From cab62bdfe1d71f44183bf82b74af85a8e78d648d Mon Sep 17 00:00:00 2001 From: Mat Jaggard Date: Mon, 6 Dec 2021 12:59:02 +0000 Subject: [PATCH 1/8] Full refresh and update to Swagger 3 --- .swagger-codegen/VERSION | 1 + .travis.yml | 1 - LICENSE | 201 - README.md | 1559 +++-- billforward/__init__.py | 815 ++- billforward/api/__init__.py | 32 + billforward/api/accounts_api.py | 1997 ++++++ billforward/api/affiliation_api.py | 845 +++ billforward/api/avatax_api.py | 410 ++ billforward/api/card_connect_api.py | 311 + billforward/api/charges_api.py | 574 ++ billforward/api/checkout_api.py | 508 ++ billforward/api/contracts_api.py | 836 +++ billforward/api/coupons_api.py | 1111 +++ billforward/api/default_api.py | 309 + billforward/api/dunning_api.py | 643 ++ billforward/api/ebanx_api.py | 412 ++ billforward/api/invoices_api.py | 5613 +++++++++++++++ billforward/api/notifications_api.py | 740 ++ billforward/api/payment_gateway_api.py | 528 ++ billforward/api/payment_methods_api.py | 952 +++ billforward/api/payments_api.py | 1095 +++ billforward/api/permissions_api.py | 624 ++ billforward/api/plans_api.py | 334 + billforward/api/quotes_api.py | 340 + billforward/api/receipts_api.py | 810 +++ billforward/api/reports_api.py | 1547 +++++ billforward/api/salesforce_api.py | 490 ++ billforward/api/security_api.py | 2169 ++++++ billforward/api/subscriptions_api.py | 5805 ++++++++++++++++ billforward/api/taxes_api.py | 997 +++ billforward/api/tokenization_api.py | 3430 ++++++++++ billforward/api/webhooks_api.py | 806 +++ billforward/api_client.py | 497 +- billforward/apis/__init__.py | 66 - billforward/apis/accounts_api.py | 2174 ------ billforward/apis/addresses_api.py | 259 - billforward/apis/amendments_api.py | 1372 ---- billforward/apis/analytics_api.py | 1384 ---- billforward/apis/auditlogs_api.py | 671 -- billforward/apis/charges_api.py | 883 --- billforward/apis/clients_api.py | 488 -- billforward/apis/configurations_api.py | 500 -- billforward/apis/couponbook_api.py | 1071 --- billforward/apis/couponbookdefinition_api.py | 724 -- billforward/apis/coupondefinition_api.py | 596 -- billforward/apis/couponinstance_api.py | 1239 ---- billforward/apis/couponmodifier_api.py | 808 --- billforward/apis/couponrule_api.py | 596 -- billforward/apis/coupons_api.py | 987 --- billforward/apis/creditnotes_api.py | 746 -- billforward/apis/cybersourcetokens_api.py | 586 -- billforward/apis/dunninglines_api.py | 727 -- billforward/apis/emailproviders_api.py | 496 -- billforward/apis/emails_api.py | 375 - billforward/apis/emailsubscriptions_api.py | 610 -- billforward/apis/fixedtermdefinitions_api.py | 259 - billforward/apis/fixedterms_api.py | 155 - billforward/apis/invoices_api.py | 5183 -------------- billforward/apis/metadata_api.py | 469 -- billforward/apis/notifications_api.py | 801 --- billforward/apis/organizations_api.py | 825 --- billforward/apis/passwords_api.py | 155 - billforward/apis/paymentmethods_api.py | 964 --- .../paymentmethodsubscriptionlinks_api.py | 266 - billforward/apis/payments_api.py | 1003 --- billforward/apis/periods_api.py | 292 - billforward/apis/permissions_api.py | 705 -- billforward/apis/pricingcalculator_api.py | 363 - billforward/apis/pricingcomponents_api.py | 744 -- billforward/apis/pricingcomponenttiers_api.py | 624 -- .../apis/pricingcomponentvaluechanges_api.py | 752 -- .../apis/pricingcomponentvalues_api.py | 636 -- billforward/apis/productrateplans_api.py | 1679 ----- billforward/apis/products_api.py | 1066 --- billforward/apis/profiles_api.py | 632 -- billforward/apis/quotes_api.py | 155 - billforward/apis/receipts_api.py | 906 --- billforward/apis/refunds_api.py | 939 --- billforward/apis/roles_api.py | 722 -- billforward/apis/search_api.py | 179 - billforward/apis/subscriptions_api.py | 6034 ----------------- billforward/apis/synch_app_configs_api.py | 475 -- billforward/apis/synch_configs_api.py | 700 -- billforward/apis/synch_jobs_api.py | 916 --- billforward/apis/taxationlinks_api.py | 744 -- billforward/apis/taxationstrategies_api.py | 1111 --- billforward/apis/time_api.py | 155 - billforward/apis/tokenization_api.py | 743 -- billforward/apis/unitofmeasure_api.py | 488 -- billforward/apis/usage_api.py | 659 -- billforward/apis/usageperiods_api.py | 437 -- .../apis/usageroundingstrategies_api.py | 515 -- billforward/apis/usagesessions_api.py | 507 -- billforward/apis/usernames_api.py | 155 - billforward/apis/users_api.py | 1231 ---- billforward/apis/vaultedgateways_api.py | 1419 ---- billforward/apis/webhooks_api.py | 811 --- billforward/configuration.py | 164 +- billforward/models/__init__.py | 713 +- billforward/models/account.py | 505 +- .../account_ltv_result_paged_metadata.py | 280 - billforward/models/account_paged_metadata.py | 280 - .../account_payments_result_paged_metadata.py | 280 - billforward/models/add_charge_request.py | 541 +- billforward/models/add_charge_response.py | 214 + .../models/add_charge_to_account_response.py | 188 + .../add_charges_to_account_api_request.py | 415 ++ .../models/add_contract_period_request.py | 214 + billforward/models/add_coupon_code_request.py | 202 +- .../models/add_payment_method_request.py | 180 +- .../models/add_taxation_strategy_request.py | 202 - billforward/models/additional_data.py | 119 + billforward/models/address.py | 492 +- billforward/models/address_paged_metadata.py | 280 - ...ance_pricing_components_by_charge_model.py | 162 + billforward/models/affiliate.py | 344 + .../models/affiliate_commission_charge.py | 168 + .../affiliate_rate_plan_relationships.py | 370 + .../affiliate_subscription_relationship.py | 292 + billforward/models/aggregating_component.py | 358 - .../aggregating_component_description.py | 110 + billforward/models/alias.py | 280 - .../allowed_webhook_subscription_values.py | 202 + billforward/models/amendment.py | 498 +- .../models/amendment_discard_amendment.py | 451 +- .../models/amendment_paged_metadata.py | 280 - .../amendment_price_n_time_paged_metadata.py | 280 - billforward/models/api_configuration.py | 759 +++ .../api_configuration_paged_metadata.py | 280 - billforward/models/api_quote.py | 816 ++- .../models/api_quote_paged_metadata.py | 280 - .../models/api_quote_response_quantity.py | 700 +- billforward/models/arrears_charge.py | 171 + ...ears_pricing_components_by_charge_model.py | 162 + billforward/models/audit_entry.py | 376 - .../models/audit_entry_paged_metadata.py | 280 - billforward/models/auth_capture_request.py | 496 +- .../models/authorize_net_configuration.py | 122 + billforward/models/authorize_net_payment.py | 90 + billforward/models/authorize_net_token.py | 376 + .../authorize_net_token_paged_metadata.py | 280 - billforward/models/avatax_config_request.py | 344 + billforward/models/avatax_configuration.py | 484 ++ billforward/models/avatax_ping_request.py | 240 + billforward/models/avatax_ping_response.py | 136 + billforward/models/bank_account.py | 430 ++ ...ank_account_verification_paged_metadata.py | 280 - .../models/batch_increment_values_request.py | 137 + ...update_pricing_component_values_request.py | 169 + billforward/models/bf_error.py | 208 - billforward/models/bf_permission.py | 344 +- .../models/bf_permission_paged_metadata.py | 280 - ..._managed_payments_result_paged_metadata.py | 280 - billforward/models/billing_entity_base.py | 136 +- .../models/braintree_auth_capture_request.py | 429 +- .../models/braintree_capture_request.py | 376 +- billforward/models/braintree_configuration.py | 116 + .../models/braintree_merchant_account.py | 293 + billforward/models/braintree_payment.py | 90 + .../models/braintree_pre_auth_request.py | 116 + billforward/models/braintree_token.py | 401 ++ .../models/braintree_token_paged_metadata.py | 280 - billforward/models/calculator_result.py | 136 + .../models/cancel_subscription_request.py | 292 - billforward/models/cancellation_amendment.py | 553 +- .../card_connect_auth_capture_request.py | 142 + .../models/card_connect_configuration.py | 90 + .../models/card_connect_gateway_request.py | 188 + billforward/models/card_connect_payment.py | 90 + .../cass_churn_result_paged_metadata.py | 280 - .../cass_payment_result_paged_metadata.py | 280 - .../cass_upgrade_result_paged_metadata.py | 280 - billforward/models/client.py | 462 -- billforward/models/client_paged_metadata.py | 280 - billforward/models/commission_structure.py | 324 + billforward/models/component_change.py | 486 +- billforward/models/component_cost.py | 150 - billforward/models/compound_usage.py | 202 - billforward/models/compound_usage_session.py | 202 - billforward/models/contract.py | 541 ++ billforward/models/contract_period.py | 409 ++ billforward/models/coupon.py | 722 +- billforward/models/coupon_book.py | 462 -- billforward/models/coupon_book_definition.py | 552 -- .../coupon_book_definition_paged_metadata.py | 280 - .../models/coupon_book_paged_metadata.py | 280 - billforward/models/coupon_charge.py | 382 ++ billforward/models/coupon_code_response.py | 188 + billforward/models/coupon_definition.py | 610 -- .../coupon_definition_paged_metadata.py | 280 - billforward/models/coupon_discount.py | 400 +- .../models/coupon_discount_estimate.py | 254 - billforward/models/coupon_instance.py | 713 +- .../models/coupon_instance_existing_value.py | 292 +- .../models/coupon_instance_paged_metadata.py | 280 - billforward/models/coupon_modifier_base.py | 506 -- .../coupon_modifier_base_paged_metadata.py | 280 - billforward/models/coupon_paged_metadata.py | 280 - billforward/models/coupon_payment.py | 90 + billforward/models/coupon_rule.py | 576 -- .../models/coupon_rule_paged_metadata.py | 280 - .../models/coupon_unique_codes_request.py | 254 +- .../models/coupon_unique_codes_response.py | 152 +- ...on_unique_codes_response_paged_metadata.py | 280 - billforward/models/coupon_wrapper_response.py | 350 +- .../models/create_account_profile_request.py | 436 -- billforward/models/create_account_request.py | 254 - billforward/models/create_address_request.py | 358 - .../create_aggregating_component_request.py | 156 +- ...create_aggregating_subscription_request.py | 546 +- .../create_commission_invoice_request.py | 136 + .../models/create_contract_period_request.py | 214 + billforward/models/create_contract_request.py | 352 + .../models/create_coupon_discount_request.py | 266 + billforward/models/create_coupon_request.py | 344 + .../models/create_offline_payment_request.py | 402 ++ .../create_permission_on_role_request.py | 202 + .../models/create_permission_request.py | 254 + ...eate_pricing_component_quantity_request.py | 266 + .../models/create_profile_address_request.py | 332 - billforward/models/create_profile_request.py | 84 + billforward/models/create_role_request.py | 240 + ...create_salesforce_configuration_request.py | 240 + .../create_subscription_batch_request.py | 156 +- .../create_subscription_charge_amendment.py | 678 +- ...ubscription_checkout_definition_request.py | 136 + .../models/create_subscription_request.py | 924 ++- .../create_subscription_timer_request.py | 258 + billforward/models/create_totp_request.py | 188 + billforward/models/credit_account_request.py | 252 +- billforward/models/credit_note.py | 513 +- billforward/models/credit_note_currency.py | 240 + .../models/credit_note_paged_metadata.py | 280 - billforward/models/credit_note_payment.py | 90 + .../models/credit_subscription_request.py | 226 +- .../models/cybersource_configuration.py | 116 + billforward/models/cybersource_payment.py | 90 + .../cybersource_token_paged_metadata.py | 280 - .../models/data_sync_job_error_response.py | 272 + billforward/models/data_sync_job_response.py | 628 ++ ...sation_app_configuration_paged_metadata.py | 280 - .../data_synchronisation_configuration.py | 442 -- ...ronisation_configuration_paged_metadata.py | 280 - ...data_synchronization_job_paged_metadata.py | 280 - .../models/debts_result_paged_metadata.py | 280 - billforward/models/dunning_line.py | 348 +- .../models/dunning_line_paged_metadata.py | 280 - billforward/models/dynamic_metadata.py | 99 - .../models/ebanx_auth_capture_request.py | 220 + billforward/models/ebanx_configuration.py | 90 + billforward/models/ebanx_gateway_request.py | 162 + billforward/models/ebanx_payment.py | 90 + billforward/models/ebanx_webhook.py | 200 + billforward/models/email.py | 838 --- billforward/models/email_paged_metadata.py | 280 - billforward/models/email_provider.py | 384 -- .../models/email_provider_paged_metadata.py | 280 - billforward/models/email_subscription.py | 448 -- .../email_subscription_paged_metadata.py | 280 - billforward/models/email_tokenization.py | 832 +++ .../email_tokenization_create_api_request.py | 324 + .../email_tokenization_send_api_request.py | 110 + .../email_tokenization_update_api_request.py | 136 + billforward/models/end_trial_amendment.py | 424 +- billforward/models/epx_capture_request.py | 786 +++ billforward/models/epx_configuration.py | 220 + billforward/models/epx_payment.py | 90 + billforward/models/epx_pre_auth_request.py | 266 + billforward/models/epx_pre_auth_response.py | 370 + billforward/models/event.py | 306 - billforward/models/event_data.py | 150 - .../models/execution_receipt_response.py | 278 + billforward/models/execution_response.py | 220 + billforward/models/extras.py | 110 + billforward/models/file_sham.py | 99 - billforward/models/fixed_term.py | 535 +- billforward/models/fixed_term_definition.py | 377 + .../fixed_term_definition_paged_metadata.py | 280 - .../models/fixed_term_expiry_amendment.py | 450 +- .../models/fixed_term_paged_metadata.py | 280 - .../models/flat_advance_pricing_component.py | 330 + .../models/flat_arrears_pricing_component.py | 330 + billforward/models/flat_pricing_component.py | 780 +-- .../models/flat_setup_pricing_component.py | 298 + .../models/flat_usage_pricing_component.py | 304 + .../get_rate_plan_affiliate_response.py | 292 + .../get_subscription_affiliate_response.py | 214 + .../models/go_cardless_configuration.py | 90 + .../go_cardless_tokenization_request.py | 448 ++ .../models/halt_aggregation_request.py | 110 + .../models/halt_aggregation_response.py | 188 + billforward/models/hosted_payment.py | 220 + billforward/models/hosted_payment_config.py | 136 + billforward/models/i_discardable.py | 110 + billforward/models/import_invoice_line.py | 252 +- billforward/models/import_invoice_request.py | 590 ++ .../models/import_subscription_request.py | 480 ++ billforward/models/inline_response_default.py | 294 + .../models/inline_response_default1.py | 138 + .../models/inline_response_default10.py | 294 + .../models/inline_response_default100.py | 294 + .../models/inline_response_default101.py | 294 + .../models/inline_response_default102.py | 138 + .../models/inline_response_default103.py | 138 + .../models/inline_response_default11.py | 138 + .../models/inline_response_default12.py | 294 + .../models/inline_response_default13.py | 138 + .../models/inline_response_default14.py | 138 + .../models/inline_response_default15.py | 138 + .../models/inline_response_default16.py | 138 + .../models/inline_response_default17.py | 138 + .../models/inline_response_default18.py | 294 + .../models/inline_response_default19.py | 138 + .../models/inline_response_default2.py | 138 + .../models/inline_response_default20.py | 294 + .../models/inline_response_default21.py | 138 + .../models/inline_response_default22.py | 294 + .../models/inline_response_default23.py | 138 + .../models/inline_response_default24.py | 138 + .../models/inline_response_default25.py | 294 + .../models/inline_response_default26.py | 294 + .../models/inline_response_default27.py | 138 + .../models/inline_response_default28.py | 138 + .../models/inline_response_default29.py | 138 + .../models/inline_response_default3.py | 294 + .../models/inline_response_default30.py | 138 + .../models/inline_response_default31.py | 294 + .../models/inline_response_default32.py | 294 + .../models/inline_response_default33.py | 294 + .../models/inline_response_default34.py | 138 + .../models/inline_response_default35.py | 138 + .../models/inline_response_default36.py | 138 + .../models/inline_response_default37.py | 294 + .../models/inline_response_default38.py | 138 + .../models/inline_response_default39.py | 138 + .../models/inline_response_default4.py | 138 + .../models/inline_response_default40.py | 138 + .../models/inline_response_default41.py | 138 + .../models/inline_response_default42.py | 294 + .../models/inline_response_default43.py | 138 + .../models/inline_response_default44.py | 294 + .../models/inline_response_default45.py | 138 + .../models/inline_response_default46.py | 138 + .../models/inline_response_default47.py | 138 + .../models/inline_response_default48.py | 294 + .../models/inline_response_default49.py | 138 + .../models/inline_response_default5.py | 294 + .../models/inline_response_default50.py | 138 + .../models/inline_response_default51.py | 138 + .../models/inline_response_default52.py | 294 + .../models/inline_response_default53.py | 138 + .../models/inline_response_default54.py | 294 + .../models/inline_response_default55.py | 138 + .../models/inline_response_default56.py | 294 + .../models/inline_response_default57.py | 138 + .../models/inline_response_default58.py | 138 + .../models/inline_response_default59.py | 294 + .../models/inline_response_default6.py | 138 + .../models/inline_response_default60.py | 138 + .../models/inline_response_default61.py | 138 + .../models/inline_response_default62.py | 138 + .../models/inline_response_default63.py | 138 + .../models/inline_response_default64.py | 294 + .../models/inline_response_default65.py | 138 + .../models/inline_response_default66.py | 294 + .../models/inline_response_default67.py | 138 + .../models/inline_response_default68.py | 294 + .../models/inline_response_default69.py | 138 + .../models/inline_response_default7.py | 138 + .../models/inline_response_default70.py | 138 + .../models/inline_response_default71.py | 138 + .../models/inline_response_default72.py | 138 + .../models/inline_response_default73.py | 138 + .../models/inline_response_default74.py | 294 + .../models/inline_response_default75.py | 138 + .../models/inline_response_default76.py | 138 + .../models/inline_response_default77.py | 294 + .../models/inline_response_default78.py | 138 + .../models/inline_response_default79.py | 138 + .../models/inline_response_default8.py | 294 + .../models/inline_response_default80.py | 138 + .../models/inline_response_default81.py | 294 + .../models/inline_response_default82.py | 138 + .../models/inline_response_default83.py | 138 + .../models/inline_response_default84.py | 138 + .../models/inline_response_default85.py | 294 + .../models/inline_response_default86.py | 138 + .../models/inline_response_default87.py | 294 + .../models/inline_response_default88.py | 294 + .../models/inline_response_default89.py | 138 + .../models/inline_response_default9.py | 294 + .../models/inline_response_default90.py | 138 + .../models/inline_response_default91.py | 138 + .../models/inline_response_default92.py | 138 + .../models/inline_response_default93.py | 138 + .../models/inline_response_default94.py | 138 + .../models/inline_response_default95.py | 138 + .../models/inline_response_default96.py | 138 + .../models/inline_response_default97.py | 138 + .../models/inline_response_default98.py | 294 + .../models/inline_response_default99.py | 294 + .../models/insertable_billing_entity.py | 474 -- billforward/models/interval_date.py | 136 + billforward/models/invoice.py | 1392 ++-- billforward/models/invoice_charge_request.py | 234 +- .../models/invoice_execution_request.py | 241 + billforward/models/invoice_line.py | 922 --- billforward/models/invoice_line_payment.py | 858 --- .../invoice_line_payment_paged_metadata.py | 280 - billforward/models/invoice_line_payments.py | 1045 +++ billforward/models/invoice_lines.py | 1021 +++ ...nvoice_next_execution_attempt_amendment.py | 491 +- .../invoice_outstanding_charges_amendment.py | 450 +- billforward/models/invoice_paged_metadata.py | 280 - billforward/models/invoice_payment.py | 494 -- billforward/models/invoice_payments.py | 489 ++ .../models/invoice_recalculation_amendment.py | 528 +- .../models/invoice_recalculation_request.py | 316 +- billforward/models/invoice_refund_request.py | 195 + billforward/models/invoice_refund_response.py | 266 + billforward/models/invoice_split.py | 214 + .../models/invoice_split_service_request.py | 200 + .../invoice_template_config_response.py | 466 ++ billforward/models/issue_invoice_amendment.py | 451 +- billforward/models/issue_invoice_request.py | 136 + billforward/models/issue_invoice_response.py | 272 + billforward/models/kash_configuration.py | 142 + .../models/legacy_create_webhook_request.py | 162 + billforward/models/manual_charge.py | 117 + billforward/models/marketplace_quote.py | 292 + billforward/models/metadata.py | 138 + billforward/models/metadata_key_values.py | 136 + .../metadata_key_values_paged_metadata.py | 280 - billforward/models/migration.py | 299 + billforward/models/migration_request.py | 402 +- billforward/models/migration_response.py | 754 ++ billforward/models/mutable_billing_entity.py | 642 -- .../models/nested_adhoc_charge_request.py | 324 + billforward/models/nested_charge_request.py | 428 ++ billforward/models/notification.py | 642 -- .../models/notification_paged_metadata.py | 280 - .../models/notification_send_request.py | 110 + .../models/notification_send_response.py | 570 ++ billforward/models/notifications.py | 662 ++ billforward/models/o_auth_token.py | 136 + billforward/models/offline_payment.py | 200 + .../models/open_id_registration_response.py | 136 + .../models/open_id_user_link_request.py | 162 + billforward/models/organization.py | 462 -- billforward/models/organization_lite_view.py | 240 + .../models/organization_paged_metadata.py | 280 - billforward/models/password.py | 248 +- billforward/models/password_paged_metadata.py | 280 - .../models/password_reset_code_request.py | 110 + billforward/models/password_reset_request.py | 124 - billforward/models/password_reset_response.py | 162 + ...password_update_with_reset_code_request.py | 188 + billforward/models/pause_request.py | 264 +- .../models/pay_vision_auth_capture_request.py | 144 + .../models/pay_vision_configuration.py | 220 + .../models/pay_vision_pre_auth_request.py | 90 + billforward/models/payment.py | 637 +- billforward/models/payment_accounting_view.py | 402 ++ billforward/models/payment_method.py | 694 +- .../models/payment_method_paged_metadata.py | 280 - .../payment_method_subscription_link.py | 299 +- ...method_subscription_link_paged_metadata.py | 280 - billforward/models/payment_paged_metadata.py | 280 - billforward/models/payment_refund_request.py | 195 + billforward/models/payment_refund_response.py | 292 + billforward/models/payment_retry_request.py | 134 +- billforward/models/paypal_configuration.py | 90 + billforward/models/paypal_payment.py | 90 + .../models/pending_component_value_change.py | 162 +- billforward/models/period.py | 344 - billforward/models/period_paged_metadata.py | 280 - .../models/permission_action_entity.py | 169 + ...permission_action_entity_paged_metadata.py | 280 - .../models/permission_resource_entity.py | 169 + ...rmission_resource_entity_paged_metadata.py | 280 - billforward/models/plan_aggregation.py | 110 + billforward/models/plan_request.py | 730 ++ billforward/models/plan_response.py | 886 +++ billforward/models/prepayment_charge.py | 90 + billforward/models/price_breakdown.py | 240 + .../price_calculation_paged_metadata.py | 280 - billforward/models/price_line.py | 532 ++ billforward/models/pricing_component.py | 871 ++- .../models/pricing_component_charge.py | 554 ++ .../pricing_component_coupon_modifier.py | 506 -- .../pricing_component_migration_value.py | 276 +- .../pricing_component_paged_metadata.py | 280 - .../pricing_component_quantity_request.py | 176 - billforward/models/pricing_component_tier.py | 500 +- .../pricing_component_tier_paged_metadata.py | 280 - billforward/models/pricing_component_value.py | 398 +- .../pricing_component_value_amendment.py | 175 + .../models/pricing_component_value_change.py | 518 ++ ...ricing_component_value_change_amendment.py | 512 -- ...g_component_value_change_paged_metadata.py | 280 - ...onent_value_migration_amendment_mapping.py | 317 +- .../pricing_component_value_paged_metadata.py | 280 - .../models/pricing_component_value_request.py | 261 +- .../pricing_component_value_response.py | 590 ++ ...component_value_response_paged_metadata.py | 280 - .../pricing_components_by_charge_type.py | 214 + billforward/models/pricing_tier.py | 220 + billforward/models/product.py | 584 -- billforward/models/product_coupon_modifier.py | 506 -- billforward/models/product_paged_metadata.py | 280 - .../product_payments_result_paged_metadata.py | 280 - billforward/models/product_rate_plan.py | 984 --- .../product_rate_plan_migration_amendment.py | 639 +- .../product_rate_plan_migration_charge.py | 409 ++ .../product_rate_plan_paged_metadata.py | 280 - ...ate_plan_payments_result_paged_metadata.py | 280 - billforward/models/profile.py | 590 +- billforward/models/profile_paged_metadata.py | 280 - .../models/public_configuration_response.py | 162 + billforward/models/quote_request.py | 673 +- billforward/models/quote_request_value.py | 178 +- .../recalculate_charge_batch_request.py | 220 + .../recalculate_charge_batch_response.py | 214 + .../models/recalculate_charge_request.py | 327 +- billforward/models/receipt.py | 723 +- billforward/models/receipt_paged_metadata.py | 280 - billforward/models/refund.py | 948 ++- billforward/models/refund_accounting_view.py | 564 ++ billforward/models/refund_paged_metadata.py | 280 - .../models/remove_credit_account_request.py | 188 + billforward/models/resume_request.py | 266 +- .../models/resume_subscription_amendment.py | 434 +- billforward/models/revenue_attribution.py | 722 -- .../revenue_attribution_paged_metadata.py | 280 - billforward/models/revenue_attributions.py | 853 +++ .../models/revive_subscription_request.py | 124 - billforward/models/role.py | 354 +- billforward/models/role_paged_metadata.py | 280 - billforward/models/rule_satisfaction.py | 202 - .../models/sage_pay_auth_capture_request.py | 195 + billforward/models/sage_pay_card_payment.py | 90 + billforward/models/sage_pay_configuration.py | 168 + .../models/sage_pay_enabled_card_type.py | 302 + .../models/sage_pay_pre_auth_request.py | 168 + .../salesforce_configuration_response.py | 344 + .../models/search_result_paged_metadata.py | 280 - billforward/models/service_end_amendment.py | 424 +- .../models/set_rate_plan_affiliate_request.py | 298 + .../set_subscription_affiliate_request.py | 246 + billforward/models/setup_charge.py | 171 + ...etup_pricing_components_by_charge_model.py | 162 + .../models/shuttle_auth_capture_request.py | 144 + billforward/models/shuttle_configuration.py | 168 + billforward/models/shuttle_payment.py | 90 + .../models/shuttle_pre_auth_request.py | 116 + billforward/models/simple_date_param.py | 136 + billforward/models/simple_user.py | 214 + .../single_recalculate_charge_request.py | 357 + .../models/spreedly_auth_capture_request.py | 117 + billforward/models/spreedly_configuration.py | 168 + .../models/spreedly_pre_auth_request.py | 90 + .../models/square_auth_capture_request.py | 196 + billforward/models/square_configuration.py | 116 + .../models/square_configuration_data.py | 240 + billforward/models/square_data.py | 110 + billforward/models/square_payment.py | 90 + billforward/models/square_subscription.py | 214 + .../models/start_all_subscriptions_request.py | 136 + .../start_all_subscriptions_response.py | 188 + billforward/models/start_contract_request.py | 168 + billforward/models/start_contract_response.py | 162 + .../models/stripe_ach_capture_request.py | 370 + billforward/models/stripe_ach_payment.py | 90 + billforward/models/stripe_ach_token.py | 374 + .../models/stripe_ach_token_paged_metadata.py | 280 - billforward/models/stripe_additional_data.py | 142 + .../models/stripe_auth_capture_request.py | 457 +- billforward/models/stripe_card_payment.py | 90 + billforward/models/stripe_configuration.py | 90 + billforward/models/stripe_object.py | 99 - billforward/models/stripe_pre_auth_request.py | 90 + billforward/models/stripe_token.py | 355 + .../models/stripe_token_paged_metadata.py | 280 - billforward/models/subscription.py | 1271 ++-- .../models/subscription_cancellation.py | 555 ++ ...ubscription_cancellation_paged_metadata.py | 280 - billforward/models/subscription_charge.py | 923 ++- .../subscription_charge_paged_metadata.py | 280 - .../subscription_checkout_action_request.py | 214 + ...ription_checkout_definition_description.py | 266 + .../models/subscription_checkout_response.py | 214 + .../subscription_ltv_result_paged_metadata.py | 280 - .../models/subscription_paged_metadata.py | 280 - .../models/subscription_revive_amendment.py | 148 + .../subscription_revive_partial_request.py | 110 + .../models/subscription_revive_request.py | 252 + billforward/models/swagger_type_list.py | 150 - billforward/models/swagger_type_list_inv.py | 108 +- billforward/models/swagger_type_list_subs.py | 152 +- billforward/models/sync_action_request.py | 142 + billforward/models/tax_line.py | 349 + .../models/taxation_link_paged_metadata.py | 280 - billforward/models/taxation_strategy.py | 519 ++ .../taxation_strategy_paged_metadata.py | 280 - .../tiered_advance_pricing_component.py | 330 + .../tiered_arrears_pricing_component.py | 330 + .../models/tiered_pricing_component.py | 780 +-- .../models/tiered_setup_pricing_component.py | 298 + .../models/tiered_usage_pricing_component.py | 304 + .../models/tiered_volume_pricing_component.py | 780 +-- billforward/models/time_request.py | 370 +- billforward/models/time_response.py | 406 +- .../models/time_response_paged_metadata.py | 280 - billforward/models/time_zone.py | 202 - billforward/models/timer_amendment.py | 606 +- .../models/tokenization_epxredirect_body.py | 916 +++ .../tokenization_payvisionshoutv1_body.py | 136 + billforward/models/tokenization_pre_auth.py | 136 + .../tokenization_pre_auth_paged_metadata.py | 280 - .../models/tokenization_pre_auth_request.py | 364 + .../tokenization_sagepaynotifyv300_body.py | 370 + billforward/models/tokens_response.py | 136 + .../models/trust_commerce_configuration.py | 142 + billforward/models/trust_commerce_token.py | 322 + .../trust_commerce_token_paged_metadata.py | 280 - .../typed_query_result_wrapper_account.py | 538 ++ .../typed_query_result_wrapper_address.py | 538 ++ .../typed_query_result_wrapper_amendment.py | 538 ++ .../typed_query_result_wrapper_api_quote.py | 538 ++ ...ery_result_wrapper_avatax_configuration.py | 538 ++ ...yped_query_result_wrapper_bf_permission.py | 538 ++ ...ed_query_result_wrapper_braintree_token.py | 538 ++ .../typed_query_result_wrapper_contract.py | 538 ++ .../typed_query_result_wrapper_coupon.py | 538 ++ .../typed_query_result_wrapper_credit_note.py | 538 ++ ...y_result_wrapper_data_sync_job_response.py | 538 ++ ...typed_query_result_wrapper_dunning_line.py | 538 ++ .../typed_query_result_wrapper_invoice.py | 538 ++ ...ery_result_wrapper_invoice_line_payment.py | 538 ++ ...typed_query_result_wrapper_notification.py | 538 ++ .../typed_query_result_wrapper_payment.py | 538 ++ ...ped_query_result_wrapper_payment_method.py | 538 ++ ...yped_query_result_wrapper_plan_response.py | 538 ++ .../typed_query_result_wrapper_profile.py | 538 ++ .../typed_query_result_wrapper_receipt.py | 538 ++ .../typed_query_result_wrapper_refund.py | 538 ++ ...uery_result_wrapper_revenue_attribution.py | 538 ++ .../models/typed_query_result_wrapper_role.py | 538 ++ ...d_query_result_wrapper_stripe_ach_token.py | 538 ++ ...typed_query_result_wrapper_stripe_token.py | 538 ++ ...typed_query_result_wrapper_subscription.py | 538 ++ ...uery_result_wrapper_subscription_charge.py | 538 ++ ..._query_result_wrapper_taxation_strategy.py | 538 ++ ...yped_query_result_wrapper_user_response.py | 538 ++ .../typed_query_result_wrapper_webhook.py | 538 ++ billforward/models/unit_discount.py | 202 - billforward/models/unit_of_measure.py | 322 +- .../models/unit_of_measure_coupon_modifier.py | 506 -- .../models/unit_of_measure_paged_metadata.py | 280 - billforward/models/update_address_request.py | 384 -- .../update_component_value_amendment.py | 519 +- billforward/models/update_contract_request.py | 326 + billforward/models/update_email_request.py | 214 + billforward/models/update_invoice_request.py | 350 + .../models/update_invoice_template_request.py | 440 ++ billforward/models/update_password_request.py | 188 + .../models/update_password_response.py | 214 + ...e_pricing_component_value_change_result.py | 414 ++ .../update_pricing_component_value_request.py | 196 + ...update_pricing_component_value_response.py | 188 + billforward/models/update_profile_request.py | 488 -- .../update_rate_plan_affiliate_request.py | 188 + billforward/models/update_role_request.py | 222 +- ...update_salesforce_configuration_request.py | 162 + .../models/update_subscription_request.py | 620 +- .../models/update_user_info_request.py | 162 + billforward/models/upgrade_charge.py | 194 + billforward/models/usage.py | 598 -- billforward/models/usage_paged_metadata.py | 280 - .../models/usage_period_paged_metadata.py | 280 - ...sage_pricing_components_by_charge_model.py | 162 + .../usage_rounding_strategy_paged_metadata.py | 280 - billforward/models/usage_session.py | 468 -- .../models/usage_session_paged_metadata.py | 280 - billforward/models/user.py | 632 +- billforward/models/user_create_request.py | 370 + billforward/models/user_creation_request.py | 360 +- billforward/models/user_creation_response.py | 448 ++ .../user_creation_response_paged_metadata.py | 280 - billforward/models/user_invite_request.py | 318 + billforward/models/user_paged_metadata.py | 280 - ...private_permanent_token_refresh_request.py | 136 + .../user_private_permanent_token_request.py | 136 + billforward/models/user_response.py | 318 + billforward/models/user_timezone.py | 188 + billforward/models/username.py | 327 +- billforward/models/username_paged_metadata.py | 280 - billforward/models/username_response.py | 344 + billforward/models/value_increment.py | 138 + .../models/verify_payment_method_request.py | 162 + billforward/models/webhook.py | 422 ++ billforward/models/webhook_paged_metadata.py | 280 - billforward/models/webhook_subscription.py | 336 + billforward/models/zooz_capture_request.py | 214 + billforward/models/zooz_configuration.py | 90 + billforward/models/zooz_payment.py | 90 + billforward/rest.py | 246 +- docs/APIConfiguration.md | 33 + docs/APIConfigurationPagedMetadata.md | 16 - docs/APIQuote.md | 64 +- docs/APIQuotePagedMetadata.md | 16 - docs/APIQuoteResponseQuantity.md | 45 +- docs/Account.md | 30 +- docs/AccountLTVResultPagedMetadata.md | 16 - docs/AccountPagedMetadata.md | 16 - docs/AccountPaymentsResultPagedMetadata.md | 16 - docs/AccountsApi.md | 756 +-- docs/AddChargeRequest.md | 36 +- docs/AddChargeResponse.md | 13 + docs/AddChargeToAccountResponse.md | 12 + docs/AddChargesToAccountAPIRequest.md | 20 + docs/AddContractPeriodRequest.md | 13 + docs/AddCouponCodeRequest.md | 10 +- docs/AddPaymentMethodRequest.md | 6 +- docs/AddTaxationStrategyRequest.md | 13 - ...bscriptionRequest.md => AdditionalData.md} | 5 +- docs/Address.md | 35 +- docs/AddressPagedMetadata.md | 16 - docs/AddressesApi.md | 104 - docs/AdvancePricingComponentsByChargeModel.md | 11 + docs/Affiliate.md | 18 + docs/AffiliateCommissionCharge.md | 11 + docs/AffiliateRatePlanRelationships.md | 19 + docs/AffiliateSubscriptionRelationship.md | 16 + docs/AffiliationApi.md | 403 ++ docs/AggregatingComponent.md | 19 - ....md => AggregatingComponentDescription.md} | 4 +- docs/Alias.md | 16 - docs/AllowedWebhookSubscriptionValues.md | 12 + docs/Amendment.md | 28 +- docs/AmendmentDiscardAmendment.md | 15 +- docs/AmendmentPagedMetadata.md | 16 - docs/AmendmentPriceNTimePagedMetadata.md | 16 - docs/AmendmentsApi.md | 620 -- docs/AnalyticsApi.md | 620 -- docs/ArrearsCharge.md | 11 + docs/ArrearsPricingComponentsByChargeModel.md | 11 + docs/AuditEntry.md | 19 - docs/AuditEntryPagedMetadata.md | 16 - docs/AuditlogsApi.md | 298 - docs/AuthCaptureRequest.md | 25 +- docs/AuthorizeNetConfiguration.md | 9 + docs/AuthorizeNetPayment.md | 8 + docs/AuthorizeNetToken.md | 19 + docs/AuthorizeNetTokenPagedMetadata.md | 16 - docs/AvataxApi.md | 197 + docs/AvataxConfigRequest.md | 18 + docs/AvataxConfiguration.md | 23 + docs/AvataxPingRequest.md | 14 + docs/AvataxPingResponse.md | 10 + docs/BFError.md | 13 - docs/BFPermission.md | 22 +- docs/BFPermissionPagedMetadata.md | 16 - docs/BankAccount.md | 21 + docs/BankAccountVerificationPagedMetadata.md | 16 - docs/BatchIncrementValuesRequest.md | 10 + ...atchUpdatePricingComponentValuesRequest.md | 11 + ...rwardManagedPaymentsResultPagedMetadata.md | 16 - docs/BillingEntityBase.md | 4 +- docs/BraintreeAuthCaptureRequest.md | 16 +- docs/BraintreeCaptureRequest.md | 27 +- docs/BraintreeConfiguration.md | 9 + docs/BraintreeMerchantAccount.md | 16 + ...DynamicMetadata.md => BraintreePayment.md} | 3 +- docs/BraintreePreAuthRequest.md | 9 + docs/BraintreeToken.md | 20 + docs/BraintreeTokenPagedMetadata.md | 16 - docs/CalculatorResult.md | 10 + docs/CancelSubscriptionRequest.md | 16 - docs/CancellationAmendment.md | 23 +- docs/CardConnectApi.md | 150 + docs/CardConnectAuthCaptureRequest.md | 10 + docs/CardConnectConfiguration.md | 8 + docs/CardConnectGatewayRequest.md | 12 + docs/CardConnectPayment.md | 8 + docs/CassChurnResultPagedMetadata.md | 16 - docs/CassPaymentResultPagedMetadata.md | 16 - docs/CassUpgradeResultPagedMetadata.md | 16 - docs/ChargesApi.md | 334 +- docs/CheckoutApi.md | 246 + docs/Client.md | 23 - docs/ClientPagedMetadata.md | 16 - docs/ClientsApi.md | 212 - docs/CommissionStructure.md | 17 + docs/ComponentChange.md | 27 +- docs/CompoundUsage.md | 13 - docs/CompoundUsageSession.md | 13 - docs/ConfigurationsApi.md | 218 - docs/Contract.md | 25 + docs/ContractPeriod.md | 20 + docs/ContractsApi.md | 407 ++ docs/Coupon.md | 51 +- docs/CouponBook.md | 23 - docs/CouponBookDefinition.md | 26 - docs/CouponBookDefinitionPagedMetadata.md | 16 - docs/CouponBookPagedMetadata.md | 16 - docs/CouponCharge.md | 19 + docs/CouponCodeResponse.md | 12 + docs/CouponDefinition.md | 28 - docs/CouponDefinitionPagedMetadata.md | 16 - docs/CouponDiscount.md | 22 +- docs/CouponDiscountEstimate.md | 15 - docs/CouponInstance.md | 42 +- docs/CouponInstanceExistingValue.md | 18 +- docs/CouponInstancePagedMetadata.md | 16 - docs/CouponModifierBase.md | 24 - docs/CouponModifierBasePagedMetadata.md | 16 - docs/CouponPagedMetadata.md | 16 - docs/{StripeObject.md => CouponPayment.md} | 3 +- docs/CouponRule.md | 26 - docs/CouponRulePagedMetadata.md | 16 - docs/CouponUniqueCodesRequest.md | 12 +- docs/CouponUniqueCodesResponse.md | 5 +- .../CouponUniqueCodesResponsePagedMetadata.md | 16 - docs/CouponWrapperResponse.md | 18 +- docs/CouponbookApi.md | 482 -- docs/CouponbookdefinitionApi.md | 322 - docs/CoupondefinitionApi.md | 262 - docs/CouponinstanceApi.md | 562 -- docs/CouponmodifierApi.md | 360 - docs/CouponruleApi.md | 262 - docs/CouponsApi.md | 446 +- docs/CreateAccountProfileRequest.md | 22 - docs/CreateAccountRequest.md | 15 - docs/CreateAddressRequest.md | 19 - docs/CreateAggregatingComponentRequest.md | 7 +- docs/CreateAggregatingSubscriptionRequest.md | 34 +- docs/CreateCommissionInvoiceRequest.md | 10 + docs/CreateContractPeriodRequest.md | 13 + docs/CreateContractRequest.md | 18 + docs/CreateCouponDiscountRequest.md | 15 + docs/CreateCouponRequest.md | 18 + docs/CreateOfflinePaymentRequest.md | 20 + docs/CreatePermissionOnRoleRequest.md | 12 + docs/CreatePermissionRequest.md | 14 + docs/CreatePricingComponentQuantityRequest.md | 15 + docs/CreateProfileAddressRequest.md | 18 - docs/CreateProfileRequest.md | 8 + docs/CreateRoleRequest.md | 14 + docs/CreateSalesforceConfigurationRequest.md | 14 + docs/CreateSubscriptionBatchRequest.md | 7 +- docs/CreateSubscriptionChargeAmendment.md | 32 +- ...teSubscriptionCheckoutDefinitionRequest.md | 10 + docs/CreateSubscriptionRequest.md | 49 +- docs/CreateSubscriptionTimerRequest.md | 14 + docs/CreateTOTPRequest.md | 12 + docs/CreditAccountRequest.md | 14 +- docs/CreditNote.md | 33 +- docs/CreditNoteCurrency.md | 14 + docs/CreditNotePagedMetadata.md | 16 - docs/CreditNotePayment.md | 8 + docs/CreditSubscriptionRequest.md | 12 +- docs/CreditnotesApi.md | 330 - docs/CybersourceConfiguration.md | 9 + docs/CybersourcePayment.md | 8 + docs/CybersourceTokenPagedMetadata.md | 16 - docs/CybersourcetokensApi.md | 254 - docs/DataSyncJobErrorResponse.md | 15 + docs/DataSyncJobResponse.md | 28 + ...ronisationAppConfigurationPagedMetadata.md | 16 - docs/DataSynchronisationConfiguration.md | 22 - ...nchronisationConfigurationPagedMetadata.md | 16 - docs/DataSynchronizationJobPagedMetadata.md | 16 - docs/DebtsResultPagedMetadata.md | 16 - docs/DefaultApi.md | 149 + docs/DunningApi.md | 315 + docs/DunningLine.md | 22 +- docs/DunningLinePagedMetadata.md | 16 - docs/DunninglinesApi.md | 322 - docs/EBANXApi.md | 199 + docs/EBANXAuthCaptureRequest.md | 13 + docs/EBANXConfiguration.md | 8 + docs/EBANXGatewayRequest.md | 11 + docs/EBANXPayment.md | 8 + docs/EBANXWebhook.md | 12 + docs/Email.md | 37 - docs/EmailPagedMetadata.md | 16 - docs/EmailProvider.md | 20 - docs/EmailProviderPagedMetadata.md | 16 - docs/EmailSubscription.md | 22 - docs/EmailSubscriptionPagedMetadata.md | 16 - docs/EmailTokenization.md | 36 + docs/EmailTokenizationCreateAPIRequest.md | 17 + docs/EmailTokenizationSendAPIRequest.md | 9 + docs/EmailTokenizationUpdateAPIRequest.md | 10 + docs/EmailprovidersApi.md | 216 - docs/EmailsApi.md | 158 - docs/EmailsubscriptionsApi.md | 266 - docs/EndTrialAmendment.md | 13 - docs/EpxCaptureRequest.md | 35 + docs/EpxConfiguration.md | 13 + docs/{FileSham.md => EpxPayment.md} | 3 +- docs/EpxPreAuthRequest.md | 15 + docs/EpxPreAuthResponse.md | 19 + docs/Event.md | 17 - docs/ExecutionReceiptResponse.md | 15 + docs/ExecutionResponse.md | 13 + docs/Extras.md | 9 + docs/FixedTerm.md | 31 +- docs/FixedTermDefinition.md | 19 + docs/FixedTermDefinitionPagedMetadata.md | 16 - docs/FixedTermExpiryAmendment.md | 15 +- docs/FixedTermPagedMetadata.md | 16 - docs/FixedtermdefinitionsApi.md | 104 - docs/FixedtermsApi.md | 56 - docs/FlatAdvancePricingComponent.md | 17 + docs/FlatArrearsPricingComponent.md | 17 + docs/FlatPricingComponent.md | 26 - docs/FlatSetupPricingComponent.md | 16 + docs/FlatUsagePricingComponent.md | 16 + docs/GetRatePlanAffiliateResponse.md | 16 + docs/GetSubscriptionAffiliateResponse.md | 13 + docs/GoCardlessConfiguration.md | 8 + docs/GoCardlessTokenizationRequest.md | 22 + docs/HaltAggregationRequest.md | 9 + docs/HaltAggregationResponse.md | 12 + docs/HostedPayment.md | 13 + docs/HostedPaymentConfig.md | 10 + docs/IDiscardable.md | 9 + docs/ImportInvoiceLine.md | 1 - docs/ImportInvoiceRequest.md | 27 + docs/ImportSubscriptionRequest.md | 23 + docs/InlineResponseDefault.md | 16 + docs/InlineResponseDefault1.md | 10 + docs/InlineResponseDefault10.md | 16 + docs/InlineResponseDefault100.md | 16 + docs/InlineResponseDefault101.md | 16 + docs/InlineResponseDefault102.md | 10 + docs/InlineResponseDefault103.md | 10 + docs/InlineResponseDefault11.md | 10 + docs/InlineResponseDefault12.md | 16 + docs/InlineResponseDefault13.md | 10 + docs/InlineResponseDefault14.md | 10 + docs/InlineResponseDefault15.md | 10 + docs/InlineResponseDefault16.md | 10 + docs/InlineResponseDefault17.md | 10 + docs/InlineResponseDefault18.md | 16 + docs/InlineResponseDefault19.md | 10 + docs/InlineResponseDefault2.md | 10 + docs/InlineResponseDefault20.md | 16 + docs/InlineResponseDefault21.md | 10 + docs/InlineResponseDefault22.md | 16 + docs/InlineResponseDefault23.md | 10 + docs/InlineResponseDefault24.md | 10 + docs/InlineResponseDefault25.md | 16 + docs/InlineResponseDefault26.md | 16 + docs/InlineResponseDefault27.md | 10 + docs/InlineResponseDefault28.md | 10 + docs/InlineResponseDefault29.md | 10 + docs/InlineResponseDefault3.md | 16 + docs/InlineResponseDefault30.md | 10 + docs/InlineResponseDefault31.md | 16 + docs/InlineResponseDefault32.md | 16 + docs/InlineResponseDefault33.md | 16 + docs/InlineResponseDefault34.md | 10 + docs/InlineResponseDefault35.md | 10 + docs/InlineResponseDefault36.md | 10 + docs/InlineResponseDefault37.md | 16 + docs/InlineResponseDefault38.md | 10 + docs/InlineResponseDefault39.md | 10 + docs/InlineResponseDefault4.md | 10 + docs/InlineResponseDefault40.md | 10 + docs/InlineResponseDefault41.md | 10 + docs/InlineResponseDefault42.md | 16 + docs/InlineResponseDefault43.md | 10 + docs/InlineResponseDefault44.md | 16 + docs/InlineResponseDefault45.md | 10 + docs/InlineResponseDefault46.md | 10 + docs/InlineResponseDefault47.md | 10 + docs/InlineResponseDefault48.md | 16 + docs/InlineResponseDefault49.md | 10 + docs/InlineResponseDefault5.md | 16 + docs/InlineResponseDefault50.md | 10 + docs/InlineResponseDefault51.md | 10 + docs/InlineResponseDefault52.md | 16 + docs/InlineResponseDefault53.md | 10 + docs/InlineResponseDefault54.md | 16 + docs/InlineResponseDefault55.md | 10 + docs/InlineResponseDefault56.md | 16 + docs/InlineResponseDefault57.md | 10 + docs/InlineResponseDefault58.md | 10 + docs/InlineResponseDefault59.md | 16 + docs/InlineResponseDefault6.md | 10 + docs/InlineResponseDefault60.md | 10 + docs/InlineResponseDefault61.md | 10 + docs/InlineResponseDefault62.md | 10 + docs/InlineResponseDefault63.md | 10 + docs/InlineResponseDefault64.md | 16 + docs/InlineResponseDefault65.md | 10 + docs/InlineResponseDefault66.md | 16 + docs/InlineResponseDefault67.md | 10 + docs/InlineResponseDefault68.md | 16 + docs/InlineResponseDefault69.md | 10 + docs/InlineResponseDefault7.md | 10 + docs/InlineResponseDefault70.md | 10 + docs/InlineResponseDefault71.md | 10 + docs/InlineResponseDefault72.md | 10 + docs/InlineResponseDefault73.md | 10 + docs/InlineResponseDefault74.md | 16 + docs/InlineResponseDefault75.md | 10 + docs/InlineResponseDefault76.md | 10 + docs/InlineResponseDefault77.md | 16 + docs/InlineResponseDefault78.md | 10 + docs/InlineResponseDefault79.md | 10 + docs/InlineResponseDefault8.md | 16 + docs/InlineResponseDefault80.md | 10 + docs/InlineResponseDefault81.md | 16 + docs/InlineResponseDefault82.md | 10 + docs/InlineResponseDefault83.md | 10 + docs/InlineResponseDefault84.md | 10 + docs/InlineResponseDefault85.md | 16 + docs/InlineResponseDefault86.md | 10 + docs/InlineResponseDefault87.md | 16 + docs/InlineResponseDefault88.md | 16 + docs/InlineResponseDefault89.md | 10 + docs/InlineResponseDefault9.md | 16 + docs/InlineResponseDefault90.md | 10 + docs/InlineResponseDefault91.md | 10 + docs/InlineResponseDefault92.md | 10 + docs/InlineResponseDefault93.md | 10 + docs/InlineResponseDefault94.md | 10 + docs/InlineResponseDefault95.md | 10 + docs/InlineResponseDefault96.md | 10 + docs/InlineResponseDefault97.md | 10 + docs/InlineResponseDefault98.md | 16 + docs/InlineResponseDefault99.md | 16 + docs/InsertableBillingEntity.md | 23 - docs/IntervalDate.md | 10 + docs/Invoice.md | 98 +- docs/InvoiceChargeRequest.md | 11 +- docs/InvoiceExecutionRequest.md | 14 + docs/InvoiceLine.md | 40 - docs/InvoiceLinePayment.md | 38 - docs/InvoiceLinePaymentPagedMetadata.md | 16 - docs/InvoiceLinePayments.md | 44 + docs/InvoiceLines.md | 43 + docs/InvoiceNextExecutionAttemptAmendment.md | 18 +- docs/InvoiceOutstandingChargesAmendment.md | 15 +- docs/InvoicePagedMetadata.md | 16 - docs/InvoicePayment.md | 24 - docs/InvoicePayments.md | 23 + docs/InvoiceRecalculationAmendment.md | 21 +- docs/InvoiceRecalculationRequest.md | 15 +- docs/InvoiceRefundRequest.md | 12 + docs/InvoiceRefundResponse.md | 15 + docs/InvoiceSplit.md | 13 + docs/InvoiceSplitServiceRequest.md | 12 + docs/InvoiceTemplateConfigResponse.md | 22 + docs/InvoicesApi.md | 2459 ++++--- docs/IssueInvoiceAmendment.md | 15 +- docs/IssueInvoiceRequest.md | 10 + docs/IssueInvoiceResponse.md | 15 + docs/KashConfiguration.md | 10 + docs/LegacyCreateWebhookRequest.md | 11 + docs/ManualCharge.md | 9 + docs/MarketplaceQuote.md | 16 + docs/Metadata.md | 10 + docs/MetadataApi.md | 204 - docs/MetadataKeyValues.md | 10 + docs/MetadataKeyValuesPagedMetadata.md | 16 - docs/Migration.md | 16 + docs/MigrationRequest.md | 23 +- docs/MigrationResponse.md | 33 + docs/MutableBillingEntity.md | 29 - docs/NestedAdhocChargeRequest.md | 17 + docs/NestedChargeRequest.md | 21 + docs/Notification.md | 29 - docs/NotificationPagedMetadata.md | 16 - docs/NotificationSendRequest.md | 9 + docs/NotificationSendResponse.md | 26 + docs/Notifications.md | 29 + docs/NotificationsApi.md | 323 +- docs/OAuthToken.md | 10 + docs/OfflinePayment.md | 12 + docs/OpenIDRegistrationResponse.md | 10 + docs/OpenIdUserLinkRequest.md | 11 + docs/Organization.md | 23 - docs/OrganizationLiteView.md | 14 + docs/OrganizationPagedMetadata.md | 16 - docs/OrganizationsApi.md | 370 - docs/Password.md | 15 +- docs/PasswordPagedMetadata.md | 16 - docs/PasswordResetCodeRequest.md | 9 + docs/PasswordResetResponse.md | 11 + docs/PasswordUpdateWithResetCodeRequest.md | 12 + docs/PasswordsApi.md | 56 - docs/PauseRequest.md | 10 +- docs/PayVisionAuthCaptureRequest.md | 10 + docs/PayVisionConfiguration.md | 13 + docs/PayVisionPreAuthRequest.md | 8 + docs/Payment.md | 39 +- docs/PaymentAccountingView.md | 20 + docs/PaymentGatewayApi.md | 260 + docs/PaymentMethod.md | 40 +- docs/PaymentMethodPagedMetadata.md | 16 - docs/PaymentMethodSubscriptionLink.md | 17 +- ...mentMethodSubscriptionLinkPagedMetadata.md | 16 - docs/PaymentPagedMetadata.md | 16 - docs/PaymentRefundRequest.md | 12 + docs/PaymentRefundResponse.md | 16 + docs/PaymentRetryRequest.md | 5 +- docs/PaymentmethodsApi.md | 361 +- docs/PaymentmethodsubscriptionlinksApi.md | 106 - docs/PaymentsApi.md | 452 +- docs/PaypalConfiguration.md | 8 + docs/PaypalPayment.md | 8 + docs/PendingComponentValueChange.md | 1 - docs/Period.md | 18 - docs/PeriodPagedMetadata.md | 16 - docs/PeriodsApi.md | 122 - docs/PermissionActionEntity.md | 11 + docs/PermissionActionEntityPagedMetadata.md | 16 - docs/PermissionResourceEntity.md | 11 + docs/PermissionResourceEntityPagedMetadata.md | 16 - docs/PermissionsApi.md | 191 +- docs/PlanAggregation.md | 9 + docs/PlanRequest.md | 31 + docs/PlanResponse.md | 37 + docs/PlansApi.md | 158 + docs/PrepaymentCharge.md | 8 + docs/PriceBreakdown.md | 14 + docs/PriceCalculationPagedMetadata.md | 16 - docs/PriceLine.md | 25 + docs/PricingComponent.md | 56 +- docs/PricingComponentCharge.md | 25 + docs/PricingComponentCouponModifier.md | 24 - docs/PricingComponentMigrationValue.md | 14 +- docs/PricingComponentPagedMetadata.md | 16 - docs/PricingComponentQuantityRequest.md | 12 - docs/PricingComponentTier.md | 27 +- docs/PricingComponentTierPagedMetadata.md | 16 - docs/PricingComponentValue.md | 26 +- docs/PricingComponentValueAmendment.md | 11 + docs/PricingComponentValueChange.md | 24 + docs/PricingComponentValueChangeAmendment.md | 24 - ...ricingComponentValueChangePagedMetadata.md | 16 - ...ComponentValueMigrationAmendmentMapping.md | 19 +- docs/PricingComponentValuePagedMetadata.md | 16 - docs/PricingComponentValueRequest.md | 13 +- docs/PricingComponentValueResponse.md | 27 + ...cingComponentValueResponsePagedMetadata.md | 16 - docs/PricingComponentsByChargeType.md | 13 + docs/PricingTier.md | 13 + docs/PricingcalculatorApi.md | 152 - docs/PricingcomponentsApi.md | 332 - docs/PricingcomponenttiersApi.md | 276 - docs/PricingcomponentvaluechangesApi.md | 336 - docs/PricingcomponentvaluesApi.md | 282 - docs/Product.md | 27 - docs/ProductCouponModifier.md | 24 - docs/ProductPagedMetadata.md | 16 - docs/ProductPaymentsResultPagedMetadata.md | 16 - docs/ProductRatePlan.md | 41 - docs/ProductRatePlanMigrationAmendment.md | 30 +- docs/ProductRatePlanMigrationCharge.md | 20 + docs/ProductRatePlanPagedMetadata.md | 16 - ...ductRatePlanPaymentsResultPagedMetadata.md | 16 - docs/ProductrateplansApi.md | 760 --- docs/ProductsApi.md | 478 -- docs/Profile.md | 41 +- docs/ProfilePagedMetadata.md | 16 - docs/ProfilesApi.md | 280 - docs/PublicConfigurationResponse.md | 11 + docs/QuoteRequest.md | 40 +- docs/QuoteRequestValue.md | 9 +- docs/QuotesApi.md | 136 +- docs/RecalculateChargeBatchRequest.md | 13 + docs/RecalculateChargeBatchResponse.md | 13 + docs/RecalculateChargeRequest.md | 19 +- docs/Receipt.md | 20 +- docs/ReceiptPagedMetadata.md | 16 - docs/ReceiptsApi.md | 318 +- docs/Refund.md | 65 +- docs/RefundAccountingView.md | 26 + docs/RefundPagedMetadata.md | 16 - docs/RefundsApi.md | 420 -- docs/RemoveCreditAccountRequest.md | 12 + docs/ReportsApi.md | 783 +++ docs/ResumeRequest.md | 11 +- docs/ResumeSubscriptionAmendment.md | 15 +- docs/RevenueAttribution.md | 33 - docs/RevenueAttributionPagedMetadata.md | 16 - docs/RevenueAttributions.md | 37 + docs/Role.md | 25 +- docs/RolePagedMetadata.md | 16 - docs/RolesApi.md | 318 - docs/RuleSatisfaction.md | 13 - docs/SagePayAuthCaptureRequest.md | 12 + docs/SagePayCardPayment.md | 8 + docs/SagePayConfiguration.md | 11 + docs/SagePayEnabledCardType.md | 16 + docs/SagePayPreAuthRequest.md | 11 + docs/SalesforceApi.md | 242 + docs/SalesforceConfigurationResponse.md | 18 + docs/SearchApi.md | 68 - docs/SearchResultPagedMetadata.md | 16 - docs/SecurityApi.md | 1077 +++ docs/ServiceEndAmendment.md | 13 - docs/SetRatePlanAffiliateRequest.md | 16 + ....md => SetSubscriptionAffiliateRequest.md} | 10 +- docs/SetupCharge.md | 11 + docs/SetupPricingComponentsByChargeModel.md | 11 + docs/ShuttleAuthCaptureRequest.md | 10 + docs/ShuttleConfiguration.md | 11 + docs/ShuttlePayment.md | 8 + docs/ShuttlePreAuthRequest.md | 9 + docs/SimpleDateParam.md | 10 + docs/SimpleUser.md | 13 + docs/SingleRecalculateChargeRequest.md | 18 + docs/SpreedlyAuthCaptureRequest.md | 9 + docs/SpreedlyConfiguration.md | 11 + docs/SpreedlyPreAuthRequest.md | 8 + docs/SquareAuthCaptureRequest.md | 12 + docs/SquareConfiguration.md | 9 + docs/SquareConfigurationData.md | 14 + docs/SquareData.md | 9 + docs/SquarePayment.md | 8 + docs/SquareSubscription.md | 13 + ...ata.md => StartAllSubscriptionsRequest.md} | 7 +- docs/StartAllSubscriptionsResponse.md | 12 + docs/StartContractRequest.md | 11 + docs/StartContractResponse.md | 11 + docs/StripeACHCaptureRequest.md | 19 + docs/StripeACHPayment.md | 8 + docs/StripeACHTokenPagedMetadata.md | 16 - docs/StripeAchToken.md | 19 + docs/StripeAdditionalData.md | 10 + docs/StripeAuthCaptureRequest.md | 16 +- docs/StripeCardPayment.md | 8 + docs/StripeConfiguration.md | 8 + docs/StripePreAuthRequest.md | 8 + docs/StripeToken.md | 18 + docs/StripeTokenPagedMetadata.md | 16 - docs/Subscription.md | 87 +- docs/SubscriptionCancellation.md | 25 + docs/SubscriptionCancellationPagedMetadata.md | 16 - docs/SubscriptionCharge.md | 59 +- docs/SubscriptionChargePagedMetadata.md | 16 - docs/SubscriptionCheckoutActionRequest.md | 13 + ...bscriptionCheckoutDefinitionDescription.md | 15 + docs/SubscriptionCheckoutResponse.md | 13 + docs/SubscriptionLTVResultPagedMetadata.md | 16 - docs/SubscriptionPagedMetadata.md | 16 - docs/SubscriptionReviveAmendment.md | 10 + docs/SubscriptionRevivePartialRequest.md | 9 + docs/SubscriptionReviveRequest.md | 14 + docs/SubscriptionsApi.md | 2077 +++--- docs/SwaggerTypeList.md | 11 - docs/SwaggerTypeListInv.md | 3 +- docs/SwaggerTypeListSubs.md | 6 +- docs/SyncActionRequest.md | 10 + docs/SynchAppConfigsApi.md | 204 - docs/SynchConfigsApi.md | 310 - docs/SynchJobsApi.md | 410 -- docs/TaxLine.md | 18 + docs/TaxationLinkPagedMetadata.md | 16 - docs/TaxationStrategy.md | 24 + docs/TaxationStrategyPagedMetadata.md | 16 - docs/TaxationlinksApi.md | 332 - docs/TaxationstrategiesApi.md | 502 -- docs/TaxesApi.md | 492 ++ docs/TieredAdvancePricingComponent.md | 17 + docs/TieredArrearsPricingComponent.md | 17 + docs/TieredPricingComponent.md | 26 - docs/TieredSetupPricingComponent.md | 16 + docs/TieredUsagePricingComponent.md | 16 + docs/TieredVolumePricingComponent.md | 26 - docs/TimeApi.md | 56 - docs/TimeRequest.md | 22 +- docs/TimeResponse.md | 22 +- docs/TimeResponsePagedMetadata.md | 16 - docs/TimerAmendment.md | 17 +- docs/TokenizationApi.md | 1659 ++++- docs/TokenizationEpxredirectBody.md | 40 + docs/TokenizationPayvisionshoutv1Body.md | 10 + docs/TokenizationPreAuth.md | 10 + docs/TokenizationPreAuthPagedMetadata.md | 16 - docs/TokenizationPreAuthRequest.md | 18 + docs/TokenizationSagepaynotifyv300Body.md | 19 + docs/TokensResponse.md | 10 + docs/TrustCommerceConfiguration.md | 10 + docs/TrustCommerceToken.md | 17 + docs/TrustCommerceTokenPagedMetadata.md | 16 - docs/TypedQueryResultWrapperAPIQuote.md | 25 + docs/TypedQueryResultWrapperAccount.md | 25 + docs/TypedQueryResultWrapperAddress.md | 25 + docs/TypedQueryResultWrapperAmendment.md | 25 + ...edQueryResultWrapperAvataxConfiguration.md | 25 + docs/TypedQueryResultWrapperBFPermission.md | 25 + docs/TypedQueryResultWrapperBraintreeToken.md | 25 + docs/TypedQueryResultWrapperContract.md | 25 + docs/TypedQueryResultWrapperCoupon.md | 25 + docs/TypedQueryResultWrapperCreditNote.md | 25 + ...edQueryResultWrapperDataSyncJobResponse.md | 25 + docs/TypedQueryResultWrapperDunningLine.md | 25 + docs/TypedQueryResultWrapperInvoice.md | 25 + ...pedQueryResultWrapperInvoiceLinePayment.md | 25 + docs/TypedQueryResultWrapperNotification.md | 25 + docs/TypedQueryResultWrapperPayment.md | 25 + docs/TypedQueryResultWrapperPaymentMethod.md | 25 + docs/TypedQueryResultWrapperPlanResponse.md | 25 + docs/TypedQueryResultWrapperProfile.md | 25 + docs/TypedQueryResultWrapperReceipt.md | 25 + docs/TypedQueryResultWrapperRefund.md | 25 + ...pedQueryResultWrapperRevenueAttribution.md | 25 + docs/TypedQueryResultWrapperRole.md | 25 + docs/TypedQueryResultWrapperStripeACHToken.md | 25 + docs/TypedQueryResultWrapperStripeToken.md | 25 + docs/TypedQueryResultWrapperSubscription.md | 25 + ...pedQueryResultWrapperSubscriptionCharge.md | 25 + ...TypedQueryResultWrapperTaxationStrategy.md | 25 + docs/TypedQueryResultWrapperUserResponse.md | 25 + docs/TypedQueryResultWrapperWebhook.md | 25 + docs/UnitDiscount.md | 13 - docs/UnitOfMeasure.md | 20 +- docs/UnitOfMeasureCouponModifier.md | 24 - docs/UnitOfMeasurePagedMetadata.md | 16 - docs/UnitofmeasureApi.md | 212 - docs/UpdateAddressRequest.md | 20 - docs/UpdateComponentValueAmendment.md | 21 +- docs/UpdateContractRequest.md | 17 + docs/UpdateEmailRequest.md | 13 + docs/UpdateInvoiceRequest.md | 18 + docs/UpdateInvoiceTemplateRequest.md | 21 + docs/UpdatePasswordRequest.md | 12 + docs/UpdatePasswordResponse.md | 13 + ...UpdatePricingComponentValueChangeResult.md | 20 + docs/UpdatePricingComponentValueRequest.md | 12 + docs/UpdatePricingComponentValueResponse.md | 12 + docs/UpdateProfileRequest.md | 24 - docs/UpdateRatePlanAffiliateRequest.md | 12 + docs/UpdateRoleRequest.md | 13 +- docs/UpdateSalesforceConfigurationRequest.md | 11 + docs/UpdateSubscriptionRequest.md | 31 +- docs/UpdateUserInfoRequest.md | 11 + docs/UpgradeCharge.md | 12 + docs/Usage.md | 28 - docs/UsageApi.md | 286 - docs/UsagePagedMetadata.md | 16 - docs/UsagePeriodPagedMetadata.md | 16 - docs/UsagePricingComponentsByChargeModel.md | 11 + docs/UsageRoundingStrategyPagedMetadata.md | 16 - docs/UsageSession.md | 23 - docs/UsageSessionPagedMetadata.md | 16 - docs/UsageperiodsApi.md | 186 - docs/UsageroundingstrategiesApi.md | 224 - docs/UsagesessionsApi.md | 220 - docs/User.md | 36 +- docs/UserCreateRequest.md | 19 + docs/UserCreationRequest.md | 23 +- docs/UserCreationResponse.md | 22 + docs/UserCreationResponsePagedMetadata.md | 16 - docs/UserInviteRequest.md | 17 + docs/UserPagedMetadata.md | 16 - ...UserPrivatePermanentTokenRefreshRequest.md | 10 + docs/UserPrivatePermanentTokenRequest.md | 10 + docs/UserResponse.md | 17 + docs/{TimeZone.md => UserTimezone.md} | 3 +- docs/Username.md | 17 +- docs/UsernamePagedMetadata.md | 16 - docs/UsernameResponse.md | 18 + docs/UsernamesApi.md | 56 - docs/UsersApi.md | 554 -- docs/ValueIncrement.md | 10 + docs/VaultedgatewaysApi.md | 640 -- docs/VerifyPaymentMethodRequest.md | 11 + docs/Webhook.md | 21 + docs/WebhookPagedMetadata.md | 16 - docs/WebhookSubscription.md | 17 + docs/WebhooksApi.md | 279 +- docs/ZoozCaptureRequest.md | 13 + docs/ZoozConfiguration.md | 8 + docs/ZoozPayment.md | 8 + git_push.sh | 2 +- requirements.txt | 2 +- setup.py | 31 +- test/test_account.py | 33 +- .../test_account_ltv_result_paged_metadata.py | 52 - test/test_account_paged_metadata.py | 52 - ..._account_payments_result_paged_metadata.py | 52 - test/test_accounts_api.py | 129 +- test/test_add_charge_request.py | 33 +- test/test_add_charge_response.py | 39 + test/test_add_charge_to_account_response.py | 39 + ...test_add_charges_to_account_api_request.py | 39 + test/test_add_contract_period_request.py | 39 + test/test_add_coupon_code_request.py | 33 +- test/test_add_payment_method_request.py | 33 +- test/test_add_taxation_strategy_request.py | 52 - test/test_additional_data.py | 39 + test/test_address.py | 33 +- test/test_address_paged_metadata.py | 52 - test/test_addresses_api.py | 62 - ...ance_pricing_components_by_charge_model.py | 39 + test/test_affiliate.py | 39 + test/test_affiliate_commission_charge.py | 39 + .../test_affiliate_rate_plan_relationships.py | 39 + ...est_affiliate_subscription_relationship.py | 39 + test/test_affiliation_api.py | 81 + test/test_aggregating_component.py | 52 - .../test_aggregating_component_description.py | 39 + test/test_alias.py | 52 - ...est_allowed_webhook_subscription_values.py | 39 + test/test_amendment.py | 33 +- test/test_amendment_discard_amendment.py | 33 +- test/test_amendment_paged_metadata.py | 52 - ...t_amendment_price_n_time_paged_metadata.py | 52 - test/test_amendments_api.py | 134 - test/test_analytics_api.py | 134 - test/test_api_configuration.py | 39 + test/test_api_configuration_paged_metadata.py | 52 - test/test_api_quote.py | 37 +- test/test_api_quote_paged_metadata.py | 52 - test/test_api_quote_response_quantity.py | 33 +- test/test_arrears_charge.py | 39 + ...ears_pricing_components_by_charge_model.py | 39 + test/test_audit_entry.py | 52 - test/test_audit_entry_paged_metadata.py | 52 - test/test_auditlogs_api.py | 86 - test/test_auth_capture_request.py | 33 +- test/test_authorize_net_configuration.py | 39 + test/test_authorize_net_payment.py | 39 + test/test_authorize_net_token.py | 39 + ...test_authorize_net_token_paged_metadata.py | 52 - test/test_avatax_api.py | 57 + test/test_avatax_config_request.py | 39 + test/test_avatax_configuration.py | 39 + test/test_avatax_ping_request.py | 39 + test/test_avatax_ping_response.py | 39 + test/test_bank_account.py | 39 + ...ank_account_verification_paged_metadata.py | 52 - test/test_batch_increment_values_request.py | 39 + ...update_pricing_component_values_request.py | 39 + test/test_bf_error.py | 52 - test/test_bf_permission.py | 33 +- test/test_bf_permission_paged_metadata.py | 52 - ..._managed_payments_result_paged_metadata.py | 52 - test/test_billing_entity_base.py | 33 +- test/test_braintree_auth_capture_request.py | 33 +- test/test_braintree_capture_request.py | 33 +- test/test_braintree_configuration.py | 39 + test/test_braintree_merchant_account.py | 39 + test/test_braintree_payment.py | 39 + test/test_braintree_pre_auth_request.py | 39 + test/test_braintree_token.py | 39 + test/test_braintree_token_paged_metadata.py | 52 - test/test_calculator_result.py | 39 + test/test_cancel_subscription_request.py | 52 - test/test_cancellation_amendment.py | 33 +- test/test_card_connect_api.py | 51 + .../test_card_connect_auth_capture_request.py | 39 + test/test_card_connect_configuration.py | 39 + test/test_card_connect_gateway_request.py | 39 + test/test_card_connect_payment.py | 39 + test/test_cass_churn_result_paged_metadata.py | 52 - ...test_cass_payment_result_paged_metadata.py | 52 - ...test_cass_upgrade_result_paged_metadata.py | 52 - test/test_charges_api.py | 67 +- test/test_checkout_api.py | 63 + test/test_client.py | 52 - test/test_client_paged_metadata.py | 52 - test/test_clients_api.py | 78 - test/test_commission_structure.py | 39 + test/test_component_change.py | 33 +- test/test_component_cost.py | 52 - test/test_compound_usage.py | 52 - test/test_compound_usage_session.py | 52 - test/test_configurations_api.py | 78 - test/test_contract.py | 39 + test/test_contract_period.py | 39 + test/test_contracts_api.py | 81 + test/test_coupon.py | 33 +- test/test_coupon_book.py | 52 - test/test_coupon_book_definition.py | 52 - ...t_coupon_book_definition_paged_metadata.py | 52 - test/test_coupon_book_paged_metadata.py | 52 - test/test_coupon_charge.py | 39 + test/test_coupon_code_response.py | 39 + test/test_coupon_definition.py | 52 - test/test_coupon_definition_paged_metadata.py | 52 - test/test_coupon_discount.py | 33 +- test/test_coupon_discount_estimate.py | 52 - test/test_coupon_instance.py | 33 +- test/test_coupon_instance_existing_value.py | 33 +- test/test_coupon_instance_paged_metadata.py | 52 - test/test_coupon_modifier_base.py | 52 - ...est_coupon_modifier_base_paged_metadata.py | 52 - test/test_coupon_paged_metadata.py | 52 - test/test_coupon_payment.py | 39 + test/test_coupon_rule.py | 52 - test/test_coupon_rule_paged_metadata.py | 52 - test/test_coupon_unique_codes_request.py | 33 +- test/test_coupon_unique_codes_response.py | 33 +- ...on_unique_codes_response_paged_metadata.py | 52 - test/test_coupon_wrapper_response.py | 33 +- test/test_couponbook_api.py | 118 - test/test_couponbookdefinition_api.py | 94 - test/test_coupondefinition_api.py | 86 - test/test_couponinstance_api.py | 126 - test/test_couponmodifier_api.py | 102 - test/test_couponrule_api.py | 86 - test/test_coupons_api.py | 67 +- test/test_create_account_profile_request.py | 52 - test/test_create_account_request.py | 52 - test/test_create_address_request.py | 52 - ...st_create_aggregating_component_request.py | 33 +- ...create_aggregating_subscription_request.py | 33 +- .../test_create_commission_invoice_request.py | 39 + test/test_create_contract_period_request.py | 39 + test/test_create_contract_request.py | 39 + test/test_create_coupon_discount_request.py | 39 + test/test_create_coupon_request.py | 39 + test/test_create_offline_payment_request.py | 39 + .../test_create_permission_on_role_request.py | 39 + test/test_create_permission_request.py | 39 + ...eate_pricing_component_quantity_request.py | 39 + test/test_create_profile_address_request.py | 52 - test/test_create_profile_request.py | 39 + test/test_create_role_request.py | 39 + ...create_salesforce_configuration_request.py | 39 + .../test_create_subscription_batch_request.py | 33 +- ...st_create_subscription_charge_amendment.py | 33 +- ...ubscription_checkout_definition_request.py | 39 + test/test_create_subscription_request.py | 33 +- .../test_create_subscription_timer_request.py | 39 + test/test_create_totp_request.py | 39 + test/test_credit_account_request.py | 33 +- test/test_credit_note.py | 33 +- test/test_credit_note_currency.py | 39 + test/test_credit_note_paged_metadata.py | 52 - test/test_credit_note_payment.py | 39 + test/test_credit_subscription_request.py | 33 +- test/test_creditnotes_api.py | 94 - test/test_cybersource_configuration.py | 39 + test/test_cybersource_payment.py | 39 + test/test_cybersource_token_paged_metadata.py | 52 - test/test_cybersourcetokens_api.py | 86 - test/test_data_sync_job_error_response.py | 39 + test/test_data_sync_job_response.py | 39 + ...sation_app_configuration_paged_metadata.py | 52 - ...test_data_synchronisation_configuration.py | 52 - ...ronisation_configuration_paged_metadata.py | 52 - ...data_synchronization_job_paged_metadata.py | 52 - test/test_debts_result_paged_metadata.py | 52 - test/test_default_api.py | 51 + test/test_dunning_api.py | 69 + test/test_dunning_line.py | 33 +- test/test_dunning_line_paged_metadata.py | 52 - test/test_dunninglines_api.py | 94 - test/test_dynamic_metadata.py | 52 - test/test_ebanx_api.py | 57 + test/test_ebanx_auth_capture_request.py | 39 + test/test_ebanx_configuration.py | 39 + test/test_ebanx_gateway_request.py | 39 + test/test_ebanx_payment.py | 39 + test/test_ebanx_webhook.py | 39 + test/test_email.py | 52 - test/test_email_paged_metadata.py | 52 - test/test_email_provider.py | 52 - test/test_email_provider_paged_metadata.py | 52 - test/test_email_subscription.py | 52 - .../test_email_subscription_paged_metadata.py | 52 - test/test_email_tokenization.py | 39 + ...t_email_tokenization_create_api_request.py | 39 + ...est_email_tokenization_send_api_request.py | 39 + ...t_email_tokenization_update_api_request.py | 39 + test/test_emailproviders_api.py | 78 - test/test_emails_api.py | 70 - test/test_emailsubscriptions_api.py | 86 - test/test_end_trial_amendment.py | 33 +- test/test_epx_capture_request.py | 39 + test/test_epx_configuration.py | 39 + test/test_epx_payment.py | 39 + test/test_epx_pre_auth_request.py | 39 + test/test_epx_pre_auth_response.py | 39 + test/test_event.py | 52 - test/test_event_data.py | 52 - test/test_execution_receipt_response.py | 39 + test/test_execution_response.py | 39 + test/test_extras.py | 39 + test/test_file_sham.py | 52 - test/test_fixed_term.py | 33 +- test/test_fixed_term_definition.py | 39 + ...st_fixed_term_definition_paged_metadata.py | 52 - test/test_fixed_term_expiry_amendment.py | 33 +- test/test_fixed_term_paged_metadata.py | 52 - test/test_fixedtermdefinitions_api.py | 62 - test/test_fixedterms_api.py | 54 - test/test_flat_advance_pricing_component.py | 39 + test/test_flat_arrears_pricing_component.py | 39 + test/test_flat_pricing_component.py | 33 +- test/test_flat_setup_pricing_component.py | 39 + test/test_flat_usage_pricing_component.py | 39 + test/test_get_rate_plan_affiliate_response.py | 39 + ...est_get_subscription_affiliate_response.py | 39 + test/test_go_cardless_configuration.py | 39 + test/test_go_cardless_tokenization_request.py | 39 + test/test_halt_aggregation_request.py | 39 + test/test_halt_aggregation_response.py | 39 + test/test_hosted_payment.py | 39 + test/test_hosted_payment_config.py | 39 + test/test_i_discardable.py | 39 + test/test_import_invoice_line.py | 33 +- test/test_import_invoice_request.py | 39 + test/test_import_subscription_request.py | 39 + test/test_inline_response_default.py | 39 + test/test_inline_response_default1.py | 39 + test/test_inline_response_default10.py | 39 + test/test_inline_response_default100.py | 39 + test/test_inline_response_default101.py | 39 + test/test_inline_response_default102.py | 39 + test/test_inline_response_default103.py | 39 + test/test_inline_response_default11.py | 39 + test/test_inline_response_default12.py | 39 + test/test_inline_response_default13.py | 39 + test/test_inline_response_default14.py | 39 + test/test_inline_response_default15.py | 39 + test/test_inline_response_default16.py | 39 + test/test_inline_response_default17.py | 39 + test/test_inline_response_default18.py | 39 + test/test_inline_response_default19.py | 39 + test/test_inline_response_default2.py | 39 + test/test_inline_response_default20.py | 39 + test/test_inline_response_default21.py | 39 + test/test_inline_response_default22.py | 39 + test/test_inline_response_default23.py | 39 + test/test_inline_response_default24.py | 39 + test/test_inline_response_default25.py | 39 + test/test_inline_response_default26.py | 39 + test/test_inline_response_default27.py | 39 + test/test_inline_response_default28.py | 39 + test/test_inline_response_default29.py | 39 + test/test_inline_response_default3.py | 39 + test/test_inline_response_default30.py | 39 + test/test_inline_response_default31.py | 39 + test/test_inline_response_default32.py | 39 + test/test_inline_response_default33.py | 39 + test/test_inline_response_default34.py | 39 + test/test_inline_response_default35.py | 39 + test/test_inline_response_default36.py | 39 + test/test_inline_response_default37.py | 39 + test/test_inline_response_default38.py | 39 + test/test_inline_response_default39.py | 39 + test/test_inline_response_default4.py | 39 + test/test_inline_response_default40.py | 39 + test/test_inline_response_default41.py | 39 + test/test_inline_response_default42.py | 39 + test/test_inline_response_default43.py | 39 + test/test_inline_response_default44.py | 39 + test/test_inline_response_default45.py | 39 + test/test_inline_response_default46.py | 39 + test/test_inline_response_default47.py | 39 + test/test_inline_response_default48.py | 39 + test/test_inline_response_default49.py | 39 + test/test_inline_response_default5.py | 39 + test/test_inline_response_default50.py | 39 + test/test_inline_response_default51.py | 39 + test/test_inline_response_default52.py | 39 + test/test_inline_response_default53.py | 39 + test/test_inline_response_default54.py | 39 + test/test_inline_response_default55.py | 39 + test/test_inline_response_default56.py | 39 + test/test_inline_response_default57.py | 39 + test/test_inline_response_default58.py | 39 + test/test_inline_response_default59.py | 39 + test/test_inline_response_default6.py | 39 + test/test_inline_response_default60.py | 39 + test/test_inline_response_default61.py | 39 + test/test_inline_response_default62.py | 39 + test/test_inline_response_default63.py | 39 + test/test_inline_response_default64.py | 39 + test/test_inline_response_default65.py | 39 + test/test_inline_response_default66.py | 39 + test/test_inline_response_default67.py | 39 + test/test_inline_response_default68.py | 39 + test/test_inline_response_default69.py | 39 + test/test_inline_response_default7.py | 39 + test/test_inline_response_default70.py | 39 + test/test_inline_response_default71.py | 39 + test/test_inline_response_default72.py | 39 + test/test_inline_response_default73.py | 39 + test/test_inline_response_default74.py | 39 + test/test_inline_response_default75.py | 39 + test/test_inline_response_default76.py | 39 + test/test_inline_response_default77.py | 39 + test/test_inline_response_default78.py | 39 + test/test_inline_response_default79.py | 39 + test/test_inline_response_default8.py | 39 + test/test_inline_response_default80.py | 39 + test/test_inline_response_default81.py | 39 + test/test_inline_response_default82.py | 39 + test/test_inline_response_default83.py | 39 + test/test_inline_response_default84.py | 39 + test/test_inline_response_default85.py | 39 + test/test_inline_response_default86.py | 39 + test/test_inline_response_default87.py | 39 + test/test_inline_response_default88.py | 39 + test/test_inline_response_default89.py | 39 + test/test_inline_response_default9.py | 39 + test/test_inline_response_default90.py | 39 + test/test_inline_response_default91.py | 39 + test/test_inline_response_default92.py | 39 + test/test_inline_response_default93.py | 39 + test/test_inline_response_default94.py | 39 + test/test_inline_response_default95.py | 39 + test/test_inline_response_default96.py | 39 + test/test_inline_response_default97.py | 39 + test/test_inline_response_default98.py | 39 + test/test_inline_response_default99.py | 39 + test/test_insertable_billing_entity.py | 52 - test/test_interval_date.py | 39 + test/test_invoice.py | 33 +- test/test_invoice_charge_request.py | 33 +- test/test_invoice_execution_request.py | 39 + test/test_invoice_line.py | 52 - test/test_invoice_line_payment.py | 52 - ...est_invoice_line_payment_paged_metadata.py | 52 - test/test_invoice_line_payments.py | 39 + test/test_invoice_lines.py | 39 + ...nvoice_next_execution_attempt_amendment.py | 33 +- ...t_invoice_outstanding_charges_amendment.py | 33 +- test/test_invoice_paged_metadata.py | 52 - test/test_invoice_payment.py | 52 - test/test_invoice_payments.py | 39 + test/test_invoice_recalculation_amendment.py | 33 +- test/test_invoice_recalculation_request.py | 33 +- test/test_invoice_refund_request.py | 39 + test/test_invoice_refund_response.py | 39 + test/test_invoice_split.py | 39 + test/test_invoice_split_service_request.py | 39 + test/test_invoice_template_config_response.py | 39 + test/test_invoices_api.py | 249 +- test/test_issue_invoice_amendment.py | 33 +- test/test_issue_invoice_request.py | 39 + test/test_issue_invoice_response.py | 39 + test/test_kash_configuration.py | 39 + test/test_legacy_create_webhook_request.py | 39 + test/test_manual_charge.py | 39 + test/test_marketplace_quote.py | 39 + test/test_metadata.py | 39 + test/test_metadata_api.py | 78 - test/test_metadata_key_values.py | 39 + ...test_metadata_key_values_paged_metadata.py | 52 - test/test_migration.py | 39 + test/test_migration_request.py | 33 +- test/test_migration_response.py | 39 + test/test_mutable_billing_entity.py | 52 - test/test_nested_adhoc_charge_request.py | 39 + test/test_nested_charge_request.py | 39 + test/test_notification.py | 52 - test/test_notification_paged_metadata.py | 52 - test/test_notification_send_request.py | 39 + test/test_notification_send_response.py | 39 + test/test_notifications.py | 39 + test/test_notifications_api.py | 59 +- test/test_o_auth_token.py | 39 + test/test_offline_payment.py | 39 + test/test_open_id_registration_response.py | 39 + test/test_open_id_user_link_request.py | 39 + test/test_organization.py | 52 - test/test_organization_lite_view.py | 39 + test/test_organization_paged_metadata.py | 52 - test/test_organizations_api.py | 102 - test/test_password.py | 33 +- test/test_password_paged_metadata.py | 52 - test/test_password_reset_code_request.py | 39 + test/test_password_reset_request.py | 52 - test/test_password_reset_response.py | 39 + ...password_update_with_reset_code_request.py | 39 + test/test_passwords_api.py | 54 - test/test_pause_request.py | 33 +- test/test_pay_vision_auth_capture_request.py | 39 + test/test_pay_vision_configuration.py | 39 + test/test_pay_vision_pre_auth_request.py | 39 + test/test_payment.py | 33 +- test/test_payment_accounting_view.py | 39 + test/test_payment_gateway_api.py | 63 + test/test_payment_method.py | 33 +- test/test_payment_method_paged_metadata.py | 52 - test/test_payment_method_subscription_link.py | 33 +- ...method_subscription_link_paged_metadata.py | 52 - test/test_payment_methods_api.py | 87 + test/test_payment_paged_metadata.py | 52 - test/test_payment_refund_request.py | 39 + test/test_payment_refund_response.py | 39 + test/test_payment_retry_request.py | 33 +- test/test_paymentmethods_api.py | 110 - ...test_paymentmethodsubscriptionlinks_api.py | 62 - test/test_payments_api.py | 69 +- test/test_paypal_configuration.py | 39 + test/test_paypal_payment.py | 39 + test/test_pending_component_value_change.py | 33 +- test/test_period.py | 52 - test/test_period_paged_metadata.py | 52 - test/test_periods_api.py | 62 - test/test_permission_action_entity.py | 39 + ...permission_action_entity_paged_metadata.py | 52 - test/test_permission_resource_entity.py | 39 + ...rmission_resource_entity_paged_metadata.py | 52 - test/test_permissions_api.py | 51 +- test/test_plan_aggregation.py | 39 + test/test_plan_request.py | 39 + test/test_plan_response.py | 39 + test/test_plans_api.py | 51 + test/test_prepayment_charge.py | 39 + test/test_price_breakdown.py | 39 + test/test_price_calculation_paged_metadata.py | 52 - test/test_price_line.py | 39 + test/test_pricing_component.py | 33 +- test/test_pricing_component_charge.py | 39 + .../test_pricing_component_coupon_modifier.py | 52 - .../test_pricing_component_migration_value.py | 33 +- test/test_pricing_component_paged_metadata.py | 52 - ...test_pricing_component_quantity_request.py | 52 - test/test_pricing_component_tier.py | 33 +- ...t_pricing_component_tier_paged_metadata.py | 52 - test/test_pricing_component_value.py | 33 +- .../test_pricing_component_value_amendment.py | 39 + test/test_pricing_component_value_change.py | 39 + ...ricing_component_value_change_amendment.py | 52 - ...g_component_value_change_paged_metadata.py | 52 - ...onent_value_migration_amendment_mapping.py | 33 +- ..._pricing_component_value_paged_metadata.py | 52 - test/test_pricing_component_value_request.py | 33 +- test/test_pricing_component_value_response.py | 39 + ...component_value_response_paged_metadata.py | 52 - .../test_pricing_components_by_charge_type.py | 39 + test/test_pricing_tier.py | 39 + test/test_pricingcalculator_api.py | 70 - test/test_pricingcomponents_api.py | 94 - test/test_pricingcomponenttiers_api.py | 86 - test/test_pricingcomponentvaluechanges_api.py | 94 - test/test_pricingcomponentvalues_api.py | 86 - test/test_product.py | 52 - test/test_product_coupon_modifier.py | 52 - test/test_product_paged_metadata.py | 52 - ..._product_payments_result_paged_metadata.py | 52 - test/test_product_rate_plan.py | 52 - ...t_product_rate_plan_migration_amendment.py | 33 +- ...test_product_rate_plan_migration_charge.py | 39 + test/test_product_rate_plan_paged_metadata.py | 52 - ...ate_plan_payments_result_paged_metadata.py | 52 - test/test_productrateplans_api.py | 158 - test/test_products_api.py | 118 - test/test_profile.py | 33 +- test/test_profile_paged_metadata.py | 52 - test/test_profiles_api.py | 86 - test/test_public_configuration_response.py | 39 + test/test_quote_request.py | 33 +- test/test_quote_request_value.py | 33 +- test/test_quotes_api.py | 43 +- test/test_recalculate_charge_batch_request.py | 39 + .../test_recalculate_charge_batch_response.py | 39 + test/test_recalculate_charge_request.py | 33 +- test/test_receipt.py | 33 +- test/test_receipt_paged_metadata.py | 52 - test/test_receipts_api.py | 55 +- test/test_refund.py | 33 +- test/test_refund_accounting_view.py | 39 + test/test_refund_paged_metadata.py | 52 - test/test_refunds_api.py | 110 - test/test_remove_credit_account_request.py | 39 + test/test_reports_api.py | 105 + test/test_resume_request.py | 33 +- test/test_resume_subscription_amendment.py | 33 +- test/test_revenue_attribution.py | 52 - ...test_revenue_attribution_paged_metadata.py | 52 - test/test_revenue_attributions.py | 39 + test/test_revive_subscription_request.py | 52 - test/test_role.py | 33 +- test/test_role_paged_metadata.py | 52 - test/test_roles_api.py | 94 - test/test_rule_satisfaction.py | 52 - test/test_sage_pay_auth_capture_request.py | 39 + test/test_sage_pay_card_payment.py | 39 + test/test_sage_pay_configuration.py | 39 + test/test_sage_pay_enabled_card_type.py | 39 + test/test_sage_pay_pre_auth_request.py | 39 + test/test_salesforce_api.py | 63 + .../test_salesforce_configuration_response.py | 39 + test/test_search_api.py | 54 - test/test_search_result_paged_metadata.py | 52 - test/test_security_api.py | 165 + test/test_service_end_amendment.py | 33 +- test/test_set_rate_plan_affiliate_request.py | 39 + ...test_set_subscription_affiliate_request.py | 39 + test/test_setup_charge.py | 39 + ...etup_pricing_components_by_charge_model.py | 39 + test/test_shuttle_auth_capture_request.py | 39 + test/test_shuttle_configuration.py | 39 + test/test_shuttle_payment.py | 39 + test/test_shuttle_pre_auth_request.py | 39 + test/test_simple_date_param.py | 39 + test/test_simple_user.py | 39 + .../test_single_recalculate_charge_request.py | 39 + test/test_spreedly_auth_capture_request.py | 39 + test/test_spreedly_configuration.py | 39 + test/test_spreedly_pre_auth_request.py | 39 + test/test_square_auth_capture_request.py | 39 + test/test_square_configuration.py | 39 + test/test_square_configuration_data.py | 39 + test/test_square_data.py | 39 + test/test_square_payment.py | 39 + test/test_square_subscription.py | 39 + test/test_start_all_subscriptions_request.py | 39 + test/test_start_all_subscriptions_response.py | 39 + test/test_start_contract_request.py | 39 + test/test_start_contract_response.py | 39 + test/test_stripe_ach_capture_request.py | 39 + test/test_stripe_ach_payment.py | 39 + test/test_stripe_ach_token.py | 39 + test/test_stripe_ach_token_paged_metadata.py | 52 - test/test_stripe_additional_data.py | 39 + test/test_stripe_auth_capture_request.py | 33 +- test/test_stripe_card_payment.py | 39 + test/test_stripe_configuration.py | 39 + test/test_stripe_object.py | 52 - test/test_stripe_pre_auth_request.py | 39 + test/test_stripe_token.py | 39 + test/test_stripe_token_paged_metadata.py | 52 - test/test_subscription.py | 33 +- test/test_subscription_cancellation.py | 39 + ...ubscription_cancellation_paged_metadata.py | 52 - test/test_subscription_charge.py | 33 +- ...test_subscription_charge_paged_metadata.py | 52 - ...st_subscription_checkout_action_request.py | 39 + ...ription_checkout_definition_description.py | 39 + test/test_subscription_checkout_response.py | 39 + ..._subscription_ltv_result_paged_metadata.py | 52 - test/test_subscription_paged_metadata.py | 52 - test/test_subscription_revive_amendment.py | 39 + ...est_subscription_revive_partial_request.py | 39 + test/test_subscription_revive_request.py | 39 + test/test_subscriptions_api.py | 259 +- test/test_swagger_type_list.py | 52 - test/test_swagger_type_list_inv.py | 33 +- test/test_swagger_type_list_subs.py | 33 +- test/test_sync_action_request.py | 39 + test/test_synch_app_configs_api.py | 78 - test/test_synch_configs_api.py | 94 - test/test_synch_jobs_api.py | 110 - test/test_tax_line.py | 39 + test/test_taxation_link_paged_metadata.py | 52 - test/test_taxation_strategy.py | 39 + test/test_taxation_strategy_paged_metadata.py | 52 - test/test_taxationlinks_api.py | 94 - test/test_taxationstrategies_api.py | 118 - test/test_taxes_api.py | 87 + test/test_tiered_advance_pricing_component.py | 39 + test/test_tiered_arrears_pricing_component.py | 39 + test/test_tiered_pricing_component.py | 33 +- test/test_tiered_setup_pricing_component.py | 39 + test/test_tiered_usage_pricing_component.py | 39 + test/test_tiered_volume_pricing_component.py | 33 +- test/test_time_api.py | 54 - test/test_time_request.py | 33 +- test/test_time_response.py | 33 +- test/test_time_response_paged_metadata.py | 52 - test/test_time_zone.py | 52 - test/test_timer_amendment.py | 33 +- test/test_tokenization_api.py | 215 +- test/test_tokenization_epxredirect_body.py | 39 + ...test_tokenization_payvisionshoutv1_body.py | 39 + test/test_tokenization_pre_auth.py | 39 + ...st_tokenization_pre_auth_paged_metadata.py | 52 - test/test_tokenization_pre_auth_request.py | 39 + ...est_tokenization_sagepaynotifyv300_body.py | 39 + test/test_tokens_response.py | 39 + test/test_trust_commerce_configuration.py | 39 + test/test_trust_commerce_token.py | 39 + ...est_trust_commerce_token_paged_metadata.py | 52 - ...test_typed_query_result_wrapper_account.py | 39 + ...test_typed_query_result_wrapper_address.py | 39 + ...st_typed_query_result_wrapper_amendment.py | 39 + ...st_typed_query_result_wrapper_api_quote.py | 39 + ...ery_result_wrapper_avatax_configuration.py | 39 + ...yped_query_result_wrapper_bf_permission.py | 39 + ...ed_query_result_wrapper_braintree_token.py | 39 + ...est_typed_query_result_wrapper_contract.py | 39 + .../test_typed_query_result_wrapper_coupon.py | 39 + ..._typed_query_result_wrapper_credit_note.py | 39 + ...y_result_wrapper_data_sync_job_response.py | 39 + ...typed_query_result_wrapper_dunning_line.py | 39 + ...test_typed_query_result_wrapper_invoice.py | 39 + ...ery_result_wrapper_invoice_line_payment.py | 39 + ...typed_query_result_wrapper_notification.py | 39 + ...test_typed_query_result_wrapper_payment.py | 39 + ...ped_query_result_wrapper_payment_method.py | 39 + ...yped_query_result_wrapper_plan_response.py | 39 + ...test_typed_query_result_wrapper_profile.py | 39 + ...test_typed_query_result_wrapper_receipt.py | 39 + .../test_typed_query_result_wrapper_refund.py | 39 + ...uery_result_wrapper_revenue_attribution.py | 39 + test/test_typed_query_result_wrapper_role.py | 39 + ...d_query_result_wrapper_stripe_ach_token.py | 39 + ...typed_query_result_wrapper_stripe_token.py | 39 + ...typed_query_result_wrapper_subscription.py | 39 + ...uery_result_wrapper_subscription_charge.py | 39 + ..._query_result_wrapper_taxation_strategy.py | 39 + ...yped_query_result_wrapper_user_response.py | 39 + ...test_typed_query_result_wrapper_webhook.py | 39 + test/test_unit_discount.py | 52 - test/test_unit_of_measure.py | 33 +- test/test_unit_of_measure_coupon_modifier.py | 52 - test/test_unit_of_measure_paged_metadata.py | 52 - test/test_unitofmeasure_api.py | 78 - test/test_update_address_request.py | 52 - test/test_update_component_value_amendment.py | 33 +- test/test_update_contract_request.py | 39 + test/test_update_email_request.py | 39 + test/test_update_invoice_request.py | 39 + test/test_update_invoice_template_request.py | 39 + test/test_update_password_request.py | 39 + test/test_update_password_response.py | 39 + ...e_pricing_component_value_change_result.py | 39 + ..._update_pricing_component_value_request.py | 39 + ...update_pricing_component_value_response.py | 39 + test/test_update_profile_request.py | 52 - ...test_update_rate_plan_affiliate_request.py | 39 + test/test_update_role_request.py | 33 +- ...update_salesforce_configuration_request.py | 39 + test/test_update_subscription_request.py | 33 +- test/test_update_user_info_request.py | 39 + test/test_upgrade_charge.py | 39 + test/test_usage.py | 52 - test/test_usage_api.py | 86 - test/test_usage_paged_metadata.py | 52 - test/test_usage_period_paged_metadata.py | 52 - ...sage_pricing_components_by_charge_model.py | 39 + ..._usage_rounding_strategy_paged_metadata.py | 52 - test/test_usage_session.py | 52 - test/test_usage_session_paged_metadata.py | 52 - test/test_usageperiods_api.py | 70 - test/test_usageroundingstrategies_api.py | 78 - test/test_usagesessions_api.py | 78 - test/test_user.py | 33 +- test/test_user_create_request.py | 39 + test/test_user_creation_request.py | 33 +- test/test_user_creation_response.py | 39 + ...t_user_creation_response_paged_metadata.py | 52 - test/test_user_invite_request.py | 39 + test/test_user_paged_metadata.py | 52 - ...private_permanent_token_refresh_request.py | 39 + ...st_user_private_permanent_token_request.py | 39 + test/test_user_response.py | 39 + test/test_user_timezone.py | 39 + test/test_username.py | 33 +- test/test_username_paged_metadata.py | 52 - test/test_username_response.py | 39 + test/test_usernames_api.py | 54 - test/test_users_api.py | 134 - test/test_value_increment.py | 39 + test/test_vaultedgateways_api.py | 150 - test/test_verify_payment_method_request.py | 39 + test/test_webhook.py | 39 + test/test_webhook_paged_metadata.py | 52 - test/test_webhook_subscription.py | 39 + test/test_webhooks_api.py | 59 +- test/test_zooz_capture_request.py | 39 + test/test_zooz_configuration.py | 39 + test/test_zooz_payment.py | 39 + tox.ini | 6 +- 2073 files changed, 190425 insertions(+), 161413 deletions(-) create mode 100644 .swagger-codegen/VERSION delete mode 100644 LICENSE create mode 100644 billforward/api/__init__.py create mode 100644 billforward/api/accounts_api.py create mode 100644 billforward/api/affiliation_api.py create mode 100644 billforward/api/avatax_api.py create mode 100644 billforward/api/card_connect_api.py create mode 100644 billforward/api/charges_api.py create mode 100644 billforward/api/checkout_api.py create mode 100644 billforward/api/contracts_api.py create mode 100644 billforward/api/coupons_api.py create mode 100644 billforward/api/default_api.py create mode 100644 billforward/api/dunning_api.py create mode 100644 billforward/api/ebanx_api.py create mode 100644 billforward/api/invoices_api.py create mode 100644 billforward/api/notifications_api.py create mode 100644 billforward/api/payment_gateway_api.py create mode 100644 billforward/api/payment_methods_api.py create mode 100644 billforward/api/payments_api.py create mode 100644 billforward/api/permissions_api.py create mode 100644 billforward/api/plans_api.py create mode 100644 billforward/api/quotes_api.py create mode 100644 billforward/api/receipts_api.py create mode 100644 billforward/api/reports_api.py create mode 100644 billforward/api/salesforce_api.py create mode 100644 billforward/api/security_api.py create mode 100644 billforward/api/subscriptions_api.py create mode 100644 billforward/api/taxes_api.py create mode 100644 billforward/api/tokenization_api.py create mode 100644 billforward/api/webhooks_api.py delete mode 100644 billforward/apis/__init__.py delete mode 100644 billforward/apis/accounts_api.py delete mode 100644 billforward/apis/addresses_api.py delete mode 100644 billforward/apis/amendments_api.py delete mode 100644 billforward/apis/analytics_api.py delete mode 100644 billforward/apis/auditlogs_api.py delete mode 100644 billforward/apis/charges_api.py delete mode 100644 billforward/apis/clients_api.py delete mode 100644 billforward/apis/configurations_api.py delete mode 100644 billforward/apis/couponbook_api.py delete mode 100644 billforward/apis/couponbookdefinition_api.py delete mode 100644 billforward/apis/coupondefinition_api.py delete mode 100644 billforward/apis/couponinstance_api.py delete mode 100644 billforward/apis/couponmodifier_api.py delete mode 100644 billforward/apis/couponrule_api.py delete mode 100644 billforward/apis/coupons_api.py delete mode 100644 billforward/apis/creditnotes_api.py delete mode 100644 billforward/apis/cybersourcetokens_api.py delete mode 100644 billforward/apis/dunninglines_api.py delete mode 100644 billforward/apis/emailproviders_api.py delete mode 100644 billforward/apis/emails_api.py delete mode 100644 billforward/apis/emailsubscriptions_api.py delete mode 100644 billforward/apis/fixedtermdefinitions_api.py delete mode 100644 billforward/apis/fixedterms_api.py delete mode 100644 billforward/apis/invoices_api.py delete mode 100644 billforward/apis/metadata_api.py delete mode 100644 billforward/apis/notifications_api.py delete mode 100644 billforward/apis/organizations_api.py delete mode 100644 billforward/apis/passwords_api.py delete mode 100644 billforward/apis/paymentmethods_api.py delete mode 100644 billforward/apis/paymentmethodsubscriptionlinks_api.py delete mode 100644 billforward/apis/payments_api.py delete mode 100644 billforward/apis/periods_api.py delete mode 100644 billforward/apis/permissions_api.py delete mode 100644 billforward/apis/pricingcalculator_api.py delete mode 100644 billforward/apis/pricingcomponents_api.py delete mode 100644 billforward/apis/pricingcomponenttiers_api.py delete mode 100644 billforward/apis/pricingcomponentvaluechanges_api.py delete mode 100644 billforward/apis/pricingcomponentvalues_api.py delete mode 100644 billforward/apis/productrateplans_api.py delete mode 100644 billforward/apis/products_api.py delete mode 100644 billforward/apis/profiles_api.py delete mode 100644 billforward/apis/quotes_api.py delete mode 100644 billforward/apis/receipts_api.py delete mode 100644 billforward/apis/refunds_api.py delete mode 100644 billforward/apis/roles_api.py delete mode 100644 billforward/apis/search_api.py delete mode 100644 billforward/apis/subscriptions_api.py delete mode 100644 billforward/apis/synch_app_configs_api.py delete mode 100644 billforward/apis/synch_configs_api.py delete mode 100644 billforward/apis/synch_jobs_api.py delete mode 100644 billforward/apis/taxationlinks_api.py delete mode 100644 billforward/apis/taxationstrategies_api.py delete mode 100644 billforward/apis/time_api.py delete mode 100644 billforward/apis/tokenization_api.py delete mode 100644 billforward/apis/unitofmeasure_api.py delete mode 100644 billforward/apis/usage_api.py delete mode 100644 billforward/apis/usageperiods_api.py delete mode 100644 billforward/apis/usageroundingstrategies_api.py delete mode 100644 billforward/apis/usagesessions_api.py delete mode 100644 billforward/apis/usernames_api.py delete mode 100644 billforward/apis/users_api.py delete mode 100644 billforward/apis/vaultedgateways_api.py delete mode 100644 billforward/apis/webhooks_api.py delete mode 100644 billforward/models/account_ltv_result_paged_metadata.py delete mode 100644 billforward/models/account_paged_metadata.py delete mode 100644 billforward/models/account_payments_result_paged_metadata.py create mode 100644 billforward/models/add_charge_response.py create mode 100644 billforward/models/add_charge_to_account_response.py create mode 100644 billforward/models/add_charges_to_account_api_request.py create mode 100644 billforward/models/add_contract_period_request.py delete mode 100644 billforward/models/add_taxation_strategy_request.py create mode 100644 billforward/models/additional_data.py delete mode 100644 billforward/models/address_paged_metadata.py create mode 100644 billforward/models/advance_pricing_components_by_charge_model.py create mode 100644 billforward/models/affiliate.py create mode 100644 billforward/models/affiliate_commission_charge.py create mode 100644 billforward/models/affiliate_rate_plan_relationships.py create mode 100644 billforward/models/affiliate_subscription_relationship.py delete mode 100644 billforward/models/aggregating_component.py create mode 100644 billforward/models/aggregating_component_description.py delete mode 100644 billforward/models/alias.py create mode 100644 billforward/models/allowed_webhook_subscription_values.py delete mode 100644 billforward/models/amendment_paged_metadata.py delete mode 100644 billforward/models/amendment_price_n_time_paged_metadata.py create mode 100644 billforward/models/api_configuration.py delete mode 100644 billforward/models/api_configuration_paged_metadata.py delete mode 100644 billforward/models/api_quote_paged_metadata.py create mode 100644 billforward/models/arrears_charge.py create mode 100644 billforward/models/arrears_pricing_components_by_charge_model.py delete mode 100644 billforward/models/audit_entry.py delete mode 100644 billforward/models/audit_entry_paged_metadata.py create mode 100644 billforward/models/authorize_net_configuration.py create mode 100644 billforward/models/authorize_net_payment.py create mode 100644 billforward/models/authorize_net_token.py delete mode 100644 billforward/models/authorize_net_token_paged_metadata.py create mode 100644 billforward/models/avatax_config_request.py create mode 100644 billforward/models/avatax_configuration.py create mode 100644 billforward/models/avatax_ping_request.py create mode 100644 billforward/models/avatax_ping_response.py create mode 100644 billforward/models/bank_account.py delete mode 100644 billforward/models/bank_account_verification_paged_metadata.py create mode 100644 billforward/models/batch_increment_values_request.py create mode 100644 billforward/models/batch_update_pricing_component_values_request.py delete mode 100644 billforward/models/bf_error.py delete mode 100644 billforward/models/bf_permission_paged_metadata.py delete mode 100644 billforward/models/billforward_managed_payments_result_paged_metadata.py create mode 100644 billforward/models/braintree_configuration.py create mode 100644 billforward/models/braintree_merchant_account.py create mode 100644 billforward/models/braintree_payment.py create mode 100644 billforward/models/braintree_pre_auth_request.py create mode 100644 billforward/models/braintree_token.py delete mode 100644 billforward/models/braintree_token_paged_metadata.py create mode 100644 billforward/models/calculator_result.py delete mode 100644 billforward/models/cancel_subscription_request.py create mode 100644 billforward/models/card_connect_auth_capture_request.py create mode 100644 billforward/models/card_connect_configuration.py create mode 100644 billforward/models/card_connect_gateway_request.py create mode 100644 billforward/models/card_connect_payment.py delete mode 100644 billforward/models/cass_churn_result_paged_metadata.py delete mode 100644 billforward/models/cass_payment_result_paged_metadata.py delete mode 100644 billforward/models/cass_upgrade_result_paged_metadata.py delete mode 100644 billforward/models/client.py delete mode 100644 billforward/models/client_paged_metadata.py create mode 100644 billforward/models/commission_structure.py delete mode 100644 billforward/models/component_cost.py delete mode 100644 billforward/models/compound_usage.py delete mode 100644 billforward/models/compound_usage_session.py create mode 100644 billforward/models/contract.py create mode 100644 billforward/models/contract_period.py delete mode 100644 billforward/models/coupon_book.py delete mode 100644 billforward/models/coupon_book_definition.py delete mode 100644 billforward/models/coupon_book_definition_paged_metadata.py delete mode 100644 billforward/models/coupon_book_paged_metadata.py create mode 100644 billforward/models/coupon_charge.py create mode 100644 billforward/models/coupon_code_response.py delete mode 100644 billforward/models/coupon_definition.py delete mode 100644 billforward/models/coupon_definition_paged_metadata.py delete mode 100644 billforward/models/coupon_discount_estimate.py delete mode 100644 billforward/models/coupon_instance_paged_metadata.py delete mode 100644 billforward/models/coupon_modifier_base.py delete mode 100644 billforward/models/coupon_modifier_base_paged_metadata.py delete mode 100644 billforward/models/coupon_paged_metadata.py create mode 100644 billforward/models/coupon_payment.py delete mode 100644 billforward/models/coupon_rule.py delete mode 100644 billforward/models/coupon_rule_paged_metadata.py delete mode 100644 billforward/models/coupon_unique_codes_response_paged_metadata.py delete mode 100644 billforward/models/create_account_profile_request.py delete mode 100644 billforward/models/create_account_request.py delete mode 100644 billforward/models/create_address_request.py create mode 100644 billforward/models/create_commission_invoice_request.py create mode 100644 billforward/models/create_contract_period_request.py create mode 100644 billforward/models/create_contract_request.py create mode 100644 billforward/models/create_coupon_discount_request.py create mode 100644 billforward/models/create_coupon_request.py create mode 100644 billforward/models/create_offline_payment_request.py create mode 100644 billforward/models/create_permission_on_role_request.py create mode 100644 billforward/models/create_permission_request.py create mode 100644 billforward/models/create_pricing_component_quantity_request.py delete mode 100644 billforward/models/create_profile_address_request.py create mode 100644 billforward/models/create_profile_request.py create mode 100644 billforward/models/create_role_request.py create mode 100644 billforward/models/create_salesforce_configuration_request.py create mode 100644 billforward/models/create_subscription_checkout_definition_request.py create mode 100644 billforward/models/create_subscription_timer_request.py create mode 100644 billforward/models/create_totp_request.py create mode 100644 billforward/models/credit_note_currency.py delete mode 100644 billforward/models/credit_note_paged_metadata.py create mode 100644 billforward/models/credit_note_payment.py create mode 100644 billforward/models/cybersource_configuration.py create mode 100644 billforward/models/cybersource_payment.py delete mode 100644 billforward/models/cybersource_token_paged_metadata.py create mode 100644 billforward/models/data_sync_job_error_response.py create mode 100644 billforward/models/data_sync_job_response.py delete mode 100644 billforward/models/data_synchronisation_app_configuration_paged_metadata.py delete mode 100644 billforward/models/data_synchronisation_configuration.py delete mode 100644 billforward/models/data_synchronisation_configuration_paged_metadata.py delete mode 100644 billforward/models/data_synchronization_job_paged_metadata.py delete mode 100644 billforward/models/debts_result_paged_metadata.py delete mode 100644 billforward/models/dunning_line_paged_metadata.py delete mode 100644 billforward/models/dynamic_metadata.py create mode 100644 billforward/models/ebanx_auth_capture_request.py create mode 100644 billforward/models/ebanx_configuration.py create mode 100644 billforward/models/ebanx_gateway_request.py create mode 100644 billforward/models/ebanx_payment.py create mode 100644 billforward/models/ebanx_webhook.py delete mode 100644 billforward/models/email.py delete mode 100644 billforward/models/email_paged_metadata.py delete mode 100644 billforward/models/email_provider.py delete mode 100644 billforward/models/email_provider_paged_metadata.py delete mode 100644 billforward/models/email_subscription.py delete mode 100644 billforward/models/email_subscription_paged_metadata.py create mode 100644 billforward/models/email_tokenization.py create mode 100644 billforward/models/email_tokenization_create_api_request.py create mode 100644 billforward/models/email_tokenization_send_api_request.py create mode 100644 billforward/models/email_tokenization_update_api_request.py create mode 100644 billforward/models/epx_capture_request.py create mode 100644 billforward/models/epx_configuration.py create mode 100644 billforward/models/epx_payment.py create mode 100644 billforward/models/epx_pre_auth_request.py create mode 100644 billforward/models/epx_pre_auth_response.py delete mode 100644 billforward/models/event.py delete mode 100644 billforward/models/event_data.py create mode 100644 billforward/models/execution_receipt_response.py create mode 100644 billforward/models/execution_response.py create mode 100644 billforward/models/extras.py delete mode 100644 billforward/models/file_sham.py create mode 100644 billforward/models/fixed_term_definition.py delete mode 100644 billforward/models/fixed_term_definition_paged_metadata.py delete mode 100644 billforward/models/fixed_term_paged_metadata.py create mode 100644 billforward/models/flat_advance_pricing_component.py create mode 100644 billforward/models/flat_arrears_pricing_component.py create mode 100644 billforward/models/flat_setup_pricing_component.py create mode 100644 billforward/models/flat_usage_pricing_component.py create mode 100644 billforward/models/get_rate_plan_affiliate_response.py create mode 100644 billforward/models/get_subscription_affiliate_response.py create mode 100644 billforward/models/go_cardless_configuration.py create mode 100644 billforward/models/go_cardless_tokenization_request.py create mode 100644 billforward/models/halt_aggregation_request.py create mode 100644 billforward/models/halt_aggregation_response.py create mode 100644 billforward/models/hosted_payment.py create mode 100644 billforward/models/hosted_payment_config.py create mode 100644 billforward/models/i_discardable.py create mode 100644 billforward/models/import_invoice_request.py create mode 100644 billforward/models/import_subscription_request.py create mode 100644 billforward/models/inline_response_default.py create mode 100644 billforward/models/inline_response_default1.py create mode 100644 billforward/models/inline_response_default10.py create mode 100644 billforward/models/inline_response_default100.py create mode 100644 billforward/models/inline_response_default101.py create mode 100644 billforward/models/inline_response_default102.py create mode 100644 billforward/models/inline_response_default103.py create mode 100644 billforward/models/inline_response_default11.py create mode 100644 billforward/models/inline_response_default12.py create mode 100644 billforward/models/inline_response_default13.py create mode 100644 billforward/models/inline_response_default14.py create mode 100644 billforward/models/inline_response_default15.py create mode 100644 billforward/models/inline_response_default16.py create mode 100644 billforward/models/inline_response_default17.py create mode 100644 billforward/models/inline_response_default18.py create mode 100644 billforward/models/inline_response_default19.py create mode 100644 billforward/models/inline_response_default2.py create mode 100644 billforward/models/inline_response_default20.py create mode 100644 billforward/models/inline_response_default21.py create mode 100644 billforward/models/inline_response_default22.py create mode 100644 billforward/models/inline_response_default23.py create mode 100644 billforward/models/inline_response_default24.py create mode 100644 billforward/models/inline_response_default25.py create mode 100644 billforward/models/inline_response_default26.py create mode 100644 billforward/models/inline_response_default27.py create mode 100644 billforward/models/inline_response_default28.py create mode 100644 billforward/models/inline_response_default29.py create mode 100644 billforward/models/inline_response_default3.py create mode 100644 billforward/models/inline_response_default30.py create mode 100644 billforward/models/inline_response_default31.py create mode 100644 billforward/models/inline_response_default32.py create mode 100644 billforward/models/inline_response_default33.py create mode 100644 billforward/models/inline_response_default34.py create mode 100644 billforward/models/inline_response_default35.py create mode 100644 billforward/models/inline_response_default36.py create mode 100644 billforward/models/inline_response_default37.py create mode 100644 billforward/models/inline_response_default38.py create mode 100644 billforward/models/inline_response_default39.py create mode 100644 billforward/models/inline_response_default4.py create mode 100644 billforward/models/inline_response_default40.py create mode 100644 billforward/models/inline_response_default41.py create mode 100644 billforward/models/inline_response_default42.py create mode 100644 billforward/models/inline_response_default43.py create mode 100644 billforward/models/inline_response_default44.py create mode 100644 billforward/models/inline_response_default45.py create mode 100644 billforward/models/inline_response_default46.py create mode 100644 billforward/models/inline_response_default47.py create mode 100644 billforward/models/inline_response_default48.py create mode 100644 billforward/models/inline_response_default49.py create mode 100644 billforward/models/inline_response_default5.py create mode 100644 billforward/models/inline_response_default50.py create mode 100644 billforward/models/inline_response_default51.py create mode 100644 billforward/models/inline_response_default52.py create mode 100644 billforward/models/inline_response_default53.py create mode 100644 billforward/models/inline_response_default54.py create mode 100644 billforward/models/inline_response_default55.py create mode 100644 billforward/models/inline_response_default56.py create mode 100644 billforward/models/inline_response_default57.py create mode 100644 billforward/models/inline_response_default58.py create mode 100644 billforward/models/inline_response_default59.py create mode 100644 billforward/models/inline_response_default6.py create mode 100644 billforward/models/inline_response_default60.py create mode 100644 billforward/models/inline_response_default61.py create mode 100644 billforward/models/inline_response_default62.py create mode 100644 billforward/models/inline_response_default63.py create mode 100644 billforward/models/inline_response_default64.py create mode 100644 billforward/models/inline_response_default65.py create mode 100644 billforward/models/inline_response_default66.py create mode 100644 billforward/models/inline_response_default67.py create mode 100644 billforward/models/inline_response_default68.py create mode 100644 billforward/models/inline_response_default69.py create mode 100644 billforward/models/inline_response_default7.py create mode 100644 billforward/models/inline_response_default70.py create mode 100644 billforward/models/inline_response_default71.py create mode 100644 billforward/models/inline_response_default72.py create mode 100644 billforward/models/inline_response_default73.py create mode 100644 billforward/models/inline_response_default74.py create mode 100644 billforward/models/inline_response_default75.py create mode 100644 billforward/models/inline_response_default76.py create mode 100644 billforward/models/inline_response_default77.py create mode 100644 billforward/models/inline_response_default78.py create mode 100644 billforward/models/inline_response_default79.py create mode 100644 billforward/models/inline_response_default8.py create mode 100644 billforward/models/inline_response_default80.py create mode 100644 billforward/models/inline_response_default81.py create mode 100644 billforward/models/inline_response_default82.py create mode 100644 billforward/models/inline_response_default83.py create mode 100644 billforward/models/inline_response_default84.py create mode 100644 billforward/models/inline_response_default85.py create mode 100644 billforward/models/inline_response_default86.py create mode 100644 billforward/models/inline_response_default87.py create mode 100644 billforward/models/inline_response_default88.py create mode 100644 billforward/models/inline_response_default89.py create mode 100644 billforward/models/inline_response_default9.py create mode 100644 billforward/models/inline_response_default90.py create mode 100644 billforward/models/inline_response_default91.py create mode 100644 billforward/models/inline_response_default92.py create mode 100644 billforward/models/inline_response_default93.py create mode 100644 billforward/models/inline_response_default94.py create mode 100644 billforward/models/inline_response_default95.py create mode 100644 billforward/models/inline_response_default96.py create mode 100644 billforward/models/inline_response_default97.py create mode 100644 billforward/models/inline_response_default98.py create mode 100644 billforward/models/inline_response_default99.py delete mode 100644 billforward/models/insertable_billing_entity.py create mode 100644 billforward/models/interval_date.py create mode 100644 billforward/models/invoice_execution_request.py delete mode 100644 billforward/models/invoice_line.py delete mode 100644 billforward/models/invoice_line_payment.py delete mode 100644 billforward/models/invoice_line_payment_paged_metadata.py create mode 100644 billforward/models/invoice_line_payments.py create mode 100644 billforward/models/invoice_lines.py delete mode 100644 billforward/models/invoice_paged_metadata.py delete mode 100644 billforward/models/invoice_payment.py create mode 100644 billforward/models/invoice_payments.py create mode 100644 billforward/models/invoice_refund_request.py create mode 100644 billforward/models/invoice_refund_response.py create mode 100644 billforward/models/invoice_split.py create mode 100644 billforward/models/invoice_split_service_request.py create mode 100644 billforward/models/invoice_template_config_response.py create mode 100644 billforward/models/issue_invoice_request.py create mode 100644 billforward/models/issue_invoice_response.py create mode 100644 billforward/models/kash_configuration.py create mode 100644 billforward/models/legacy_create_webhook_request.py create mode 100644 billforward/models/manual_charge.py create mode 100644 billforward/models/marketplace_quote.py create mode 100644 billforward/models/metadata.py create mode 100644 billforward/models/metadata_key_values.py delete mode 100644 billforward/models/metadata_key_values_paged_metadata.py create mode 100644 billforward/models/migration.py create mode 100644 billforward/models/migration_response.py delete mode 100644 billforward/models/mutable_billing_entity.py create mode 100644 billforward/models/nested_adhoc_charge_request.py create mode 100644 billforward/models/nested_charge_request.py delete mode 100644 billforward/models/notification.py delete mode 100644 billforward/models/notification_paged_metadata.py create mode 100644 billforward/models/notification_send_request.py create mode 100644 billforward/models/notification_send_response.py create mode 100644 billforward/models/notifications.py create mode 100644 billforward/models/o_auth_token.py create mode 100644 billforward/models/offline_payment.py create mode 100644 billforward/models/open_id_registration_response.py create mode 100644 billforward/models/open_id_user_link_request.py delete mode 100644 billforward/models/organization.py create mode 100644 billforward/models/organization_lite_view.py delete mode 100644 billforward/models/organization_paged_metadata.py delete mode 100644 billforward/models/password_paged_metadata.py create mode 100644 billforward/models/password_reset_code_request.py delete mode 100644 billforward/models/password_reset_request.py create mode 100644 billforward/models/password_reset_response.py create mode 100644 billforward/models/password_update_with_reset_code_request.py create mode 100644 billforward/models/pay_vision_auth_capture_request.py create mode 100644 billforward/models/pay_vision_configuration.py create mode 100644 billforward/models/pay_vision_pre_auth_request.py create mode 100644 billforward/models/payment_accounting_view.py delete mode 100644 billforward/models/payment_method_paged_metadata.py delete mode 100644 billforward/models/payment_method_subscription_link_paged_metadata.py delete mode 100644 billforward/models/payment_paged_metadata.py create mode 100644 billforward/models/payment_refund_request.py create mode 100644 billforward/models/payment_refund_response.py create mode 100644 billforward/models/paypal_configuration.py create mode 100644 billforward/models/paypal_payment.py delete mode 100644 billforward/models/period.py delete mode 100644 billforward/models/period_paged_metadata.py create mode 100644 billforward/models/permission_action_entity.py delete mode 100644 billforward/models/permission_action_entity_paged_metadata.py create mode 100644 billforward/models/permission_resource_entity.py delete mode 100644 billforward/models/permission_resource_entity_paged_metadata.py create mode 100644 billforward/models/plan_aggregation.py create mode 100644 billforward/models/plan_request.py create mode 100644 billforward/models/plan_response.py create mode 100644 billforward/models/prepayment_charge.py create mode 100644 billforward/models/price_breakdown.py delete mode 100644 billforward/models/price_calculation_paged_metadata.py create mode 100644 billforward/models/price_line.py create mode 100644 billforward/models/pricing_component_charge.py delete mode 100644 billforward/models/pricing_component_coupon_modifier.py delete mode 100644 billforward/models/pricing_component_paged_metadata.py delete mode 100644 billforward/models/pricing_component_quantity_request.py delete mode 100644 billforward/models/pricing_component_tier_paged_metadata.py create mode 100644 billforward/models/pricing_component_value_amendment.py create mode 100644 billforward/models/pricing_component_value_change.py delete mode 100644 billforward/models/pricing_component_value_change_amendment.py delete mode 100644 billforward/models/pricing_component_value_change_paged_metadata.py delete mode 100644 billforward/models/pricing_component_value_paged_metadata.py create mode 100644 billforward/models/pricing_component_value_response.py delete mode 100644 billforward/models/pricing_component_value_response_paged_metadata.py create mode 100644 billforward/models/pricing_components_by_charge_type.py create mode 100644 billforward/models/pricing_tier.py delete mode 100644 billforward/models/product.py delete mode 100644 billforward/models/product_coupon_modifier.py delete mode 100644 billforward/models/product_paged_metadata.py delete mode 100644 billforward/models/product_payments_result_paged_metadata.py delete mode 100644 billforward/models/product_rate_plan.py create mode 100644 billforward/models/product_rate_plan_migration_charge.py delete mode 100644 billforward/models/product_rate_plan_paged_metadata.py delete mode 100644 billforward/models/product_rate_plan_payments_result_paged_metadata.py delete mode 100644 billforward/models/profile_paged_metadata.py create mode 100644 billforward/models/public_configuration_response.py create mode 100644 billforward/models/recalculate_charge_batch_request.py create mode 100644 billforward/models/recalculate_charge_batch_response.py delete mode 100644 billforward/models/receipt_paged_metadata.py create mode 100644 billforward/models/refund_accounting_view.py delete mode 100644 billforward/models/refund_paged_metadata.py create mode 100644 billforward/models/remove_credit_account_request.py delete mode 100644 billforward/models/revenue_attribution.py delete mode 100644 billforward/models/revenue_attribution_paged_metadata.py create mode 100644 billforward/models/revenue_attributions.py delete mode 100644 billforward/models/revive_subscription_request.py delete mode 100644 billforward/models/role_paged_metadata.py delete mode 100644 billforward/models/rule_satisfaction.py create mode 100644 billforward/models/sage_pay_auth_capture_request.py create mode 100644 billforward/models/sage_pay_card_payment.py create mode 100644 billforward/models/sage_pay_configuration.py create mode 100644 billforward/models/sage_pay_enabled_card_type.py create mode 100644 billforward/models/sage_pay_pre_auth_request.py create mode 100644 billforward/models/salesforce_configuration_response.py delete mode 100644 billforward/models/search_result_paged_metadata.py create mode 100644 billforward/models/set_rate_plan_affiliate_request.py create mode 100644 billforward/models/set_subscription_affiliate_request.py create mode 100644 billforward/models/setup_charge.py create mode 100644 billforward/models/setup_pricing_components_by_charge_model.py create mode 100644 billforward/models/shuttle_auth_capture_request.py create mode 100644 billforward/models/shuttle_configuration.py create mode 100644 billforward/models/shuttle_payment.py create mode 100644 billforward/models/shuttle_pre_auth_request.py create mode 100644 billforward/models/simple_date_param.py create mode 100644 billforward/models/simple_user.py create mode 100644 billforward/models/single_recalculate_charge_request.py create mode 100644 billforward/models/spreedly_auth_capture_request.py create mode 100644 billforward/models/spreedly_configuration.py create mode 100644 billforward/models/spreedly_pre_auth_request.py create mode 100644 billforward/models/square_auth_capture_request.py create mode 100644 billforward/models/square_configuration.py create mode 100644 billforward/models/square_configuration_data.py create mode 100644 billforward/models/square_data.py create mode 100644 billforward/models/square_payment.py create mode 100644 billforward/models/square_subscription.py create mode 100644 billforward/models/start_all_subscriptions_request.py create mode 100644 billforward/models/start_all_subscriptions_response.py create mode 100644 billforward/models/start_contract_request.py create mode 100644 billforward/models/start_contract_response.py create mode 100644 billforward/models/stripe_ach_capture_request.py create mode 100644 billforward/models/stripe_ach_payment.py create mode 100644 billforward/models/stripe_ach_token.py delete mode 100644 billforward/models/stripe_ach_token_paged_metadata.py create mode 100644 billforward/models/stripe_additional_data.py create mode 100644 billforward/models/stripe_card_payment.py create mode 100644 billforward/models/stripe_configuration.py delete mode 100644 billforward/models/stripe_object.py create mode 100644 billforward/models/stripe_pre_auth_request.py create mode 100644 billforward/models/stripe_token.py delete mode 100644 billforward/models/stripe_token_paged_metadata.py create mode 100644 billforward/models/subscription_cancellation.py delete mode 100644 billforward/models/subscription_cancellation_paged_metadata.py delete mode 100644 billforward/models/subscription_charge_paged_metadata.py create mode 100644 billforward/models/subscription_checkout_action_request.py create mode 100644 billforward/models/subscription_checkout_definition_description.py create mode 100644 billforward/models/subscription_checkout_response.py delete mode 100644 billforward/models/subscription_ltv_result_paged_metadata.py delete mode 100644 billforward/models/subscription_paged_metadata.py create mode 100644 billforward/models/subscription_revive_amendment.py create mode 100644 billforward/models/subscription_revive_partial_request.py create mode 100644 billforward/models/subscription_revive_request.py delete mode 100644 billforward/models/swagger_type_list.py create mode 100644 billforward/models/sync_action_request.py create mode 100644 billforward/models/tax_line.py delete mode 100644 billforward/models/taxation_link_paged_metadata.py create mode 100644 billforward/models/taxation_strategy.py delete mode 100644 billforward/models/taxation_strategy_paged_metadata.py create mode 100644 billforward/models/tiered_advance_pricing_component.py create mode 100644 billforward/models/tiered_arrears_pricing_component.py create mode 100644 billforward/models/tiered_setup_pricing_component.py create mode 100644 billforward/models/tiered_usage_pricing_component.py delete mode 100644 billforward/models/time_response_paged_metadata.py delete mode 100644 billforward/models/time_zone.py create mode 100644 billforward/models/tokenization_epxredirect_body.py create mode 100644 billforward/models/tokenization_payvisionshoutv1_body.py create mode 100644 billforward/models/tokenization_pre_auth.py delete mode 100644 billforward/models/tokenization_pre_auth_paged_metadata.py create mode 100644 billforward/models/tokenization_pre_auth_request.py create mode 100644 billforward/models/tokenization_sagepaynotifyv300_body.py create mode 100644 billforward/models/tokens_response.py create mode 100644 billforward/models/trust_commerce_configuration.py create mode 100644 billforward/models/trust_commerce_token.py delete mode 100644 billforward/models/trust_commerce_token_paged_metadata.py create mode 100644 billforward/models/typed_query_result_wrapper_account.py create mode 100644 billforward/models/typed_query_result_wrapper_address.py create mode 100644 billforward/models/typed_query_result_wrapper_amendment.py create mode 100644 billforward/models/typed_query_result_wrapper_api_quote.py create mode 100644 billforward/models/typed_query_result_wrapper_avatax_configuration.py create mode 100644 billforward/models/typed_query_result_wrapper_bf_permission.py create mode 100644 billforward/models/typed_query_result_wrapper_braintree_token.py create mode 100644 billforward/models/typed_query_result_wrapper_contract.py create mode 100644 billforward/models/typed_query_result_wrapper_coupon.py create mode 100644 billforward/models/typed_query_result_wrapper_credit_note.py create mode 100644 billforward/models/typed_query_result_wrapper_data_sync_job_response.py create mode 100644 billforward/models/typed_query_result_wrapper_dunning_line.py create mode 100644 billforward/models/typed_query_result_wrapper_invoice.py create mode 100644 billforward/models/typed_query_result_wrapper_invoice_line_payment.py create mode 100644 billforward/models/typed_query_result_wrapper_notification.py create mode 100644 billforward/models/typed_query_result_wrapper_payment.py create mode 100644 billforward/models/typed_query_result_wrapper_payment_method.py create mode 100644 billforward/models/typed_query_result_wrapper_plan_response.py create mode 100644 billforward/models/typed_query_result_wrapper_profile.py create mode 100644 billforward/models/typed_query_result_wrapper_receipt.py create mode 100644 billforward/models/typed_query_result_wrapper_refund.py create mode 100644 billforward/models/typed_query_result_wrapper_revenue_attribution.py create mode 100644 billforward/models/typed_query_result_wrapper_role.py create mode 100644 billforward/models/typed_query_result_wrapper_stripe_ach_token.py create mode 100644 billforward/models/typed_query_result_wrapper_stripe_token.py create mode 100644 billforward/models/typed_query_result_wrapper_subscription.py create mode 100644 billforward/models/typed_query_result_wrapper_subscription_charge.py create mode 100644 billforward/models/typed_query_result_wrapper_taxation_strategy.py create mode 100644 billforward/models/typed_query_result_wrapper_user_response.py create mode 100644 billforward/models/typed_query_result_wrapper_webhook.py delete mode 100644 billforward/models/unit_discount.py delete mode 100644 billforward/models/unit_of_measure_coupon_modifier.py delete mode 100644 billforward/models/unit_of_measure_paged_metadata.py delete mode 100644 billforward/models/update_address_request.py create mode 100644 billforward/models/update_contract_request.py create mode 100644 billforward/models/update_email_request.py create mode 100644 billforward/models/update_invoice_request.py create mode 100644 billforward/models/update_invoice_template_request.py create mode 100644 billforward/models/update_password_request.py create mode 100644 billforward/models/update_password_response.py create mode 100644 billforward/models/update_pricing_component_value_change_result.py create mode 100644 billforward/models/update_pricing_component_value_request.py create mode 100644 billforward/models/update_pricing_component_value_response.py delete mode 100644 billforward/models/update_profile_request.py create mode 100644 billforward/models/update_rate_plan_affiliate_request.py create mode 100644 billforward/models/update_salesforce_configuration_request.py create mode 100644 billforward/models/update_user_info_request.py create mode 100644 billforward/models/upgrade_charge.py delete mode 100644 billforward/models/usage.py delete mode 100644 billforward/models/usage_paged_metadata.py delete mode 100644 billforward/models/usage_period_paged_metadata.py create mode 100644 billforward/models/usage_pricing_components_by_charge_model.py delete mode 100644 billforward/models/usage_rounding_strategy_paged_metadata.py delete mode 100644 billforward/models/usage_session.py delete mode 100644 billforward/models/usage_session_paged_metadata.py create mode 100644 billforward/models/user_create_request.py create mode 100644 billforward/models/user_creation_response.py delete mode 100644 billforward/models/user_creation_response_paged_metadata.py create mode 100644 billforward/models/user_invite_request.py delete mode 100644 billforward/models/user_paged_metadata.py create mode 100644 billforward/models/user_private_permanent_token_refresh_request.py create mode 100644 billforward/models/user_private_permanent_token_request.py create mode 100644 billforward/models/user_response.py create mode 100644 billforward/models/user_timezone.py delete mode 100644 billforward/models/username_paged_metadata.py create mode 100644 billforward/models/username_response.py create mode 100644 billforward/models/value_increment.py create mode 100644 billforward/models/verify_payment_method_request.py create mode 100644 billforward/models/webhook.py delete mode 100644 billforward/models/webhook_paged_metadata.py create mode 100644 billforward/models/webhook_subscription.py create mode 100644 billforward/models/zooz_capture_request.py create mode 100644 billforward/models/zooz_configuration.py create mode 100644 billforward/models/zooz_payment.py create mode 100644 docs/APIConfiguration.md delete mode 100644 docs/APIConfigurationPagedMetadata.md delete mode 100644 docs/APIQuotePagedMetadata.md delete mode 100644 docs/AccountLTVResultPagedMetadata.md delete mode 100644 docs/AccountPagedMetadata.md delete mode 100644 docs/AccountPaymentsResultPagedMetadata.md create mode 100644 docs/AddChargeResponse.md create mode 100644 docs/AddChargeToAccountResponse.md create mode 100644 docs/AddChargesToAccountAPIRequest.md create mode 100644 docs/AddContractPeriodRequest.md delete mode 100644 docs/AddTaxationStrategyRequest.md rename docs/{ReviveSubscriptionRequest.md => AdditionalData.md} (80%) delete mode 100644 docs/AddressPagedMetadata.md delete mode 100644 docs/AddressesApi.md create mode 100644 docs/AdvancePricingComponentsByChargeModel.md create mode 100644 docs/Affiliate.md create mode 100644 docs/AffiliateCommissionCharge.md create mode 100644 docs/AffiliateRatePlanRelationships.md create mode 100644 docs/AffiliateSubscriptionRelationship.md create mode 100644 docs/AffiliationApi.md delete mode 100644 docs/AggregatingComponent.md rename docs/{ComponentCost.md => AggregatingComponentDescription.md} (84%) delete mode 100644 docs/Alias.md create mode 100644 docs/AllowedWebhookSubscriptionValues.md delete mode 100644 docs/AmendmentPagedMetadata.md delete mode 100644 docs/AmendmentPriceNTimePagedMetadata.md delete mode 100644 docs/AmendmentsApi.md delete mode 100644 docs/AnalyticsApi.md create mode 100644 docs/ArrearsCharge.md create mode 100644 docs/ArrearsPricingComponentsByChargeModel.md delete mode 100644 docs/AuditEntry.md delete mode 100644 docs/AuditEntryPagedMetadata.md delete mode 100644 docs/AuditlogsApi.md create mode 100644 docs/AuthorizeNetConfiguration.md create mode 100644 docs/AuthorizeNetPayment.md create mode 100644 docs/AuthorizeNetToken.md delete mode 100644 docs/AuthorizeNetTokenPagedMetadata.md create mode 100644 docs/AvataxApi.md create mode 100644 docs/AvataxConfigRequest.md create mode 100644 docs/AvataxConfiguration.md create mode 100644 docs/AvataxPingRequest.md create mode 100644 docs/AvataxPingResponse.md delete mode 100644 docs/BFError.md delete mode 100644 docs/BFPermissionPagedMetadata.md create mode 100644 docs/BankAccount.md delete mode 100644 docs/BankAccountVerificationPagedMetadata.md create mode 100644 docs/BatchIncrementValuesRequest.md create mode 100644 docs/BatchUpdatePricingComponentValuesRequest.md delete mode 100644 docs/BillforwardManagedPaymentsResultPagedMetadata.md create mode 100644 docs/BraintreeConfiguration.md create mode 100644 docs/BraintreeMerchantAccount.md rename docs/{DynamicMetadata.md => BraintreePayment.md} (93%) create mode 100644 docs/BraintreePreAuthRequest.md create mode 100644 docs/BraintreeToken.md delete mode 100644 docs/BraintreeTokenPagedMetadata.md create mode 100644 docs/CalculatorResult.md delete mode 100644 docs/CancelSubscriptionRequest.md create mode 100644 docs/CardConnectApi.md create mode 100644 docs/CardConnectAuthCaptureRequest.md create mode 100644 docs/CardConnectConfiguration.md create mode 100644 docs/CardConnectGatewayRequest.md create mode 100644 docs/CardConnectPayment.md delete mode 100644 docs/CassChurnResultPagedMetadata.md delete mode 100644 docs/CassPaymentResultPagedMetadata.md delete mode 100644 docs/CassUpgradeResultPagedMetadata.md create mode 100644 docs/CheckoutApi.md delete mode 100644 docs/Client.md delete mode 100644 docs/ClientPagedMetadata.md delete mode 100644 docs/ClientsApi.md create mode 100644 docs/CommissionStructure.md delete mode 100644 docs/CompoundUsage.md delete mode 100644 docs/CompoundUsageSession.md delete mode 100644 docs/ConfigurationsApi.md create mode 100644 docs/Contract.md create mode 100644 docs/ContractPeriod.md create mode 100644 docs/ContractsApi.md delete mode 100644 docs/CouponBook.md delete mode 100644 docs/CouponBookDefinition.md delete mode 100644 docs/CouponBookDefinitionPagedMetadata.md delete mode 100644 docs/CouponBookPagedMetadata.md create mode 100644 docs/CouponCharge.md create mode 100644 docs/CouponCodeResponse.md delete mode 100644 docs/CouponDefinition.md delete mode 100644 docs/CouponDefinitionPagedMetadata.md delete mode 100644 docs/CouponDiscountEstimate.md delete mode 100644 docs/CouponInstancePagedMetadata.md delete mode 100644 docs/CouponModifierBase.md delete mode 100644 docs/CouponModifierBasePagedMetadata.md delete mode 100644 docs/CouponPagedMetadata.md rename docs/{StripeObject.md => CouponPayment.md} (94%) delete mode 100644 docs/CouponRule.md delete mode 100644 docs/CouponRulePagedMetadata.md delete mode 100644 docs/CouponUniqueCodesResponsePagedMetadata.md delete mode 100644 docs/CouponbookApi.md delete mode 100644 docs/CouponbookdefinitionApi.md delete mode 100644 docs/CoupondefinitionApi.md delete mode 100644 docs/CouponinstanceApi.md delete mode 100644 docs/CouponmodifierApi.md delete mode 100644 docs/CouponruleApi.md delete mode 100644 docs/CreateAccountProfileRequest.md delete mode 100644 docs/CreateAccountRequest.md delete mode 100644 docs/CreateAddressRequest.md create mode 100644 docs/CreateCommissionInvoiceRequest.md create mode 100644 docs/CreateContractPeriodRequest.md create mode 100644 docs/CreateContractRequest.md create mode 100644 docs/CreateCouponDiscountRequest.md create mode 100644 docs/CreateCouponRequest.md create mode 100644 docs/CreateOfflinePaymentRequest.md create mode 100644 docs/CreatePermissionOnRoleRequest.md create mode 100644 docs/CreatePermissionRequest.md create mode 100644 docs/CreatePricingComponentQuantityRequest.md delete mode 100644 docs/CreateProfileAddressRequest.md create mode 100644 docs/CreateProfileRequest.md create mode 100644 docs/CreateRoleRequest.md create mode 100644 docs/CreateSalesforceConfigurationRequest.md create mode 100644 docs/CreateSubscriptionCheckoutDefinitionRequest.md create mode 100644 docs/CreateSubscriptionTimerRequest.md create mode 100644 docs/CreateTOTPRequest.md create mode 100644 docs/CreditNoteCurrency.md delete mode 100644 docs/CreditNotePagedMetadata.md create mode 100644 docs/CreditNotePayment.md delete mode 100644 docs/CreditnotesApi.md create mode 100644 docs/CybersourceConfiguration.md create mode 100644 docs/CybersourcePayment.md delete mode 100644 docs/CybersourceTokenPagedMetadata.md delete mode 100644 docs/CybersourcetokensApi.md create mode 100644 docs/DataSyncJobErrorResponse.md create mode 100644 docs/DataSyncJobResponse.md delete mode 100644 docs/DataSynchronisationAppConfigurationPagedMetadata.md delete mode 100644 docs/DataSynchronisationConfiguration.md delete mode 100644 docs/DataSynchronisationConfigurationPagedMetadata.md delete mode 100644 docs/DataSynchronizationJobPagedMetadata.md delete mode 100644 docs/DebtsResultPagedMetadata.md create mode 100644 docs/DefaultApi.md create mode 100644 docs/DunningApi.md delete mode 100644 docs/DunningLinePagedMetadata.md delete mode 100644 docs/DunninglinesApi.md create mode 100644 docs/EBANXApi.md create mode 100644 docs/EBANXAuthCaptureRequest.md create mode 100644 docs/EBANXConfiguration.md create mode 100644 docs/EBANXGatewayRequest.md create mode 100644 docs/EBANXPayment.md create mode 100644 docs/EBANXWebhook.md delete mode 100644 docs/Email.md delete mode 100644 docs/EmailPagedMetadata.md delete mode 100644 docs/EmailProvider.md delete mode 100644 docs/EmailProviderPagedMetadata.md delete mode 100644 docs/EmailSubscription.md delete mode 100644 docs/EmailSubscriptionPagedMetadata.md create mode 100644 docs/EmailTokenization.md create mode 100644 docs/EmailTokenizationCreateAPIRequest.md create mode 100644 docs/EmailTokenizationSendAPIRequest.md create mode 100644 docs/EmailTokenizationUpdateAPIRequest.md delete mode 100644 docs/EmailprovidersApi.md delete mode 100644 docs/EmailsApi.md delete mode 100644 docs/EmailsubscriptionsApi.md create mode 100644 docs/EpxCaptureRequest.md create mode 100644 docs/EpxConfiguration.md rename docs/{FileSham.md => EpxPayment.md} (95%) create mode 100644 docs/EpxPreAuthRequest.md create mode 100644 docs/EpxPreAuthResponse.md delete mode 100644 docs/Event.md create mode 100644 docs/ExecutionReceiptResponse.md create mode 100644 docs/ExecutionResponse.md create mode 100644 docs/Extras.md create mode 100644 docs/FixedTermDefinition.md delete mode 100644 docs/FixedTermDefinitionPagedMetadata.md delete mode 100644 docs/FixedTermPagedMetadata.md delete mode 100644 docs/FixedtermdefinitionsApi.md delete mode 100644 docs/FixedtermsApi.md create mode 100644 docs/FlatAdvancePricingComponent.md create mode 100644 docs/FlatArrearsPricingComponent.md create mode 100644 docs/FlatSetupPricingComponent.md create mode 100644 docs/FlatUsagePricingComponent.md create mode 100644 docs/GetRatePlanAffiliateResponse.md create mode 100644 docs/GetSubscriptionAffiliateResponse.md create mode 100644 docs/GoCardlessConfiguration.md create mode 100644 docs/GoCardlessTokenizationRequest.md create mode 100644 docs/HaltAggregationRequest.md create mode 100644 docs/HaltAggregationResponse.md create mode 100644 docs/HostedPayment.md create mode 100644 docs/HostedPaymentConfig.md create mode 100644 docs/IDiscardable.md create mode 100644 docs/ImportInvoiceRequest.md create mode 100644 docs/ImportSubscriptionRequest.md create mode 100644 docs/InlineResponseDefault.md create mode 100644 docs/InlineResponseDefault1.md create mode 100644 docs/InlineResponseDefault10.md create mode 100644 docs/InlineResponseDefault100.md create mode 100644 docs/InlineResponseDefault101.md create mode 100644 docs/InlineResponseDefault102.md create mode 100644 docs/InlineResponseDefault103.md create mode 100644 docs/InlineResponseDefault11.md create mode 100644 docs/InlineResponseDefault12.md create mode 100644 docs/InlineResponseDefault13.md create mode 100644 docs/InlineResponseDefault14.md create mode 100644 docs/InlineResponseDefault15.md create mode 100644 docs/InlineResponseDefault16.md create mode 100644 docs/InlineResponseDefault17.md create mode 100644 docs/InlineResponseDefault18.md create mode 100644 docs/InlineResponseDefault19.md create mode 100644 docs/InlineResponseDefault2.md create mode 100644 docs/InlineResponseDefault20.md create mode 100644 docs/InlineResponseDefault21.md create mode 100644 docs/InlineResponseDefault22.md create mode 100644 docs/InlineResponseDefault23.md create mode 100644 docs/InlineResponseDefault24.md create mode 100644 docs/InlineResponseDefault25.md create mode 100644 docs/InlineResponseDefault26.md create mode 100644 docs/InlineResponseDefault27.md create mode 100644 docs/InlineResponseDefault28.md create mode 100644 docs/InlineResponseDefault29.md create mode 100644 docs/InlineResponseDefault3.md create mode 100644 docs/InlineResponseDefault30.md create mode 100644 docs/InlineResponseDefault31.md create mode 100644 docs/InlineResponseDefault32.md create mode 100644 docs/InlineResponseDefault33.md create mode 100644 docs/InlineResponseDefault34.md create mode 100644 docs/InlineResponseDefault35.md create mode 100644 docs/InlineResponseDefault36.md create mode 100644 docs/InlineResponseDefault37.md create mode 100644 docs/InlineResponseDefault38.md create mode 100644 docs/InlineResponseDefault39.md create mode 100644 docs/InlineResponseDefault4.md create mode 100644 docs/InlineResponseDefault40.md create mode 100644 docs/InlineResponseDefault41.md create mode 100644 docs/InlineResponseDefault42.md create mode 100644 docs/InlineResponseDefault43.md create mode 100644 docs/InlineResponseDefault44.md create mode 100644 docs/InlineResponseDefault45.md create mode 100644 docs/InlineResponseDefault46.md create mode 100644 docs/InlineResponseDefault47.md create mode 100644 docs/InlineResponseDefault48.md create mode 100644 docs/InlineResponseDefault49.md create mode 100644 docs/InlineResponseDefault5.md create mode 100644 docs/InlineResponseDefault50.md create mode 100644 docs/InlineResponseDefault51.md create mode 100644 docs/InlineResponseDefault52.md create mode 100644 docs/InlineResponseDefault53.md create mode 100644 docs/InlineResponseDefault54.md create mode 100644 docs/InlineResponseDefault55.md create mode 100644 docs/InlineResponseDefault56.md create mode 100644 docs/InlineResponseDefault57.md create mode 100644 docs/InlineResponseDefault58.md create mode 100644 docs/InlineResponseDefault59.md create mode 100644 docs/InlineResponseDefault6.md create mode 100644 docs/InlineResponseDefault60.md create mode 100644 docs/InlineResponseDefault61.md create mode 100644 docs/InlineResponseDefault62.md create mode 100644 docs/InlineResponseDefault63.md create mode 100644 docs/InlineResponseDefault64.md create mode 100644 docs/InlineResponseDefault65.md create mode 100644 docs/InlineResponseDefault66.md create mode 100644 docs/InlineResponseDefault67.md create mode 100644 docs/InlineResponseDefault68.md create mode 100644 docs/InlineResponseDefault69.md create mode 100644 docs/InlineResponseDefault7.md create mode 100644 docs/InlineResponseDefault70.md create mode 100644 docs/InlineResponseDefault71.md create mode 100644 docs/InlineResponseDefault72.md create mode 100644 docs/InlineResponseDefault73.md create mode 100644 docs/InlineResponseDefault74.md create mode 100644 docs/InlineResponseDefault75.md create mode 100644 docs/InlineResponseDefault76.md create mode 100644 docs/InlineResponseDefault77.md create mode 100644 docs/InlineResponseDefault78.md create mode 100644 docs/InlineResponseDefault79.md create mode 100644 docs/InlineResponseDefault8.md create mode 100644 docs/InlineResponseDefault80.md create mode 100644 docs/InlineResponseDefault81.md create mode 100644 docs/InlineResponseDefault82.md create mode 100644 docs/InlineResponseDefault83.md create mode 100644 docs/InlineResponseDefault84.md create mode 100644 docs/InlineResponseDefault85.md create mode 100644 docs/InlineResponseDefault86.md create mode 100644 docs/InlineResponseDefault87.md create mode 100644 docs/InlineResponseDefault88.md create mode 100644 docs/InlineResponseDefault89.md create mode 100644 docs/InlineResponseDefault9.md create mode 100644 docs/InlineResponseDefault90.md create mode 100644 docs/InlineResponseDefault91.md create mode 100644 docs/InlineResponseDefault92.md create mode 100644 docs/InlineResponseDefault93.md create mode 100644 docs/InlineResponseDefault94.md create mode 100644 docs/InlineResponseDefault95.md create mode 100644 docs/InlineResponseDefault96.md create mode 100644 docs/InlineResponseDefault97.md create mode 100644 docs/InlineResponseDefault98.md create mode 100644 docs/InlineResponseDefault99.md delete mode 100644 docs/InsertableBillingEntity.md create mode 100644 docs/IntervalDate.md create mode 100644 docs/InvoiceExecutionRequest.md delete mode 100644 docs/InvoiceLine.md delete mode 100644 docs/InvoiceLinePayment.md delete mode 100644 docs/InvoiceLinePaymentPagedMetadata.md create mode 100644 docs/InvoiceLinePayments.md create mode 100644 docs/InvoiceLines.md delete mode 100644 docs/InvoicePagedMetadata.md delete mode 100644 docs/InvoicePayment.md create mode 100644 docs/InvoicePayments.md create mode 100644 docs/InvoiceRefundRequest.md create mode 100644 docs/InvoiceRefundResponse.md create mode 100644 docs/InvoiceSplit.md create mode 100644 docs/InvoiceSplitServiceRequest.md create mode 100644 docs/InvoiceTemplateConfigResponse.md create mode 100644 docs/IssueInvoiceRequest.md create mode 100644 docs/IssueInvoiceResponse.md create mode 100644 docs/KashConfiguration.md create mode 100644 docs/LegacyCreateWebhookRequest.md create mode 100644 docs/ManualCharge.md create mode 100644 docs/MarketplaceQuote.md create mode 100644 docs/Metadata.md delete mode 100644 docs/MetadataApi.md create mode 100644 docs/MetadataKeyValues.md delete mode 100644 docs/MetadataKeyValuesPagedMetadata.md create mode 100644 docs/Migration.md create mode 100644 docs/MigrationResponse.md delete mode 100644 docs/MutableBillingEntity.md create mode 100644 docs/NestedAdhocChargeRequest.md create mode 100644 docs/NestedChargeRequest.md delete mode 100644 docs/Notification.md delete mode 100644 docs/NotificationPagedMetadata.md create mode 100644 docs/NotificationSendRequest.md create mode 100644 docs/NotificationSendResponse.md create mode 100644 docs/Notifications.md create mode 100644 docs/OAuthToken.md create mode 100644 docs/OfflinePayment.md create mode 100644 docs/OpenIDRegistrationResponse.md create mode 100644 docs/OpenIdUserLinkRequest.md delete mode 100644 docs/Organization.md create mode 100644 docs/OrganizationLiteView.md delete mode 100644 docs/OrganizationPagedMetadata.md delete mode 100644 docs/OrganizationsApi.md delete mode 100644 docs/PasswordPagedMetadata.md create mode 100644 docs/PasswordResetCodeRequest.md create mode 100644 docs/PasswordResetResponse.md create mode 100644 docs/PasswordUpdateWithResetCodeRequest.md delete mode 100644 docs/PasswordsApi.md create mode 100644 docs/PayVisionAuthCaptureRequest.md create mode 100644 docs/PayVisionConfiguration.md create mode 100644 docs/PayVisionPreAuthRequest.md create mode 100644 docs/PaymentAccountingView.md create mode 100644 docs/PaymentGatewayApi.md delete mode 100644 docs/PaymentMethodPagedMetadata.md delete mode 100644 docs/PaymentMethodSubscriptionLinkPagedMetadata.md delete mode 100644 docs/PaymentPagedMetadata.md create mode 100644 docs/PaymentRefundRequest.md create mode 100644 docs/PaymentRefundResponse.md delete mode 100644 docs/PaymentmethodsubscriptionlinksApi.md create mode 100644 docs/PaypalConfiguration.md create mode 100644 docs/PaypalPayment.md delete mode 100644 docs/Period.md delete mode 100644 docs/PeriodPagedMetadata.md delete mode 100644 docs/PeriodsApi.md create mode 100644 docs/PermissionActionEntity.md delete mode 100644 docs/PermissionActionEntityPagedMetadata.md create mode 100644 docs/PermissionResourceEntity.md delete mode 100644 docs/PermissionResourceEntityPagedMetadata.md create mode 100644 docs/PlanAggregation.md create mode 100644 docs/PlanRequest.md create mode 100644 docs/PlanResponse.md create mode 100644 docs/PlansApi.md create mode 100644 docs/PrepaymentCharge.md create mode 100644 docs/PriceBreakdown.md delete mode 100644 docs/PriceCalculationPagedMetadata.md create mode 100644 docs/PriceLine.md create mode 100644 docs/PricingComponentCharge.md delete mode 100644 docs/PricingComponentCouponModifier.md delete mode 100644 docs/PricingComponentPagedMetadata.md delete mode 100644 docs/PricingComponentQuantityRequest.md delete mode 100644 docs/PricingComponentTierPagedMetadata.md create mode 100644 docs/PricingComponentValueAmendment.md create mode 100644 docs/PricingComponentValueChange.md delete mode 100644 docs/PricingComponentValueChangeAmendment.md delete mode 100644 docs/PricingComponentValueChangePagedMetadata.md delete mode 100644 docs/PricingComponentValuePagedMetadata.md create mode 100644 docs/PricingComponentValueResponse.md delete mode 100644 docs/PricingComponentValueResponsePagedMetadata.md create mode 100644 docs/PricingComponentsByChargeType.md create mode 100644 docs/PricingTier.md delete mode 100644 docs/PricingcalculatorApi.md delete mode 100644 docs/PricingcomponentsApi.md delete mode 100644 docs/PricingcomponenttiersApi.md delete mode 100644 docs/PricingcomponentvaluechangesApi.md delete mode 100644 docs/PricingcomponentvaluesApi.md delete mode 100644 docs/Product.md delete mode 100644 docs/ProductCouponModifier.md delete mode 100644 docs/ProductPagedMetadata.md delete mode 100644 docs/ProductPaymentsResultPagedMetadata.md delete mode 100644 docs/ProductRatePlan.md create mode 100644 docs/ProductRatePlanMigrationCharge.md delete mode 100644 docs/ProductRatePlanPagedMetadata.md delete mode 100644 docs/ProductRatePlanPaymentsResultPagedMetadata.md delete mode 100644 docs/ProductrateplansApi.md delete mode 100644 docs/ProductsApi.md delete mode 100644 docs/ProfilePagedMetadata.md delete mode 100644 docs/ProfilesApi.md create mode 100644 docs/PublicConfigurationResponse.md create mode 100644 docs/RecalculateChargeBatchRequest.md create mode 100644 docs/RecalculateChargeBatchResponse.md delete mode 100644 docs/ReceiptPagedMetadata.md create mode 100644 docs/RefundAccountingView.md delete mode 100644 docs/RefundPagedMetadata.md delete mode 100644 docs/RefundsApi.md create mode 100644 docs/RemoveCreditAccountRequest.md create mode 100644 docs/ReportsApi.md delete mode 100644 docs/RevenueAttribution.md delete mode 100644 docs/RevenueAttributionPagedMetadata.md create mode 100644 docs/RevenueAttributions.md delete mode 100644 docs/RolePagedMetadata.md delete mode 100644 docs/RolesApi.md delete mode 100644 docs/RuleSatisfaction.md create mode 100644 docs/SagePayAuthCaptureRequest.md create mode 100644 docs/SagePayCardPayment.md create mode 100644 docs/SagePayConfiguration.md create mode 100644 docs/SagePayEnabledCardType.md create mode 100644 docs/SagePayPreAuthRequest.md create mode 100644 docs/SalesforceApi.md create mode 100644 docs/SalesforceConfigurationResponse.md delete mode 100644 docs/SearchApi.md delete mode 100644 docs/SearchResultPagedMetadata.md create mode 100644 docs/SecurityApi.md create mode 100644 docs/SetRatePlanAffiliateRequest.md rename docs/{PasswordResetRequest.md => SetSubscriptionAffiliateRequest.md} (54%) create mode 100644 docs/SetupCharge.md create mode 100644 docs/SetupPricingComponentsByChargeModel.md create mode 100644 docs/ShuttleAuthCaptureRequest.md create mode 100644 docs/ShuttleConfiguration.md create mode 100644 docs/ShuttlePayment.md create mode 100644 docs/ShuttlePreAuthRequest.md create mode 100644 docs/SimpleDateParam.md create mode 100644 docs/SimpleUser.md create mode 100644 docs/SingleRecalculateChargeRequest.md create mode 100644 docs/SpreedlyAuthCaptureRequest.md create mode 100644 docs/SpreedlyConfiguration.md create mode 100644 docs/SpreedlyPreAuthRequest.md create mode 100644 docs/SquareAuthCaptureRequest.md create mode 100644 docs/SquareConfiguration.md create mode 100644 docs/SquareConfigurationData.md create mode 100644 docs/SquareData.md create mode 100644 docs/SquarePayment.md create mode 100644 docs/SquareSubscription.md rename docs/{EventData.md => StartAllSubscriptionsRequest.md} (69%) create mode 100644 docs/StartAllSubscriptionsResponse.md create mode 100644 docs/StartContractRequest.md create mode 100644 docs/StartContractResponse.md create mode 100644 docs/StripeACHCaptureRequest.md create mode 100644 docs/StripeACHPayment.md delete mode 100644 docs/StripeACHTokenPagedMetadata.md create mode 100644 docs/StripeAchToken.md create mode 100644 docs/StripeAdditionalData.md create mode 100644 docs/StripeCardPayment.md create mode 100644 docs/StripeConfiguration.md create mode 100644 docs/StripePreAuthRequest.md create mode 100644 docs/StripeToken.md delete mode 100644 docs/StripeTokenPagedMetadata.md create mode 100644 docs/SubscriptionCancellation.md delete mode 100644 docs/SubscriptionCancellationPagedMetadata.md delete mode 100644 docs/SubscriptionChargePagedMetadata.md create mode 100644 docs/SubscriptionCheckoutActionRequest.md create mode 100644 docs/SubscriptionCheckoutDefinitionDescription.md create mode 100644 docs/SubscriptionCheckoutResponse.md delete mode 100644 docs/SubscriptionLTVResultPagedMetadata.md delete mode 100644 docs/SubscriptionPagedMetadata.md create mode 100644 docs/SubscriptionReviveAmendment.md create mode 100644 docs/SubscriptionRevivePartialRequest.md create mode 100644 docs/SubscriptionReviveRequest.md delete mode 100644 docs/SwaggerTypeList.md create mode 100644 docs/SyncActionRequest.md delete mode 100644 docs/SynchAppConfigsApi.md delete mode 100644 docs/SynchConfigsApi.md delete mode 100644 docs/SynchJobsApi.md create mode 100644 docs/TaxLine.md delete mode 100644 docs/TaxationLinkPagedMetadata.md create mode 100644 docs/TaxationStrategy.md delete mode 100644 docs/TaxationStrategyPagedMetadata.md delete mode 100644 docs/TaxationlinksApi.md delete mode 100644 docs/TaxationstrategiesApi.md create mode 100644 docs/TaxesApi.md create mode 100644 docs/TieredAdvancePricingComponent.md create mode 100644 docs/TieredArrearsPricingComponent.md create mode 100644 docs/TieredSetupPricingComponent.md create mode 100644 docs/TieredUsagePricingComponent.md delete mode 100644 docs/TimeApi.md delete mode 100644 docs/TimeResponsePagedMetadata.md create mode 100644 docs/TokenizationEpxredirectBody.md create mode 100644 docs/TokenizationPayvisionshoutv1Body.md create mode 100644 docs/TokenizationPreAuth.md delete mode 100644 docs/TokenizationPreAuthPagedMetadata.md create mode 100644 docs/TokenizationPreAuthRequest.md create mode 100644 docs/TokenizationSagepaynotifyv300Body.md create mode 100644 docs/TokensResponse.md create mode 100644 docs/TrustCommerceConfiguration.md create mode 100644 docs/TrustCommerceToken.md delete mode 100644 docs/TrustCommerceTokenPagedMetadata.md create mode 100644 docs/TypedQueryResultWrapperAPIQuote.md create mode 100644 docs/TypedQueryResultWrapperAccount.md create mode 100644 docs/TypedQueryResultWrapperAddress.md create mode 100644 docs/TypedQueryResultWrapperAmendment.md create mode 100644 docs/TypedQueryResultWrapperAvataxConfiguration.md create mode 100644 docs/TypedQueryResultWrapperBFPermission.md create mode 100644 docs/TypedQueryResultWrapperBraintreeToken.md create mode 100644 docs/TypedQueryResultWrapperContract.md create mode 100644 docs/TypedQueryResultWrapperCoupon.md create mode 100644 docs/TypedQueryResultWrapperCreditNote.md create mode 100644 docs/TypedQueryResultWrapperDataSyncJobResponse.md create mode 100644 docs/TypedQueryResultWrapperDunningLine.md create mode 100644 docs/TypedQueryResultWrapperInvoice.md create mode 100644 docs/TypedQueryResultWrapperInvoiceLinePayment.md create mode 100644 docs/TypedQueryResultWrapperNotification.md create mode 100644 docs/TypedQueryResultWrapperPayment.md create mode 100644 docs/TypedQueryResultWrapperPaymentMethod.md create mode 100644 docs/TypedQueryResultWrapperPlanResponse.md create mode 100644 docs/TypedQueryResultWrapperProfile.md create mode 100644 docs/TypedQueryResultWrapperReceipt.md create mode 100644 docs/TypedQueryResultWrapperRefund.md create mode 100644 docs/TypedQueryResultWrapperRevenueAttribution.md create mode 100644 docs/TypedQueryResultWrapperRole.md create mode 100644 docs/TypedQueryResultWrapperStripeACHToken.md create mode 100644 docs/TypedQueryResultWrapperStripeToken.md create mode 100644 docs/TypedQueryResultWrapperSubscription.md create mode 100644 docs/TypedQueryResultWrapperSubscriptionCharge.md create mode 100644 docs/TypedQueryResultWrapperTaxationStrategy.md create mode 100644 docs/TypedQueryResultWrapperUserResponse.md create mode 100644 docs/TypedQueryResultWrapperWebhook.md delete mode 100644 docs/UnitDiscount.md delete mode 100644 docs/UnitOfMeasureCouponModifier.md delete mode 100644 docs/UnitOfMeasurePagedMetadata.md delete mode 100644 docs/UnitofmeasureApi.md delete mode 100644 docs/UpdateAddressRequest.md create mode 100644 docs/UpdateContractRequest.md create mode 100644 docs/UpdateEmailRequest.md create mode 100644 docs/UpdateInvoiceRequest.md create mode 100644 docs/UpdateInvoiceTemplateRequest.md create mode 100644 docs/UpdatePasswordRequest.md create mode 100644 docs/UpdatePasswordResponse.md create mode 100644 docs/UpdatePricingComponentValueChangeResult.md create mode 100644 docs/UpdatePricingComponentValueRequest.md create mode 100644 docs/UpdatePricingComponentValueResponse.md delete mode 100644 docs/UpdateProfileRequest.md create mode 100644 docs/UpdateRatePlanAffiliateRequest.md create mode 100644 docs/UpdateSalesforceConfigurationRequest.md create mode 100644 docs/UpdateUserInfoRequest.md create mode 100644 docs/UpgradeCharge.md delete mode 100644 docs/Usage.md delete mode 100644 docs/UsageApi.md delete mode 100644 docs/UsagePagedMetadata.md delete mode 100644 docs/UsagePeriodPagedMetadata.md create mode 100644 docs/UsagePricingComponentsByChargeModel.md delete mode 100644 docs/UsageRoundingStrategyPagedMetadata.md delete mode 100644 docs/UsageSession.md delete mode 100644 docs/UsageSessionPagedMetadata.md delete mode 100644 docs/UsageperiodsApi.md delete mode 100644 docs/UsageroundingstrategiesApi.md delete mode 100644 docs/UsagesessionsApi.md create mode 100644 docs/UserCreateRequest.md create mode 100644 docs/UserCreationResponse.md delete mode 100644 docs/UserCreationResponsePagedMetadata.md create mode 100644 docs/UserInviteRequest.md delete mode 100644 docs/UserPagedMetadata.md create mode 100644 docs/UserPrivatePermanentTokenRefreshRequest.md create mode 100644 docs/UserPrivatePermanentTokenRequest.md create mode 100644 docs/UserResponse.md rename docs/{TimeZone.md => UserTimezone.md} (96%) delete mode 100644 docs/UsernamePagedMetadata.md create mode 100644 docs/UsernameResponse.md delete mode 100644 docs/UsernamesApi.md delete mode 100644 docs/UsersApi.md create mode 100644 docs/ValueIncrement.md delete mode 100644 docs/VaultedgatewaysApi.md create mode 100644 docs/VerifyPaymentMethodRequest.md create mode 100644 docs/Webhook.md delete mode 100644 docs/WebhookPagedMetadata.md create mode 100644 docs/WebhookSubscription.md create mode 100644 docs/ZoozCaptureRequest.md create mode 100644 docs/ZoozConfiguration.md create mode 100644 docs/ZoozPayment.md delete mode 100644 test/test_account_ltv_result_paged_metadata.py delete mode 100644 test/test_account_paged_metadata.py delete mode 100644 test/test_account_payments_result_paged_metadata.py create mode 100644 test/test_add_charge_response.py create mode 100644 test/test_add_charge_to_account_response.py create mode 100644 test/test_add_charges_to_account_api_request.py create mode 100644 test/test_add_contract_period_request.py delete mode 100644 test/test_add_taxation_strategy_request.py create mode 100644 test/test_additional_data.py delete mode 100644 test/test_address_paged_metadata.py delete mode 100644 test/test_addresses_api.py create mode 100644 test/test_advance_pricing_components_by_charge_model.py create mode 100644 test/test_affiliate.py create mode 100644 test/test_affiliate_commission_charge.py create mode 100644 test/test_affiliate_rate_plan_relationships.py create mode 100644 test/test_affiliate_subscription_relationship.py create mode 100644 test/test_affiliation_api.py delete mode 100644 test/test_aggregating_component.py create mode 100644 test/test_aggregating_component_description.py delete mode 100644 test/test_alias.py create mode 100644 test/test_allowed_webhook_subscription_values.py delete mode 100644 test/test_amendment_paged_metadata.py delete mode 100644 test/test_amendment_price_n_time_paged_metadata.py delete mode 100644 test/test_amendments_api.py delete mode 100644 test/test_analytics_api.py create mode 100644 test/test_api_configuration.py delete mode 100644 test/test_api_configuration_paged_metadata.py delete mode 100644 test/test_api_quote_paged_metadata.py create mode 100644 test/test_arrears_charge.py create mode 100644 test/test_arrears_pricing_components_by_charge_model.py delete mode 100644 test/test_audit_entry.py delete mode 100644 test/test_audit_entry_paged_metadata.py delete mode 100644 test/test_auditlogs_api.py create mode 100644 test/test_authorize_net_configuration.py create mode 100644 test/test_authorize_net_payment.py create mode 100644 test/test_authorize_net_token.py delete mode 100644 test/test_authorize_net_token_paged_metadata.py create mode 100644 test/test_avatax_api.py create mode 100644 test/test_avatax_config_request.py create mode 100644 test/test_avatax_configuration.py create mode 100644 test/test_avatax_ping_request.py create mode 100644 test/test_avatax_ping_response.py create mode 100644 test/test_bank_account.py delete mode 100644 test/test_bank_account_verification_paged_metadata.py create mode 100644 test/test_batch_increment_values_request.py create mode 100644 test/test_batch_update_pricing_component_values_request.py delete mode 100644 test/test_bf_error.py delete mode 100644 test/test_bf_permission_paged_metadata.py delete mode 100644 test/test_billforward_managed_payments_result_paged_metadata.py create mode 100644 test/test_braintree_configuration.py create mode 100644 test/test_braintree_merchant_account.py create mode 100644 test/test_braintree_payment.py create mode 100644 test/test_braintree_pre_auth_request.py create mode 100644 test/test_braintree_token.py delete mode 100644 test/test_braintree_token_paged_metadata.py create mode 100644 test/test_calculator_result.py delete mode 100644 test/test_cancel_subscription_request.py create mode 100644 test/test_card_connect_api.py create mode 100644 test/test_card_connect_auth_capture_request.py create mode 100644 test/test_card_connect_configuration.py create mode 100644 test/test_card_connect_gateway_request.py create mode 100644 test/test_card_connect_payment.py delete mode 100644 test/test_cass_churn_result_paged_metadata.py delete mode 100644 test/test_cass_payment_result_paged_metadata.py delete mode 100644 test/test_cass_upgrade_result_paged_metadata.py create mode 100644 test/test_checkout_api.py delete mode 100644 test/test_client.py delete mode 100644 test/test_client_paged_metadata.py delete mode 100644 test/test_clients_api.py create mode 100644 test/test_commission_structure.py delete mode 100644 test/test_component_cost.py delete mode 100644 test/test_compound_usage.py delete mode 100644 test/test_compound_usage_session.py delete mode 100644 test/test_configurations_api.py create mode 100644 test/test_contract.py create mode 100644 test/test_contract_period.py create mode 100644 test/test_contracts_api.py delete mode 100644 test/test_coupon_book.py delete mode 100644 test/test_coupon_book_definition.py delete mode 100644 test/test_coupon_book_definition_paged_metadata.py delete mode 100644 test/test_coupon_book_paged_metadata.py create mode 100644 test/test_coupon_charge.py create mode 100644 test/test_coupon_code_response.py delete mode 100644 test/test_coupon_definition.py delete mode 100644 test/test_coupon_definition_paged_metadata.py delete mode 100644 test/test_coupon_discount_estimate.py delete mode 100644 test/test_coupon_instance_paged_metadata.py delete mode 100644 test/test_coupon_modifier_base.py delete mode 100644 test/test_coupon_modifier_base_paged_metadata.py delete mode 100644 test/test_coupon_paged_metadata.py create mode 100644 test/test_coupon_payment.py delete mode 100644 test/test_coupon_rule.py delete mode 100644 test/test_coupon_rule_paged_metadata.py delete mode 100644 test/test_coupon_unique_codes_response_paged_metadata.py delete mode 100644 test/test_couponbook_api.py delete mode 100644 test/test_couponbookdefinition_api.py delete mode 100644 test/test_coupondefinition_api.py delete mode 100644 test/test_couponinstance_api.py delete mode 100644 test/test_couponmodifier_api.py delete mode 100644 test/test_couponrule_api.py delete mode 100644 test/test_create_account_profile_request.py delete mode 100644 test/test_create_account_request.py delete mode 100644 test/test_create_address_request.py create mode 100644 test/test_create_commission_invoice_request.py create mode 100644 test/test_create_contract_period_request.py create mode 100644 test/test_create_contract_request.py create mode 100644 test/test_create_coupon_discount_request.py create mode 100644 test/test_create_coupon_request.py create mode 100644 test/test_create_offline_payment_request.py create mode 100644 test/test_create_permission_on_role_request.py create mode 100644 test/test_create_permission_request.py create mode 100644 test/test_create_pricing_component_quantity_request.py delete mode 100644 test/test_create_profile_address_request.py create mode 100644 test/test_create_profile_request.py create mode 100644 test/test_create_role_request.py create mode 100644 test/test_create_salesforce_configuration_request.py create mode 100644 test/test_create_subscription_checkout_definition_request.py create mode 100644 test/test_create_subscription_timer_request.py create mode 100644 test/test_create_totp_request.py create mode 100644 test/test_credit_note_currency.py delete mode 100644 test/test_credit_note_paged_metadata.py create mode 100644 test/test_credit_note_payment.py delete mode 100644 test/test_creditnotes_api.py create mode 100644 test/test_cybersource_configuration.py create mode 100644 test/test_cybersource_payment.py delete mode 100644 test/test_cybersource_token_paged_metadata.py delete mode 100644 test/test_cybersourcetokens_api.py create mode 100644 test/test_data_sync_job_error_response.py create mode 100644 test/test_data_sync_job_response.py delete mode 100644 test/test_data_synchronisation_app_configuration_paged_metadata.py delete mode 100644 test/test_data_synchronisation_configuration.py delete mode 100644 test/test_data_synchronisation_configuration_paged_metadata.py delete mode 100644 test/test_data_synchronization_job_paged_metadata.py delete mode 100644 test/test_debts_result_paged_metadata.py create mode 100644 test/test_default_api.py create mode 100644 test/test_dunning_api.py delete mode 100644 test/test_dunning_line_paged_metadata.py delete mode 100644 test/test_dunninglines_api.py delete mode 100644 test/test_dynamic_metadata.py create mode 100644 test/test_ebanx_api.py create mode 100644 test/test_ebanx_auth_capture_request.py create mode 100644 test/test_ebanx_configuration.py create mode 100644 test/test_ebanx_gateway_request.py create mode 100644 test/test_ebanx_payment.py create mode 100644 test/test_ebanx_webhook.py delete mode 100644 test/test_email.py delete mode 100644 test/test_email_paged_metadata.py delete mode 100644 test/test_email_provider.py delete mode 100644 test/test_email_provider_paged_metadata.py delete mode 100644 test/test_email_subscription.py delete mode 100644 test/test_email_subscription_paged_metadata.py create mode 100644 test/test_email_tokenization.py create mode 100644 test/test_email_tokenization_create_api_request.py create mode 100644 test/test_email_tokenization_send_api_request.py create mode 100644 test/test_email_tokenization_update_api_request.py delete mode 100644 test/test_emailproviders_api.py delete mode 100644 test/test_emails_api.py delete mode 100644 test/test_emailsubscriptions_api.py create mode 100644 test/test_epx_capture_request.py create mode 100644 test/test_epx_configuration.py create mode 100644 test/test_epx_payment.py create mode 100644 test/test_epx_pre_auth_request.py create mode 100644 test/test_epx_pre_auth_response.py delete mode 100644 test/test_event.py delete mode 100644 test/test_event_data.py create mode 100644 test/test_execution_receipt_response.py create mode 100644 test/test_execution_response.py create mode 100644 test/test_extras.py delete mode 100644 test/test_file_sham.py create mode 100644 test/test_fixed_term_definition.py delete mode 100644 test/test_fixed_term_definition_paged_metadata.py delete mode 100644 test/test_fixed_term_paged_metadata.py delete mode 100644 test/test_fixedtermdefinitions_api.py delete mode 100644 test/test_fixedterms_api.py create mode 100644 test/test_flat_advance_pricing_component.py create mode 100644 test/test_flat_arrears_pricing_component.py create mode 100644 test/test_flat_setup_pricing_component.py create mode 100644 test/test_flat_usage_pricing_component.py create mode 100644 test/test_get_rate_plan_affiliate_response.py create mode 100644 test/test_get_subscription_affiliate_response.py create mode 100644 test/test_go_cardless_configuration.py create mode 100644 test/test_go_cardless_tokenization_request.py create mode 100644 test/test_halt_aggregation_request.py create mode 100644 test/test_halt_aggregation_response.py create mode 100644 test/test_hosted_payment.py create mode 100644 test/test_hosted_payment_config.py create mode 100644 test/test_i_discardable.py create mode 100644 test/test_import_invoice_request.py create mode 100644 test/test_import_subscription_request.py create mode 100644 test/test_inline_response_default.py create mode 100644 test/test_inline_response_default1.py create mode 100644 test/test_inline_response_default10.py create mode 100644 test/test_inline_response_default100.py create mode 100644 test/test_inline_response_default101.py create mode 100644 test/test_inline_response_default102.py create mode 100644 test/test_inline_response_default103.py create mode 100644 test/test_inline_response_default11.py create mode 100644 test/test_inline_response_default12.py create mode 100644 test/test_inline_response_default13.py create mode 100644 test/test_inline_response_default14.py create mode 100644 test/test_inline_response_default15.py create mode 100644 test/test_inline_response_default16.py create mode 100644 test/test_inline_response_default17.py create mode 100644 test/test_inline_response_default18.py create mode 100644 test/test_inline_response_default19.py create mode 100644 test/test_inline_response_default2.py create mode 100644 test/test_inline_response_default20.py create mode 100644 test/test_inline_response_default21.py create mode 100644 test/test_inline_response_default22.py create mode 100644 test/test_inline_response_default23.py create mode 100644 test/test_inline_response_default24.py create mode 100644 test/test_inline_response_default25.py create mode 100644 test/test_inline_response_default26.py create mode 100644 test/test_inline_response_default27.py create mode 100644 test/test_inline_response_default28.py create mode 100644 test/test_inline_response_default29.py create mode 100644 test/test_inline_response_default3.py create mode 100644 test/test_inline_response_default30.py create mode 100644 test/test_inline_response_default31.py create mode 100644 test/test_inline_response_default32.py create mode 100644 test/test_inline_response_default33.py create mode 100644 test/test_inline_response_default34.py create mode 100644 test/test_inline_response_default35.py create mode 100644 test/test_inline_response_default36.py create mode 100644 test/test_inline_response_default37.py create mode 100644 test/test_inline_response_default38.py create mode 100644 test/test_inline_response_default39.py create mode 100644 test/test_inline_response_default4.py create mode 100644 test/test_inline_response_default40.py create mode 100644 test/test_inline_response_default41.py create mode 100644 test/test_inline_response_default42.py create mode 100644 test/test_inline_response_default43.py create mode 100644 test/test_inline_response_default44.py create mode 100644 test/test_inline_response_default45.py create mode 100644 test/test_inline_response_default46.py create mode 100644 test/test_inline_response_default47.py create mode 100644 test/test_inline_response_default48.py create mode 100644 test/test_inline_response_default49.py create mode 100644 test/test_inline_response_default5.py create mode 100644 test/test_inline_response_default50.py create mode 100644 test/test_inline_response_default51.py create mode 100644 test/test_inline_response_default52.py create mode 100644 test/test_inline_response_default53.py create mode 100644 test/test_inline_response_default54.py create mode 100644 test/test_inline_response_default55.py create mode 100644 test/test_inline_response_default56.py create mode 100644 test/test_inline_response_default57.py create mode 100644 test/test_inline_response_default58.py create mode 100644 test/test_inline_response_default59.py create mode 100644 test/test_inline_response_default6.py create mode 100644 test/test_inline_response_default60.py create mode 100644 test/test_inline_response_default61.py create mode 100644 test/test_inline_response_default62.py create mode 100644 test/test_inline_response_default63.py create mode 100644 test/test_inline_response_default64.py create mode 100644 test/test_inline_response_default65.py create mode 100644 test/test_inline_response_default66.py create mode 100644 test/test_inline_response_default67.py create mode 100644 test/test_inline_response_default68.py create mode 100644 test/test_inline_response_default69.py create mode 100644 test/test_inline_response_default7.py create mode 100644 test/test_inline_response_default70.py create mode 100644 test/test_inline_response_default71.py create mode 100644 test/test_inline_response_default72.py create mode 100644 test/test_inline_response_default73.py create mode 100644 test/test_inline_response_default74.py create mode 100644 test/test_inline_response_default75.py create mode 100644 test/test_inline_response_default76.py create mode 100644 test/test_inline_response_default77.py create mode 100644 test/test_inline_response_default78.py create mode 100644 test/test_inline_response_default79.py create mode 100644 test/test_inline_response_default8.py create mode 100644 test/test_inline_response_default80.py create mode 100644 test/test_inline_response_default81.py create mode 100644 test/test_inline_response_default82.py create mode 100644 test/test_inline_response_default83.py create mode 100644 test/test_inline_response_default84.py create mode 100644 test/test_inline_response_default85.py create mode 100644 test/test_inline_response_default86.py create mode 100644 test/test_inline_response_default87.py create mode 100644 test/test_inline_response_default88.py create mode 100644 test/test_inline_response_default89.py create mode 100644 test/test_inline_response_default9.py create mode 100644 test/test_inline_response_default90.py create mode 100644 test/test_inline_response_default91.py create mode 100644 test/test_inline_response_default92.py create mode 100644 test/test_inline_response_default93.py create mode 100644 test/test_inline_response_default94.py create mode 100644 test/test_inline_response_default95.py create mode 100644 test/test_inline_response_default96.py create mode 100644 test/test_inline_response_default97.py create mode 100644 test/test_inline_response_default98.py create mode 100644 test/test_inline_response_default99.py delete mode 100644 test/test_insertable_billing_entity.py create mode 100644 test/test_interval_date.py create mode 100644 test/test_invoice_execution_request.py delete mode 100644 test/test_invoice_line.py delete mode 100644 test/test_invoice_line_payment.py delete mode 100644 test/test_invoice_line_payment_paged_metadata.py create mode 100644 test/test_invoice_line_payments.py create mode 100644 test/test_invoice_lines.py delete mode 100644 test/test_invoice_paged_metadata.py delete mode 100644 test/test_invoice_payment.py create mode 100644 test/test_invoice_payments.py create mode 100644 test/test_invoice_refund_request.py create mode 100644 test/test_invoice_refund_response.py create mode 100644 test/test_invoice_split.py create mode 100644 test/test_invoice_split_service_request.py create mode 100644 test/test_invoice_template_config_response.py create mode 100644 test/test_issue_invoice_request.py create mode 100644 test/test_issue_invoice_response.py create mode 100644 test/test_kash_configuration.py create mode 100644 test/test_legacy_create_webhook_request.py create mode 100644 test/test_manual_charge.py create mode 100644 test/test_marketplace_quote.py create mode 100644 test/test_metadata.py delete mode 100644 test/test_metadata_api.py create mode 100644 test/test_metadata_key_values.py delete mode 100644 test/test_metadata_key_values_paged_metadata.py create mode 100644 test/test_migration.py create mode 100644 test/test_migration_response.py delete mode 100644 test/test_mutable_billing_entity.py create mode 100644 test/test_nested_adhoc_charge_request.py create mode 100644 test/test_nested_charge_request.py delete mode 100644 test/test_notification.py delete mode 100644 test/test_notification_paged_metadata.py create mode 100644 test/test_notification_send_request.py create mode 100644 test/test_notification_send_response.py create mode 100644 test/test_notifications.py create mode 100644 test/test_o_auth_token.py create mode 100644 test/test_offline_payment.py create mode 100644 test/test_open_id_registration_response.py create mode 100644 test/test_open_id_user_link_request.py delete mode 100644 test/test_organization.py create mode 100644 test/test_organization_lite_view.py delete mode 100644 test/test_organization_paged_metadata.py delete mode 100644 test/test_organizations_api.py delete mode 100644 test/test_password_paged_metadata.py create mode 100644 test/test_password_reset_code_request.py delete mode 100644 test/test_password_reset_request.py create mode 100644 test/test_password_reset_response.py create mode 100644 test/test_password_update_with_reset_code_request.py delete mode 100644 test/test_passwords_api.py create mode 100644 test/test_pay_vision_auth_capture_request.py create mode 100644 test/test_pay_vision_configuration.py create mode 100644 test/test_pay_vision_pre_auth_request.py create mode 100644 test/test_payment_accounting_view.py create mode 100644 test/test_payment_gateway_api.py delete mode 100644 test/test_payment_method_paged_metadata.py delete mode 100644 test/test_payment_method_subscription_link_paged_metadata.py create mode 100644 test/test_payment_methods_api.py delete mode 100644 test/test_payment_paged_metadata.py create mode 100644 test/test_payment_refund_request.py create mode 100644 test/test_payment_refund_response.py delete mode 100644 test/test_paymentmethods_api.py delete mode 100644 test/test_paymentmethodsubscriptionlinks_api.py create mode 100644 test/test_paypal_configuration.py create mode 100644 test/test_paypal_payment.py delete mode 100644 test/test_period.py delete mode 100644 test/test_period_paged_metadata.py delete mode 100644 test/test_periods_api.py create mode 100644 test/test_permission_action_entity.py delete mode 100644 test/test_permission_action_entity_paged_metadata.py create mode 100644 test/test_permission_resource_entity.py delete mode 100644 test/test_permission_resource_entity_paged_metadata.py create mode 100644 test/test_plan_aggregation.py create mode 100644 test/test_plan_request.py create mode 100644 test/test_plan_response.py create mode 100644 test/test_plans_api.py create mode 100644 test/test_prepayment_charge.py create mode 100644 test/test_price_breakdown.py delete mode 100644 test/test_price_calculation_paged_metadata.py create mode 100644 test/test_price_line.py create mode 100644 test/test_pricing_component_charge.py delete mode 100644 test/test_pricing_component_coupon_modifier.py delete mode 100644 test/test_pricing_component_paged_metadata.py delete mode 100644 test/test_pricing_component_quantity_request.py delete mode 100644 test/test_pricing_component_tier_paged_metadata.py create mode 100644 test/test_pricing_component_value_amendment.py create mode 100644 test/test_pricing_component_value_change.py delete mode 100644 test/test_pricing_component_value_change_amendment.py delete mode 100644 test/test_pricing_component_value_change_paged_metadata.py delete mode 100644 test/test_pricing_component_value_paged_metadata.py create mode 100644 test/test_pricing_component_value_response.py delete mode 100644 test/test_pricing_component_value_response_paged_metadata.py create mode 100644 test/test_pricing_components_by_charge_type.py create mode 100644 test/test_pricing_tier.py delete mode 100644 test/test_pricingcalculator_api.py delete mode 100644 test/test_pricingcomponents_api.py delete mode 100644 test/test_pricingcomponenttiers_api.py delete mode 100644 test/test_pricingcomponentvaluechanges_api.py delete mode 100644 test/test_pricingcomponentvalues_api.py delete mode 100644 test/test_product.py delete mode 100644 test/test_product_coupon_modifier.py delete mode 100644 test/test_product_paged_metadata.py delete mode 100644 test/test_product_payments_result_paged_metadata.py delete mode 100644 test/test_product_rate_plan.py create mode 100644 test/test_product_rate_plan_migration_charge.py delete mode 100644 test/test_product_rate_plan_paged_metadata.py delete mode 100644 test/test_product_rate_plan_payments_result_paged_metadata.py delete mode 100644 test/test_productrateplans_api.py delete mode 100644 test/test_products_api.py delete mode 100644 test/test_profile_paged_metadata.py delete mode 100644 test/test_profiles_api.py create mode 100644 test/test_public_configuration_response.py create mode 100644 test/test_recalculate_charge_batch_request.py create mode 100644 test/test_recalculate_charge_batch_response.py delete mode 100644 test/test_receipt_paged_metadata.py create mode 100644 test/test_refund_accounting_view.py delete mode 100644 test/test_refund_paged_metadata.py delete mode 100644 test/test_refunds_api.py create mode 100644 test/test_remove_credit_account_request.py create mode 100644 test/test_reports_api.py delete mode 100644 test/test_revenue_attribution.py delete mode 100644 test/test_revenue_attribution_paged_metadata.py create mode 100644 test/test_revenue_attributions.py delete mode 100644 test/test_revive_subscription_request.py delete mode 100644 test/test_role_paged_metadata.py delete mode 100644 test/test_roles_api.py delete mode 100644 test/test_rule_satisfaction.py create mode 100644 test/test_sage_pay_auth_capture_request.py create mode 100644 test/test_sage_pay_card_payment.py create mode 100644 test/test_sage_pay_configuration.py create mode 100644 test/test_sage_pay_enabled_card_type.py create mode 100644 test/test_sage_pay_pre_auth_request.py create mode 100644 test/test_salesforce_api.py create mode 100644 test/test_salesforce_configuration_response.py delete mode 100644 test/test_search_api.py delete mode 100644 test/test_search_result_paged_metadata.py create mode 100644 test/test_security_api.py create mode 100644 test/test_set_rate_plan_affiliate_request.py create mode 100644 test/test_set_subscription_affiliate_request.py create mode 100644 test/test_setup_charge.py create mode 100644 test/test_setup_pricing_components_by_charge_model.py create mode 100644 test/test_shuttle_auth_capture_request.py create mode 100644 test/test_shuttle_configuration.py create mode 100644 test/test_shuttle_payment.py create mode 100644 test/test_shuttle_pre_auth_request.py create mode 100644 test/test_simple_date_param.py create mode 100644 test/test_simple_user.py create mode 100644 test/test_single_recalculate_charge_request.py create mode 100644 test/test_spreedly_auth_capture_request.py create mode 100644 test/test_spreedly_configuration.py create mode 100644 test/test_spreedly_pre_auth_request.py create mode 100644 test/test_square_auth_capture_request.py create mode 100644 test/test_square_configuration.py create mode 100644 test/test_square_configuration_data.py create mode 100644 test/test_square_data.py create mode 100644 test/test_square_payment.py create mode 100644 test/test_square_subscription.py create mode 100644 test/test_start_all_subscriptions_request.py create mode 100644 test/test_start_all_subscriptions_response.py create mode 100644 test/test_start_contract_request.py create mode 100644 test/test_start_contract_response.py create mode 100644 test/test_stripe_ach_capture_request.py create mode 100644 test/test_stripe_ach_payment.py create mode 100644 test/test_stripe_ach_token.py delete mode 100644 test/test_stripe_ach_token_paged_metadata.py create mode 100644 test/test_stripe_additional_data.py create mode 100644 test/test_stripe_card_payment.py create mode 100644 test/test_stripe_configuration.py delete mode 100644 test/test_stripe_object.py create mode 100644 test/test_stripe_pre_auth_request.py create mode 100644 test/test_stripe_token.py delete mode 100644 test/test_stripe_token_paged_metadata.py create mode 100644 test/test_subscription_cancellation.py delete mode 100644 test/test_subscription_cancellation_paged_metadata.py delete mode 100644 test/test_subscription_charge_paged_metadata.py create mode 100644 test/test_subscription_checkout_action_request.py create mode 100644 test/test_subscription_checkout_definition_description.py create mode 100644 test/test_subscription_checkout_response.py delete mode 100644 test/test_subscription_ltv_result_paged_metadata.py delete mode 100644 test/test_subscription_paged_metadata.py create mode 100644 test/test_subscription_revive_amendment.py create mode 100644 test/test_subscription_revive_partial_request.py create mode 100644 test/test_subscription_revive_request.py delete mode 100644 test/test_swagger_type_list.py create mode 100644 test/test_sync_action_request.py delete mode 100644 test/test_synch_app_configs_api.py delete mode 100644 test/test_synch_configs_api.py delete mode 100644 test/test_synch_jobs_api.py create mode 100644 test/test_tax_line.py delete mode 100644 test/test_taxation_link_paged_metadata.py create mode 100644 test/test_taxation_strategy.py delete mode 100644 test/test_taxation_strategy_paged_metadata.py delete mode 100644 test/test_taxationlinks_api.py delete mode 100644 test/test_taxationstrategies_api.py create mode 100644 test/test_taxes_api.py create mode 100644 test/test_tiered_advance_pricing_component.py create mode 100644 test/test_tiered_arrears_pricing_component.py create mode 100644 test/test_tiered_setup_pricing_component.py create mode 100644 test/test_tiered_usage_pricing_component.py delete mode 100644 test/test_time_api.py delete mode 100644 test/test_time_response_paged_metadata.py delete mode 100644 test/test_time_zone.py create mode 100644 test/test_tokenization_epxredirect_body.py create mode 100644 test/test_tokenization_payvisionshoutv1_body.py create mode 100644 test/test_tokenization_pre_auth.py delete mode 100644 test/test_tokenization_pre_auth_paged_metadata.py create mode 100644 test/test_tokenization_pre_auth_request.py create mode 100644 test/test_tokenization_sagepaynotifyv300_body.py create mode 100644 test/test_tokens_response.py create mode 100644 test/test_trust_commerce_configuration.py create mode 100644 test/test_trust_commerce_token.py delete mode 100644 test/test_trust_commerce_token_paged_metadata.py create mode 100644 test/test_typed_query_result_wrapper_account.py create mode 100644 test/test_typed_query_result_wrapper_address.py create mode 100644 test/test_typed_query_result_wrapper_amendment.py create mode 100644 test/test_typed_query_result_wrapper_api_quote.py create mode 100644 test/test_typed_query_result_wrapper_avatax_configuration.py create mode 100644 test/test_typed_query_result_wrapper_bf_permission.py create mode 100644 test/test_typed_query_result_wrapper_braintree_token.py create mode 100644 test/test_typed_query_result_wrapper_contract.py create mode 100644 test/test_typed_query_result_wrapper_coupon.py create mode 100644 test/test_typed_query_result_wrapper_credit_note.py create mode 100644 test/test_typed_query_result_wrapper_data_sync_job_response.py create mode 100644 test/test_typed_query_result_wrapper_dunning_line.py create mode 100644 test/test_typed_query_result_wrapper_invoice.py create mode 100644 test/test_typed_query_result_wrapper_invoice_line_payment.py create mode 100644 test/test_typed_query_result_wrapper_notification.py create mode 100644 test/test_typed_query_result_wrapper_payment.py create mode 100644 test/test_typed_query_result_wrapper_payment_method.py create mode 100644 test/test_typed_query_result_wrapper_plan_response.py create mode 100644 test/test_typed_query_result_wrapper_profile.py create mode 100644 test/test_typed_query_result_wrapper_receipt.py create mode 100644 test/test_typed_query_result_wrapper_refund.py create mode 100644 test/test_typed_query_result_wrapper_revenue_attribution.py create mode 100644 test/test_typed_query_result_wrapper_role.py create mode 100644 test/test_typed_query_result_wrapper_stripe_ach_token.py create mode 100644 test/test_typed_query_result_wrapper_stripe_token.py create mode 100644 test/test_typed_query_result_wrapper_subscription.py create mode 100644 test/test_typed_query_result_wrapper_subscription_charge.py create mode 100644 test/test_typed_query_result_wrapper_taxation_strategy.py create mode 100644 test/test_typed_query_result_wrapper_user_response.py create mode 100644 test/test_typed_query_result_wrapper_webhook.py delete mode 100644 test/test_unit_discount.py delete mode 100644 test/test_unit_of_measure_coupon_modifier.py delete mode 100644 test/test_unit_of_measure_paged_metadata.py delete mode 100644 test/test_unitofmeasure_api.py delete mode 100644 test/test_update_address_request.py create mode 100644 test/test_update_contract_request.py create mode 100644 test/test_update_email_request.py create mode 100644 test/test_update_invoice_request.py create mode 100644 test/test_update_invoice_template_request.py create mode 100644 test/test_update_password_request.py create mode 100644 test/test_update_password_response.py create mode 100644 test/test_update_pricing_component_value_change_result.py create mode 100644 test/test_update_pricing_component_value_request.py create mode 100644 test/test_update_pricing_component_value_response.py delete mode 100644 test/test_update_profile_request.py create mode 100644 test/test_update_rate_plan_affiliate_request.py create mode 100644 test/test_update_salesforce_configuration_request.py create mode 100644 test/test_update_user_info_request.py create mode 100644 test/test_upgrade_charge.py delete mode 100644 test/test_usage.py delete mode 100644 test/test_usage_api.py delete mode 100644 test/test_usage_paged_metadata.py delete mode 100644 test/test_usage_period_paged_metadata.py create mode 100644 test/test_usage_pricing_components_by_charge_model.py delete mode 100644 test/test_usage_rounding_strategy_paged_metadata.py delete mode 100644 test/test_usage_session.py delete mode 100644 test/test_usage_session_paged_metadata.py delete mode 100644 test/test_usageperiods_api.py delete mode 100644 test/test_usageroundingstrategies_api.py delete mode 100644 test/test_usagesessions_api.py create mode 100644 test/test_user_create_request.py create mode 100644 test/test_user_creation_response.py delete mode 100644 test/test_user_creation_response_paged_metadata.py create mode 100644 test/test_user_invite_request.py delete mode 100644 test/test_user_paged_metadata.py create mode 100644 test/test_user_private_permanent_token_refresh_request.py create mode 100644 test/test_user_private_permanent_token_request.py create mode 100644 test/test_user_response.py create mode 100644 test/test_user_timezone.py delete mode 100644 test/test_username_paged_metadata.py create mode 100644 test/test_username_response.py delete mode 100644 test/test_usernames_api.py delete mode 100644 test/test_users_api.py create mode 100644 test/test_value_increment.py delete mode 100644 test/test_vaultedgateways_api.py create mode 100644 test/test_verify_payment_method_request.py create mode 100644 test/test_webhook.py delete mode 100644 test/test_webhook_paged_metadata.py create mode 100644 test/test_webhook_subscription.py create mode 100644 test/test_zooz_capture_request.py create mode 100644 test/test_zooz_configuration.py create mode 100644 test/test_zooz_payment.py diff --git a/.swagger-codegen/VERSION b/.swagger-codegen/VERSION new file mode 100644 index 0000000..0667b5f --- /dev/null +++ b/.swagger-codegen/VERSION @@ -0,0 +1 @@ +3.0.29 \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index 86211e2..dd6c445 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,7 +1,6 @@ # ref: https://docs.travis-ci.com/user/languages/python language: python python: - - "2.7" - "3.2" - "3.3" - "3.4" diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 8dada3e..0000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "{}" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright {yyyy} {name of copyright owner} - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/README.md b/README.md index 1a193ac..b44a509 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@ -# [Experimental] Billforward Python SDK +# billforward +This is documentation for the Billforward API. You can find out more at billforward.io. This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: -- API version: 1.0.0 +- API version: 1.0 - Package version: 1.0.0 -- Commit: 0986acd2a6e542ca74188c4d3fb13f8241cf42eb -- Build date: 2016-07-14T12:19:55.738+01:00 -- Build package: class io.swagger.codegen.languages.PythonClientCodegen +- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen ## Requirements. @@ -18,9 +17,9 @@ Python 2.7 and 3.4+ If the python package is hosted on Github, you can install directly from Github ```sh -pip install git+https://github.com/billforward/bf-python.git +pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git ``` -(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/billforward/bf-python.git`) +(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`) Then import the package: ```python @@ -46,720 +45,1064 @@ import billforward Please follow the [installation procedure](#installation--usage) and then run the following: ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint -# Create an API client -api_client = billforward.ApiClient('https://api-sandbox.billforward.net:443/v1', 'Authorization', 'Bearer INSERT-PRIVATE-TOKEN-HERE') -# Using your API client, create an instance of the API class -accounts_api = billforward.AccountsApi(api_client) +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +body = billforward.AddChargesToAccountAPIRequest() # AddChargesToAccountAPIRequest | (optional) try: - api_response = accounts_api.get_account_by_id('ACC-8900EF22-8222-495A-BAF8-F0ABB6B8') + api_response = api_instance.add_charge_to_account(account_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->get_account_by_id: %s\n" % e + print("Exception when calling AccountsApi->add_charge_to_account: %s\n" % e) + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +body = billforward.CreditAccountRequest() # CreditAccountRequest | (optional) + +try: + api_response = api_instance.add_credit_note_to_account(account_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->add_credit_note_to_account: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +body = billforward.Account() # Account | (optional) + +try: + api_response = api_instance.create_account(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->create_account: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +body = billforward.Address() # Address | (optional) + +try: + api_response = api_instance.create_address(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->create_address: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +delete_gateway_data = false # bool | (optional) (default to false) +delete_personal_data = false # bool | (optional) (default to false) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.delete_account(account_id, delete_gateway_data=delete_gateway_data, delete_personal_data=delete_personal_data, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->delete_account: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.delete_metadata_for_account(account_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->delete_metadata_for_account: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_account_by_id(account_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->get_account_by_id: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +id = ['id_example'] # list[str] | (optional) +organizations = ['organizations_example'] # list[str] | (optional) +include_retired = true # bool | (optional) (default to true) +users_only = false # bool | (optional) (default to false) +metadata = 'metadata_example' # str | (optional) + +try: + api_response = api_instance.get_all_accounts(id=id, organizations=organizations, include_retired=include_retired, users_only=users_only, metadata=metadata) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->get_all_accounts: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_available_credit_on_account(account_id, organizations=organizations, include_retired=include_retired) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->get_available_credit_on_account: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) +exclude_children = true # bool | (optional) (default to true) + +try: + api_response = api_instance.get_invoices_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->get_invoices_by_account_id: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_metadata_for_account(account_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->get_metadata_for_account: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) +default_only = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_payment_method_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, default_only=default_only) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->get_payment_method_by_account_id: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_subscription_charges(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->get_subscription_charges: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +body = billforward.HaltAggregationRequest() # HaltAggregationRequest | (optional) + +try: + api_response = api_instance.halt_aggregation(account_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->halt_aggregation: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +body = billforward.RemoveCreditAccountRequest() # RemoveCreditAccountRequest | (optional) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.remove_credit_from_account2(account_id, body=body, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->remove_credit_from_account2: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +body = 'body_example' # str | (optional) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.set_metadata_for_account(account_id, body=body, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->set_metadata_for_account: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +body = billforward.Account() # Account | (optional) + +try: + api_response = api_instance.update_account(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->update_account: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +body = billforward.Address() # Address | (optional) + +try: + api_response = api_instance.update_address(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->update_address: %s\n" % e) + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +body = 'body_example' # str | (optional) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.upsert_metadata_for_account(account_id, body=body, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->upsert_metadata_for_account: %s\n" % e) ``` ## Documentation for API Endpoints -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*AccountsApi* | [**add_credit_note_to_account**](docs/AccountsApi.md#add_credit_note_to_account) | **POST** /accounts/{account-ID}/credit | Creates a credit-note which may be used by any subscription of this account. -*AccountsApi* | [**add_permission_to_account**](docs/AccountsApi.md#add_permission_to_account) | **POST** /accounts/{account-ID}/roles/{role} | Add a role to the account -*AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /accounts | Create an Account. -*AccountsApi* | [**delete_account**](docs/AccountsApi.md#delete_account) | **DELETE** /accounts/{account-ID} | Delete the account specified by the account-ID parameter. -*AccountsApi* | [**delete_metadata_for_account**](docs/AccountsApi.md#delete_metadata_for_account) | **DELETE** /accounts/{account-ID}/metadata | Remove any associated metadata. -*AccountsApi* | [**get_account_by_id**](docs/AccountsApi.md#get_account_by_id) | **GET** /accounts/{account-ID} | Returns a single account, specified by the account-ID parameter. -*AccountsApi* | [**get_accounts_by_created**](docs/AccountsApi.md#get_accounts_by_created) | **GET** /accounts/created/{lower-threshold}/{upper-threshold} | Returns a collection of account objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*AccountsApi* | [**get_accounts_by_updated**](docs/AccountsApi.md#get_accounts_by_updated) | **GET** /accounts/updated/{lower-threshold}/{upper-threshold} | Returns a collection of account objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*AccountsApi* | [**get_accounts_by_user_id**](docs/AccountsApi.md#get_accounts_by_user_id) | **GET** /accounts/user/{user-ID} | Returns a collection of accounts, specified by the user-ID parameter. By default 10 values are returned. Records are returned in natural order. -*AccountsApi* | [**get_all_accounts**](docs/AccountsApi.md#get_all_accounts) | **GET** /accounts | Returns a collection of all account objects. By default 10 values are returned. Records are returned in natural order. -*AccountsApi* | [**get_available_credit_on_account**](docs/AccountsApi.md#get_available_credit_on_account) | **GET** /accounts/{account-ID}/credit | Returns all available credit-notes for the specified account. By default 10 values are returned. Records are returned in natural order. -*AccountsApi* | [**get_metadata_for_account**](docs/AccountsApi.md#get_metadata_for_account) | **GET** /accounts/{account-ID}/metadata | Retrieve any associated metadata. -*AccountsApi* | [**get_permissions_on_account**](docs/AccountsApi.md#get_permissions_on_account) | **GET** /accounts/{account-ID}/roles | Retrieves a collection of roles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -*AccountsApi* | [**remove_credit_from_account**](docs/AccountsApi.md#remove_credit_from_account) | **DELETE** /accounts/{account-ID}/credit/{value} | Decrease the amount of credit by the value specified or entirely if no value provided. -*AccountsApi* | [**remove_permission_from_account**](docs/AccountsApi.md#remove_permission_from_account) | **DELETE** /accounts/{account-ID}/roles/{role} | Revoke the specified role. -*AccountsApi* | [**set_metadata_for_account**](docs/AccountsApi.md#set_metadata_for_account) | **POST** /accounts/{account-ID}/metadata | Remove any existing metadata keys and create the provided data. -*AccountsApi* | [**update_account**](docs/AccountsApi.md#update_account) | **PUT** /accounts | Update an Account. -*AccountsApi* | [**upsert_metadata_for_account**](docs/AccountsApi.md#upsert_metadata_for_account) | **PUT** /accounts/{account-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed. -*AddressesApi* | [**create_address**](docs/AddressesApi.md#create_address) | **POST** /addresses | Create -*AddressesApi* | [**update_address**](docs/AddressesApi.md#update_address) | **PUT** /addresses | Update -*AmendmentsApi* | [**create_amendment**](docs/AmendmentsApi.md#create_amendment) | **POST** /amendments | Create an amendment. -*AmendmentsApi* | [**get_all_amendments**](docs/AmendmentsApi.md#get_all_amendments) | **GET** /amendments | Returns a collection of all amendments. By default 10 values are returned. Records are returned in natural order. -*AmendmentsApi* | [**get_amendment_by_id**](docs/AmendmentsApi.md#get_amendment_by_id) | **GET** /amendments/{amendment-ID} | Returns a single amendment, specified by the amendment-ID parameter. -*AmendmentsApi* | [**get_amendment_by_state**](docs/AmendmentsApi.md#get_amendment_by_state) | **GET** /amendments/state/{state} | Returns a collection of amendments, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -*AmendmentsApi* | [**get_amendment_by_subscription_id**](docs/AmendmentsApi.md#get_amendment_by_subscription_id) | **GET** /amendments/subscription/{subscription-ID} | Returns a collection of amendments, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. -*AmendmentsApi* | [**get_amendment_swagger**](docs/AmendmentsApi.md#get_amendment_swagger) | **GET** /amendments/swagger-end-point/{query-string} | -*AmendmentsApi* | [**get_amendments_by_actioning_time**](docs/AmendmentsApi.md#get_amendments_by_actioning_time) | **GET** /amendments/actioning-time/{lower-threshold}/{upper-threshold} | Returns a collection of amendment objects with an actioning-time within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*AmendmentsApi* | [**get_amendments_by_created_date**](docs/AmendmentsApi.md#get_amendments_by_created_date) | **GET** /amendments/created/{lower-threshold}/{upper-threshold} | Returns a collection of amendment objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*AmendmentsApi* | [**get_amendments_by_updated_date**](docs/AmendmentsApi.md#get_amendments_by_updated_date) | **GET** /amendments/updated/{lower-threshold}/{upper-threshold} | Returns a collection of amendment objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*AmendmentsApi* | [**retire_amendment**](docs/AmendmentsApi.md#retire_amendment) | **DELETE** /amendments/{amendment-ID} | Retires the amendment specified by the amendment-ID parameter. Retiring a amendment causes it to cancel based on the specificed retirement settings for the product. -*AmendmentsApi* | [**update_amendment**](docs/AmendmentsApi.md#update_amendment) | **PUT** /amendments | Update an amendment. -*AnalyticsApi* | [**get_account_debts**](docs/AnalyticsApi.md#get_account_debts) | **POST** /analytics/payments/accounts/outstanding | Gets outstanding debts per account, within a date range. -*AnalyticsApi* | [**get_account_ltv**](docs/AnalyticsApi.md#get_account_ltv) | **GET** /analytics/account-ltv/{account-id}/{end-datetime} | Gets an account's life-time value, as of a given end date. -*AnalyticsApi* | [**get_account_payments**](docs/AnalyticsApi.md#get_account_payments) | **POST** /analytics/payments/accounts | Gets hourly payments per product, within a date range. -*AnalyticsApi* | [**get_billforward_managed_payments**](docs/AnalyticsApi.md#get_billforward_managed_payments) | **GET** /analytics/billforward-managed-payments/{start-datetime}/{end-datetime} | Gets all payments managed by BillForward, within a date range. -*AnalyticsApi* | [**get_churn**](docs/AnalyticsApi.md#get_churn) | **GET** /analytics/churn/{start-datetime}/{end-datetime} | Gets churn, within a date range. -*AnalyticsApi* | [**get_debts**](docs/AnalyticsApi.md#get_debts) | **GET** /analytics/payments/outstanding/{start-datetime}/{end-datetime} | Gets debts within a date range. -*AnalyticsApi* | [**get_payments**](docs/AnalyticsApi.md#get_payments) | **GET** /analytics/payments/{start-datetime}/{end-datetime} | Gets payments within a date range. -*AnalyticsApi* | [**get_product_payments**](docs/AnalyticsApi.md#get_product_payments) | **POST** /analytics/payments-per-product | Gets hourly payments per product, within a date range. -*AnalyticsApi* | [**get_product_rate_plan_payments**](docs/AnalyticsApi.md#get_product_rate_plan_payments) | **POST** /analytics/payments/product-rate-plan | Gets hourly payments per product, within a date range. -*AnalyticsApi* | [**get_subscription_ltv**](docs/AnalyticsApi.md#get_subscription_ltv) | **GET** /analytics/subscription-ltv/{subscription-id}/{end-datetime} | Gets a subscription's life-time value, as of a given end date. -*AnalyticsApi* | [**get_upgrades**](docs/AnalyticsApi.md#get_upgrades) | **GET** /analytics/upgrades/{start-datetime}/{end-datetime} | Gets upgrades, within a date range. -*AuditlogsApi* | [**get_all_audit_entries**](docs/AuditlogsApi.md#get_all_audit_entries) | **GET** /audit-logs | Returns a collection of all audit-log objects. By default 10 values are returned. Records are returned in natural order. -*AuditlogsApi* | [**get_audit_entries_by_created_date**](docs/AuditlogsApi.md#get_audit_entries_by_created_date) | **GET** /audit-logs/created/{lower-threshold}/{upper-threshold} | Returns a collection of audit-log objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*AuditlogsApi* | [**get_audit_entry_by_entity_id**](docs/AuditlogsApi.md#get_audit_entry_by_entity_id) | **GET** /audit-logs/entity/{entity-ID} | Returns a collection of audit-log entries, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. -*AuditlogsApi* | [**get_audit_entry_by_entity_type**](docs/AuditlogsApi.md#get_audit_entry_by_entity_type) | **GET** /audit-logs/entity-type/{entity-type} | Returns a collection of audit-log entries, specified by the entity-type parameter. By default 10 values are returned. Records are returned in natural order. -*AuditlogsApi* | [**get_audit_entry_by_id**](docs/AuditlogsApi.md#get_audit_entry_by_id) | **GET** /audit-logs/{audit-ID} | Returns a single audit-log entry, specified by the audit-ID parameter. -*ChargesApi* | [**get_all_subscription_charges**](docs/ChargesApi.md#get_all_subscription_charges) | **GET** /charges | Retrieves a collection of all charges. By default 10 values are returned. Records are returned in natural order. -*ChargesApi* | [**get_subscription_charge_by_account_id**](docs/ChargesApi.md#get_subscription_charge_by_account_id) | **GET** /charges/account/{account-ID} | Retrieves a collection of charges, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -*ChargesApi* | [**get_subscription_charge_by_id**](docs/ChargesApi.md#get_subscription_charge_by_id) | **GET** /charges/{charge-id} | Retrieves a single charge, specified by the charge-id parameter. -*ChargesApi* | [**get_subscription_charge_by_state**](docs/ChargesApi.md#get_subscription_charge_by_state) | **GET** /charges/state/{state} | Retrieves a collection of charges, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -*ChargesApi* | [**get_subscription_charge_by_version_id**](docs/ChargesApi.md#get_subscription_charge_by_version_id) | **GET** /charges/version/{version-ID} | Retrieves a single charge, specified by the version-ID parameter. -*ChargesApi* | [**recalculate_subscription_charge**](docs/ChargesApi.md#recalculate_subscription_charge) | **POST** /charges/{charge-ID}/recalculate | Recalculate a charge. -*ChargesApi* | [**void_subscription_charge**](docs/ChargesApi.md#void_subscription_charge) | **DELETE** /charges/{charge-id} | Void the charge with the specified charge-ID. -*ClientsApi* | [**create_client**](docs/ClientsApi.md#create_client) | **POST** /clients | Create a client. -*ClientsApi* | [**get_all_clients**](docs/ClientsApi.md#get_all_clients) | **GET** /clients | Returns a collection of clients. -*ClientsApi* | [**get_client_by_id**](docs/ClientsApi.md#get_client_by_id) | **GET** /clients/{client-ID} | Returns a single client, specified by the client-ID parameter. -*ClientsApi* | [**update_client**](docs/ClientsApi.md#update_client) | **PUT** /clients | Update a client. -*ConfigurationsApi* | [**create_api_configuration**](docs/ConfigurationsApi.md#create_api_configuration) | **POST** /configurations | Create a configuration. -*ConfigurationsApi* | [**get_all_api_configurations**](docs/ConfigurationsApi.md#get_all_api_configurations) | **GET** /configurations | Returns a collection of configurations. By default 10 values are returned. Records are returned in natural order. -*ConfigurationsApi* | [**get_api_configurations_by_type**](docs/ConfigurationsApi.md#get_api_configurations_by_type) | **GET** /configurations/type/{configuration-type} | Returns a single configuration, specified by the type parameter. -*ConfigurationsApi* | [**update_api_configuration**](docs/ConfigurationsApi.md#update_api_configuration) | **PUT** /configurations | Update a configuration. -*CouponbookApi* | [**create_coupon_book**](docs/CouponbookApi.md#create_coupon_book) | **POST** /coupon-books | Create a coupon-book. -*CouponbookApi* | [**delete_coupon_book**](docs/CouponbookApi.md#delete_coupon_book) | **DELETE** /coupon-books/{coupon-book-ID} | Retire a coupon-book, specified by the coupon-book-ID parameter. -*CouponbookApi* | [**get_all_attachable_coupon_books**](docs/CouponbookApi.md#get_all_attachable_coupon_books) | **GET** /coupon-books/attachable/{attachableness}/{has_code} | Returns a collection of attachable coupon-books. An attachable coupon-book has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. -*CouponbookApi* | [**get_all_coupon_books**](docs/CouponbookApi.md#get_all_coupon_books) | **GET** /coupon-books | Returns a collection of coupon-books. By default 10 values are returned. Records are returned in natural order. -*CouponbookApi* | [**get_coupon_book_by_book_code**](docs/CouponbookApi.md#get_coupon_book_by_book_code) | **GET** /coupon-books/book-code/{book-code} | Returns a single coupon-book, specified by the book-code parameter. -*CouponbookApi* | [**get_coupon_book_by_coupon_book_definition_id**](docs/CouponbookApi.md#get_coupon_book_by_coupon_book_definition_id) | **GET** /coupon-books/coupon-book-definition/{coupon-book-definition-ID} | Returns a collection of coupon-books, specified by coupon-book-definition-ID parameter. By default 10 coupon-books are returned. Records are returned in natural order. -*CouponbookApi* | [**get_coupon_book_by_coupon_code**](docs/CouponbookApi.md#get_coupon_book_by_coupon_code) | **GET** /coupon-books/coupon/{coupon-code} | Returns a single coupon-book, specified by the coupon-code parameter. -*CouponbookApi* | [**get_coupon_book_by_id**](docs/CouponbookApi.md#get_coupon_book_by_id) | **GET** /coupon-books/{coupon-book-ID} | Returns a single coupon-book, specified by the coupon-book-ID parameter. -*CouponbookApi* | [**update_coupon_book**](docs/CouponbookApi.md#update_coupon_book) | **PUT** /coupon-books | Update a coupon-book. -*CouponbookdefinitionApi* | [**create_coupon_book_definition**](docs/CouponbookdefinitionApi.md#create_coupon_book_definition) | **POST** /coupon-book-definitions | Create a coupon-book-definition. -*CouponbookdefinitionApi* | [**delete_coupon_book_definition**](docs/CouponbookdefinitionApi.md#delete_coupon_book_definition) | **DELETE** /coupon-book-definitions/{coupon-book-definition-ID} | Retire a coupon-book-definition, specified by the coupon-book-definition-ID parameter. -*CouponbookdefinitionApi* | [**get_all_coupon_book_definitions**](docs/CouponbookdefinitionApi.md#get_all_coupon_book_definitions) | **GET** /coupon-book-definitions | Returns a collection of coupon-book-definitions. By default 10 values are returned. Records are returned in natural order. -*CouponbookdefinitionApi* | [**get_coupon_book_definition_by_coupon_definition_id**](docs/CouponbookdefinitionApi.md#get_coupon_book_definition_by_coupon_definition_id) | **GET** /coupon-book-definitions/coupon-definition/{coupon-definition-ID} | Returns a collection of coupon-book-definitions, specified by coupon-definition-ID parameter. By default 10 coupon-book-definitions are returned. Records are returned in natural order. -*CouponbookdefinitionApi* | [**get_coupon_book_definition_by_id**](docs/CouponbookdefinitionApi.md#get_coupon_book_definition_by_id) | **GET** /coupon-book-definitions/{coupon-book-definition-ID} | Returns a single coupon-book-definition, specified by the coupon-book-definition-ID parameter. -*CouponbookdefinitionApi* | [**update_coupon_book_definition**](docs/CouponbookdefinitionApi.md#update_coupon_book_definition) | **PUT** /coupon-book-definitions | Update a coupon-book-definition. -*CoupondefinitionApi* | [**create_coupon_definition**](docs/CoupondefinitionApi.md#create_coupon_definition) | **POST** /coupon-definitions | Create a coupon-definition. -*CoupondefinitionApi* | [**delete_coupon_definition**](docs/CoupondefinitionApi.md#delete_coupon_definition) | **DELETE** /coupon-definitions/{coupon-definition-ID} | Retire a coupon-definition, specified by the coupon-definition-ID parameter. -*CoupondefinitionApi* | [**get_all_coupon_definitions**](docs/CoupondefinitionApi.md#get_all_coupon_definitions) | **GET** /coupon-definitions | Returns a collection of coupon-definitions. By default 10 values are returned. Records are returned in natural order. -*CoupondefinitionApi* | [**get_coupon_definition_by_id**](docs/CoupondefinitionApi.md#get_coupon_definition_by_id) | **GET** /coupon-definitions/{coupon-definition-ID} | Returns a single coupon-definition, specified by the coupon-definition-ID parameter. -*CoupondefinitionApi* | [**update_coupon_definition**](docs/CoupondefinitionApi.md#update_coupon_definition) | **PUT** /coupon-definitions | Update a coupon-definition. -*CouponinstanceApi* | [**create_coupon_instance**](docs/CouponinstanceApi.md#create_coupon_instance) | **POST** /coupon-instances | Create a coupon-instance. -*CouponinstanceApi* | [**delete_coupon_instance**](docs/CouponinstanceApi.md#delete_coupon_instance) | **DELETE** /coupon-instances/{coupon-instance-ID} | Retire a coupon-instance, specified by the coupon-instance-ID parameter. -*CouponinstanceApi* | [**get_all_attachable_coupon_instances**](docs/CouponinstanceApi.md#get_all_attachable_coupon_instances) | **GET** /coupon-instances/attachable/{attachableness}/{has_code} | Returns a collection of attachable coupon-instances. An attachable coupon-instance has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. -*CouponinstanceApi* | [**get_all_coupon_instances**](docs/CouponinstanceApi.md#get_all_coupon_instances) | **GET** /coupon-instances | Returns a collection of coupon-instances. By default 10 values are returned. Records are returned in natural order. -*CouponinstanceApi* | [**get_coupon_instance_by_coupon_code**](docs/CouponinstanceApi.md#get_coupon_instance_by_coupon_code) | **GET** /coupon-instances/coupon/{coupon-code} | Returns a collection of coupon-instances, specified by coupon-code parameter. By default 10 coupon-instances are returned. Records are returned in natural order. -*CouponinstanceApi* | [**get_coupon_instance_by_coupon_definition_id**](docs/CouponinstanceApi.md#get_coupon_instance_by_coupon_definition_id) | **GET** /coupon-instances/coupon-definition/{coupon-definition-ID} | Returns a collection of coupon-instances, specified by coupon-definition-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. -*CouponinstanceApi* | [**get_coupon_instance_by_id**](docs/CouponinstanceApi.md#get_coupon_instance_by_id) | **GET** /coupon-instances/{coupon-instance-ID} | Returns a single coupon-instance, specified by the coupon-instance-ID parameter. -*CouponinstanceApi* | [**get_coupon_instance_by_target_id**](docs/CouponinstanceApi.md#get_coupon_instance_by_target_id) | **GET** /coupon-instances/target/{target-ID} | Returns a collection of coupon-instances, specified by target-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. -*CouponinstanceApi* | [**get_coupon_instance_by_target_type**](docs/CouponinstanceApi.md#get_coupon_instance_by_target_type) | **GET** /coupon-instances/target-entity/{target} | Returns a collection of coupon-instances, specified by target parameter. By default 10 coupon-instances are returned. Records are returned in natural order. -*CouponinstanceApi* | [**update_coupon_instance**](docs/CouponinstanceApi.md#update_coupon_instance) | **PUT** /coupon-instances | Update a coupon-instance. -*CouponmodifierApi* | [**create_coupon_modifier**](docs/CouponmodifierApi.md#create_coupon_modifier) | **POST** /coupon-modifiers | Create a coupon-modifier. -*CouponmodifierApi* | [**delete_coupon_modifier**](docs/CouponmodifierApi.md#delete_coupon_modifier) | **DELETE** /coupon-modifiers/{coupon-modifier-ID} | Retire a coupon-modifier, specified by the coupon-modifier-ID parameter. -*CouponmodifierApi* | [**get_all_coupon_modifiers**](docs/CouponmodifierApi.md#get_all_coupon_modifiers) | **GET** /coupon-modifiers | Returns a collection of coupon-modifiers. By default 10 values are returned. Records are returned in natural order. -*CouponmodifierApi* | [**get_coupon_modifier_by_coupon_code**](docs/CouponmodifierApi.md#get_coupon_modifier_by_coupon_code) | **GET** /coupon-modifiers/coupon-code/{coupon-code} | Returns a collection of coupon-modifiers, specified by the coupon-code parameter. -*CouponmodifierApi* | [**get_coupon_modifier_by_coupon_definition_id**](docs/CouponmodifierApi.md#get_coupon_modifier_by_coupon_definition_id) | **GET** /coupon-modifiers/coupon-definition/{coupon-definition-ID} | Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter. -*CouponmodifierApi* | [**get_coupon_modifier_by_id**](docs/CouponmodifierApi.md#get_coupon_modifier_by_id) | **GET** /coupon-modifiers/{coupon-modifier-ID} | Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter. -*CouponmodifierApi* | [**update_coupon_modifier**](docs/CouponmodifierApi.md#update_coupon_modifier) | **PUT** /coupon-modifiers | Update a coupon-instance. -*CouponruleApi* | [**create_coupon_rule**](docs/CouponruleApi.md#create_coupon_rule) | **POST** /coupon-rules | Create a coupon-rule. -*CouponruleApi* | [**delete_coupon_rule**](docs/CouponruleApi.md#delete_coupon_rule) | **DELETE** /coupon-rules/{coupon-rule-ID} | Retire a coupon-rule, specified by the coupon-rule-ID parameter. -*CouponruleApi* | [**get_all_coupon_rules**](docs/CouponruleApi.md#get_all_coupon_rules) | **GET** /coupon-rules | Returns a collection of coupon-rules. By default 10 values are returned. Records are returned in natural order. -*CouponruleApi* | [**get_coupon_rule_by_coupon_definition_id**](docs/CouponruleApi.md#get_coupon_rule_by_coupon_definition_id) | **GET** /coupon-rules/coupon-definition/{coupon-definition-ID} | Returns a single coupon-definition, specified by the coupon-definition-ID parameter. -*CouponruleApi* | [**get_coupon_rule_by_id**](docs/CouponruleApi.md#get_coupon_rule_by_id) | **GET** /coupon-rules/{coupon-rule-ID} | Returns a single coupon-rule, specified by the coupon-rule-ID parameter. -*CouponsApi* | [**create_coupon**](docs/CouponsApi.md#create_coupon) | **POST** /coupons | Create a coupon. -*CouponsApi* | [**create_coupon_unique_codes**](docs/CouponsApi.md#create_coupon_unique_codes) | **POST** /coupons/{code}/codes | Create a list of unique coupon codes that can be applied to a subscription. -*CouponsApi* | [**get_all_coupons**](docs/CouponsApi.md#get_all_coupons) | **GET** /coupons | Returns a collection of all coupons. By default 10 values are returned. Records are returned in natural order. -*CouponsApi* | [**get_applied_coupons**](docs/CouponsApi.md#get_applied_coupons) | **GET** /coupons/{code}/applied | Returns a list of unique coupons which have been applied. -*CouponsApi* | [**get_available_coupon_codes_for_code**](docs/CouponsApi.md#get_available_coupon_codes_for_code) | **GET** /coupons/{code}/codes | Returns a list of available unique coupon codes for the specified parent coupon code that can be applied to a subscription. -*CouponsApi* | [**get_coupon_code**](docs/CouponsApi.md#get_coupon_code) | **GET** /coupons/{code} | Returns the coupon for the specified code that can be applied to a subscription. -*CouponsApi* | [**get_subscription_applications_of_coupons**](docs/CouponsApi.md#get_subscription_applications_of_coupons) | **GET** /coupons/{code}/subscriptions | Retrieves a collection of the coupons by this coupon code which have been applied. -*CouponsApi* | [**retire_coupon**](docs/CouponsApi.md#retire_coupon) | **DELETE** /coupons/{code} | <p>This method has 2 main behaviours depending on what is passed in. If the parent coupon code, for example SUMMER, is given no new coupons can be issued or claimed from this code. Deleting will result in the deleted property being set to true.</p><p>If a unique coupon code, for example SUMMER-AGH8, is given this will stop the coupon from being applied to the subscription from that point onwards. When a coupon is deleted the validUntil property is set which is the date/time it stopped applying to the target.</p> -*CreditnotesApi* | [**create_credit_note**](docs/CreditnotesApi.md#create_credit_note) | **POST** /credit-notes | Create a credit note. -*CreditnotesApi* | [**get_credit_note_by_id**](docs/CreditnotesApi.md#get_credit_note_by_id) | **GET** /credit-notes/{credit-note-ID} | Returns a single credit-note, specified by the ID parameter. -*CreditnotesApi* | [**get_credit_note_for_account**](docs/CreditnotesApi.md#get_credit_note_for_account) | **GET** /credit-notes/account/{account-ID} | Returns credit notes for an account. -*CreditnotesApi* | [**get_credit_note_for_invoice**](docs/CreditnotesApi.md#get_credit_note_for_invoice) | **GET** /credit-notes/invoice/{invoice-ID} | Returns credit notes for an invoice. -*CreditnotesApi* | [**get_credit_note_for_subscription**](docs/CreditnotesApi.md#get_credit_note_for_subscription) | **GET** /credit-notes/subscription/{subscription-ID} | Returns credit notes for an subscription. -*CreditnotesApi* | [**retire_credit_note**](docs/CreditnotesApi.md#retire_credit_note) | **DELETE** /credit-notes/{credit-note-ID} | Removes any remaining value from credit note -*CybersourcetokensApi* | [**create_cybersource_token**](docs/CybersourcetokensApi.md#create_cybersource_token) | **POST** /cybersource-tokens | Create a cybersource-token. -*CybersourcetokensApi* | [**get_cybersource_token_by_id**](docs/CybersourcetokensApi.md#get_cybersource_token_by_id) | **GET** /cybersource-tokens/{token-ID} | Returns a single cybersource-token, specified by the token-ID parameter. -*CybersourcetokensApi* | [**get_cybersource_token_by_recurring_subscription_id**](docs/CybersourcetokensApi.md#get_cybersource_token_by_recurring_subscription_id) | **GET** /cybersource-tokens/recurring-subscription-info/{recurring-subscription-ID} | Returns a single cybersource-token, specified by the recurring-subscription-ID parameter. -*CybersourcetokensApi* | [**retire_cybersource_token**](docs/CybersourcetokensApi.md#retire_cybersource_token) | **DELETE** /cybersource-tokens/{token-ID} | Retires the cybersource token specified by the token-ID parameter. -*CybersourcetokensApi* | [**update_cybersource_token**](docs/CybersourcetokensApi.md#update_cybersource_token) | **PUT** /cybersource-tokens | Update a cybersource-token. -*DunninglinesApi* | [**create_dunning_line**](docs/DunninglinesApi.md#create_dunning_line) | **POST** /dunning-lines | Create a dunning-line. -*DunninglinesApi* | [**get_all_dunning_lines**](docs/DunninglinesApi.md#get_all_dunning_lines) | **GET** /dunning-lines | Returns a collection of all dunning-lines. By default 10 values are returned. Records are returned in natural order. -*DunninglinesApi* | [**get_dunning_line_by_attempt_index**](docs/DunninglinesApi.md#get_dunning_line_by_attempt_index) | **GET** /dunning-lines/attempt-index/{index} | Returns a collection of dunning-lines specified by the index parameter. By default 10 values are returned. Records are returned in natural order. -*DunninglinesApi* | [**get_dunning_line_by_id**](docs/DunninglinesApi.md#get_dunning_line_by_id) | **GET** /dunning-lines/{dunning-line-ID} | Returns a single dunning-line, specified by the dunning-line-ID parameter. -*DunninglinesApi* | [**retire_dunning_line**](docs/DunninglinesApi.md#retire_dunning_line) | **DELETE** /dunning-lines/{dunning-line-ID} | Retires the specified dunning-line. -*DunninglinesApi* | [**update_dunning_line**](docs/DunninglinesApi.md#update_dunning_line) | **PUT** /dunning-lines | Update a dunning-line. -*EmailprovidersApi* | [**create_email_provider**](docs/EmailprovidersApi.md#create_email_provider) | **POST** /email-providers | Create an email provider. -*EmailprovidersApi* | [**delete**](docs/EmailprovidersApi.md#delete) | **DELETE** /email-providers/{email-provider-ID} | Deletes a single email provider, specified by id or name parameter. -*EmailprovidersApi* | [**get_all_email_providers**](docs/EmailprovidersApi.md#get_all_email_providers) | **GET** /email-providers | Returns a collection of all email-providers. By default 10 values are returned. Records are returned in natural order. -*EmailprovidersApi* | [**get_email_by_provider_id**](docs/EmailprovidersApi.md#get_email_by_provider_id) | **GET** /email-providers/{email-provider-ID} | Retrieves a single email provider, specified by the version-ID parameter. -*EmailsApi* | [**get_email_by_id**](docs/EmailsApi.md#get_email_by_id) | **GET** /emails/{email-ID} | Retrieves a single invoice, specified by the version-ID parameter. -*EmailsApi* | [**get_email_html_by_id**](docs/EmailsApi.md#get_email_html_by_id) | **GET** /emails/{email-ID}.html | Retrieves a single invoice, specified by the version-ID parameter. -*EmailsApi* | [**get_email_text_by_id**](docs/EmailsApi.md#get_email_text_by_id) | **GET** /emails/{email-ID}.txt | Retrieves a single invoice, specified by the version-ID parameter. -*EmailsubscriptionsApi* | [**create_email_subscription**](docs/EmailsubscriptionsApi.md#create_email_subscription) | **POST** /email-subscriptions | Create an email subscription. -*EmailsubscriptionsApi* | [**delete_email_subscription_by_type**](docs/EmailsubscriptionsApi.md#delete_email_subscription_by_type) | **DELETE** /email-subscriptions/type={type} | Unsubscribe from the email specified by the type parameter. -*EmailsubscriptionsApi* | [**get_all_email_subscriptions**](docs/EmailsubscriptionsApi.md#get_all_email_subscriptions) | **GET** /email-subscriptions | Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order. -*EmailsubscriptionsApi* | [**get_email_subscription_by_id**](docs/EmailsubscriptionsApi.md#get_email_subscription_by_id) | **GET** /email-subscriptions/{email-subscription-id} | Retrieves a single email subscription, specified by ID. -*EmailsubscriptionsApi* | [**update_email_subscription**](docs/EmailsubscriptionsApi.md#update_email_subscription) | **PUT** /email-subscriptions | Update an email subscription. -*FixedtermdefinitionsApi* | [**create_fixed_term_definition**](docs/FixedtermdefinitionsApi.md#create_fixed_term_definition) | **POST** /fixed-term-definitions | Create -*FixedtermdefinitionsApi* | [**update_fixed_term_definition**](docs/FixedtermdefinitionsApi.md#update_fixed_term_definition) | **PUT** /fixed-term-definitions | Update -*FixedtermsApi* | [**update_fixed_term**](docs/FixedtermsApi.md#update_fixed_term) | **PUT** /fixed-terms | Update -*InvoicesApi* | [**add_charge_to_invoice**](docs/InvoicesApi.md#add_charge_to_invoice) | **POST** /invoices/{invoice-ID}/charges | Creates a charge on the specified invoice. -*InvoicesApi* | [**aggregate_invoices**](docs/InvoicesApi.md#aggregate_invoices) | **POST** /invoices/aggregate | Aggregate Invoices into to one parent Invoice -*InvoicesApi* | [**execute_invoice**](docs/InvoicesApi.md#execute_invoice) | **POST** /invoices/{invoice-ID}/execute | Attempt payment for the outstanding value of an invoice -*InvoicesApi* | [**generate_line_payments_for_all_invoices**](docs/InvoicesApi.md#generate_line_payments_for_all_invoices) | **POST** /invoices/generate-line-payments | Generates InvoiceLinePayments for all existing InvoicePayments. -*InvoicesApi* | [**get_all_invoices**](docs/InvoicesApi.md#get_all_invoices) | **GET** /invoices | Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. -*InvoicesApi* | [**get_all_invoices_as_csv**](docs/InvoicesApi.md#get_all_invoices_as_csv) | **GET** /invoices/all.csv | Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. -*InvoicesApi* | [**get_bucketed_revenue_attributions_as_csv**](docs/InvoicesApi.md#get_bucketed_revenue_attributions_as_csv) | **GET** /invoices/bucketed-revenue-attributions.csv | Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed. -*InvoicesApi* | [**get_charges_on_invoice**](docs/InvoicesApi.md#get_charges_on_invoice) | **GET** /invoices/{invoice-ID}/charges | Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order. -*InvoicesApi* | [**get_credit_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/credit.csv | Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. -*InvoicesApi* | [**get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](docs/InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/credit.csv | Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. -*InvoicesApi* | [**get_debit_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/revenue.csv | Retrieves received revenue from InvoicePayments upon line items, in CSV format. -*InvoicesApi* | [**get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](docs/InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/revenue.csv | Retrieves received revenue from InvoicePayments upon line items, in CSV format. -*InvoicesApi* | [**get_invoice_as_html**](docs/InvoicesApi.md#get_invoice_as_html) | **GET** /invoices/{ID}.html | Retrieves a single invoice specified by the ID parameter. -*InvoicesApi* | [**get_invoice_as_pdf**](docs/InvoicesApi.md#get_invoice_as_pdf) | **GET** /invoices/{ID}.pdf | Retrieves a single invoice specified by the ID parameter. -*InvoicesApi* | [**get_invoice_by_id**](docs/InvoicesApi.md#get_invoice_by_id) | **GET** /invoices/{invoice-ID} | Retrieves a single invoice specified by the invoice-ID parameter. -*InvoicesApi* | [**get_invoice_by_id_as_csv**](docs/InvoicesApi.md#get_invoice_by_id_as_csv) | **GET** /invoices/{ID}.csv | Retrieves a single invoice specified by the ID parameter. -*InvoicesApi* | [**get_invoice_by_subscription_id**](docs/InvoicesApi.md#get_invoice_by_subscription_id) | **GET** /invoices/subscription/{subscription-ID} | Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. -*InvoicesApi* | [**get_invoice_by_subscription_version_id**](docs/InvoicesApi.md#get_invoice_by_subscription_version_id) | **GET** /invoices/subscription/version/{subscription-version-ID} | Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order. -*InvoicesApi* | [**get_invoice_by_version_id**](docs/InvoicesApi.md#get_invoice_by_version_id) | **GET** /invoices/version/{version-ID} | Retrieves a single invoice, specified by the version-ID parameter. -*InvoicesApi* | [**get_invoices_by_account_id**](docs/InvoicesApi.md#get_invoices_by_account_id) | **GET** /invoices/account/{account-ID} | Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -*InvoicesApi* | [**get_invoices_by_period_end**](docs/InvoicesApi.md#get_invoices_by_period_end) | **GET** /invoices/period-end/{lower-threshold}/{upper-threshold} | Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*InvoicesApi* | [**get_invoices_by_period_start**](docs/InvoicesApi.md#get_invoices_by_period_start) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*InvoicesApi* | [**get_invoices_by_period_start_as_csv**](docs/InvoicesApi.md#get_invoices_by_period_start_as_csv) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold}.csv | Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*InvoicesApi* | [**get_invoices_by_state**](docs/InvoicesApi.md#get_invoices_by_state) | **GET** /invoices/state/{state} | Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -*InvoicesApi* | [**get_invoices_by_state_and_period_start**](docs/InvoicesApi.md#get_invoices_by_state_and_period_start) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*InvoicesApi* | [**get_invoices_by_state_and_period_start_as_csv**](docs/InvoicesApi.md#get_invoices_by_state_and_period_start_as_csv) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}.csv | Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*InvoicesApi* | [**get_invoices_by_state_as_csv**](docs/InvoicesApi.md#get_invoices_by_state_as_csv) | **GET** /invoices/state/{state}.csv | Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -*InvoicesApi* | [**get_line_payments**](docs/InvoicesApi.md#get_line_payments) | **GET** /invoices/line-payments | Retrieves all InvoiceLine payment attributions. -*InvoicesApi* | [**get_line_payments_as_csv**](docs/InvoicesApi.md#get_line_payments_as_csv) | **GET** /invoices/line-payments.csv | Retrieves (as CSV) all InvoiceLine payment attributions. -*InvoicesApi* | [**get_metadata_for_invoice**](docs/InvoicesApi.md#get_metadata_for_invoice) | **GET** /invoices/{invoice-ID}/metadata | Retrieve any associated metadata. -*InvoicesApi* | [**get_refund_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/refund.csv | Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. -*InvoicesApi* | [**get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received**](docs/InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received) | **GET** /invoices/payment-received/refund.csv | Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. -*InvoicesApi* | [**get_revenue_attributions**](docs/InvoicesApi.md#get_revenue_attributions) | **GET** /invoices/revenue-attributions | Retrieves all attributions of Invoice costs to Invoice lines. -*InvoicesApi* | [**get_revenue_attributions_as_csv**](docs/InvoicesApi.md#get_revenue_attributions_as_csv) | **GET** /invoices/revenue-attributions.csv | Retrieves (as CSV) all attributions of Invoice costs to Invoice lines. +*AccountsApi* | [**add_charge_to_account**](docs/AccountsApi.md#add_charge_to_account) | **POST** /accounts/{account-ID}/invoice | +*AccountsApi* | [**add_credit_note_to_account**](docs/AccountsApi.md#add_credit_note_to_account) | **POST** /accounts/{account-ID}/credit | +*AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /accounts | +*AccountsApi* | [**create_address**](docs/AccountsApi.md#create_address) | **POST** /addresses | +*AccountsApi* | [**delete_account**](docs/AccountsApi.md#delete_account) | **DELETE** /accounts/{account-ID} | +*AccountsApi* | [**delete_metadata_for_account**](docs/AccountsApi.md#delete_metadata_for_account) | **DELETE** /accounts/{account-ID}/metadata | +*AccountsApi* | [**get_account_by_id**](docs/AccountsApi.md#get_account_by_id) | **GET** /accounts/{account-ID} | +*AccountsApi* | [**get_all_accounts**](docs/AccountsApi.md#get_all_accounts) | **GET** /accounts | +*AccountsApi* | [**get_available_credit_on_account**](docs/AccountsApi.md#get_available_credit_on_account) | **GET** /accounts/{account-ID}/credit | +*AccountsApi* | [**get_invoices_by_account_id**](docs/AccountsApi.md#get_invoices_by_account_id) | **GET** /accounts/{account-ID}/invoices | +*AccountsApi* | [**get_metadata_for_account**](docs/AccountsApi.md#get_metadata_for_account) | **GET** /accounts/{account-ID}/metadata | +*AccountsApi* | [**get_payment_method_by_account_id**](docs/AccountsApi.md#get_payment_method_by_account_id) | **GET** /accounts/{account-ID}/payment-methods | +*AccountsApi* | [**get_subscription_charges**](docs/AccountsApi.md#get_subscription_charges) | **GET** /accounts/{account-ID}/charges | +*AccountsApi* | [**halt_aggregation**](docs/AccountsApi.md#halt_aggregation) | **POST** /accounts/{account-ID}/halt-aggregation | +*AccountsApi* | [**remove_credit_from_account2**](docs/AccountsApi.md#remove_credit_from_account2) | **DELETE** /accounts/{account-ID}/credit | +*AccountsApi* | [**set_metadata_for_account**](docs/AccountsApi.md#set_metadata_for_account) | **POST** /accounts/{account-ID}/metadata | +*AccountsApi* | [**update_account**](docs/AccountsApi.md#update_account) | **PUT** /accounts | +*AccountsApi* | [**update_address**](docs/AccountsApi.md#update_address) | **PUT** /addresses | +*AccountsApi* | [**upsert_metadata_for_account**](docs/AccountsApi.md#upsert_metadata_for_account) | **PUT** /accounts/{account-ID}/metadata | +*AffiliationApi* | [**create_invoice**](docs/AffiliationApi.md#create_invoice) | **POST** /affiliate/{account-id}/invoice | +*AffiliationApi* | [**get_affiliate**](docs/AffiliationApi.md#get_affiliate) | **GET** /product-rate-plans/{productRatePlanID}/affiliate | +*AffiliationApi* | [**get_affiliate1**](docs/AffiliationApi.md#get_affiliate1) | **GET** /subscriptions/{subscriptionID}/affiliate | +*AffiliationApi* | [**quote_invoice**](docs/AffiliationApi.md#quote_invoice) | **GET** /affiliate/{account-id}/quote/invoice/{invoice-id} | +*AffiliationApi* | [**quote_subscription**](docs/AffiliationApi.md#quote_subscription) | **GET** /affiliate/{account-id}/quote/subscription/{subscription-id} | +*AffiliationApi* | [**set_affiliate**](docs/AffiliationApi.md#set_affiliate) | **POST** /product-rate-plans/{product-rate-plan-ID}/affiliate | +*AffiliationApi* | [**set_affiliate1**](docs/AffiliationApi.md#set_affiliate1) | **POST** /subscriptions/{subscriptionID}/affiliate | +*AffiliationApi* | [**update_affiliate**](docs/AffiliationApi.md#update_affiliate) | **PUT** /product-rate-plans/{product-rate-plan-ID}/affiliate | +*AvataxApi* | [**create_avatax_configuration**](docs/AvataxApi.md#create_avatax_configuration) | **POST** /tax/avatax | +*AvataxApi* | [**get_avatax_configuration**](docs/AvataxApi.md#get_avatax_configuration) | **GET** /tax/avatax | +*AvataxApi* | [**ping**](docs/AvataxApi.md#ping) | **POST** /tax/avatax/ping | +*AvataxApi* | [**update_avatax_configuration**](docs/AvataxApi.md#update_avatax_configuration) | **PUT** /tax/avatax/{avatax-config-ID} | +*CardConnectApi* | [**delete_configuration**](docs/CardConnectApi.md#delete_configuration) | **DELETE** /cardconnect | +*CardConnectApi* | [**get_configuration**](docs/CardConnectApi.md#get_configuration) | **GET** /cardconnect | +*CardConnectApi* | [**upsert_configuration**](docs/CardConnectApi.md#upsert_configuration) | **POST** /cardconnect | +*ChargesApi* | [**batch_recalculate_subscription_charge**](docs/ChargesApi.md#batch_recalculate_subscription_charge) | **POST** /charges/recalculate | +*ChargesApi* | [**get_all_subscription_charges**](docs/ChargesApi.md#get_all_subscription_charges) | **GET** /charges | +*ChargesApi* | [**get_subscription_charge_by_id**](docs/ChargesApi.md#get_subscription_charge_by_id) | **GET** /charges/{charge-id} | +*ChargesApi* | [**recalculate_subscription_charge**](docs/ChargesApi.md#recalculate_subscription_charge) | **POST** /charges/{charge-ID}/recalculate | +*ChargesApi* | [**void_subscription_charge**](docs/ChargesApi.md#void_subscription_charge) | **DELETE** /charges/{charge-id} | +*CheckoutApi* | [**build_subscription_checkout**](docs/CheckoutApi.md#build_subscription_checkout) | **GET** /public/checkouts/subscriptions/{checkout-definition-path} | +*CheckoutApi* | [**create_account1**](docs/CheckoutApi.md#create_account1) | **POST** /public/accounts | +*CheckoutApi* | [**create_subscription_checkout_definition**](docs/CheckoutApi.md#create_subscription_checkout_definition) | **POST** /checkouts/subscriptions | +*CheckoutApi* | [**get_subscription_checkout_definition**](docs/CheckoutApi.md#get_subscription_checkout_definition) | **GET** /checkouts/subscriptions/{checkout-definition-path} | +*CheckoutApi* | [**subscription_checkout**](docs/CheckoutApi.md#subscription_checkout) | **POST** /public/checkouts/subscriptions | +*ContractsApi* | [**add_contract_period**](docs/ContractsApi.md#add_contract_period) | **POST** /contracts/{contract}/period | +*ContractsApi* | [**create_contract**](docs/ContractsApi.md#create_contract) | **POST** /contracts | +*ContractsApi* | [**get_all_contracts**](docs/ContractsApi.md#get_all_contracts) | **GET** /contracts | +*ContractsApi* | [**get_contract_by_id**](docs/ContractsApi.md#get_contract_by_id) | **GET** /contracts/{contract} | +*ContractsApi* | [**start_contract**](docs/ContractsApi.md#start_contract) | **POST** /contracts/{contract}/start | +*ContractsApi* | [**update_contract**](docs/ContractsApi.md#update_contract) | **PUT** /contracts | +*ContractsApi* | [**void_contract**](docs/ContractsApi.md#void_contract) | **DELETE** /contracts/{contract} | +*ContractsApi* | [**void_final_contract_period**](docs/ContractsApi.md#void_final_contract_period) | **DELETE** /contracts/{contract}/period | +*CouponsApi* | [**create_coupon**](docs/CouponsApi.md#create_coupon) | **POST** /coupons | +*CouponsApi* | [**create_coupon_unique_codes**](docs/CouponsApi.md#create_coupon_unique_codes) | **POST** /coupons/{code}/codes | +*CouponsApi* | [**get_all_coupons**](docs/CouponsApi.md#get_all_coupons) | **GET** /coupons | +*CouponsApi* | [**get_applied_coupons**](docs/CouponsApi.md#get_applied_coupons) | **GET** /coupons/{code}/applied | +*CouponsApi* | [**get_available_coupon_codes_for_code**](docs/CouponsApi.md#get_available_coupon_codes_for_code) | **GET** /coupons/{code}/codes | +*CouponsApi* | [**get_available_coupon_codes_for_code_as_csv**](docs/CouponsApi.md#get_available_coupon_codes_for_code_as_csv) | **GET** /coupons/{code}/codes.csv | +*CouponsApi* | [**get_coupon_code**](docs/CouponsApi.md#get_coupon_code) | **GET** /coupons/{code} | +*CouponsApi* | [**get_plans_for_coupon**](docs/CouponsApi.md#get_plans_for_coupon) | **GET** /coupons/{code}/plans | +*CouponsApi* | [**get_subscription_applications_of_coupons**](docs/CouponsApi.md#get_subscription_applications_of_coupons) | **GET** /coupons/{code}/subscriptions | +*CouponsApi* | [**retire_coupon**](docs/CouponsApi.md#retire_coupon) | **DELETE** /coupons/{code} | +*DunningApi* | [**create_dunning_line**](docs/DunningApi.md#create_dunning_line) | **POST** /dunning-lines | +*DunningApi* | [**get_all_dunning_lines**](docs/DunningApi.md#get_all_dunning_lines) | **GET** /dunning-lines | +*DunningApi* | [**get_dunning_line_by_attempt_index**](docs/DunningApi.md#get_dunning_line_by_attempt_index) | **GET** /dunning-lines/attempt-index/{index} | +*DunningApi* | [**get_dunning_line_by_id**](docs/DunningApi.md#get_dunning_line_by_id) | **GET** /dunning-lines/{dunning-line-ID} | +*DunningApi* | [**retire_dunning_line**](docs/DunningApi.md#retire_dunning_line) | **DELETE** /dunning-lines/{dunning-line-ID} | +*DunningApi* | [**update_dunning_line**](docs/DunningApi.md#update_dunning_line) | **PUT** /dunning-lines | +*EBANXApi* | [**delete_configuration1**](docs/EBANXApi.md#delete_configuration1) | **DELETE** /ebanx | +*EBANXApi* | [**get_configuration1**](docs/EBANXApi.md#get_configuration1) | **GET** /ebanx | +*EBANXApi* | [**handle_webhook**](docs/EBANXApi.md#handle_webhook) | **POST** /ebanx/webhook/{organization_id} | +*EBANXApi* | [**upsert_configuration1**](docs/EBANXApi.md#upsert_configuration1) | **POST** /ebanx | +*InvoicesApi* | [**add_charge_to_invoice**](docs/InvoicesApi.md#add_charge_to_invoice) | **POST** /invoices/{invoice-ID}/charges | +*InvoicesApi* | [**execute_invoice**](docs/InvoicesApi.md#execute_invoice) | **POST** /invoices/{invoice-ID}/execute | +*InvoicesApi* | [**get_all_invoices**](docs/InvoicesApi.md#get_all_invoices) | **GET** /invoices | +*InvoicesApi* | [**get_all_invoices_as_csv**](docs/InvoicesApi.md#get_all_invoices_as_csv) | **GET** /invoices/all.csv | +*InvoicesApi* | [**get_bucketed_revenue_attributions_as_csv**](docs/InvoicesApi.md#get_bucketed_revenue_attributions_as_csv) | **GET** /invoices/bucketed-revenue-attributions.csv | +*InvoicesApi* | [**get_charges_on_invoice**](docs/InvoicesApi.md#get_charges_on_invoice) | **GET** /invoices/{invoice-ID}/charges | +*InvoicesApi* | [**get_credit_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/credit.csv | +*InvoicesApi* | [**get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](docs/InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/credit.csv | +*InvoicesApi* | [**get_debit_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/revenue.csv | +*InvoicesApi* | [**get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](docs/InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/revenue.csv | +*InvoicesApi* | [**get_hosted_payments**](docs/InvoicesApi.md#get_hosted_payments) | **GET** /invoices/{invoiceID}/hosted-payments | +*InvoicesApi* | [**get_invoice_as_html**](docs/InvoicesApi.md#get_invoice_as_html) | **GET** /invoices/{ID}.html | +*InvoicesApi* | [**get_invoice_as_pdf**](docs/InvoicesApi.md#get_invoice_as_pdf) | **GET** /invoices/{id}.pdf | +*InvoicesApi* | [**get_invoice_by_id**](docs/InvoicesApi.md#get_invoice_by_id) | **GET** /invoices/{invoice-ID} | +*InvoicesApi* | [**get_invoice_by_id_as_csv**](docs/InvoicesApi.md#get_invoice_by_id_as_csv) | **GET** /invoices/{ID}.csv | +*InvoicesApi* | [**get_invoice_by_subscription_id**](docs/InvoicesApi.md#get_invoice_by_subscription_id) | **GET** /invoices/subscription/{subscription-ID} | +*InvoicesApi* | [**get_invoice_by_subscription_version_id**](docs/InvoicesApi.md#get_invoice_by_subscription_version_id) | **GET** /invoices/subscription/version/{subscription-version-ID} | +*InvoicesApi* | [**get_invoice_by_version_id**](docs/InvoicesApi.md#get_invoice_by_version_id) | **GET** /invoices/version/{version-ID} | +*InvoicesApi* | [**get_invoice_template**](docs/InvoicesApi.md#get_invoice_template) | **GET** /invoices/template | +*InvoicesApi* | [**get_invoices_by_account_id1**](docs/InvoicesApi.md#get_invoices_by_account_id1) | **GET** /invoices/account/{account-ID} | +*InvoicesApi* | [**get_invoices_by_period_end**](docs/InvoicesApi.md#get_invoices_by_period_end) | **GET** /invoices/period-end/{lower-threshold}/{upper-threshold} | +*InvoicesApi* | [**get_invoices_by_period_start**](docs/InvoicesApi.md#get_invoices_by_period_start) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold} | +*InvoicesApi* | [**get_invoices_by_period_start_as_csv**](docs/InvoicesApi.md#get_invoices_by_period_start_as_csv) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold}.csv | +*InvoicesApi* | [**get_invoices_by_state**](docs/InvoicesApi.md#get_invoices_by_state) | **GET** /invoices/state/{state} | +*InvoicesApi* | [**get_invoices_by_state_and_period_start**](docs/InvoicesApi.md#get_invoices_by_state_and_period_start) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold} | +*InvoicesApi* | [**get_invoices_by_state_and_period_start_as_csv**](docs/InvoicesApi.md#get_invoices_by_state_and_period_start_as_csv) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}.csv | +*InvoicesApi* | [**get_invoices_by_state_as_csv**](docs/InvoicesApi.md#get_invoices_by_state_as_csv) | **GET** /invoices/state/{state}.csv | +*InvoicesApi* | [**get_line_payments**](docs/InvoicesApi.md#get_line_payments) | **GET** /invoices/line-payments | +*InvoicesApi* | [**get_line_payments_as_csv**](docs/InvoicesApi.md#get_line_payments_as_csv) | **GET** /invoices/line-payments.csv | +*InvoicesApi* | [**get_metadata_for_invoice**](docs/InvoicesApi.md#get_metadata_for_invoice) | **GET** /invoices/{invoice-ID}/metadata | +*InvoicesApi* | [**get_refund_for_refunded_invoice**](docs/InvoicesApi.md#get_refund_for_refunded_invoice) | **GET** /invoices/{invoice-ID}/refunds | +*InvoicesApi* | [**get_refund_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/refund.csv | +*InvoicesApi* | [**get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received**](docs/InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received) | **GET** /invoices/payment-received/refund.csv | +*InvoicesApi* | [**get_revenue_attributions**](docs/InvoicesApi.md#get_revenue_attributions) | **GET** /invoices/revenue-attributions | +*InvoicesApi* | [**get_revenue_attributions_as_csv**](docs/InvoicesApi.md#get_revenue_attributions_as_csv) | **GET** /invoices/revenue-attributions.csv | *InvoicesApi* | [**get_swagger_for_invoice**](docs/InvoicesApi.md#get_swagger_for_invoice) | **GET** /invoices/swagger-end-point/{query-string} | -*InvoicesApi* | [**import_invoice**](docs/InvoicesApi.md#import_invoice) | **POST** /invoices/import | Import an invoice. -*InvoicesApi* | [**recalculate_invoice**](docs/InvoicesApi.md#recalculate_invoice) | **POST** /invoices/{invoice-ID}/recalculate | Re-calculate an Invoice. -*InvoicesApi* | [**remove_charge_from_invoice**](docs/InvoicesApi.md#remove_charge_from_invoice) | **DELETE** /invoices/{invoice-ID}/charges/{charge-ID} | Removes the specified charge from the specified Invoice. -*InvoicesApi* | [**remove_metadata_from_invoice**](docs/InvoicesApi.md#remove_metadata_from_invoice) | **DELETE** /invoices/{invoice-ID}/metadata | Remove any associated metadata. -*InvoicesApi* | [**set_metadata_for_invoice**](docs/InvoicesApi.md#set_metadata_for_invoice) | **POST** /invoices/{invoice-ID}/metadata | Remove any existing metadata keys and create the provided data. -*InvoicesApi* | [**update_invoice**](docs/InvoicesApi.md#update_invoice) | **PUT** /invoices | Update an Invoice. -*InvoicesApi* | [**upsert_metadata_for_invoice**](docs/InvoicesApi.md#upsert_metadata_for_invoice) | **PUT** /invoices/{invoice-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed. -*InvoicesApi* | [**void_invoice**](docs/InvoicesApi.md#void_invoice) | **DELETE** /invoices/{invoice-ID} | Voids the invoice specified by the invoice identifier parameter. -*MetadataApi* | [**delete_metadata_key_values**](docs/MetadataApi.md#delete_metadata_key_values) | **DELETE** /metadata | Remove any associated metadata. -*MetadataApi* | [**get_metadata_key_values**](docs/MetadataApi.md#get_metadata_key_values) | **GET** /metadata | Retrieve any associated metadata. -*MetadataApi* | [**set_metadata_key_values**](docs/MetadataApi.md#set_metadata_key_values) | **POST** /metadata | Remove any existing metadata keys and create the provided data. -*MetadataApi* | [**upsert_metadata_key_values**](docs/MetadataApi.md#upsert_metadata_key_values) | **PUT** /metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed. -*NotificationsApi* | [**ack_notification**](docs/NotificationsApi.md#ack_notification) | **GET** /notifications/ack/{notification-ID} | Acknowledge a newly recevied notification. -*NotificationsApi* | [**get_all_notifications**](docs/NotificationsApi.md#get_all_notifications) | **GET** /notifications | Returns a collection of all notifications. By default 10 values are returned. Records are returned in natural order. -*NotificationsApi* | [**get_notification_by_entity_id**](docs/NotificationsApi.md#get_notification_by_entity_id) | **GET** /notifications/entity-ID/{entity-ID} | Returns a collection of notifications, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. -*NotificationsApi* | [**get_notification_by_id**](docs/NotificationsApi.md#get_notification_by_id) | **GET** /notifications/{notification-ID} | Returns a single notification, specified by the notification-ID parameter. -*NotificationsApi* | [**get_notifications_by_webhook_id**](docs/NotificationsApi.md#get_notifications_by_webhook_id) | **GET** /notifications/{lower-threshold}/{upper-threshold}/{webhookID} | Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters for the given webhook id. By default 10 values are returned. Records are returned in natural order. -*NotificationsApi* | [**get_notifications_within_date_range**](docs/NotificationsApi.md#get_notifications_within_date_range) | **GET** /notifications/{lower-threshold}/{upper-threshold} | Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*OrganizationsApi* | [**create_organization**](docs/OrganizationsApi.md#create_organization) | **POST** /organizations | Create an organization. -*OrganizationsApi* | [**get_all_my_organizations**](docs/OrganizationsApi.md#get_all_my_organizations) | **GET** /organizations/mine | Returns a collection of all my asociated organizations. By default 10 values are returned. Records are returned in natural order. -*OrganizationsApi* | [**get_all_organizations**](docs/OrganizationsApi.md#get_all_organizations) | **GET** /organizations | Returns a collection of all organizations. By default 10 values are returned. Records are returned in natural order. -*OrganizationsApi* | [**get_organization_by_customer_code**](docs/OrganizationsApi.md#get_organization_by_customer_code) | **GET** /organizations/customer-code/{customer-code} | Returns a single organization, specified by the customer-code parameter. -*OrganizationsApi* | [**get_organization_by_id**](docs/OrganizationsApi.md#get_organization_by_id) | **GET** /organizations/{organization-ID} | Returns a single Organization, specified by the organization-ID parameter. -*OrganizationsApi* | [**get_organization_by_name**](docs/OrganizationsApi.md#get_organization_by_name) | **GET** /organizations/name/{name} | Returns a single Organization, specified by the name parameter. -*OrganizationsApi* | [**update_organization**](docs/OrganizationsApi.md#update_organization) | **PUT** /organizations | Update an organization. -*PasswordsApi* | [**create_password**](docs/PasswordsApi.md#create_password) | **POST** /passwords | Create -*PaymentmethodsApi* | [**create_payment_method**](docs/PaymentmethodsApi.md#create_payment_method) | **POST** /payment-methods | Create a payment-method. -*PaymentmethodsApi* | [**delete_payment_method**](docs/PaymentmethodsApi.md#delete_payment_method) | **DELETE** /payment-methods/{payment-method-ID} | Deletes the payment-method specified by the payment-method-ID parameter. -*PaymentmethodsApi* | [**get_all_payment_methods**](docs/PaymentmethodsApi.md#get_all_payment_methods) | **GET** /payment-methods | Returns a collection of all payment-methods. By default 10 values are returned. Records are returned in natural order. -*PaymentmethodsApi* | [**get_payment_method_by_account_id**](docs/PaymentmethodsApi.md#get_payment_method_by_account_id) | **GET** /payment-methods/account/{account-ID} | Returns a collection of payment-methods, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -*PaymentmethodsApi* | [**get_payment_method_by_id**](docs/PaymentmethodsApi.md#get_payment_method_by_id) | **GET** /payment-methods/{payment-method-ID} | Returns a single payment-method, specified by the payment-method-ID parameter. -*PaymentmethodsApi* | [**get_payment_method_by_link_id**](docs/PaymentmethodsApi.md#get_payment_method_by_link_id) | **GET** /payment-methods/link-id/{linkID} | Returns a single payment-method, specified by the linkID parameter. -*PaymentmethodsApi* | [**get_payment_method_by_payment_gateway**](docs/PaymentmethodsApi.md#get_payment_method_by_payment_gateway) | **GET** /payment-methods/gateway/{gateway} | Returns a collection of payment-methods, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. -*PaymentmethodsApi* | [**update_payment_method**](docs/PaymentmethodsApi.md#update_payment_method) | **PUT** /payment-methods | Update a payment-method. -*PaymentmethodsubscriptionlinksApi* | [**create_payment_method_subscription_link**](docs/PaymentmethodsubscriptionlinksApi.md#create_payment_method_subscription_link) | **POST** /payment-method-subscription-links | Create -*PaymentmethodsubscriptionlinksApi* | [**retire_payment_method_subscription_link**](docs/PaymentmethodsubscriptionlinksApi.md#retire_payment_method_subscription_link) | **DELETE** /payment-method-subscription-links/{payment-method-subscription-link-ID} | Retires the payment-method-subscription-link specified by the link-ID parameter. -*PaymentsApi* | [**create_payment**](docs/PaymentsApi.md#create_payment) | **POST** /payments | Create a payment. -*PaymentsApi* | [**get_all_payments**](docs/PaymentsApi.md#get_all_payments) | **GET** /payments | Returns a collection of all payments. By default 10 values are returned. Records are returned in natural order. -*PaymentsApi* | [**get_payment_as_csv**](docs/PaymentsApi.md#get_payment_as_csv) | **GET** /payments/csv | Retrieves payments in CSV format. -*PaymentsApi* | [**get_payment_by_id**](docs/PaymentsApi.md#get_payment_by_id) | **GET** /payments/{payment-ID} | Returns a single payment, specified by the payment-ID parameter. -*PaymentsApi* | [**get_payment_by_invoice_id**](docs/PaymentsApi.md#get_payment_by_invoice_id) | **GET** /payments/invoice/{invoice-ID} | Returns a collection of payments, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. -*PaymentsApi* | [**get_payment_by_payment_gateway**](docs/PaymentsApi.md#get_payment_by_payment_gateway) | **GET** /payments/gateway/{gateway} | Returns a collection of payments, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. -*PaymentsApi* | [**get_payment_by_payment_method_id**](docs/PaymentsApi.md#get_payment_by_payment_method_id) | **GET** /payments/payment-method/{payment-method-ID} | Returns a collection of payments, specified by the payment-method-ID parameter. By default 10 values are returned. Records are returned in natural order. -*PaymentsApi* | [**update_payment**](docs/PaymentsApi.md#update_payment) | **PUT** /payments | Update a payment. -*PeriodsApi* | [**get_all_periods_for_subscription**](docs/PeriodsApi.md#get_all_periods_for_subscription) | **GET** /periods/{subscription-id} | Retrieve by subscription) -*PeriodsApi* | [**get_latest_periods**](docs/PeriodsApi.md#get_latest_periods) | **GET** /periods | Get all periods -*PermissionsApi* | [**create_permission**](docs/PermissionsApi.md#create_permission) | **POST** /permissions | Create a new permission. -*PermissionsApi* | [**get_all_permissions**](docs/PermissionsApi.md#get_all_permissions) | **GET** /permissions | Retrieves a collection of all permissions. By default 10 values are returned. Records are returned in natural order. -*PermissionsApi* | [**get_available_actions_for_resource**](docs/PermissionsApi.md#get_available_actions_for_resource) | **GET** /permissions/resources/{resource} | Retrieves all the available actions for the specified resource. -*PermissionsApi* | [**get_available_resources**](docs/PermissionsApi.md#get_available_resources) | **GET** /permissions/resources | Retrieves all available resource. -*PermissionsApi* | [**get_permission_by_id**](docs/PermissionsApi.md#get_permission_by_id) | **GET** /permissions/{permission-ID} | Retrieves a single permission, specified by the ID parameter. -*PermissionsApi* | [**revoke_permission**](docs/PermissionsApi.md#revoke_permission) | **DELETE** /permissions/{permission-ID} | Revokes a permission -*PricingcalculatorApi* | [**get_amendment_cost**](docs/PricingcalculatorApi.md#get_amendment_cost) | **POST** /pricing-calculator/amendment-cost | Calculates the price of a subscription's upgrading/downgrading to a new pricing component value. -*PricingcalculatorApi* | [**get_coupon_instance_initialisation_cost**](docs/PricingcalculatorApi.md#get_coupon_instance_initialisation_cost) | **POST** /pricing-calculator/coupon-instance/initialisation | Calculates the price of a subscription to a rate plan, at specified values of pricing component values, and with the specified coupon applied. -*PricingcalculatorApi* | [**get_product_rate_plan_costs**](docs/PricingcalculatorApi.md#get_product_rate_plan_costs) | **POST** /pricing-calculator/product-rate-plan | Calculates the price of a subscription to a rate plan, at specified values of pricing component values. -*PricingcomponentsApi* | [**create_pricing_component**](docs/PricingcomponentsApi.md#create_pricing_component) | **POST** /pricing-components | Create a pricing-component. -*PricingcomponentsApi* | [**get_all_pricing_components**](docs/PricingcomponentsApi.md#get_all_pricing_components) | **GET** /pricing-components | Returns a collection of pricing-components. By default 10 values are returned. Records are returned in natural order. -*PricingcomponentsApi* | [**get_pricing_component**](docs/PricingcomponentsApi.md#get_pricing_component) | **GET** /pricing-components/{pricing-component-ID} | Returns a collection of pricing-components, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. -*PricingcomponentsApi* | [**get_pricing_component_by_product_rate_plan_id**](docs/PricingcomponentsApi.md#get_pricing_component_by_product_rate_plan_id) | **GET** /pricing-components/product-rate-plan/{product-rate-plan-ID} | Returns a collection of pricing-components, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. -*PricingcomponentsApi* | [**retire_pricing_component**](docs/PricingcomponentsApi.md#retire_pricing_component) | **DELETE** /pricing-components/{pricing-component-ID} | Retires the pricing-component specified by the pricing-component-ID parameter. -*PricingcomponentsApi* | [**update_pricing_component**](docs/PricingcomponentsApi.md#update_pricing_component) | **PUT** /pricing-components | Update a pricing-component. -*PricingcomponenttiersApi* | [**create_pricing_component_tier**](docs/PricingcomponenttiersApi.md#create_pricing_component_tier) | **POST** /pricing-component-tiers | Create -*PricingcomponenttiersApi* | [**get_all_pricing_component_tiers**](docs/PricingcomponenttiersApi.md#get_all_pricing_component_tiers) | **GET** /pricing-component-tiers | Returns a collection of pricing-component-tier-tiers. By default 10 values are returned. Records are returned in natural order. -*PricingcomponenttiersApi* | [**get_pricing_component_tier**](docs/PricingcomponenttiersApi.md#get_pricing_component_tier) | **GET** /pricing-component-tiers/{pricing-component-tier-ID} | Returns a collection of pricing-component-tier-tiers, specified by the pricing-component-tier-ID parameter. By default 10 values are returned. Records are returned in natural order. -*PricingcomponenttiersApi* | [**get_pricing_component_tier_by_product_rate_plan_id**](docs/PricingcomponenttiersApi.md#get_pricing_component_tier_by_product_rate_plan_id) | **GET** /pricing-component-tiers/product-rate-plan/{product-rate-plan-ID} | Returns a collection of pricing-component-tier-tiers, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. -*PricingcomponenttiersApi* | [**update_pricing_component_tier**](docs/PricingcomponenttiersApi.md#update_pricing_component_tier) | **PUT** /pricing-component-tiers | Update. -*PricingcomponentvaluechangesApi* | [**create_pricing_component_value_change**](docs/PricingcomponentvaluechangesApi.md#create_pricing_component_value_change) | **POST** /pricing-component-value-changes | Create a pricing-component-value-change. -*PricingcomponentvaluechangesApi* | [**get_all_pricing_component_value_changes**](docs/PricingcomponentvaluechangesApi.md#get_all_pricing_component_value_changes) | **GET** /pricing-component-value-changes | Returns a collection of pricing-component-value-changes. By default 10 values are returned. Records are returned in natural order. -*PricingcomponentvaluechangesApi* | [**get_pricing_component_value_change**](docs/PricingcomponentvaluechangesApi.md#get_pricing_component_value_change) | **GET** /pricing-component-value-changes/{ID} | Returns a single pricing-component-value-changes, specified by the ID parameter. -*PricingcomponentvaluechangesApi* | [**get_pricing_component_value_change_by_component_id**](docs/PricingcomponentvaluechangesApi.md#get_pricing_component_value_change_by_component_id) | **GET** /pricing-component-value-changes/component-ID/{pricing-component-ID} | Returns a collection of pricing-component-value-changes, specified by the pricing-component-value-ID parameter. By default 10 values are returned. Records are returned in natural order. -*PricingcomponentvaluechangesApi* | [**get_pricing_component_value_change_by_invoice_id**](docs/PricingcomponentvaluechangesApi.md#get_pricing_component_value_change_by_invoice_id) | **GET** /pricing-component-value-changes/invoice/{invoice-ID} | Returns a collection of pricing-component-value-changes, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. -*PricingcomponentvaluechangesApi* | [**get_pricing_component_value_change_by_subscription_id**](docs/PricingcomponentvaluechangesApi.md#get_pricing_component_value_change_by_subscription_id) | **GET** /pricing-component-value-changes/subscription/{subscription-ID} | Returns a collection of pricing-component-value-changes, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. -*PricingcomponentvaluesApi* | [**create_pricing_component_value**](docs/PricingcomponentvaluesApi.md#create_pricing_component_value) | **POST** /pricing-component-values | Create a pricing-component-value. -*PricingcomponentvaluesApi* | [**get_all_pricing_component_values**](docs/PricingcomponentvaluesApi.md#get_all_pricing_component_values) | **GET** /pricing-component-values | Returns a collection of pricing-component-values.By default 10 values are returned. Records are returned in natural order. -*PricingcomponentvaluesApi* | [**get_pricing_component_value**](docs/PricingcomponentvaluesApi.md#get_pricing_component_value) | **GET** /pricing-component-values/{pricing-component-ID} | Returns a collection of pricing-component-values, specified by the pricing-component-ID parameter.By default 10 values are returned. Records are returned in natural order. -*PricingcomponentvaluesApi* | [**get_pricing_component_value_by_subscription_id**](docs/PricingcomponentvaluesApi.md#get_pricing_component_value_by_subscription_id) | **GET** /pricing-component-values/subscription/{subscription-ID} | Returns a collection of pricing-component-values, specified by the subscription-ID parameter.By default 10 values are returned. Records are returned in natural order. -*PricingcomponentvaluesApi* | [**update_pricing_component_value**](docs/PricingcomponentvaluesApi.md#update_pricing_component_value) | **PUT** /pricing-component-values | Update a pricing-component-value. -*ProductrateplansApi* | [**add_taxation_strategy_to_rate_plan**](docs/ProductrateplansApi.md#add_taxation_strategy_to_rate_plan) | **POST** /product-rate-plans/{product-rate-plan-ID}/tax | Adds or re-enables the specified taxation-strategy for the given product-rate-plan. -*ProductrateplansApi* | [**create_rate_plan**](docs/ProductrateplansApi.md#create_rate_plan) | **POST** /product-rate-plans | Create a new rate-plan. -*ProductrateplansApi* | [**delete_metadata_for_rate_plan**](docs/ProductrateplansApi.md#delete_metadata_for_rate_plan) | **DELETE** /product-rate-plans/{product-rate-plan-ID}/metadata | Remove any associated metadata. -*ProductrateplansApi* | [**get_all_rate_plans**](docs/ProductrateplansApi.md#get_all_rate_plans) | **GET** /product-rate-plans | Returns a collection of product-rate-plans. By default 10 values are returned. Records are returned in natural order. -*ProductrateplansApi* | [**get_available_taxation_strategies_for_rate_plan**](docs/ProductrateplansApi.md#get_available_taxation_strategies_for_rate_plan) | **GET** /product-rate-plans/{product-rate-plan-ID}/tax | Returns all available taxes for the specified product-rate-plan. By default 10 values are returned. Records are returned in natural order. -*ProductrateplansApi* | [**get_metadata_for_rate_plan**](docs/ProductrateplansApi.md#get_metadata_for_rate_plan) | **GET** /product-rate-plans/{product-rate-plan-ID}/metadata | Retrieve any associated metadata. -*ProductrateplansApi* | [**get_product_rate_plan_by_id**](docs/ProductrateplansApi.md#get_product_rate_plan_by_id) | **GET** /product-rate-plans/{product-rate-plan-ID} | Returns product-rate-plans, specified by the product-rate-plan id or name. -*ProductrateplansApi* | [**get_rate_plan_by_product**](docs/ProductrateplansApi.md#get_rate_plan_by_product) | **GET** /product-rate-plans/product/{product-ID} | Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. -*ProductrateplansApi* | [**get_rate_plan_by_product_and_rate_plan**](docs/ProductrateplansApi.md#get_rate_plan_by_product_and_rate_plan) | **GET** /product-rate-plans/product/{product-ID}/rate-plan/{rate-plan-ID} | Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. -*ProductrateplansApi* | [**remove_taxation_strategy_from_rate_plan**](docs/ProductrateplansApi.md#remove_taxation_strategy_from_rate_plan) | **DELETE** /product-rate-plans/{product-rate-plan-ID}/tax/{taxation-strategy-ID} | Removes the specified taxation-strategy for the given product-rate-plan. -*ProductrateplansApi* | [**retire_rate_plan**](docs/ProductrateplansApi.md#retire_rate_plan) | **DELETE** /product-rate-plans/{product-rate-plan-ID} | Retires the product-rate-plan specified product-rate-plan-ID. -*ProductrateplansApi* | [**set_metadata_for_rate_plan**](docs/ProductrateplansApi.md#set_metadata_for_rate_plan) | **POST** /product-rate-plans/{product-rate-plan-ID}/metadata | Remove any existing metadata keys and create the provided data. -*ProductrateplansApi* | [**update_rate_plan**](docs/ProductrateplansApi.md#update_rate_plan) | **PUT** /product-rate-plans | Update a rate-plan. -*ProductrateplansApi* | [**upsert_metadata_for_rate_plan**](docs/ProductrateplansApi.md#upsert_metadata_for_rate_plan) | **PUT** /product-rate-plans/{product-rate-plan-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed. -*ProductsApi* | [**create_product**](docs/ProductsApi.md#create_product) | **POST** /products | Create a product. -*ProductsApi* | [**delete_metadata_for_product**](docs/ProductsApi.md#delete_metadata_for_product) | **DELETE** /products/{product-ID}/metadata | Remove any associated metadata. -*ProductsApi* | [**get_all_products**](docs/ProductsApi.md#get_all_products) | **GET** /products | Returns a collection of products. By default 10 values are returned. Records are returned in natural order. -*ProductsApi* | [**get_metadata_for_product**](docs/ProductsApi.md#get_metadata_for_product) | **GET** /products/{product-ID}/metadata | Retrieve any associated metadata. -*ProductsApi* | [**get_product_by_id**](docs/ProductsApi.md#get_product_by_id) | **GET** /products/{product-ID} | Returns a single product, specified by the product-ID parameter. -*ProductsApi* | [**retire_product**](docs/ProductsApi.md#retire_product) | **DELETE** /products/{product-ID} | Deletes the product specified by the product-ID parameter. Any existing subscriptions will continue; it is a soft delete. -*ProductsApi* | [**set_metadata_for_product**](docs/ProductsApi.md#set_metadata_for_product) | **POST** /products/{product-ID}/metadata | Remove any existing metadata keys and create the provided data. -*ProductsApi* | [**update_product**](docs/ProductsApi.md#update_product) | **PUT** /products | Update a product. -*ProductsApi* | [**upsert_metadata_for_product**](docs/ProductsApi.md#upsert_metadata_for_product) | **PUT** /products/{product-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed. -*ProfilesApi* | [**get_all_profiles**](docs/ProfilesApi.md#get_all_profiles) | **GET** /profiles | Returns a collection of all profiles. By default 10 values are returned. Records are returned in natural order -*ProfilesApi* | [**get_profile**](docs/ProfilesApi.md#get_profile) | **GET** /profiles/{profile-ID} | Returns a single profile, specified by the ID parameter. -*ProfilesApi* | [**get_profile_by_account_id**](docs/ProfilesApi.md#get_profile_by_account_id) | **GET** /profiles/account/{account-ID} | Returns a collection of profiles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order -*ProfilesApi* | [**get_profile_by_email_address**](docs/ProfilesApi.md#get_profile_by_email_address) | **GET** /profiles/email/{email} | Returns a single profile, specified by the email parameter. -*ProfilesApi* | [**update_profile**](docs/ProfilesApi.md#update_profile) | **PUT** /profiles | Update a profile -*QuotesApi* | [**quote**](docs/QuotesApi.md#quote) | **POST** /quotes | Returns a quote. -*ReceiptsApi* | [**create_receipt**](docs/ReceiptsApi.md#create_receipt) | **POST** /receipts | Create a receipt. -*ReceiptsApi* | [**get_all_receipts**](docs/ReceiptsApi.md#get_all_receipts) | **GET** /receipts | Returns a collection of all receipts. By default 10 values are returned. receipts are returned in natural order -*ReceiptsApi* | [**get_receipt_by_id**](docs/ReceiptsApi.md#get_receipt_by_id) | **GET** /receipts/{receipt-ID} | Returns a single receipt, specified by the ID parameter. -*ReceiptsApi* | [**get_receipts_by_invoice**](docs/ReceiptsApi.md#get_receipts_by_invoice) | **GET** /receipts/invoice/{invoice-ID} | Returns a receipt for the receipt payment. -*ReceiptsApi* | [**get_receipts_by_payment**](docs/ReceiptsApi.md#get_receipts_by_payment) | **GET** /receipts/payment/{payment-ID} | Returns a collection of receipts for the payment. -*ReceiptsApi* | [**get_receipts_for_debit_payments_as_csv**](docs/ReceiptsApi.md#get_receipts_for_debit_payments_as_csv) | **GET** /receipts/debits.csv | Retrieves debit payments in CSV format. -*ReceiptsApi* | [**get_receipts_for_refund_payments_as_csv**](docs/ReceiptsApi.md#get_receipts_for_refund_payments_as_csv) | **GET** /receipts/refunds.csv | Retrieves refunded payments in CSV format. -*RefundsApi* | [**create_refund**](docs/RefundsApi.md#create_refund) | **POST** /refunds | <p>When creating a refund either the invoice, or invoice payment must be specified.</p><p>Creating a refund by specifying the invoiceID will refund any un-refunded value up to the full value of the payment. When refunding via the invoicePaymentID the same rules apply. Refunds will be processed by the same payment methods that took the payment.</p><p>Refunds can be for a partial amount of the payment. It is possible to create refunds up to the value of the total payment.</p><p>Once a payment or invoice is fully refunded, no more refunds can be created. Errors will be returned if the payment is greater than available refund funds.</p> -*RefundsApi* | [**get_all_refunds**](docs/RefundsApi.md#get_all_refunds) | **GET** /refunds | Returns a collection of all refunds. By default 10 values are returned. Refunds are returned in natural order -*RefundsApi* | [**get_refund_by_id**](docs/RefundsApi.md#get_refund_by_id) | **GET** /refunds/{refund-ID} | Returns a single refund, specified by the ID parameter. -*RefundsApi* | [**get_refund_for_original_payment**](docs/RefundsApi.md#get_refund_for_original_payment) | **GET** /refunds/original-payment/{payment-ID} | Returns a refund for the original payment. -*RefundsApi* | [**get_refund_for_refund_payment**](docs/RefundsApi.md#get_refund_for_refund_payment) | **GET** /refunds/refund-payment/{payment-ID} | Returns a refund for the refund payment. -*RefundsApi* | [**get_refund_for_refunded_invoice**](docs/RefundsApi.md#get_refund_for_refunded_invoice) | **GET** /refunds/invoice/{invoice-ID} | Returns a refund for the refund payment. -*RefundsApi* | [**get_refunds_as_csv**](docs/RefundsApi.md#get_refunds_as_csv) | **GET** /refunds/csv | Retrieves refunds in CSV format. -*RefundsApi* | [**update_refund**](docs/RefundsApi.md#update_refund) | **PUT** /refunds | Update a refund -*RolesApi* | [**create_role**](docs/RolesApi.md#create_role) | **POST** /roles | Create a new role. -*RolesApi* | [**get_all_roles**](docs/RolesApi.md#get_all_roles) | **GET** /roles | Retrieves a collection of all roles. By default 10 values are returned. Records are returned in natural order. -*RolesApi* | [**get_role_by_id**](docs/RolesApi.md#get_role_by_id) | **GET** /roles/{role} | Retrieves a single role, specified by the ID parameter. -*RolesApi* | [**remove_permission_from_role**](docs/RolesApi.md#remove_permission_from_role) | **DELETE** /roles/{role}/permission/{resource}/{action} | Revokes a particular permission -*RolesApi* | [**revoke_role**](docs/RolesApi.md#revoke_role) | **DELETE** /roles/{role} | Revokes a role -*RolesApi* | [**update_role**](docs/RolesApi.md#update_role) | **PUT** /roles | Update a role. -*SearchApi* | [**perform_search**](docs/SearchApi.md#perform_search) | **GET** /search/{query-string} | Returns the results of the global search specified by the query-string. -*SubscriptionsApi* | [**add_charge_to_subscription**](docs/SubscriptionsApi.md#add_charge_to_subscription) | **POST** /subscriptions/{subscription-ID}/charge | Creates a charge on the specified subscription. -*SubscriptionsApi* | [**add_coupon_to_subscription**](docs/SubscriptionsApi.md#add_coupon_to_subscription) | **POST** /subscriptions/{subscription-ID}/coupons | Applies a coupon to a subscription. -*SubscriptionsApi* | [**add_credit_note_to_subscription**](docs/SubscriptionsApi.md#add_credit_note_to_subscription) | **POST** /subscriptions/{subscription-ID}/credit | Creates a credit-note which may be used by only the specified subscription. -*SubscriptionsApi* | [**add_payment_method_to_subscription**](docs/SubscriptionsApi.md#add_payment_method_to_subscription) | **POST** /subscriptions/{subscription-ID}/payment-methods | Enables the payment method to pay invoices of this subscription. -*SubscriptionsApi* | [**advance_subscription**](docs/SubscriptionsApi.md#advance_subscription) | **POST** /subscriptions/{subscription-ID}/advance | Advance the subscription through time. -*SubscriptionsApi* | [**available_payment_methods_for_subscription**](docs/SubscriptionsApi.md#available_payment_methods_for_subscription) | **GET** /subscriptions/{subscription-ID}/payment-methods | Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**batch_create_subscriptions**](docs/SubscriptionsApi.md#batch_create_subscriptions) | **POST** /subscriptions/batch | Create multiple subscriptions. -*SubscriptionsApi* | [**cancel_subscription**](docs/SubscriptionsApi.md#cancel_subscription) | **POST** /subscriptions/{subscription-ID}/cancel | Retires the subscription specified by the subscription-ID parameter. Retiring a subscription causes it to cancel based on the specified retirement settings for the product. -*SubscriptionsApi* | [**create_aggregating_subscription**](docs/SubscriptionsApi.md#create_aggregating_subscription) | **POST** /subscriptions/aggregating | Create an aggregating subscription. -*SubscriptionsApi* | [**create_subscription**](docs/SubscriptionsApi.md#create_subscription) | **POST** /subscriptions | Create a new subscription. -*SubscriptionsApi* | [**create_subscription_v2**](docs/SubscriptionsApi.md#create_subscription_v2) | **POST** /subscriptions/create | Create a subscription (V2). -*SubscriptionsApi* | [**create_timer**](docs/SubscriptionsApi.md#create_timer) | **POST** /subscriptions/{subscription-ID}/timer | Create a timer for a subscription event. -*SubscriptionsApi* | [**delete_metadata_for_subscription**](docs/SubscriptionsApi.md#delete_metadata_for_subscription) | **DELETE** /subscriptions/{subscription-ID}/metadata | Remove any associated metadata. -*SubscriptionsApi* | [**freeze_subscription**](docs/SubscriptionsApi.md#freeze_subscription) | **POST** /subscriptions/{subscription-ID}/freeze | Freeze the subscription. -*SubscriptionsApi* | [**get_all_subscriptions**](docs/SubscriptionsApi.md#get_all_subscriptions) | **GET** /subscriptions | Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**get_applicable_coupons_for_subscription**](docs/SubscriptionsApi.md#get_applicable_coupons_for_subscription) | **GET** /subscriptions/{subscription-ID}/applicable-coupons | Retrieves a collection of the coupons which can be applied to this subscription. -*SubscriptionsApi* | [**get_available_credit_subscription**](docs/SubscriptionsApi.md#get_available_credit_subscription) | **GET** /subscriptions/{subscription-ID}/credit | Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**get_charges_on_subscription**](docs/SubscriptionsApi.md#get_charges_on_subscription) | **GET** /subscriptions/{subscription-ID}/charges | Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**get_children_of_subscription**](docs/SubscriptionsApi.md#get_children_of_subscription) | **GET** /subscriptions/{subscription-ID}/children | Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**get_coupons_on_subscription**](docs/SubscriptionsApi.md#get_coupons_on_subscription) | **GET** /subscriptions/{subscription-ID}/coupons | Retrieves a collection of the coupons and the unique codes currently applied to the subscription. -*SubscriptionsApi* | [**get_invoices_for_subscription_by_state**](docs/SubscriptionsApi.md#get_invoices_for_subscription_by_state) | **GET** /subscriptions/{subscriptionID}/invoices/{state} | Retrieves a collection of invoice objects of the specified state for the given subscription. By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**get_metadata_for_subscription**](docs/SubscriptionsApi.md#get_metadata_for_subscription) | **GET** /subscriptions/{subscription-ID}/metadata | Retrieve any associated metadata. -*SubscriptionsApi* | [**get_parent_subscription**](docs/SubscriptionsApi.md#get_parent_subscription) | **GET** /subscriptions/{subscription-ID}/parent | Return the parent of the given subscription. -*SubscriptionsApi* | [**get_pricing_component_values_of_subscription**](docs/SubscriptionsApi.md#get_pricing_component_values_of_subscription) | **GET** /subscriptions/{subscription-ID}/values | Gets the subscription's current pricing-component values. -*SubscriptionsApi* | [**get_subscription_by_account_id**](docs/SubscriptionsApi.md#get_subscription_by_account_id) | **GET** /subscriptions/account/{account-ID} | Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**get_subscription_by_id**](docs/SubscriptionsApi.md#get_subscription_by_id) | **GET** /subscriptions/{subscription-ID} | Retrieves a single subscription, specified by the ID parameter. -*SubscriptionsApi* | [**get_subscription_by_product_id**](docs/SubscriptionsApi.md#get_subscription_by_product_id) | **GET** /subscriptions/product/{product-ID} | Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**get_subscription_by_product_rate_plan_id**](docs/SubscriptionsApi.md#get_subscription_by_product_rate_plan_id) | **GET** /subscriptions/product-rate-plan/{product-rate-plan-ID} | Retrieves a collection of subscriptions, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**get_subscription_by_state**](docs/SubscriptionsApi.md#get_subscription_by_state) | **GET** /subscriptions/state/{state} | Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**get_subscription_by_version_id**](docs/SubscriptionsApi.md#get_subscription_by_version_id) | **GET** /subscriptions/version/{version-ID} | Retrieves a single subscription, specified by the version-ID parameter. -*SubscriptionsApi* | [**get_subscriptions_by_initial_period_start**](docs/SubscriptionsApi.md#get_subscriptions_by_initial_period_start) | **GET** /subscriptions/initial-period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**get_subscriptions_by_period_end**](docs/SubscriptionsApi.md#get_subscriptions_by_period_end) | **GET** /subscriptions/period-end/{lower-threshold}/{upper-threshold} | Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**get_subscriptions_by_period_start**](docs/SubscriptionsApi.md#get_subscriptions_by_period_start) | **GET** /subscriptions/period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of subscription objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**get_subscriptions_by_successful_periods**](docs/SubscriptionsApi.md#get_subscriptions_by_successful_periods) | **GET** /subscriptions/successful-periods/{lower-threshold}/{upper-threshold} | Retrieves a collection of subscription objects whose successful periods count falls within the range specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. +*InvoicesApi* | [**import_invoice**](docs/InvoicesApi.md#import_invoice) | **POST** /invoices/import | +*InvoicesApi* | [**issue_invoice**](docs/InvoicesApi.md#issue_invoice) | **PUT** /invoices/{invoice-id}/issue | +*InvoicesApi* | [**list_original_invoice**](docs/InvoicesApi.md#list_original_invoice) | **GET** /invoices/{invoice-id}/original | +*InvoicesApi* | [**list_split_invoice**](docs/InvoicesApi.md#list_split_invoice) | **GET** /invoices/{invoice-id}/split | +*InvoicesApi* | [**recalculate_invoice**](docs/InvoicesApi.md#recalculate_invoice) | **POST** /invoices/{invoice-ID}/recalculate | +*InvoicesApi* | [**refund_invoice**](docs/InvoicesApi.md#refund_invoice) | **POST** /invoices/{invoice-id}/refund | +*InvoicesApi* | [**remove_charge_from_invoice**](docs/InvoicesApi.md#remove_charge_from_invoice) | **DELETE** /invoices/{invoice-ID}/charges/{charge-ID} | +*InvoicesApi* | [**remove_metadata_from_invoice**](docs/InvoicesApi.md#remove_metadata_from_invoice) | **DELETE** /invoices/{invoice-ID}/metadata | +*InvoicesApi* | [**set_metadata_for_invoice**](docs/InvoicesApi.md#set_metadata_for_invoice) | **POST** /invoices/{invoice-ID}/metadata | +*InvoicesApi* | [**split_invoice**](docs/InvoicesApi.md#split_invoice) | **POST** /invoices/{invoice-id}/split | +*InvoicesApi* | [**update_invoice**](docs/InvoicesApi.md#update_invoice) | **PUT** /invoices | +*InvoicesApi* | [**update_invoice_template**](docs/InvoicesApi.md#update_invoice_template) | **PUT** /invoices/template | +*InvoicesApi* | [**upsert_metadata_for_invoice**](docs/InvoicesApi.md#upsert_metadata_for_invoice) | **PUT** /invoices/{invoice-ID}/metadata | +*InvoicesApi* | [**void_invoice**](docs/InvoicesApi.md#void_invoice) | **DELETE** /invoices/{invoice-ID} | +*NotificationsApi* | [**get_all_notifications**](docs/NotificationsApi.md#get_all_notifications) | **GET** /notifications | +*NotificationsApi* | [**get_notification_by_entity_id**](docs/NotificationsApi.md#get_notification_by_entity_id) | **GET** /notifications/entity-ID/{entity-ID} | +*NotificationsApi* | [**get_notification_by_id**](docs/NotificationsApi.md#get_notification_by_id) | **GET** /notifications/{notification-ID} | +*NotificationsApi* | [**get_notifications_by_webhook_id**](docs/NotificationsApi.md#get_notifications_by_webhook_id) | **GET** /notifications/{lower-threshold}/{upper-threshold}/{webhookID} | +*NotificationsApi* | [**get_notifications_within_date_range**](docs/NotificationsApi.md#get_notifications_within_date_range) | **GET** /notifications/{lower-threshold}/{upper-threshold} | +*NotificationsApi* | [**resend_notification**](docs/NotificationsApi.md#resend_notification) | **POST** /notifications/{notification-ID}/resend | +*PaymentGatewayApi* | [**create_api_configuration**](docs/PaymentGatewayApi.md#create_api_configuration) | **POST** /configurations | +*PaymentGatewayApi* | [**get_all_api_configurations**](docs/PaymentGatewayApi.md#get_all_api_configurations) | **GET** /configurations | +*PaymentGatewayApi* | [**get_api_configurations_by_type**](docs/PaymentGatewayApi.md#get_api_configurations_by_type) | **GET** /configurations/type/{configuration-type} | +*PaymentGatewayApi* | [**public_configuration**](docs/PaymentGatewayApi.md#public_configuration) | **GET** /configurations/public | +*PaymentGatewayApi* | [**update_api_configuration**](docs/PaymentGatewayApi.md#update_api_configuration) | **PUT** /configurations | +*PaymentMethodsApi* | [**create_payment_method**](docs/PaymentMethodsApi.md#create_payment_method) | **POST** /payment-methods | +*PaymentMethodsApi* | [**delete_payment_method**](docs/PaymentMethodsApi.md#delete_payment_method) | **DELETE** /payment-methods/{payment-method-ID} | +*PaymentMethodsApi* | [**get_all_payment_methods**](docs/PaymentMethodsApi.md#get_all_payment_methods) | **GET** /payment-methods | +*PaymentMethodsApi* | [**get_mandate_pdf**](docs/PaymentMethodsApi.md#get_mandate_pdf) | **GET** /payment-methods/{payment-method-ID}/mandate.pdf | +*PaymentMethodsApi* | [**get_payment_method_by_id**](docs/PaymentMethodsApi.md#get_payment_method_by_id) | **GET** /payment-methods/{payment-method-ID} | +*PaymentMethodsApi* | [**get_payment_method_by_link_id**](docs/PaymentMethodsApi.md#get_payment_method_by_link_id) | **GET** /payment-methods/link-id/{linkID} | +*PaymentMethodsApi* | [**get_payment_method_by_payment_gateway**](docs/PaymentMethodsApi.md#get_payment_method_by_payment_gateway) | **GET** /payment-methods/gateway/{gateway} | +*PaymentMethodsApi* | [**update_payment_method**](docs/PaymentMethodsApi.md#update_payment_method) | **PUT** /payment-methods | +*PaymentMethodsApi* | [**verify_ach**](docs/PaymentMethodsApi.md#verify_ach) | **POST** /payment-methods/{payment-method-ID}/verify/micro-deposits | +*PaymentsApi* | [**create_offline_payment**](docs/PaymentsApi.md#create_offline_payment) | **POST** /payments/offline | +*PaymentsApi* | [**create_payment**](docs/PaymentsApi.md#create_payment) | **POST** /payments | +*PaymentsApi* | [**get_all_payments**](docs/PaymentsApi.md#get_all_payments) | **GET** /payments | +*PaymentsApi* | [**get_payment_as_csv**](docs/PaymentsApi.md#get_payment_as_csv) | **GET** /payments/csv | +*PaymentsApi* | [**get_payment_by_id**](docs/PaymentsApi.md#get_payment_by_id) | **GET** /payments/{payment-ID} | +*PaymentsApi* | [**get_payment_by_invoice_id**](docs/PaymentsApi.md#get_payment_by_invoice_id) | **GET** /payments/invoice/{invoice-ID} | +*PaymentsApi* | [**get_payment_by_payment_gateway**](docs/PaymentsApi.md#get_payment_by_payment_gateway) | **GET** /payments/gateway/{gateway} | +*PaymentsApi* | [**get_payment_by_payment_method_id**](docs/PaymentsApi.md#get_payment_by_payment_method_id) | **GET** /payments/payment-method/{payment-method-ID} | +*PaymentsApi* | [**refund_payment**](docs/PaymentsApi.md#refund_payment) | **POST** /payments/{payment_id}/refund | +*PaymentsApi* | [**update_payment**](docs/PaymentsApi.md#update_payment) | **PUT** /payments | +*PermissionsApi* | [**create_permission**](docs/PermissionsApi.md#create_permission) | **POST** /permissions | +*PermissionsApi* | [**get_all_permissions**](docs/PermissionsApi.md#get_all_permissions) | **GET** /permissions | +*PermissionsApi* | [**get_available_actions_for_resource**](docs/PermissionsApi.md#get_available_actions_for_resource) | **GET** /permissions/resources/{resource} | +*PermissionsApi* | [**get_available_resources**](docs/PermissionsApi.md#get_available_resources) | **GET** /permissions/resources | +*PermissionsApi* | [**get_permission_by_id**](docs/PermissionsApi.md#get_permission_by_id) | **GET** /permissions/{permission-ID} | +*PermissionsApi* | [**revoke_permission**](docs/PermissionsApi.md#revoke_permission) | **DELETE** /permissions/{permission-ID} | +*PlansApi* | [**delete**](docs/PlansApi.md#delete) | **DELETE** /plans/{path} | +*PlansApi* | [**find**](docs/PlansApi.md#find) | **GET** /plans/{path} | +*PlansApi* | [**upsert**](docs/PlansApi.md#upsert) | **PUT** /plans | +*QuotesApi* | [**get_all_quotes**](docs/QuotesApi.md#get_all_quotes) | **GET** /quotes | +*QuotesApi* | [**get_quote_by_id**](docs/QuotesApi.md#get_quote_by_id) | **GET** /quotes/{id} | +*QuotesApi* | [**quote**](docs/QuotesApi.md#quote) | **POST** /quotes | +*ReceiptsApi* | [**create_receipt**](docs/ReceiptsApi.md#create_receipt) | **POST** /receipts | +*ReceiptsApi* | [**get_all_receipts**](docs/ReceiptsApi.md#get_all_receipts) | **GET** /receipts | +*ReceiptsApi* | [**get_receipt_by_id**](docs/ReceiptsApi.md#get_receipt_by_id) | **GET** /receipts/{receipt-ID} | +*ReceiptsApi* | [**get_receipts_by_invoice**](docs/ReceiptsApi.md#get_receipts_by_invoice) | **GET** /receipts/invoice/{invoice-ID} | +*ReceiptsApi* | [**get_receipts_by_payment**](docs/ReceiptsApi.md#get_receipts_by_payment) | **GET** /receipts/payment/{payment-ID} | +*ReceiptsApi* | [**get_receipts_for_debit_payments_as_csv**](docs/ReceiptsApi.md#get_receipts_for_debit_payments_as_csv) | **GET** /receipts/debits.csv | +*ReceiptsApi* | [**get_receipts_for_refund_payments_as_csv**](docs/ReceiptsApi.md#get_receipts_for_refund_payments_as_csv) | **GET** /receipts/refunds.csv | +*ReportsApi* | [**get_accounts_overview**](docs/ReportsApi.md#get_accounts_overview) | **GET** /reports/accounts/overview.csv | +*ReportsApi* | [**get_affiliate_charge_report**](docs/ReportsApi.md#get_affiliate_charge_report) | **GET** /reports/affiliate/overview.csv | +*ReportsApi* | [**get_coupon_report**](docs/ReportsApi.md#get_coupon_report) | **GET** /reports/coupons/overview.csv | +*ReportsApi* | [**get_csv_report_invoice_line_payments_bucketed**](docs/ReportsApi.md#get_csv_report_invoice_line_payments_bucketed) | **GET** /reports/fulfilled/bucketed.csv | +*ReportsApi* | [**get_csv_report_invoice_line_payments_raw**](docs/ReportsApi.md#get_csv_report_invoice_line_payments_raw) | **GET** /reports/fulfilled/raw.csv | +*ReportsApi* | [**get_csv_report_revenue_attributions_bucketed**](docs/ReportsApi.md#get_csv_report_revenue_attributions_bucketed) | **GET** /reports/invoiced/bucketed.csv | +*ReportsApi* | [**get_csv_report_revenue_attributions_raw**](docs/ReportsApi.md#get_csv_report_revenue_attributions_raw) | **GET** /reports/invoiced/raw.csv | +*ReportsApi* | [**get_csv_revenue_schedule**](docs/ReportsApi.md#get_csv_revenue_schedule) | **GET** /reports/revenue-schedule/raw.csv | +*ReportsApi* | [**get_payment_transactions**](docs/ReportsApi.md#get_payment_transactions) | **GET** /reports/transactions/payments.csv | +*ReportsApi* | [**get_refunds_as_csv**](docs/ReportsApi.md#get_refunds_as_csv) | **GET** /refunds/csv | +*ReportsApi* | [**get_shipments_report**](docs/ReportsApi.md#get_shipments_report) | **GET** /reports/shipments/overview.csv | +*ReportsApi* | [**get_subscriptions_overview**](docs/ReportsApi.md#get_subscriptions_overview) | **GET** /reports/subscriptions/overview.csv | +*SalesforceApi* | [**change_salesforce_job_state**](docs/SalesforceApi.md#change_salesforce_job_state) | **POST** /salesforce/sync/action | +*SalesforceApi* | [**connect_to_salesforce**](docs/SalesforceApi.md#connect_to_salesforce) | **POST** /salesforce/connect | +*SalesforceApi* | [**get_all_salesforce_jobs**](docs/SalesforceApi.md#get_all_salesforce_jobs) | **GET** /salesforce/sync | +*SalesforceApi* | [**get_salesforce_configuration**](docs/SalesforceApi.md#get_salesforce_configuration) | **GET** /salesforce/configuration | +*SalesforceApi* | [**update_salesforce_configuration**](docs/SalesforceApi.md#update_salesforce_configuration) | **PUT** /salesforce/configuration | +*SecurityApi* | [**create_flexcheck_user_login**](docs/SecurityApi.md#create_flexcheck_user_login) | **POST** /users/flexcheck | +*SecurityApi* | [**create_role**](docs/SecurityApi.md#create_role) | **POST** /roles | +*SecurityApi* | [**create_user_login**](docs/SecurityApi.md#create_user_login) | **POST** /users | +*SecurityApi* | [**get_all_roles**](docs/SecurityApi.md#get_all_roles) | **GET** /roles | +*SecurityApi* | [**get_current_user**](docs/SecurityApi.md#get_current_user) | **GET** /users/mine | +*SecurityApi* | [**get_my_organizations**](docs/SecurityApi.md#get_my_organizations) | **GET** /users/mine/organizations | +*SecurityApi* | [**get_private_permanent_api_token**](docs/SecurityApi.md#get_private_permanent_api_token) | **POST** /users/generate-permanent-api-token | +*SecurityApi* | [**get_role_by_id**](docs/SecurityApi.md#get_role_by_id) | **GET** /roles/{role} | +*SecurityApi* | [**get_simple_all_users**](docs/SecurityApi.md#get_simple_all_users) | **GET** /users | +*SecurityApi* | [**get_temporary_api_tokens**](docs/SecurityApi.md#get_temporary_api_tokens) | **GET** /users/generate-tokens | +*SecurityApi* | [**get_user_by_username**](docs/SecurityApi.md#get_user_by_username) | **GET** /users/username/{email} | +*SecurityApi* | [**invite_user_login**](docs/SecurityApi.md#invite_user_login) | **POST** /users/invite | +*SecurityApi* | [**link_open_id_token_to_user**](docs/SecurityApi.md#link_open_id_token_to_user) | **POST** /users/invite/openid | +*SecurityApi* | [**refresh_permanent_api_token**](docs/SecurityApi.md#refresh_permanent_api_token) | **POST** /users/refresh-permanent-api-token | +*SecurityApi* | [**remove_permission_from_role**](docs/SecurityApi.md#remove_permission_from_role) | **DELETE** /roles/{role}/permission/{resource}/{action} | +*SecurityApi* | [**request_password_reset_code**](docs/SecurityApi.md#request_password_reset_code) | **POST** /users/password-reset/request-reset-code | +*SecurityApi* | [**revoke_role**](docs/SecurityApi.md#revoke_role) | **DELETE** /roles/{role} | +*SecurityApi* | [**update_email**](docs/SecurityApi.md#update_email) | **PUT** /users/{email}/email | +*SecurityApi* | [**update_role**](docs/SecurityApi.md#update_role) | **PUT** /roles | +*SecurityApi* | [**update_user_infos**](docs/SecurityApi.md#update_user_infos) | **PUT** /users/{email} | +*SecurityApi* | [**update_user_password**](docs/SecurityApi.md#update_user_password) | **PUT** /users/{email}/password | +*SecurityApi* | [**update_user_password_with_reset_code**](docs/SecurityApi.md#update_user_password_with_reset_code) | **POST** /users/password-reset/password-update | +*SubscriptionsApi* | [**add_charge_to_subscription**](docs/SubscriptionsApi.md#add_charge_to_subscription) | **POST** /subscriptions/{subscription-ID}/charge | +*SubscriptionsApi* | [**add_coupon_to_subscription**](docs/SubscriptionsApi.md#add_coupon_to_subscription) | **POST** /subscriptions/{subscription-ID}/coupons | +*SubscriptionsApi* | [**add_credit_note_to_subscription**](docs/SubscriptionsApi.md#add_credit_note_to_subscription) | **POST** /subscriptions/{subscription-ID}/credit | +*SubscriptionsApi* | [**add_payment_method_to_subscription**](docs/SubscriptionsApi.md#add_payment_method_to_subscription) | **POST** /subscriptions/{subscription-ID}/payment-methods | +*SubscriptionsApi* | [**advance_subscription**](docs/SubscriptionsApi.md#advance_subscription) | **POST** /subscriptions/{subscription-ID}/advance | +*SubscriptionsApi* | [**available_payment_methods_for_subscription**](docs/SubscriptionsApi.md#available_payment_methods_for_subscription) | **GET** /subscriptions/{subscription-ID}/payment-methods | +*SubscriptionsApi* | [**batch_create_subscriptions**](docs/SubscriptionsApi.md#batch_create_subscriptions) | **POST** /subscriptions/batch | +*SubscriptionsApi* | [**batch_increment_usage**](docs/SubscriptionsApi.md#batch_increment_usage) | **POST** /subscriptions/{subscriptionID}/increment-values | +*SubscriptionsApi* | [**cancel_subscription**](docs/SubscriptionsApi.md#cancel_subscription) | **POST** /subscriptions/{subscription-ID}/cancel | +*SubscriptionsApi* | [**create_aggregating_subscription**](docs/SubscriptionsApi.md#create_aggregating_subscription) | **POST** /subscriptions/aggregating | +*SubscriptionsApi* | [**create_subscription_from_request**](docs/SubscriptionsApi.md#create_subscription_from_request) | **POST** /subscriptions/create | +*SubscriptionsApi* | [**create_timer**](docs/SubscriptionsApi.md#create_timer) | **POST** /subscriptions/{subscription-ID}/timer | +*SubscriptionsApi* | [**delete_metadata_for_subscription**](docs/SubscriptionsApi.md#delete_metadata_for_subscription) | **DELETE** /subscriptions/{subscription-ID}/metadata | +*SubscriptionsApi* | [**freeze_subscription**](docs/SubscriptionsApi.md#freeze_subscription) | **POST** /subscriptions/{subscription-ID}/freeze | +*SubscriptionsApi* | [**get_affiliate1**](docs/SubscriptionsApi.md#get_affiliate1) | **GET** /subscriptions/{subscriptionID}/affiliate | +*SubscriptionsApi* | [**get_applicable_coupons_for_subscription**](docs/SubscriptionsApi.md#get_applicable_coupons_for_subscription) | **GET** /subscriptions/{subscription-ID}/applicable-coupons | +*SubscriptionsApi* | [**get_available_credit_subscription**](docs/SubscriptionsApi.md#get_available_credit_subscription) | **GET** /subscriptions/{subscription-ID}/credit | +*SubscriptionsApi* | [**get_charges_on_subscription**](docs/SubscriptionsApi.md#get_charges_on_subscription) | **GET** /subscriptions/{subscription-ID}/charges | +*SubscriptionsApi* | [**get_children_of_subscription**](docs/SubscriptionsApi.md#get_children_of_subscription) | **GET** /subscriptions/{subscription-ID}/children | +*SubscriptionsApi* | [**get_coupons_on_subscription**](docs/SubscriptionsApi.md#get_coupons_on_subscription) | **GET** /subscriptions/{subscription-ID}/coupons | +*SubscriptionsApi* | [**get_invoices_for_subscription_by_state**](docs/SubscriptionsApi.md#get_invoices_for_subscription_by_state) | **GET** /subscriptions/{subscriptionID}/invoices/{state} | +*SubscriptionsApi* | [**get_metadata_for_subscription**](docs/SubscriptionsApi.md#get_metadata_for_subscription) | **GET** /subscriptions/{subscription-ID}/metadata | +*SubscriptionsApi* | [**get_parent_subscription**](docs/SubscriptionsApi.md#get_parent_subscription) | **GET** /subscriptions/{subscription-ID}/parent | +*SubscriptionsApi* | [**get_pricing_component_values_of_subscription**](docs/SubscriptionsApi.md#get_pricing_component_values_of_subscription) | **GET** /subscriptions/{subscription-ID}/values | +*SubscriptionsApi* | [**get_subscription_by_account_id**](docs/SubscriptionsApi.md#get_subscription_by_account_id) | **GET** /subscriptions/account/{account-ID} | +*SubscriptionsApi* | [**get_subscription_by_id**](docs/SubscriptionsApi.md#get_subscription_by_id) | **GET** /subscriptions/{subscription-ID} | +*SubscriptionsApi* | [**get_subscription_by_product_id**](docs/SubscriptionsApi.md#get_subscription_by_product_id) | **GET** /subscriptions/product/{product-ID} | +*SubscriptionsApi* | [**get_subscription_by_product_rate_plan_id**](docs/SubscriptionsApi.md#get_subscription_by_product_rate_plan_id) | **GET** /subscriptions/product-rate-plan/{product-rate-plan-ID} | +*SubscriptionsApi* | [**get_subscription_by_state**](docs/SubscriptionsApi.md#get_subscription_by_state) | **GET** /subscriptions/state/{state} | +*SubscriptionsApi* | [**get_subscription_by_version_id**](docs/SubscriptionsApi.md#get_subscription_by_version_id) | **GET** /subscriptions/version/{version-ID} | +*SubscriptionsApi* | [**get_subscriptions_by_initial_period_start**](docs/SubscriptionsApi.md#get_subscriptions_by_initial_period_start) | **GET** /subscriptions/initial-period-start/{lower-threshold}/{upper-threshold} | +*SubscriptionsApi* | [**get_subscriptions_by_period_end**](docs/SubscriptionsApi.md#get_subscriptions_by_period_end) | **GET** /subscriptions/period-end/{lower-threshold}/{upper-threshold} | +*SubscriptionsApi* | [**get_subscriptions_by_period_start**](docs/SubscriptionsApi.md#get_subscriptions_by_period_start) | **GET** /subscriptions/period-start/{lower-threshold}/{upper-threshold} | +*SubscriptionsApi* | [**get_subscriptions_by_successful_periods**](docs/SubscriptionsApi.md#get_subscriptions_by_successful_periods) | **GET** /subscriptions/successful-periods/{lower-threshold}/{upper-threshold} | *SubscriptionsApi* | [**get_swagger_subscription**](docs/SubscriptionsApi.md#get_swagger_subscription) | **GET** /subscriptions/swagger-end-point/{query-string} | -*SubscriptionsApi* | [**get_timers_for_subscription**](docs/SubscriptionsApi.md#get_timers_for_subscription) | **GET** /subscriptions/{subscription-ID}/timer | Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order. -*SubscriptionsApi* | [**import_subscription**](docs/SubscriptionsApi.md#import_subscription) | **POST** /subscriptions/import | Import a subscription. -*SubscriptionsApi* | [**invoice_charges_on_subscription**](docs/SubscriptionsApi.md#invoice_charges_on_subscription) | **POST** /subscriptions/{subscription-ID}/invoice-charges | Invoice any outstanding charges for the subscription. -*SubscriptionsApi* | [**migrate_subscription**](docs/SubscriptionsApi.md#migrate_subscription) | **POST** /subscriptions/{subscription-ID}/migrate | Migrate the subscription to a new plan. -*SubscriptionsApi* | [**remove_coupon_from_subscription**](docs/SubscriptionsApi.md#remove_coupon_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/coupons/{coupon-code} | Removes the coupon from the subscription. -*SubscriptionsApi* | [**remove_credit_from_subscription**](docs/SubscriptionsApi.md#remove_credit_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/credit/{value} | Decrease the amount of credit available to the specified subscription. -*SubscriptionsApi* | [**remove_payment_method_from_subscription**](docs/SubscriptionsApi.md#remove_payment_method_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/payment-methods/{payment-method-ID} | Removes the specified payment method for the given subscription. -*SubscriptionsApi* | [**remove_pricing_component_value_change_from_subscription**](docs/SubscriptionsApi.md#remove_pricing_component_value_change_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/values/{pricing-component} | Discards from the subscription any scheduled changes in the value of the specified pricing-component. -*SubscriptionsApi* | [**resume_subscription**](docs/SubscriptionsApi.md#resume_subscription) | **POST** /subscriptions/{subscription-ID}/resume | Resume the frozen subscription. -*SubscriptionsApi* | [**revive_subscription**](docs/SubscriptionsApi.md#revive_subscription) | **POST** /subscriptions/{subscription-ID}/revive | Revives a cancelled subscription and returns it to its previous state -*SubscriptionsApi* | [**set_metadata_for_subscription**](docs/SubscriptionsApi.md#set_metadata_for_subscription) | **POST** /subscriptions/{subscription-ID}/metadata | Remove any existing metadata keys and create the provided data. -*SubscriptionsApi* | [**set_pricing_component_value_on_subscription**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription) | **POST** /subscriptions/{subscription-ID}/pricing-component-values | Sets upon this subscription a new value for the specified pricing-component without performing an upgrade. -*SubscriptionsApi* | [**set_pricing_component_value_on_subscription_v2**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription_v2) | **POST** /subscriptions/{subscription-ID}/values/{pricing-component} | Upgrades/downgrades this subscription to some new value for the specified pricing-component. -*SubscriptionsApi* | [**update_subscription**](docs/SubscriptionsApi.md#update_subscription) | **PUT** /subscriptions | Update a subscription. -*SubscriptionsApi* | [**update_subscription_v2**](docs/SubscriptionsApi.md#update_subscription_v2) | **PUT** /subscriptions/update | Update a subscription (V2). -*SubscriptionsApi* | [**upsert_metadata_for_subscription**](docs/SubscriptionsApi.md#upsert_metadata_for_subscription) | **PUT** /subscriptions/{subscription-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed. -*SynchAppConfigsApi* | [**create_sync_app_config**](docs/SynchAppConfigsApi.md#create_sync_app_config) | **POST** /synchAppConfigs | Create a synch app configuration. -*SynchAppConfigsApi* | [**get_sync_app_config**](docs/SynchAppConfigsApi.md#get_sync_app_config) | **GET** /synchAppConfigs/{synchAppConfigs-ID} | Returns a single config, specified by the ID parameter. -*SynchAppConfigsApi* | [**get_sync_app_config_by_platform**](docs/SynchAppConfigsApi.md#get_sync_app_config_by_platform) | **GET** /synchAppConfigs/platform/{platform} | Returns a collection configurations, specified by the platform parameter. -*SynchAppConfigsApi* | [**update_sync_app_config**](docs/SynchAppConfigsApi.md#update_sync_app_config) | **PUT** /synchAppConfigs | Update a synch app configuration. -*SynchConfigsApi* | [**create_sync_config**](docs/SynchConfigsApi.md#create_sync_config) | **POST** /synchConfigs | Create a synch configuration. -*SynchConfigsApi* | [**get_all_sync_configs**](docs/SynchConfigsApi.md#get_all_sync_configs) | **GET** /synchConfigs | Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. -*SynchConfigsApi* | [**get_sync_config**](docs/SynchConfigsApi.md#get_sync_config) | **GET** /synchConfigs/{synchConfigs-ID} | Returns a single config, specified by the ID parameter. -*SynchConfigsApi* | [**get_sync_config_by_platform**](docs/SynchConfigsApi.md#get_sync_config_by_platform) | **GET** /synchConfigs/platform/{platform} | Returns a collection configurations, specified by the platform parameter. -*SynchConfigsApi* | [**get_sync_config_by_username**](docs/SynchConfigsApi.md#get_sync_config_by_username) | **GET** /synchConfigs/username/{username} | Returns a collection configurations, specified by the username parameter. -*SynchConfigsApi* | [**update_sync_config**](docs/SynchConfigsApi.md#update_sync_config) | **PUT** /synchConfigs | Update a synch configuration. -*SynchJobsApi* | [**create_sync_job**](docs/SynchJobsApi.md#create_sync_job) | **POST** /synchJobs | Create a synch job. -*SynchJobsApi* | [**get_all_sync_jobs**](docs/SynchJobsApi.md#get_all_sync_jobs) | **GET** /synchJobs | Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. -*SynchJobsApi* | [**get_sync_job_by_id**](docs/SynchJobsApi.md#get_sync_job_by_id) | **GET** /synchJobs/{synchJob-ID} | Returns a single job, specified by the ID parameter. -*SynchJobsApi* | [**get_sync_job_by_scope**](docs/SynchJobsApi.md#get_sync_job_by_scope) | **GET** /synchJobs/scope/{scope} | Returns a collection jobs, specified by the scope parameter. -*SynchJobsApi* | [**get_sync_job_by_state**](docs/SynchJobsApi.md#get_sync_job_by_state) | **GET** /synchJobs/state/{state} | Returns a collection jobs, specified by the state parameter. -*SynchJobsApi* | [**get_sync_job_by_target**](docs/SynchJobsApi.md#get_sync_job_by_target) | **GET** /synchJobs/target/{target} | Returns a collection jobs, specified by the target parameter. -*SynchJobsApi* | [**get_sync_job_by_type**](docs/SynchJobsApi.md#get_sync_job_by_type) | **GET** /synchJobs/type/{type} | Returns a collection jobs, specified by the type parameter. -*SynchJobsApi* | [**update_sync_job**](docs/SynchJobsApi.md#update_sync_job) | **PUT** /synchJobs | Update a synch job. -*TaxationlinksApi* | [**create_taxation_link**](docs/TaxationlinksApi.md#create_taxation_link) | **POST** /taxation-links | Create -*TaxationlinksApi* | [**get_all_taxation_links**](docs/TaxationlinksApi.md#get_all_taxation_links) | **GET** /taxation-links | Returns a collection of all taxation-links. By default 10 values are returned. Records are returned in natural order. -*TaxationlinksApi* | [**get_taxation_link_by_id**](docs/TaxationlinksApi.md#get_taxation_link_by_id) | **GET** /taxation-links/{taxation-link-ID} | Returns a single taxation-link, specified by the taxation-link-ID parameter. -*TaxationlinksApi* | [**get_taxation_link_by_product_rate_plan**](docs/TaxationlinksApi.md#get_taxation_link_by_product_rate_plan) | **GET** /taxation-links/product-rate-plan/{product-rate-plan-ID} | Returns a collection of taxation-links, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. -*TaxationlinksApi* | [**get_taxation_link_by_taxation_strategy**](docs/TaxationlinksApi.md#get_taxation_link_by_taxation_strategy) | **GET** /taxation-links/taxation-strategy/{taxation-strategy-ID} | Returns a collection of taxation-links, specified by the taxation-strategy-ID parameter. By default 10 values are returned. Records are returned in natural order. -*TaxationlinksApi* | [**update_taxation_link**](docs/TaxationlinksApi.md#update_taxation_link) | **PUT** /taxation-links | Update -*TaxationstrategiesApi* | [**create_taxation_strategy**](docs/TaxationstrategiesApi.md#create_taxation_strategy) | **POST** /taxation-strategies | <p>Add a new tax or schedule changes in an existing tax.</p><p>Add a new tax by providing the location and tax percentage. To schedule a tax change specify the ID of the current Tax. A new version of the will be created <i>validFrom</i> the specified date, the existing tax <i>validTill</i> the start of this new tax.</p> -*TaxationstrategiesApi* | [**get_all_taxation_strategies**](docs/TaxationstrategiesApi.md#get_all_taxation_strategies) | **GET** /taxation-strategies | Returns a collection of all taxation-strategies. By default 10 values are returned. Records are returned in natural order. -*TaxationstrategiesApi* | [**get_taxation_strategy_by_consistent_id**](docs/TaxationstrategiesApi.md#get_taxation_strategy_by_consistent_id) | **GET** /taxation-strategies/{taxation-strategy-ID} | Returns the tax currently being applied for the taxation-strategy-ID. To return schedule or historic tax changes the include_retired query parameter should be set to true. -*TaxationstrategiesApi* | [**get_taxation_strategy_by_country**](docs/TaxationstrategiesApi.md#get_taxation_strategy_by_country) | **GET** /taxation-strategies/country/{country} | Returns a collection of taxation-strategies, specified by the country parameter. By default 10 values are returned. Records are returned in natural order. To return schedule or historic tax changes the include_retired query parameter should be set to true. -*TaxationstrategiesApi* | [**get_taxation_strategy_by_currency**](docs/TaxationstrategiesApi.md#get_taxation_strategy_by_currency) | **GET** /taxation-strategies/currency/{currency} | Returns a collection of taxation-strategies, specified by the currency parameter. By default 10 values are returned. Records are returned in natural order. -*TaxationstrategiesApi* | [**get_taxation_strategy_by_province**](docs/TaxationstrategiesApi.md#get_taxation_strategy_by_province) | **GET** /taxation-strategies/province/{province} | Returns a collection of taxation-strategies, specified by the province parameter. By default 10 values are returned. Records are returned in natural order. -*TaxationstrategiesApi* | [**get_taxation_strategy_by_version_id**](docs/TaxationstrategiesApi.md#get_taxation_strategy_by_version_id) | **GET** /taxation-strategies/version/{version-ID} | Returns a single taxation-strategy, specified by the taxation-strategy-ID parameter. -*TaxationstrategiesApi* | [**retire_taxation_strategy**](docs/TaxationstrategiesApi.md#retire_taxation_strategy) | **DELETE** /taxation-strategies/version/{version-ID} | Retires the taxation-strategy specified by taxation-strategy-ID parameter. Only the version of the tax which has an unbounded (null) validTill can be removed. Removing a tax change will make the previous tax come into effect. For example if you have a Tax in January and 5% and a new tax at 7% from February onwards, you can remove the February tax. Remove the February tax will re-instate the January tax. -*TaxationstrategiesApi* | [**update_taxation_strategy**](docs/TaxationstrategiesApi.md#update_taxation_strategy) | **PUT** /taxation-strategies | Update a tax. -*TimeApi* | [**get_time_swagger**](docs/TimeApi.md#get_time_swagger) | **GET** /time/swagger-end-point | -*TokenizationApi* | [**auth_capture**](docs/TokenizationApi.md#auth_capture) | **POST** /tokenization/auth-capture | [Note: this API can be invoked more simply by our client-side card capture library, <a href=\"https://github.com/billforward/billforward-js\">BillForward.js</a>; you should not need to interact with this API manually unless you have particularly bespoke requirements] -*TokenizationApi* | [**braintree_card_capture**](docs/TokenizationApi.md#braintree_card_capture) | **POST** /tokenization/braintree | [Warning: for use only in PCI-compliant environments; for more information, <a href=\"mailto:support@billforward.net\">contact us</a> regarding provisioning of your own on-premise BillForward instance] Captures raw credit card details into Braintree's vault. -*TokenizationApi* | [**pay_vision_shout_v1**](docs/TokenizationApi.md#pay_vision_shout_v1) | **POST** /tokenization/payvision-shout-v1 | [Note: this API is intended to be invoked by the PayVision servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. -*TokenizationApi* | [**pre_auth**](docs/TokenizationApi.md#pre_auth) | **POST** /tokenization/pre-auth | [Note: this API can be invoked more simply by our client-side card capture library, <a href=\"https://github.com/billforward/billforward-js\">BillForward.js</a>; you should not need to interact with this API manually unless you have particularly bespoke requirements] -*TokenizationApi* | [**sage_pay_notify_v300**](docs/TokenizationApi.md#sage_pay_notify_v300) | **POST** /tokenization/sagepay-notify-v3-00 | [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of receiving a callback from a SagePay card capture operation, using SagePay's FORM Protocol, v3.0] Handles SagePay Notification. -*TokenizationApi* | [**sage_pay_shout_v300**](docs/TokenizationApi.md#sage_pay_shout_v300) | **GET** /tokenization/sagepay-shout-v3-00 | [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe, using SagePay's FORM Protocol, v3.0] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. -*UnitofmeasureApi* | [**create_unit_of_measure**](docs/UnitofmeasureApi.md#create_unit_of_measure) | **POST** /units-of-measure | Create a unit-of-measure. -*UnitofmeasureApi* | [**get_all_units_of_measure**](docs/UnitofmeasureApi.md#get_all_units_of_measure) | **GET** /units-of-measure | Returns a collection of all unit-of-measure objects. By default 10 values are returned. Records are returned in natural order. -*UnitofmeasureApi* | [**get_unit_of_measure_by_id**](docs/UnitofmeasureApi.md#get_unit_of_measure_by_id) | **GET** /units-of-measure/{unit-of-measure-identifier} | Returns a single unit-of-measure corresponding to the unique id or name specified. -*UnitofmeasureApi* | [**update_unit_of_measure**](docs/UnitofmeasureApi.md#update_unit_of_measure) | **PUT** /units-of-measure | Update a unit-of-measure. -*UsageApi* | [**create_usage_instance**](docs/UsageApi.md#create_usage_instance) | **POST** /usage | Add usage -*UsageApi* | [**get_usage_by_id**](docs/UsageApi.md#get_usage_by_id) | **GET** /usage/{subscription-id}/{period-id} | Retrieve by subscription and period -*UsageApi* | [**get_usage_by_subscription_id**](docs/UsageApi.md#get_usage_by_subscription_id) | **GET** /usage/{subscription-id} | Retrieve by subscription -*UsageApi* | [**get_usage_by_subscription_id_uo_m_period_and_usage_type**](docs/UsageApi.md#get_usage_by_subscription_id_uo_m_period_and_usage_type) | **GET** /usage/{subscription-id}/{uom}/{period-id}/{usage-type} | Retrieve by subscription, period and type -*UsageApi* | [**update_usage_instance**](docs/UsageApi.md#update_usage_instance) | **PUT** /usage | Update usage -*UsageperiodsApi* | [**get_usage_period**](docs/UsageperiodsApi.md#get_usage_period) | **GET** /usage-periods/{subscription-id}/{period-id} | Retrieve by subscription and period -*UsageperiodsApi* | [**get_usage_period_for_all**](docs/UsageperiodsApi.md#get_usage_period_for_all) | **GET** /usage-periods/{subscription-id} | Retrieve by subscription -*UsageperiodsApi* | [**get_usage_period_for_invoice**](docs/UsageperiodsApi.md#get_usage_period_for_invoice) | **GET** /usage-periods/{subscription-id}/invoice/{invoice-id} | Retrieve by invoice) -*UsageroundingstrategiesApi* | [**create_usage_rounding_strategy**](docs/UsageroundingstrategiesApi.md#create_usage_rounding_strategy) | **POST** /usage-rounding-strategies | Create a new rounding strategy -*UsageroundingstrategiesApi* | [**get_usage_rounding_strategy_by_id**](docs/UsageroundingstrategiesApi.md#get_usage_rounding_strategy_by_id) | **GET** /usage-rounding-strategies/{usage-rounding-strategies-ID} | Returns a collection of usage-rounding-strategies, specified by the usage-rounding-strategies-id parameter. By default 10 values are returned. Records are returned in natural order. -*UsageroundingstrategiesApi* | [**get_usage_rounding_strategy_by_pricing_component_id**](docs/UsageroundingstrategiesApi.md#get_usage_rounding_strategy_by_pricing_component_id) | **GET** /usage-rounding-strategies/pricing-component/{pricing-component-ID} | Returns a collection of usage-rounding-strategies, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. -*UsageroundingstrategiesApi* | [**update_usage_rounding_strategy**](docs/UsageroundingstrategiesApi.md#update_usage_rounding_strategy) | **PUT** /usage-rounding-strategies | Update a rounding strategy -*UsagesessionsApi* | [**get_active_sessions_for_subscription**](docs/UsagesessionsApi.md#get_active_sessions_for_subscription) | **GET** /usage-sessions/{subscription-id}/active | Get active by subscription -*UsagesessionsApi* | [**get_usage_list_for_usage_session**](docs/UsagesessionsApi.md#get_usage_list_for_usage_session) | **GET** /usage-sessions/{subscription-id} | Retrieve by subscription -*UsagesessionsApi* | [**start_usage_session**](docs/UsagesessionsApi.md#start_usage_session) | **POST** /usage-sessions/start | Start a new session -*UsagesessionsApi* | [**stop_usage_session**](docs/UsagesessionsApi.md#stop_usage_session) | **POST** /usage-sessions/stop | Stop a specified session -*UsernamesApi* | [**create_username**](docs/UsernamesApi.md#create_username) | **POST** /usernames | Create a username. -*UsersApi* | [**create_user**](docs/UsersApi.md#create_user) | **POST** /users | Create a user. -*UsersApi* | [**create_user_login**](docs/UsersApi.md#create_user_login) | **POST** /users/create-user-login | Create a user. -*UsersApi* | [**get_all_users**](docs/UsersApi.md#get_all_users) | **GET** /users | Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. -*UsersApi* | [**get_user_by_id**](docs/UsersApi.md#get_user_by_id) | **GET** /users/{user-ID} | Returns a single User, specified by the ID parameter. -*UsersApi* | [**get_user_by_password_reset_code**](docs/UsersApi.md#get_user_by_password_reset_code) | **GET** /users/password-reset-code/{password-reset-code} | Returns a single User, specified by the password-reset-code parameter. -*UsersApi* | [**get_user_by_sms_password_reset_code**](docs/UsersApi.md#get_user_by_sms_password_reset_code) | **GET** /users/sms-password-reset-code/{sms-password-reset-code} | Returns a single User, specified by the sms-password-reset-code parameter. -*UsersApi* | [**get_user_by_username**](docs/UsersApi.md#get_user_by_username) | **GET** /users/username/{username} | Returns a single User, specified by the username parameter, this is by default the e-mail address of the user. -*UsersApi* | [**reset_user_password**](docs/UsersApi.md#reset_user_password) | **POST** /users/password-reset | Create a password reset request. -*UsersApi* | [**retire_user**](docs/UsersApi.md#retire_user) | **DELETE** /users/{user-ID} | Retires the user with the specified user-ID. -*UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PUT** /users | Update a user. -*UsersApi* | [**update_user_password**](docs/UsersApi.md#update_user_password) | **POST** /users/password-update | Update a user's password. -*VaultedgatewaysApi* | [**create_authorize_net_token**](docs/VaultedgatewaysApi.md#create_authorize_net_token) | **POST** /vaulted-gateways/authorize-net | Create an authorize-net-token. -*VaultedgatewaysApi* | [**create_braintree_token**](docs/VaultedgatewaysApi.md#create_braintree_token) | **POST** /vaulted-gateways/braintree | Create a braintree-token. -*VaultedgatewaysApi* | [**create_stripe_ach_token**](docs/VaultedgatewaysApi.md#create_stripe_ach_token) | **POST** /vaulted-gateways/stripe-ACH | Create a stripe-ACH-token. -*VaultedgatewaysApi* | [**create_stripe_token**](docs/VaultedgatewaysApi.md#create_stripe_token) | **POST** /vaulted-gateways/stripe | Create a stripe-token. -*VaultedgatewaysApi* | [**create_trust_commerce_token**](docs/VaultedgatewaysApi.md#create_trust_commerce_token) | **POST** /vaulted-gateways/trustCommerce | Create a trust-commerce-token. -*VaultedgatewaysApi* | [**get_braintree_by_account_id**](docs/VaultedgatewaysApi.md#get_braintree_by_account_id) | **GET** /vaulted-gateways/braintree/{accountID} | Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter. -*VaultedgatewaysApi* | [**get_by_card_details_id**](docs/VaultedgatewaysApi.md#get_by_card_details_id) | **GET** /vaulted-gateways/stripe/card-details-id/{cardDetailsID} | Returns a single stripe-token, specified by the cardDetailsID parameter. -*VaultedgatewaysApi* | [**get_stripe_ach**](docs/VaultedgatewaysApi.md#get_stripe_ach) | **GET** /vaulted-gateways/stripe-ACH/{stripeACHTokenID} | Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter. -*VaultedgatewaysApi* | [**get_stripe_token**](docs/VaultedgatewaysApi.md#get_stripe_token) | **GET** /vaulted-gateways/stripe/{stripeTokenID} | Returns a single stripe-token, specified by the stripeTokenID parameter. -*VaultedgatewaysApi* | [**update_stripe_ach_token**](docs/VaultedgatewaysApi.md#update_stripe_ach_token) | **PUT** /vaulted-gateways/stripe-ACH | Update a stripe-ACH-token. -*VaultedgatewaysApi* | [**update_stripe_token**](docs/VaultedgatewaysApi.md#update_stripe_token) | **PUT** /vaulted-gateways/stripe | Update a stripe-token. -*VaultedgatewaysApi* | [**verify_bank_account**](docs/VaultedgatewaysApi.md#verify_bank_account) | **POST** /vaulted-gateways/stripe/verify-bank-account | Verify Stripe bank account. -*VaultedgatewaysApi* | [**webhook**](docs/VaultedgatewaysApi.md#webhook) | **POST** /vaulted-gateways/stripe/webhook | Receive and handle webhook from Stripe. -*WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | Create a webhook. -*WebhooksApi* | [**create_webhook_v2**](docs/WebhooksApi.md#create_webhook_v2) | **POST** /webhooks/create | Create a webhook. -*WebhooksApi* | [**get_all_webhooks**](docs/WebhooksApi.md#get_all_webhooks) | **GET** /webhooks | Returns a collection of Webhooks, specified by the accountID parameter. By default 10 values are returned. Records are returned in natural order. -*WebhooksApi* | [**get_webhook_by_id**](docs/WebhooksApi.md#get_webhook_by_id) | **GET** /webhooks/{webhook-ID} | Returns a single webhook, specified by the webhook-ID parameter. -*WebhooksApi* | [**retire_webhook**](docs/WebhooksApi.md#retire_webhook) | **DELETE** /webhooks/{webhook-ID} | Retires the specified webhook. -*WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /webhooks | Update a webhook. -*WebhooksApi* | [**verify_webhook**](docs/WebhooksApi.md#verify_webhook) | **GET** /webhooks/verify/{verification-ID} | New webhooks must be verified before use, use the verificationID of the webhook to perform verification. - +*SubscriptionsApi* | [**get_timers_for_subscription**](docs/SubscriptionsApi.md#get_timers_for_subscription) | **GET** /subscriptions/{subscription-ID}/timer | +*SubscriptionsApi* | [**import_subscription**](docs/SubscriptionsApi.md#import_subscription) | **POST** /subscriptions/import | +*SubscriptionsApi* | [**invoice_charges_on_subscription**](docs/SubscriptionsApi.md#invoice_charges_on_subscription) | **POST** /subscriptions/{subscription-ID}/invoice-charges | +*SubscriptionsApi* | [**migrate_subscription**](docs/SubscriptionsApi.md#migrate_subscription) | **POST** /subscriptions/{subscription-ID}/migrate | +*SubscriptionsApi* | [**pause_subscription**](docs/SubscriptionsApi.md#pause_subscription) | **POST** /subscriptions/{subscription-ID}/pause | +*SubscriptionsApi* | [**remove_coupon_from_subscription**](docs/SubscriptionsApi.md#remove_coupon_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/coupons/{coupon-code} | +*SubscriptionsApi* | [**remove_credit_from_subscription**](docs/SubscriptionsApi.md#remove_credit_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/credit/{value} | +*SubscriptionsApi* | [**remove_payment_method_from_subscription**](docs/SubscriptionsApi.md#remove_payment_method_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/payment-methods/{payment-method-ID} | +*SubscriptionsApi* | [**remove_pricing_component_value_change_from_subscription**](docs/SubscriptionsApi.md#remove_pricing_component_value_change_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/values/{pricing-component} | +*SubscriptionsApi* | [**resume_subscription**](docs/SubscriptionsApi.md#resume_subscription) | **POST** /subscriptions/{subscription-ID}/resume | +*SubscriptionsApi* | [**revive_subscription**](docs/SubscriptionsApi.md#revive_subscription) | **POST** /subscriptions/{subscription-ID}/revive | +*SubscriptionsApi* | [**set_affiliate1**](docs/SubscriptionsApi.md#set_affiliate1) | **POST** /subscriptions/{subscriptionID}/affiliate | +*SubscriptionsApi* | [**set_metadata_for_subscription**](docs/SubscriptionsApi.md#set_metadata_for_subscription) | **POST** /subscriptions/{subscription-ID}/metadata | +*SubscriptionsApi* | [**set_pricing_component_value_on_subscription**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription) | **POST** /subscriptions/{subscription-ID}/pricing-component-values | +*SubscriptionsApi* | [**set_pricing_component_value_on_subscription1**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription1) | **POST** /subscriptions/{subscription-ID}/values/{pricing-component} | +*SubscriptionsApi* | [**set_pricing_component_value_on_subscription_batch_update**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription_batch_update) | **POST** /subscriptions/{subscription-ID}/values | +*SubscriptionsApi* | [**start_all_subscriptions**](docs/SubscriptionsApi.md#start_all_subscriptions) | **POST** /subscriptions/{accountID}/start | +*SubscriptionsApi* | [**update_subscription_from_request**](docs/SubscriptionsApi.md#update_subscription_from_request) | **PUT** /subscriptions/update | +*SubscriptionsApi* | [**upsert_metadata_for_subscription**](docs/SubscriptionsApi.md#upsert_metadata_for_subscription) | **PUT** /subscriptions/{subscription-ID}/metadata | +*TaxesApi* | [**create_taxation_strategy**](docs/TaxesApi.md#create_taxation_strategy) | **POST** /taxation-strategies | +*TaxesApi* | [**get_all_taxation_strategies**](docs/TaxesApi.md#get_all_taxation_strategies) | **GET** /taxation-strategies | +*TaxesApi* | [**get_taxation_strategy_by_consistent_id**](docs/TaxesApi.md#get_taxation_strategy_by_consistent_id) | **GET** /taxation-strategies/{taxation-strategy-ID} | +*TaxesApi* | [**get_taxation_strategy_by_country**](docs/TaxesApi.md#get_taxation_strategy_by_country) | **GET** /taxation-strategies/country/{country} | +*TaxesApi* | [**get_taxation_strategy_by_currency**](docs/TaxesApi.md#get_taxation_strategy_by_currency) | **GET** /taxation-strategies/currency/{currency} | +*TaxesApi* | [**get_taxation_strategy_by_province**](docs/TaxesApi.md#get_taxation_strategy_by_province) | **GET** /taxation-strategies/province/{province} | +*TaxesApi* | [**get_taxation_strategy_by_version_id**](docs/TaxesApi.md#get_taxation_strategy_by_version_id) | **GET** /taxation-strategies/version/{version-ID} | +*TaxesApi* | [**retire_taxation_strategy**](docs/TaxesApi.md#retire_taxation_strategy) | **DELETE** /taxation-strategies/version/{version-ID} | +*TaxesApi* | [**update_taxation_strategy**](docs/TaxesApi.md#update_taxation_strategy) | **PUT** /taxation-strategies | +*TokenizationApi* | [**auth_capture**](docs/TokenizationApi.md#auth_capture) | **POST** /tokenization/auth-capture | +*TokenizationApi* | [**braintree_card_capture**](docs/TokenizationApi.md#braintree_card_capture) | **POST** /tokenization/braintree | +*TokenizationApi* | [**create_authorize_net_token**](docs/TokenizationApi.md#create_authorize_net_token) | **POST** /vaulted-gateways/authorize-net | +*TokenizationApi* | [**create_braintree_token**](docs/TokenizationApi.md#create_braintree_token) | **POST** /vaulted-gateways/braintree | +*TokenizationApi* | [**create_stripe_ach_token**](docs/TokenizationApi.md#create_stripe_ach_token) | **POST** /vaulted-gateways/stripe-ACH | +*TokenizationApi* | [**create_stripe_token**](docs/TokenizationApi.md#create_stripe_token) | **POST** /vaulted-gateways/stripe | +*TokenizationApi* | [**create_trust_commerce_token**](docs/TokenizationApi.md#create_trust_commerce_token) | **POST** /vaulted-gateways/trustCommerce | +*TokenizationApi* | [**display_card_capture_form**](docs/TokenizationApi.md#display_card_capture_form) | **GET** /tokenization/card-capture-form | +*TokenizationApi* | [**epx_card_capture**](docs/TokenizationApi.md#epx_card_capture) | **POST** /tokenization/epx | +*TokenizationApi* | [**epx_pre_auth**](docs/TokenizationApi.md#epx_pre_auth) | **POST** /tokenization/epx-pre-auth | +*TokenizationApi* | [**epx_pre_auth_response**](docs/TokenizationApi.md#epx_pre_auth_response) | **POST** /tokenization/epx-redirect | +*TokenizationApi* | [**expire_email_redirect_capture**](docs/TokenizationApi.md#expire_email_redirect_capture) | **DELETE** /tokenization/email-redirect/{id} | +*TokenizationApi* | [**get_all_email_redirect_capture**](docs/TokenizationApi.md#get_all_email_redirect_capture) | **GET** /tokenization/email-redirect | +*TokenizationApi* | [**get_braintree_by_account_id**](docs/TokenizationApi.md#get_braintree_by_account_id) | **GET** /vaulted-gateways/braintree/{accountID} | +*TokenizationApi* | [**get_by_card_details_id**](docs/TokenizationApi.md#get_by_card_details_id) | **GET** /vaulted-gateways/stripe/card-details-id/{cardDetailsID} | +*TokenizationApi* | [**get_email_redirect_capture**](docs/TokenizationApi.md#get_email_redirect_capture) | **GET** /tokenization/email-redirect/{id} | +*TokenizationApi* | [**get_email_redirect_capture_invoice_html**](docs/TokenizationApi.md#get_email_redirect_capture_invoice_html) | **GET** /tokenization/email-redirect/{id}/invoice.html | +*TokenizationApi* | [**get_stripe_ach**](docs/TokenizationApi.md#get_stripe_ach) | **GET** /vaulted-gateways/stripe-ACH/{stripeACHTokenID} | +*TokenizationApi* | [**get_stripe_token**](docs/TokenizationApi.md#get_stripe_token) | **GET** /vaulted-gateways/stripe/{stripeTokenID} | +*TokenizationApi* | [**go_cardless_bank_account_capture**](docs/TokenizationApi.md#go_cardless_bank_account_capture) | **POST** /tokenization/direct-debit | +*TokenizationApi* | [**pay_vision_shout_v1**](docs/TokenizationApi.md#pay_vision_shout_v1) | **POST** /tokenization/payvision-shout-v1 | +*TokenizationApi* | [**pre_auth**](docs/TokenizationApi.md#pre_auth) | **POST** /tokenization/pre-auth | +*TokenizationApi* | [**sage_pay_notify_v300**](docs/TokenizationApi.md#sage_pay_notify_v300) | **POST** /tokenization/sagepay-notify-v3-00 | +*TokenizationApi* | [**sage_pay_shout_v300**](docs/TokenizationApi.md#sage_pay_shout_v300) | **GET** /tokenization/sagepay-shout-v3-00 | +*TokenizationApi* | [**send_email_redirect_capture**](docs/TokenizationApi.md#send_email_redirect_capture) | **POST** /tokenization/email-redirect/{id}/send | +*TokenizationApi* | [**start_email_redirect_capture**](docs/TokenizationApi.md#start_email_redirect_capture) | **POST** /tokenization/email-redirect | +*TokenizationApi* | [**stripe_ach_bank_account_capture**](docs/TokenizationApi.md#stripe_ach_bank_account_capture) | **POST** /tokenization/ach | +*TokenizationApi* | [**stripe_web_hook**](docs/TokenizationApi.md#stripe_web_hook) | **POST** /vaulted-gateways/stripe/webhook | +*TokenizationApi* | [**update_email_redirect_capture**](docs/TokenizationApi.md#update_email_redirect_capture) | **PUT** /tokenization/email-redirect/{id} | +*TokenizationApi* | [**update_profile_with_token**](docs/TokenizationApi.md#update_profile_with_token) | **PUT** /tokenization/profile | +*TokenizationApi* | [**update_stripe_ach_token**](docs/TokenizationApi.md#update_stripe_ach_token) | **PUT** /vaulted-gateways/stripe-ACH | +*TokenizationApi* | [**update_stripe_token**](docs/TokenizationApi.md#update_stripe_token) | **PUT** /vaulted-gateways/stripe | +*TokenizationApi* | [**zooz_card_capture**](docs/TokenizationApi.md#zooz_card_capture) | **POST** /tokenization/zooz | +*TokenizationApi* | [**zooz_web_hook**](docs/TokenizationApi.md#zooz_web_hook) | **POST** /vaulted-gateways/zooz/webhook | +*WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | +*WebhooksApi* | [**create_webhook_v2**](docs/WebhooksApi.md#create_webhook_v2) | **POST** /webhooks/create | +*WebhooksApi* | [**get_all_webhooks**](docs/WebhooksApi.md#get_all_webhooks) | **GET** /webhooks | +*WebhooksApi* | [**get_allowed_webhook_subscriptions**](docs/WebhooksApi.md#get_allowed_webhook_subscriptions) | **GET** /webhooks/allowed-subscriptions | +*WebhooksApi* | [**get_webhook_by_id**](docs/WebhooksApi.md#get_webhook_by_id) | **GET** /webhooks/{webhook-ID} | +*WebhooksApi* | [**retire_webhook**](docs/WebhooksApi.md#retire_webhook) | **DELETE** /webhooks/{webhook-ID} | +*WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /webhooks | +*WebhooksApi* | [**verify_webhook**](docs/WebhooksApi.md#verify_webhook) | **GET** /webhooks/verify/{verification-ID} | +*DefaultApi* | [**create_totp_secret**](docs/DefaultApi.md#create_totp_secret) | **POST** /2fa/totp | +*DefaultApi* | [**enable2fa**](docs/DefaultApi.md#enable2fa) | **POST** /2fa/enable | +*DefaultApi* | [**get_qr_code**](docs/DefaultApi.md#get_qr_code) | **GET** /barcode/qr/acc/{accountId} | ## Documentation For Models - - [APIConfigurationPagedMetadata](docs/APIConfigurationPagedMetadata.md) - - [APIQuote](docs/APIQuote.md) - - [APIQuotePagedMetadata](docs/APIQuotePagedMetadata.md) + - [APIConfiguration](docs/APIConfiguration.md) - [APIQuoteResponseQuantity](docs/APIQuoteResponseQuantity.md) - [Account](docs/Account.md) - - [AccountLTVResultPagedMetadata](docs/AccountLTVResultPagedMetadata.md) - - [AccountPagedMetadata](docs/AccountPagedMetadata.md) - - [AccountPaymentsResultPagedMetadata](docs/AccountPaymentsResultPagedMetadata.md) - [AddChargeRequest](docs/AddChargeRequest.md) + - [AddChargeResponse](docs/AddChargeResponse.md) + - [AddChargeToAccountResponse](docs/AddChargeToAccountResponse.md) + - [AddChargesToAccountAPIRequest](docs/AddChargesToAccountAPIRequest.md) + - [AddContractPeriodRequest](docs/AddContractPeriodRequest.md) - [AddCouponCodeRequest](docs/AddCouponCodeRequest.md) - [AddPaymentMethodRequest](docs/AddPaymentMethodRequest.md) - - [AddTaxationStrategyRequest](docs/AddTaxationStrategyRequest.md) + - [AdditionalData](docs/AdditionalData.md) - [Address](docs/Address.md) - - [AddressPagedMetadata](docs/AddressPagedMetadata.md) - - [AggregatingComponent](docs/AggregatingComponent.md) - - [Alias](docs/Alias.md) + - [AdvancePricingComponentsByChargeModel](docs/AdvancePricingComponentsByChargeModel.md) + - [Affiliate](docs/Affiliate.md) + - [AffiliateCommissionCharge](docs/AffiliateCommissionCharge.md) + - [AffiliateRatePlanRelationships](docs/AffiliateRatePlanRelationships.md) + - [AffiliateSubscriptionRelationship](docs/AffiliateSubscriptionRelationship.md) + - [AggregatingComponentDescription](docs/AggregatingComponentDescription.md) + - [AllowedWebhookSubscriptionValues](docs/AllowedWebhookSubscriptionValues.md) - [Amendment](docs/Amendment.md) - [AmendmentDiscardAmendment](docs/AmendmentDiscardAmendment.md) - - [AmendmentPagedMetadata](docs/AmendmentPagedMetadata.md) - - [AmendmentPriceNTimePagedMetadata](docs/AmendmentPriceNTimePagedMetadata.md) - - [AuditEntry](docs/AuditEntry.md) - - [AuditEntryPagedMetadata](docs/AuditEntryPagedMetadata.md) + - [ApiQuote](docs/ApiQuote.md) + - [ArrearsCharge](docs/ArrearsCharge.md) + - [ArrearsPricingComponentsByChargeModel](docs/ArrearsPricingComponentsByChargeModel.md) - [AuthCaptureRequest](docs/AuthCaptureRequest.md) - - [AuthorizeNetTokenPagedMetadata](docs/AuthorizeNetTokenPagedMetadata.md) - - [BFError](docs/BFError.md) + - [AuthorizeNetConfiguration](docs/AuthorizeNetConfiguration.md) + - [AuthorizeNetPayment](docs/AuthorizeNetPayment.md) + - [AuthorizeNetToken](docs/AuthorizeNetToken.md) + - [AvataxConfigRequest](docs/AvataxConfigRequest.md) + - [AvataxConfiguration](docs/AvataxConfiguration.md) + - [AvataxPingRequest](docs/AvataxPingRequest.md) + - [AvataxPingResponse](docs/AvataxPingResponse.md) - [BFPermission](docs/BFPermission.md) - - [BFPermissionPagedMetadata](docs/BFPermissionPagedMetadata.md) - - [BankAccountVerificationPagedMetadata](docs/BankAccountVerificationPagedMetadata.md) - - [BillforwardManagedPaymentsResultPagedMetadata](docs/BillforwardManagedPaymentsResultPagedMetadata.md) + - [BankAccount](docs/BankAccount.md) + - [BatchIncrementValuesRequest](docs/BatchIncrementValuesRequest.md) + - [BatchUpdatePricingComponentValuesRequest](docs/BatchUpdatePricingComponentValuesRequest.md) - [BillingEntityBase](docs/BillingEntityBase.md) - [BraintreeAuthCaptureRequest](docs/BraintreeAuthCaptureRequest.md) - [BraintreeCaptureRequest](docs/BraintreeCaptureRequest.md) - - [BraintreeTokenPagedMetadata](docs/BraintreeTokenPagedMetadata.md) - - [CancelSubscriptionRequest](docs/CancelSubscriptionRequest.md) + - [BraintreeConfiguration](docs/BraintreeConfiguration.md) + - [BraintreeMerchantAccount](docs/BraintreeMerchantAccount.md) + - [BraintreePayment](docs/BraintreePayment.md) + - [BraintreePreAuthRequest](docs/BraintreePreAuthRequest.md) + - [BraintreeToken](docs/BraintreeToken.md) + - [CalculatorResult](docs/CalculatorResult.md) - [CancellationAmendment](docs/CancellationAmendment.md) - - [CassChurnResultPagedMetadata](docs/CassChurnResultPagedMetadata.md) - - [CassPaymentResultPagedMetadata](docs/CassPaymentResultPagedMetadata.md) - - [CassUpgradeResultPagedMetadata](docs/CassUpgradeResultPagedMetadata.md) - - [Client](docs/Client.md) - - [ClientPagedMetadata](docs/ClientPagedMetadata.md) + - [CardConnectAuthCaptureRequest](docs/CardConnectAuthCaptureRequest.md) + - [CardConnectConfiguration](docs/CardConnectConfiguration.md) + - [CardConnectGatewayRequest](docs/CardConnectGatewayRequest.md) + - [CardConnectPayment](docs/CardConnectPayment.md) + - [CommissionStructure](docs/CommissionStructure.md) - [ComponentChange](docs/ComponentChange.md) - - [ComponentCost](docs/ComponentCost.md) - - [CompoundUsage](docs/CompoundUsage.md) - - [CompoundUsageSession](docs/CompoundUsageSession.md) + - [Contract](docs/Contract.md) + - [ContractPeriod](docs/ContractPeriod.md) - [Coupon](docs/Coupon.md) - - [CouponBook](docs/CouponBook.md) - - [CouponBookDefinition](docs/CouponBookDefinition.md) - - [CouponBookDefinitionPagedMetadata](docs/CouponBookDefinitionPagedMetadata.md) - - [CouponBookPagedMetadata](docs/CouponBookPagedMetadata.md) - - [CouponDefinition](docs/CouponDefinition.md) - - [CouponDefinitionPagedMetadata](docs/CouponDefinitionPagedMetadata.md) + - [CouponCharge](docs/CouponCharge.md) + - [CouponCodeResponse](docs/CouponCodeResponse.md) - [CouponDiscount](docs/CouponDiscount.md) - - [CouponDiscountEstimate](docs/CouponDiscountEstimate.md) - [CouponInstance](docs/CouponInstance.md) - [CouponInstanceExistingValue](docs/CouponInstanceExistingValue.md) - - [CouponInstancePagedMetadata](docs/CouponInstancePagedMetadata.md) - - [CouponModifierBase](docs/CouponModifierBase.md) - - [CouponModifierBasePagedMetadata](docs/CouponModifierBasePagedMetadata.md) - - [CouponPagedMetadata](docs/CouponPagedMetadata.md) - - [CouponRule](docs/CouponRule.md) - - [CouponRulePagedMetadata](docs/CouponRulePagedMetadata.md) + - [CouponPayment](docs/CouponPayment.md) - [CouponUniqueCodesRequest](docs/CouponUniqueCodesRequest.md) - [CouponUniqueCodesResponse](docs/CouponUniqueCodesResponse.md) - - [CouponUniqueCodesResponsePagedMetadata](docs/CouponUniqueCodesResponsePagedMetadata.md) - [CouponWrapperResponse](docs/CouponWrapperResponse.md) - - [CreateAccountProfileRequest](docs/CreateAccountProfileRequest.md) - - [CreateAccountRequest](docs/CreateAccountRequest.md) - - [CreateAddressRequest](docs/CreateAddressRequest.md) - [CreateAggregatingComponentRequest](docs/CreateAggregatingComponentRequest.md) - [CreateAggregatingSubscriptionRequest](docs/CreateAggregatingSubscriptionRequest.md) - - [CreateProfileAddressRequest](docs/CreateProfileAddressRequest.md) + - [CreateCommissionInvoiceRequest](docs/CreateCommissionInvoiceRequest.md) + - [CreateContractPeriodRequest](docs/CreateContractPeriodRequest.md) + - [CreateContractRequest](docs/CreateContractRequest.md) + - [CreateCouponDiscountRequest](docs/CreateCouponDiscountRequest.md) + - [CreateCouponRequest](docs/CreateCouponRequest.md) + - [CreateOfflinePaymentRequest](docs/CreateOfflinePaymentRequest.md) + - [CreatePermissionOnRoleRequest](docs/CreatePermissionOnRoleRequest.md) + - [CreatePermissionRequest](docs/CreatePermissionRequest.md) + - [CreatePricingComponentQuantityRequest](docs/CreatePricingComponentQuantityRequest.md) + - [CreateProfileRequest](docs/CreateProfileRequest.md) + - [CreateRoleRequest](docs/CreateRoleRequest.md) + - [CreateSalesforceConfigurationRequest](docs/CreateSalesforceConfigurationRequest.md) - [CreateSubscriptionBatchRequest](docs/CreateSubscriptionBatchRequest.md) - [CreateSubscriptionChargeAmendment](docs/CreateSubscriptionChargeAmendment.md) + - [CreateSubscriptionCheckoutDefinitionRequest](docs/CreateSubscriptionCheckoutDefinitionRequest.md) - [CreateSubscriptionRequest](docs/CreateSubscriptionRequest.md) + - [CreateSubscriptionTimerRequest](docs/CreateSubscriptionTimerRequest.md) + - [CreateTOTPRequest](docs/CreateTOTPRequest.md) - [CreditAccountRequest](docs/CreditAccountRequest.md) - [CreditNote](docs/CreditNote.md) - - [CreditNotePagedMetadata](docs/CreditNotePagedMetadata.md) + - [CreditNoteCurrency](docs/CreditNoteCurrency.md) + - [CreditNotePayment](docs/CreditNotePayment.md) - [CreditSubscriptionRequest](docs/CreditSubscriptionRequest.md) - - [CybersourceTokenPagedMetadata](docs/CybersourceTokenPagedMetadata.md) - - [DataSynchronisationAppConfigurationPagedMetadata](docs/DataSynchronisationAppConfigurationPagedMetadata.md) - - [DataSynchronisationConfiguration](docs/DataSynchronisationConfiguration.md) - - [DataSynchronisationConfigurationPagedMetadata](docs/DataSynchronisationConfigurationPagedMetadata.md) - - [DataSynchronizationJobPagedMetadata](docs/DataSynchronizationJobPagedMetadata.md) - - [DebtsResultPagedMetadata](docs/DebtsResultPagedMetadata.md) + - [CybersourceConfiguration](docs/CybersourceConfiguration.md) + - [CybersourcePayment](docs/CybersourcePayment.md) + - [DataSyncJobErrorResponse](docs/DataSyncJobErrorResponse.md) + - [DataSyncJobResponse](docs/DataSyncJobResponse.md) - [DunningLine](docs/DunningLine.md) - - [DunningLinePagedMetadata](docs/DunningLinePagedMetadata.md) - - [DynamicMetadata](docs/DynamicMetadata.md) - - [Email](docs/Email.md) - - [EmailPagedMetadata](docs/EmailPagedMetadata.md) - - [EmailProvider](docs/EmailProvider.md) - - [EmailProviderPagedMetadata](docs/EmailProviderPagedMetadata.md) - - [EmailSubscription](docs/EmailSubscription.md) - - [EmailSubscriptionPagedMetadata](docs/EmailSubscriptionPagedMetadata.md) + - [EBANXAuthCaptureRequest](docs/EBANXAuthCaptureRequest.md) + - [EBANXConfiguration](docs/EBANXConfiguration.md) + - [EBANXGatewayRequest](docs/EBANXGatewayRequest.md) + - [EBANXPayment](docs/EBANXPayment.md) + - [EBANXWebhook](docs/EBANXWebhook.md) + - [EmailTokenization](docs/EmailTokenization.md) + - [EmailTokenizationCreateAPIRequest](docs/EmailTokenizationCreateAPIRequest.md) + - [EmailTokenizationSendAPIRequest](docs/EmailTokenizationSendAPIRequest.md) + - [EmailTokenizationUpdateAPIRequest](docs/EmailTokenizationUpdateAPIRequest.md) - [EndTrialAmendment](docs/EndTrialAmendment.md) - - [Event](docs/Event.md) - - [EventData](docs/EventData.md) - - [FileSham](docs/FileSham.md) + - [EpxCaptureRequest](docs/EpxCaptureRequest.md) + - [EpxConfiguration](docs/EpxConfiguration.md) + - [EpxPayment](docs/EpxPayment.md) + - [EpxPreAuthRequest](docs/EpxPreAuthRequest.md) + - [EpxPreAuthResponse](docs/EpxPreAuthResponse.md) + - [ExecutionReceiptResponse](docs/ExecutionReceiptResponse.md) + - [ExecutionResponse](docs/ExecutionResponse.md) + - [Extras](docs/Extras.md) - [FixedTerm](docs/FixedTerm.md) - - [FixedTermDefinitionPagedMetadata](docs/FixedTermDefinitionPagedMetadata.md) + - [FixedTermDefinition](docs/FixedTermDefinition.md) - [FixedTermExpiryAmendment](docs/FixedTermExpiryAmendment.md) - - [FixedTermPagedMetadata](docs/FixedTermPagedMetadata.md) + - [FlatAdvancePricingComponent](docs/FlatAdvancePricingComponent.md) + - [FlatArrearsPricingComponent](docs/FlatArrearsPricingComponent.md) - [FlatPricingComponent](docs/FlatPricingComponent.md) + - [FlatSetupPricingComponent](docs/FlatSetupPricingComponent.md) + - [FlatUsagePricingComponent](docs/FlatUsagePricingComponent.md) + - [GetRatePlanAffiliateResponse](docs/GetRatePlanAffiliateResponse.md) + - [GetSubscriptionAffiliateResponse](docs/GetSubscriptionAffiliateResponse.md) + - [GoCardlessConfiguration](docs/GoCardlessConfiguration.md) + - [GoCardlessTokenizationRequest](docs/GoCardlessTokenizationRequest.md) + - [HaltAggregationRequest](docs/HaltAggregationRequest.md) + - [HaltAggregationResponse](docs/HaltAggregationResponse.md) + - [HostedPayment](docs/HostedPayment.md) + - [HostedPaymentConfig](docs/HostedPaymentConfig.md) + - [IDiscardable](docs/IDiscardable.md) - [ImportInvoiceLine](docs/ImportInvoiceLine.md) - - [InsertableBillingEntity](docs/InsertableBillingEntity.md) + - [ImportInvoiceRequest](docs/ImportInvoiceRequest.md) + - [ImportSubscriptionRequest](docs/ImportSubscriptionRequest.md) + - [InlineResponseDefault](docs/InlineResponseDefault.md) + - [InlineResponseDefault1](docs/InlineResponseDefault1.md) + - [InlineResponseDefault10](docs/InlineResponseDefault10.md) + - [InlineResponseDefault100](docs/InlineResponseDefault100.md) + - [InlineResponseDefault101](docs/InlineResponseDefault101.md) + - [InlineResponseDefault102](docs/InlineResponseDefault102.md) + - [InlineResponseDefault103](docs/InlineResponseDefault103.md) + - [InlineResponseDefault11](docs/InlineResponseDefault11.md) + - [InlineResponseDefault12](docs/InlineResponseDefault12.md) + - [InlineResponseDefault13](docs/InlineResponseDefault13.md) + - [InlineResponseDefault14](docs/InlineResponseDefault14.md) + - [InlineResponseDefault15](docs/InlineResponseDefault15.md) + - [InlineResponseDefault16](docs/InlineResponseDefault16.md) + - [InlineResponseDefault17](docs/InlineResponseDefault17.md) + - [InlineResponseDefault18](docs/InlineResponseDefault18.md) + - [InlineResponseDefault19](docs/InlineResponseDefault19.md) + - [InlineResponseDefault2](docs/InlineResponseDefault2.md) + - [InlineResponseDefault20](docs/InlineResponseDefault20.md) + - [InlineResponseDefault21](docs/InlineResponseDefault21.md) + - [InlineResponseDefault22](docs/InlineResponseDefault22.md) + - [InlineResponseDefault23](docs/InlineResponseDefault23.md) + - [InlineResponseDefault24](docs/InlineResponseDefault24.md) + - [InlineResponseDefault25](docs/InlineResponseDefault25.md) + - [InlineResponseDefault26](docs/InlineResponseDefault26.md) + - [InlineResponseDefault27](docs/InlineResponseDefault27.md) + - [InlineResponseDefault28](docs/InlineResponseDefault28.md) + - [InlineResponseDefault29](docs/InlineResponseDefault29.md) + - [InlineResponseDefault3](docs/InlineResponseDefault3.md) + - [InlineResponseDefault30](docs/InlineResponseDefault30.md) + - [InlineResponseDefault31](docs/InlineResponseDefault31.md) + - [InlineResponseDefault32](docs/InlineResponseDefault32.md) + - [InlineResponseDefault33](docs/InlineResponseDefault33.md) + - [InlineResponseDefault34](docs/InlineResponseDefault34.md) + - [InlineResponseDefault35](docs/InlineResponseDefault35.md) + - [InlineResponseDefault36](docs/InlineResponseDefault36.md) + - [InlineResponseDefault37](docs/InlineResponseDefault37.md) + - [InlineResponseDefault38](docs/InlineResponseDefault38.md) + - [InlineResponseDefault39](docs/InlineResponseDefault39.md) + - [InlineResponseDefault4](docs/InlineResponseDefault4.md) + - [InlineResponseDefault40](docs/InlineResponseDefault40.md) + - [InlineResponseDefault41](docs/InlineResponseDefault41.md) + - [InlineResponseDefault42](docs/InlineResponseDefault42.md) + - [InlineResponseDefault43](docs/InlineResponseDefault43.md) + - [InlineResponseDefault44](docs/InlineResponseDefault44.md) + - [InlineResponseDefault45](docs/InlineResponseDefault45.md) + - [InlineResponseDefault46](docs/InlineResponseDefault46.md) + - [InlineResponseDefault47](docs/InlineResponseDefault47.md) + - [InlineResponseDefault48](docs/InlineResponseDefault48.md) + - [InlineResponseDefault49](docs/InlineResponseDefault49.md) + - [InlineResponseDefault5](docs/InlineResponseDefault5.md) + - [InlineResponseDefault50](docs/InlineResponseDefault50.md) + - [InlineResponseDefault51](docs/InlineResponseDefault51.md) + - [InlineResponseDefault52](docs/InlineResponseDefault52.md) + - [InlineResponseDefault53](docs/InlineResponseDefault53.md) + - [InlineResponseDefault54](docs/InlineResponseDefault54.md) + - [InlineResponseDefault55](docs/InlineResponseDefault55.md) + - [InlineResponseDefault56](docs/InlineResponseDefault56.md) + - [InlineResponseDefault57](docs/InlineResponseDefault57.md) + - [InlineResponseDefault58](docs/InlineResponseDefault58.md) + - [InlineResponseDefault59](docs/InlineResponseDefault59.md) + - [InlineResponseDefault6](docs/InlineResponseDefault6.md) + - [InlineResponseDefault60](docs/InlineResponseDefault60.md) + - [InlineResponseDefault61](docs/InlineResponseDefault61.md) + - [InlineResponseDefault62](docs/InlineResponseDefault62.md) + - [InlineResponseDefault63](docs/InlineResponseDefault63.md) + - [InlineResponseDefault64](docs/InlineResponseDefault64.md) + - [InlineResponseDefault65](docs/InlineResponseDefault65.md) + - [InlineResponseDefault66](docs/InlineResponseDefault66.md) + - [InlineResponseDefault67](docs/InlineResponseDefault67.md) + - [InlineResponseDefault68](docs/InlineResponseDefault68.md) + - [InlineResponseDefault69](docs/InlineResponseDefault69.md) + - [InlineResponseDefault7](docs/InlineResponseDefault7.md) + - [InlineResponseDefault70](docs/InlineResponseDefault70.md) + - [InlineResponseDefault71](docs/InlineResponseDefault71.md) + - [InlineResponseDefault72](docs/InlineResponseDefault72.md) + - [InlineResponseDefault73](docs/InlineResponseDefault73.md) + - [InlineResponseDefault74](docs/InlineResponseDefault74.md) + - [InlineResponseDefault75](docs/InlineResponseDefault75.md) + - [InlineResponseDefault76](docs/InlineResponseDefault76.md) + - [InlineResponseDefault77](docs/InlineResponseDefault77.md) + - [InlineResponseDefault78](docs/InlineResponseDefault78.md) + - [InlineResponseDefault79](docs/InlineResponseDefault79.md) + - [InlineResponseDefault8](docs/InlineResponseDefault8.md) + - [InlineResponseDefault80](docs/InlineResponseDefault80.md) + - [InlineResponseDefault81](docs/InlineResponseDefault81.md) + - [InlineResponseDefault82](docs/InlineResponseDefault82.md) + - [InlineResponseDefault83](docs/InlineResponseDefault83.md) + - [InlineResponseDefault84](docs/InlineResponseDefault84.md) + - [InlineResponseDefault85](docs/InlineResponseDefault85.md) + - [InlineResponseDefault86](docs/InlineResponseDefault86.md) + - [InlineResponseDefault87](docs/InlineResponseDefault87.md) + - [InlineResponseDefault88](docs/InlineResponseDefault88.md) + - [InlineResponseDefault89](docs/InlineResponseDefault89.md) + - [InlineResponseDefault9](docs/InlineResponseDefault9.md) + - [InlineResponseDefault90](docs/InlineResponseDefault90.md) + - [InlineResponseDefault91](docs/InlineResponseDefault91.md) + - [InlineResponseDefault92](docs/InlineResponseDefault92.md) + - [InlineResponseDefault93](docs/InlineResponseDefault93.md) + - [InlineResponseDefault94](docs/InlineResponseDefault94.md) + - [InlineResponseDefault95](docs/InlineResponseDefault95.md) + - [InlineResponseDefault96](docs/InlineResponseDefault96.md) + - [InlineResponseDefault97](docs/InlineResponseDefault97.md) + - [InlineResponseDefault98](docs/InlineResponseDefault98.md) + - [InlineResponseDefault99](docs/InlineResponseDefault99.md) + - [IntervalDate](docs/IntervalDate.md) - [Invoice](docs/Invoice.md) - [InvoiceChargeRequest](docs/InvoiceChargeRequest.md) - - [InvoiceLine](docs/InvoiceLine.md) - - [InvoiceLinePayment](docs/InvoiceLinePayment.md) - - [InvoiceLinePaymentPagedMetadata](docs/InvoiceLinePaymentPagedMetadata.md) + - [InvoiceExecutionRequest](docs/InvoiceExecutionRequest.md) + - [InvoiceLinePayments](docs/InvoiceLinePayments.md) + - [InvoiceLines](docs/InvoiceLines.md) - [InvoiceNextExecutionAttemptAmendment](docs/InvoiceNextExecutionAttemptAmendment.md) - [InvoiceOutstandingChargesAmendment](docs/InvoiceOutstandingChargesAmendment.md) - - [InvoicePagedMetadata](docs/InvoicePagedMetadata.md) - - [InvoicePayment](docs/InvoicePayment.md) + - [InvoicePayments](docs/InvoicePayments.md) - [InvoiceRecalculationAmendment](docs/InvoiceRecalculationAmendment.md) - [InvoiceRecalculationRequest](docs/InvoiceRecalculationRequest.md) + - [InvoiceRefundRequest](docs/InvoiceRefundRequest.md) + - [InvoiceRefundResponse](docs/InvoiceRefundResponse.md) + - [InvoiceSplit](docs/InvoiceSplit.md) + - [InvoiceSplitServiceRequest](docs/InvoiceSplitServiceRequest.md) + - [InvoiceTemplateConfigResponse](docs/InvoiceTemplateConfigResponse.md) - [IssueInvoiceAmendment](docs/IssueInvoiceAmendment.md) - - [MetadataKeyValuesPagedMetadata](docs/MetadataKeyValuesPagedMetadata.md) + - [IssueInvoiceRequest](docs/IssueInvoiceRequest.md) + - [IssueInvoiceResponse](docs/IssueInvoiceResponse.md) + - [KashConfiguration](docs/KashConfiguration.md) + - [LegacyCreateWebhookRequest](docs/LegacyCreateWebhookRequest.md) + - [ManualCharge](docs/ManualCharge.md) + - [MarketplaceQuote](docs/MarketplaceQuote.md) + - [Metadata](docs/Metadata.md) + - [MetadataKeyValues](docs/MetadataKeyValues.md) + - [Migration](docs/Migration.md) - [MigrationRequest](docs/MigrationRequest.md) - - [MutableBillingEntity](docs/MutableBillingEntity.md) - - [Notification](docs/Notification.md) - - [NotificationPagedMetadata](docs/NotificationPagedMetadata.md) - - [Organization](docs/Organization.md) - - [OrganizationPagedMetadata](docs/OrganizationPagedMetadata.md) + - [MigrationResponse](docs/MigrationResponse.md) + - [NestedAdhocChargeRequest](docs/NestedAdhocChargeRequest.md) + - [NestedChargeRequest](docs/NestedChargeRequest.md) + - [NotificationSendRequest](docs/NotificationSendRequest.md) + - [NotificationSendResponse](docs/NotificationSendResponse.md) + - [Notifications](docs/Notifications.md) + - [OAuthToken](docs/OAuthToken.md) + - [OfflinePayment](docs/OfflinePayment.md) + - [OpenIDRegistrationResponse](docs/OpenIDRegistrationResponse.md) + - [OpenIdUserLinkRequest](docs/OpenIdUserLinkRequest.md) + - [OrganizationLiteView](docs/OrganizationLiteView.md) - [Password](docs/Password.md) - - [PasswordPagedMetadata](docs/PasswordPagedMetadata.md) - - [PasswordResetRequest](docs/PasswordResetRequest.md) + - [PasswordResetCodeRequest](docs/PasswordResetCodeRequest.md) + - [PasswordResetResponse](docs/PasswordResetResponse.md) + - [PasswordUpdateWithResetCodeRequest](docs/PasswordUpdateWithResetCodeRequest.md) - [PauseRequest](docs/PauseRequest.md) + - [PayVisionAuthCaptureRequest](docs/PayVisionAuthCaptureRequest.md) + - [PayVisionConfiguration](docs/PayVisionConfiguration.md) + - [PayVisionPreAuthRequest](docs/PayVisionPreAuthRequest.md) - [Payment](docs/Payment.md) + - [PaymentAccountingView](docs/PaymentAccountingView.md) - [PaymentMethod](docs/PaymentMethod.md) - - [PaymentMethodPagedMetadata](docs/PaymentMethodPagedMetadata.md) - [PaymentMethodSubscriptionLink](docs/PaymentMethodSubscriptionLink.md) - - [PaymentMethodSubscriptionLinkPagedMetadata](docs/PaymentMethodSubscriptionLinkPagedMetadata.md) - - [PaymentPagedMetadata](docs/PaymentPagedMetadata.md) + - [PaymentRefundRequest](docs/PaymentRefundRequest.md) + - [PaymentRefundResponse](docs/PaymentRefundResponse.md) - [PaymentRetryRequest](docs/PaymentRetryRequest.md) + - [PaypalConfiguration](docs/PaypalConfiguration.md) + - [PaypalPayment](docs/PaypalPayment.md) - [PendingComponentValueChange](docs/PendingComponentValueChange.md) - - [Period](docs/Period.md) - - [PeriodPagedMetadata](docs/PeriodPagedMetadata.md) - - [PermissionActionEntityPagedMetadata](docs/PermissionActionEntityPagedMetadata.md) - - [PermissionResourceEntityPagedMetadata](docs/PermissionResourceEntityPagedMetadata.md) - - [PriceCalculationPagedMetadata](docs/PriceCalculationPagedMetadata.md) + - [PermissionActionEntity](docs/PermissionActionEntity.md) + - [PermissionResourceEntity](docs/PermissionResourceEntity.md) + - [PlanAggregation](docs/PlanAggregation.md) + - [PlanRequest](docs/PlanRequest.md) + - [PlanResponse](docs/PlanResponse.md) + - [PrepaymentCharge](docs/PrepaymentCharge.md) + - [PriceBreakdown](docs/PriceBreakdown.md) + - [PriceLine](docs/PriceLine.md) - [PricingComponent](docs/PricingComponent.md) - - [PricingComponentCouponModifier](docs/PricingComponentCouponModifier.md) + - [PricingComponentCharge](docs/PricingComponentCharge.md) - [PricingComponentMigrationValue](docs/PricingComponentMigrationValue.md) - - [PricingComponentPagedMetadata](docs/PricingComponentPagedMetadata.md) - - [PricingComponentQuantityRequest](docs/PricingComponentQuantityRequest.md) - [PricingComponentTier](docs/PricingComponentTier.md) - - [PricingComponentTierPagedMetadata](docs/PricingComponentTierPagedMetadata.md) - [PricingComponentValue](docs/PricingComponentValue.md) - - [PricingComponentValueChangeAmendment](docs/PricingComponentValueChangeAmendment.md) - - [PricingComponentValueChangePagedMetadata](docs/PricingComponentValueChangePagedMetadata.md) + - [PricingComponentValueAmendment](docs/PricingComponentValueAmendment.md) + - [PricingComponentValueChange](docs/PricingComponentValueChange.md) - [PricingComponentValueMigrationAmendmentMapping](docs/PricingComponentValueMigrationAmendmentMapping.md) - - [PricingComponentValuePagedMetadata](docs/PricingComponentValuePagedMetadata.md) - [PricingComponentValueRequest](docs/PricingComponentValueRequest.md) - - [PricingComponentValueResponsePagedMetadata](docs/PricingComponentValueResponsePagedMetadata.md) - - [Product](docs/Product.md) - - [ProductCouponModifier](docs/ProductCouponModifier.md) - - [ProductPagedMetadata](docs/ProductPagedMetadata.md) - - [ProductPaymentsResultPagedMetadata](docs/ProductPaymentsResultPagedMetadata.md) - - [ProductRatePlan](docs/ProductRatePlan.md) + - [PricingComponentValueResponse](docs/PricingComponentValueResponse.md) + - [PricingComponentsByChargeType](docs/PricingComponentsByChargeType.md) + - [PricingTier](docs/PricingTier.md) - [ProductRatePlanMigrationAmendment](docs/ProductRatePlanMigrationAmendment.md) - - [ProductRatePlanPagedMetadata](docs/ProductRatePlanPagedMetadata.md) - - [ProductRatePlanPaymentsResultPagedMetadata](docs/ProductRatePlanPaymentsResultPagedMetadata.md) + - [ProductRatePlanMigrationCharge](docs/ProductRatePlanMigrationCharge.md) - [Profile](docs/Profile.md) - - [ProfilePagedMetadata](docs/ProfilePagedMetadata.md) + - [PublicConfigurationResponse](docs/PublicConfigurationResponse.md) - [QuoteRequest](docs/QuoteRequest.md) - [QuoteRequestValue](docs/QuoteRequestValue.md) + - [RecalculateChargeBatchRequest](docs/RecalculateChargeBatchRequest.md) + - [RecalculateChargeBatchResponse](docs/RecalculateChargeBatchResponse.md) - [RecalculateChargeRequest](docs/RecalculateChargeRequest.md) - [Receipt](docs/Receipt.md) - - [ReceiptPagedMetadata](docs/ReceiptPagedMetadata.md) - [Refund](docs/Refund.md) - - [RefundPagedMetadata](docs/RefundPagedMetadata.md) + - [RefundAccountingView](docs/RefundAccountingView.md) + - [RemoveCreditAccountRequest](docs/RemoveCreditAccountRequest.md) - [ResumeRequest](docs/ResumeRequest.md) - [ResumeSubscriptionAmendment](docs/ResumeSubscriptionAmendment.md) - - [RevenueAttribution](docs/RevenueAttribution.md) - - [RevenueAttributionPagedMetadata](docs/RevenueAttributionPagedMetadata.md) - - [ReviveSubscriptionRequest](docs/ReviveSubscriptionRequest.md) + - [RevenueAttributions](docs/RevenueAttributions.md) - [Role](docs/Role.md) - - [RolePagedMetadata](docs/RolePagedMetadata.md) - - [RuleSatisfaction](docs/RuleSatisfaction.md) - - [SearchResultPagedMetadata](docs/SearchResultPagedMetadata.md) + - [SagePayAuthCaptureRequest](docs/SagePayAuthCaptureRequest.md) + - [SagePayCardPayment](docs/SagePayCardPayment.md) + - [SagePayConfiguration](docs/SagePayConfiguration.md) + - [SagePayEnabledCardType](docs/SagePayEnabledCardType.md) + - [SagePayPreAuthRequest](docs/SagePayPreAuthRequest.md) + - [SalesforceConfigurationResponse](docs/SalesforceConfigurationResponse.md) - [ServiceEndAmendment](docs/ServiceEndAmendment.md) - - [StripeACHTokenPagedMetadata](docs/StripeACHTokenPagedMetadata.md) + - [SetRatePlanAffiliateRequest](docs/SetRatePlanAffiliateRequest.md) + - [SetSubscriptionAffiliateRequest](docs/SetSubscriptionAffiliateRequest.md) + - [SetupCharge](docs/SetupCharge.md) + - [SetupPricingComponentsByChargeModel](docs/SetupPricingComponentsByChargeModel.md) + - [ShuttleAuthCaptureRequest](docs/ShuttleAuthCaptureRequest.md) + - [ShuttleConfiguration](docs/ShuttleConfiguration.md) + - [ShuttlePayment](docs/ShuttlePayment.md) + - [ShuttlePreAuthRequest](docs/ShuttlePreAuthRequest.md) + - [SimpleDateParam](docs/SimpleDateParam.md) + - [SimpleUser](docs/SimpleUser.md) + - [SingleRecalculateChargeRequest](docs/SingleRecalculateChargeRequest.md) + - [SpreedlyAuthCaptureRequest](docs/SpreedlyAuthCaptureRequest.md) + - [SpreedlyConfiguration](docs/SpreedlyConfiguration.md) + - [SpreedlyPreAuthRequest](docs/SpreedlyPreAuthRequest.md) + - [SquareAuthCaptureRequest](docs/SquareAuthCaptureRequest.md) + - [SquareConfiguration](docs/SquareConfiguration.md) + - [SquareConfigurationData](docs/SquareConfigurationData.md) + - [SquareData](docs/SquareData.md) + - [SquarePayment](docs/SquarePayment.md) + - [SquareSubscription](docs/SquareSubscription.md) + - [StartAllSubscriptionsRequest](docs/StartAllSubscriptionsRequest.md) + - [StartAllSubscriptionsResponse](docs/StartAllSubscriptionsResponse.md) + - [StartContractRequest](docs/StartContractRequest.md) + - [StartContractResponse](docs/StartContractResponse.md) + - [StripeACHCaptureRequest](docs/StripeACHCaptureRequest.md) + - [StripeACHPayment](docs/StripeACHPayment.md) + - [StripeAchToken](docs/StripeAchToken.md) + - [StripeAdditionalData](docs/StripeAdditionalData.md) - [StripeAuthCaptureRequest](docs/StripeAuthCaptureRequest.md) - - [StripeObject](docs/StripeObject.md) - - [StripeTokenPagedMetadata](docs/StripeTokenPagedMetadata.md) + - [StripeCardPayment](docs/StripeCardPayment.md) + - [StripeConfiguration](docs/StripeConfiguration.md) + - [StripePreAuthRequest](docs/StripePreAuthRequest.md) + - [StripeToken](docs/StripeToken.md) - [Subscription](docs/Subscription.md) - - [SubscriptionCancellationPagedMetadata](docs/SubscriptionCancellationPagedMetadata.md) + - [SubscriptionCancellation](docs/SubscriptionCancellation.md) - [SubscriptionCharge](docs/SubscriptionCharge.md) - - [SubscriptionChargePagedMetadata](docs/SubscriptionChargePagedMetadata.md) - - [SubscriptionLTVResultPagedMetadata](docs/SubscriptionLTVResultPagedMetadata.md) - - [SubscriptionPagedMetadata](docs/SubscriptionPagedMetadata.md) - - [SwaggerTypeList](docs/SwaggerTypeList.md) + - [SubscriptionCheckoutActionRequest](docs/SubscriptionCheckoutActionRequest.md) + - [SubscriptionCheckoutDefinitionDescription](docs/SubscriptionCheckoutDefinitionDescription.md) + - [SubscriptionCheckoutResponse](docs/SubscriptionCheckoutResponse.md) + - [SubscriptionReviveAmendment](docs/SubscriptionReviveAmendment.md) + - [SubscriptionRevivePartialRequest](docs/SubscriptionRevivePartialRequest.md) + - [SubscriptionReviveRequest](docs/SubscriptionReviveRequest.md) - [SwaggerTypeListInv](docs/SwaggerTypeListInv.md) - [SwaggerTypeListSubs](docs/SwaggerTypeListSubs.md) - - [TaxationLinkPagedMetadata](docs/TaxationLinkPagedMetadata.md) - - [TaxationStrategyPagedMetadata](docs/TaxationStrategyPagedMetadata.md) + - [SyncActionRequest](docs/SyncActionRequest.md) + - [TaxLine](docs/TaxLine.md) + - [TaxationStrategy](docs/TaxationStrategy.md) + - [TieredAdvancePricingComponent](docs/TieredAdvancePricingComponent.md) + - [TieredArrearsPricingComponent](docs/TieredArrearsPricingComponent.md) - [TieredPricingComponent](docs/TieredPricingComponent.md) + - [TieredSetupPricingComponent](docs/TieredSetupPricingComponent.md) + - [TieredUsagePricingComponent](docs/TieredUsagePricingComponent.md) - [TieredVolumePricingComponent](docs/TieredVolumePricingComponent.md) - [TimeRequest](docs/TimeRequest.md) - [TimeResponse](docs/TimeResponse.md) - - [TimeResponsePagedMetadata](docs/TimeResponsePagedMetadata.md) - - [TimeZone](docs/TimeZone.md) - [TimerAmendment](docs/TimerAmendment.md) - - [TokenizationPreAuthPagedMetadata](docs/TokenizationPreAuthPagedMetadata.md) - - [TrustCommerceTokenPagedMetadata](docs/TrustCommerceTokenPagedMetadata.md) - - [UnitDiscount](docs/UnitDiscount.md) + - [TokenizationEpxredirectBody](docs/TokenizationEpxredirectBody.md) + - [TokenizationPayvisionshoutv1Body](docs/TokenizationPayvisionshoutv1Body.md) + - [TokenizationPreAuth](docs/TokenizationPreAuth.md) + - [TokenizationPreAuthRequest](docs/TokenizationPreAuthRequest.md) + - [TokenizationSagepaynotifyv300Body](docs/TokenizationSagepaynotifyv300Body.md) + - [TokensResponse](docs/TokensResponse.md) + - [TrustCommerceConfiguration](docs/TrustCommerceConfiguration.md) + - [TrustCommerceToken](docs/TrustCommerceToken.md) + - [TypedQueryResultWrapperAPIQuote](docs/TypedQueryResultWrapperAPIQuote.md) + - [TypedQueryResultWrapperAccount](docs/TypedQueryResultWrapperAccount.md) + - [TypedQueryResultWrapperAddress](docs/TypedQueryResultWrapperAddress.md) + - [TypedQueryResultWrapperAmendment](docs/TypedQueryResultWrapperAmendment.md) + - [TypedQueryResultWrapperAvataxConfiguration](docs/TypedQueryResultWrapperAvataxConfiguration.md) + - [TypedQueryResultWrapperBFPermission](docs/TypedQueryResultWrapperBFPermission.md) + - [TypedQueryResultWrapperBraintreeToken](docs/TypedQueryResultWrapperBraintreeToken.md) + - [TypedQueryResultWrapperContract](docs/TypedQueryResultWrapperContract.md) + - [TypedQueryResultWrapperCoupon](docs/TypedQueryResultWrapperCoupon.md) + - [TypedQueryResultWrapperCreditNote](docs/TypedQueryResultWrapperCreditNote.md) + - [TypedQueryResultWrapperDataSyncJobResponse](docs/TypedQueryResultWrapperDataSyncJobResponse.md) + - [TypedQueryResultWrapperDunningLine](docs/TypedQueryResultWrapperDunningLine.md) + - [TypedQueryResultWrapperInvoice](docs/TypedQueryResultWrapperInvoice.md) + - [TypedQueryResultWrapperInvoiceLinePayment](docs/TypedQueryResultWrapperInvoiceLinePayment.md) + - [TypedQueryResultWrapperNotification](docs/TypedQueryResultWrapperNotification.md) + - [TypedQueryResultWrapperPayment](docs/TypedQueryResultWrapperPayment.md) + - [TypedQueryResultWrapperPaymentMethod](docs/TypedQueryResultWrapperPaymentMethod.md) + - [TypedQueryResultWrapperPlanResponse](docs/TypedQueryResultWrapperPlanResponse.md) + - [TypedQueryResultWrapperProfile](docs/TypedQueryResultWrapperProfile.md) + - [TypedQueryResultWrapperReceipt](docs/TypedQueryResultWrapperReceipt.md) + - [TypedQueryResultWrapperRefund](docs/TypedQueryResultWrapperRefund.md) + - [TypedQueryResultWrapperRevenueAttribution](docs/TypedQueryResultWrapperRevenueAttribution.md) + - [TypedQueryResultWrapperRole](docs/TypedQueryResultWrapperRole.md) + - [TypedQueryResultWrapperStripeACHToken](docs/TypedQueryResultWrapperStripeACHToken.md) + - [TypedQueryResultWrapperStripeToken](docs/TypedQueryResultWrapperStripeToken.md) + - [TypedQueryResultWrapperSubscription](docs/TypedQueryResultWrapperSubscription.md) + - [TypedQueryResultWrapperSubscriptionCharge](docs/TypedQueryResultWrapperSubscriptionCharge.md) + - [TypedQueryResultWrapperTaxationStrategy](docs/TypedQueryResultWrapperTaxationStrategy.md) + - [TypedQueryResultWrapperUserResponse](docs/TypedQueryResultWrapperUserResponse.md) + - [TypedQueryResultWrapperWebhook](docs/TypedQueryResultWrapperWebhook.md) - [UnitOfMeasure](docs/UnitOfMeasure.md) - - [UnitOfMeasureCouponModifier](docs/UnitOfMeasureCouponModifier.md) - - [UnitOfMeasurePagedMetadata](docs/UnitOfMeasurePagedMetadata.md) - - [UpdateAddressRequest](docs/UpdateAddressRequest.md) - [UpdateComponentValueAmendment](docs/UpdateComponentValueAmendment.md) - - [UpdateProfileRequest](docs/UpdateProfileRequest.md) + - [UpdateContractRequest](docs/UpdateContractRequest.md) + - [UpdateEmailRequest](docs/UpdateEmailRequest.md) + - [UpdateInvoiceRequest](docs/UpdateInvoiceRequest.md) + - [UpdateInvoiceTemplateRequest](docs/UpdateInvoiceTemplateRequest.md) + - [UpdatePasswordRequest](docs/UpdatePasswordRequest.md) + - [UpdatePasswordResponse](docs/UpdatePasswordResponse.md) + - [UpdatePricingComponentValueChangeResult](docs/UpdatePricingComponentValueChangeResult.md) + - [UpdatePricingComponentValueRequest](docs/UpdatePricingComponentValueRequest.md) + - [UpdatePricingComponentValueResponse](docs/UpdatePricingComponentValueResponse.md) + - [UpdateRatePlanAffiliateRequest](docs/UpdateRatePlanAffiliateRequest.md) - [UpdateRoleRequest](docs/UpdateRoleRequest.md) + - [UpdateSalesforceConfigurationRequest](docs/UpdateSalesforceConfigurationRequest.md) - [UpdateSubscriptionRequest](docs/UpdateSubscriptionRequest.md) - - [Usage](docs/Usage.md) - - [UsagePagedMetadata](docs/UsagePagedMetadata.md) - - [UsagePeriodPagedMetadata](docs/UsagePeriodPagedMetadata.md) - - [UsageRoundingStrategyPagedMetadata](docs/UsageRoundingStrategyPagedMetadata.md) - - [UsageSession](docs/UsageSession.md) - - [UsageSessionPagedMetadata](docs/UsageSessionPagedMetadata.md) + - [UpdateUserInfoRequest](docs/UpdateUserInfoRequest.md) + - [UpgradeCharge](docs/UpgradeCharge.md) + - [UsagePricingComponentsByChargeModel](docs/UsagePricingComponentsByChargeModel.md) - [User](docs/User.md) + - [UserCreateRequest](docs/UserCreateRequest.md) - [UserCreationRequest](docs/UserCreationRequest.md) - - [UserCreationResponsePagedMetadata](docs/UserCreationResponsePagedMetadata.md) - - [UserPagedMetadata](docs/UserPagedMetadata.md) + - [UserCreationResponse](docs/UserCreationResponse.md) + - [UserInviteRequest](docs/UserInviteRequest.md) + - [UserPrivatePermanentTokenRefreshRequest](docs/UserPrivatePermanentTokenRefreshRequest.md) + - [UserPrivatePermanentTokenRequest](docs/UserPrivatePermanentTokenRequest.md) + - [UserResponse](docs/UserResponse.md) + - [UserTimezone](docs/UserTimezone.md) - [Username](docs/Username.md) - - [UsernamePagedMetadata](docs/UsernamePagedMetadata.md) - - [WebhookPagedMetadata](docs/WebhookPagedMetadata.md) - + - [UsernameResponse](docs/UsernameResponse.md) + - [ValueIncrement](docs/ValueIncrement.md) + - [VerifyPaymentMethodRequest](docs/VerifyPaymentMethodRequest.md) + - [Webhook](docs/Webhook.md) + - [WebhookSubscription](docs/WebhookSubscription.md) + - [ZoozCaptureRequest](docs/ZoozCaptureRequest.md) + - [ZoozConfiguration](docs/ZoozConfiguration.md) + - [ZoozPayment](docs/ZoozPayment.md) ## Documentation For Authorization - All endpoints do not require authorization. +## bearerAuth -## Author +## Author +team@billforward.net diff --git a/billforward/__init__.py b/billforward/__init__.py index 99ddefb..df6d862 100644 --- a/billforward/__init__.py +++ b/billforward/__init__.py @@ -1,325 +1,514 @@ # coding: utf-8 +# flake8: noqa + """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -# import models into sdk package -from .models.api_configuration_paged_metadata import APIConfigurationPagedMetadata -from .models.api_quote import APIQuote -from .models.api_quote_paged_metadata import APIQuotePagedMetadata -from .models.api_quote_response_quantity import APIQuoteResponseQuantity -from .models.account import Account -from .models.account_ltv_result_paged_metadata import AccountLTVResultPagedMetadata -from .models.account_paged_metadata import AccountPagedMetadata -from .models.account_payments_result_paged_metadata import AccountPaymentsResultPagedMetadata -from .models.add_charge_request import AddChargeRequest -from .models.add_coupon_code_request import AddCouponCodeRequest -from .models.add_payment_method_request import AddPaymentMethodRequest -from .models.add_taxation_strategy_request import AddTaxationStrategyRequest -from .models.address import Address -from .models.address_paged_metadata import AddressPagedMetadata -from .models.aggregating_component import AggregatingComponent -from .models.alias import Alias -from .models.amendment import Amendment -from .models.amendment_discard_amendment import AmendmentDiscardAmendment -from .models.amendment_paged_metadata import AmendmentPagedMetadata -from .models.amendment_price_n_time_paged_metadata import AmendmentPriceNTimePagedMetadata -from .models.audit_entry import AuditEntry -from .models.audit_entry_paged_metadata import AuditEntryPagedMetadata -from .models.auth_capture_request import AuthCaptureRequest -from .models.authorize_net_token_paged_metadata import AuthorizeNetTokenPagedMetadata -from .models.bf_error import BFError -from .models.bf_permission import BFPermission -from .models.bf_permission_paged_metadata import BFPermissionPagedMetadata -from .models.bank_account_verification_paged_metadata import BankAccountVerificationPagedMetadata -from .models.billforward_managed_payments_result_paged_metadata import BillforwardManagedPaymentsResultPagedMetadata -from .models.billing_entity_base import BillingEntityBase -from .models.braintree_auth_capture_request import BraintreeAuthCaptureRequest -from .models.braintree_capture_request import BraintreeCaptureRequest -from .models.braintree_token_paged_metadata import BraintreeTokenPagedMetadata -from .models.cancel_subscription_request import CancelSubscriptionRequest -from .models.cancellation_amendment import CancellationAmendment -from .models.cass_churn_result_paged_metadata import CassChurnResultPagedMetadata -from .models.cass_payment_result_paged_metadata import CassPaymentResultPagedMetadata -from .models.cass_upgrade_result_paged_metadata import CassUpgradeResultPagedMetadata -from .models.client import Client -from .models.client_paged_metadata import ClientPagedMetadata -from .models.component_change import ComponentChange -from .models.component_cost import ComponentCost -from .models.compound_usage import CompoundUsage -from .models.compound_usage_session import CompoundUsageSession -from .models.coupon import Coupon -from .models.coupon_book import CouponBook -from .models.coupon_book_definition import CouponBookDefinition -from .models.coupon_book_definition_paged_metadata import CouponBookDefinitionPagedMetadata -from .models.coupon_book_paged_metadata import CouponBookPagedMetadata -from .models.coupon_definition import CouponDefinition -from .models.coupon_definition_paged_metadata import CouponDefinitionPagedMetadata -from .models.coupon_discount import CouponDiscount -from .models.coupon_discount_estimate import CouponDiscountEstimate -from .models.coupon_instance import CouponInstance -from .models.coupon_instance_existing_value import CouponInstanceExistingValue -from .models.coupon_instance_paged_metadata import CouponInstancePagedMetadata -from .models.coupon_modifier_base import CouponModifierBase -from .models.coupon_modifier_base_paged_metadata import CouponModifierBasePagedMetadata -from .models.coupon_paged_metadata import CouponPagedMetadata -from .models.coupon_rule import CouponRule -from .models.coupon_rule_paged_metadata import CouponRulePagedMetadata -from .models.coupon_unique_codes_request import CouponUniqueCodesRequest -from .models.coupon_unique_codes_response import CouponUniqueCodesResponse -from .models.coupon_unique_codes_response_paged_metadata import CouponUniqueCodesResponsePagedMetadata -from .models.coupon_wrapper_response import CouponWrapperResponse -from .models.create_account_profile_request import CreateAccountProfileRequest -from .models.create_account_request import CreateAccountRequest -from .models.create_address_request import CreateAddressRequest -from .models.create_aggregating_component_request import CreateAggregatingComponentRequest -from .models.create_aggregating_subscription_request import CreateAggregatingSubscriptionRequest -from .models.create_profile_address_request import CreateProfileAddressRequest -from .models.create_subscription_batch_request import CreateSubscriptionBatchRequest -from .models.create_subscription_charge_amendment import CreateSubscriptionChargeAmendment -from .models.create_subscription_request import CreateSubscriptionRequest -from .models.credit_account_request import CreditAccountRequest -from .models.credit_note import CreditNote -from .models.credit_note_paged_metadata import CreditNotePagedMetadata -from .models.credit_subscription_request import CreditSubscriptionRequest -from .models.cybersource_token_paged_metadata import CybersourceTokenPagedMetadata -from .models.data_synchronisation_app_configuration_paged_metadata import DataSynchronisationAppConfigurationPagedMetadata -from .models.data_synchronisation_configuration import DataSynchronisationConfiguration -from .models.data_synchronisation_configuration_paged_metadata import DataSynchronisationConfigurationPagedMetadata -from .models.data_synchronization_job_paged_metadata import DataSynchronizationJobPagedMetadata -from .models.debts_result_paged_metadata import DebtsResultPagedMetadata -from .models.dunning_line import DunningLine -from .models.dunning_line_paged_metadata import DunningLinePagedMetadata -from .models.dynamic_metadata import DynamicMetadata -from .models.email import Email -from .models.email_paged_metadata import EmailPagedMetadata -from .models.email_provider import EmailProvider -from .models.email_provider_paged_metadata import EmailProviderPagedMetadata -from .models.email_subscription import EmailSubscription -from .models.email_subscription_paged_metadata import EmailSubscriptionPagedMetadata -from .models.end_trial_amendment import EndTrialAmendment -from .models.event import Event -from .models.event_data import EventData -from .models.file_sham import FileSham -from .models.fixed_term import FixedTerm -from .models.fixed_term_definition_paged_metadata import FixedTermDefinitionPagedMetadata -from .models.fixed_term_expiry_amendment import FixedTermExpiryAmendment -from .models.fixed_term_paged_metadata import FixedTermPagedMetadata -from .models.flat_pricing_component import FlatPricingComponent -from .models.import_invoice_line import ImportInvoiceLine -from .models.insertable_billing_entity import InsertableBillingEntity -from .models.invoice import Invoice -from .models.invoice_charge_request import InvoiceChargeRequest -from .models.invoice_line import InvoiceLine -from .models.invoice_line_payment import InvoiceLinePayment -from .models.invoice_line_payment_paged_metadata import InvoiceLinePaymentPagedMetadata -from .models.invoice_next_execution_attempt_amendment import InvoiceNextExecutionAttemptAmendment -from .models.invoice_outstanding_charges_amendment import InvoiceOutstandingChargesAmendment -from .models.invoice_paged_metadata import InvoicePagedMetadata -from .models.invoice_payment import InvoicePayment -from .models.invoice_recalculation_amendment import InvoiceRecalculationAmendment -from .models.invoice_recalculation_request import InvoiceRecalculationRequest -from .models.issue_invoice_amendment import IssueInvoiceAmendment -from .models.metadata_key_values_paged_metadata import MetadataKeyValuesPagedMetadata -from .models.migration_request import MigrationRequest -from .models.mutable_billing_entity import MutableBillingEntity -from .models.notification import Notification -from .models.notification_paged_metadata import NotificationPagedMetadata -from .models.organization import Organization -from .models.organization_paged_metadata import OrganizationPagedMetadata -from .models.password import Password -from .models.password_paged_metadata import PasswordPagedMetadata -from .models.password_reset_request import PasswordResetRequest -from .models.pause_request import PauseRequest -from .models.payment import Payment -from .models.payment_method import PaymentMethod -from .models.payment_method_paged_metadata import PaymentMethodPagedMetadata -from .models.payment_method_subscription_link import PaymentMethodSubscriptionLink -from .models.payment_method_subscription_link_paged_metadata import PaymentMethodSubscriptionLinkPagedMetadata -from .models.payment_paged_metadata import PaymentPagedMetadata -from .models.payment_retry_request import PaymentRetryRequest -from .models.pending_component_value_change import PendingComponentValueChange -from .models.period import Period -from .models.period_paged_metadata import PeriodPagedMetadata -from .models.permission_action_entity_paged_metadata import PermissionActionEntityPagedMetadata -from .models.permission_resource_entity_paged_metadata import PermissionResourceEntityPagedMetadata -from .models.price_calculation_paged_metadata import PriceCalculationPagedMetadata -from .models.pricing_component import PricingComponent -from .models.pricing_component_coupon_modifier import PricingComponentCouponModifier -from .models.pricing_component_migration_value import PricingComponentMigrationValue -from .models.pricing_component_paged_metadata import PricingComponentPagedMetadata -from .models.pricing_component_quantity_request import PricingComponentQuantityRequest -from .models.pricing_component_tier import PricingComponentTier -from .models.pricing_component_tier_paged_metadata import PricingComponentTierPagedMetadata -from .models.pricing_component_value import PricingComponentValue -from .models.pricing_component_value_change_amendment import PricingComponentValueChangeAmendment -from .models.pricing_component_value_change_paged_metadata import PricingComponentValueChangePagedMetadata -from .models.pricing_component_value_migration_amendment_mapping import PricingComponentValueMigrationAmendmentMapping -from .models.pricing_component_value_paged_metadata import PricingComponentValuePagedMetadata -from .models.pricing_component_value_request import PricingComponentValueRequest -from .models.pricing_component_value_response_paged_metadata import PricingComponentValueResponsePagedMetadata -from .models.product import Product -from .models.product_coupon_modifier import ProductCouponModifier -from .models.product_paged_metadata import ProductPagedMetadata -from .models.product_payments_result_paged_metadata import ProductPaymentsResultPagedMetadata -from .models.product_rate_plan import ProductRatePlan -from .models.product_rate_plan_migration_amendment import ProductRatePlanMigrationAmendment -from .models.product_rate_plan_paged_metadata import ProductRatePlanPagedMetadata -from .models.product_rate_plan_payments_result_paged_metadata import ProductRatePlanPaymentsResultPagedMetadata -from .models.profile import Profile -from .models.profile_paged_metadata import ProfilePagedMetadata -from .models.quote_request import QuoteRequest -from .models.quote_request_value import QuoteRequestValue -from .models.recalculate_charge_request import RecalculateChargeRequest -from .models.receipt import Receipt -from .models.receipt_paged_metadata import ReceiptPagedMetadata -from .models.refund import Refund -from .models.refund_paged_metadata import RefundPagedMetadata -from .models.resume_request import ResumeRequest -from .models.resume_subscription_amendment import ResumeSubscriptionAmendment -from .models.revenue_attribution import RevenueAttribution -from .models.revenue_attribution_paged_metadata import RevenueAttributionPagedMetadata -from .models.revive_subscription_request import ReviveSubscriptionRequest -from .models.role import Role -from .models.role_paged_metadata import RolePagedMetadata -from .models.rule_satisfaction import RuleSatisfaction -from .models.search_result_paged_metadata import SearchResultPagedMetadata -from .models.service_end_amendment import ServiceEndAmendment -from .models.stripe_ach_token_paged_metadata import StripeACHTokenPagedMetadata -from .models.stripe_auth_capture_request import StripeAuthCaptureRequest -from .models.stripe_object import StripeObject -from .models.stripe_token_paged_metadata import StripeTokenPagedMetadata -from .models.subscription import Subscription -from .models.subscription_cancellation_paged_metadata import SubscriptionCancellationPagedMetadata -from .models.subscription_charge import SubscriptionCharge -from .models.subscription_charge_paged_metadata import SubscriptionChargePagedMetadata -from .models.subscription_ltv_result_paged_metadata import SubscriptionLTVResultPagedMetadata -from .models.subscription_paged_metadata import SubscriptionPagedMetadata -from .models.swagger_type_list import SwaggerTypeList -from .models.swagger_type_list_inv import SwaggerTypeListInv -from .models.swagger_type_list_subs import SwaggerTypeListSubs -from .models.taxation_link_paged_metadata import TaxationLinkPagedMetadata -from .models.taxation_strategy_paged_metadata import TaxationStrategyPagedMetadata -from .models.tiered_pricing_component import TieredPricingComponent -from .models.tiered_volume_pricing_component import TieredVolumePricingComponent -from .models.time_request import TimeRequest -from .models.time_response import TimeResponse -from .models.time_response_paged_metadata import TimeResponsePagedMetadata -from .models.time_zone import TimeZone -from .models.timer_amendment import TimerAmendment -from .models.tokenization_pre_auth_paged_metadata import TokenizationPreAuthPagedMetadata -from .models.trust_commerce_token_paged_metadata import TrustCommerceTokenPagedMetadata -from .models.unit_discount import UnitDiscount -from .models.unit_of_measure import UnitOfMeasure -from .models.unit_of_measure_coupon_modifier import UnitOfMeasureCouponModifier -from .models.unit_of_measure_paged_metadata import UnitOfMeasurePagedMetadata -from .models.update_address_request import UpdateAddressRequest -from .models.update_component_value_amendment import UpdateComponentValueAmendment -from .models.update_profile_request import UpdateProfileRequest -from .models.update_role_request import UpdateRoleRequest -from .models.update_subscription_request import UpdateSubscriptionRequest -from .models.usage import Usage -from .models.usage_paged_metadata import UsagePagedMetadata -from .models.usage_period_paged_metadata import UsagePeriodPagedMetadata -from .models.usage_rounding_strategy_paged_metadata import UsageRoundingStrategyPagedMetadata -from .models.usage_session import UsageSession -from .models.usage_session_paged_metadata import UsageSessionPagedMetadata -from .models.user import User -from .models.user_creation_request import UserCreationRequest -from .models.user_creation_response_paged_metadata import UserCreationResponsePagedMetadata -from .models.user_paged_metadata import UserPagedMetadata -from .models.username import Username -from .models.username_paged_metadata import UsernamePagedMetadata -from .models.webhook_paged_metadata import WebhookPagedMetadata - # import apis into sdk package -from .apis.accounts_api import AccountsApi -from .apis.addresses_api import AddressesApi -from .apis.amendments_api import AmendmentsApi -from .apis.analytics_api import AnalyticsApi -from .apis.auditlogs_api import AuditlogsApi -from .apis.charges_api import ChargesApi -from .apis.clients_api import ClientsApi -from .apis.configurations_api import ConfigurationsApi -from .apis.couponbook_api import CouponbookApi -from .apis.couponbookdefinition_api import CouponbookdefinitionApi -from .apis.coupondefinition_api import CoupondefinitionApi -from .apis.couponinstance_api import CouponinstanceApi -from .apis.couponmodifier_api import CouponmodifierApi -from .apis.couponrule_api import CouponruleApi -from .apis.coupons_api import CouponsApi -from .apis.creditnotes_api import CreditnotesApi -from .apis.cybersourcetokens_api import CybersourcetokensApi -from .apis.dunninglines_api import DunninglinesApi -from .apis.emailproviders_api import EmailprovidersApi -from .apis.emails_api import EmailsApi -from .apis.emailsubscriptions_api import EmailsubscriptionsApi -from .apis.fixedtermdefinitions_api import FixedtermdefinitionsApi -from .apis.fixedterms_api import FixedtermsApi -from .apis.invoices_api import InvoicesApi -from .apis.metadata_api import MetadataApi -from .apis.notifications_api import NotificationsApi -from .apis.organizations_api import OrganizationsApi -from .apis.passwords_api import PasswordsApi -from .apis.paymentmethods_api import PaymentmethodsApi -from .apis.paymentmethodsubscriptionlinks_api import PaymentmethodsubscriptionlinksApi -from .apis.payments_api import PaymentsApi -from .apis.periods_api import PeriodsApi -from .apis.permissions_api import PermissionsApi -from .apis.pricingcalculator_api import PricingcalculatorApi -from .apis.pricingcomponents_api import PricingcomponentsApi -from .apis.pricingcomponenttiers_api import PricingcomponenttiersApi -from .apis.pricingcomponentvaluechanges_api import PricingcomponentvaluechangesApi -from .apis.pricingcomponentvalues_api import PricingcomponentvaluesApi -from .apis.productrateplans_api import ProductrateplansApi -from .apis.products_api import ProductsApi -from .apis.profiles_api import ProfilesApi -from .apis.quotes_api import QuotesApi -from .apis.receipts_api import ReceiptsApi -from .apis.refunds_api import RefundsApi -from .apis.roles_api import RolesApi -from .apis.search_api import SearchApi -from .apis.subscriptions_api import SubscriptionsApi -from .apis.synch_app_configs_api import SynchAppConfigsApi -from .apis.synch_configs_api import SynchConfigsApi -from .apis.synch_jobs_api import SynchJobsApi -from .apis.taxationlinks_api import TaxationlinksApi -from .apis.taxationstrategies_api import TaxationstrategiesApi -from .apis.time_api import TimeApi -from .apis.tokenization_api import TokenizationApi -from .apis.unitofmeasure_api import UnitofmeasureApi -from .apis.usage_api import UsageApi -from .apis.usageperiods_api import UsageperiodsApi -from .apis.usageroundingstrategies_api import UsageroundingstrategiesApi -from .apis.usagesessions_api import UsagesessionsApi -from .apis.usernames_api import UsernamesApi -from .apis.users_api import UsersApi -from .apis.vaultedgateways_api import VaultedgatewaysApi -from .apis.webhooks_api import WebhooksApi - +from billforward.api.accounts_api import AccountsApi +from billforward.api.affiliation_api import AffiliationApi +from billforward.api.avatax_api import AvataxApi +from billforward.api.card_connect_api import CardConnectApi +from billforward.api.charges_api import ChargesApi +from billforward.api.checkout_api import CheckoutApi +from billforward.api.contracts_api import ContractsApi +from billforward.api.coupons_api import CouponsApi +from billforward.api.dunning_api import DunningApi +from billforward.api.ebanx_api import EBANXApi +from billforward.api.invoices_api import InvoicesApi +from billforward.api.notifications_api import NotificationsApi +from billforward.api.payment_gateway_api import PaymentGatewayApi +from billforward.api.payment_methods_api import PaymentMethodsApi +from billforward.api.payments_api import PaymentsApi +from billforward.api.permissions_api import PermissionsApi +from billforward.api.plans_api import PlansApi +from billforward.api.quotes_api import QuotesApi +from billforward.api.receipts_api import ReceiptsApi +from billforward.api.reports_api import ReportsApi +from billforward.api.salesforce_api import SalesforceApi +from billforward.api.security_api import SecurityApi +from billforward.api.subscriptions_api import SubscriptionsApi +from billforward.api.taxes_api import TaxesApi +from billforward.api.tokenization_api import TokenizationApi +from billforward.api.webhooks_api import WebhooksApi +from billforward.api.default_api import DefaultApi # import ApiClient -from .api_client import ApiClient - -from .configuration import Configuration - -configuration = Configuration() +from billforward.api_client import ApiClient +from billforward.configuration import Configuration +# import models into sdk package +from billforward.models.api_configuration import APIConfiguration +from billforward.models.api_quote_response_quantity import APIQuoteResponseQuantity +from billforward.models.account import Account +from billforward.models.add_charge_request import AddChargeRequest +from billforward.models.add_charge_response import AddChargeResponse +from billforward.models.add_charge_to_account_response import AddChargeToAccountResponse +from billforward.models.add_charges_to_account_api_request import AddChargesToAccountAPIRequest +from billforward.models.add_contract_period_request import AddContractPeriodRequest +from billforward.models.add_coupon_code_request import AddCouponCodeRequest +from billforward.models.add_payment_method_request import AddPaymentMethodRequest +from billforward.models.additional_data import AdditionalData +from billforward.models.address import Address +from billforward.models.advance_pricing_components_by_charge_model import AdvancePricingComponentsByChargeModel +from billforward.models.affiliate import Affiliate +from billforward.models.affiliate_commission_charge import AffiliateCommissionCharge +from billforward.models.affiliate_rate_plan_relationships import AffiliateRatePlanRelationships +from billforward.models.affiliate_subscription_relationship import AffiliateSubscriptionRelationship +from billforward.models.aggregating_component_description import AggregatingComponentDescription +from billforward.models.allowed_webhook_subscription_values import AllowedWebhookSubscriptionValues +from billforward.models.amendment import Amendment +from billforward.models.amendment_discard_amendment import AmendmentDiscardAmendment +from billforward.models.api_quote import ApiQuote +from billforward.models.arrears_charge import ArrearsCharge +from billforward.models.arrears_pricing_components_by_charge_model import ArrearsPricingComponentsByChargeModel +from billforward.models.auth_capture_request import AuthCaptureRequest +from billforward.models.authorize_net_configuration import AuthorizeNetConfiguration +from billforward.models.authorize_net_payment import AuthorizeNetPayment +from billforward.models.authorize_net_token import AuthorizeNetToken +from billforward.models.avatax_config_request import AvataxConfigRequest +from billforward.models.avatax_configuration import AvataxConfiguration +from billforward.models.avatax_ping_request import AvataxPingRequest +from billforward.models.avatax_ping_response import AvataxPingResponse +from billforward.models.bf_permission import BFPermission +from billforward.models.bank_account import BankAccount +from billforward.models.batch_increment_values_request import BatchIncrementValuesRequest +from billforward.models.batch_update_pricing_component_values_request import BatchUpdatePricingComponentValuesRequest +from billforward.models.billing_entity_base import BillingEntityBase +from billforward.models.braintree_auth_capture_request import BraintreeAuthCaptureRequest +from billforward.models.braintree_capture_request import BraintreeCaptureRequest +from billforward.models.braintree_configuration import BraintreeConfiguration +from billforward.models.braintree_merchant_account import BraintreeMerchantAccount +from billforward.models.braintree_payment import BraintreePayment +from billforward.models.braintree_pre_auth_request import BraintreePreAuthRequest +from billforward.models.braintree_token import BraintreeToken +from billforward.models.calculator_result import CalculatorResult +from billforward.models.cancellation_amendment import CancellationAmendment +from billforward.models.card_connect_auth_capture_request import CardConnectAuthCaptureRequest +from billforward.models.card_connect_configuration import CardConnectConfiguration +from billforward.models.card_connect_gateway_request import CardConnectGatewayRequest +from billforward.models.card_connect_payment import CardConnectPayment +from billforward.models.commission_structure import CommissionStructure +from billforward.models.component_change import ComponentChange +from billforward.models.contract import Contract +from billforward.models.contract_period import ContractPeriod +from billforward.models.coupon import Coupon +from billforward.models.coupon_charge import CouponCharge +from billforward.models.coupon_code_response import CouponCodeResponse +from billforward.models.coupon_discount import CouponDiscount +from billforward.models.coupon_instance import CouponInstance +from billforward.models.coupon_instance_existing_value import CouponInstanceExistingValue +from billforward.models.coupon_payment import CouponPayment +from billforward.models.coupon_unique_codes_request import CouponUniqueCodesRequest +from billforward.models.coupon_unique_codes_response import CouponUniqueCodesResponse +from billforward.models.coupon_wrapper_response import CouponWrapperResponse +from billforward.models.create_aggregating_component_request import CreateAggregatingComponentRequest +from billforward.models.create_aggregating_subscription_request import CreateAggregatingSubscriptionRequest +from billforward.models.create_commission_invoice_request import CreateCommissionInvoiceRequest +from billforward.models.create_contract_period_request import CreateContractPeriodRequest +from billforward.models.create_contract_request import CreateContractRequest +from billforward.models.create_coupon_discount_request import CreateCouponDiscountRequest +from billforward.models.create_coupon_request import CreateCouponRequest +from billforward.models.create_offline_payment_request import CreateOfflinePaymentRequest +from billforward.models.create_permission_on_role_request import CreatePermissionOnRoleRequest +from billforward.models.create_permission_request import CreatePermissionRequest +from billforward.models.create_pricing_component_quantity_request import CreatePricingComponentQuantityRequest +from billforward.models.create_profile_request import CreateProfileRequest +from billforward.models.create_role_request import CreateRoleRequest +from billforward.models.create_salesforce_configuration_request import CreateSalesforceConfigurationRequest +from billforward.models.create_subscription_batch_request import CreateSubscriptionBatchRequest +from billforward.models.create_subscription_charge_amendment import CreateSubscriptionChargeAmendment +from billforward.models.create_subscription_checkout_definition_request import CreateSubscriptionCheckoutDefinitionRequest +from billforward.models.create_subscription_request import CreateSubscriptionRequest +from billforward.models.create_subscription_timer_request import CreateSubscriptionTimerRequest +from billforward.models.create_totp_request import CreateTOTPRequest +from billforward.models.credit_account_request import CreditAccountRequest +from billforward.models.credit_note import CreditNote +from billforward.models.credit_note_currency import CreditNoteCurrency +from billforward.models.credit_note_payment import CreditNotePayment +from billforward.models.credit_subscription_request import CreditSubscriptionRequest +from billforward.models.cybersource_configuration import CybersourceConfiguration +from billforward.models.cybersource_payment import CybersourcePayment +from billforward.models.data_sync_job_error_response import DataSyncJobErrorResponse +from billforward.models.data_sync_job_response import DataSyncJobResponse +from billforward.models.dunning_line import DunningLine +from billforward.models.ebanx_auth_capture_request import EBANXAuthCaptureRequest +from billforward.models.ebanx_configuration import EBANXConfiguration +from billforward.models.ebanx_gateway_request import EBANXGatewayRequest +from billforward.models.ebanx_payment import EBANXPayment +from billforward.models.ebanx_webhook import EBANXWebhook +from billforward.models.email_tokenization import EmailTokenization +from billforward.models.email_tokenization_create_api_request import EmailTokenizationCreateAPIRequest +from billforward.models.email_tokenization_send_api_request import EmailTokenizationSendAPIRequest +from billforward.models.email_tokenization_update_api_request import EmailTokenizationUpdateAPIRequest +from billforward.models.end_trial_amendment import EndTrialAmendment +from billforward.models.epx_capture_request import EpxCaptureRequest +from billforward.models.epx_configuration import EpxConfiguration +from billforward.models.epx_payment import EpxPayment +from billforward.models.epx_pre_auth_request import EpxPreAuthRequest +from billforward.models.epx_pre_auth_response import EpxPreAuthResponse +from billforward.models.execution_receipt_response import ExecutionReceiptResponse +from billforward.models.execution_response import ExecutionResponse +from billforward.models.extras import Extras +from billforward.models.fixed_term import FixedTerm +from billforward.models.fixed_term_definition import FixedTermDefinition +from billforward.models.fixed_term_expiry_amendment import FixedTermExpiryAmendment +from billforward.models.flat_advance_pricing_component import FlatAdvancePricingComponent +from billforward.models.flat_arrears_pricing_component import FlatArrearsPricingComponent +from billforward.models.flat_pricing_component import FlatPricingComponent +from billforward.models.flat_setup_pricing_component import FlatSetupPricingComponent +from billforward.models.flat_usage_pricing_component import FlatUsagePricingComponent +from billforward.models.get_rate_plan_affiliate_response import GetRatePlanAffiliateResponse +from billforward.models.get_subscription_affiliate_response import GetSubscriptionAffiliateResponse +from billforward.models.go_cardless_configuration import GoCardlessConfiguration +from billforward.models.go_cardless_tokenization_request import GoCardlessTokenizationRequest +from billforward.models.halt_aggregation_request import HaltAggregationRequest +from billforward.models.halt_aggregation_response import HaltAggregationResponse +from billforward.models.hosted_payment import HostedPayment +from billforward.models.hosted_payment_config import HostedPaymentConfig +from billforward.models.i_discardable import IDiscardable +from billforward.models.import_invoice_line import ImportInvoiceLine +from billforward.models.import_invoice_request import ImportInvoiceRequest +from billforward.models.import_subscription_request import ImportSubscriptionRequest +from billforward.models.inline_response_default import InlineResponseDefault +from billforward.models.inline_response_default1 import InlineResponseDefault1 +from billforward.models.inline_response_default10 import InlineResponseDefault10 +from billforward.models.inline_response_default100 import InlineResponseDefault100 +from billforward.models.inline_response_default101 import InlineResponseDefault101 +from billforward.models.inline_response_default102 import InlineResponseDefault102 +from billforward.models.inline_response_default103 import InlineResponseDefault103 +from billforward.models.inline_response_default11 import InlineResponseDefault11 +from billforward.models.inline_response_default12 import InlineResponseDefault12 +from billforward.models.inline_response_default13 import InlineResponseDefault13 +from billforward.models.inline_response_default14 import InlineResponseDefault14 +from billforward.models.inline_response_default15 import InlineResponseDefault15 +from billforward.models.inline_response_default16 import InlineResponseDefault16 +from billforward.models.inline_response_default17 import InlineResponseDefault17 +from billforward.models.inline_response_default18 import InlineResponseDefault18 +from billforward.models.inline_response_default19 import InlineResponseDefault19 +from billforward.models.inline_response_default2 import InlineResponseDefault2 +from billforward.models.inline_response_default20 import InlineResponseDefault20 +from billforward.models.inline_response_default21 import InlineResponseDefault21 +from billforward.models.inline_response_default22 import InlineResponseDefault22 +from billforward.models.inline_response_default23 import InlineResponseDefault23 +from billforward.models.inline_response_default24 import InlineResponseDefault24 +from billforward.models.inline_response_default25 import InlineResponseDefault25 +from billforward.models.inline_response_default26 import InlineResponseDefault26 +from billforward.models.inline_response_default27 import InlineResponseDefault27 +from billforward.models.inline_response_default28 import InlineResponseDefault28 +from billforward.models.inline_response_default29 import InlineResponseDefault29 +from billforward.models.inline_response_default3 import InlineResponseDefault3 +from billforward.models.inline_response_default30 import InlineResponseDefault30 +from billforward.models.inline_response_default31 import InlineResponseDefault31 +from billforward.models.inline_response_default32 import InlineResponseDefault32 +from billforward.models.inline_response_default33 import InlineResponseDefault33 +from billforward.models.inline_response_default34 import InlineResponseDefault34 +from billforward.models.inline_response_default35 import InlineResponseDefault35 +from billforward.models.inline_response_default36 import InlineResponseDefault36 +from billforward.models.inline_response_default37 import InlineResponseDefault37 +from billforward.models.inline_response_default38 import InlineResponseDefault38 +from billforward.models.inline_response_default39 import InlineResponseDefault39 +from billforward.models.inline_response_default4 import InlineResponseDefault4 +from billforward.models.inline_response_default40 import InlineResponseDefault40 +from billforward.models.inline_response_default41 import InlineResponseDefault41 +from billforward.models.inline_response_default42 import InlineResponseDefault42 +from billforward.models.inline_response_default43 import InlineResponseDefault43 +from billforward.models.inline_response_default44 import InlineResponseDefault44 +from billforward.models.inline_response_default45 import InlineResponseDefault45 +from billforward.models.inline_response_default46 import InlineResponseDefault46 +from billforward.models.inline_response_default47 import InlineResponseDefault47 +from billforward.models.inline_response_default48 import InlineResponseDefault48 +from billforward.models.inline_response_default49 import InlineResponseDefault49 +from billforward.models.inline_response_default5 import InlineResponseDefault5 +from billforward.models.inline_response_default50 import InlineResponseDefault50 +from billforward.models.inline_response_default51 import InlineResponseDefault51 +from billforward.models.inline_response_default52 import InlineResponseDefault52 +from billforward.models.inline_response_default53 import InlineResponseDefault53 +from billforward.models.inline_response_default54 import InlineResponseDefault54 +from billforward.models.inline_response_default55 import InlineResponseDefault55 +from billforward.models.inline_response_default56 import InlineResponseDefault56 +from billforward.models.inline_response_default57 import InlineResponseDefault57 +from billforward.models.inline_response_default58 import InlineResponseDefault58 +from billforward.models.inline_response_default59 import InlineResponseDefault59 +from billforward.models.inline_response_default6 import InlineResponseDefault6 +from billforward.models.inline_response_default60 import InlineResponseDefault60 +from billforward.models.inline_response_default61 import InlineResponseDefault61 +from billforward.models.inline_response_default62 import InlineResponseDefault62 +from billforward.models.inline_response_default63 import InlineResponseDefault63 +from billforward.models.inline_response_default64 import InlineResponseDefault64 +from billforward.models.inline_response_default65 import InlineResponseDefault65 +from billforward.models.inline_response_default66 import InlineResponseDefault66 +from billforward.models.inline_response_default67 import InlineResponseDefault67 +from billforward.models.inline_response_default68 import InlineResponseDefault68 +from billforward.models.inline_response_default69 import InlineResponseDefault69 +from billforward.models.inline_response_default7 import InlineResponseDefault7 +from billforward.models.inline_response_default70 import InlineResponseDefault70 +from billforward.models.inline_response_default71 import InlineResponseDefault71 +from billforward.models.inline_response_default72 import InlineResponseDefault72 +from billforward.models.inline_response_default73 import InlineResponseDefault73 +from billforward.models.inline_response_default74 import InlineResponseDefault74 +from billforward.models.inline_response_default75 import InlineResponseDefault75 +from billforward.models.inline_response_default76 import InlineResponseDefault76 +from billforward.models.inline_response_default77 import InlineResponseDefault77 +from billforward.models.inline_response_default78 import InlineResponseDefault78 +from billforward.models.inline_response_default79 import InlineResponseDefault79 +from billforward.models.inline_response_default8 import InlineResponseDefault8 +from billforward.models.inline_response_default80 import InlineResponseDefault80 +from billforward.models.inline_response_default81 import InlineResponseDefault81 +from billforward.models.inline_response_default82 import InlineResponseDefault82 +from billforward.models.inline_response_default83 import InlineResponseDefault83 +from billforward.models.inline_response_default84 import InlineResponseDefault84 +from billforward.models.inline_response_default85 import InlineResponseDefault85 +from billforward.models.inline_response_default86 import InlineResponseDefault86 +from billforward.models.inline_response_default87 import InlineResponseDefault87 +from billforward.models.inline_response_default88 import InlineResponseDefault88 +from billforward.models.inline_response_default89 import InlineResponseDefault89 +from billforward.models.inline_response_default9 import InlineResponseDefault9 +from billforward.models.inline_response_default90 import InlineResponseDefault90 +from billforward.models.inline_response_default91 import InlineResponseDefault91 +from billforward.models.inline_response_default92 import InlineResponseDefault92 +from billforward.models.inline_response_default93 import InlineResponseDefault93 +from billforward.models.inline_response_default94 import InlineResponseDefault94 +from billforward.models.inline_response_default95 import InlineResponseDefault95 +from billforward.models.inline_response_default96 import InlineResponseDefault96 +from billforward.models.inline_response_default97 import InlineResponseDefault97 +from billforward.models.inline_response_default98 import InlineResponseDefault98 +from billforward.models.inline_response_default99 import InlineResponseDefault99 +from billforward.models.interval_date import IntervalDate +from billforward.models.invoice import Invoice +from billforward.models.invoice_charge_request import InvoiceChargeRequest +from billforward.models.invoice_execution_request import InvoiceExecutionRequest +from billforward.models.invoice_line_payments import InvoiceLinePayments +from billforward.models.invoice_lines import InvoiceLines +from billforward.models.invoice_next_execution_attempt_amendment import InvoiceNextExecutionAttemptAmendment +from billforward.models.invoice_outstanding_charges_amendment import InvoiceOutstandingChargesAmendment +from billforward.models.invoice_payments import InvoicePayments +from billforward.models.invoice_recalculation_amendment import InvoiceRecalculationAmendment +from billforward.models.invoice_recalculation_request import InvoiceRecalculationRequest +from billforward.models.invoice_refund_request import InvoiceRefundRequest +from billforward.models.invoice_refund_response import InvoiceRefundResponse +from billforward.models.invoice_split import InvoiceSplit +from billforward.models.invoice_split_service_request import InvoiceSplitServiceRequest +from billforward.models.invoice_template_config_response import InvoiceTemplateConfigResponse +from billforward.models.issue_invoice_amendment import IssueInvoiceAmendment +from billforward.models.issue_invoice_request import IssueInvoiceRequest +from billforward.models.issue_invoice_response import IssueInvoiceResponse +from billforward.models.kash_configuration import KashConfiguration +from billforward.models.legacy_create_webhook_request import LegacyCreateWebhookRequest +from billforward.models.manual_charge import ManualCharge +from billforward.models.marketplace_quote import MarketplaceQuote +from billforward.models.metadata import Metadata +from billforward.models.metadata_key_values import MetadataKeyValues +from billforward.models.migration import Migration +from billforward.models.migration_request import MigrationRequest +from billforward.models.migration_response import MigrationResponse +from billforward.models.nested_adhoc_charge_request import NestedAdhocChargeRequest +from billforward.models.nested_charge_request import NestedChargeRequest +from billforward.models.notification_send_request import NotificationSendRequest +from billforward.models.notification_send_response import NotificationSendResponse +from billforward.models.notifications import Notifications +from billforward.models.o_auth_token import OAuthToken +from billforward.models.offline_payment import OfflinePayment +from billforward.models.open_id_registration_response import OpenIDRegistrationResponse +from billforward.models.open_id_user_link_request import OpenIdUserLinkRequest +from billforward.models.organization_lite_view import OrganizationLiteView +from billforward.models.password import Password +from billforward.models.password_reset_code_request import PasswordResetCodeRequest +from billforward.models.password_reset_response import PasswordResetResponse +from billforward.models.password_update_with_reset_code_request import PasswordUpdateWithResetCodeRequest +from billforward.models.pause_request import PauseRequest +from billforward.models.pay_vision_auth_capture_request import PayVisionAuthCaptureRequest +from billforward.models.pay_vision_configuration import PayVisionConfiguration +from billforward.models.pay_vision_pre_auth_request import PayVisionPreAuthRequest +from billforward.models.payment import Payment +from billforward.models.payment_accounting_view import PaymentAccountingView +from billforward.models.payment_method import PaymentMethod +from billforward.models.payment_method_subscription_link import PaymentMethodSubscriptionLink +from billforward.models.payment_refund_request import PaymentRefundRequest +from billforward.models.payment_refund_response import PaymentRefundResponse +from billforward.models.payment_retry_request import PaymentRetryRequest +from billforward.models.paypal_configuration import PaypalConfiguration +from billforward.models.paypal_payment import PaypalPayment +from billforward.models.pending_component_value_change import PendingComponentValueChange +from billforward.models.permission_action_entity import PermissionActionEntity +from billforward.models.permission_resource_entity import PermissionResourceEntity +from billforward.models.plan_aggregation import PlanAggregation +from billforward.models.plan_request import PlanRequest +from billforward.models.plan_response import PlanResponse +from billforward.models.prepayment_charge import PrepaymentCharge +from billforward.models.price_breakdown import PriceBreakdown +from billforward.models.price_line import PriceLine +from billforward.models.pricing_component import PricingComponent +from billforward.models.pricing_component_charge import PricingComponentCharge +from billforward.models.pricing_component_migration_value import PricingComponentMigrationValue +from billforward.models.pricing_component_tier import PricingComponentTier +from billforward.models.pricing_component_value import PricingComponentValue +from billforward.models.pricing_component_value_amendment import PricingComponentValueAmendment +from billforward.models.pricing_component_value_change import PricingComponentValueChange +from billforward.models.pricing_component_value_migration_amendment_mapping import PricingComponentValueMigrationAmendmentMapping +from billforward.models.pricing_component_value_request import PricingComponentValueRequest +from billforward.models.pricing_component_value_response import PricingComponentValueResponse +from billforward.models.pricing_components_by_charge_type import PricingComponentsByChargeType +from billforward.models.pricing_tier import PricingTier +from billforward.models.product_rate_plan_migration_amendment import ProductRatePlanMigrationAmendment +from billforward.models.product_rate_plan_migration_charge import ProductRatePlanMigrationCharge +from billforward.models.profile import Profile +from billforward.models.public_configuration_response import PublicConfigurationResponse +from billforward.models.quote_request import QuoteRequest +from billforward.models.quote_request_value import QuoteRequestValue +from billforward.models.recalculate_charge_batch_request import RecalculateChargeBatchRequest +from billforward.models.recalculate_charge_batch_response import RecalculateChargeBatchResponse +from billforward.models.recalculate_charge_request import RecalculateChargeRequest +from billforward.models.receipt import Receipt +from billforward.models.refund import Refund +from billforward.models.refund_accounting_view import RefundAccountingView +from billforward.models.remove_credit_account_request import RemoveCreditAccountRequest +from billforward.models.resume_request import ResumeRequest +from billforward.models.resume_subscription_amendment import ResumeSubscriptionAmendment +from billforward.models.revenue_attributions import RevenueAttributions +from billforward.models.role import Role +from billforward.models.sage_pay_auth_capture_request import SagePayAuthCaptureRequest +from billforward.models.sage_pay_card_payment import SagePayCardPayment +from billforward.models.sage_pay_configuration import SagePayConfiguration +from billforward.models.sage_pay_enabled_card_type import SagePayEnabledCardType +from billforward.models.sage_pay_pre_auth_request import SagePayPreAuthRequest +from billforward.models.salesforce_configuration_response import SalesforceConfigurationResponse +from billforward.models.service_end_amendment import ServiceEndAmendment +from billforward.models.set_rate_plan_affiliate_request import SetRatePlanAffiliateRequest +from billforward.models.set_subscription_affiliate_request import SetSubscriptionAffiliateRequest +from billforward.models.setup_charge import SetupCharge +from billforward.models.setup_pricing_components_by_charge_model import SetupPricingComponentsByChargeModel +from billforward.models.shuttle_auth_capture_request import ShuttleAuthCaptureRequest +from billforward.models.shuttle_configuration import ShuttleConfiguration +from billforward.models.shuttle_payment import ShuttlePayment +from billforward.models.shuttle_pre_auth_request import ShuttlePreAuthRequest +from billforward.models.simple_date_param import SimpleDateParam +from billforward.models.simple_user import SimpleUser +from billforward.models.single_recalculate_charge_request import SingleRecalculateChargeRequest +from billforward.models.spreedly_auth_capture_request import SpreedlyAuthCaptureRequest +from billforward.models.spreedly_configuration import SpreedlyConfiguration +from billforward.models.spreedly_pre_auth_request import SpreedlyPreAuthRequest +from billforward.models.square_auth_capture_request import SquareAuthCaptureRequest +from billforward.models.square_configuration import SquareConfiguration +from billforward.models.square_configuration_data import SquareConfigurationData +from billforward.models.square_data import SquareData +from billforward.models.square_payment import SquarePayment +from billforward.models.square_subscription import SquareSubscription +from billforward.models.start_all_subscriptions_request import StartAllSubscriptionsRequest +from billforward.models.start_all_subscriptions_response import StartAllSubscriptionsResponse +from billforward.models.start_contract_request import StartContractRequest +from billforward.models.start_contract_response import StartContractResponse +from billforward.models.stripe_ach_capture_request import StripeACHCaptureRequest +from billforward.models.stripe_ach_payment import StripeACHPayment +from billforward.models.stripe_ach_token import StripeAchToken +from billforward.models.stripe_additional_data import StripeAdditionalData +from billforward.models.stripe_auth_capture_request import StripeAuthCaptureRequest +from billforward.models.stripe_card_payment import StripeCardPayment +from billforward.models.stripe_configuration import StripeConfiguration +from billforward.models.stripe_pre_auth_request import StripePreAuthRequest +from billforward.models.stripe_token import StripeToken +from billforward.models.subscription import Subscription +from billforward.models.subscription_cancellation import SubscriptionCancellation +from billforward.models.subscription_charge import SubscriptionCharge +from billforward.models.subscription_checkout_action_request import SubscriptionCheckoutActionRequest +from billforward.models.subscription_checkout_definition_description import SubscriptionCheckoutDefinitionDescription +from billforward.models.subscription_checkout_response import SubscriptionCheckoutResponse +from billforward.models.subscription_revive_amendment import SubscriptionReviveAmendment +from billforward.models.subscription_revive_partial_request import SubscriptionRevivePartialRequest +from billforward.models.subscription_revive_request import SubscriptionReviveRequest +from billforward.models.swagger_type_list_inv import SwaggerTypeListInv +from billforward.models.swagger_type_list_subs import SwaggerTypeListSubs +from billforward.models.sync_action_request import SyncActionRequest +from billforward.models.tax_line import TaxLine +from billforward.models.taxation_strategy import TaxationStrategy +from billforward.models.tiered_advance_pricing_component import TieredAdvancePricingComponent +from billforward.models.tiered_arrears_pricing_component import TieredArrearsPricingComponent +from billforward.models.tiered_pricing_component import TieredPricingComponent +from billforward.models.tiered_setup_pricing_component import TieredSetupPricingComponent +from billforward.models.tiered_usage_pricing_component import TieredUsagePricingComponent +from billforward.models.tiered_volume_pricing_component import TieredVolumePricingComponent +from billforward.models.time_request import TimeRequest +from billforward.models.time_response import TimeResponse +from billforward.models.timer_amendment import TimerAmendment +from billforward.models.tokenization_epxredirect_body import TokenizationEpxredirectBody +from billforward.models.tokenization_payvisionshoutv1_body import TokenizationPayvisionshoutv1Body +from billforward.models.tokenization_pre_auth import TokenizationPreAuth +from billforward.models.tokenization_pre_auth_request import TokenizationPreAuthRequest +from billforward.models.tokenization_sagepaynotifyv300_body import TokenizationSagepaynotifyv300Body +from billforward.models.tokens_response import TokensResponse +from billforward.models.trust_commerce_configuration import TrustCommerceConfiguration +from billforward.models.trust_commerce_token import TrustCommerceToken +from billforward.models.typed_query_result_wrapper_api_quote import TypedQueryResultWrapperAPIQuote +from billforward.models.typed_query_result_wrapper_account import TypedQueryResultWrapperAccount +from billforward.models.typed_query_result_wrapper_address import TypedQueryResultWrapperAddress +from billforward.models.typed_query_result_wrapper_amendment import TypedQueryResultWrapperAmendment +from billforward.models.typed_query_result_wrapper_avatax_configuration import TypedQueryResultWrapperAvataxConfiguration +from billforward.models.typed_query_result_wrapper_bf_permission import TypedQueryResultWrapperBFPermission +from billforward.models.typed_query_result_wrapper_braintree_token import TypedQueryResultWrapperBraintreeToken +from billforward.models.typed_query_result_wrapper_contract import TypedQueryResultWrapperContract +from billforward.models.typed_query_result_wrapper_coupon import TypedQueryResultWrapperCoupon +from billforward.models.typed_query_result_wrapper_credit_note import TypedQueryResultWrapperCreditNote +from billforward.models.typed_query_result_wrapper_data_sync_job_response import TypedQueryResultWrapperDataSyncJobResponse +from billforward.models.typed_query_result_wrapper_dunning_line import TypedQueryResultWrapperDunningLine +from billforward.models.typed_query_result_wrapper_invoice import TypedQueryResultWrapperInvoice +from billforward.models.typed_query_result_wrapper_invoice_line_payment import TypedQueryResultWrapperInvoiceLinePayment +from billforward.models.typed_query_result_wrapper_notification import TypedQueryResultWrapperNotification +from billforward.models.typed_query_result_wrapper_payment import TypedQueryResultWrapperPayment +from billforward.models.typed_query_result_wrapper_payment_method import TypedQueryResultWrapperPaymentMethod +from billforward.models.typed_query_result_wrapper_plan_response import TypedQueryResultWrapperPlanResponse +from billforward.models.typed_query_result_wrapper_profile import TypedQueryResultWrapperProfile +from billforward.models.typed_query_result_wrapper_receipt import TypedQueryResultWrapperReceipt +from billforward.models.typed_query_result_wrapper_refund import TypedQueryResultWrapperRefund +from billforward.models.typed_query_result_wrapper_revenue_attribution import TypedQueryResultWrapperRevenueAttribution +from billforward.models.typed_query_result_wrapper_role import TypedQueryResultWrapperRole +from billforward.models.typed_query_result_wrapper_stripe_ach_token import TypedQueryResultWrapperStripeACHToken +from billforward.models.typed_query_result_wrapper_stripe_token import TypedQueryResultWrapperStripeToken +from billforward.models.typed_query_result_wrapper_subscription import TypedQueryResultWrapperSubscription +from billforward.models.typed_query_result_wrapper_subscription_charge import TypedQueryResultWrapperSubscriptionCharge +from billforward.models.typed_query_result_wrapper_taxation_strategy import TypedQueryResultWrapperTaxationStrategy +from billforward.models.typed_query_result_wrapper_user_response import TypedQueryResultWrapperUserResponse +from billforward.models.typed_query_result_wrapper_webhook import TypedQueryResultWrapperWebhook +from billforward.models.unit_of_measure import UnitOfMeasure +from billforward.models.update_component_value_amendment import UpdateComponentValueAmendment +from billforward.models.update_contract_request import UpdateContractRequest +from billforward.models.update_email_request import UpdateEmailRequest +from billforward.models.update_invoice_request import UpdateInvoiceRequest +from billforward.models.update_invoice_template_request import UpdateInvoiceTemplateRequest +from billforward.models.update_password_request import UpdatePasswordRequest +from billforward.models.update_password_response import UpdatePasswordResponse +from billforward.models.update_pricing_component_value_change_result import UpdatePricingComponentValueChangeResult +from billforward.models.update_pricing_component_value_request import UpdatePricingComponentValueRequest +from billforward.models.update_pricing_component_value_response import UpdatePricingComponentValueResponse +from billforward.models.update_rate_plan_affiliate_request import UpdateRatePlanAffiliateRequest +from billforward.models.update_role_request import UpdateRoleRequest +from billforward.models.update_salesforce_configuration_request import UpdateSalesforceConfigurationRequest +from billforward.models.update_subscription_request import UpdateSubscriptionRequest +from billforward.models.update_user_info_request import UpdateUserInfoRequest +from billforward.models.upgrade_charge import UpgradeCharge +from billforward.models.usage_pricing_components_by_charge_model import UsagePricingComponentsByChargeModel +from billforward.models.user import User +from billforward.models.user_create_request import UserCreateRequest +from billforward.models.user_creation_request import UserCreationRequest +from billforward.models.user_creation_response import UserCreationResponse +from billforward.models.user_invite_request import UserInviteRequest +from billforward.models.user_private_permanent_token_refresh_request import UserPrivatePermanentTokenRefreshRequest +from billforward.models.user_private_permanent_token_request import UserPrivatePermanentTokenRequest +from billforward.models.user_response import UserResponse +from billforward.models.user_timezone import UserTimezone +from billforward.models.username import Username +from billforward.models.username_response import UsernameResponse +from billforward.models.value_increment import ValueIncrement +from billforward.models.verify_payment_method_request import VerifyPaymentMethodRequest +from billforward.models.webhook import Webhook +from billforward.models.webhook_subscription import WebhookSubscription +from billforward.models.zooz_capture_request import ZoozCaptureRequest +from billforward.models.zooz_configuration import ZoozConfiguration +from billforward.models.zooz_payment import ZoozPayment diff --git a/billforward/api/__init__.py b/billforward/api/__init__.py new file mode 100644 index 0000000..8c989a7 --- /dev/null +++ b/billforward/api/__init__.py @@ -0,0 +1,32 @@ +from __future__ import absolute_import + +# flake8: noqa + +# import apis into api package +from billforward.api.accounts_api import AccountsApi +from billforward.api.affiliation_api import AffiliationApi +from billforward.api.avatax_api import AvataxApi +from billforward.api.card_connect_api import CardConnectApi +from billforward.api.charges_api import ChargesApi +from billforward.api.checkout_api import CheckoutApi +from billforward.api.contracts_api import ContractsApi +from billforward.api.coupons_api import CouponsApi +from billforward.api.dunning_api import DunningApi +from billforward.api.ebanx_api import EBANXApi +from billforward.api.invoices_api import InvoicesApi +from billforward.api.notifications_api import NotificationsApi +from billforward.api.payment_gateway_api import PaymentGatewayApi +from billforward.api.payment_methods_api import PaymentMethodsApi +from billforward.api.payments_api import PaymentsApi +from billforward.api.permissions_api import PermissionsApi +from billforward.api.plans_api import PlansApi +from billforward.api.quotes_api import QuotesApi +from billforward.api.receipts_api import ReceiptsApi +from billforward.api.reports_api import ReportsApi +from billforward.api.salesforce_api import SalesforceApi +from billforward.api.security_api import SecurityApi +from billforward.api.subscriptions_api import SubscriptionsApi +from billforward.api.taxes_api import TaxesApi +from billforward.api.tokenization_api import TokenizationApi +from billforward.api.webhooks_api import WebhooksApi +from billforward.api.default_api import DefaultApi diff --git a/billforward/api/accounts_api.py b/billforward/api/accounts_api.py new file mode 100644 index 0000000..26f655d --- /dev/null +++ b/billforward/api/accounts_api.py @@ -0,0 +1,1997 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class AccountsApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def add_charge_to_account(self, account_id, **kwargs): # noqa: E501 + """add_charge_to_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_charge_to_account(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param AddChargesToAccountAPIRequest body: + :return: InlineResponseDefault2 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.add_charge_to_account_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.add_charge_to_account_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def add_charge_to_account_with_http_info(self, account_id, **kwargs): # noqa: E501 + """add_charge_to_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_charge_to_account_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param AddChargesToAccountAPIRequest body: + :return: InlineResponseDefault2 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method add_charge_to_account" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `add_charge_to_account`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}/invoice', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault2', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def add_credit_note_to_account(self, account_id, **kwargs): # noqa: E501 + """add_credit_note_to_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_credit_note_to_account(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param CreditAccountRequest body: + :return: InlineResponseDefault4 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.add_credit_note_to_account_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.add_credit_note_to_account_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def add_credit_note_to_account_with_http_info(self, account_id, **kwargs): # noqa: E501 + """add_credit_note_to_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_credit_note_to_account_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param CreditAccountRequest body: + :return: InlineResponseDefault4 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method add_credit_note_to_account" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `add_credit_note_to_account`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}/credit', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault4', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_account(self, **kwargs): # noqa: E501 + """create_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_account(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Account body: + :return: InlineResponseDefault6 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_account_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_account_with_http_info(**kwargs) # noqa: E501 + return data + + def create_account_with_http_info(self, **kwargs): # noqa: E501 + """create_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_account_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Account body: + :return: InlineResponseDefault6 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_account" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault6', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_address(self, **kwargs): # noqa: E501 + """create_address # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_address(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Address body: + :return: InlineResponseDefault12 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_address_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_address_with_http_info(**kwargs) # noqa: E501 + return data + + def create_address_with_http_info(self, **kwargs): # noqa: E501 + """create_address # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_address_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Address body: + :return: InlineResponseDefault12 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_address" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/addresses', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault12', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def delete_account(self, account_id, **kwargs): # noqa: E501 + """delete_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_account(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param bool delete_gateway_data: + :param bool delete_personal_data: + :param list[str] organizations: + :return: InlineResponseDefault6 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.delete_account_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.delete_account_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def delete_account_with_http_info(self, account_id, **kwargs): # noqa: E501 + """delete_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_account_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param bool delete_gateway_data: + :param bool delete_personal_data: + :param list[str] organizations: + :return: InlineResponseDefault6 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'delete_gateway_data', 'delete_personal_data', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_account" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `delete_account`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'delete_gateway_data' in params: + query_params.append(('delete_gateway_data', params['delete_gateway_data'])) # noqa: E501 + if 'delete_personal_data' in params: + query_params.append(('delete_personal_data', params['delete_personal_data'])) # noqa: E501 + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault6', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def delete_metadata_for_account(self, account_id, **kwargs): # noqa: E501 + """delete_metadata_for_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_metadata_for_account(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.delete_metadata_for_account_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.delete_metadata_for_account_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def delete_metadata_for_account_with_http_info(self, account_id, **kwargs): # noqa: E501 + """delete_metadata_for_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_metadata_for_account_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_metadata_for_account" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `delete_metadata_for_account`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}/metadata', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault7', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_account_by_id(self, account_id, **kwargs): # noqa: E501 + """get_account_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_account_by_id(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault6 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_account_by_id_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.get_account_by_id_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def get_account_by_id_with_http_info(self, account_id, **kwargs): # noqa: E501 + """get_account_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_account_by_id_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault6 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_account_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_account_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault6', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_accounts(self, **kwargs): # noqa: E501 + """get_all_accounts # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_accounts(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] id: + :param list[str] organizations: + :param bool include_retired: + :param bool users_only: + :param str metadata: + :return: InlineResponseDefault5 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_accounts_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_accounts_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_accounts_with_http_info(self, **kwargs): # noqa: E501 + """get_all_accounts # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_accounts_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] id: + :param list[str] organizations: + :param bool include_retired: + :param bool users_only: + :param str metadata: + :return: InlineResponseDefault5 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'organizations', 'include_retired', 'users_only', 'metadata'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_accounts" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'id' in params: + query_params.append(('id', params['id'])) # noqa: E501 + collection_formats['id'] = 'multi' # noqa: E501 + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'users_only' in params: + query_params.append(('users_only', params['users_only'])) # noqa: E501 + if 'metadata' in params: + query_params.append(('metadata', params['metadata'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault5', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_available_credit_on_account(self, account_id, **kwargs): # noqa: E501 + """get_available_credit_on_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_available_credit_on_account(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param bool include_retired: + :return: InlineResponseDefault3 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_available_credit_on_account_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.get_available_credit_on_account_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def get_available_credit_on_account_with_http_info(self, account_id, **kwargs): # noqa: E501 + """get_available_credit_on_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_available_credit_on_account_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param bool include_retired: + :return: InlineResponseDefault3 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'organizations', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_available_credit_on_account" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_available_credit_on_account`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}/credit', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault3', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoices_by_account_id(self, account_id, **kwargs): # noqa: E501 + """get_invoices_by_account_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoices_by_account_id_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.get_invoices_by_account_id_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def get_invoices_by_account_id_with_http_info(self, account_id, **kwargs): # noqa: E501 + """get_invoices_by_account_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_account_id_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoices_by_account_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_invoices_by_account_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'exclude_children' in params: + query_params.append(('exclude_children', params['exclude_children'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}/invoices', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_metadata_for_account(self, account_id, **kwargs): # noqa: E501 + """get_metadata_for_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_metadata_for_account(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_metadata_for_account_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.get_metadata_for_account_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def get_metadata_for_account_with_http_info(self, account_id, **kwargs): # noqa: E501 + """get_metadata_for_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_metadata_for_account_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_metadata_for_account" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_metadata_for_account`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}/metadata', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault7', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_payment_method_by_account_id(self, account_id, **kwargs): # noqa: E501 + """get_payment_method_by_account_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_method_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool default_only: + :return: InlineResponseDefault9 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_payment_method_by_account_id_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.get_payment_method_by_account_id_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def get_payment_method_by_account_id_with_http_info(self, account_id, **kwargs): # noqa: E501 + """get_payment_method_by_account_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_method_by_account_id_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool default_only: + :return: InlineResponseDefault9 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'default_only'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_payment_method_by_account_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_payment_method_by_account_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'default_only' in params: + query_params.append(('default_only', params['default_only'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}/payment-methods', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault9', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscription_charges(self, account_id, **kwargs): # noqa: E501 + """get_subscription_charges # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_charges(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault10 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscription_charges_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.get_subscription_charges_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def get_subscription_charges_with_http_info(self, account_id, **kwargs): # noqa: E501 + """get_subscription_charges # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_charges_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault10 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscription_charges" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_subscription_charges`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}/charges', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault10', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def halt_aggregation(self, account_id, **kwargs): # noqa: E501 + """halt_aggregation # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.halt_aggregation(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param HaltAggregationRequest body: + :return: InlineResponseDefault11 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.halt_aggregation_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.halt_aggregation_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def halt_aggregation_with_http_info(self, account_id, **kwargs): # noqa: E501 + """halt_aggregation # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.halt_aggregation_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param HaltAggregationRequest body: + :return: InlineResponseDefault11 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method halt_aggregation" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `halt_aggregation`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}/halt-aggregation', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault11', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def remove_credit_from_account2(self, account_id, **kwargs): # noqa: E501 + """remove_credit_from_account2 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_credit_from_account2(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param RemoveCreditAccountRequest body: + :param list[str] organizations: + :return: InlineResponseDefault4 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.remove_credit_from_account2_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.remove_credit_from_account2_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def remove_credit_from_account2_with_http_info(self, account_id, **kwargs): # noqa: E501 + """remove_credit_from_account2 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_credit_from_account2_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param RemoveCreditAccountRequest body: + :param list[str] organizations: + :return: InlineResponseDefault4 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'body', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method remove_credit_from_account2" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `remove_credit_from_account2`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}/credit', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault4', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def set_metadata_for_account(self, account_id, **kwargs): # noqa: E501 + """set_metadata_for_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_metadata_for_account(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param str body: + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.set_metadata_for_account_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.set_metadata_for_account_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def set_metadata_for_account_with_http_info(self, account_id, **kwargs): # noqa: E501 + """set_metadata_for_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_metadata_for_account_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param str body: + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'body', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method set_metadata_for_account" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `set_metadata_for_account`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}/metadata', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault7', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_account(self, **kwargs): # noqa: E501 + """update_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_account(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Account body: + :return: InlineResponseDefault6 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_account_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_account_with_http_info(**kwargs) # noqa: E501 + return data + + def update_account_with_http_info(self, **kwargs): # noqa: E501 + """update_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_account_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Account body: + :return: InlineResponseDefault6 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_account" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault6', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_address(self, **kwargs): # noqa: E501 + """update_address # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_address(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Address body: + :return: InlineResponseDefault12 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_address_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_address_with_http_info(**kwargs) # noqa: E501 + return data + + def update_address_with_http_info(self, **kwargs): # noqa: E501 + """update_address # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_address_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Address body: + :return: InlineResponseDefault12 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_address" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/addresses', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault12', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def upsert_metadata_for_account(self, account_id, **kwargs): # noqa: E501 + """upsert_metadata_for_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upsert_metadata_for_account(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param str body: + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.upsert_metadata_for_account_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.upsert_metadata_for_account_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def upsert_metadata_for_account_with_http_info(self, account_id, **kwargs): # noqa: E501 + """upsert_metadata_for_account # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upsert_metadata_for_account_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param str body: + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'body', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method upsert_metadata_for_account" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `upsert_metadata_for_account`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/accounts/{account-ID}/metadata', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault7', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/affiliation_api.py b/billforward/api/affiliation_api.py new file mode 100644 index 0000000..21a74c7 --- /dev/null +++ b/billforward/api/affiliation_api.py @@ -0,0 +1,845 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class AffiliationApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def create_invoice(self, account_id, **kwargs): # noqa: E501 + """create_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_invoice(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param CreateCommissionInvoiceRequest body: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_invoice_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.create_invoice_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def create_invoice_with_http_info(self, account_id, **kwargs): # noqa: E501 + """create_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_invoice_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param CreateCommissionInvoiceRequest body: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `create_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-id'] = params['account_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/affiliate/{account-id}/invoice', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_affiliate(self, product_rate_plan_id, **kwargs): # noqa: E501 + """get_affiliate # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_affiliate(product_rate_plan_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str product_rate_plan_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault48 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_affiliate_with_http_info(product_rate_plan_id, **kwargs) # noqa: E501 + else: + (data) = self.get_affiliate_with_http_info(product_rate_plan_id, **kwargs) # noqa: E501 + return data + + def get_affiliate_with_http_info(self, product_rate_plan_id, **kwargs): # noqa: E501 + """get_affiliate # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_affiliate_with_http_info(product_rate_plan_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str product_rate_plan_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault48 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['product_rate_plan_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_affiliate" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'product_rate_plan_id' is set + if ('product_rate_plan_id' not in params or + params['product_rate_plan_id'] is None): + raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `get_affiliate`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'product_rate_plan_id' in params: + path_params['productRatePlanID'] = params['product_rate_plan_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/product-rate-plans/{productRatePlanID}/affiliate', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault48', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_affiliate1(self, subscription_id, **kwargs): # noqa: E501 + """get_affiliate1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_affiliate1(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault66 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_affiliate1_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.get_affiliate1_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def get_affiliate1_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """get_affiliate1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_affiliate1_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault66 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_affiliate1" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_affiliate1`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscriptionID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscriptionID}/affiliate', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault66', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def quote_invoice(self, account_id, invoice_id, **kwargs): # noqa: E501 + """quote_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.quote_invoice(account_id, invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param str invoice_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault13 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.quote_invoice_with_http_info(account_id, invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.quote_invoice_with_http_info(account_id, invoice_id, **kwargs) # noqa: E501 + return data + + def quote_invoice_with_http_info(self, account_id, invoice_id, **kwargs): # noqa: E501 + """quote_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.quote_invoice_with_http_info(account_id, invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param str invoice_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault13 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'invoice_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method quote_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `quote_invoice`") # noqa: E501 + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `quote_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-id'] = params['account_id'] # noqa: E501 + if 'invoice_id' in params: + path_params['invoice-id'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/affiliate/{account-id}/quote/invoice/{invoice-id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault13', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def quote_subscription(self, account_id, subscription_id, **kwargs): # noqa: E501 + """quote_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.quote_subscription(account_id, subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault13 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.quote_subscription_with_http_info(account_id, subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.quote_subscription_with_http_info(account_id, subscription_id, **kwargs) # noqa: E501 + return data + + def quote_subscription_with_http_info(self, account_id, subscription_id, **kwargs): # noqa: E501 + """quote_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.quote_subscription_with_http_info(account_id, subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault13 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'subscription_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method quote_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `quote_subscription`") # noqa: E501 + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `quote_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-id'] = params['account_id'] # noqa: E501 + if 'subscription_id' in params: + path_params['subscription-id'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/affiliate/{account-id}/quote/subscription/{subscription-id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault13', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def set_affiliate(self, product_rate_plan_id, **kwargs): # noqa: E501 + """set_affiliate # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_affiliate(product_rate_plan_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str product_rate_plan_id: (required) + :param SetRatePlanAffiliateRequest body: + :return: InlineResponseDefault49 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.set_affiliate_with_http_info(product_rate_plan_id, **kwargs) # noqa: E501 + else: + (data) = self.set_affiliate_with_http_info(product_rate_plan_id, **kwargs) # noqa: E501 + return data + + def set_affiliate_with_http_info(self, product_rate_plan_id, **kwargs): # noqa: E501 + """set_affiliate # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_affiliate_with_http_info(product_rate_plan_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str product_rate_plan_id: (required) + :param SetRatePlanAffiliateRequest body: + :return: InlineResponseDefault49 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['product_rate_plan_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method set_affiliate" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'product_rate_plan_id' is set + if ('product_rate_plan_id' not in params or + params['product_rate_plan_id'] is None): + raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `set_affiliate`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'product_rate_plan_id' in params: + path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/product-rate-plans/{product-rate-plan-ID}/affiliate', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault49', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def set_affiliate1(self, subscription_id, **kwargs): # noqa: E501 + """set_affiliate1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_affiliate1(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param SetSubscriptionAffiliateRequest body: + :return: InlineResponseDefault67 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.set_affiliate1_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.set_affiliate1_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def set_affiliate1_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """set_affiliate1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_affiliate1_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param SetSubscriptionAffiliateRequest body: + :return: InlineResponseDefault67 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method set_affiliate1" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `set_affiliate1`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscriptionID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscriptionID}/affiliate', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault67', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_affiliate(self, product_rate_plan_id, **kwargs): # noqa: E501 + """update_affiliate # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_affiliate(product_rate_plan_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str product_rate_plan_id: (required) + :param UpdateRatePlanAffiliateRequest body: + :return: InlineResponseDefault49 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_affiliate_with_http_info(product_rate_plan_id, **kwargs) # noqa: E501 + else: + (data) = self.update_affiliate_with_http_info(product_rate_plan_id, **kwargs) # noqa: E501 + return data + + def update_affiliate_with_http_info(self, product_rate_plan_id, **kwargs): # noqa: E501 + """update_affiliate # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_affiliate_with_http_info(product_rate_plan_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str product_rate_plan_id: (required) + :param UpdateRatePlanAffiliateRequest body: + :return: InlineResponseDefault49 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['product_rate_plan_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_affiliate" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'product_rate_plan_id' is set + if ('product_rate_plan_id' not in params or + params['product_rate_plan_id'] is None): + raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `update_affiliate`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'product_rate_plan_id' in params: + path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/product-rate-plans/{product-rate-plan-ID}/affiliate', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault49', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/avatax_api.py b/billforward/api/avatax_api.py new file mode 100644 index 0000000..9fc8baa --- /dev/null +++ b/billforward/api/avatax_api.py @@ -0,0 +1,410 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class AvataxApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def create_avatax_configuration(self, **kwargs): # noqa: E501 + """create_avatax_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_avatax_configuration(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param AvataxConfigRequest body: + :return: InlineResponseDefault75 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_avatax_configuration_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_avatax_configuration_with_http_info(**kwargs) # noqa: E501 + return data + + def create_avatax_configuration_with_http_info(self, **kwargs): # noqa: E501 + """create_avatax_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_avatax_configuration_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param AvataxConfigRequest body: + :return: InlineResponseDefault75 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_avatax_configuration" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tax/avatax', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault75', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_avatax_configuration(self, **kwargs): # noqa: E501 + """get_avatax_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_avatax_configuration(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault74 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_avatax_configuration_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_avatax_configuration_with_http_info(**kwargs) # noqa: E501 + return data + + def get_avatax_configuration_with_http_info(self, **kwargs): # noqa: E501 + """get_avatax_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_avatax_configuration_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault74 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_avatax_configuration" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tax/avatax', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault74', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def ping(self, **kwargs): # noqa: E501 + """ping # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.ping(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param AvataxPingRequest body: + :return: InlineResponseDefault76 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.ping_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.ping_with_http_info(**kwargs) # noqa: E501 + return data + + def ping_with_http_info(self, **kwargs): # noqa: E501 + """ping # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.ping_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param AvataxPingRequest body: + :return: InlineResponseDefault76 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method ping" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tax/avatax/ping', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault76', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_avatax_configuration(self, avatax_config_id, **kwargs): # noqa: E501 + """update_avatax_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_avatax_configuration(avatax_config_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str avatax_config_id: (required) + :param AvataxConfigRequest body: + :return: InlineResponseDefault75 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_avatax_configuration_with_http_info(avatax_config_id, **kwargs) # noqa: E501 + else: + (data) = self.update_avatax_configuration_with_http_info(avatax_config_id, **kwargs) # noqa: E501 + return data + + def update_avatax_configuration_with_http_info(self, avatax_config_id, **kwargs): # noqa: E501 + """update_avatax_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_avatax_configuration_with_http_info(avatax_config_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str avatax_config_id: (required) + :param AvataxConfigRequest body: + :return: InlineResponseDefault75 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['avatax_config_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_avatax_configuration" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'avatax_config_id' is set + if ('avatax_config_id' not in params or + params['avatax_config_id'] is None): + raise ValueError("Missing the required parameter `avatax_config_id` when calling `update_avatax_configuration`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'avatax_config_id' in params: + path_params['avatax-config-ID'] = params['avatax_config_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tax/avatax/{avatax-config-ID}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault75', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/card_connect_api.py b/billforward/api/card_connect_api.py new file mode 100644 index 0000000..94ce17e --- /dev/null +++ b/billforward/api/card_connect_api.py @@ -0,0 +1,311 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class CardConnectApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def delete_configuration(self, **kwargs): # noqa: E501 + """delete_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_configuration(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: APIConfiguration + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.delete_configuration_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.delete_configuration_with_http_info(**kwargs) # noqa: E501 + return data + + def delete_configuration_with_http_info(self, **kwargs): # noqa: E501 + """delete_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_configuration_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: APIConfiguration + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_configuration" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/cardconnect', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='APIConfiguration', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_configuration(self, **kwargs): # noqa: E501 + """get_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_configuration(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault14 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_configuration_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_configuration_with_http_info(**kwargs) # noqa: E501 + return data + + def get_configuration_with_http_info(self, **kwargs): # noqa: E501 + """get_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_configuration_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault14 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_configuration" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/cardconnect', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault14', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def upsert_configuration(self, **kwargs): # noqa: E501 + """upsert_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upsert_configuration(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CardConnectGatewayRequest body: + :param list[str] organizations: + :return: InlineResponseDefault14 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.upsert_configuration_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.upsert_configuration_with_http_info(**kwargs) # noqa: E501 + return data + + def upsert_configuration_with_http_info(self, **kwargs): # noqa: E501 + """upsert_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upsert_configuration_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CardConnectGatewayRequest body: + :param list[str] organizations: + :return: InlineResponseDefault14 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method upsert_configuration" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/cardconnect', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault14', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/charges_api.py b/billforward/api/charges_api.py new file mode 100644 index 0000000..01fde3b --- /dev/null +++ b/billforward/api/charges_api.py @@ -0,0 +1,574 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class ChargesApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def batch_recalculate_subscription_charge(self, **kwargs): # noqa: E501 + """batch_recalculate_subscription_charge # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.batch_recalculate_subscription_charge(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param RecalculateChargeBatchRequest body: + :return: InlineResponseDefault15 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.batch_recalculate_subscription_charge_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.batch_recalculate_subscription_charge_with_http_info(**kwargs) # noqa: E501 + return data + + def batch_recalculate_subscription_charge_with_http_info(self, **kwargs): # noqa: E501 + """batch_recalculate_subscription_charge # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.batch_recalculate_subscription_charge_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param RecalculateChargeBatchRequest body: + :return: InlineResponseDefault15 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method batch_recalculate_subscription_charge" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/charges/recalculate', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault15', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_subscription_charges(self, **kwargs): # noqa: E501 + """get_all_subscription_charges # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_subscription_charges(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: + :param str product_rate_plan: + :param str state: + :param str pricing_component_type: + :param list[str] parent_invoice_id: + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault10 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_subscription_charges_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_subscription_charges_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_subscription_charges_with_http_info(self, **kwargs): # noqa: E501 + """get_all_subscription_charges # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_subscription_charges_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: + :param str product_rate_plan: + :param str state: + :param str pricing_component_type: + :param list[str] parent_invoice_id: + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault10 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'product_rate_plan', 'state', 'pricing_component_type', 'parent_invoice_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_subscription_charges" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'account_id' in params: + query_params.append(('account_id', params['account_id'])) # noqa: E501 + if 'product_rate_plan' in params: + query_params.append(('product_rate_plan', params['product_rate_plan'])) # noqa: E501 + if 'state' in params: + query_params.append(('state', params['state'])) # noqa: E501 + if 'pricing_component_type' in params: + query_params.append(('pricing_component_type', params['pricing_component_type'])) # noqa: E501 + if 'parent_invoice_id' in params: + query_params.append(('parent_invoice_id', params['parent_invoice_id'])) # noqa: E501 + collection_formats['parent_invoice_id'] = 'multi' # noqa: E501 + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/charges', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault10', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscription_charge_by_id(self, charge_id, **kwargs): # noqa: E501 + """get_subscription_charge_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_charge_by_id(charge_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str charge_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault16 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscription_charge_by_id_with_http_info(charge_id, **kwargs) # noqa: E501 + else: + (data) = self.get_subscription_charge_by_id_with_http_info(charge_id, **kwargs) # noqa: E501 + return data + + def get_subscription_charge_by_id_with_http_info(self, charge_id, **kwargs): # noqa: E501 + """get_subscription_charge_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_charge_by_id_with_http_info(charge_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str charge_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault16 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['charge_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscription_charge_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'charge_id' is set + if ('charge_id' not in params or + params['charge_id'] is None): + raise ValueError("Missing the required parameter `charge_id` when calling `get_subscription_charge_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'charge_id' in params: + path_params['charge-id'] = params['charge_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/charges/{charge-id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault16', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def recalculate_subscription_charge(self, charge_id, **kwargs): # noqa: E501 + """recalculate_subscription_charge # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.recalculate_subscription_charge(charge_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str charge_id: (required) + :param RecalculateChargeRequest body: + :return: InlineResponseDefault10 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.recalculate_subscription_charge_with_http_info(charge_id, **kwargs) # noqa: E501 + else: + (data) = self.recalculate_subscription_charge_with_http_info(charge_id, **kwargs) # noqa: E501 + return data + + def recalculate_subscription_charge_with_http_info(self, charge_id, **kwargs): # noqa: E501 + """recalculate_subscription_charge # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.recalculate_subscription_charge_with_http_info(charge_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str charge_id: (required) + :param RecalculateChargeRequest body: + :return: InlineResponseDefault10 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['charge_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method recalculate_subscription_charge" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'charge_id' is set + if ('charge_id' not in params or + params['charge_id'] is None): + raise ValueError("Missing the required parameter `charge_id` when calling `recalculate_subscription_charge`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'charge_id' in params: + path_params['charge-ID'] = params['charge_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/charges/{charge-ID}/recalculate', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault10', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def void_subscription_charge(self, charge_id, **kwargs): # noqa: E501 + """void_subscription_charge # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.void_subscription_charge(charge_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str charge_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault16 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.void_subscription_charge_with_http_info(charge_id, **kwargs) # noqa: E501 + else: + (data) = self.void_subscription_charge_with_http_info(charge_id, **kwargs) # noqa: E501 + return data + + def void_subscription_charge_with_http_info(self, charge_id, **kwargs): # noqa: E501 + """void_subscription_charge # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.void_subscription_charge_with_http_info(charge_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str charge_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault16 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['charge_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method void_subscription_charge" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'charge_id' is set + if ('charge_id' not in params or + params['charge_id'] is None): + raise ValueError("Missing the required parameter `charge_id` when calling `void_subscription_charge`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'charge_id' in params: + path_params['charge-id'] = params['charge_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/charges/{charge-id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault16', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/checkout_api.py b/billforward/api/checkout_api.py new file mode 100644 index 0000000..d4fcda8 --- /dev/null +++ b/billforward/api/checkout_api.py @@ -0,0 +1,508 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class CheckoutApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def build_subscription_checkout(self, checkout_definition_path, **kwargs): # noqa: E501 + """build_subscription_checkout # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.build_subscription_checkout(checkout_definition_path, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str checkout_definition_path: (required) + :param list[str] organizations: + :return: InlineResponseDefault50 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.build_subscription_checkout_with_http_info(checkout_definition_path, **kwargs) # noqa: E501 + else: + (data) = self.build_subscription_checkout_with_http_info(checkout_definition_path, **kwargs) # noqa: E501 + return data + + def build_subscription_checkout_with_http_info(self, checkout_definition_path, **kwargs): # noqa: E501 + """build_subscription_checkout # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.build_subscription_checkout_with_http_info(checkout_definition_path, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str checkout_definition_path: (required) + :param list[str] organizations: + :return: InlineResponseDefault50 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['checkout_definition_path', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method build_subscription_checkout" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'checkout_definition_path' is set + if ('checkout_definition_path' not in params or + params['checkout_definition_path'] is None): + raise ValueError("Missing the required parameter `checkout_definition_path` when calling `build_subscription_checkout`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'checkout_definition_path' in params: + path_params['checkout-definition-path'] = params['checkout_definition_path'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/public/checkouts/subscriptions/{checkout-definition-path}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault50', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_account1(self, **kwargs): # noqa: E501 + """create_account1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_account1(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Account body: + :return: InlineResponseDefault6 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_account1_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_account1_with_http_info(**kwargs) # noqa: E501 + return data + + def create_account1_with_http_info(self, **kwargs): # noqa: E501 + """create_account1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_account1_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Account body: + :return: InlineResponseDefault6 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_account1" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/public/accounts', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault6', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_subscription_checkout_definition(self, **kwargs): # noqa: E501 + """create_subscription_checkout_definition # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_subscription_checkout_definition(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateSubscriptionCheckoutDefinitionRequest body: + :return: InlineResponseDefault17 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_subscription_checkout_definition_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_subscription_checkout_definition_with_http_info(**kwargs) # noqa: E501 + return data + + def create_subscription_checkout_definition_with_http_info(self, **kwargs): # noqa: E501 + """create_subscription_checkout_definition # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_subscription_checkout_definition_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateSubscriptionCheckoutDefinitionRequest body: + :return: InlineResponseDefault17 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_subscription_checkout_definition" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/checkouts/subscriptions', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault17', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscription_checkout_definition(self, checkout_definition_path, **kwargs): # noqa: E501 + """get_subscription_checkout_definition # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_checkout_definition(checkout_definition_path, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str checkout_definition_path: (required) + :param list[str] organizations: + :return: InlineResponseDefault17 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscription_checkout_definition_with_http_info(checkout_definition_path, **kwargs) # noqa: E501 + else: + (data) = self.get_subscription_checkout_definition_with_http_info(checkout_definition_path, **kwargs) # noqa: E501 + return data + + def get_subscription_checkout_definition_with_http_info(self, checkout_definition_path, **kwargs): # noqa: E501 + """get_subscription_checkout_definition # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_checkout_definition_with_http_info(checkout_definition_path, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str checkout_definition_path: (required) + :param list[str] organizations: + :return: InlineResponseDefault17 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['checkout_definition_path', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscription_checkout_definition" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'checkout_definition_path' is set + if ('checkout_definition_path' not in params or + params['checkout_definition_path'] is None): + raise ValueError("Missing the required parameter `checkout_definition_path` when calling `get_subscription_checkout_definition`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'checkout_definition_path' in params: + path_params['checkout-definition-path'] = params['checkout_definition_path'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/checkouts/subscriptions/{checkout-definition-path}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault17', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def subscription_checkout(self, **kwargs): # noqa: E501 + """subscription_checkout # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.subscription_checkout(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SubscriptionCheckoutActionRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.subscription_checkout_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.subscription_checkout_with_http_info(**kwargs) # noqa: E501 + return data + + def subscription_checkout_with_http_info(self, **kwargs): # noqa: E501 + """subscription_checkout # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.subscription_checkout_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SubscriptionCheckoutActionRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method subscription_checkout" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/public/checkouts/subscriptions', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault51', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/contracts_api.py b/billforward/api/contracts_api.py new file mode 100644 index 0000000..38b8b16 --- /dev/null +++ b/billforward/api/contracts_api.py @@ -0,0 +1,836 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class ContractsApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def add_contract_period(self, contract, **kwargs): # noqa: E501 + """add_contract_period # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_contract_period(contract, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str contract: (required) + :param AddContractPeriodRequest body: + :return: InlineResponseDefault19 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.add_contract_period_with_http_info(contract, **kwargs) # noqa: E501 + else: + (data) = self.add_contract_period_with_http_info(contract, **kwargs) # noqa: E501 + return data + + def add_contract_period_with_http_info(self, contract, **kwargs): # noqa: E501 + """add_contract_period # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_contract_period_with_http_info(contract, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str contract: (required) + :param AddContractPeriodRequest body: + :return: InlineResponseDefault19 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['contract', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method add_contract_period" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'contract' is set + if ('contract' not in params or + params['contract'] is None): + raise ValueError("Missing the required parameter `contract` when calling `add_contract_period`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'contract' in params: + path_params['contract'] = params['contract'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/contracts/{contract}/period', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault19', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_contract(self, **kwargs): # noqa: E501 + """create_contract # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_contract(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateContractRequest body: + :return: InlineResponseDefault19 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_contract_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_contract_with_http_info(**kwargs) # noqa: E501 + return data + + def create_contract_with_http_info(self, **kwargs): # noqa: E501 + """create_contract # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_contract_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateContractRequest body: + :return: InlineResponseDefault19 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_contract" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/contracts', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault19', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_contracts(self, **kwargs): # noqa: E501 + """get_all_contracts # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_contracts(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] state: + :param list[str] account_id: + :param list[str] subscription_id: + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault20 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_contracts_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_contracts_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_contracts_with_http_info(self, **kwargs): # noqa: E501 + """get_all_contracts # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_contracts_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] state: + :param list[str] account_id: + :param list[str] subscription_id: + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault20 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['state', 'account_id', 'subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_contracts" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'state' in params: + query_params.append(('state[]', params['state'])) # noqa: E501 + collection_formats['state[]'] = 'multi' # noqa: E501 + if 'account_id' in params: + query_params.append(('account_id[]', params['account_id'])) # noqa: E501 + collection_formats['account_id[]'] = 'multi' # noqa: E501 + if 'subscription_id' in params: + query_params.append(('subscription_id[]', params['subscription_id'])) # noqa: E501 + collection_formats['subscription_id[]'] = 'multi' # noqa: E501 + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/contracts', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault20', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_contract_by_id(self, contract, **kwargs): # noqa: E501 + """get_contract_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_contract_by_id(contract, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str contract: (required) + :param list[str] organizations: + :return: InlineResponseDefault19 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_contract_by_id_with_http_info(contract, **kwargs) # noqa: E501 + else: + (data) = self.get_contract_by_id_with_http_info(contract, **kwargs) # noqa: E501 + return data + + def get_contract_by_id_with_http_info(self, contract, **kwargs): # noqa: E501 + """get_contract_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_contract_by_id_with_http_info(contract, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str contract: (required) + :param list[str] organizations: + :return: InlineResponseDefault19 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['contract', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_contract_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'contract' is set + if ('contract' not in params or + params['contract'] is None): + raise ValueError("Missing the required parameter `contract` when calling `get_contract_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'contract' in params: + path_params['contract'] = params['contract'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/contracts/{contract}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault19', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def start_contract(self, contract, **kwargs): # noqa: E501 + """start_contract # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.start_contract(contract, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str contract: (required) + :param StartContractRequest body: + :return: InlineResponseDefault21 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.start_contract_with_http_info(contract, **kwargs) # noqa: E501 + else: + (data) = self.start_contract_with_http_info(contract, **kwargs) # noqa: E501 + return data + + def start_contract_with_http_info(self, contract, **kwargs): # noqa: E501 + """start_contract # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.start_contract_with_http_info(contract, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str contract: (required) + :param StartContractRequest body: + :return: InlineResponseDefault21 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['contract', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method start_contract" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'contract' is set + if ('contract' not in params or + params['contract'] is None): + raise ValueError("Missing the required parameter `contract` when calling `start_contract`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'contract' in params: + path_params['contract'] = params['contract'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/contracts/{contract}/start', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault21', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_contract(self, **kwargs): # noqa: E501 + """update_contract # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_contract(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UpdateContractRequest body: + :return: InlineResponseDefault19 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_contract_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_contract_with_http_info(**kwargs) # noqa: E501 + return data + + def update_contract_with_http_info(self, **kwargs): # noqa: E501 + """update_contract # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_contract_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UpdateContractRequest body: + :return: InlineResponseDefault19 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_contract" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/contracts', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault19', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def void_contract(self, contract, **kwargs): # noqa: E501 + """void_contract # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.void_contract(contract, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str contract: (required) + :param list[str] organizations: + :return: InlineResponseDefault19 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.void_contract_with_http_info(contract, **kwargs) # noqa: E501 + else: + (data) = self.void_contract_with_http_info(contract, **kwargs) # noqa: E501 + return data + + def void_contract_with_http_info(self, contract, **kwargs): # noqa: E501 + """void_contract # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.void_contract_with_http_info(contract, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str contract: (required) + :param list[str] organizations: + :return: InlineResponseDefault19 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['contract', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method void_contract" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'contract' is set + if ('contract' not in params or + params['contract'] is None): + raise ValueError("Missing the required parameter `contract` when calling `void_contract`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'contract' in params: + path_params['contract'] = params['contract'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/contracts/{contract}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault19', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def void_final_contract_period(self, contract, **kwargs): # noqa: E501 + """void_final_contract_period # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.void_final_contract_period(contract, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str contract: (required) + :param list[str] organizations: + :return: InlineResponseDefault19 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.void_final_contract_period_with_http_info(contract, **kwargs) # noqa: E501 + else: + (data) = self.void_final_contract_period_with_http_info(contract, **kwargs) # noqa: E501 + return data + + def void_final_contract_period_with_http_info(self, contract, **kwargs): # noqa: E501 + """void_final_contract_period # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.void_final_contract_period_with_http_info(contract, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str contract: (required) + :param list[str] organizations: + :return: InlineResponseDefault19 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['contract', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method void_final_contract_period" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'contract' is set + if ('contract' not in params or + params['contract'] is None): + raise ValueError("Missing the required parameter `contract` when calling `void_final_contract_period`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'contract' in params: + path_params['contract'] = params['contract'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/contracts/{contract}/period', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault19', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/coupons_api.py b/billforward/api/coupons_api.py new file mode 100644 index 0000000..ec8296c --- /dev/null +++ b/billforward/api/coupons_api.py @@ -0,0 +1,1111 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class CouponsApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def create_coupon(self, **kwargs): # noqa: E501 + """create_coupon # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_coupon(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateCouponRequest body: + :return: InlineResponseDefault23 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_coupon_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_coupon_with_http_info(**kwargs) # noqa: E501 + return data + + def create_coupon_with_http_info(self, **kwargs): # noqa: E501 + """create_coupon # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_coupon_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateCouponRequest body: + :return: InlineResponseDefault23 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_coupon" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/coupons', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault23', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_coupon_unique_codes(self, code, **kwargs): # noqa: E501 + """create_coupon_unique_codes # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_coupon_unique_codes(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param CouponUniqueCodesRequest body: + :return: InlineResponseDefault24 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_coupon_unique_codes_with_http_info(code, **kwargs) # noqa: E501 + else: + (data) = self.create_coupon_unique_codes_with_http_info(code, **kwargs) # noqa: E501 + return data + + def create_coupon_unique_codes_with_http_info(self, code, **kwargs): # noqa: E501 + """create_coupon_unique_codes # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_coupon_unique_codes_with_http_info(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param CouponUniqueCodesRequest body: + :return: InlineResponseDefault24 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['code', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_coupon_unique_codes" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'code' is set + if ('code' not in params or + params['code'] is None): + raise ValueError("Missing the required parameter `code` when calling `create_coupon_unique_codes`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'code' in params: + path_params['code'] = params['code'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/coupons/{code}/codes', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault24', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_coupons(self, **kwargs): # noqa: E501 + """get_all_coupons # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_coupons(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault22 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_coupons_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_coupons_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_coupons_with_http_info(self, **kwargs): # noqa: E501 + """get_all_coupons # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_coupons_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault22 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_coupons" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/coupons', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault22', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_applied_coupons(self, code, **kwargs): # noqa: E501 + """get_applied_coupons # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_applied_coupons(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault22 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_applied_coupons_with_http_info(code, **kwargs) # noqa: E501 + else: + (data) = self.get_applied_coupons_with_http_info(code, **kwargs) # noqa: E501 + return data + + def get_applied_coupons_with_http_info(self, code, **kwargs): # noqa: E501 + """get_applied_coupons # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_applied_coupons_with_http_info(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault22 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['code', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_applied_coupons" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'code' is set + if ('code' not in params or + params['code'] is None): + raise ValueError("Missing the required parameter `code` when calling `get_applied_coupons`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'code' in params: + path_params['code'] = params['code'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/coupons/{code}/applied', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault22', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_available_coupon_codes_for_code(self, code, **kwargs): # noqa: E501 + """get_available_coupon_codes_for_code # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_available_coupon_codes_for_code(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault24 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_available_coupon_codes_for_code_with_http_info(code, **kwargs) # noqa: E501 + else: + (data) = self.get_available_coupon_codes_for_code_with_http_info(code, **kwargs) # noqa: E501 + return data + + def get_available_coupon_codes_for_code_with_http_info(self, code, **kwargs): # noqa: E501 + """get_available_coupon_codes_for_code # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_available_coupon_codes_for_code_with_http_info(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault24 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['code', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_available_coupon_codes_for_code" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'code' is set + if ('code' not in params or + params['code'] is None): + raise ValueError("Missing the required parameter `code` when calling `get_available_coupon_codes_for_code`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'code' in params: + path_params['code'] = params['code'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/coupons/{code}/codes', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault24', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_available_coupon_codes_for_code_as_csv(self, code, **kwargs): # noqa: E501 + """get_available_coupon_codes_for_code_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_available_coupon_codes_for_code_as_csv(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_available_coupon_codes_for_code_as_csv_with_http_info(code, **kwargs) # noqa: E501 + else: + (data) = self.get_available_coupon_codes_for_code_as_csv_with_http_info(code, **kwargs) # noqa: E501 + return data + + def get_available_coupon_codes_for_code_as_csv_with_http_info(self, code, **kwargs): # noqa: E501 + """get_available_coupon_codes_for_code_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_available_coupon_codes_for_code_as_csv_with_http_info(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['code', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_available_coupon_codes_for_code_as_csv" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'code' is set + if ('code' not in params or + params['code'] is None): + raise ValueError("Missing the required parameter `code` when calling `get_available_coupon_codes_for_code_as_csv`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'code' in params: + path_params['code'] = params['code'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/coupons/{code}/codes.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_coupon_code(self, code, **kwargs): # noqa: E501 + """get_coupon_code # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_coupon_code(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :return: InlineResponseDefault22 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_coupon_code_with_http_info(code, **kwargs) # noqa: E501 + else: + (data) = self.get_coupon_code_with_http_info(code, **kwargs) # noqa: E501 + return data + + def get_coupon_code_with_http_info(self, code, **kwargs): # noqa: E501 + """get_coupon_code # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_coupon_code_with_http_info(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :return: InlineResponseDefault22 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['code', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_coupon_code" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'code' is set + if ('code' not in params or + params['code'] is None): + raise ValueError("Missing the required parameter `code` when calling `get_coupon_code`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'code' in params: + path_params['code'] = params['code'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/coupons/{code}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault22', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_plans_for_coupon(self, code, **kwargs): # noqa: E501 + """get_plans_for_coupon # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_plans_for_coupon(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault25 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_plans_for_coupon_with_http_info(code, **kwargs) # noqa: E501 + else: + (data) = self.get_plans_for_coupon_with_http_info(code, **kwargs) # noqa: E501 + return data + + def get_plans_for_coupon_with_http_info(self, code, **kwargs): # noqa: E501 + """get_plans_for_coupon # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_plans_for_coupon_with_http_info(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault25 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['code', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_plans_for_coupon" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'code' is set + if ('code' not in params or + params['code'] is None): + raise ValueError("Missing the required parameter `code` when calling `get_plans_for_coupon`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'code' in params: + path_params['code'] = params['code'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/coupons/{code}/plans', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault25', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscription_applications_of_coupons(self, code, **kwargs): # noqa: E501 + """get_subscription_applications_of_coupons # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_applications_of_coupons(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscription_applications_of_coupons_with_http_info(code, **kwargs) # noqa: E501 + else: + (data) = self.get_subscription_applications_of_coupons_with_http_info(code, **kwargs) # noqa: E501 + return data + + def get_subscription_applications_of_coupons_with_http_info(self, code, **kwargs): # noqa: E501 + """get_subscription_applications_of_coupons # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_applications_of_coupons_with_http_info(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['code', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscription_applications_of_coupons" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'code' is set + if ('code' not in params or + params['code'] is None): + raise ValueError("Missing the required parameter `code` when calling `get_subscription_applications_of_coupons`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'code' in params: + path_params['code'] = params['code'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/coupons/{code}/subscriptions', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault26', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def retire_coupon(self, code, **kwargs): # noqa: E501 + """retire_coupon # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.retire_coupon(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :return: InlineResponseDefault22 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.retire_coupon_with_http_info(code, **kwargs) # noqa: E501 + else: + (data) = self.retire_coupon_with_http_info(code, **kwargs) # noqa: E501 + return data + + def retire_coupon_with_http_info(self, code, **kwargs): # noqa: E501 + """retire_coupon # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.retire_coupon_with_http_info(code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str code: (required) + :param list[str] organizations: + :return: InlineResponseDefault22 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['code', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method retire_coupon" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'code' is set + if ('code' not in params or + params['code'] is None): + raise ValueError("Missing the required parameter `code` when calling `retire_coupon`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'code' in params: + path_params['code'] = params['code'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/coupons/{code}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault22', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/default_api.py b/billforward/api/default_api.py new file mode 100644 index 0000000..13200b9 --- /dev/null +++ b/billforward/api/default_api.py @@ -0,0 +1,309 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class DefaultApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def create_totp_secret(self, **kwargs): # noqa: E501 + """create_totp_secret # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_totp_secret(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateTOTPRequest body: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_totp_secret_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_totp_secret_with_http_info(**kwargs) # noqa: E501 + return data + + def create_totp_secret_with_http_info(self, **kwargs): # noqa: E501 + """create_totp_secret # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_totp_secret_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateTOTPRequest body: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_totp_secret" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/2fa/totp', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def enable2fa(self, **kwargs): # noqa: E501 + """enable2fa # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.enable2fa(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateTOTPRequest body: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.enable2fa_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.enable2fa_with_http_info(**kwargs) # noqa: E501 + return data + + def enable2fa_with_http_info(self, **kwargs): # noqa: E501 + """enable2fa # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.enable2fa_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateTOTPRequest body: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method enable2fa" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/2fa/enable', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_qr_code(self, account_id, **kwargs): # noqa: E501 + """get_qr_code # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_qr_code(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param bool include_billforward_logo: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_qr_code_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.get_qr_code_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def get_qr_code_with_http_info(self, account_id, **kwargs): # noqa: E501 + """get_qr_code # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_qr_code_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param bool include_billforward_logo: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'organizations', 'include_billforward_logo'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_qr_code" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_qr_code`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['accountId'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'include_billforward_logo' in params: + query_params.append(('includeBillforwardLogo', params['include_billforward_logo'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/barcode/qr/acc/{accountId}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/dunning_api.py b/billforward/api/dunning_api.py new file mode 100644 index 0000000..19017fa --- /dev/null +++ b/billforward/api/dunning_api.py @@ -0,0 +1,643 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class DunningApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def create_dunning_line(self, **kwargs): # noqa: E501 + """create_dunning_line # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_dunning_line(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param DunningLine body: + :return: InlineResponseDefault1 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_dunning_line_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_dunning_line_with_http_info(**kwargs) # noqa: E501 + return data + + def create_dunning_line_with_http_info(self, **kwargs): # noqa: E501 + """create_dunning_line # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_dunning_line_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param DunningLine body: + :return: InlineResponseDefault1 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_dunning_line" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/dunning-lines', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault1', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_dunning_lines(self, **kwargs): # noqa: E501 + """get_all_dunning_lines # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_dunning_lines(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_dunning_lines_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_dunning_lines_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_dunning_lines_with_http_info(self, **kwargs): # noqa: E501 + """get_all_dunning_lines # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_dunning_lines_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_dunning_lines" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/dunning-lines', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_dunning_line_by_attempt_index(self, index, **kwargs): # noqa: E501 + """get_dunning_line_by_attempt_index # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_dunning_line_by_attempt_index(index, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param int index: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_dunning_line_by_attempt_index_with_http_info(index, **kwargs) # noqa: E501 + else: + (data) = self.get_dunning_line_by_attempt_index_with_http_info(index, **kwargs) # noqa: E501 + return data + + def get_dunning_line_by_attempt_index_with_http_info(self, index, **kwargs): # noqa: E501 + """get_dunning_line_by_attempt_index # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_dunning_line_by_attempt_index_with_http_info(index, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param int index: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['index', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_dunning_line_by_attempt_index" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'index' is set + if ('index' not in params or + params['index'] is None): + raise ValueError("Missing the required parameter `index` when calling `get_dunning_line_by_attempt_index`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'index' in params: + path_params['index'] = params['index'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/dunning-lines/attempt-index/{index}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_dunning_line_by_id(self, dunning_line_id, **kwargs): # noqa: E501 + """get_dunning_line_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_dunning_line_by_id(dunning_line_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str dunning_line_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault1 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_dunning_line_by_id_with_http_info(dunning_line_id, **kwargs) # noqa: E501 + else: + (data) = self.get_dunning_line_by_id_with_http_info(dunning_line_id, **kwargs) # noqa: E501 + return data + + def get_dunning_line_by_id_with_http_info(self, dunning_line_id, **kwargs): # noqa: E501 + """get_dunning_line_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_dunning_line_by_id_with_http_info(dunning_line_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str dunning_line_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault1 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['dunning_line_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_dunning_line_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'dunning_line_id' is set + if ('dunning_line_id' not in params or + params['dunning_line_id'] is None): + raise ValueError("Missing the required parameter `dunning_line_id` when calling `get_dunning_line_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'dunning_line_id' in params: + path_params['dunning-line-ID'] = params['dunning_line_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/dunning-lines/{dunning-line-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault1', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def retire_dunning_line(self, dunning_line_id, **kwargs): # noqa: E501 + """retire_dunning_line # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.retire_dunning_line(dunning_line_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str dunning_line_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault1 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.retire_dunning_line_with_http_info(dunning_line_id, **kwargs) # noqa: E501 + else: + (data) = self.retire_dunning_line_with_http_info(dunning_line_id, **kwargs) # noqa: E501 + return data + + def retire_dunning_line_with_http_info(self, dunning_line_id, **kwargs): # noqa: E501 + """retire_dunning_line # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.retire_dunning_line_with_http_info(dunning_line_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str dunning_line_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault1 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['dunning_line_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method retire_dunning_line" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'dunning_line_id' is set + if ('dunning_line_id' not in params or + params['dunning_line_id'] is None): + raise ValueError("Missing the required parameter `dunning_line_id` when calling `retire_dunning_line`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'dunning_line_id' in params: + path_params['dunning-line-ID'] = params['dunning_line_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/dunning-lines/{dunning-line-ID}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault1', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_dunning_line(self, **kwargs): # noqa: E501 + """update_dunning_line # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_dunning_line(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param DunningLine body: + :return: InlineResponseDefault1 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_dunning_line_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_dunning_line_with_http_info(**kwargs) # noqa: E501 + return data + + def update_dunning_line_with_http_info(self, **kwargs): # noqa: E501 + """update_dunning_line # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_dunning_line_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param DunningLine body: + :return: InlineResponseDefault1 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_dunning_line" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/dunning-lines', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault1', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/ebanx_api.py b/billforward/api/ebanx_api.py new file mode 100644 index 0000000..6a4cd90 --- /dev/null +++ b/billforward/api/ebanx_api.py @@ -0,0 +1,412 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class EBANXApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def delete_configuration1(self, **kwargs): # noqa: E501 + """delete_configuration1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_configuration1(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: APIConfiguration + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.delete_configuration1_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.delete_configuration1_with_http_info(**kwargs) # noqa: E501 + return data + + def delete_configuration1_with_http_info(self, **kwargs): # noqa: E501 + """delete_configuration1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_configuration1_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: APIConfiguration + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_configuration1" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/ebanx', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='APIConfiguration', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_configuration1(self, **kwargs): # noqa: E501 + """get_configuration1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_configuration1(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault14 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_configuration1_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_configuration1_with_http_info(**kwargs) # noqa: E501 + return data + + def get_configuration1_with_http_info(self, **kwargs): # noqa: E501 + """get_configuration1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_configuration1_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault14 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_configuration1" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/ebanx', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault14', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def handle_webhook(self, organization_id, **kwargs): # noqa: E501 + """handle_webhook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.handle_webhook(organization_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str organization_id: (required) + :param EBANXWebhook body: + :return: InlineResponseDefault27 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.handle_webhook_with_http_info(organization_id, **kwargs) # noqa: E501 + else: + (data) = self.handle_webhook_with_http_info(organization_id, **kwargs) # noqa: E501 + return data + + def handle_webhook_with_http_info(self, organization_id, **kwargs): # noqa: E501 + """handle_webhook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.handle_webhook_with_http_info(organization_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str organization_id: (required) + :param EBANXWebhook body: + :return: InlineResponseDefault27 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organization_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method handle_webhook" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'organization_id' is set + if ('organization_id' not in params or + params['organization_id'] is None): + raise ValueError("Missing the required parameter `organization_id` when calling `handle_webhook`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'organization_id' in params: + path_params['organization_id'] = params['organization_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/ebanx/webhook/{organization_id}', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault27', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def upsert_configuration1(self, **kwargs): # noqa: E501 + """upsert_configuration1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upsert_configuration1(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param EBANXGatewayRequest body: + :param list[str] organizations: + :return: InlineResponseDefault14 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.upsert_configuration1_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.upsert_configuration1_with_http_info(**kwargs) # noqa: E501 + return data + + def upsert_configuration1_with_http_info(self, **kwargs): # noqa: E501 + """upsert_configuration1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upsert_configuration1_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param EBANXGatewayRequest body: + :param list[str] organizations: + :return: InlineResponseDefault14 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method upsert_configuration1" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/ebanx', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault14', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/invoices_api.py b/billforward/api/invoices_api.py new file mode 100644 index 0000000..b112c87 --- /dev/null +++ b/billforward/api/invoices_api.py @@ -0,0 +1,5613 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class InvoicesApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def add_charge_to_invoice(self, invoice_id, **kwargs): # noqa: E501 + """add_charge_to_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_charge_to_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param AddChargeRequest body: + :return: InlineResponseDefault28 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.add_charge_to_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.add_charge_to_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def add_charge_to_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """add_charge_to_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_charge_to_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param AddChargeRequest body: + :return: InlineResponseDefault28 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method add_charge_to_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `add_charge_to_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-ID}/charges', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault28', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def execute_invoice(self, invoice_id, **kwargs): # noqa: E501 + """execute_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.execute_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param InvoiceExecutionRequest body: + :return: InlineResponseDefault29 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.execute_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.execute_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def execute_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """execute_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.execute_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param InvoiceExecutionRequest body: + :return: InlineResponseDefault29 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method execute_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `execute_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-ID}/execute', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault29', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_invoices(self, **kwargs): # noqa: E501 + """get_all_invoices # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_invoices(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param list[str] state: + :param list[str] account_id: + :param list[str] subscription_id: + :param list[str] subscription_version_id: + :param list[str] invoice_version_id: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :param str metadata: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_invoices_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_invoices_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_invoices_with_http_info(self, **kwargs): # noqa: E501 + """get_all_invoices # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_invoices_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param list[str] state: + :param list[str] account_id: + :param list[str] subscription_id: + :param list[str] subscription_version_id: + :param list[str] invoice_version_id: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :param str metadata: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'state', 'account_id', 'subscription_id', 'subscription_version_id', 'invoice_version_id', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children', 'metadata'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_invoices" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'state' in params: + query_params.append(('state', params['state'])) # noqa: E501 + collection_formats['state'] = 'multi' # noqa: E501 + if 'account_id' in params: + query_params.append(('accountID', params['account_id'])) # noqa: E501 + collection_formats['accountID'] = 'multi' # noqa: E501 + if 'subscription_id' in params: + query_params.append(('subscriptionID', params['subscription_id'])) # noqa: E501 + collection_formats['subscriptionID'] = 'multi' # noqa: E501 + if 'subscription_version_id' in params: + query_params.append(('subscriptionVersionID', params['subscription_version_id'])) # noqa: E501 + collection_formats['subscriptionVersionID'] = 'multi' # noqa: E501 + if 'invoice_version_id' in params: + query_params.append(('invoiceVersionID', params['invoice_version_id'])) # noqa: E501 + collection_formats['invoiceVersionID'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'exclude_children' in params: + query_params.append(('exclude_children', params['exclude_children'])) # noqa: E501 + if 'metadata' in params: + query_params.append(('metadata', params['metadata'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_invoices_as_csv(self, **kwargs): # noqa: E501 + """get_all_invoices_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_invoices_as_csv(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_invoices_as_csv_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_invoices_as_csv_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_invoices_as_csv_with_http_info(self, **kwargs): # noqa: E501 + """get_all_invoices_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_invoices_as_csv_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_invoices_as_csv" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/all.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_bucketed_revenue_attributions_as_csv(self, **kwargs): # noqa: E501 + """get_bucketed_revenue_attributions_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_bucketed_revenue_attributions_as_csv(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_granularity: + :param str date_time_format: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_bucketed_revenue_attributions_as_csv_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_bucketed_revenue_attributions_as_csv_with_http_info(**kwargs) # noqa: E501 + return data + + def get_bucketed_revenue_attributions_as_csv_with_http_info(self, **kwargs): # noqa: E501 + """get_bucketed_revenue_attributions_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_bucketed_revenue_attributions_as_csv_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_granularity: + :param str date_time_format: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'recognition_start', 'recognition_end', 'date_interval_inclusivity', 'date_granularity', 'date_time_format', 'boolean_format', 'monetary_amount_format'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_bucketed_revenue_attributions_as_csv" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/bucketed-revenue-attributions.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_charges_on_invoice(self, invoice_id, **kwargs): # noqa: E501 + """get_charges_on_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_charges_on_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param str state: + :param str type: + :param bool include_retired: + :return: InlineResponseDefault10 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_charges_on_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.get_charges_on_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def get_charges_on_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """get_charges_on_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_charges_on_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param str state: + :param str type: + :param bool include_retired: + :return: InlineResponseDefault10 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'state', 'type', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_charges_on_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `get_charges_on_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'state' in params: + query_params.append(('state', params['state'])) # noqa: E501 + if 'type' in params: + query_params.append(('type', params['type'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-ID}/charges', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault10', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_credit_invoice_line_payments_from_invoices_as_csv(self, **kwargs): # noqa: E501 + """get_credit_invoice_line_payments_from_invoices_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_credit_invoice_line_payments_from_invoices_as_csv(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_credit_invoice_line_payments_from_invoices_as_csv_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_credit_invoice_line_payments_from_invoices_as_csv_with_http_info(**kwargs) # noqa: E501 + return data + + def get_credit_invoice_line_payments_from_invoices_as_csv_with_http_info(self, **kwargs): # noqa: E501 + """get_credit_invoice_line_payments_from_invoices_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_credit_invoice_line_payments_from_invoices_as_csv_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'recognition_start', 'recognition_end', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_credit_invoice_line_payments_from_invoices_as_csv" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/credit.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(self, **kwargs): # noqa: E501 + """get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam start: + :param SimpleDateParam end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(**kwargs) # noqa: E501 + return data + + def get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(self, **kwargs): # noqa: E501 + """get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam start: + :param SimpleDateParam end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'start', 'end', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'start' in params: + query_params.append(('start', params['start'])) # noqa: E501 + if 'end' in params: + query_params.append(('end', params['end'])) # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/payment-received/credit.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_debit_invoice_line_payments_from_invoices_as_csv(self, **kwargs): # noqa: E501 + """get_debit_invoice_line_payments_from_invoices_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_debit_invoice_line_payments_from_invoices_as_csv(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_debit_invoice_line_payments_from_invoices_as_csv_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_debit_invoice_line_payments_from_invoices_as_csv_with_http_info(**kwargs) # noqa: E501 + return data + + def get_debit_invoice_line_payments_from_invoices_as_csv_with_http_info(self, **kwargs): # noqa: E501 + """get_debit_invoice_line_payments_from_invoices_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_debit_invoice_line_payments_from_invoices_as_csv_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'recognition_start', 'recognition_end', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_debit_invoice_line_payments_from_invoices_as_csv" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/revenue.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(self, **kwargs): # noqa: E501 + """get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam start: + :param SimpleDateParam end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(**kwargs) # noqa: E501 + return data + + def get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(self, **kwargs): # noqa: E501 + """get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam start: + :param SimpleDateParam end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'start', 'end', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'start' in params: + query_params.append(('start', params['start'])) # noqa: E501 + if 'end' in params: + query_params.append(('end', params['end'])) # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/payment-received/revenue.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_hosted_payments(self, invoice_id, **kwargs): # noqa: E501 + """get_hosted_payments # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_hosted_payments(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :return: list[HostedPayment] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_hosted_payments_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.get_hosted_payments_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def get_hosted_payments_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """get_hosted_payments # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_hosted_payments_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :return: list[HostedPayment] + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_hosted_payments" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `get_hosted_payments`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoiceID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoiceID}/hosted-payments', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[HostedPayment]', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoice_as_html(self, id, **kwargs): # noqa: E501 + """get_invoice_as_html # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_as_html(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :param bool tier_breakdown: + :param bool inclusive_end: + :param bool show_zero_cost: + :param bool show_plan_only_when_ambiguous: + :param bool include_footer: + :param str header_display: + :param str group_line_items_by: + :param bool hide_tax_if_zero: + :param str show_unit_price: + :param str representing_account_id: + :param bool company_address_on_top: + :param bool upgrade_duration_wording: + :param bool refresh_cache: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoice_as_html_with_http_info(id, **kwargs) # noqa: E501 + else: + (data) = self.get_invoice_as_html_with_http_info(id, **kwargs) # noqa: E501 + return data + + def get_invoice_as_html_with_http_info(self, id, **kwargs): # noqa: E501 + """get_invoice_as_html # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_as_html_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :param bool tier_breakdown: + :param bool inclusive_end: + :param bool show_zero_cost: + :param bool show_plan_only_when_ambiguous: + :param bool include_footer: + :param str header_display: + :param str group_line_items_by: + :param bool hide_tax_if_zero: + :param str show_unit_price: + :param str representing_account_id: + :param bool company_address_on_top: + :param bool upgrade_duration_wording: + :param bool refresh_cache: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'organizations', 'tier_breakdown', 'inclusive_end', 'show_zero_cost', 'show_plan_only_when_ambiguous', 'include_footer', 'header_display', 'group_line_items_by', 'hide_tax_if_zero', 'show_unit_price', 'representing_account_id', 'company_address_on_top', 'upgrade_duration_wording', 'refresh_cache'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoice_as_html" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params or + params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_invoice_as_html`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['ID'] = params['id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'tier_breakdown' in params: + query_params.append(('tier_breakdown', params['tier_breakdown'])) # noqa: E501 + if 'inclusive_end' in params: + query_params.append(('inclusive_end', params['inclusive_end'])) # noqa: E501 + if 'show_zero_cost' in params: + query_params.append(('show_zero_cost', params['show_zero_cost'])) # noqa: E501 + if 'show_plan_only_when_ambiguous' in params: + query_params.append(('show_plan_only_when_ambiguous', params['show_plan_only_when_ambiguous'])) # noqa: E501 + if 'include_footer' in params: + query_params.append(('include_footer', params['include_footer'])) # noqa: E501 + if 'header_display' in params: + query_params.append(('header_display', params['header_display'])) # noqa: E501 + if 'group_line_items_by' in params: + query_params.append(('group_line_items_by', params['group_line_items_by'])) # noqa: E501 + if 'hide_tax_if_zero' in params: + query_params.append(('hide_tax_if_zero', params['hide_tax_if_zero'])) # noqa: E501 + if 'show_unit_price' in params: + query_params.append(('show_unit_price', params['show_unit_price'])) # noqa: E501 + if 'representing_account_id' in params: + query_params.append(('representing_account_id', params['representing_account_id'])) # noqa: E501 + if 'company_address_on_top' in params: + query_params.append(('company_address_on_top', params['company_address_on_top'])) # noqa: E501 + if 'upgrade_duration_wording' in params: + query_params.append(('upgrade_duration_wording', params['upgrade_duration_wording'])) # noqa: E501 + if 'refresh_cache' in params: + query_params.append(('refresh_cache', params['refresh_cache'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{ID}.html', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoice_as_pdf(self, id, **kwargs): # noqa: E501 + """get_invoice_as_pdf # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_as_pdf(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :param int offset: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool tier_breakdown: + :param bool inclusive_end: + :param bool show_zero_cost: + :param bool show_plan_only_when_ambiguous: + :param bool include_footer: + :param str header_display: + :param str group_line_items_by: + :param bool hide_tax_if_zero: + :param str show_unit_price: + :param str representing_account_id: + :param bool company_address_on_top: + :param bool upgrade_duration_wording: + :param bool refresh_cache: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoice_as_pdf_with_http_info(id, **kwargs) # noqa: E501 + else: + (data) = self.get_invoice_as_pdf_with_http_info(id, **kwargs) # noqa: E501 + return data + + def get_invoice_as_pdf_with_http_info(self, id, **kwargs): # noqa: E501 + """get_invoice_as_pdf # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_as_pdf_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :param int offset: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool tier_breakdown: + :param bool inclusive_end: + :param bool show_zero_cost: + :param bool show_plan_only_when_ambiguous: + :param bool include_footer: + :param str header_display: + :param str group_line_items_by: + :param bool hide_tax_if_zero: + :param str show_unit_price: + :param str representing_account_id: + :param bool company_address_on_top: + :param bool upgrade_duration_wording: + :param bool refresh_cache: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'organizations', 'offset', 'order_by', 'order', 'include_retired', 'tier_breakdown', 'inclusive_end', 'show_zero_cost', 'show_plan_only_when_ambiguous', 'include_footer', 'header_display', 'group_line_items_by', 'hide_tax_if_zero', 'show_unit_price', 'representing_account_id', 'company_address_on_top', 'upgrade_duration_wording', 'refresh_cache'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoice_as_pdf" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params or + params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_invoice_as_pdf`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'tier_breakdown' in params: + query_params.append(('tier_breakdown', params['tier_breakdown'])) # noqa: E501 + if 'inclusive_end' in params: + query_params.append(('inclusive_end', params['inclusive_end'])) # noqa: E501 + if 'show_zero_cost' in params: + query_params.append(('show_zero_cost', params['show_zero_cost'])) # noqa: E501 + if 'show_plan_only_when_ambiguous' in params: + query_params.append(('show_plan_only_when_ambiguous', params['show_plan_only_when_ambiguous'])) # noqa: E501 + if 'include_footer' in params: + query_params.append(('include_footer', params['include_footer'])) # noqa: E501 + if 'header_display' in params: + query_params.append(('header_display', params['header_display'])) # noqa: E501 + if 'group_line_items_by' in params: + query_params.append(('group_line_items_by', params['group_line_items_by'])) # noqa: E501 + if 'hide_tax_if_zero' in params: + query_params.append(('hide_tax_if_zero', params['hide_tax_if_zero'])) # noqa: E501 + if 'show_unit_price' in params: + query_params.append(('show_unit_price', params['show_unit_price'])) # noqa: E501 + if 'representing_account_id' in params: + query_params.append(('representing_account_id', params['representing_account_id'])) # noqa: E501 + if 'company_address_on_top' in params: + query_params.append(('company_address_on_top', params['company_address_on_top'])) # noqa: E501 + if 'upgrade_duration_wording' in params: + query_params.append(('upgrade_duration_wording', params['upgrade_duration_wording'])) # noqa: E501 + if 'refresh_cache' in params: + query_params.append(('refresh_cache', params['refresh_cache'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{id}.pdf', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoice_by_id(self, invoice_id, **kwargs): # noqa: E501 + """get_invoice_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_by_id(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoice_by_id_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.get_invoice_by_id_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def get_invoice_by_id_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """get_invoice_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_by_id_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoice_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `get_invoice_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoice_by_id_as_csv(self, id, **kwargs): # noqa: E501 + """get_invoice_by_id_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_by_id_as_csv(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoice_by_id_as_csv_with_http_info(id, **kwargs) # noqa: E501 + else: + (data) = self.get_invoice_by_id_as_csv_with_http_info(id, **kwargs) # noqa: E501 + return data + + def get_invoice_by_id_as_csv_with_http_info(self, id, **kwargs): # noqa: E501 + """get_invoice_by_id_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_by_id_as_csv_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoice_by_id_as_csv" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params or + params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_invoice_by_id_as_csv`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['ID'] = params['id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{ID}.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoice_by_subscription_id(self, subscription_id, **kwargs): # noqa: E501 + """get_invoice_by_subscription_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_by_subscription_id(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoice_by_subscription_id_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.get_invoice_by_subscription_id_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def get_invoice_by_subscription_id_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """get_invoice_by_subscription_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_by_subscription_id_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoice_by_subscription_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_invoice_by_subscription_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/subscription/{subscription-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoice_by_subscription_version_id(self, subscription_version_id, **kwargs): # noqa: E501 + """get_invoice_by_subscription_version_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_by_subscription_version_id(subscription_version_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_version_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoice_by_subscription_version_id_with_http_info(subscription_version_id, **kwargs) # noqa: E501 + else: + (data) = self.get_invoice_by_subscription_version_id_with_http_info(subscription_version_id, **kwargs) # noqa: E501 + return data + + def get_invoice_by_subscription_version_id_with_http_info(self, subscription_version_id, **kwargs): # noqa: E501 + """get_invoice_by_subscription_version_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_by_subscription_version_id_with_http_info(subscription_version_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_version_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_version_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoice_by_subscription_version_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_version_id' is set + if ('subscription_version_id' not in params or + params['subscription_version_id'] is None): + raise ValueError("Missing the required parameter `subscription_version_id` when calling `get_invoice_by_subscription_version_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_version_id' in params: + path_params['subscription-version-ID'] = params['subscription_version_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/subscription/version/{subscription-version-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoice_by_version_id(self, version_id, **kwargs): # noqa: E501 + """get_invoice_by_version_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_by_version_id(version_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str version_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault29 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoice_by_version_id_with_http_info(version_id, **kwargs) # noqa: E501 + else: + (data) = self.get_invoice_by_version_id_with_http_info(version_id, **kwargs) # noqa: E501 + return data + + def get_invoice_by_version_id_with_http_info(self, version_id, **kwargs): # noqa: E501 + """get_invoice_by_version_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_by_version_id_with_http_info(version_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str version_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault29 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['version_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoice_by_version_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'version_id' is set + if ('version_id' not in params or + params['version_id'] is None): + raise ValueError("Missing the required parameter `version_id` when calling `get_invoice_by_version_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'version_id' in params: + path_params['version-ID'] = params['version_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/version/{version-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault29', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoice_template(self, **kwargs): # noqa: E501 + """get_invoice_template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_template(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault30 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoice_template_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_invoice_template_with_http_info(**kwargs) # noqa: E501 + return data + + def get_invoice_template_with_http_info(self, **kwargs): # noqa: E501 + """get_invoice_template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoice_template_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault30 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoice_template" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/template', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault30', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoices_by_account_id1(self, account_id, **kwargs): # noqa: E501 + """get_invoices_by_account_id1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_account_id1(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoices_by_account_id1_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.get_invoices_by_account_id1_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def get_invoices_by_account_id1_with_http_info(self, account_id, **kwargs): # noqa: E501 + """get_invoices_by_account_id1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_account_id1_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoices_by_account_id1" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_invoices_by_account_id1`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'exclude_children' in params: + query_params.append(('exclude_children', params['exclude_children'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/account/{account-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoices_by_period_end(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_invoices_by_period_end # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_period_end(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoices_by_period_end_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + else: + (data) = self.get_invoices_by_period_end_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + return data + + def get_invoices_by_period_end_with_http_info(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_invoices_by_period_end # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_period_end_with_http_info(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoices_by_period_end" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'lower_threshold' is set + if ('lower_threshold' not in params or + params['lower_threshold'] is None): + raise ValueError("Missing the required parameter `lower_threshold` when calling `get_invoices_by_period_end`") # noqa: E501 + # verify the required parameter 'upper_threshold' is set + if ('upper_threshold' not in params or + params['upper_threshold'] is None): + raise ValueError("Missing the required parameter `upper_threshold` when calling `get_invoices_by_period_end`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'lower_threshold' in params: + path_params['lower-threshold'] = params['lower_threshold'] # noqa: E501 + if 'upper_threshold' in params: + path_params['upper-threshold'] = params['upper_threshold'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/period-end/{lower-threshold}/{upper-threshold}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoices_by_period_start(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_invoices_by_period_start # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_period_start(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoices_by_period_start_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + else: + (data) = self.get_invoices_by_period_start_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + return data + + def get_invoices_by_period_start_with_http_info(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_invoices_by_period_start # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_period_start_with_http_info(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoices_by_period_start" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'lower_threshold' is set + if ('lower_threshold' not in params or + params['lower_threshold'] is None): + raise ValueError("Missing the required parameter `lower_threshold` when calling `get_invoices_by_period_start`") # noqa: E501 + # verify the required parameter 'upper_threshold' is set + if ('upper_threshold' not in params or + params['upper_threshold'] is None): + raise ValueError("Missing the required parameter `upper_threshold` when calling `get_invoices_by_period_start`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'lower_threshold' in params: + path_params['lower-threshold'] = params['lower_threshold'] # noqa: E501 + if 'upper_threshold' in params: + path_params['upper-threshold'] = params['upper_threshold'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/period-start/{lower-threshold}/{upper-threshold}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoices_by_period_start_as_csv(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_invoices_by_period_start_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_period_start_as_csv(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoices_by_period_start_as_csv_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + else: + (data) = self.get_invoices_by_period_start_as_csv_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + return data + + def get_invoices_by_period_start_as_csv_with_http_info(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_invoices_by_period_start_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_period_start_as_csv_with_http_info(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoices_by_period_start_as_csv" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'lower_threshold' is set + if ('lower_threshold' not in params or + params['lower_threshold'] is None): + raise ValueError("Missing the required parameter `lower_threshold` when calling `get_invoices_by_period_start_as_csv`") # noqa: E501 + # verify the required parameter 'upper_threshold' is set + if ('upper_threshold' not in params or + params['upper_threshold'] is None): + raise ValueError("Missing the required parameter `upper_threshold` when calling `get_invoices_by_period_start_as_csv`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'lower_threshold' in params: + path_params['lower-threshold'] = params['lower_threshold'] # noqa: E501 + if 'upper_threshold' in params: + path_params['upper-threshold'] = params['upper_threshold'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/period-start/{lower-threshold}/{upper-threshold}.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoices_by_state(self, state, **kwargs): # noqa: E501 + """get_invoices_by_state # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_state(state, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str state: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoices_by_state_with_http_info(state, **kwargs) # noqa: E501 + else: + (data) = self.get_invoices_by_state_with_http_info(state, **kwargs) # noqa: E501 + return data + + def get_invoices_by_state_with_http_info(self, state, **kwargs): # noqa: E501 + """get_invoices_by_state # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_state_with_http_info(state, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str state: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['state', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoices_by_state" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'state' is set + if ('state' not in params or + params['state'] is None): + raise ValueError("Missing the required parameter `state` when calling `get_invoices_by_state`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'state' in params: + path_params['state'] = params['state'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/state/{state}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoices_by_state_and_period_start(self, state, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_invoices_by_state_and_period_start # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_state_and_period_start(state, lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str state: (required) + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoices_by_state_and_period_start_with_http_info(state, lower_threshold, upper_threshold, **kwargs) # noqa: E501 + else: + (data) = self.get_invoices_by_state_and_period_start_with_http_info(state, lower_threshold, upper_threshold, **kwargs) # noqa: E501 + return data + + def get_invoices_by_state_and_period_start_with_http_info(self, state, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_invoices_by_state_and_period_start # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_state_and_period_start_with_http_info(state, lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str state: (required) + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['state', 'lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoices_by_state_and_period_start" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'state' is set + if ('state' not in params or + params['state'] is None): + raise ValueError("Missing the required parameter `state` when calling `get_invoices_by_state_and_period_start`") # noqa: E501 + # verify the required parameter 'lower_threshold' is set + if ('lower_threshold' not in params or + params['lower_threshold'] is None): + raise ValueError("Missing the required parameter `lower_threshold` when calling `get_invoices_by_state_and_period_start`") # noqa: E501 + # verify the required parameter 'upper_threshold' is set + if ('upper_threshold' not in params or + params['upper_threshold'] is None): + raise ValueError("Missing the required parameter `upper_threshold` when calling `get_invoices_by_state_and_period_start`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'state' in params: + path_params['state'] = params['state'] # noqa: E501 + if 'lower_threshold' in params: + path_params['lower-threshold'] = params['lower_threshold'] # noqa: E501 + if 'upper_threshold' in params: + path_params['upper-threshold'] = params['upper_threshold'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoices_by_state_and_period_start_as_csv(self, state, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_invoices_by_state_and_period_start_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_state_and_period_start_as_csv(state, lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str state: (required) + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoices_by_state_and_period_start_as_csv_with_http_info(state, lower_threshold, upper_threshold, **kwargs) # noqa: E501 + else: + (data) = self.get_invoices_by_state_and_period_start_as_csv_with_http_info(state, lower_threshold, upper_threshold, **kwargs) # noqa: E501 + return data + + def get_invoices_by_state_and_period_start_as_csv_with_http_info(self, state, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_invoices_by_state_and_period_start_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_state_and_period_start_as_csv_with_http_info(state, lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str state: (required) + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['state', 'lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoices_by_state_and_period_start_as_csv" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'state' is set + if ('state' not in params or + params['state'] is None): + raise ValueError("Missing the required parameter `state` when calling `get_invoices_by_state_and_period_start_as_csv`") # noqa: E501 + # verify the required parameter 'lower_threshold' is set + if ('lower_threshold' not in params or + params['lower_threshold'] is None): + raise ValueError("Missing the required parameter `lower_threshold` when calling `get_invoices_by_state_and_period_start_as_csv`") # noqa: E501 + # verify the required parameter 'upper_threshold' is set + if ('upper_threshold' not in params or + params['upper_threshold'] is None): + raise ValueError("Missing the required parameter `upper_threshold` when calling `get_invoices_by_state_and_period_start_as_csv`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'state' in params: + path_params['state'] = params['state'] # noqa: E501 + if 'lower_threshold' in params: + path_params['lower-threshold'] = params['lower_threshold'] # noqa: E501 + if 'upper_threshold' in params: + path_params['upper-threshold'] = params['upper_threshold'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoices_by_state_as_csv(self, state, **kwargs): # noqa: E501 + """get_invoices_by_state_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_state_as_csv(state, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str state: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoices_by_state_as_csv_with_http_info(state, **kwargs) # noqa: E501 + else: + (data) = self.get_invoices_by_state_as_csv_with_http_info(state, **kwargs) # noqa: E501 + return data + + def get_invoices_by_state_as_csv_with_http_info(self, state, **kwargs): # noqa: E501 + """get_invoices_by_state_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_by_state_as_csv_with_http_info(state, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str state: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['state', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoices_by_state_as_csv" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'state' is set + if ('state' not in params or + params['state'] is None): + raise ValueError("Missing the required parameter `state` when calling `get_invoices_by_state_as_csv`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'state' in params: + path_params['state'] = params['state'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/state/{state}.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_line_payments(self, **kwargs): # noqa: E501 + """get_line_payments # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_line_payments(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str payment_direction: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param list[str] include_gateway: + :param list[str] exclude_gateway: + :return: InlineResponseDefault31 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_line_payments_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_line_payments_with_http_info(**kwargs) # noqa: E501 + return data + + def get_line_payments_with_http_info(self, **kwargs): # noqa: E501 + """get_line_payments # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_line_payments_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str payment_direction: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param list[str] include_gateway: + :param list[str] exclude_gateway: + :return: InlineResponseDefault31 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'payment_direction', 'date_discriminator', 'recognition_start', 'recognition_end', 'include_gateway', 'exclude_gateway'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_line_payments" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'payment_direction' in params: + query_params.append(('payment_direction', params['payment_direction'])) # noqa: E501 + if 'date_discriminator' in params: + query_params.append(('date_discriminator', params['date_discriminator'])) # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'include_gateway' in params: + query_params.append(('include_gateway', params['include_gateway'])) # noqa: E501 + collection_formats['include_gateway'] = 'multi' # noqa: E501 + if 'exclude_gateway' in params: + query_params.append(('exclude_gateway', params['exclude_gateway'])) # noqa: E501 + collection_formats['exclude_gateway'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/line-payments', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault31', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_line_payments_as_csv(self, **kwargs): # noqa: E501 + """get_line_payments_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_line_payments_as_csv(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str payment_direction: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param list[str] include_gateway: + :param list[str] exclude_gateway: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_line_payments_as_csv_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_line_payments_as_csv_with_http_info(**kwargs) # noqa: E501 + return data + + def get_line_payments_as_csv_with_http_info(self, **kwargs): # noqa: E501 + """get_line_payments_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_line_payments_as_csv_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str payment_direction: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param list[str] include_gateway: + :param list[str] exclude_gateway: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'payment_direction', 'date_discriminator', 'recognition_start', 'recognition_end', 'include_gateway', 'exclude_gateway', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_line_payments_as_csv" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'payment_direction' in params: + query_params.append(('payment_direction', params['payment_direction'])) # noqa: E501 + if 'date_discriminator' in params: + query_params.append(('date_discriminator', params['date_discriminator'])) # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'include_gateway' in params: + query_params.append(('include_gateway', params['include_gateway'])) # noqa: E501 + collection_formats['include_gateway'] = 'multi' # noqa: E501 + if 'exclude_gateway' in params: + query_params.append(('exclude_gateway', params['exclude_gateway'])) # noqa: E501 + collection_formats['exclude_gateway'] = 'multi' # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/line-payments.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_metadata_for_invoice(self, invoice_id, **kwargs): # noqa: E501 + """get_metadata_for_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_metadata_for_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_metadata_for_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.get_metadata_for_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def get_metadata_for_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """get_metadata_for_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_metadata_for_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_metadata_for_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `get_metadata_for_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-ID}/metadata', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault7', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_refund_for_refunded_invoice(self, invoice_id, **kwargs): # noqa: E501 + """get_refund_for_refunded_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_refund_for_refunded_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault32 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_refund_for_refunded_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.get_refund_for_refunded_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def get_refund_for_refunded_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """get_refund_for_refunded_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_refund_for_refunded_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault32 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_refund_for_refunded_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `get_refund_for_refunded_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-ID}/refunds', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault32', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_refund_invoice_line_payments_from_invoices_as_csv(self, **kwargs): # noqa: E501 + """get_refund_invoice_line_payments_from_invoices_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_refund_invoice_line_payments_from_invoices_as_csv(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_refund_invoice_line_payments_from_invoices_as_csv_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_refund_invoice_line_payments_from_invoices_as_csv_with_http_info(**kwargs) # noqa: E501 + return data + + def get_refund_invoice_line_payments_from_invoices_as_csv_with_http_info(self, **kwargs): # noqa: E501 + """get_refund_invoice_line_payments_from_invoices_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_refund_invoice_line_payments_from_invoices_as_csv_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'recognition_start', 'recognition_end', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_refund_invoice_line_payments_from_invoices_as_csv" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/refund.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(self, **kwargs): # noqa: E501 + """get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam start: + :param SimpleDateParam end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received_with_http_info(**kwargs) # noqa: E501 + return data + + def get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received_with_http_info(self, **kwargs): # noqa: E501 + """get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam start: + :param SimpleDateParam end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'start', 'end', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'start' in params: + query_params.append(('start', params['start'])) # noqa: E501 + if 'end' in params: + query_params.append(('end', params['end'])) # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/payment-received/refund.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_revenue_attributions(self, **kwargs): # noqa: E501 + """get_revenue_attributions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_revenue_attributions(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :return: InlineResponseDefault33 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_revenue_attributions_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_revenue_attributions_with_http_info(**kwargs) # noqa: E501 + return data + + def get_revenue_attributions_with_http_info(self, **kwargs): # noqa: E501 + """get_revenue_attributions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_revenue_attributions_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :return: InlineResponseDefault33 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'recognition_start', 'recognition_end'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_revenue_attributions" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/revenue-attributions', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault33', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_revenue_attributions_as_csv(self, **kwargs): # noqa: E501 + """get_revenue_attributions_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_revenue_attributions_as_csv(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_granularity: + :param str date_time_format: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_revenue_attributions_as_csv_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_revenue_attributions_as_csv_with_http_info(**kwargs) # noqa: E501 + return data + + def get_revenue_attributions_as_csv_with_http_info(self, **kwargs): # noqa: E501 + """get_revenue_attributions_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_revenue_attributions_as_csv_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_granularity: + :param str date_time_format: + :param str boolean_format: + :param str monetary_amount_format: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'recognition_start', 'recognition_end', 'date_interval_inclusivity', 'date_granularity', 'date_time_format', 'boolean_format', 'monetary_amount_format'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_revenue_attributions_as_csv" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/revenue-attributions.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_swagger_for_invoice(self, query_string, **kwargs): # noqa: E501 + """get_swagger_for_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_swagger_for_invoice(query_string, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str query_string: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str format: + :param bool wildcard: + :param bool entity: + :return: InlineResponseDefault34 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_swagger_for_invoice_with_http_info(query_string, **kwargs) # noqa: E501 + else: + (data) = self.get_swagger_for_invoice_with_http_info(query_string, **kwargs) # noqa: E501 + return data + + def get_swagger_for_invoice_with_http_info(self, query_string, **kwargs): # noqa: E501 + """get_swagger_for_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_swagger_for_invoice_with_http_info(query_string, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str query_string: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str format: + :param bool wildcard: + :param bool entity: + :return: InlineResponseDefault34 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['query_string', 'organizations', 'offset', 'records', 'format', 'wildcard', 'entity'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_swagger_for_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'query_string' is set + if ('query_string' not in params or + params['query_string'] is None): + raise ValueError("Missing the required parameter `query_string` when calling `get_swagger_for_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'query_string' in params: + path_params['query-string'] = params['query_string'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'format' in params: + query_params.append(('format', params['format'])) # noqa: E501 + if 'wildcard' in params: + query_params.append(('wildcard', params['wildcard'])) # noqa: E501 + if 'entity' in params: + query_params.append(('entity', params['entity'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/swagger-end-point/{query-string}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault34', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def import_invoice(self, **kwargs): # noqa: E501 + """import_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.import_invoice(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param ImportInvoiceRequest body: + :return: InlineResponseDefault29 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.import_invoice_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.import_invoice_with_http_info(**kwargs) # noqa: E501 + return data + + def import_invoice_with_http_info(self, **kwargs): # noqa: E501 + """import_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.import_invoice_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param ImportInvoiceRequest body: + :return: InlineResponseDefault29 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method import_invoice" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/import', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault29', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def issue_invoice(self, invoice_id, **kwargs): # noqa: E501 + """issue_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.issue_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param IssueInvoiceRequest body: + :return: InlineResponseDefault35 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.issue_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.issue_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def issue_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """issue_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.issue_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param IssueInvoiceRequest body: + :return: InlineResponseDefault35 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method issue_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `issue_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-id'] = params['invoice_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['text/plain', 'application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-id}/issue', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault35', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def list_original_invoice(self, invoice_id, **kwargs): # noqa: E501 + """list_original_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.list_original_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.list_original_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.list_original_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def list_original_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """list_original_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.list_original_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method list_original_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `list_original_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-id'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-id}/original', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def list_split_invoice(self, invoice_id, **kwargs): # noqa: E501 + """list_split_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.list_split_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.list_split_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.list_split_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def list_split_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """list_split_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.list_split_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method list_split_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `list_split_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-id'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-id}/split', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def recalculate_invoice(self, invoice_id, **kwargs): # noqa: E501 + """recalculate_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.recalculate_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param InvoiceRecalculationRequest body: + :return: InlineResponseDefault29 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.recalculate_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.recalculate_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def recalculate_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """recalculate_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.recalculate_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param InvoiceRecalculationRequest body: + :return: InlineResponseDefault29 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method recalculate_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `recalculate_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-ID}/recalculate', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault29', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def refund_invoice(self, invoice_id, **kwargs): # noqa: E501 + """refund_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.refund_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param InvoiceRefundRequest body: + :return: InlineResponseDefault36 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.refund_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.refund_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def refund_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """refund_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.refund_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param InvoiceRefundRequest body: + :return: InlineResponseDefault36 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method refund_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `refund_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-id'] = params['invoice_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-id}/refund', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault36', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def remove_charge_from_invoice(self, invoice_id, charge_id, **kwargs): # noqa: E501 + """remove_charge_from_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_charge_from_invoice(invoice_id, charge_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param str charge_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault10 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.remove_charge_from_invoice_with_http_info(invoice_id, charge_id, **kwargs) # noqa: E501 + else: + (data) = self.remove_charge_from_invoice_with_http_info(invoice_id, charge_id, **kwargs) # noqa: E501 + return data + + def remove_charge_from_invoice_with_http_info(self, invoice_id, charge_id, **kwargs): # noqa: E501 + """remove_charge_from_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_charge_from_invoice_with_http_info(invoice_id, charge_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param str charge_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault10 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'charge_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method remove_charge_from_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `remove_charge_from_invoice`") # noqa: E501 + # verify the required parameter 'charge_id' is set + if ('charge_id' not in params or + params['charge_id'] is None): + raise ValueError("Missing the required parameter `charge_id` when calling `remove_charge_from_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + if 'charge_id' in params: + path_params['charge-ID'] = params['charge_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-ID}/charges/{charge-ID}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault10', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def remove_metadata_from_invoice(self, invoice_id, **kwargs): # noqa: E501 + """remove_metadata_from_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_metadata_from_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.remove_metadata_from_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.remove_metadata_from_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def remove_metadata_from_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """remove_metadata_from_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_metadata_from_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method remove_metadata_from_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `remove_metadata_from_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-ID}/metadata', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault7', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def set_metadata_for_invoice(self, invoice_id, **kwargs): # noqa: E501 + """set_metadata_for_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_metadata_for_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param str body: + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.set_metadata_for_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.set_metadata_for_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def set_metadata_for_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """set_metadata_for_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_metadata_for_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param str body: + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'body', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method set_metadata_for_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `set_metadata_for_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-ID}/metadata', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault7', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def split_invoice(self, invoice_id, **kwargs): # noqa: E501 + """split_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.split_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param InvoiceSplitServiceRequest body: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.split_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.split_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def split_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """split_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.split_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param InvoiceSplitServiceRequest body: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method split_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `split_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-id'] = params['invoice_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-id}/split', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_invoice(self, **kwargs): # noqa: E501 + """update_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_invoice(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UpdateInvoiceRequest body: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_invoice_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_invoice_with_http_info(**kwargs) # noqa: E501 + return data + + def update_invoice_with_http_info(self, **kwargs): # noqa: E501 + """update_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_invoice_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UpdateInvoiceRequest body: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_invoice" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_invoice_template(self, **kwargs): # noqa: E501 + """update_invoice_template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_invoice_template(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UpdateInvoiceTemplateRequest body: + :return: InlineResponseDefault30 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_invoice_template_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_invoice_template_with_http_info(**kwargs) # noqa: E501 + return data + + def update_invoice_template_with_http_info(self, **kwargs): # noqa: E501 + """update_invoice_template # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_invoice_template_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UpdateInvoiceTemplateRequest body: + :return: InlineResponseDefault30 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_invoice_template" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/template', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault30', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def upsert_metadata_for_invoice(self, invoice_id, **kwargs): # noqa: E501 + """upsert_metadata_for_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upsert_metadata_for_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param str body: + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.upsert_metadata_for_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.upsert_metadata_for_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def upsert_metadata_for_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """upsert_metadata_for_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upsert_metadata_for_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param str body: + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'body', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method upsert_metadata_for_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `upsert_metadata_for_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-ID}/metadata', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault7', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def void_invoice(self, invoice_id, **kwargs): # noqa: E501 + """void_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.void_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :param bool void_charges: + :return: InlineResponseDefault29 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.void_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.void_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def void_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """void_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.void_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :param bool void_charges: + :return: InlineResponseDefault29 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'organizations', 'void_charges'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method void_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `void_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'void_charges' in params: + query_params.append(('void_charges', params['void_charges'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/invoices/{invoice-ID}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault29', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/notifications_api.py b/billforward/api/notifications_api.py new file mode 100644 index 0000000..dbd792e --- /dev/null +++ b/billforward/api/notifications_api.py @@ -0,0 +1,740 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class NotificationsApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def get_all_notifications(self, **kwargs): # noqa: E501 + """get_all_notifications # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_notifications(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault37 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_notifications_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_notifications_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_notifications_with_http_info(self, **kwargs): # noqa: E501 + """get_all_notifications # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_notifications_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault37 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_notifications" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/notifications', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault37', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_notification_by_entity_id(self, entity_id, **kwargs): # noqa: E501 + """get_notification_by_entity_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_notification_by_entity_id(entity_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str entity_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault37 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_notification_by_entity_id_with_http_info(entity_id, **kwargs) # noqa: E501 + else: + (data) = self.get_notification_by_entity_id_with_http_info(entity_id, **kwargs) # noqa: E501 + return data + + def get_notification_by_entity_id_with_http_info(self, entity_id, **kwargs): # noqa: E501 + """get_notification_by_entity_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_notification_by_entity_id_with_http_info(entity_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str entity_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault37 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['entity_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_notification_by_entity_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'entity_id' is set + if ('entity_id' not in params or + params['entity_id'] is None): + raise ValueError("Missing the required parameter `entity_id` when calling `get_notification_by_entity_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'entity_id' in params: + path_params['entity-ID'] = params['entity_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/notifications/entity-ID/{entity-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault37', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_notification_by_id(self, notification_id, **kwargs): # noqa: E501 + """get_notification_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_notification_by_id(notification_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str notification_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault38 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_notification_by_id_with_http_info(notification_id, **kwargs) # noqa: E501 + else: + (data) = self.get_notification_by_id_with_http_info(notification_id, **kwargs) # noqa: E501 + return data + + def get_notification_by_id_with_http_info(self, notification_id, **kwargs): # noqa: E501 + """get_notification_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_notification_by_id_with_http_info(notification_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str notification_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault38 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['notification_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_notification_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'notification_id' is set + if ('notification_id' not in params or + params['notification_id'] is None): + raise ValueError("Missing the required parameter `notification_id` when calling `get_notification_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'notification_id' in params: + path_params['notification-ID'] = params['notification_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/notifications/{notification-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault38', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_notifications_by_webhook_id(self, lower_threshold, upper_threshold, webhook_id, **kwargs): # noqa: E501 + """get_notifications_by_webhook_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_notifications_by_webhook_id(lower_threshold, upper_threshold, webhook_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param str webhook_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param int safety_margin: + :return: InlineResponseDefault37 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_notifications_by_webhook_id_with_http_info(lower_threshold, upper_threshold, webhook_id, **kwargs) # noqa: E501 + else: + (data) = self.get_notifications_by_webhook_id_with_http_info(lower_threshold, upper_threshold, webhook_id, **kwargs) # noqa: E501 + return data + + def get_notifications_by_webhook_id_with_http_info(self, lower_threshold, upper_threshold, webhook_id, **kwargs): # noqa: E501 + """get_notifications_by_webhook_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_notifications_by_webhook_id_with_http_info(lower_threshold, upper_threshold, webhook_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param str webhook_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param int safety_margin: + :return: InlineResponseDefault37 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['lower_threshold', 'upper_threshold', 'webhook_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'safety_margin'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_notifications_by_webhook_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'lower_threshold' is set + if ('lower_threshold' not in params or + params['lower_threshold'] is None): + raise ValueError("Missing the required parameter `lower_threshold` when calling `get_notifications_by_webhook_id`") # noqa: E501 + # verify the required parameter 'upper_threshold' is set + if ('upper_threshold' not in params or + params['upper_threshold'] is None): + raise ValueError("Missing the required parameter `upper_threshold` when calling `get_notifications_by_webhook_id`") # noqa: E501 + # verify the required parameter 'webhook_id' is set + if ('webhook_id' not in params or + params['webhook_id'] is None): + raise ValueError("Missing the required parameter `webhook_id` when calling `get_notifications_by_webhook_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'lower_threshold' in params: + path_params['lower-threshold'] = params['lower_threshold'] # noqa: E501 + if 'upper_threshold' in params: + path_params['upper-threshold'] = params['upper_threshold'] # noqa: E501 + if 'webhook_id' in params: + path_params['webhookID'] = params['webhook_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'safety_margin' in params: + query_params.append(('safety_margin', params['safety_margin'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/notifications/{lower-threshold}/{upper-threshold}/{webhookID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault37', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_notifications_within_date_range(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_notifications_within_date_range # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_notifications_within_date_range(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param str domain: + :param str action: + :param str webhook_id: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param int safety_margin: + :return: InlineResponseDefault37 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_notifications_within_date_range_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + else: + (data) = self.get_notifications_within_date_range_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + return data + + def get_notifications_within_date_range_with_http_info(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_notifications_within_date_range # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_notifications_within_date_range_with_http_info(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param str domain: + :param str action: + :param str webhook_id: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param int safety_margin: + :return: InlineResponseDefault37 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'domain', 'action', 'webhook_id', 'offset', 'records', 'order_by', 'order', 'include_retired', 'safety_margin'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_notifications_within_date_range" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'lower_threshold' is set + if ('lower_threshold' not in params or + params['lower_threshold'] is None): + raise ValueError("Missing the required parameter `lower_threshold` when calling `get_notifications_within_date_range`") # noqa: E501 + # verify the required parameter 'upper_threshold' is set + if ('upper_threshold' not in params or + params['upper_threshold'] is None): + raise ValueError("Missing the required parameter `upper_threshold` when calling `get_notifications_within_date_range`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'lower_threshold' in params: + path_params['lower-threshold'] = params['lower_threshold'] # noqa: E501 + if 'upper_threshold' in params: + path_params['upper-threshold'] = params['upper_threshold'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'domain' in params: + query_params.append(('domain', params['domain'])) # noqa: E501 + if 'action' in params: + query_params.append(('action', params['action'])) # noqa: E501 + if 'webhook_id' in params: + query_params.append(('webhookID', params['webhook_id'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'safety_margin' in params: + query_params.append(('safety_margin', params['safety_margin'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/notifications/{lower-threshold}/{upper-threshold}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault37', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def resend_notification(self, notification_id, **kwargs): # noqa: E501 + """resend_notification # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.resend_notification(notification_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str notification_id: (required) + :param NotificationSendRequest body: + :return: InlineResponseDefault39 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.resend_notification_with_http_info(notification_id, **kwargs) # noqa: E501 + else: + (data) = self.resend_notification_with_http_info(notification_id, **kwargs) # noqa: E501 + return data + + def resend_notification_with_http_info(self, notification_id, **kwargs): # noqa: E501 + """resend_notification # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.resend_notification_with_http_info(notification_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str notification_id: (required) + :param NotificationSendRequest body: + :return: InlineResponseDefault39 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['notification_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method resend_notification" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'notification_id' is set + if ('notification_id' not in params or + params['notification_id'] is None): + raise ValueError("Missing the required parameter `notification_id` when calling `resend_notification`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'notification_id' in params: + path_params['notification-ID'] = params['notification_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/notifications/{notification-ID}/resend', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault39', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/payment_gateway_api.py b/billforward/api/payment_gateway_api.py new file mode 100644 index 0000000..2b88d7b --- /dev/null +++ b/billforward/api/payment_gateway_api.py @@ -0,0 +1,528 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class PaymentGatewayApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def create_api_configuration(self, **kwargs): # noqa: E501 + """create_api_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_api_configuration(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param APIConfiguration body: + :return: InlineResponseDefault14 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_api_configuration_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_api_configuration_with_http_info(**kwargs) # noqa: E501 + return data + + def create_api_configuration_with_http_info(self, **kwargs): # noqa: E501 + """create_api_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_api_configuration_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param APIConfiguration body: + :return: InlineResponseDefault14 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_api_configuration" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/configurations', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault14', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_api_configurations(self, **kwargs): # noqa: E501 + """get_all_api_configurations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_api_configurations(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault18 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_api_configurations_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_api_configurations_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_api_configurations_with_http_info(self, **kwargs): # noqa: E501 + """get_all_api_configurations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_api_configurations_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault18 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_api_configurations" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/configurations', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault18', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_api_configurations_by_type(self, configuration_type, **kwargs): # noqa: E501 + """get_api_configurations_by_type # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_api_configurations_by_type(configuration_type, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str configuration_type: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault18 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_api_configurations_by_type_with_http_info(configuration_type, **kwargs) # noqa: E501 + else: + (data) = self.get_api_configurations_by_type_with_http_info(configuration_type, **kwargs) # noqa: E501 + return data + + def get_api_configurations_by_type_with_http_info(self, configuration_type, **kwargs): # noqa: E501 + """get_api_configurations_by_type # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_api_configurations_by_type_with_http_info(configuration_type, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str configuration_type: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault18 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['configuration_type', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_api_configurations_by_type" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'configuration_type' is set + if ('configuration_type' not in params or + params['configuration_type'] is None): + raise ValueError("Missing the required parameter `configuration_type` when calling `get_api_configurations_by_type`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'configuration_type' in params: + path_params['configuration-type'] = params['configuration_type'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/configurations/type/{configuration-type}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault18', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def public_configuration(self, **kwargs): # noqa: E501 + """public_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.public_configuration(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str organization_id: + :return: PublicConfigurationResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.public_configuration_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.public_configuration_with_http_info(**kwargs) # noqa: E501 + return data + + def public_configuration_with_http_info(self, **kwargs): # noqa: E501 + """public_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.public_configuration_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str organization_id: + :return: PublicConfigurationResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organization_id'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method public_configuration" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organization_id' in params: + query_params.append(('organizationID', params['organization_id'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/configurations/public', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='PublicConfigurationResponse', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_api_configuration(self, **kwargs): # noqa: E501 + """update_api_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_api_configuration(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param APIConfiguration body: + :return: InlineResponseDefault14 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_api_configuration_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_api_configuration_with_http_info(**kwargs) # noqa: E501 + return data + + def update_api_configuration_with_http_info(self, **kwargs): # noqa: E501 + """update_api_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_api_configuration_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param APIConfiguration body: + :return: InlineResponseDefault14 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_api_configuration" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/configurations', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault14', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/payment_methods_api.py b/billforward/api/payment_methods_api.py new file mode 100644 index 0000000..133022b --- /dev/null +++ b/billforward/api/payment_methods_api.py @@ -0,0 +1,952 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class PaymentMethodsApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def create_payment_method(self, **kwargs): # noqa: E501 + """create_payment_method # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_payment_method(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param PaymentMethod body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_payment_method_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_payment_method_with_http_info(**kwargs) # noqa: E501 + return data + + def create_payment_method_with_http_info(self, **kwargs): # noqa: E501 + """create_payment_method # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_payment_method_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param PaymentMethod body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_payment_method" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['text/plain', 'application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payment-methods', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault40', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def delete_payment_method(self, payment_method_id, **kwargs): # noqa: E501 + """delete_payment_method # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_payment_method(payment_method_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_method_id: (required) + :param bool delete_gateway_data: + :param list[str] organizations: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.delete_payment_method_with_http_info(payment_method_id, **kwargs) # noqa: E501 + else: + (data) = self.delete_payment_method_with_http_info(payment_method_id, **kwargs) # noqa: E501 + return data + + def delete_payment_method_with_http_info(self, payment_method_id, **kwargs): # noqa: E501 + """delete_payment_method # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_payment_method_with_http_info(payment_method_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_method_id: (required) + :param bool delete_gateway_data: + :param list[str] organizations: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['payment_method_id', 'delete_gateway_data', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_payment_method" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'payment_method_id' is set + if ('payment_method_id' not in params or + params['payment_method_id'] is None): + raise ValueError("Missing the required parameter `payment_method_id` when calling `delete_payment_method`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'payment_method_id' in params: + path_params['payment-method-ID'] = params['payment_method_id'] # noqa: E501 + + query_params = [] + if 'delete_gateway_data' in params: + query_params.append(('delete_gateway_data', params['delete_gateway_data'])) # noqa: E501 + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payment-methods/{payment-method-ID}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault40', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_payment_methods(self, **kwargs): # noqa: E501 + """get_all_payment_methods # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_payment_methods(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str routing_number: + :param str account_number: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault9 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_payment_methods_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_payment_methods_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_payment_methods_with_http_info(self, **kwargs): # noqa: E501 + """get_all_payment_methods # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_payment_methods_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str routing_number: + :param str account_number: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault9 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'routing_number', 'account_number', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_payment_methods" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'routing_number' in params: + query_params.append(('routing_number', params['routing_number'])) # noqa: E501 + if 'account_number' in params: + query_params.append(('account_number', params['account_number'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payment-methods', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault9', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_mandate_pdf(self, payment_method_id, **kwargs): # noqa: E501 + """get_mandate_pdf # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_mandate_pdf(payment_method_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_method_id: (required) + :param list[str] organizations: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_mandate_pdf_with_http_info(payment_method_id, **kwargs) # noqa: E501 + else: + (data) = self.get_mandate_pdf_with_http_info(payment_method_id, **kwargs) # noqa: E501 + return data + + def get_mandate_pdf_with_http_info(self, payment_method_id, **kwargs): # noqa: E501 + """get_mandate_pdf # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_mandate_pdf_with_http_info(payment_method_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_method_id: (required) + :param list[str] organizations: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['payment_method_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_mandate_pdf" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'payment_method_id' is set + if ('payment_method_id' not in params or + params['payment_method_id'] is None): + raise ValueError("Missing the required parameter `payment_method_id` when calling `get_mandate_pdf`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'payment_method_id' in params: + path_params['payment-method-ID'] = params['payment_method_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payment-methods/{payment-method-ID}/mandate.pdf', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_payment_method_by_id(self, payment_method_id, **kwargs): # noqa: E501 + """get_payment_method_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_method_by_id(payment_method_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_method_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_payment_method_by_id_with_http_info(payment_method_id, **kwargs) # noqa: E501 + else: + (data) = self.get_payment_method_by_id_with_http_info(payment_method_id, **kwargs) # noqa: E501 + return data + + def get_payment_method_by_id_with_http_info(self, payment_method_id, **kwargs): # noqa: E501 + """get_payment_method_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_method_by_id_with_http_info(payment_method_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_method_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['payment_method_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_payment_method_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'payment_method_id' is set + if ('payment_method_id' not in params or + params['payment_method_id'] is None): + raise ValueError("Missing the required parameter `payment_method_id` when calling `get_payment_method_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'payment_method_id' in params: + path_params['payment-method-ID'] = params['payment_method_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payment-methods/{payment-method-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault40', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_payment_method_by_link_id(self, link_id, **kwargs): # noqa: E501 + """get_payment_method_by_link_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_method_by_link_id(link_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str link_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault9 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_payment_method_by_link_id_with_http_info(link_id, **kwargs) # noqa: E501 + else: + (data) = self.get_payment_method_by_link_id_with_http_info(link_id, **kwargs) # noqa: E501 + return data + + def get_payment_method_by_link_id_with_http_info(self, link_id, **kwargs): # noqa: E501 + """get_payment_method_by_link_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_method_by_link_id_with_http_info(link_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str link_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault9 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['link_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_payment_method_by_link_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'link_id' is set + if ('link_id' not in params or + params['link_id'] is None): + raise ValueError("Missing the required parameter `link_id` when calling `get_payment_method_by_link_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'link_id' in params: + path_params['linkID'] = params['link_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payment-methods/link-id/{linkID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault9', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_payment_method_by_payment_gateway(self, gateway, **kwargs): # noqa: E501 + """get_payment_method_by_payment_gateway # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_method_by_payment_gateway(gateway, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str gateway: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault9 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_payment_method_by_payment_gateway_with_http_info(gateway, **kwargs) # noqa: E501 + else: + (data) = self.get_payment_method_by_payment_gateway_with_http_info(gateway, **kwargs) # noqa: E501 + return data + + def get_payment_method_by_payment_gateway_with_http_info(self, gateway, **kwargs): # noqa: E501 + """get_payment_method_by_payment_gateway # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_method_by_payment_gateway_with_http_info(gateway, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str gateway: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault9 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['gateway', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_payment_method_by_payment_gateway" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'gateway' is set + if ('gateway' not in params or + params['gateway'] is None): + raise ValueError("Missing the required parameter `gateway` when calling `get_payment_method_by_payment_gateway`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'gateway' in params: + path_params['gateway'] = params['gateway'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payment-methods/gateway/{gateway}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault9', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_payment_method(self, **kwargs): # noqa: E501 + """update_payment_method # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_payment_method(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param PaymentMethod body: + :param bool delete_gateway_data: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_payment_method_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_payment_method_with_http_info(**kwargs) # noqa: E501 + return data + + def update_payment_method_with_http_info(self, **kwargs): # noqa: E501 + """update_payment_method # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_payment_method_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param PaymentMethod body: + :param bool delete_gateway_data: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body', 'delete_gateway_data'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_payment_method" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'delete_gateway_data' in params: + query_params.append(('delete_gateway_data', params['delete_gateway_data'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['text/plain', 'application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payment-methods', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault40', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def verify_ach(self, payment_method_id, **kwargs): # noqa: E501 + """verify_ach # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.verify_ach(payment_method_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_method_id: (required) + :param VerifyPaymentMethodRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.verify_ach_with_http_info(payment_method_id, **kwargs) # noqa: E501 + else: + (data) = self.verify_ach_with_http_info(payment_method_id, **kwargs) # noqa: E501 + return data + + def verify_ach_with_http_info(self, payment_method_id, **kwargs): # noqa: E501 + """verify_ach # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.verify_ach_with_http_info(payment_method_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_method_id: (required) + :param VerifyPaymentMethodRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['payment_method_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method verify_ach" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'payment_method_id' is set + if ('payment_method_id' not in params or + params['payment_method_id'] is None): + raise ValueError("Missing the required parameter `payment_method_id` when calling `verify_ach`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'payment_method_id' in params: + path_params['payment-method-ID'] = params['payment_method_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payment-methods/{payment-method-ID}/verify/micro-deposits', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault40', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/payments_api.py b/billforward/api/payments_api.py new file mode 100644 index 0000000..854c0b7 --- /dev/null +++ b/billforward/api/payments_api.py @@ -0,0 +1,1095 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class PaymentsApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def create_offline_payment(self, **kwargs): # noqa: E501 + """create_offline_payment # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_offline_payment(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateOfflinePaymentRequest body: + :return: InlineResponseDefault41 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_offline_payment_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_offline_payment_with_http_info(**kwargs) # noqa: E501 + return data + + def create_offline_payment_with_http_info(self, **kwargs): # noqa: E501 + """create_offline_payment # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_offline_payment_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateOfflinePaymentRequest body: + :return: InlineResponseDefault41 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_offline_payment" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payments/offline', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault41', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_payment(self, **kwargs): # noqa: E501 + """create_payment # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_payment(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Payment body: + :return: InlineResponseDefault41 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_payment_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_payment_with_http_info(**kwargs) # noqa: E501 + return data + + def create_payment_with_http_info(self, **kwargs): # noqa: E501 + """create_payment # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_payment_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Payment body: + :return: InlineResponseDefault41 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_payment" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payments', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault41', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_payments(self, **kwargs): # noqa: E501 + """get_all_payments # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_payments(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param list[str] account_id: + :param list[str] subscription_id: + :return: InlineResponseDefault42 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_payments_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_payments_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_payments_with_http_info(self, **kwargs): # noqa: E501 + """get_all_payments # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_payments_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param list[str] account_id: + :param list[str] subscription_id: + :return: InlineResponseDefault42 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'account_id', 'subscription_id'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_payments" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'account_id' in params: + query_params.append(('account_id[]', params['account_id'])) # noqa: E501 + collection_formats['account_id[]'] = 'multi' # noqa: E501 + if 'subscription_id' in params: + query_params.append(('subscription_id[]', params['subscription_id'])) # noqa: E501 + collection_formats['subscription_id[]'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payments', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault42', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_payment_as_csv(self, **kwargs): # noqa: E501 + """get_payment_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_as_csv(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam received_start: + :param SimpleDateParam received_end: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_payment_as_csv_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_payment_as_csv_with_http_info(**kwargs) # noqa: E501 + return data + + def get_payment_as_csv_with_http_info(self, **kwargs): # noqa: E501 + """get_payment_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_as_csv_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam received_start: + :param SimpleDateParam received_end: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'received_start', 'received_end', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_payment_as_csv" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'received_start' in params: + query_params.append(('received_start', params['received_start'])) # noqa: E501 + if 'received_end' in params: + query_params.append(('received_end', params['received_end'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payments/csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_payment_by_id(self, payment_id, **kwargs): # noqa: E501 + """get_payment_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_by_id(payment_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault41 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_payment_by_id_with_http_info(payment_id, **kwargs) # noqa: E501 + else: + (data) = self.get_payment_by_id_with_http_info(payment_id, **kwargs) # noqa: E501 + return data + + def get_payment_by_id_with_http_info(self, payment_id, **kwargs): # noqa: E501 + """get_payment_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_by_id_with_http_info(payment_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault41 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['payment_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_payment_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'payment_id' is set + if ('payment_id' not in params or + params['payment_id'] is None): + raise ValueError("Missing the required parameter `payment_id` when calling `get_payment_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'payment_id' in params: + path_params['payment-ID'] = params['payment_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payments/{payment-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault41', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_payment_by_invoice_id(self, invoice_id, **kwargs): # noqa: E501 + """get_payment_by_invoice_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_by_invoice_id(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault42 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_payment_by_invoice_id_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.get_payment_by_invoice_id_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def get_payment_by_invoice_id_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """get_payment_by_invoice_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_by_invoice_id_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault42 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_payment_by_invoice_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `get_payment_by_invoice_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payments/invoice/{invoice-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault42', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_payment_by_payment_gateway(self, gateway, **kwargs): # noqa: E501 + """get_payment_by_payment_gateway # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_by_payment_gateway(gateway, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str gateway: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault42 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_payment_by_payment_gateway_with_http_info(gateway, **kwargs) # noqa: E501 + else: + (data) = self.get_payment_by_payment_gateway_with_http_info(gateway, **kwargs) # noqa: E501 + return data + + def get_payment_by_payment_gateway_with_http_info(self, gateway, **kwargs): # noqa: E501 + """get_payment_by_payment_gateway # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_by_payment_gateway_with_http_info(gateway, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str gateway: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault42 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['gateway', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_payment_by_payment_gateway" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'gateway' is set + if ('gateway' not in params or + params['gateway'] is None): + raise ValueError("Missing the required parameter `gateway` when calling `get_payment_by_payment_gateway`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'gateway' in params: + path_params['gateway'] = params['gateway'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payments/gateway/{gateway}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault42', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_payment_by_payment_method_id(self, payment_method_id, **kwargs): # noqa: E501 + """get_payment_by_payment_method_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_by_payment_method_id(payment_method_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_method_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault42 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_payment_by_payment_method_id_with_http_info(payment_method_id, **kwargs) # noqa: E501 + else: + (data) = self.get_payment_by_payment_method_id_with_http_info(payment_method_id, **kwargs) # noqa: E501 + return data + + def get_payment_by_payment_method_id_with_http_info(self, payment_method_id, **kwargs): # noqa: E501 + """get_payment_by_payment_method_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_by_payment_method_id_with_http_info(payment_method_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_method_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault42 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['payment_method_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_payment_by_payment_method_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'payment_method_id' is set + if ('payment_method_id' not in params or + params['payment_method_id'] is None): + raise ValueError("Missing the required parameter `payment_method_id` when calling `get_payment_by_payment_method_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'payment_method_id' in params: + path_params['payment-method-ID'] = params['payment_method_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payments/payment-method/{payment-method-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault42', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def refund_payment(self, payment_id, **kwargs): # noqa: E501 + """refund_payment # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.refund_payment(payment_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_id: (required) + :param PaymentRefundRequest body: + :return: InlineResponseDefault43 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.refund_payment_with_http_info(payment_id, **kwargs) # noqa: E501 + else: + (data) = self.refund_payment_with_http_info(payment_id, **kwargs) # noqa: E501 + return data + + def refund_payment_with_http_info(self, payment_id, **kwargs): # noqa: E501 + """refund_payment # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.refund_payment_with_http_info(payment_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_id: (required) + :param PaymentRefundRequest body: + :return: InlineResponseDefault43 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['payment_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method refund_payment" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'payment_id' is set + if ('payment_id' not in params or + params['payment_id'] is None): + raise ValueError("Missing the required parameter `payment_id` when calling `refund_payment`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'payment_id' in params: + path_params['payment_id'] = params['payment_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payments/{payment_id}/refund', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault43', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_payment(self, **kwargs): # noqa: E501 + """update_payment # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_payment(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Payment body: + :return: InlineResponseDefault41 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_payment_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_payment_with_http_info(**kwargs) # noqa: E501 + return data + + def update_payment_with_http_info(self, **kwargs): # noqa: E501 + """update_payment # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_payment_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Payment body: + :return: InlineResponseDefault41 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_payment" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/payments', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault41', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/permissions_api.py b/billforward/api/permissions_api.py new file mode 100644 index 0000000..a40eaed --- /dev/null +++ b/billforward/api/permissions_api.py @@ -0,0 +1,624 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class PermissionsApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def create_permission(self, **kwargs): # noqa: E501 + """create_permission # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_permission(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreatePermissionRequest body: + :return: InlineResponseDefault45 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_permission_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_permission_with_http_info(**kwargs) # noqa: E501 + return data + + def create_permission_with_http_info(self, **kwargs): # noqa: E501 + """create_permission # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_permission_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreatePermissionRequest body: + :return: InlineResponseDefault45 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_permission" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/permissions', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault45', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_permissions(self, **kwargs): # noqa: E501 + """get_all_permissions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_permissions(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault44 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_permissions_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_permissions_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_permissions_with_http_info(self, **kwargs): # noqa: E501 + """get_all_permissions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_permissions_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault44 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_permissions" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/permissions', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault44', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_available_actions_for_resource(self, resource, **kwargs): # noqa: E501 + """get_available_actions_for_resource # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_available_actions_for_resource(resource, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str resource: (required) + :param list[str] organizations: + :return: InlineResponseDefault46 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_available_actions_for_resource_with_http_info(resource, **kwargs) # noqa: E501 + else: + (data) = self.get_available_actions_for_resource_with_http_info(resource, **kwargs) # noqa: E501 + return data + + def get_available_actions_for_resource_with_http_info(self, resource, **kwargs): # noqa: E501 + """get_available_actions_for_resource # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_available_actions_for_resource_with_http_info(resource, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str resource: (required) + :param list[str] organizations: + :return: InlineResponseDefault46 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['resource', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_available_actions_for_resource" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'resource' is set + if ('resource' not in params or + params['resource'] is None): + raise ValueError("Missing the required parameter `resource` when calling `get_available_actions_for_resource`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'resource' in params: + path_params['resource'] = params['resource'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/permissions/resources/{resource}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault46', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_available_resources(self, **kwargs): # noqa: E501 + """get_available_resources # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_available_resources(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault47 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_available_resources_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_available_resources_with_http_info(**kwargs) # noqa: E501 + return data + + def get_available_resources_with_http_info(self, **kwargs): # noqa: E501 + """get_available_resources # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_available_resources_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault47 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_available_resources" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/permissions/resources', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault47', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_permission_by_id(self, permission_id, **kwargs): # noqa: E501 + """get_permission_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_permission_by_id(permission_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str permission_id: (required) + :param list[str] organizations: + :param bool include_retired: + :return: InlineResponseDefault45 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_permission_by_id_with_http_info(permission_id, **kwargs) # noqa: E501 + else: + (data) = self.get_permission_by_id_with_http_info(permission_id, **kwargs) # noqa: E501 + return data + + def get_permission_by_id_with_http_info(self, permission_id, **kwargs): # noqa: E501 + """get_permission_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_permission_by_id_with_http_info(permission_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str permission_id: (required) + :param list[str] organizations: + :param bool include_retired: + :return: InlineResponseDefault45 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['permission_id', 'organizations', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_permission_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'permission_id' is set + if ('permission_id' not in params or + params['permission_id'] is None): + raise ValueError("Missing the required parameter `permission_id` when calling `get_permission_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'permission_id' in params: + path_params['permission-ID'] = params['permission_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/permissions/{permission-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault45', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def revoke_permission(self, permission_id, **kwargs): # noqa: E501 + """revoke_permission # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.revoke_permission(permission_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str permission_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault45 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.revoke_permission_with_http_info(permission_id, **kwargs) # noqa: E501 + else: + (data) = self.revoke_permission_with_http_info(permission_id, **kwargs) # noqa: E501 + return data + + def revoke_permission_with_http_info(self, permission_id, **kwargs): # noqa: E501 + """revoke_permission # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.revoke_permission_with_http_info(permission_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str permission_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault45 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['permission_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method revoke_permission" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'permission_id' is set + if ('permission_id' not in params or + params['permission_id'] is None): + raise ValueError("Missing the required parameter `permission_id` when calling `revoke_permission`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'permission_id' in params: + path_params['permission-ID'] = params['permission_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/permissions/{permission-ID}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault45', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/plans_api.py b/billforward/api/plans_api.py new file mode 100644 index 0000000..ca5cfbf --- /dev/null +++ b/billforward/api/plans_api.py @@ -0,0 +1,334 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class PlansApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def delete(self, path, **kwargs): # noqa: E501 + """delete # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete(path, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str path: (required) + :param list[str] organizations: + :return: InlineResponseDefault25 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.delete_with_http_info(path, **kwargs) # noqa: E501 + else: + (data) = self.delete_with_http_info(path, **kwargs) # noqa: E501 + return data + + def delete_with_http_info(self, path, **kwargs): # noqa: E501 + """delete # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_with_http_info(path, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str path: (required) + :param list[str] organizations: + :return: InlineResponseDefault25 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['path', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'path' is set + if ('path' not in params or + params['path'] is None): + raise ValueError("Missing the required parameter `path` when calling `delete`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'path' in params: + path_params['path'] = params['path'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/plans/{path}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault25', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def find(self, path, **kwargs): # noqa: E501 + """find # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.find(path, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str path: (required) + :param int records: + :param list[str] organizations: + :param bool with_pricing: + :param bool with_metadata: + :return: InlineResponseDefault25 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.find_with_http_info(path, **kwargs) # noqa: E501 + else: + (data) = self.find_with_http_info(path, **kwargs) # noqa: E501 + return data + + def find_with_http_info(self, path, **kwargs): # noqa: E501 + """find # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.find_with_http_info(path, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str path: (required) + :param int records: + :param list[str] organizations: + :param bool with_pricing: + :param bool with_metadata: + :return: InlineResponseDefault25 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['path', 'records', 'organizations', 'with_pricing', 'with_metadata'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method find" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'path' is set + if ('path' not in params or + params['path'] is None): + raise ValueError("Missing the required parameter `path` when calling `find`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'path' in params: + path_params['path'] = params['path'] # noqa: E501 + + query_params = [] + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'with_pricing' in params: + query_params.append(('with-pricing', params['with_pricing'])) # noqa: E501 + if 'with_metadata' in params: + query_params.append(('with-metadata', params['with_metadata'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/plans/{path}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault25', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def upsert(self, **kwargs): # noqa: E501 + """upsert # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upsert(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[PlanRequest] body: + :return: InlineResponseDefault25 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.upsert_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.upsert_with_http_info(**kwargs) # noqa: E501 + return data + + def upsert_with_http_info(self, **kwargs): # noqa: E501 + """upsert # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upsert_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[PlanRequest] body: + :return: InlineResponseDefault25 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method upsert" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['text/plain', 'application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/plans', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault25', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/quotes_api.py b/billforward/api/quotes_api.py new file mode 100644 index 0000000..2ee5354 --- /dev/null +++ b/billforward/api/quotes_api.py @@ -0,0 +1,340 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class QuotesApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def get_all_quotes(self, **kwargs): # noqa: E501 + """get_all_quotes # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_quotes(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] account_id: + :param list[str] subscription_id: + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault52 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_quotes_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_quotes_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_quotes_with_http_info(self, **kwargs): # noqa: E501 + """get_all_quotes # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_quotes_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] account_id: + :param list[str] subscription_id: + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault52 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_quotes" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'account_id' in params: + query_params.append(('account_id[]', params['account_id'])) # noqa: E501 + collection_formats['account_id[]'] = 'multi' # noqa: E501 + if 'subscription_id' in params: + query_params.append(('subscription_id[]', params['subscription_id'])) # noqa: E501 + collection_formats['subscription_id[]'] = 'multi' # noqa: E501 + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/quotes', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault52', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_quote_by_id(self, id, **kwargs): # noqa: E501 + """get_quote_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_quote_by_id(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :return: InlineResponseDefault53 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_quote_by_id_with_http_info(id, **kwargs) # noqa: E501 + else: + (data) = self.get_quote_by_id_with_http_info(id, **kwargs) # noqa: E501 + return data + + def get_quote_by_id_with_http_info(self, id, **kwargs): # noqa: E501 + """get_quote_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_quote_by_id_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :return: InlineResponseDefault53 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_quote_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params or + params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_quote_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/quotes/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault53', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def quote(self, **kwargs): # noqa: E501 + """quote # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.quote(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param QuoteRequest body: + :return: InlineResponseDefault53 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.quote_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.quote_with_http_info(**kwargs) # noqa: E501 + return data + + def quote_with_http_info(self, **kwargs): # noqa: E501 + """quote # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.quote_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param QuoteRequest body: + :return: InlineResponseDefault53 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method quote" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/quotes', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault53', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/receipts_api.py b/billforward/api/receipts_api.py new file mode 100644 index 0000000..18bb696 --- /dev/null +++ b/billforward/api/receipts_api.py @@ -0,0 +1,810 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class ReceiptsApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def create_receipt(self, **kwargs): # noqa: E501 + """create_receipt # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_receipt(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Receipt body: + :return: InlineResponseDefault55 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_receipt_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_receipt_with_http_info(**kwargs) # noqa: E501 + return data + + def create_receipt_with_http_info(self, **kwargs): # noqa: E501 + """create_receipt # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_receipt_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Receipt body: + :return: InlineResponseDefault55 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_receipt" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/receipts', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault55', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_receipts(self, **kwargs): # noqa: E501 + """get_all_receipts # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_receipts(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param list[str] account_id: + :param list[str] invoice_id: + :param list[str] payment_method_id: + :param str type: + :param str gateway: + :param str decision: + :return: InlineResponseDefault54 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_receipts_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_receipts_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_receipts_with_http_info(self, **kwargs): # noqa: E501 + """get_all_receipts # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_receipts_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param list[str] account_id: + :param list[str] invoice_id: + :param list[str] payment_method_id: + :param str type: + :param str gateway: + :param str decision: + :return: InlineResponseDefault54 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'account_id', 'invoice_id', 'payment_method_id', 'type', 'gateway', 'decision'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_receipts" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'account_id' in params: + query_params.append(('account_id', params['account_id'])) # noqa: E501 + collection_formats['account_id'] = 'multi' # noqa: E501 + if 'invoice_id' in params: + query_params.append(('invoice_id', params['invoice_id'])) # noqa: E501 + collection_formats['invoice_id'] = 'multi' # noqa: E501 + if 'payment_method_id' in params: + query_params.append(('payment_method_id', params['payment_method_id'])) # noqa: E501 + collection_formats['payment_method_id'] = 'multi' # noqa: E501 + if 'type' in params: + query_params.append(('type', params['type'])) # noqa: E501 + if 'gateway' in params: + query_params.append(('gateway', params['gateway'])) # noqa: E501 + if 'decision' in params: + query_params.append(('decision', params['decision'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/receipts', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault54', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_receipt_by_id(self, receipt_id, **kwargs): # noqa: E501 + """get_receipt_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_receipt_by_id(receipt_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str receipt_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault55 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_receipt_by_id_with_http_info(receipt_id, **kwargs) # noqa: E501 + else: + (data) = self.get_receipt_by_id_with_http_info(receipt_id, **kwargs) # noqa: E501 + return data + + def get_receipt_by_id_with_http_info(self, receipt_id, **kwargs): # noqa: E501 + """get_receipt_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_receipt_by_id_with_http_info(receipt_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str receipt_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault55 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['receipt_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_receipt_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'receipt_id' is set + if ('receipt_id' not in params or + params['receipt_id'] is None): + raise ValueError("Missing the required parameter `receipt_id` when calling `get_receipt_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'receipt_id' in params: + path_params['receipt-ID'] = params['receipt_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/receipts/{receipt-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault55', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_receipts_by_invoice(self, invoice_id, **kwargs): # noqa: E501 + """get_receipts_by_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_receipts_by_invoice(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault54 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_receipts_by_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + else: + (data) = self.get_receipts_by_invoice_with_http_info(invoice_id, **kwargs) # noqa: E501 + return data + + def get_receipts_by_invoice_with_http_info(self, invoice_id, **kwargs): # noqa: E501 + """get_receipts_by_invoice # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_receipts_by_invoice_with_http_info(invoice_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str invoice_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault54 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['invoice_id', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_receipts_by_invoice" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'invoice_id' is set + if ('invoice_id' not in params or + params['invoice_id'] is None): + raise ValueError("Missing the required parameter `invoice_id` when calling `get_receipts_by_invoice`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'invoice_id' in params: + path_params['invoice-ID'] = params['invoice_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/receipts/invoice/{invoice-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault54', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_receipts_by_payment(self, payment_id, **kwargs): # noqa: E501 + """get_receipts_by_payment # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_receipts_by_payment(payment_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault54 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_receipts_by_payment_with_http_info(payment_id, **kwargs) # noqa: E501 + else: + (data) = self.get_receipts_by_payment_with_http_info(payment_id, **kwargs) # noqa: E501 + return data + + def get_receipts_by_payment_with_http_info(self, payment_id, **kwargs): # noqa: E501 + """get_receipts_by_payment # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_receipts_by_payment_with_http_info(payment_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str payment_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault54 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['payment_id', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_receipts_by_payment" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'payment_id' is set + if ('payment_id' not in params or + params['payment_id'] is None): + raise ValueError("Missing the required parameter `payment_id` when calling `get_receipts_by_payment`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'payment_id' in params: + path_params['payment-ID'] = params['payment_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/receipts/payment/{payment-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault54', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_receipts_for_debit_payments_as_csv(self, **kwargs): # noqa: E501 + """get_receipts_for_debit_payments_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_receipts_for_debit_payments_as_csv(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam received_start: + :param SimpleDateParam received_end: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param list[str] gateway: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_receipts_for_debit_payments_as_csv_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_receipts_for_debit_payments_as_csv_with_http_info(**kwargs) # noqa: E501 + return data + + def get_receipts_for_debit_payments_as_csv_with_http_info(self, **kwargs): # noqa: E501 + """get_receipts_for_debit_payments_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_receipts_for_debit_payments_as_csv_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam received_start: + :param SimpleDateParam received_end: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param list[str] gateway: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'received_start', 'received_end', 'offset', 'records', 'order_by', 'order', 'gateway'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_receipts_for_debit_payments_as_csv" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'received_start' in params: + query_params.append(('received_start', params['received_start'])) # noqa: E501 + if 'received_end' in params: + query_params.append(('received_end', params['received_end'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'gateway' in params: + query_params.append(('gateway', params['gateway'])) # noqa: E501 + collection_formats['gateway'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/receipts/debits.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_receipts_for_refund_payments_as_csv(self, **kwargs): # noqa: E501 + """get_receipts_for_refund_payments_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_receipts_for_refund_payments_as_csv(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam completed_start: + :param SimpleDateParam completed_end: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_receipts_for_refund_payments_as_csv_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_receipts_for_refund_payments_as_csv_with_http_info(**kwargs) # noqa: E501 + return data + + def get_receipts_for_refund_payments_as_csv_with_http_info(self, **kwargs): # noqa: E501 + """get_receipts_for_refund_payments_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_receipts_for_refund_payments_as_csv_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam completed_start: + :param SimpleDateParam completed_end: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'completed_start', 'completed_end', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_receipts_for_refund_payments_as_csv" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'completed_start' in params: + query_params.append(('completed_start', params['completed_start'])) # noqa: E501 + if 'completed_end' in params: + query_params.append(('completed_end', params['completed_end'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/receipts/refunds.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/reports_api.py b/billforward/api/reports_api.py new file mode 100644 index 0000000..82c6895 --- /dev/null +++ b/billforward/api/reports_api.py @@ -0,0 +1,1547 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class ReportsApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def get_accounts_overview(self, **kwargs): # noqa: E501 + """get_accounts_overview # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_accounts_overview(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_accounts_overview_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_accounts_overview_with_http_info(**kwargs) # noqa: E501 + return data + + def get_accounts_overview_with_http_info(self, **kwargs): # noqa: E501 + """get_accounts_overview # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_accounts_overview_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'date_discriminator', 'recognition_start', 'recognition_end', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format', 'meta_column_account'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_accounts_overview" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'date_discriminator' in params: + query_params.append(('date_discriminator', params['date_discriminator'])) # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + if 'meta_column_account' in params: + query_params.append(('meta_column_account[]', params['meta_column_account'])) # noqa: E501 + collection_formats['meta_column_account[]'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/reports/accounts/overview.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_affiliate_charge_report(self, **kwargs): # noqa: E501 + """get_affiliate_charge_report # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_affiliate_charge_report(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_affiliate_charge_report_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_affiliate_charge_report_with_http_info(**kwargs) # noqa: E501 + return data + + def get_affiliate_charge_report_with_http_info(self, **kwargs): # noqa: E501 + """get_affiliate_charge_report # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_affiliate_charge_report_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'recognition_start', 'recognition_end'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_affiliate_charge_report" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/reports/affiliate/overview.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_coupon_report(self, **kwargs): # noqa: E501 + """get_coupon_report # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_coupon_report(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_coupon_report_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_coupon_report_with_http_info(**kwargs) # noqa: E501 + return data + + def get_coupon_report_with_http_info(self, **kwargs): # noqa: E501 + """get_coupon_report # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_coupon_report_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'recognition_start', 'recognition_end'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_coupon_report" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/reports/coupons/overview.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_csv_report_invoice_line_payments_bucketed(self, **kwargs): # noqa: E501 + """get_csv_report_invoice_line_payments_bucketed # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_csv_report_invoice_line_payments_bucketed(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str payment_direction: + :param str bucket_type: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param list[str] include_gateway: + :param list[str] exclude_gateway: + :param list[str] accounts: + :param list[str] subscriptions: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :param list[str] meta_column_sub_child: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_csv_report_invoice_line_payments_bucketed_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_csv_report_invoice_line_payments_bucketed_with_http_info(**kwargs) # noqa: E501 + return data + + def get_csv_report_invoice_line_payments_bucketed_with_http_info(self, **kwargs): # noqa: E501 + """get_csv_report_invoice_line_payments_bucketed # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_csv_report_invoice_line_payments_bucketed_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str payment_direction: + :param str bucket_type: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param list[str] include_gateway: + :param list[str] exclude_gateway: + :param list[str] accounts: + :param list[str] subscriptions: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :param list[str] meta_column_sub_child: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'payment_direction', 'bucket_type', 'date_discriminator', 'recognition_start', 'recognition_end', 'include_gateway', 'exclude_gateway', 'accounts', 'subscriptions', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format', 'meta_column_account', 'meta_column_sub_child'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_csv_report_invoice_line_payments_bucketed" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'payment_direction' in params: + query_params.append(('payment_direction', params['payment_direction'])) # noqa: E501 + if 'bucket_type' in params: + query_params.append(('bucket_type', params['bucket_type'])) # noqa: E501 + if 'date_discriminator' in params: + query_params.append(('date_discriminator', params['date_discriminator'])) # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'include_gateway' in params: + query_params.append(('include_gateway', params['include_gateway'])) # noqa: E501 + collection_formats['include_gateway'] = 'multi' # noqa: E501 + if 'exclude_gateway' in params: + query_params.append(('exclude_gateway', params['exclude_gateway'])) # noqa: E501 + collection_formats['exclude_gateway'] = 'multi' # noqa: E501 + if 'accounts' in params: + query_params.append(('accounts', params['accounts'])) # noqa: E501 + collection_formats['accounts'] = 'multi' # noqa: E501 + if 'subscriptions' in params: + query_params.append(('subscriptions', params['subscriptions'])) # noqa: E501 + collection_formats['subscriptions'] = 'multi' # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + if 'meta_column_account' in params: + query_params.append(('meta_column_account[]', params['meta_column_account'])) # noqa: E501 + collection_formats['meta_column_account[]'] = 'multi' # noqa: E501 + if 'meta_column_sub_child' in params: + query_params.append(('meta_column_sub_child[]', params['meta_column_sub_child'])) # noqa: E501 + collection_formats['meta_column_sub_child[]'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/reports/fulfilled/bucketed.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_csv_report_invoice_line_payments_raw(self, **kwargs): # noqa: E501 + """get_csv_report_invoice_line_payments_raw # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_csv_report_invoice_line_payments_raw(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str payment_direction: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param list[str] include_gateway: + :param list[str] exclude_gateway: + :param list[str] accounts: + :param list[str] subscriptions: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :param list[str] meta_column_sub_child: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_csv_report_invoice_line_payments_raw_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_csv_report_invoice_line_payments_raw_with_http_info(**kwargs) # noqa: E501 + return data + + def get_csv_report_invoice_line_payments_raw_with_http_info(self, **kwargs): # noqa: E501 + """get_csv_report_invoice_line_payments_raw # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_csv_report_invoice_line_payments_raw_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str payment_direction: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param list[str] include_gateway: + :param list[str] exclude_gateway: + :param list[str] accounts: + :param list[str] subscriptions: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :param list[str] meta_column_sub_child: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'payment_direction', 'date_discriminator', 'recognition_start', 'recognition_end', 'include_gateway', 'exclude_gateway', 'accounts', 'subscriptions', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format', 'meta_column_account', 'meta_column_sub_child'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_csv_report_invoice_line_payments_raw" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'payment_direction' in params: + query_params.append(('payment_direction', params['payment_direction'])) # noqa: E501 + if 'date_discriminator' in params: + query_params.append(('date_discriminator', params['date_discriminator'])) # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'include_gateway' in params: + query_params.append(('include_gateway', params['include_gateway'])) # noqa: E501 + collection_formats['include_gateway'] = 'multi' # noqa: E501 + if 'exclude_gateway' in params: + query_params.append(('exclude_gateway', params['exclude_gateway'])) # noqa: E501 + collection_formats['exclude_gateway'] = 'multi' # noqa: E501 + if 'accounts' in params: + query_params.append(('accounts', params['accounts'])) # noqa: E501 + collection_formats['accounts'] = 'multi' # noqa: E501 + if 'subscriptions' in params: + query_params.append(('subscriptions', params['subscriptions'])) # noqa: E501 + collection_formats['subscriptions'] = 'multi' # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + if 'meta_column_account' in params: + query_params.append(('meta_column_account[]', params['meta_column_account'])) # noqa: E501 + collection_formats['meta_column_account[]'] = 'multi' # noqa: E501 + if 'meta_column_sub_child' in params: + query_params.append(('meta_column_sub_child[]', params['meta_column_sub_child'])) # noqa: E501 + collection_formats['meta_column_sub_child[]'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/reports/fulfilled/raw.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_csv_report_revenue_attributions_bucketed(self, **kwargs): # noqa: E501 + """get_csv_report_revenue_attributions_bucketed # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_csv_report_revenue_attributions_bucketed(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :param list[str] meta_column_sub_child: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_csv_report_revenue_attributions_bucketed_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_csv_report_revenue_attributions_bucketed_with_http_info(**kwargs) # noqa: E501 + return data + + def get_csv_report_revenue_attributions_bucketed_with_http_info(self, **kwargs): # noqa: E501 + """get_csv_report_revenue_attributions_bucketed # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_csv_report_revenue_attributions_bucketed_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :param list[str] meta_column_sub_child: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'date_discriminator', 'recognition_start', 'recognition_end', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format', 'meta_column_account', 'meta_column_sub_child'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_csv_report_revenue_attributions_bucketed" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'date_discriminator' in params: + query_params.append(('date_discriminator', params['date_discriminator'])) # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + if 'meta_column_account' in params: + query_params.append(('meta_column_account[]', params['meta_column_account'])) # noqa: E501 + collection_formats['meta_column_account[]'] = 'multi' # noqa: E501 + if 'meta_column_sub_child' in params: + query_params.append(('meta_column_sub_child[]', params['meta_column_sub_child'])) # noqa: E501 + collection_formats['meta_column_sub_child[]'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/reports/invoiced/bucketed.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_csv_report_revenue_attributions_raw(self, **kwargs): # noqa: E501 + """get_csv_report_revenue_attributions_raw # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_csv_report_revenue_attributions_raw(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :param list[str] meta_column_sub_child: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_csv_report_revenue_attributions_raw_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_csv_report_revenue_attributions_raw_with_http_info(**kwargs) # noqa: E501 + return data + + def get_csv_report_revenue_attributions_raw_with_http_info(self, **kwargs): # noqa: E501 + """get_csv_report_revenue_attributions_raw # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_csv_report_revenue_attributions_raw_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :param list[str] meta_column_sub_child: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'date_discriminator', 'recognition_start', 'recognition_end', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format', 'meta_column_account', 'meta_column_sub_child'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_csv_report_revenue_attributions_raw" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'date_discriminator' in params: + query_params.append(('date_discriminator', params['date_discriminator'])) # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + if 'meta_column_account' in params: + query_params.append(('meta_column_account[]', params['meta_column_account'])) # noqa: E501 + collection_formats['meta_column_account[]'] = 'multi' # noqa: E501 + if 'meta_column_sub_child' in params: + query_params.append(('meta_column_sub_child[]', params['meta_column_sub_child'])) # noqa: E501 + collection_formats['meta_column_sub_child[]'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/reports/invoiced/raw.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_csv_revenue_schedule(self, **kwargs): # noqa: E501 + """get_csv_revenue_schedule # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_csv_revenue_schedule(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param list[str] include_gateway: + :param list[str] exclude_gateway: + :param str bucket_by: + :param list[str] group_by: + :param bool pivot_by_dates: + :param bool include_detailed_lines: + :param list[str] accounts: + :param list[str] subscriptions: + :param list[str] plans: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_csv_revenue_schedule_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_csv_revenue_schedule_with_http_info(**kwargs) # noqa: E501 + return data + + def get_csv_revenue_schedule_with_http_info(self, **kwargs): # noqa: E501 + """get_csv_revenue_schedule # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_csv_revenue_schedule_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param list[str] include_gateway: + :param list[str] exclude_gateway: + :param str bucket_by: + :param list[str] group_by: + :param bool pivot_by_dates: + :param bool include_detailed_lines: + :param list[str] accounts: + :param list[str] subscriptions: + :param list[str] plans: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'recognition_start', 'recognition_end', 'include_gateway', 'exclude_gateway', 'bucket_by', 'group_by', 'pivot_by_dates', 'include_detailed_lines', 'accounts', 'subscriptions', 'plans'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_csv_revenue_schedule" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'include_gateway' in params: + query_params.append(('include_gateway', params['include_gateway'])) # noqa: E501 + collection_formats['include_gateway'] = 'multi' # noqa: E501 + if 'exclude_gateway' in params: + query_params.append(('exclude_gateway', params['exclude_gateway'])) # noqa: E501 + collection_formats['exclude_gateway'] = 'multi' # noqa: E501 + if 'bucket_by' in params: + query_params.append(('bucket_by', params['bucket_by'])) # noqa: E501 + if 'group_by' in params: + query_params.append(('group_by', params['group_by'])) # noqa: E501 + collection_formats['group_by'] = 'multi' # noqa: E501 + if 'pivot_by_dates' in params: + query_params.append(('pivot_by_dates', params['pivot_by_dates'])) # noqa: E501 + if 'include_detailed_lines' in params: + query_params.append(('include_detailed_lines', params['include_detailed_lines'])) # noqa: E501 + if 'accounts' in params: + query_params.append(('accounts', params['accounts'])) # noqa: E501 + collection_formats['accounts'] = 'multi' # noqa: E501 + if 'subscriptions' in params: + query_params.append(('subscriptions', params['subscriptions'])) # noqa: E501 + collection_formats['subscriptions'] = 'multi' # noqa: E501 + if 'plans' in params: + query_params.append(('plans', params['plans'])) # noqa: E501 + collection_formats['plans'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/reports/revenue-schedule/raw.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_payment_transactions(self, **kwargs): # noqa: E501 + """get_payment_transactions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_transactions(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param list[str] include_gateway: + :param list[str] exclude_gateway: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :param list[str] meta_column_sub_child: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_payment_transactions_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_payment_transactions_with_http_info(**kwargs) # noqa: E501 + return data + + def get_payment_transactions_with_http_info(self, **kwargs): # noqa: E501 + """get_payment_transactions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_payment_transactions_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param list[str] include_gateway: + :param list[str] exclude_gateway: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :param list[str] meta_column_sub_child: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'date_discriminator', 'recognition_start', 'recognition_end', 'include_gateway', 'exclude_gateway', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format', 'meta_column_account', 'meta_column_sub_child'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_payment_transactions" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'date_discriminator' in params: + query_params.append(('date_discriminator', params['date_discriminator'])) # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'include_gateway' in params: + query_params.append(('include_gateway', params['include_gateway'])) # noqa: E501 + collection_formats['include_gateway'] = 'multi' # noqa: E501 + if 'exclude_gateway' in params: + query_params.append(('exclude_gateway', params['exclude_gateway'])) # noqa: E501 + collection_formats['exclude_gateway'] = 'multi' # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + if 'meta_column_account' in params: + query_params.append(('meta_column_account[]', params['meta_column_account'])) # noqa: E501 + collection_formats['meta_column_account[]'] = 'multi' # noqa: E501 + if 'meta_column_sub_child' in params: + query_params.append(('meta_column_sub_child[]', params['meta_column_sub_child'])) # noqa: E501 + collection_formats['meta_column_sub_child[]'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/reports/transactions/payments.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_refunds_as_csv(self, **kwargs): # noqa: E501 + """get_refunds_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_refunds_as_csv(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam completed_start: + :param SimpleDateParam completed_end: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_refunds_as_csv_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_refunds_as_csv_with_http_info(**kwargs) # noqa: E501 + return data + + def get_refunds_as_csv_with_http_info(self, **kwargs): # noqa: E501 + """get_refunds_as_csv # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_refunds_as_csv_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam completed_start: + :param SimpleDateParam completed_end: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'completed_start', 'completed_end', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_refunds_as_csv" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'completed_start' in params: + query_params.append(('completed_start', params['completed_start'])) # noqa: E501 + if 'completed_end' in params: + query_params.append(('completed_end', params['completed_end'])) # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/refunds/csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_shipments_report(self, **kwargs): # noqa: E501 + """get_shipments_report # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_shipments_report(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_shipments_report_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_shipments_report_with_http_info(**kwargs) # noqa: E501 + return data + + def get_shipments_report_with_http_info(self, **kwargs): # noqa: E501 + """get_shipments_report # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_shipments_report_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'recognition_start', 'recognition_end'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_shipments_report" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/reports/shipments/overview.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscriptions_overview(self, **kwargs): # noqa: E501 + """get_subscriptions_overview # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscriptions_overview(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :param list[str] meta_column_sub: + :param list[str] account_id: + :param list[str] subscription_id: + :param list[str] parent_sub_id: + :param list[str] product_id: + :param list[str] rate_plan_id: + :param bool exclude_child_subs: + :param bool exclude_parentless_subs: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscriptions_overview_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_subscriptions_overview_with_http_info(**kwargs) # noqa: E501 + return data + + def get_subscriptions_overview_with_http_info(self, **kwargs): # noqa: E501 + """get_subscriptions_overview # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscriptions_overview_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str date_discriminator: + :param SimpleDateParam recognition_start: + :param SimpleDateParam recognition_end: + :param str date_interval_inclusivity: + :param str date_time_format: + :param str date_granularity: + :param str boolean_format: + :param str monetary_amount_format: + :param list[str] meta_column_account: + :param list[str] meta_column_sub: + :param list[str] account_id: + :param list[str] subscription_id: + :param list[str] parent_sub_id: + :param list[str] product_id: + :param list[str] rate_plan_id: + :param bool exclude_child_subs: + :param bool exclude_parentless_subs: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'date_discriminator', 'recognition_start', 'recognition_end', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format', 'meta_column_account', 'meta_column_sub', 'account_id', 'subscription_id', 'parent_sub_id', 'product_id', 'rate_plan_id', 'exclude_child_subs', 'exclude_parentless_subs'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscriptions_overview" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'date_discriminator' in params: + query_params.append(('date_discriminator', params['date_discriminator'])) # noqa: E501 + if 'recognition_start' in params: + query_params.append(('recognition_start', params['recognition_start'])) # noqa: E501 + if 'recognition_end' in params: + query_params.append(('recognition_end', params['recognition_end'])) # noqa: E501 + if 'date_interval_inclusivity' in params: + query_params.append(('date_interval_inclusivity', params['date_interval_inclusivity'])) # noqa: E501 + if 'date_time_format' in params: + query_params.append(('date_time_format', params['date_time_format'])) # noqa: E501 + if 'date_granularity' in params: + query_params.append(('date_granularity', params['date_granularity'])) # noqa: E501 + if 'boolean_format' in params: + query_params.append(('boolean_format', params['boolean_format'])) # noqa: E501 + if 'monetary_amount_format' in params: + query_params.append(('monetary_amount_format', params['monetary_amount_format'])) # noqa: E501 + if 'meta_column_account' in params: + query_params.append(('meta_column_account[]', params['meta_column_account'])) # noqa: E501 + collection_formats['meta_column_account[]'] = 'multi' # noqa: E501 + if 'meta_column_sub' in params: + query_params.append(('meta_column_sub[]', params['meta_column_sub'])) # noqa: E501 + collection_formats['meta_column_sub[]'] = 'multi' # noqa: E501 + if 'account_id' in params: + query_params.append(('account_id[]', params['account_id'])) # noqa: E501 + collection_formats['account_id[]'] = 'multi' # noqa: E501 + if 'subscription_id' in params: + query_params.append(('subscription_id[]', params['subscription_id'])) # noqa: E501 + collection_formats['subscription_id[]'] = 'multi' # noqa: E501 + if 'parent_sub_id' in params: + query_params.append(('parent_sub_id[]', params['parent_sub_id'])) # noqa: E501 + collection_formats['parent_sub_id[]'] = 'multi' # noqa: E501 + if 'product_id' in params: + query_params.append(('product_id[]', params['product_id'])) # noqa: E501 + collection_formats['product_id[]'] = 'multi' # noqa: E501 + if 'rate_plan_id' in params: + query_params.append(('rate_plan_id[]', params['rate_plan_id'])) # noqa: E501 + collection_formats['rate_plan_id[]'] = 'multi' # noqa: E501 + if 'exclude_child_subs' in params: + query_params.append(('exclude_child_subs', params['exclude_child_subs'])) # noqa: E501 + if 'exclude_parentless_subs' in params: + query_params.append(('exclude_parentless_subs', params['exclude_parentless_subs'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/reports/subscriptions/overview.csv', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/salesforce_api.py b/billforward/api/salesforce_api.py new file mode 100644 index 0000000..6c87415 --- /dev/null +++ b/billforward/api/salesforce_api.py @@ -0,0 +1,490 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class SalesforceApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def change_salesforce_job_state(self, **kwargs): # noqa: E501 + """change_salesforce_job_state # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.change_salesforce_job_state(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SyncActionRequest body: + :return: InlineResponseDefault58 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.change_salesforce_job_state_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.change_salesforce_job_state_with_http_info(**kwargs) # noqa: E501 + return data + + def change_salesforce_job_state_with_http_info(self, **kwargs): # noqa: E501 + """change_salesforce_job_state # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.change_salesforce_job_state_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SyncActionRequest body: + :return: InlineResponseDefault58 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method change_salesforce_job_state" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/salesforce/sync/action', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault58', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def connect_to_salesforce(self, **kwargs): # noqa: E501 + """connect_to_salesforce # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.connect_to_salesforce(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateSalesforceConfigurationRequest body: + :return: InlineResponseDefault27 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.connect_to_salesforce_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.connect_to_salesforce_with_http_info(**kwargs) # noqa: E501 + return data + + def connect_to_salesforce_with_http_info(self, **kwargs): # noqa: E501 + """connect_to_salesforce # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.connect_to_salesforce_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateSalesforceConfigurationRequest body: + :return: InlineResponseDefault27 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method connect_to_salesforce" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/salesforce/connect', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault27', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_salesforce_jobs(self, **kwargs): # noqa: E501 + """get_all_salesforce_jobs # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_salesforce_jobs(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str organization_id: + :return: InlineResponseDefault59 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_salesforce_jobs_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_salesforce_jobs_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_salesforce_jobs_with_http_info(self, **kwargs): # noqa: E501 + """get_all_salesforce_jobs # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_salesforce_jobs_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str organization_id: + :return: InlineResponseDefault59 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organization_id'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_salesforce_jobs" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organization_id' in params: + query_params.append(('organizationID', params['organization_id'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/salesforce/sync', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault59', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_salesforce_configuration(self, **kwargs): # noqa: E501 + """get_salesforce_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_salesforce_configuration(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str organization_id: + :return: InlineResponseDefault60 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_salesforce_configuration_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_salesforce_configuration_with_http_info(**kwargs) # noqa: E501 + return data + + def get_salesforce_configuration_with_http_info(self, **kwargs): # noqa: E501 + """get_salesforce_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_salesforce_configuration_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str organization_id: + :return: InlineResponseDefault60 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organization_id'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_salesforce_configuration" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organization_id' in params: + query_params.append(('organizationID', params['organization_id'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/salesforce/configuration', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault60', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_salesforce_configuration(self, **kwargs): # noqa: E501 + """update_salesforce_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_salesforce_configuration(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UpdateSalesforceConfigurationRequest body: + :return: InlineResponseDefault60 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_salesforce_configuration_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_salesforce_configuration_with_http_info(**kwargs) # noqa: E501 + return data + + def update_salesforce_configuration_with_http_info(self, **kwargs): # noqa: E501 + """update_salesforce_configuration # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_salesforce_configuration_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UpdateSalesforceConfigurationRequest body: + :return: InlineResponseDefault60 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_salesforce_configuration" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/salesforce/configuration', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault60', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/security_api.py b/billforward/api/security_api.py new file mode 100644 index 0000000..f7bba35 --- /dev/null +++ b/billforward/api/security_api.py @@ -0,0 +1,2169 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class SecurityApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def create_flexcheck_user_login(self, **kwargs): # noqa: E501 + """create_flexcheck_user_login # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_flexcheck_user_login(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UserCreateRequest body: + :return: InlineResponseDefault84 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_flexcheck_user_login_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_flexcheck_user_login_with_http_info(**kwargs) # noqa: E501 + return data + + def create_flexcheck_user_login_with_http_info(self, **kwargs): # noqa: E501 + """create_flexcheck_user_login # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_flexcheck_user_login_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UserCreateRequest body: + :return: InlineResponseDefault84 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_flexcheck_user_login" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/flexcheck', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault84', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_role(self, **kwargs): # noqa: E501 + """create_role # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_role(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateRoleRequest body: + :return: InlineResponseDefault57 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_role_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_role_with_http_info(**kwargs) # noqa: E501 + return data + + def create_role_with_http_info(self, **kwargs): # noqa: E501 + """create_role # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_role_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateRoleRequest body: + :return: InlineResponseDefault57 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_role" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/roles', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault57', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_user_login(self, **kwargs): # noqa: E501 + """create_user_login # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_user_login(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UserCreateRequest body: + :return: InlineResponseDefault84 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_user_login_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_user_login_with_http_info(**kwargs) # noqa: E501 + return data + + def create_user_login_with_http_info(self, **kwargs): # noqa: E501 + """create_user_login # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_user_login_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UserCreateRequest body: + :return: InlineResponseDefault84 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_user_login" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault84', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_roles(self, **kwargs): # noqa: E501 + """get_all_roles # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_roles(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault56 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_roles_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_roles_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_roles_with_http_info(self, **kwargs): # noqa: E501 + """get_all_roles # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_roles_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault56 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_roles" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/roles', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault56', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_current_user(self, **kwargs): # noqa: E501 + """get_current_user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_current_user(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault86 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_current_user_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_current_user_with_http_info(**kwargs) # noqa: E501 + return data + + def get_current_user_with_http_info(self, **kwargs): # noqa: E501 + """get_current_user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_current_user_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault86 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_current_user" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/mine', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault86', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_my_organizations(self, **kwargs): # noqa: E501 + """get_my_organizations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_my_organizations(async_req=True) + >>> result = thread.get() + + :param async_req bool + :return: InlineResponseDefault87 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_my_organizations_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_my_organizations_with_http_info(**kwargs) # noqa: E501 + return data + + def get_my_organizations_with_http_info(self, **kwargs): # noqa: E501 + """get_my_organizations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_my_organizations_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :return: InlineResponseDefault87 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = [] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_my_organizations" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/mine/organizations', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault87', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_private_permanent_api_token(self, **kwargs): # noqa: E501 + """get_private_permanent_api_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_private_permanent_api_token(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UserPrivatePermanentTokenRequest body: + :return: OAuthToken + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_private_permanent_api_token_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_private_permanent_api_token_with_http_info(**kwargs) # noqa: E501 + return data + + def get_private_permanent_api_token_with_http_info(self, **kwargs): # noqa: E501 + """get_private_permanent_api_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_private_permanent_api_token_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UserPrivatePermanentTokenRequest body: + :return: OAuthToken + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_private_permanent_api_token" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/generate-permanent-api-token', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='OAuthToken', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_role_by_id(self, role, **kwargs): # noqa: E501 + """get_role_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_role_by_id(role, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str role: (required) + :param list[str] organizations: + :param bool include_retired: + :return: InlineResponseDefault57 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_role_by_id_with_http_info(role, **kwargs) # noqa: E501 + else: + (data) = self.get_role_by_id_with_http_info(role, **kwargs) # noqa: E501 + return data + + def get_role_by_id_with_http_info(self, role, **kwargs): # noqa: E501 + """get_role_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_role_by_id_with_http_info(role, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str role: (required) + :param list[str] organizations: + :param bool include_retired: + :return: InlineResponseDefault57 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['role', 'organizations', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_role_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'role' is set + if ('role' not in params or + params['role'] is None): + raise ValueError("Missing the required parameter `role` when calling `get_role_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'role' in params: + path_params['role'] = params['role'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/roles/{role}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault57', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_simple_all_users(self, **kwargs): # noqa: E501 + """get_simple_all_users # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_simple_all_users(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault85 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_simple_all_users_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_simple_all_users_with_http_info(**kwargs) # noqa: E501 + return data + + def get_simple_all_users_with_http_info(self, **kwargs): # noqa: E501 + """get_simple_all_users # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_simple_all_users_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault85 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_simple_all_users" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault85', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_temporary_api_tokens(self, **kwargs): # noqa: E501 + """get_temporary_api_tokens # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_temporary_api_tokens(async_req=True) + >>> result = thread.get() + + :param async_req bool + :return: TokensResponse + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_temporary_api_tokens_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_temporary_api_tokens_with_http_info(**kwargs) # noqa: E501 + return data + + def get_temporary_api_tokens_with_http_info(self, **kwargs): # noqa: E501 + """get_temporary_api_tokens # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_temporary_api_tokens_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :return: TokensResponse + If the method is called asynchronously, + returns the request thread. + """ + + all_params = [] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_temporary_api_tokens" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/generate-tokens', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='TokensResponse', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_user_by_username(self, email, **kwargs): # noqa: E501 + """get_user_by_username # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_user_by_username(email, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str email: (required) + :param list[str] organizations: + :return: InlineResponseDefault88 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_user_by_username_with_http_info(email, **kwargs) # noqa: E501 + else: + (data) = self.get_user_by_username_with_http_info(email, **kwargs) # noqa: E501 + return data + + def get_user_by_username_with_http_info(self, email, **kwargs): # noqa: E501 + """get_user_by_username # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_user_by_username_with_http_info(email, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str email: (required) + :param list[str] organizations: + :return: InlineResponseDefault88 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['email', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_user_by_username" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'email' is set + if ('email' not in params or + params['email'] is None): + raise ValueError("Missing the required parameter `email` when calling `get_user_by_username`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'email' in params: + path_params['email'] = params['email'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/username/{email}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault88', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def invite_user_login(self, **kwargs): # noqa: E501 + """invite_user_login # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.invite_user_login(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UserInviteRequest body: + :return: InlineResponseDefault84 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.invite_user_login_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.invite_user_login_with_http_info(**kwargs) # noqa: E501 + return data + + def invite_user_login_with_http_info(self, **kwargs): # noqa: E501 + """invite_user_login # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.invite_user_login_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UserInviteRequest body: + :return: InlineResponseDefault84 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method invite_user_login" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/invite', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault84', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def link_open_id_token_to_user(self, **kwargs): # noqa: E501 + """link_open_id_token_to_user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.link_open_id_token_to_user(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param OpenIdUserLinkRequest body: + :return: InlineResponseDefault89 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.link_open_id_token_to_user_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.link_open_id_token_to_user_with_http_info(**kwargs) # noqa: E501 + return data + + def link_open_id_token_to_user_with_http_info(self, **kwargs): # noqa: E501 + """link_open_id_token_to_user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.link_open_id_token_to_user_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param OpenIdUserLinkRequest body: + :return: InlineResponseDefault89 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method link_open_id_token_to_user" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/invite/openid', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault89', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def refresh_permanent_api_token(self, **kwargs): # noqa: E501 + """refresh_permanent_api_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.refresh_permanent_api_token(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UserPrivatePermanentTokenRefreshRequest body: + :return: OAuthToken + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.refresh_permanent_api_token_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.refresh_permanent_api_token_with_http_info(**kwargs) # noqa: E501 + return data + + def refresh_permanent_api_token_with_http_info(self, **kwargs): # noqa: E501 + """refresh_permanent_api_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.refresh_permanent_api_token_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UserPrivatePermanentTokenRefreshRequest body: + :return: OAuthToken + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method refresh_permanent_api_token" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/refresh-permanent-api-token', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='OAuthToken', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def remove_permission_from_role(self, role, resource, action, **kwargs): # noqa: E501 + """remove_permission_from_role # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_permission_from_role(role, resource, action, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str role: (required) + :param str resource: (required) + :param str action: (required) + :param list[str] organizations: + :return: InlineResponseDefault57 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.remove_permission_from_role_with_http_info(role, resource, action, **kwargs) # noqa: E501 + else: + (data) = self.remove_permission_from_role_with_http_info(role, resource, action, **kwargs) # noqa: E501 + return data + + def remove_permission_from_role_with_http_info(self, role, resource, action, **kwargs): # noqa: E501 + """remove_permission_from_role # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_permission_from_role_with_http_info(role, resource, action, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str role: (required) + :param str resource: (required) + :param str action: (required) + :param list[str] organizations: + :return: InlineResponseDefault57 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['role', 'resource', 'action', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method remove_permission_from_role" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'role' is set + if ('role' not in params or + params['role'] is None): + raise ValueError("Missing the required parameter `role` when calling `remove_permission_from_role`") # noqa: E501 + # verify the required parameter 'resource' is set + if ('resource' not in params or + params['resource'] is None): + raise ValueError("Missing the required parameter `resource` when calling `remove_permission_from_role`") # noqa: E501 + # verify the required parameter 'action' is set + if ('action' not in params or + params['action'] is None): + raise ValueError("Missing the required parameter `action` when calling `remove_permission_from_role`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'role' in params: + path_params['role'] = params['role'] # noqa: E501 + if 'resource' in params: + path_params['resource'] = params['resource'] # noqa: E501 + if 'action' in params: + path_params['action'] = params['action'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/roles/{role}/permission/{resource}/{action}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault57', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def request_password_reset_code(self, **kwargs): # noqa: E501 + """request_password_reset_code # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.request_password_reset_code(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param PasswordResetCodeRequest body: + :return: InlineResponseDefault90 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.request_password_reset_code_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.request_password_reset_code_with_http_info(**kwargs) # noqa: E501 + return data + + def request_password_reset_code_with_http_info(self, **kwargs): # noqa: E501 + """request_password_reset_code # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.request_password_reset_code_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param PasswordResetCodeRequest body: + :return: InlineResponseDefault90 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method request_password_reset_code" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['text/plain', 'application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/password-reset/request-reset-code', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault90', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def revoke_role(self, role, **kwargs): # noqa: E501 + """revoke_role # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.revoke_role(role, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str role: (required) + :param list[str] organizations: + :return: InlineResponseDefault57 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.revoke_role_with_http_info(role, **kwargs) # noqa: E501 + else: + (data) = self.revoke_role_with_http_info(role, **kwargs) # noqa: E501 + return data + + def revoke_role_with_http_info(self, role, **kwargs): # noqa: E501 + """revoke_role # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.revoke_role_with_http_info(role, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str role: (required) + :param list[str] organizations: + :return: InlineResponseDefault57 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['role', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method revoke_role" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'role' is set + if ('role' not in params or + params['role'] is None): + raise ValueError("Missing the required parameter `role` when calling `revoke_role`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'role' in params: + path_params['role'] = params['role'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/roles/{role}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault57', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_email(self, email, **kwargs): # noqa: E501 + """update_email # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_email(email, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str email: (required) + :param UpdateEmailRequest body: + :param list[str] organizations: + :return: InlineResponseDefault86 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_email_with_http_info(email, **kwargs) # noqa: E501 + else: + (data) = self.update_email_with_http_info(email, **kwargs) # noqa: E501 + return data + + def update_email_with_http_info(self, email, **kwargs): # noqa: E501 + """update_email # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_email_with_http_info(email, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str email: (required) + :param UpdateEmailRequest body: + :param list[str] organizations: + :return: InlineResponseDefault86 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['email', 'body', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_email" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'email' is set + if ('email' not in params or + params['email'] is None): + raise ValueError("Missing the required parameter `email` when calling `update_email`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'email' in params: + path_params['email'] = params['email'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/{email}/email', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault86', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_role(self, **kwargs): # noqa: E501 + """update_role # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_role(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UpdateRoleRequest body: + :return: InlineResponseDefault57 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_role_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_role_with_http_info(**kwargs) # noqa: E501 + return data + + def update_role_with_http_info(self, **kwargs): # noqa: E501 + """update_role # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_role_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UpdateRoleRequest body: + :return: InlineResponseDefault57 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_role" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/roles', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault57', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_user_infos(self, email, **kwargs): # noqa: E501 + """update_user_infos # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_user_infos(email, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str email: (required) + :param UpdateUserInfoRequest body: + :param list[str] organizations: + :return: InlineResponseDefault91 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_user_infos_with_http_info(email, **kwargs) # noqa: E501 + else: + (data) = self.update_user_infos_with_http_info(email, **kwargs) # noqa: E501 + return data + + def update_user_infos_with_http_info(self, email, **kwargs): # noqa: E501 + """update_user_infos # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_user_infos_with_http_info(email, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str email: (required) + :param UpdateUserInfoRequest body: + :param list[str] organizations: + :return: InlineResponseDefault91 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['email', 'body', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_user_infos" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'email' is set + if ('email' not in params or + params['email'] is None): + raise ValueError("Missing the required parameter `email` when calling `update_user_infos`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'email' in params: + path_params['email'] = params['email'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/{email}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault91', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_user_password(self, email, **kwargs): # noqa: E501 + """update_user_password # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_user_password(email, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str email: (required) + :param UpdatePasswordRequest body: + :param list[str] organizations: + :return: InlineResponseDefault92 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_user_password_with_http_info(email, **kwargs) # noqa: E501 + else: + (data) = self.update_user_password_with_http_info(email, **kwargs) # noqa: E501 + return data + + def update_user_password_with_http_info(self, email, **kwargs): # noqa: E501 + """update_user_password # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_user_password_with_http_info(email, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str email: (required) + :param UpdatePasswordRequest body: + :param list[str] organizations: + :return: InlineResponseDefault92 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['email', 'body', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_user_password" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'email' is set + if ('email' not in params or + params['email'] is None): + raise ValueError("Missing the required parameter `email` when calling `update_user_password`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'email' in params: + path_params['email'] = params['email'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/{email}/password', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault92', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_user_password_with_reset_code(self, **kwargs): # noqa: E501 + """update_user_password_with_reset_code # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_user_password_with_reset_code(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param PasswordUpdateWithResetCodeRequest body: + :return: InlineResponseDefault92 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_user_password_with_reset_code_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_user_password_with_reset_code_with_http_info(**kwargs) # noqa: E501 + return data + + def update_user_password_with_reset_code_with_http_info(self, **kwargs): # noqa: E501 + """update_user_password_with_reset_code # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_user_password_with_reset_code_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param PasswordUpdateWithResetCodeRequest body: + :return: InlineResponseDefault92 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_user_password_with_reset_code" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/users/password-reset/password-update', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault92', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/subscriptions_api.py b/billforward/api/subscriptions_api.py new file mode 100644 index 0000000..2471a19 --- /dev/null +++ b/billforward/api/subscriptions_api.py @@ -0,0 +1,5805 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class SubscriptionsApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def add_charge_to_subscription(self, subscription_id, **kwargs): # noqa: E501 + """add_charge_to_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_charge_to_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param AddChargeRequest body: + :return: InlineResponseDefault28 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.add_charge_to_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.add_charge_to_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def add_charge_to_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """add_charge_to_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_charge_to_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param AddChargeRequest body: + :return: InlineResponseDefault28 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method add_charge_to_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `add_charge_to_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/charge', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault28', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def add_coupon_to_subscription(self, subscription_id, **kwargs): # noqa: E501 + """add_coupon_to_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_coupon_to_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param AddCouponCodeRequest body: + :return: InlineResponseDefault23 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.add_coupon_to_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.add_coupon_to_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def add_coupon_to_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """add_coupon_to_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_coupon_to_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param AddCouponCodeRequest body: + :return: InlineResponseDefault23 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method add_coupon_to_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `add_coupon_to_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/coupons', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault23', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def add_credit_note_to_subscription(self, subscription_id, **kwargs): # noqa: E501 + """add_credit_note_to_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_credit_note_to_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param CreditSubscriptionRequest body: + :return: InlineResponseDefault4 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.add_credit_note_to_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.add_credit_note_to_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def add_credit_note_to_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """add_credit_note_to_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_credit_note_to_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param CreditSubscriptionRequest body: + :return: InlineResponseDefault4 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method add_credit_note_to_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `add_credit_note_to_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/credit', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault4', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def add_payment_method_to_subscription(self, subscription_id, **kwargs): # noqa: E501 + """add_payment_method_to_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_payment_method_to_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param AddPaymentMethodRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.add_payment_method_to_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.add_payment_method_to_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def add_payment_method_to_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """add_payment_method_to_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.add_payment_method_to_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param AddPaymentMethodRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method add_payment_method_to_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `add_payment_method_to_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/payment-methods', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault40', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def advance_subscription(self, subscription_id, **kwargs): # noqa: E501 + """advance_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.advance_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param TimeRequest body: + :return: InlineResponseDefault61 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.advance_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.advance_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def advance_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """advance_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.advance_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param TimeRequest body: + :return: InlineResponseDefault61 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method advance_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `advance_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/advance', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault61', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def available_payment_methods_for_subscription(self, subscription_id, **kwargs): # noqa: E501 + """available_payment_methods_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.available_payment_methods_for_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault9 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.available_payment_methods_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.available_payment_methods_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def available_payment_methods_for_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """available_payment_methods_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.available_payment_methods_for_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault9 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method available_payment_methods_for_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `available_payment_methods_for_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/payment-methods', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault9', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def batch_create_subscriptions(self, **kwargs): # noqa: E501 + """batch_create_subscriptions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.batch_create_subscriptions(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateSubscriptionBatchRequest body: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.batch_create_subscriptions_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.batch_create_subscriptions_with_http_info(**kwargs) # noqa: E501 + return data + + def batch_create_subscriptions_with_http_info(self, **kwargs): # noqa: E501 + """batch_create_subscriptions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.batch_create_subscriptions_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateSubscriptionBatchRequest body: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method batch_create_subscriptions" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/batch', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault26', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def batch_increment_usage(self, subscription_id, **kwargs): # noqa: E501 + """batch_increment_usage # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.batch_increment_usage(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param BatchIncrementValuesRequest body: + :return: InlineResponseDefault62 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.batch_increment_usage_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.batch_increment_usage_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def batch_increment_usage_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """batch_increment_usage # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.batch_increment_usage_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param BatchIncrementValuesRequest body: + :return: InlineResponseDefault62 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method batch_increment_usage" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `batch_increment_usage`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscriptionID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscriptionID}/increment-values', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault62', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def cancel_subscription(self, subscription_id, **kwargs): # noqa: E501 + """cancel_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.cancel_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param SubscriptionCancellation body: + :return: InlineResponseDefault63 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.cancel_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.cancel_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def cancel_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """cancel_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.cancel_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param SubscriptionCancellation body: + :return: InlineResponseDefault63 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method cancel_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `cancel_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/cancel', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault63', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_aggregating_subscription(self, **kwargs): # noqa: E501 + """create_aggregating_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_aggregating_subscription(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateAggregatingSubscriptionRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_aggregating_subscription_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_aggregating_subscription_with_http_info(**kwargs) # noqa: E501 + return data + + def create_aggregating_subscription_with_http_info(self, **kwargs): # noqa: E501 + """create_aggregating_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_aggregating_subscription_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateAggregatingSubscriptionRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_aggregating_subscription" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/aggregating', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault51', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_subscription_from_request(self, **kwargs): # noqa: E501 + """create_subscription_from_request # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_subscription_from_request(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateSubscriptionRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_subscription_from_request_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_subscription_from_request_with_http_info(**kwargs) # noqa: E501 + return data + + def create_subscription_from_request_with_http_info(self, **kwargs): # noqa: E501 + """create_subscription_from_request # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_subscription_from_request_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param CreateSubscriptionRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_subscription_from_request" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/create', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault51', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_timer(self, subscription_id, **kwargs): # noqa: E501 + """create_timer # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_timer(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param CreateSubscriptionTimerRequest body: + :return: InlineResponseDefault65 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_timer_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.create_timer_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def create_timer_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """create_timer # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_timer_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param CreateSubscriptionTimerRequest body: + :return: InlineResponseDefault65 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_timer" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `create_timer`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/timer', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault65', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def delete_metadata_for_subscription(self, subscription_id, **kwargs): # noqa: E501 + """delete_metadata_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_metadata_for_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.delete_metadata_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.delete_metadata_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def delete_metadata_for_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """delete_metadata_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_metadata_for_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_metadata_for_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `delete_metadata_for_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/metadata', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault7', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def freeze_subscription(self, subscription_id, **kwargs): # noqa: E501 + """freeze_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.freeze_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param PauseRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.freeze_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.freeze_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def freeze_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """freeze_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.freeze_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param PauseRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method freeze_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `freeze_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/freeze', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault51', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_affiliate1(self, subscription_id, **kwargs): # noqa: E501 + """get_affiliate1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_affiliate1(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault66 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_affiliate1_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.get_affiliate1_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def get_affiliate1_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """get_affiliate1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_affiliate1_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault66 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_affiliate1" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_affiliate1`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscriptionID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscriptionID}/affiliate', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault66', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_applicable_coupons_for_subscription(self, subscription_id, **kwargs): # noqa: E501 + """get_applicable_coupons_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_applicable_coupons_for_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault22 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_applicable_coupons_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.get_applicable_coupons_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def get_applicable_coupons_for_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """get_applicable_coupons_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_applicable_coupons_for_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault22 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_applicable_coupons_for_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_applicable_coupons_for_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/applicable-coupons', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault22', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_available_credit_subscription(self, subscription_id, **kwargs): # noqa: E501 + """get_available_credit_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_available_credit_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault3 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_available_credit_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.get_available_credit_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def get_available_credit_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """get_available_credit_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_available_credit_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault3 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_available_credit_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_available_credit_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/credit', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault3', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_charges_on_subscription(self, subscription_id, **kwargs): # noqa: E501 + """get_charges_on_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_charges_on_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param str state: + :param str type: + :param bool include_retired: + :return: InlineResponseDefault10 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_charges_on_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.get_charges_on_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def get_charges_on_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """get_charges_on_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_charges_on_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param str state: + :param str type: + :param bool include_retired: + :return: InlineResponseDefault10 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'state', 'type', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_charges_on_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_charges_on_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'state' in params: + query_params.append(('state', params['state'])) # noqa: E501 + if 'type' in params: + query_params.append(('type', params['type'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/charges', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault10', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_children_of_subscription(self, subscription_id, **kwargs): # noqa: E501 + """get_children_of_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_children_of_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param bool exclude_service_ended: + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_children_of_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.get_children_of_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def get_children_of_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """get_children_of_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_children_of_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param bool exclude_service_ended: + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'exclude_service_ended', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_children_of_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_children_of_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'exclude_service_ended' in params: + query_params.append(('exclude_service_ended', params['exclude_service_ended'])) # noqa: E501 + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/children', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault26', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_coupons_on_subscription(self, subscription_id, **kwargs): # noqa: E501 + """get_coupons_on_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_coupons_on_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault22 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_coupons_on_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.get_coupons_on_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def get_coupons_on_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """get_coupons_on_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_coupons_on_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault22 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_coupons_on_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_coupons_on_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/coupons', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault22', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_invoices_for_subscription_by_state(self, subscription_id, state, **kwargs): # noqa: E501 + """get_invoices_for_subscription_by_state # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_for_subscription_by_state(subscription_id, state, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str state: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_invoices_for_subscription_by_state_with_http_info(subscription_id, state, **kwargs) # noqa: E501 + else: + (data) = self.get_invoices_for_subscription_by_state_with_http_info(subscription_id, state, **kwargs) # noqa: E501 + return data + + def get_invoices_for_subscription_by_state_with_http_info(self, subscription_id, state, **kwargs): # noqa: E501 + """get_invoices_for_subscription_by_state # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_invoices_for_subscription_by_state_with_http_info(subscription_id, state, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str state: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault8 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'state', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_invoices_for_subscription_by_state" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_invoices_for_subscription_by_state`") # noqa: E501 + # verify the required parameter 'state' is set + if ('state' not in params or + params['state'] is None): + raise ValueError("Missing the required parameter `state` when calling `get_invoices_for_subscription_by_state`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscriptionID'] = params['subscription_id'] # noqa: E501 + if 'state' in params: + path_params['state'] = params['state'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscriptionID}/invoices/{state}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault8', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_metadata_for_subscription(self, subscription_id, **kwargs): # noqa: E501 + """get_metadata_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_metadata_for_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_metadata_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.get_metadata_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def get_metadata_for_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """get_metadata_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_metadata_for_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_metadata_for_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_metadata_for_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/metadata', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault7', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_parent_subscription(self, subscription_id, **kwargs): # noqa: E501 + """get_parent_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_parent_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_parent_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.get_parent_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def get_parent_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """get_parent_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_parent_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_parent_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_parent_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/parent', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault26', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_pricing_component_values_of_subscription(self, subscription_id, **kwargs): # noqa: E501 + """get_pricing_component_values_of_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_pricing_component_values_of_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault68 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_pricing_component_values_of_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.get_pricing_component_values_of_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def get_pricing_component_values_of_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """get_pricing_component_values_of_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_pricing_component_values_of_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault68 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_pricing_component_values_of_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_pricing_component_values_of_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/values', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault68', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscription_by_account_id(self, account_id, **kwargs): # noqa: E501 + """get_subscription_by_account_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscription_by_account_id_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.get_subscription_by_account_id_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def get_subscription_by_account_id_with_http_info(self, account_id, **kwargs): # noqa: E501 + """get_subscription_by_account_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_by_account_id_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscription_by_account_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_subscription_by_account_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['account-ID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'exclude_children' in params: + query_params.append(('exclude_children', params['exclude_children'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/account/{account-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault26', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscription_by_id(self, subscription_id, **kwargs): # noqa: E501 + """get_subscription_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_by_id(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param bool include_retired: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscription_by_id_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.get_subscription_by_id_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def get_subscription_by_id_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """get_subscription_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_by_id_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param bool include_retired: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscription_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_subscription_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault51', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscription_by_product_id(self, product_id, **kwargs): # noqa: E501 + """get_subscription_by_product_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_by_product_id(product_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str product_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscription_by_product_id_with_http_info(product_id, **kwargs) # noqa: E501 + else: + (data) = self.get_subscription_by_product_id_with_http_info(product_id, **kwargs) # noqa: E501 + return data + + def get_subscription_by_product_id_with_http_info(self, product_id, **kwargs): # noqa: E501 + """get_subscription_by_product_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_by_product_id_with_http_info(product_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str product_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['product_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscription_by_product_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'product_id' is set + if ('product_id' not in params or + params['product_id'] is None): + raise ValueError("Missing the required parameter `product_id` when calling `get_subscription_by_product_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'product_id' in params: + path_params['product-ID'] = params['product_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'exclude_children' in params: + query_params.append(('exclude_children', params['exclude_children'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/product/{product-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault26', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscription_by_product_rate_plan_id(self, product_rate_plan_id, **kwargs): # noqa: E501 + """get_subscription_by_product_rate_plan_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_by_product_rate_plan_id(product_rate_plan_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str product_rate_plan_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscription_by_product_rate_plan_id_with_http_info(product_rate_plan_id, **kwargs) # noqa: E501 + else: + (data) = self.get_subscription_by_product_rate_plan_id_with_http_info(product_rate_plan_id, **kwargs) # noqa: E501 + return data + + def get_subscription_by_product_rate_plan_id_with_http_info(self, product_rate_plan_id, **kwargs): # noqa: E501 + """get_subscription_by_product_rate_plan_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_by_product_rate_plan_id_with_http_info(product_rate_plan_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str product_rate_plan_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['product_rate_plan_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscription_by_product_rate_plan_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'product_rate_plan_id' is set + if ('product_rate_plan_id' not in params or + params['product_rate_plan_id'] is None): + raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `get_subscription_by_product_rate_plan_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'product_rate_plan_id' in params: + path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'exclude_children' in params: + query_params.append(('exclude_children', params['exclude_children'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/product-rate-plan/{product-rate-plan-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault26', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscription_by_state(self, state, **kwargs): # noqa: E501 + """get_subscription_by_state # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_by_state(state, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str state: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscription_by_state_with_http_info(state, **kwargs) # noqa: E501 + else: + (data) = self.get_subscription_by_state_with_http_info(state, **kwargs) # noqa: E501 + return data + + def get_subscription_by_state_with_http_info(self, state, **kwargs): # noqa: E501 + """get_subscription_by_state # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_by_state_with_http_info(state, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str state: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param bool exclude_children: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['state', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscription_by_state" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'state' is set + if ('state' not in params or + params['state'] is None): + raise ValueError("Missing the required parameter `state` when calling `get_subscription_by_state`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'state' in params: + path_params['state'] = params['state'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'exclude_children' in params: + query_params.append(('exclude_children', params['exclude_children'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/state/{state}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault26', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscription_by_version_id(self, version_id, **kwargs): # noqa: E501 + """get_subscription_by_version_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_by_version_id(version_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str version_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscription_by_version_id_with_http_info(version_id, **kwargs) # noqa: E501 + else: + (data) = self.get_subscription_by_version_id_with_http_info(version_id, **kwargs) # noqa: E501 + return data + + def get_subscription_by_version_id_with_http_info(self, version_id, **kwargs): # noqa: E501 + """get_subscription_by_version_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscription_by_version_id_with_http_info(version_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str version_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['version_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscription_by_version_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'version_id' is set + if ('version_id' not in params or + params['version_id'] is None): + raise ValueError("Missing the required parameter `version_id` when calling `get_subscription_by_version_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'version_id' in params: + path_params['version-ID'] = params['version_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/version/{version-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault51', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscriptions_by_initial_period_start(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_subscriptions_by_initial_period_start # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscriptions_by_initial_period_start(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscriptions_by_initial_period_start_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + else: + (data) = self.get_subscriptions_by_initial_period_start_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + return data + + def get_subscriptions_by_initial_period_start_with_http_info(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_subscriptions_by_initial_period_start # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscriptions_by_initial_period_start_with_http_info(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscriptions_by_initial_period_start" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'lower_threshold' is set + if ('lower_threshold' not in params or + params['lower_threshold'] is None): + raise ValueError("Missing the required parameter `lower_threshold` when calling `get_subscriptions_by_initial_period_start`") # noqa: E501 + # verify the required parameter 'upper_threshold' is set + if ('upper_threshold' not in params or + params['upper_threshold'] is None): + raise ValueError("Missing the required parameter `upper_threshold` when calling `get_subscriptions_by_initial_period_start`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'lower_threshold' in params: + path_params['lower-threshold'] = params['lower_threshold'] # noqa: E501 + if 'upper_threshold' in params: + path_params['upper-threshold'] = params['upper_threshold'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/initial-period-start/{lower-threshold}/{upper-threshold}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault26', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscriptions_by_period_end(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_subscriptions_by_period_end # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscriptions_by_period_end(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscriptions_by_period_end_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + else: + (data) = self.get_subscriptions_by_period_end_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + return data + + def get_subscriptions_by_period_end_with_http_info(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_subscriptions_by_period_end # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscriptions_by_period_end_with_http_info(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscriptions_by_period_end" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'lower_threshold' is set + if ('lower_threshold' not in params or + params['lower_threshold'] is None): + raise ValueError("Missing the required parameter `lower_threshold` when calling `get_subscriptions_by_period_end`") # noqa: E501 + # verify the required parameter 'upper_threshold' is set + if ('upper_threshold' not in params or + params['upper_threshold'] is None): + raise ValueError("Missing the required parameter `upper_threshold` when calling `get_subscriptions_by_period_end`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'lower_threshold' in params: + path_params['lower-threshold'] = params['lower_threshold'] # noqa: E501 + if 'upper_threshold' in params: + path_params['upper-threshold'] = params['upper_threshold'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/period-end/{lower-threshold}/{upper-threshold}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault26', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscriptions_by_period_start(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_subscriptions_by_period_start # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscriptions_by_period_start(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscriptions_by_period_start_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + else: + (data) = self.get_subscriptions_by_period_start_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + return data + + def get_subscriptions_by_period_start_with_http_info(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_subscriptions_by_period_start # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscriptions_by_period_start_with_http_info(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param SimpleDateParam lower_threshold: (required) + :param SimpleDateParam upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscriptions_by_period_start" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'lower_threshold' is set + if ('lower_threshold' not in params or + params['lower_threshold'] is None): + raise ValueError("Missing the required parameter `lower_threshold` when calling `get_subscriptions_by_period_start`") # noqa: E501 + # verify the required parameter 'upper_threshold' is set + if ('upper_threshold' not in params or + params['upper_threshold'] is None): + raise ValueError("Missing the required parameter `upper_threshold` when calling `get_subscriptions_by_period_start`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'lower_threshold' in params: + path_params['lower-threshold'] = params['lower_threshold'] # noqa: E501 + if 'upper_threshold' in params: + path_params['upper-threshold'] = params['upper_threshold'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/period-start/{lower-threshold}/{upper-threshold}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault26', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_subscriptions_by_successful_periods(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_subscriptions_by_successful_periods # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscriptions_by_successful_periods(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param int lower_threshold: (required) + :param int upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_subscriptions_by_successful_periods_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + else: + (data) = self.get_subscriptions_by_successful_periods_with_http_info(lower_threshold, upper_threshold, **kwargs) # noqa: E501 + return data + + def get_subscriptions_by_successful_periods_with_http_info(self, lower_threshold, upper_threshold, **kwargs): # noqa: E501 + """get_subscriptions_by_successful_periods # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_subscriptions_by_successful_periods_with_http_info(lower_threshold, upper_threshold, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param int lower_threshold: (required) + :param int upper_threshold: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_subscriptions_by_successful_periods" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'lower_threshold' is set + if ('lower_threshold' not in params or + params['lower_threshold'] is None): + raise ValueError("Missing the required parameter `lower_threshold` when calling `get_subscriptions_by_successful_periods`") # noqa: E501 + # verify the required parameter 'upper_threshold' is set + if ('upper_threshold' not in params or + params['upper_threshold'] is None): + raise ValueError("Missing the required parameter `upper_threshold` when calling `get_subscriptions_by_successful_periods`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'lower_threshold' in params: + path_params['lower-threshold'] = params['lower_threshold'] # noqa: E501 + if 'upper_threshold' in params: + path_params['upper-threshold'] = params['upper_threshold'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/successful-periods/{lower-threshold}/{upper-threshold}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault26', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_swagger_subscription(self, query_string, **kwargs): # noqa: E501 + """get_swagger_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_swagger_subscription(query_string, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str query_string: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str format: + :param bool wildcard: + :param bool entity: + :return: InlineResponseDefault69 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_swagger_subscription_with_http_info(query_string, **kwargs) # noqa: E501 + else: + (data) = self.get_swagger_subscription_with_http_info(query_string, **kwargs) # noqa: E501 + return data + + def get_swagger_subscription_with_http_info(self, query_string, **kwargs): # noqa: E501 + """get_swagger_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_swagger_subscription_with_http_info(query_string, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str query_string: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str format: + :param bool wildcard: + :param bool entity: + :return: InlineResponseDefault69 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['query_string', 'organizations', 'offset', 'records', 'format', 'wildcard', 'entity'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_swagger_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'query_string' is set + if ('query_string' not in params or + params['query_string'] is None): + raise ValueError("Missing the required parameter `query_string` when calling `get_swagger_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'query_string' in params: + path_params['query-string'] = params['query_string'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'format' in params: + query_params.append(('format', params['format'])) # noqa: E501 + if 'wildcard' in params: + query_params.append(('wildcard', params['wildcard'])) # noqa: E501 + if 'entity' in params: + query_params.append(('entity', params['entity'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/swagger-end-point/{query-string}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault69', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_timers_for_subscription(self, subscription_id, **kwargs): # noqa: E501 + """get_timers_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_timers_for_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param str state: + :param str event: + :return: InlineResponseDefault64 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_timers_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.get_timers_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def get_timers_for_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """get_timers_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_timers_for_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :param str state: + :param str event: + :return: InlineResponseDefault64 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'state', 'event'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_timers_for_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `get_timers_for_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + if 'state' in params: + query_params.append(('state', params['state'])) # noqa: E501 + if 'event' in params: + query_params.append(('event', params['event'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/timer', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault64', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def import_subscription(self, **kwargs): # noqa: E501 + """import_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.import_subscription(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param ImportSubscriptionRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.import_subscription_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.import_subscription_with_http_info(**kwargs) # noqa: E501 + return data + + def import_subscription_with_http_info(self, **kwargs): # noqa: E501 + """import_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.import_subscription_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param ImportSubscriptionRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method import_subscription" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/import', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault51', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def invoice_charges_on_subscription(self, subscription_id, **kwargs): # noqa: E501 + """invoice_charges_on_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.invoice_charges_on_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param InvoiceChargeRequest body: + :return: InlineResponseDefault29 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.invoice_charges_on_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.invoice_charges_on_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def invoice_charges_on_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """invoice_charges_on_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.invoice_charges_on_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param InvoiceChargeRequest body: + :return: InlineResponseDefault29 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method invoice_charges_on_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `invoice_charges_on_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/invoice-charges', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault29', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def migrate_subscription(self, subscription_id, **kwargs): # noqa: E501 + """migrate_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.migrate_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param MigrationRequest body: + :return: InlineResponseDefault70 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.migrate_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.migrate_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def migrate_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """migrate_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.migrate_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param MigrationRequest body: + :return: InlineResponseDefault70 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method migrate_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `migrate_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/migrate', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault70', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def pause_subscription(self, subscription_id, **kwargs): # noqa: E501 + """pause_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.pause_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param PauseRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.pause_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.pause_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def pause_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """pause_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.pause_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param PauseRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method pause_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `pause_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/pause', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault51', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def remove_coupon_from_subscription(self, subscription_id, coupon_code, **kwargs): # noqa: E501 + """remove_coupon_from_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_coupon_from_subscription(subscription_id, coupon_code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str coupon_code: (required) + :param list[str] organizations: + :return: InlineResponseDefault23 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.remove_coupon_from_subscription_with_http_info(subscription_id, coupon_code, **kwargs) # noqa: E501 + else: + (data) = self.remove_coupon_from_subscription_with_http_info(subscription_id, coupon_code, **kwargs) # noqa: E501 + return data + + def remove_coupon_from_subscription_with_http_info(self, subscription_id, coupon_code, **kwargs): # noqa: E501 + """remove_coupon_from_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_coupon_from_subscription_with_http_info(subscription_id, coupon_code, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str coupon_code: (required) + :param list[str] organizations: + :return: InlineResponseDefault23 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'coupon_code', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method remove_coupon_from_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `remove_coupon_from_subscription`") # noqa: E501 + # verify the required parameter 'coupon_code' is set + if ('coupon_code' not in params or + params['coupon_code'] is None): + raise ValueError("Missing the required parameter `coupon_code` when calling `remove_coupon_from_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + if 'coupon_code' in params: + path_params['coupon-code'] = params['coupon_code'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/coupons/{coupon-code}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault23', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def remove_credit_from_subscription(self, subscription_id, value, **kwargs): # noqa: E501 + """remove_credit_from_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_credit_from_subscription(subscription_id, value, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str value: (required) + :param list[str] organizations: + :return: InlineResponseDefault3 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.remove_credit_from_subscription_with_http_info(subscription_id, value, **kwargs) # noqa: E501 + else: + (data) = self.remove_credit_from_subscription_with_http_info(subscription_id, value, **kwargs) # noqa: E501 + return data + + def remove_credit_from_subscription_with_http_info(self, subscription_id, value, **kwargs): # noqa: E501 + """remove_credit_from_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_credit_from_subscription_with_http_info(subscription_id, value, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str value: (required) + :param list[str] organizations: + :return: InlineResponseDefault3 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'value', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method remove_credit_from_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `remove_credit_from_subscription`") # noqa: E501 + # verify the required parameter 'value' is set + if ('value' not in params or + params['value'] is None): + raise ValueError("Missing the required parameter `value` when calling `remove_credit_from_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + if 'value' in params: + path_params['value'] = params['value'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/credit/{value}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault3', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def remove_payment_method_from_subscription(self, subscription_id, payment_method_id, **kwargs): # noqa: E501 + """remove_payment_method_from_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_payment_method_from_subscription(subscription_id, payment_method_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str payment_method_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.remove_payment_method_from_subscription_with_http_info(subscription_id, payment_method_id, **kwargs) # noqa: E501 + else: + (data) = self.remove_payment_method_from_subscription_with_http_info(subscription_id, payment_method_id, **kwargs) # noqa: E501 + return data + + def remove_payment_method_from_subscription_with_http_info(self, subscription_id, payment_method_id, **kwargs): # noqa: E501 + """remove_payment_method_from_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_payment_method_from_subscription_with_http_info(subscription_id, payment_method_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str payment_method_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'payment_method_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method remove_payment_method_from_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `remove_payment_method_from_subscription`") # noqa: E501 + # verify the required parameter 'payment_method_id' is set + if ('payment_method_id' not in params or + params['payment_method_id'] is None): + raise ValueError("Missing the required parameter `payment_method_id` when calling `remove_payment_method_from_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + if 'payment_method_id' in params: + path_params['payment-method-ID'] = params['payment_method_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/payment-methods/{payment-method-ID}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault51', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def remove_pricing_component_value_change_from_subscription(self, subscription_id, pricing_component, **kwargs): # noqa: E501 + """remove_pricing_component_value_change_from_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_pricing_component_value_change_from_subscription(subscription_id, pricing_component, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str pricing_component: (required) + :param list[str] organizations: + :return: InlineResponseDefault68 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.remove_pricing_component_value_change_from_subscription_with_http_info(subscription_id, pricing_component, **kwargs) # noqa: E501 + else: + (data) = self.remove_pricing_component_value_change_from_subscription_with_http_info(subscription_id, pricing_component, **kwargs) # noqa: E501 + return data + + def remove_pricing_component_value_change_from_subscription_with_http_info(self, subscription_id, pricing_component, **kwargs): # noqa: E501 + """remove_pricing_component_value_change_from_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.remove_pricing_component_value_change_from_subscription_with_http_info(subscription_id, pricing_component, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str pricing_component: (required) + :param list[str] organizations: + :return: InlineResponseDefault68 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'pricing_component', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method remove_pricing_component_value_change_from_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `remove_pricing_component_value_change_from_subscription`") # noqa: E501 + # verify the required parameter 'pricing_component' is set + if ('pricing_component' not in params or + params['pricing_component'] is None): + raise ValueError("Missing the required parameter `pricing_component` when calling `remove_pricing_component_value_change_from_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + if 'pricing_component' in params: + path_params['pricing-component'] = params['pricing_component'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/values/{pricing-component}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault68', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def resume_subscription(self, subscription_id, **kwargs): # noqa: E501 + """resume_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.resume_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param ResumeRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.resume_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.resume_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def resume_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """resume_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.resume_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param ResumeRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method resume_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `resume_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/resume', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault51', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def revive_subscription(self, subscription_id, **kwargs): # noqa: E501 + """revive_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.revive_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param SubscriptionReviveRequest body: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.revive_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.revive_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def revive_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """revive_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.revive_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param SubscriptionReviveRequest body: + :return: InlineResponseDefault26 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method revive_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `revive_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/revive', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault26', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def set_affiliate1(self, subscription_id, **kwargs): # noqa: E501 + """set_affiliate1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_affiliate1(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param SetSubscriptionAffiliateRequest body: + :return: InlineResponseDefault67 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.set_affiliate1_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.set_affiliate1_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def set_affiliate1_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """set_affiliate1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_affiliate1_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param SetSubscriptionAffiliateRequest body: + :return: InlineResponseDefault67 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method set_affiliate1" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `set_affiliate1`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscriptionID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscriptionID}/affiliate', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault67', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def set_metadata_for_subscription(self, subscription_id, **kwargs): # noqa: E501 + """set_metadata_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_metadata_for_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str body: + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.set_metadata_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.set_metadata_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def set_metadata_for_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """set_metadata_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_metadata_for_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str body: + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method set_metadata_for_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `set_metadata_for_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/metadata', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault7', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def set_pricing_component_value_on_subscription(self, subscription_id, **kwargs): # noqa: E501 + """set_pricing_component_value_on_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_pricing_component_value_on_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param PricingComponentValue body: + :return: InlineResponseDefault72 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.set_pricing_component_value_on_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.set_pricing_component_value_on_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def set_pricing_component_value_on_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """set_pricing_component_value_on_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_pricing_component_value_on_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param PricingComponentValue body: + :return: InlineResponseDefault72 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method set_pricing_component_value_on_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `set_pricing_component_value_on_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/pricing-component-values', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault72', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def set_pricing_component_value_on_subscription1(self, subscription_id, pricing_component, **kwargs): # noqa: E501 + """set_pricing_component_value_on_subscription1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_pricing_component_value_on_subscription1(subscription_id, pricing_component, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str pricing_component: (required) + :param PricingComponentValueRequest body: + :return: InlineResponseDefault71 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.set_pricing_component_value_on_subscription1_with_http_info(subscription_id, pricing_component, **kwargs) # noqa: E501 + else: + (data) = self.set_pricing_component_value_on_subscription1_with_http_info(subscription_id, pricing_component, **kwargs) # noqa: E501 + return data + + def set_pricing_component_value_on_subscription1_with_http_info(self, subscription_id, pricing_component, **kwargs): # noqa: E501 + """set_pricing_component_value_on_subscription1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_pricing_component_value_on_subscription1_with_http_info(subscription_id, pricing_component, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str pricing_component: (required) + :param PricingComponentValueRequest body: + :return: InlineResponseDefault71 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'pricing_component', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method set_pricing_component_value_on_subscription1" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `set_pricing_component_value_on_subscription1`") # noqa: E501 + # verify the required parameter 'pricing_component' is set + if ('pricing_component' not in params or + params['pricing_component'] is None): + raise ValueError("Missing the required parameter `pricing_component` when calling `set_pricing_component_value_on_subscription1`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + if 'pricing_component' in params: + path_params['pricing-component'] = params['pricing_component'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/values/{pricing-component}', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault71', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def set_pricing_component_value_on_subscription_batch_update(self, subscription_id, **kwargs): # noqa: E501 + """set_pricing_component_value_on_subscription_batch_update # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_pricing_component_value_on_subscription_batch_update(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param BatchUpdatePricingComponentValuesRequest body: + :return: InlineResponseDefault62 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.set_pricing_component_value_on_subscription_batch_update_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.set_pricing_component_value_on_subscription_batch_update_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def set_pricing_component_value_on_subscription_batch_update_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """set_pricing_component_value_on_subscription_batch_update # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.set_pricing_component_value_on_subscription_batch_update_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param BatchUpdatePricingComponentValuesRequest body: + :return: InlineResponseDefault62 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method set_pricing_component_value_on_subscription_batch_update" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `set_pricing_component_value_on_subscription_batch_update`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/values', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault62', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def start_all_subscriptions(self, account_id, **kwargs): # noqa: E501 + """start_all_subscriptions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.start_all_subscriptions(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param StartAllSubscriptionsRequest body: + :return: InlineResponseDefault73 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.start_all_subscriptions_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.start_all_subscriptions_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def start_all_subscriptions_with_http_info(self, account_id, **kwargs): # noqa: E501 + """start_all_subscriptions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.start_all_subscriptions_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param StartAllSubscriptionsRequest body: + :return: InlineResponseDefault73 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method start_all_subscriptions" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `start_all_subscriptions`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['accountID'] = params['account_id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{accountID}/start', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault73', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_subscription_from_request(self, **kwargs): # noqa: E501 + """update_subscription_from_request # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_subscription_from_request(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UpdateSubscriptionRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_subscription_from_request_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_subscription_from_request_with_http_info(**kwargs) # noqa: E501 + return data + + def update_subscription_from_request_with_http_info(self, **kwargs): # noqa: E501 + """update_subscription_from_request # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_subscription_from_request_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param UpdateSubscriptionRequest body: + :return: InlineResponseDefault51 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_subscription_from_request" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/update', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault51', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def upsert_metadata_for_subscription(self, subscription_id, **kwargs): # noqa: E501 + """upsert_metadata_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upsert_metadata_for_subscription(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str body: + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.upsert_metadata_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + else: + (data) = self.upsert_metadata_for_subscription_with_http_info(subscription_id, **kwargs) # noqa: E501 + return data + + def upsert_metadata_for_subscription_with_http_info(self, subscription_id, **kwargs): # noqa: E501 + """upsert_metadata_for_subscription # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.upsert_metadata_for_subscription_with_http_info(subscription_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str subscription_id: (required) + :param str body: + :param list[str] organizations: + :return: InlineResponseDefault7 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['subscription_id', 'body', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method upsert_metadata_for_subscription" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'subscription_id' is set + if ('subscription_id' not in params or + params['subscription_id'] is None): + raise ValueError("Missing the required parameter `subscription_id` when calling `upsert_metadata_for_subscription`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'subscription_id' in params: + path_params['subscription-ID'] = params['subscription_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/subscriptions/{subscription-ID}/metadata', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault7', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/taxes_api.py b/billforward/api/taxes_api.py new file mode 100644 index 0000000..1c00cb6 --- /dev/null +++ b/billforward/api/taxes_api.py @@ -0,0 +1,997 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class TaxesApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def create_taxation_strategy(self, **kwargs): # noqa: E501 + """create_taxation_strategy # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_taxation_strategy(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param TaxationStrategy body: + :return: InlineResponseDefault78 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_taxation_strategy_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_taxation_strategy_with_http_info(**kwargs) # noqa: E501 + return data + + def create_taxation_strategy_with_http_info(self, **kwargs): # noqa: E501 + """create_taxation_strategy # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_taxation_strategy_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param TaxationStrategy body: + :return: InlineResponseDefault78 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_taxation_strategy" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/taxation-strategies', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault78', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_taxation_strategies(self, **kwargs): # noqa: E501 + """get_all_taxation_strategies # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_taxation_strategies(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault77 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_taxation_strategies_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_taxation_strategies_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_taxation_strategies_with_http_info(self, **kwargs): # noqa: E501 + """get_all_taxation_strategies # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_taxation_strategies_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault77 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_taxation_strategies" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/taxation-strategies', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault77', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_taxation_strategy_by_consistent_id(self, taxation_strategy_id, **kwargs): # noqa: E501 + """get_taxation_strategy_by_consistent_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_taxation_strategy_by_consistent_id(taxation_strategy_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str taxation_strategy_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault77 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_taxation_strategy_by_consistent_id_with_http_info(taxation_strategy_id, **kwargs) # noqa: E501 + else: + (data) = self.get_taxation_strategy_by_consistent_id_with_http_info(taxation_strategy_id, **kwargs) # noqa: E501 + return data + + def get_taxation_strategy_by_consistent_id_with_http_info(self, taxation_strategy_id, **kwargs): # noqa: E501 + """get_taxation_strategy_by_consistent_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_taxation_strategy_by_consistent_id_with_http_info(taxation_strategy_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str taxation_strategy_id: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault77 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['taxation_strategy_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_taxation_strategy_by_consistent_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'taxation_strategy_id' is set + if ('taxation_strategy_id' not in params or + params['taxation_strategy_id'] is None): + raise ValueError("Missing the required parameter `taxation_strategy_id` when calling `get_taxation_strategy_by_consistent_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'taxation_strategy_id' in params: + path_params['taxation-strategy-ID'] = params['taxation_strategy_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/taxation-strategies/{taxation-strategy-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault77', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_taxation_strategy_by_country(self, country, **kwargs): # noqa: E501 + """get_taxation_strategy_by_country # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_taxation_strategy_by_country(country, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str country: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault77 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_taxation_strategy_by_country_with_http_info(country, **kwargs) # noqa: E501 + else: + (data) = self.get_taxation_strategy_by_country_with_http_info(country, **kwargs) # noqa: E501 + return data + + def get_taxation_strategy_by_country_with_http_info(self, country, **kwargs): # noqa: E501 + """get_taxation_strategy_by_country # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_taxation_strategy_by_country_with_http_info(country, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str country: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault77 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['country', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_taxation_strategy_by_country" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'country' is set + if ('country' not in params or + params['country'] is None): + raise ValueError("Missing the required parameter `country` when calling `get_taxation_strategy_by_country`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'country' in params: + path_params['country'] = params['country'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/taxation-strategies/country/{country}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault77', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_taxation_strategy_by_currency(self, currency, **kwargs): # noqa: E501 + """get_taxation_strategy_by_currency # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_taxation_strategy_by_currency(currency, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str currency: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault77 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_taxation_strategy_by_currency_with_http_info(currency, **kwargs) # noqa: E501 + else: + (data) = self.get_taxation_strategy_by_currency_with_http_info(currency, **kwargs) # noqa: E501 + return data + + def get_taxation_strategy_by_currency_with_http_info(self, currency, **kwargs): # noqa: E501 + """get_taxation_strategy_by_currency # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_taxation_strategy_by_currency_with_http_info(currency, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str currency: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault77 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['currency', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_taxation_strategy_by_currency" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'currency' is set + if ('currency' not in params or + params['currency'] is None): + raise ValueError("Missing the required parameter `currency` when calling `get_taxation_strategy_by_currency`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'currency' in params: + path_params['currency'] = params['currency'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/taxation-strategies/currency/{currency}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault77', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_taxation_strategy_by_province(self, province, **kwargs): # noqa: E501 + """get_taxation_strategy_by_province # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_taxation_strategy_by_province(province, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str province: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault77 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_taxation_strategy_by_province_with_http_info(province, **kwargs) # noqa: E501 + else: + (data) = self.get_taxation_strategy_by_province_with_http_info(province, **kwargs) # noqa: E501 + return data + + def get_taxation_strategy_by_province_with_http_info(self, province, **kwargs): # noqa: E501 + """get_taxation_strategy_by_province # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_taxation_strategy_by_province_with_http_info(province, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str province: (required) + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault77 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['province', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_taxation_strategy_by_province" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'province' is set + if ('province' not in params or + params['province'] is None): + raise ValueError("Missing the required parameter `province` when calling `get_taxation_strategy_by_province`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'province' in params: + path_params['province'] = params['province'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/taxation-strategies/province/{province}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault77', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_taxation_strategy_by_version_id(self, version_id, **kwargs): # noqa: E501 + """get_taxation_strategy_by_version_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_taxation_strategy_by_version_id(version_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str version_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault78 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_taxation_strategy_by_version_id_with_http_info(version_id, **kwargs) # noqa: E501 + else: + (data) = self.get_taxation_strategy_by_version_id_with_http_info(version_id, **kwargs) # noqa: E501 + return data + + def get_taxation_strategy_by_version_id_with_http_info(self, version_id, **kwargs): # noqa: E501 + """get_taxation_strategy_by_version_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_taxation_strategy_by_version_id_with_http_info(version_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str version_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault78 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['version_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_taxation_strategy_by_version_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'version_id' is set + if ('version_id' not in params or + params['version_id'] is None): + raise ValueError("Missing the required parameter `version_id` when calling `get_taxation_strategy_by_version_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'version_id' in params: + path_params['version-ID'] = params['version_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/taxation-strategies/version/{version-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault78', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def retire_taxation_strategy(self, version_id, **kwargs): # noqa: E501 + """retire_taxation_strategy # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.retire_taxation_strategy(version_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str version_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault78 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.retire_taxation_strategy_with_http_info(version_id, **kwargs) # noqa: E501 + else: + (data) = self.retire_taxation_strategy_with_http_info(version_id, **kwargs) # noqa: E501 + return data + + def retire_taxation_strategy_with_http_info(self, version_id, **kwargs): # noqa: E501 + """retire_taxation_strategy # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.retire_taxation_strategy_with_http_info(version_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str version_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault78 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['version_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method retire_taxation_strategy" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'version_id' is set + if ('version_id' not in params or + params['version_id'] is None): + raise ValueError("Missing the required parameter `version_id` when calling `retire_taxation_strategy`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'version_id' in params: + path_params['version-ID'] = params['version_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/taxation-strategies/version/{version-ID}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault78', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_taxation_strategy(self, **kwargs): # noqa: E501 + """update_taxation_strategy # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_taxation_strategy(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param TaxationStrategy body: + :return: InlineResponseDefault78 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_taxation_strategy_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_taxation_strategy_with_http_info(**kwargs) # noqa: E501 + return data + + def update_taxation_strategy_with_http_info(self, **kwargs): # noqa: E501 + """update_taxation_strategy # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_taxation_strategy_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param TaxationStrategy body: + :return: InlineResponseDefault78 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_taxation_strategy" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/taxation-strategies', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault78', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/tokenization_api.py b/billforward/api/tokenization_api.py new file mode 100644 index 0000000..3763862 --- /dev/null +++ b/billforward/api/tokenization_api.py @@ -0,0 +1,3430 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class TokenizationApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def auth_capture(self, **kwargs): # noqa: E501 + """auth_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.auth_capture(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param AuthCaptureRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.auth_capture_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.auth_capture_with_http_info(**kwargs) # noqa: E501 + return data + + def auth_capture_with_http_info(self, **kwargs): # noqa: E501 + """auth_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.auth_capture_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param AuthCaptureRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method auth_capture" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/auth-capture', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault40', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def braintree_card_capture(self, **kwargs): # noqa: E501 + """braintree_card_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.braintree_card_capture(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param BraintreeCaptureRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.braintree_card_capture_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.braintree_card_capture_with_http_info(**kwargs) # noqa: E501 + return data + + def braintree_card_capture_with_http_info(self, **kwargs): # noqa: E501 + """braintree_card_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.braintree_card_capture_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param BraintreeCaptureRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method braintree_card_capture" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/braintree', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault40', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_authorize_net_token(self, **kwargs): # noqa: E501 + """create_authorize_net_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_authorize_net_token(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param AuthorizeNetToken body: + :return: InlineResponseDefault93 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_authorize_net_token_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_authorize_net_token_with_http_info(**kwargs) # noqa: E501 + return data + + def create_authorize_net_token_with_http_info(self, **kwargs): # noqa: E501 + """create_authorize_net_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_authorize_net_token_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param AuthorizeNetToken body: + :return: InlineResponseDefault93 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_authorize_net_token" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/vaulted-gateways/authorize-net', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault93', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_braintree_token(self, **kwargs): # noqa: E501 + """create_braintree_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_braintree_token(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param BraintreeToken body: + :return: InlineResponseDefault94 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_braintree_token_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_braintree_token_with_http_info(**kwargs) # noqa: E501 + return data + + def create_braintree_token_with_http_info(self, **kwargs): # noqa: E501 + """create_braintree_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_braintree_token_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param BraintreeToken body: + :return: InlineResponseDefault94 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_braintree_token" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/vaulted-gateways/braintree', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault94', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_stripe_ach_token(self, **kwargs): # noqa: E501 + """create_stripe_ach_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_stripe_ach_token(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param StripeAchToken body: + :return: InlineResponseDefault95 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_stripe_ach_token_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_stripe_ach_token_with_http_info(**kwargs) # noqa: E501 + return data + + def create_stripe_ach_token_with_http_info(self, **kwargs): # noqa: E501 + """create_stripe_ach_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_stripe_ach_token_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param StripeAchToken body: + :return: InlineResponseDefault95 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_stripe_ach_token" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/vaulted-gateways/stripe-ACH', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault95', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_stripe_token(self, **kwargs): # noqa: E501 + """create_stripe_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_stripe_token(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param StripeToken body: + :return: InlineResponseDefault96 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_stripe_token_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_stripe_token_with_http_info(**kwargs) # noqa: E501 + return data + + def create_stripe_token_with_http_info(self, **kwargs): # noqa: E501 + """create_stripe_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_stripe_token_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param StripeToken body: + :return: InlineResponseDefault96 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_stripe_token" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/vaulted-gateways/stripe', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault96', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_trust_commerce_token(self, **kwargs): # noqa: E501 + """create_trust_commerce_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_trust_commerce_token(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param TrustCommerceToken body: + :return: InlineResponseDefault97 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_trust_commerce_token_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_trust_commerce_token_with_http_info(**kwargs) # noqa: E501 + return data + + def create_trust_commerce_token_with_http_info(self, **kwargs): # noqa: E501 + """create_trust_commerce_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_trust_commerce_token_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param TrustCommerceToken body: + :return: InlineResponseDefault97 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_trust_commerce_token" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/vaulted-gateways/trustCommerce', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault97', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def display_card_capture_form(self, **kwargs): # noqa: E501 + """display_card_capture_form # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.display_card_capture_form(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str account_id: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.display_card_capture_form_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.display_card_capture_form_with_http_info(**kwargs) # noqa: E501 + return data + + def display_card_capture_form_with_http_info(self, **kwargs): # noqa: E501 + """display_card_capture_form # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.display_card_capture_form_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str account_id: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'account_id'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method display_card_capture_form" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'account_id' in params: + query_params.append(('accountID', params['account_id'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/card-capture-form', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def epx_card_capture(self, **kwargs): # noqa: E501 + """epx_card_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.epx_card_capture(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param EpxCaptureRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.epx_card_capture_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.epx_card_capture_with_http_info(**kwargs) # noqa: E501 + return data + + def epx_card_capture_with_http_info(self, **kwargs): # noqa: E501 + """epx_card_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.epx_card_capture_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param EpxCaptureRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method epx_card_capture" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/epx', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault40', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def epx_pre_auth(self, **kwargs): # noqa: E501 + """epx_pre_auth # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.epx_pre_auth(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param EpxPreAuthRequest body: + :return: InlineResponseDefault79 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.epx_pre_auth_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.epx_pre_auth_with_http_info(**kwargs) # noqa: E501 + return data + + def epx_pre_auth_with_http_info(self, **kwargs): # noqa: E501 + """epx_pre_auth # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.epx_pre_auth_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param EpxPreAuthRequest body: + :return: InlineResponseDefault79 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method epx_pre_auth" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/epx-pre-auth', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault79', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def epx_pre_auth_response(self, **kwargs): # noqa: E501 + """epx_pre_auth_response # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.epx_pre_auth_response(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str cust_nbr: + :param str merch_nbr: + :param str dba_nbr: + :param str terminal_nbr: + :param str tran_code: + :param str amount: + :param str auth_account: + :param str first_name: + :param str last_name: + :param str exp_date: + :param str bp_resp_code: + :param str bp_resp_text: + :param str bp_field_errors: + :param str msg_version: + :param str tran_type: + :param str tran_nbr: + :param str local_date: + :param str local_time: + :param str auth_guid: + :param str auth_resp: + :param str auth_code: + :param str auth_cvv2: + :param str auth_resp_text: + :param str auth_card_type: + :param str auth_tran_date_gmt: + :param str auth_amount_requested: + :param str auth_amount: + :param str auth_currency_code: + :param str network_response: + :param str auth_masked_account_nbr: + :param str user_data_9: + :param str user_data_10: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.epx_pre_auth_response_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.epx_pre_auth_response_with_http_info(**kwargs) # noqa: E501 + return data + + def epx_pre_auth_response_with_http_info(self, **kwargs): # noqa: E501 + """epx_pre_auth_response # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.epx_pre_auth_response_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str cust_nbr: + :param str merch_nbr: + :param str dba_nbr: + :param str terminal_nbr: + :param str tran_code: + :param str amount: + :param str auth_account: + :param str first_name: + :param str last_name: + :param str exp_date: + :param str bp_resp_code: + :param str bp_resp_text: + :param str bp_field_errors: + :param str msg_version: + :param str tran_type: + :param str tran_nbr: + :param str local_date: + :param str local_time: + :param str auth_guid: + :param str auth_resp: + :param str auth_code: + :param str auth_cvv2: + :param str auth_resp_text: + :param str auth_card_type: + :param str auth_tran_date_gmt: + :param str auth_amount_requested: + :param str auth_amount: + :param str auth_currency_code: + :param str network_response: + :param str auth_masked_account_nbr: + :param str user_data_9: + :param str user_data_10: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['cust_nbr', 'merch_nbr', 'dba_nbr', 'terminal_nbr', 'tran_code', 'amount', 'auth_account', 'first_name', 'last_name', 'exp_date', 'bp_resp_code', 'bp_resp_text', 'bp_field_errors', 'msg_version', 'tran_type', 'tran_nbr', 'local_date', 'local_time', 'auth_guid', 'auth_resp', 'auth_code', 'auth_cvv2', 'auth_resp_text', 'auth_card_type', 'auth_tran_date_gmt', 'auth_amount_requested', 'auth_amount', 'auth_currency_code', 'network_response', 'auth_masked_account_nbr', 'user_data_9', 'user_data_10'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method epx_pre_auth_response" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + if 'cust_nbr' in params: + form_params.append(('CUST_NBR', params['cust_nbr'])) # noqa: E501 + if 'merch_nbr' in params: + form_params.append(('MERCH_NBR', params['merch_nbr'])) # noqa: E501 + if 'dba_nbr' in params: + form_params.append(('DBA_NBR', params['dba_nbr'])) # noqa: E501 + if 'terminal_nbr' in params: + form_params.append(('TERMINAL_NBR', params['terminal_nbr'])) # noqa: E501 + if 'tran_code' in params: + form_params.append(('TRAN_CODE', params['tran_code'])) # noqa: E501 + if 'amount' in params: + form_params.append(('AMOUNT', params['amount'])) # noqa: E501 + if 'auth_account' in params: + form_params.append(('AUTH_ACCOUNT', params['auth_account'])) # noqa: E501 + if 'first_name' in params: + form_params.append(('FIRST_NAME', params['first_name'])) # noqa: E501 + if 'last_name' in params: + form_params.append(('LAST_NAME', params['last_name'])) # noqa: E501 + if 'exp_date' in params: + form_params.append(('EXP_DATE', params['exp_date'])) # noqa: E501 + if 'bp_resp_code' in params: + form_params.append(('BP_RESP_CODE', params['bp_resp_code'])) # noqa: E501 + if 'bp_resp_text' in params: + form_params.append(('BP_RESP_TEXT', params['bp_resp_text'])) # noqa: E501 + if 'bp_field_errors' in params: + form_params.append(('BP_FIELD_ERRORS', params['bp_field_errors'])) # noqa: E501 + if 'msg_version' in params: + form_params.append(('MSG_VERSION', params['msg_version'])) # noqa: E501 + if 'tran_type' in params: + form_params.append(('TRAN_TYPE', params['tran_type'])) # noqa: E501 + if 'tran_nbr' in params: + form_params.append(('TRAN_NBR', params['tran_nbr'])) # noqa: E501 + if 'local_date' in params: + form_params.append(('LOCAL_DATE', params['local_date'])) # noqa: E501 + if 'local_time' in params: + form_params.append(('LOCAL_TIME', params['local_time'])) # noqa: E501 + if 'auth_guid' in params: + form_params.append(('AUTH_GUID', params['auth_guid'])) # noqa: E501 + if 'auth_resp' in params: + form_params.append(('AUTH_RESP', params['auth_resp'])) # noqa: E501 + if 'auth_code' in params: + form_params.append(('AUTH_CODE', params['auth_code'])) # noqa: E501 + if 'auth_cvv2' in params: + form_params.append(('AUTH_CVV2', params['auth_cvv2'])) # noqa: E501 + if 'auth_resp_text' in params: + form_params.append(('AUTH_RESP_TEXT', params['auth_resp_text'])) # noqa: E501 + if 'auth_card_type' in params: + form_params.append(('AUTH_CARD_TYPE', params['auth_card_type'])) # noqa: E501 + if 'auth_tran_date_gmt' in params: + form_params.append(('AUTH_TRAN_DATE_GMT', params['auth_tran_date_gmt'])) # noqa: E501 + if 'auth_amount_requested' in params: + form_params.append(('AUTH_AMOUNT_REQUESTED', params['auth_amount_requested'])) # noqa: E501 + if 'auth_amount' in params: + form_params.append(('AUTH_AMOUNT', params['auth_amount'])) # noqa: E501 + if 'auth_currency_code' in params: + form_params.append(('AUTH_CURRENCY_CODE', params['auth_currency_code'])) # noqa: E501 + if 'network_response' in params: + form_params.append(('NETWORK_RESPONSE', params['network_response'])) # noqa: E501 + if 'auth_masked_account_nbr' in params: + form_params.append(('AUTH_MASKED_ACCOUNT_NBR', params['auth_masked_account_nbr'])) # noqa: E501 + if 'user_data_9' in params: + form_params.append(('USER_DATA_9', params['user_data_9'])) # noqa: E501 + if 'user_data_10' in params: + form_params.append(('USER_DATA_10', params['user_data_10'])) # noqa: E501 + + body_params = None + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/x-www-form-urlencoded']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/epx-redirect', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def expire_email_redirect_capture(self, id, **kwargs): # noqa: E501 + """expire_email_redirect_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.expire_email_redirect_capture(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :return: InlineResponseDefault80 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.expire_email_redirect_capture_with_http_info(id, **kwargs) # noqa: E501 + else: + (data) = self.expire_email_redirect_capture_with_http_info(id, **kwargs) # noqa: E501 + return data + + def expire_email_redirect_capture_with_http_info(self, id, **kwargs): # noqa: E501 + """expire_email_redirect_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.expire_email_redirect_capture_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :return: InlineResponseDefault80 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method expire_email_redirect_capture" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params or + params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `expire_email_redirect_capture`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/email-redirect/{id}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault80', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_email_redirect_capture(self, **kwargs): # noqa: E501 + """get_all_email_redirect_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_email_redirect_capture(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: + :param str subscription_id: + :param str invoice_id: + :param list[str] organizations: + :return: InlineResponseDefault81 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_email_redirect_capture_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_email_redirect_capture_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_email_redirect_capture_with_http_info(self, **kwargs): # noqa: E501 + """get_all_email_redirect_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_email_redirect_capture_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: + :param str subscription_id: + :param str invoice_id: + :param list[str] organizations: + :return: InlineResponseDefault81 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'subscription_id', 'invoice_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_email_redirect_capture" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'account_id' in params: + query_params.append(('account_id', params['account_id'])) # noqa: E501 + if 'subscription_id' in params: + query_params.append(('subscription_id', params['subscription_id'])) # noqa: E501 + if 'invoice_id' in params: + query_params.append(('invoice_id', params['invoice_id'])) # noqa: E501 + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/email-redirect', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault81', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_braintree_by_account_id(self, account_id, **kwargs): # noqa: E501 + """get_braintree_by_account_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_braintree_by_account_id(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault98 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_braintree_by_account_id_with_http_info(account_id, **kwargs) # noqa: E501 + else: + (data) = self.get_braintree_by_account_id_with_http_info(account_id, **kwargs) # noqa: E501 + return data + + def get_braintree_by_account_id_with_http_info(self, account_id, **kwargs): # noqa: E501 + """get_braintree_by_account_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_braintree_by_account_id_with_http_info(account_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str account_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault98 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['account_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_braintree_by_account_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'account_id' is set + if ('account_id' not in params or + params['account_id'] is None): + raise ValueError("Missing the required parameter `account_id` when calling `get_braintree_by_account_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'account_id' in params: + path_params['accountID'] = params['account_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/vaulted-gateways/braintree/{accountID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault98', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_by_card_details_id(self, card_details_id, **kwargs): # noqa: E501 + """get_by_card_details_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_by_card_details_id(card_details_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str card_details_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault99 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_by_card_details_id_with_http_info(card_details_id, **kwargs) # noqa: E501 + else: + (data) = self.get_by_card_details_id_with_http_info(card_details_id, **kwargs) # noqa: E501 + return data + + def get_by_card_details_id_with_http_info(self, card_details_id, **kwargs): # noqa: E501 + """get_by_card_details_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_by_card_details_id_with_http_info(card_details_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str card_details_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault99 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['card_details_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_by_card_details_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'card_details_id' is set + if ('card_details_id' not in params or + params['card_details_id'] is None): + raise ValueError("Missing the required parameter `card_details_id` when calling `get_by_card_details_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'card_details_id' in params: + path_params['cardDetailsID'] = params['card_details_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/vaulted-gateways/stripe/card-details-id/{cardDetailsID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault99', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_email_redirect_capture(self, id, **kwargs): # noqa: E501 + """get_email_redirect_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_email_redirect_capture(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :return: InlineResponseDefault80 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_email_redirect_capture_with_http_info(id, **kwargs) # noqa: E501 + else: + (data) = self.get_email_redirect_capture_with_http_info(id, **kwargs) # noqa: E501 + return data + + def get_email_redirect_capture_with_http_info(self, id, **kwargs): # noqa: E501 + """get_email_redirect_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_email_redirect_capture_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :return: InlineResponseDefault80 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_email_redirect_capture" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params or + params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_email_redirect_capture`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/email-redirect/{id}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault80', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_email_redirect_capture_invoice_html(self, id, **kwargs): # noqa: E501 + """get_email_redirect_capture_invoice_html # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_email_redirect_capture_invoice_html(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_email_redirect_capture_invoice_html_with_http_info(id, **kwargs) # noqa: E501 + else: + (data) = self.get_email_redirect_capture_invoice_html_with_http_info(id, **kwargs) # noqa: E501 + return data + + def get_email_redirect_capture_invoice_html_with_http_info(self, id, **kwargs): # noqa: E501 + """get_email_redirect_capture_invoice_html # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_email_redirect_capture_invoice_html_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param list[str] organizations: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_email_redirect_capture_invoice_html" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params or + params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `get_email_redirect_capture_invoice_html`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/email-redirect/{id}/invoice.html', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_stripe_ach(self, stripe_ach_token_id, **kwargs): # noqa: E501 + """get_stripe_ach # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_stripe_ach(stripe_ach_token_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str stripe_ach_token_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault100 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_stripe_ach_with_http_info(stripe_ach_token_id, **kwargs) # noqa: E501 + else: + (data) = self.get_stripe_ach_with_http_info(stripe_ach_token_id, **kwargs) # noqa: E501 + return data + + def get_stripe_ach_with_http_info(self, stripe_ach_token_id, **kwargs): # noqa: E501 + """get_stripe_ach # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_stripe_ach_with_http_info(stripe_ach_token_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str stripe_ach_token_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault100 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['stripe_ach_token_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_stripe_ach" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'stripe_ach_token_id' is set + if ('stripe_ach_token_id' not in params or + params['stripe_ach_token_id'] is None): + raise ValueError("Missing the required parameter `stripe_ach_token_id` when calling `get_stripe_ach`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'stripe_ach_token_id' in params: + path_params['stripeACHTokenID'] = params['stripe_ach_token_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/vaulted-gateways/stripe-ACH/{stripeACHTokenID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault100', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_stripe_token(self, stripe_token_id, **kwargs): # noqa: E501 + """get_stripe_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_stripe_token(stripe_token_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str stripe_token_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault99 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_stripe_token_with_http_info(stripe_token_id, **kwargs) # noqa: E501 + else: + (data) = self.get_stripe_token_with_http_info(stripe_token_id, **kwargs) # noqa: E501 + return data + + def get_stripe_token_with_http_info(self, stripe_token_id, **kwargs): # noqa: E501 + """get_stripe_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_stripe_token_with_http_info(stripe_token_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str stripe_token_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault99 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['stripe_token_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_stripe_token" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'stripe_token_id' is set + if ('stripe_token_id' not in params or + params['stripe_token_id'] is None): + raise ValueError("Missing the required parameter `stripe_token_id` when calling `get_stripe_token`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'stripe_token_id' in params: + path_params['stripeTokenID'] = params['stripe_token_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/vaulted-gateways/stripe/{stripeTokenID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault99', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def go_cardless_bank_account_capture(self, **kwargs): # noqa: E501 + """go_cardless_bank_account_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.go_cardless_bank_account_capture(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param GoCardlessTokenizationRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.go_cardless_bank_account_capture_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.go_cardless_bank_account_capture_with_http_info(**kwargs) # noqa: E501 + return data + + def go_cardless_bank_account_capture_with_http_info(self, **kwargs): # noqa: E501 + """go_cardless_bank_account_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.go_cardless_bank_account_capture_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param GoCardlessTokenizationRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method go_cardless_bank_account_capture" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/direct-debit', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault40', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def pay_vision_shout_v1(self, **kwargs): # noqa: E501 + """pay_vision_shout_v1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.pay_vision_shout_v1(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str _resource_path: + :param str id: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.pay_vision_shout_v1_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.pay_vision_shout_v1_with_http_info(**kwargs) # noqa: E501 + return data + + def pay_vision_shout_v1_with_http_info(self, **kwargs): # noqa: E501 + """pay_vision_shout_v1 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.pay_vision_shout_v1_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str _resource_path: + :param str id: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['_resource_path', 'id'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method pay_vision_shout_v1" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + if '_resource_path' in params: + form_params.append(('resourcePath', params['_resource_path'])) # noqa: E501 + if 'id' in params: + form_params.append(('id', params['id'])) # noqa: E501 + + body_params = None + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/x-www-form-urlencoded']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/payvision-shout-v1', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def pre_auth(self, **kwargs): # noqa: E501 + """pre_auth # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.pre_auth(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param TokenizationPreAuthRequest body: + :return: InlineResponseDefault82 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.pre_auth_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.pre_auth_with_http_info(**kwargs) # noqa: E501 + return data + + def pre_auth_with_http_info(self, **kwargs): # noqa: E501 + """pre_auth # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.pre_auth_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param TokenizationPreAuthRequest body: + :return: InlineResponseDefault82 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method pre_auth" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/pre-auth', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault82', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def sage_pay_notify_v300(self, **kwargs): # noqa: E501 + """sage_pay_notify_v300 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.sage_pay_notify_v300(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str vps_protocol: + :param str tx_type: + :param str vendor_tx_code: + :param str status: + :param str vps_tx_id: + :param str card_type: + :param str token: + :param str status_detail: + :param str last4_digits: + :param str vps_signature: + :param str expiry_date: + :param list[str] organizations: + :param str u: + :param str access_token: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.sage_pay_notify_v300_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.sage_pay_notify_v300_with_http_info(**kwargs) # noqa: E501 + return data + + def sage_pay_notify_v300_with_http_info(self, **kwargs): # noqa: E501 + """sage_pay_notify_v300 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.sage_pay_notify_v300_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str vps_protocol: + :param str tx_type: + :param str vendor_tx_code: + :param str status: + :param str vps_tx_id: + :param str card_type: + :param str token: + :param str status_detail: + :param str last4_digits: + :param str vps_signature: + :param str expiry_date: + :param list[str] organizations: + :param str u: + :param str access_token: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['vps_protocol', 'tx_type', 'vendor_tx_code', 'status', 'vps_tx_id', 'card_type', 'token', 'status_detail', 'last4_digits', 'vps_signature', 'expiry_date', 'organizations', 'u', 'access_token'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method sage_pay_notify_v300" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'u' in params: + query_params.append(('u', params['u'])) # noqa: E501 + if 'access_token' in params: + query_params.append(('access_token', params['access_token'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + if 'vps_protocol' in params: + form_params.append(('VPSProtocol', params['vps_protocol'])) # noqa: E501 + if 'tx_type' in params: + form_params.append(('TxType', params['tx_type'])) # noqa: E501 + if 'vendor_tx_code' in params: + form_params.append(('VendorTxCode', params['vendor_tx_code'])) # noqa: E501 + if 'status' in params: + form_params.append(('Status', params['status'])) # noqa: E501 + if 'vps_tx_id' in params: + form_params.append(('VPSTxId', params['vps_tx_id'])) # noqa: E501 + if 'card_type' in params: + form_params.append(('CardType', params['card_type'])) # noqa: E501 + if 'token' in params: + form_params.append(('Token', params['token'])) # noqa: E501 + if 'status_detail' in params: + form_params.append(('StatusDetail', params['status_detail'])) # noqa: E501 + if 'last4_digits' in params: + form_params.append(('Last4Digits', params['last4_digits'])) # noqa: E501 + if 'vps_signature' in params: + form_params.append(('VPSSignature', params['vps_signature'])) # noqa: E501 + if 'expiry_date' in params: + form_params.append(('ExpiryDate', params['expiry_date'])) # noqa: E501 + + body_params = None + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/x-www-form-urlencoded']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/sagepay-notify-v3-00', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def sage_pay_shout_v300(self, **kwargs): # noqa: E501 + """sage_pay_shout_v300 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.sage_pay_shout_v300(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str s: + :param str t: + :param str c: + :param str e: + :param str l: + :param str d: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.sage_pay_shout_v300_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.sage_pay_shout_v300_with_http_info(**kwargs) # noqa: E501 + return data + + def sage_pay_shout_v300_with_http_info(self, **kwargs): # noqa: E501 + """sage_pay_shout_v300 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.sage_pay_shout_v300_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param str s: + :param str t: + :param str c: + :param str e: + :param str l: + :param str d: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 's', 't', 'c', 'e', 'l', 'd'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method sage_pay_shout_v300" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 's' in params: + query_params.append(('s', params['s'])) # noqa: E501 + if 't' in params: + query_params.append(('t', params['t'])) # noqa: E501 + if 'c' in params: + query_params.append(('c', params['c'])) # noqa: E501 + if 'e' in params: + query_params.append(('e', params['e'])) # noqa: E501 + if 'l' in params: + query_params.append(('l', params['l'])) # noqa: E501 + if 'd' in params: + query_params.append(('d', params['d'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/sagepay-shout-v3-00', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def send_email_redirect_capture(self, id, **kwargs): # noqa: E501 + """send_email_redirect_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.send_email_redirect_capture(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param EmailTokenizationSendAPIRequest body: + :return: InlineResponseDefault80 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.send_email_redirect_capture_with_http_info(id, **kwargs) # noqa: E501 + else: + (data) = self.send_email_redirect_capture_with_http_info(id, **kwargs) # noqa: E501 + return data + + def send_email_redirect_capture_with_http_info(self, id, **kwargs): # noqa: E501 + """send_email_redirect_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.send_email_redirect_capture_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param EmailTokenizationSendAPIRequest body: + :return: InlineResponseDefault80 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method send_email_redirect_capture" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params or + params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `send_email_redirect_capture`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/email-redirect/{id}/send', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault80', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def start_email_redirect_capture(self, **kwargs): # noqa: E501 + """start_email_redirect_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.start_email_redirect_capture(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param EmailTokenizationCreateAPIRequest body: + :return: InlineResponseDefault80 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.start_email_redirect_capture_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.start_email_redirect_capture_with_http_info(**kwargs) # noqa: E501 + return data + + def start_email_redirect_capture_with_http_info(self, **kwargs): # noqa: E501 + """start_email_redirect_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.start_email_redirect_capture_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param EmailTokenizationCreateAPIRequest body: + :return: InlineResponseDefault80 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method start_email_redirect_capture" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/email-redirect', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault80', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def stripe_ach_bank_account_capture(self, **kwargs): # noqa: E501 + """stripe_ach_bank_account_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.stripe_ach_bank_account_capture(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param StripeACHCaptureRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.stripe_ach_bank_account_capture_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.stripe_ach_bank_account_capture_with_http_info(**kwargs) # noqa: E501 + return data + + def stripe_ach_bank_account_capture_with_http_info(self, **kwargs): # noqa: E501 + """stripe_ach_bank_account_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.stripe_ach_bank_account_capture_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param StripeACHCaptureRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method stripe_ach_bank_account_capture" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/ach', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault40', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def stripe_web_hook(self, **kwargs): # noqa: E501 + """stripe_web_hook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.stripe_web_hook(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str body: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.stripe_web_hook_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.stripe_web_hook_with_http_info(**kwargs) # noqa: E501 + return data + + def stripe_web_hook_with_http_info(self, **kwargs): # noqa: E501 + """stripe_web_hook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.stripe_web_hook_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str body: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method stripe_web_hook" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/vaulted-gateways/stripe/webhook', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_email_redirect_capture(self, id, **kwargs): # noqa: E501 + """update_email_redirect_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_email_redirect_capture(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param EmailTokenizationUpdateAPIRequest body: + :return: InlineResponseDefault80 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_email_redirect_capture_with_http_info(id, **kwargs) # noqa: E501 + else: + (data) = self.update_email_redirect_capture_with_http_info(id, **kwargs) # noqa: E501 + return data + + def update_email_redirect_capture_with_http_info(self, id, **kwargs): # noqa: E501 + """update_email_redirect_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_email_redirect_capture_with_http_info(id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str id: (required) + :param EmailTokenizationUpdateAPIRequest body: + :return: InlineResponseDefault80 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['id', 'body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_email_redirect_capture" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'id' is set + if ('id' not in params or + params['id'] is None): + raise ValueError("Missing the required parameter `id` when calling `update_email_redirect_capture`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'id' in params: + path_params['id'] = params['id'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/email-redirect/{id}', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault80', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_profile_with_token(self, **kwargs): # noqa: E501 + """update_profile_with_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_profile_with_token(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Profile body: + :param str request_token: + :return: InlineResponseDefault83 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_profile_with_token_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_profile_with_token_with_http_info(**kwargs) # noqa: E501 + return data + + def update_profile_with_token_with_http_info(self, **kwargs): # noqa: E501 + """update_profile_with_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_profile_with_token_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Profile body: + :param str request_token: + :return: InlineResponseDefault83 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body', 'request_token'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_profile_with_token" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'request_token' in params: + query_params.append(('request_token', params['request_token'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/profile', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault83', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_stripe_ach_token(self, **kwargs): # noqa: E501 + """update_stripe_ach_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_stripe_ach_token(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param StripeAchToken body: + :return: InlineResponseDefault95 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_stripe_ach_token_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_stripe_ach_token_with_http_info(**kwargs) # noqa: E501 + return data + + def update_stripe_ach_token_with_http_info(self, **kwargs): # noqa: E501 + """update_stripe_ach_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_stripe_ach_token_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param StripeAchToken body: + :return: InlineResponseDefault95 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_stripe_ach_token" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/vaulted-gateways/stripe-ACH', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault95', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_stripe_token(self, **kwargs): # noqa: E501 + """update_stripe_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_stripe_token(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param StripeToken body: + :return: InlineResponseDefault96 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_stripe_token_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_stripe_token_with_http_info(**kwargs) # noqa: E501 + return data + + def update_stripe_token_with_http_info(self, **kwargs): # noqa: E501 + """update_stripe_token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_stripe_token_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param StripeToken body: + :return: InlineResponseDefault96 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_stripe_token" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/vaulted-gateways/stripe', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault96', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def zooz_card_capture(self, **kwargs): # noqa: E501 + """zooz_card_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.zooz_card_capture(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param ZoozCaptureRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.zooz_card_capture_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.zooz_card_capture_with_http_info(**kwargs) # noqa: E501 + return data + + def zooz_card_capture_with_http_info(self, **kwargs): # noqa: E501 + """zooz_card_capture # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.zooz_card_capture_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param ZoozCaptureRequest body: + :return: InlineResponseDefault40 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method zooz_card_capture" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/tokenization/zooz', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault40', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def zooz_web_hook(self, **kwargs): # noqa: E501 + """zooz_web_hook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.zooz_web_hook(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str body: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.zooz_web_hook_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.zooz_web_hook_with_http_info(**kwargs) # noqa: E501 + return data + + def zooz_web_hook_with_http_info(self, **kwargs): # noqa: E501 + """zooz_web_hook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.zooz_web_hook_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str body: + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method zooz_web_hook" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['*/*']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/vaulted-gateways/zooz/webhook', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api/webhooks_api.py b/billforward/api/webhooks_api.py new file mode 100644 index 0000000..22ac814 --- /dev/null +++ b/billforward/api/webhooks_api.py @@ -0,0 +1,806 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import re # noqa: F401 + +# python 2 and python 3 compatibility library +import six + +from billforward.api_client import ApiClient + + +class WebhooksApi(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + + def create_webhook(self, **kwargs): # noqa: E501 + """create_webhook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_webhook(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Webhook body: + :return: InlineResponseDefault102 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_webhook_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_webhook_with_http_info(**kwargs) # noqa: E501 + return data + + def create_webhook_with_http_info(self, **kwargs): # noqa: E501 + """create_webhook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_webhook_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Webhook body: + :return: InlineResponseDefault102 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_webhook" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/webhooks', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault102', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def create_webhook_v2(self, **kwargs): # noqa: E501 + """create_webhook_v2 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_webhook_v2(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param LegacyCreateWebhookRequest body: + :return: InlineResponseDefault102 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.create_webhook_v2_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.create_webhook_v2_with_http_info(**kwargs) # noqa: E501 + return data + + def create_webhook_v2_with_http_info(self, **kwargs): # noqa: E501 + """create_webhook_v2 # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.create_webhook_v2_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param LegacyCreateWebhookRequest body: + :return: InlineResponseDefault102 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method create_webhook_v2" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/webhooks/create', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault102', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_all_webhooks(self, **kwargs): # noqa: E501 + """get_all_webhooks # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_webhooks(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault101 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_all_webhooks_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_all_webhooks_with_http_info(**kwargs) # noqa: E501 + return data + + def get_all_webhooks_with_http_info(self, **kwargs): # noqa: E501 + """get_all_webhooks # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_all_webhooks_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :param int offset: + :param int records: + :param str order_by: + :param str order: + :param bool include_retired: + :return: InlineResponseDefault101 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_all_webhooks" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + if 'offset' in params: + query_params.append(('offset', params['offset'])) # noqa: E501 + if 'records' in params: + query_params.append(('records', params['records'])) # noqa: E501 + if 'order_by' in params: + query_params.append(('order_by', params['order_by'])) # noqa: E501 + if 'order' in params: + query_params.append(('order', params['order'])) # noqa: E501 + if 'include_retired' in params: + query_params.append(('include_retired', params['include_retired'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/webhooks', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault101', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_allowed_webhook_subscriptions(self, **kwargs): # noqa: E501 + """get_allowed_webhook_subscriptions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_allowed_webhook_subscriptions(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault103 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_allowed_webhook_subscriptions_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.get_allowed_webhook_subscriptions_with_http_info(**kwargs) # noqa: E501 + return data + + def get_allowed_webhook_subscriptions_with_http_info(self, **kwargs): # noqa: E501 + """get_allowed_webhook_subscriptions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_allowed_webhook_subscriptions_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param list[str] organizations: + :return: InlineResponseDefault103 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_allowed_webhook_subscriptions" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/webhooks/allowed-subscriptions', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault103', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def get_webhook_by_id(self, webhook_id, **kwargs): # noqa: E501 + """get_webhook_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_webhook_by_id(webhook_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str webhook_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault102 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.get_webhook_by_id_with_http_info(webhook_id, **kwargs) # noqa: E501 + else: + (data) = self.get_webhook_by_id_with_http_info(webhook_id, **kwargs) # noqa: E501 + return data + + def get_webhook_by_id_with_http_info(self, webhook_id, **kwargs): # noqa: E501 + """get_webhook_by_id # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_webhook_by_id_with_http_info(webhook_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str webhook_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault102 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['webhook_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_webhook_by_id" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'webhook_id' is set + if ('webhook_id' not in params or + params['webhook_id'] is None): + raise ValueError("Missing the required parameter `webhook_id` when calling `get_webhook_by_id`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'webhook_id' in params: + path_params['webhook-ID'] = params['webhook_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/webhooks/{webhook-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault102', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def retire_webhook(self, webhook_id, **kwargs): # noqa: E501 + """retire_webhook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.retire_webhook(webhook_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str webhook_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault102 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.retire_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501 + else: + (data) = self.retire_webhook_with_http_info(webhook_id, **kwargs) # noqa: E501 + return data + + def retire_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501 + """retire_webhook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.retire_webhook_with_http_info(webhook_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str webhook_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault102 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['webhook_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method retire_webhook" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'webhook_id' is set + if ('webhook_id' not in params or + params['webhook_id'] is None): + raise ValueError("Missing the required parameter `webhook_id` when calling `retire_webhook`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'webhook_id' in params: + path_params['webhook-ID'] = params['webhook_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/webhooks/{webhook-ID}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault102', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def update_webhook(self, **kwargs): # noqa: E501 + """update_webhook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_webhook(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Webhook body: + :return: InlineResponseDefault102 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.update_webhook_with_http_info(**kwargs) # noqa: E501 + else: + (data) = self.update_webhook_with_http_info(**kwargs) # noqa: E501 + return data + + def update_webhook_with_http_info(self, **kwargs): # noqa: E501 + """update_webhook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_webhook_with_http_info(async_req=True) + >>> result = thread.get() + + :param async_req bool + :param Webhook body: + :return: InlineResponseDefault102 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['body'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method update_webhook" % key + ) + params[key] = val + del params['kwargs'] + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in params: + body_params = params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/webhooks', 'PUT', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault102', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) + + def verify_webhook(self, verification_id, **kwargs): # noqa: E501 + """verify_webhook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.verify_webhook(verification_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str verification_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault102 + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + if kwargs.get('async_req'): + return self.verify_webhook_with_http_info(verification_id, **kwargs) # noqa: E501 + else: + (data) = self.verify_webhook_with_http_info(verification_id, **kwargs) # noqa: E501 + return data + + def verify_webhook_with_http_info(self, verification_id, **kwargs): # noqa: E501 + """verify_webhook # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.verify_webhook_with_http_info(verification_id, async_req=True) + >>> result = thread.get() + + :param async_req bool + :param str verification_id: (required) + :param list[str] organizations: + :return: InlineResponseDefault102 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['verification_id', 'organizations'] # noqa: E501 + all_params.append('async_req') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in six.iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method verify_webhook" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'verification_id' is set + if ('verification_id' not in params or + params['verification_id'] is None): + raise ValueError("Missing the required parameter `verification_id` when calling `verify_webhook`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'verification_id' in params: + path_params['verification-ID'] = params['verification_id'] # noqa: E501 + + query_params = [] + if 'organizations' in params: + query_params.append(('organizations', params['organizations'])) # noqa: E501 + collection_formats['organizations'] = 'multi' # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['bearerAuth'] # noqa: E501 + + return self.api_client.call_api( + '/webhooks/verify/{verification-ID}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponseDefault102', # noqa: E501 + auth_settings=auth_settings, + async_req=params.get('async_req'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/billforward/api_client.py b/billforward/api_client.py index ddfaf2c..91a9916 100644 --- a/billforward/api_client.py +++ b/billforward/api_client.py @@ -1,65 +1,34 @@ # coding: utf-8 - """ -Copyright 2016 SmartBear Software - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at + Billforward API - http://www.apache.org/licenses/LICENSE-2.0 + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - ref: https://github.com/swagger-api/swagger-codegen + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git """ - from __future__ import absolute_import -from . import models -from .rest import RESTClientObject -from .rest import ApiException -import os -import re -import sys -import urllib +import datetime import json import mimetypes -import random +from multiprocessing.pool import ThreadPool +import os +import re import tempfile -import threading - -from datetime import datetime -from datetime import date # python 2 and python 3 compatibility library -from six import iteritems - -try: - # for python3 - from urllib.parse import quote -except ImportError: - # for python2 - from urllib import quote +import six +from six.moves.urllib.parse import quote -# special handling of `long` (python2 only) -try: - # Python 2 - long -except NameError: - # Python 3 - long = int - -from .configuration import Configuration +from billforward.configuration import Configuration +import billforward.models +from billforward import rest class ApiClient(object): - """ - Generic API client for Swagger client library builds. + """Generic API client for Swagger client library builds. Swagger generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of @@ -70,75 +39,100 @@ class ApiClient(object): Ref: https://github.com/swagger-api/swagger-codegen Do not edit the class manually. - :param host: The base path for the server to call. + :param configuration: .Configuration object for this client :param header_name: a header to pass when making calls to the API. - :param header_value: a header value to pass when making calls to the API. + :param header_value: a header value to pass when making calls to + the API. + :param cookie: a cookie to include in the header when making calls + to the API """ - def __init__(self, host=None, header_name=None, header_value=None, cookie=None): - """ - Constructor of the class. - """ - self.rest_client = RESTClientObject() + PRIMITIVE_TYPES = (float, bool, bytes, six.text_type) + six.integer_types + NATIVE_TYPES_MAPPING = { + 'int': int, + 'long': int if six.PY3 else long, # noqa: F821 + 'float': float, + 'str': str, + 'bool': bool, + 'date': datetime.date, + 'datetime': datetime.datetime, + 'object': object, + } + + def __init__(self, configuration=None, header_name=None, header_value=None, + cookie=None): + if configuration is None: + configuration = Configuration() + self.configuration = configuration + + self.pool = ThreadPool() + self.rest_client = rest.RESTClientObject(configuration) self.default_headers = {} if header_name is not None: self.default_headers[header_name] = header_value - if host is None: - self.host = Configuration().host - else: - self.host = host self.cookie = cookie # Set default User-Agent. self.user_agent = 'Swagger-Codegen/1.0.0/python' + def __del__(self): + self.pool.close() + self.pool.join() + @property def user_agent(self): - """ - Gets user agent. - """ + """User agent for this API client""" return self.default_headers['User-Agent'] @user_agent.setter def user_agent(self, value): - """ - Sets user agent. - """ self.default_headers['User-Agent'] = value def set_default_header(self, header_name, header_value): self.default_headers[header_name] = header_value - def __call_api(self, resource_path, method, - path_params=None, query_params=None, header_params=None, - body=None, post_params=None, files=None, - response_type=None, auth_settings=None, callback=None, _return_http_data_only=None): + def __call_api( + self, resource_path, method, path_params=None, + query_params=None, header_params=None, body=None, post_params=None, + files=None, response_type=None, auth_settings=None, + _return_http_data_only=None, collection_formats=None, + _preload_content=True, _request_timeout=None): - # headers parameters + config = self.configuration + + # header parameters header_params = header_params or {} header_params.update(self.default_headers) if self.cookie: header_params['Cookie'] = self.cookie if header_params: header_params = self.sanitize_for_serialization(header_params) + header_params = dict(self.parameters_to_tuples(header_params, + collection_formats)) # path parameters if path_params: path_params = self.sanitize_for_serialization(path_params) - for k, v in iteritems(path_params): - replacement = quote(str(self.to_path_value(v))) - resource_path = resource_path.\ - replace('{' + k + '}', replacement) + path_params = self.parameters_to_tuples(path_params, + collection_formats) + for k, v in path_params: + # specified safe chars, encode everything + resource_path = resource_path.replace( + '{%s}' % k, + quote(str(v), safe=config.safe_chars_for_path_param) + ) # query parameters if query_params: query_params = self.sanitize_for_serialization(query_params) - query_params = {k: self.to_path_value(v) - for k, v in iteritems(query_params)} + query_params = self.parameters_to_tuples(query_params, + collection_formats) # post parameters if post_params or files: post_params = self.prepare_post_parameters(post_params, files) post_params = self.sanitize_for_serialization(post_params) + post_params = self.parameters_to_tuples(post_params, + collection_formats) # auth setting self.update_params_for_auth(header_params, query_params, auth_settings) @@ -148,47 +142,33 @@ def __call_api(self, resource_path, method, body = self.sanitize_for_serialization(body) # request url - url = self.host + resource_path + url = self.configuration.host + resource_path # perform request and return response - response_data = self.request(method, url, - query_params=query_params, - headers=header_params, - post_params=post_params, body=body) + response_data = self.request( + method, url, query_params=query_params, headers=header_params, + post_params=post_params, body=body, + _preload_content=_preload_content, + _request_timeout=_request_timeout) self.last_response = response_data - # deserialize response data - if response_type: - deserialized_data = self.deserialize(response_data, response_type) - else: - deserialized_data = None - - if callback: - callback(deserialized_data) if _return_http_data_only else callback((deserialized_data, response_data.status, response_data.getheaders())) - elif _return_http_data_only: - return ( deserialized_data ); - else: - return (deserialized_data, response_data.status, response_data.getheaders()) - - - def to_path_value(self, obj): - """ - Takes value and turn it into a string suitable for inclusion in - the path, by url-encoding. - - :param obj: object or string value. + return_data = response_data + if _preload_content: + # deserialize response data + if response_type: + return_data = self.deserialize(response_data, response_type) + else: + return_data = None - :return string: quoted value. - """ - if type(obj) == list: - return ','.join(obj) + if _return_http_data_only: + return (return_data) else: - return str(obj) + return (return_data, response_data.status, + response_data.getheaders()) def sanitize_for_serialization(self, obj): - """ - Builds a JSON POST object. + """Builds a JSON POST object. If obj is None, return None. If obj is str, int, long, float, bool, return directly. @@ -201,47 +181,46 @@ def sanitize_for_serialization(self, obj): :param obj: The data to serialize. :return: The serialized form of data. """ - types = (str, int, long, float, bool, tuple) - if sys.version_info < (3, 0): - types = types + (unicode,) - if isinstance(obj, type(None)): + if obj is None: return None - elif isinstance(obj, types): + elif isinstance(obj, self.PRIMITIVE_TYPES): return obj elif isinstance(obj, list): return [self.sanitize_for_serialization(sub_obj) for sub_obj in obj] - elif isinstance(obj, (datetime, date)): + elif isinstance(obj, tuple): + return tuple(self.sanitize_for_serialization(sub_obj) + for sub_obj in obj) + elif isinstance(obj, (datetime.datetime, datetime.date)): return obj.isoformat() + + if isinstance(obj, dict): + obj_dict = obj else: - if isinstance(obj, dict): - obj_dict = obj - else: - # Convert model obj to dict except - # attributes `swagger_types`, `attribute_map` - # and attributes which value is not None. - # Convert attribute name to json key in - # model definition for request. - obj_dict = {obj.attribute_map[attr]: getattr(obj, attr) - for attr, _ in iteritems(obj.swagger_types) - if getattr(obj, attr) is not None} - - return {key: self.sanitize_for_serialization(val) - for key, val in iteritems(obj_dict)} + # Convert model obj to dict except + # attributes `swagger_types`, `attribute_map` + # and attributes which value is not None. + # Convert attribute name to json key in + # model definition for request. + obj_dict = {obj.attribute_map[attr]: getattr(obj, attr) + for attr, _ in six.iteritems(obj.swagger_types) + if getattr(obj, attr) is not None} + + return {key: self.sanitize_for_serialization(val) + for key, val in six.iteritems(obj_dict)} def deserialize(self, response, response_type): - """ - Deserializes response into an object. + """Deserializes response into an object. :param response: RESTResponse object to be deserialized. :param response_type: class literal for - deserialzied object, or string of class name. + deserialized object, or string of class name. :return: deserialized object. """ # handle file downloading # save response body into a tmp file and return the instance - if "file" == response_type: + if response_type == "file": return self.__deserialize_file(response) # fetch data from response object @@ -253,8 +232,7 @@ def deserialize(self, response, response_type): return self.__deserialize(data, response_type) def __deserialize(self, data, klass): - """ - Deserializes dict, list, str into an object. + """Deserializes dict, list, str into an object. :param data: dict, list or str. :param klass: class literal, or string of class name. @@ -266,31 +244,28 @@ def __deserialize(self, data, klass): if type(klass) == str: if klass.startswith('list['): - sub_kls = re.match('list\[(.*)\]', klass).group(1) + sub_kls = re.match(r'list\[(.*)\]', klass).group(1) return [self.__deserialize(sub_data, sub_kls) for sub_data in data] if klass.startswith('dict('): - sub_kls = re.match('dict\(([^,]*), (.*)\)', klass).group(2) + sub_kls = re.match(r'dict\(([^,]*), (.*)\)', klass).group(2) return {k: self.__deserialize(v, sub_kls) - for k, v in iteritems(data)} + for k, v in six.iteritems(data)} # convert str to class - # for native types - if klass in ['int', 'long', 'float', 'str', 'bool', - "date", 'datetime', "object"]: - klass = eval(klass) - # for model types + if klass in self.NATIVE_TYPES_MAPPING: + klass = self.NATIVE_TYPES_MAPPING[klass] else: - klass = eval('models.' + klass) + klass = getattr(billforward.models, klass) - if klass in [int, long, float, str, bool]: + if klass in self.PRIMITIVE_TYPES: return self.__deserialize_primitive(data, klass) elif klass == object: return self.__deserialize_object(data) - elif klass == date: + elif klass == datetime.date: return self.__deserialize_date(data) - elif klass == datetime: + elif klass == datetime.datetime: return self.__deserialize_datatime(data) else: return self.__deserialize_model(data, klass) @@ -298,10 +273,12 @@ def __deserialize(self, data, klass): def call_api(self, resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, - response_type=None, auth_settings=None, callback=None, _return_http_data_only=None): - """ - Makes the HTTP request (synchronous) and return the deserialized data. - To make an async request, define a function for callback. + response_type=None, auth_settings=None, async_req=None, + _return_http_data_only=None, collection_formats=None, + _preload_content=True, _request_timeout=None): + """Makes the HTTP request (synchronous) and returns deserialized data. + + To make an async request, set the async_req parameter. :param resource_path: Path to method endpoint. :param method: Method to call. @@ -316,84 +293,136 @@ def call_api(self, resource_path, method, :param response: Response data type. :param files dict: key -> filename, value -> filepath, for `multipart/form-data`. - :param callback function: Callback function for asynchronous request. - If provide this parameter, - the request will be called asynchronously. - :param _return_http_data_only: response data without head status code and headers + :param async_req bool: execute request asynchronously + :param _return_http_data_only: response data without head status code + and headers + :param collection_formats: dict of collection formats for path, query, + header, and post parameters. + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. :return: - If provide parameter callback, + If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. - If parameter callback is None, + If parameter async_req is False or missing, then the method will return the response directly. """ - if callback is None: + if not async_req: return self.__call_api(resource_path, method, path_params, query_params, header_params, body, post_params, files, - response_type, auth_settings, callback, _return_http_data_only) + response_type, auth_settings, + _return_http_data_only, collection_formats, + _preload_content, _request_timeout) else: - thread = threading.Thread(target=self.__call_api, - args=(resource_path, method, - path_params, query_params, - header_params, body, - post_params, files, - response_type, auth_settings, - callback,_return_http_data_only)) - thread.start() + thread = self.pool.apply_async(self.__call_api, (resource_path, + method, path_params, query_params, + header_params, body, + post_params, files, + response_type, auth_settings, + _return_http_data_only, + collection_formats, + _preload_content, _request_timeout)) return thread def request(self, method, url, query_params=None, headers=None, - post_params=None, body=None): - """ - Makes the HTTP request using RESTClient. - """ + post_params=None, body=None, _preload_content=True, + _request_timeout=None): + """Makes the HTTP request using RESTClient.""" if method == "GET": return self.rest_client.GET(url, query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, headers=headers) elif method == "HEAD": return self.rest_client.HEAD(url, query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, headers=headers) elif method == "OPTIONS": return self.rest_client.OPTIONS(url, query_params=query_params, headers=headers, post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, body=body) elif method == "POST": return self.rest_client.POST(url, query_params=query_params, headers=headers, post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, body=body) elif method == "PUT": return self.rest_client.PUT(url, query_params=query_params, headers=headers, post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, body=body) elif method == "PATCH": return self.rest_client.PATCH(url, query_params=query_params, headers=headers, post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, body=body) elif method == "DELETE": return self.rest_client.DELETE(url, query_params=query_params, headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, body=body) else: raise ValueError( - "http method must be `GET`, `HEAD`," + "http method must be `GET`, `HEAD`, `OPTIONS`," " `POST`, `PATCH`, `PUT` or `DELETE`." ) + def parameters_to_tuples(self, params, collection_formats): + """Get parameters as list of tuples, formatting collections. + + :param params: Parameters as dict or list of two-tuples + :param dict collection_formats: Parameter collection formats + :return: Parameters as list of tuples, collections formatted + """ + new_params = [] + if collection_formats is None: + collection_formats = {} + for k, v in six.iteritems(params) if isinstance(params, dict) else params: # noqa: E501 + if k in collection_formats: + collection_format = collection_formats[k] + if collection_format == 'multi': + new_params.extend((k, value) for value in v) + else: + if collection_format == 'ssv': + delimiter = ' ' + elif collection_format == 'tsv': + delimiter = '\t' + elif collection_format == 'pipes': + delimiter = '|' + else: # csv is the default + delimiter = ',' + new_params.append( + (k, delimiter.join(str(value) for value in v))) + else: + new_params.append((k, v)) + return new_params + def prepare_post_parameters(self, post_params=None, files=None): - """ - Builds form parameters. + """Builds form parameters. :param post_params: Normal form parameters. :param files: File parameters. @@ -405,7 +434,7 @@ def prepare_post_parameters(self, post_params=None, files=None): params = post_params if files: - for k, v in iteritems(files): + for k, v in six.iteritems(files): if not v: continue file_names = v if type(v) is list else [v] @@ -413,15 +442,15 @@ def prepare_post_parameters(self, post_params=None, files=None): with open(n, 'rb') as f: filename = os.path.basename(f.name) filedata = f.read() - mimetype = mimetypes.\ - guess_type(filename)[0] or 'application/octet-stream' - params.append(tuple([k, tuple([filename, filedata, mimetype])])) + mimetype = (mimetypes.guess_type(filename)[0] or + 'application/octet-stream') + params.append( + tuple([k, tuple([filename, filedata, mimetype])])) return params def select_header_accept(self, accepts): - """ - Returns `Accept` based on an array of accepts provided. + """Returns `Accept` based on an array of accepts provided. :param accepts: List of headers. :return: Accept (e.g. application/json). @@ -429,7 +458,7 @@ def select_header_accept(self, accepts): if not accepts: return - accepts = list(map(lambda x: x.lower(), accepts)) + accepts = [x.lower() for x in accepts] if 'application/json' in accepts: return 'application/json' @@ -437,8 +466,7 @@ def select_header_accept(self, accepts): return ', '.join(accepts) def select_header_content_type(self, content_types): - """ - Returns `Content-Type` based on an array of content_types provided. + """Returns `Content-Type` based on an array of content_types provided. :param content_types: List of content-types. :return: Content-Type (e.g. application/json). @@ -446,69 +474,67 @@ def select_header_content_type(self, content_types): if not content_types: return 'application/json' - content_types = list(map(lambda x: x.lower(), content_types)) + content_types = [x.lower() for x in content_types] - if 'application/json' in content_types: + if 'application/json' in content_types or '*/*' in content_types: return 'application/json' else: return content_types[0] def update_params_for_auth(self, headers, querys, auth_settings): - """ - Updates header and query params based on authentication setting. + """Updates header and query params based on authentication setting. :param headers: Header parameters dict to be updated. - :param querys: Query parameters dict to be updated. + :param querys: Query parameters tuple list to be updated. :param auth_settings: Authentication setting identifiers list. """ - config = Configuration() - if not auth_settings: return for auth in auth_settings: - auth_setting = config.auth_settings().get(auth) + auth_setting = self.configuration.auth_settings().get(auth) if auth_setting: if not auth_setting['value']: continue elif auth_setting['in'] == 'header': headers[auth_setting['key']] = auth_setting['value'] elif auth_setting['in'] == 'query': - querys[auth_setting['key']] = auth_setting['value'] + querys.append((auth_setting['key'], auth_setting['value'])) else: raise ValueError( 'Authentication token must be in `query` or `header`' ) def __deserialize_file(self, response): - """ + """Deserializes body to file + Saves response body into a file in a temporary folder, using the filename from the `Content-Disposition` header if provided. :param response: RESTResponse. :return: file path. """ - config = Configuration() - - fd, path = tempfile.mkstemp(dir=config.temp_folder_path) + fd, path = tempfile.mkstemp(dir=self.configuration.temp_folder_path) os.close(fd) os.remove(path) content_disposition = response.getheader("Content-Disposition") if content_disposition: - filename = re.\ - search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', content_disposition).\ - group(1) + filename = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', + content_disposition).group(1) path = os.path.join(os.path.dirname(path), filename) - - with open(path, "w") as f: - f.write(response.data) - + response_data = response.data + with open(path, "wb") as f: + if isinstance(response_data, str): + # change str to bytes so we can write it + response_data = response_data.encode('utf-8') + f.write(response_data) + else: + f.write(response_data) return path def __deserialize_primitive(self, data, klass): - """ - Deserializes string to primitive type. + """Deserializes string to primitive type. :param data: str. :param klass: class literal. @@ -516,24 +542,21 @@ def __deserialize_primitive(self, data, klass): :return: int, long, float, str, bool. """ try: - value = klass(data) + return klass(data) except UnicodeEncodeError: - value = unicode(data) + return six.text_type(data) except TypeError: - value = data - return value + return data def __deserialize_object(self, value): - """ - Return a original value. + """Return a original value. :return: object. """ return value def __deserialize_date(self, string): - """ - Deserializes string to date. + """Deserializes string to date. :param string: str. :return: date. @@ -544,15 +567,13 @@ def __deserialize_date(self, string): except ImportError: return string except ValueError: - raise ApiException( + raise rest.ApiException( status=0, - reason="Failed to parse `{0}` into a date object" - .format(string) + reason="Failed to parse `{0}` as date object".format(string) ) def __deserialize_datatime(self, string): - """ - Deserializes string to datetime. + """Deserializes string to datetime. The string should be in iso8601 datetime format. @@ -565,27 +586,47 @@ def __deserialize_datatime(self, string): except ImportError: return string except ValueError: - raise ApiException( + raise rest.ApiException( status=0, - reason="Failed to parse `{0}` into a datetime object". - format(string) + reason=( + "Failed to parse `{0}` as datetime object" + .format(string) + ) ) + def __hasattr(self, object, name): + return name in object.__class__.__dict__ + def __deserialize_model(self, data, klass): - """ - Deserializes list or dict to model. + """Deserializes list or dict to model. :param data: dict, list. :param klass: class literal. :return: model object. """ - instance = klass() - - for attr, attr_type in iteritems(instance.swagger_types): - if data is not None \ - and instance.attribute_map[attr] in data\ - and isinstance(data, (list, dict)): - value = data[instance.attribute_map[attr]] - setattr(instance, attr, self.__deserialize(value, attr_type)) + if not klass.swagger_types and not self.__hasattr(klass, 'get_real_child_model'): + return data + + kwargs = {} + if klass.swagger_types is not None: + for attr, attr_type in six.iteritems(klass.swagger_types): + if (data is not None and + klass.attribute_map[attr] in data and + isinstance(data, (list, dict))): + value = data[klass.attribute_map[attr]] + kwargs[attr] = self.__deserialize(value, attr_type) + + instance = klass(**kwargs) + + if (isinstance(instance, dict) and + klass.swagger_types is not None and + isinstance(data, dict)): + for key, value in data.items(): + if key not in klass.swagger_types: + instance[key] = value + if self.__hasattr(instance, 'get_real_child_model'): + klass_name = instance.get_real_child_model(data) + if klass_name: + instance = self.__deserialize(data, klass_name) return instance diff --git a/billforward/apis/__init__.py b/billforward/apis/__init__.py deleted file mode 100644 index c823163..0000000 --- a/billforward/apis/__init__.py +++ /dev/null @@ -1,66 +0,0 @@ -from __future__ import absolute_import - -# import apis into api package -from .accounts_api import AccountsApi -from .addresses_api import AddressesApi -from .amendments_api import AmendmentsApi -from .analytics_api import AnalyticsApi -from .auditlogs_api import AuditlogsApi -from .charges_api import ChargesApi -from .clients_api import ClientsApi -from .configurations_api import ConfigurationsApi -from .couponbook_api import CouponbookApi -from .couponbookdefinition_api import CouponbookdefinitionApi -from .coupondefinition_api import CoupondefinitionApi -from .couponinstance_api import CouponinstanceApi -from .couponmodifier_api import CouponmodifierApi -from .couponrule_api import CouponruleApi -from .coupons_api import CouponsApi -from .creditnotes_api import CreditnotesApi -from .cybersourcetokens_api import CybersourcetokensApi -from .dunninglines_api import DunninglinesApi -from .emailproviders_api import EmailprovidersApi -from .emails_api import EmailsApi -from .emailsubscriptions_api import EmailsubscriptionsApi -from .fixedtermdefinitions_api import FixedtermdefinitionsApi -from .fixedterms_api import FixedtermsApi -from .invoices_api import InvoicesApi -from .metadata_api import MetadataApi -from .notifications_api import NotificationsApi -from .organizations_api import OrganizationsApi -from .passwords_api import PasswordsApi -from .paymentmethods_api import PaymentmethodsApi -from .paymentmethodsubscriptionlinks_api import PaymentmethodsubscriptionlinksApi -from .payments_api import PaymentsApi -from .periods_api import PeriodsApi -from .permissions_api import PermissionsApi -from .pricingcalculator_api import PricingcalculatorApi -from .pricingcomponents_api import PricingcomponentsApi -from .pricingcomponenttiers_api import PricingcomponenttiersApi -from .pricingcomponentvaluechanges_api import PricingcomponentvaluechangesApi -from .pricingcomponentvalues_api import PricingcomponentvaluesApi -from .productrateplans_api import ProductrateplansApi -from .products_api import ProductsApi -from .profiles_api import ProfilesApi -from .quotes_api import QuotesApi -from .receipts_api import ReceiptsApi -from .refunds_api import RefundsApi -from .roles_api import RolesApi -from .search_api import SearchApi -from .subscriptions_api import SubscriptionsApi -from .synch_app_configs_api import SynchAppConfigsApi -from .synch_configs_api import SynchConfigsApi -from .synch_jobs_api import SynchJobsApi -from .taxationlinks_api import TaxationlinksApi -from .taxationstrategies_api import TaxationstrategiesApi -from .time_api import TimeApi -from .tokenization_api import TokenizationApi -from .unitofmeasure_api import UnitofmeasureApi -from .usage_api import UsageApi -from .usageperiods_api import UsageperiodsApi -from .usageroundingstrategies_api import UsageroundingstrategiesApi -from .usagesessions_api import UsagesessionsApi -from .usernames_api import UsernamesApi -from .users_api import UsersApi -from .vaultedgateways_api import VaultedgatewaysApi -from .webhooks_api import WebhooksApi diff --git a/billforward/apis/accounts_api.py b/billforward/apis/accounts_api.py deleted file mode 100644 index f465833..0000000 --- a/billforward/apis/accounts_api.py +++ /dev/null @@ -1,2174 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class AccountsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def add_credit_note_to_account(self, account_id, credit_note, **kwargs): - """ - Creates a credit-note which may be used by any subscription of this account. - {\"nickname\":\"Add Credit\",\"request\":\"addCreditNoteToAccountRequest.html\", \"response\":\"addCreditNoteToAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_credit_note_to_account(account_id, credit_note, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: ID of the account. (required) - :param CreditAccountRequest credit_note: The credit-note request (required) - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.add_credit_note_to_account_with_http_info(account_id, credit_note, **kwargs) - else: - (data) = self.add_credit_note_to_account_with_http_info(account_id, credit_note, **kwargs) - return data - - def add_credit_note_to_account_with_http_info(self, account_id, credit_note, **kwargs): - """ - Creates a credit-note which may be used by any subscription of this account. - {\"nickname\":\"Add Credit\",\"request\":\"addCreditNoteToAccountRequest.html\", \"response\":\"addCreditNoteToAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_credit_note_to_account_with_http_info(account_id, credit_note, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: ID of the account. (required) - :param CreditAccountRequest credit_note: The credit-note request (required) - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'credit_note'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method add_credit_note_to_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `add_credit_note_to_account`") - # verify the required parameter 'credit_note' is set - if ('credit_note' not in params) or (params['credit_note'] is None): - raise ValueError("Missing the required parameter `credit_note` when calling `add_credit_note_to_account`") - - resource_path = '/accounts/{account-ID}/credit'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'credit_note' in params: - body_params = params['credit_note'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CreditNotePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def add_permission_to_account(self, account_id, role, **kwargs): - """ - Add a role to the account - {\"nickname\":\"Add Role\",\"response\":\"addRoleToAccountResponse.html\",\"request\":\"addRoleToAccountRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_permission_to_account(account_id, role, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: ID of the account. (required) - :param str role: ID or name of the role. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.add_permission_to_account_with_http_info(account_id, role, **kwargs) - else: - (data) = self.add_permission_to_account_with_http_info(account_id, role, **kwargs) - return data - - def add_permission_to_account_with_http_info(self, account_id, role, **kwargs): - """ - Add a role to the account - {\"nickname\":\"Add Role\",\"response\":\"addRoleToAccountResponse.html\",\"request\":\"addRoleToAccountRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_permission_to_account_with_http_info(account_id, role, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: ID of the account. (required) - :param str role: ID or name of the role. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'role', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method add_permission_to_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `add_permission_to_account`") - # verify the required parameter 'role' is set - if ('role' not in params) or (params['role'] is None): - raise ValueError("Missing the required parameter `role` when calling `add_permission_to_account`") - - resource_path = '/accounts/{account-ID}/roles/{role}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - if 'role' in params: - path_params['role'] = params['role'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RolePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def create_account(self, request, **kwargs): - """ - Create an Account. - {\"nickname\":\"Create a new account\",\"response\":\"createAccountResponse.html\",\"request\":\"createAccountRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_account(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreateAccountRequest request: The account object to be created. (required) - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_account_with_http_info(request, **kwargs) - else: - (data) = self.create_account_with_http_info(request, **kwargs) - return data - - def create_account_with_http_info(self, request, **kwargs): - """ - Create an Account. - {\"nickname\":\"Create a new account\",\"response\":\"createAccountResponse.html\",\"request\":\"createAccountRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_account_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreateAccountRequest request: The account object to be created. (required) - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `create_account`") - - resource_path = '/accounts'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccountPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete_account(self, account_id, delete_gateway_data, organizations, **kwargs): - """ - Delete the account specified by the account-ID parameter. - {\"nickname\":\"Retire\",\"response\":\"deleteAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_account(account_id, delete_gateway_data, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param str delete_gateway_data: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_account_with_http_info(account_id, delete_gateway_data, organizations, **kwargs) - else: - (data) = self.delete_account_with_http_info(account_id, delete_gateway_data, organizations, **kwargs) - return data - - def delete_account_with_http_info(self, account_id, delete_gateway_data, organizations, **kwargs): - """ - Delete the account specified by the account-ID parameter. - {\"nickname\":\"Retire\",\"response\":\"deleteAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_account_with_http_info(account_id, delete_gateway_data, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param str delete_gateway_data: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'delete_gateway_data', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `delete_account`") - # verify the required parameter 'delete_gateway_data' is set - if ('delete_gateway_data' not in params) or (params['delete_gateway_data'] is None): - raise ValueError("Missing the required parameter `delete_gateway_data` when calling `delete_account`") - # verify the required parameter 'organizations' is set - if ('organizations' not in params) or (params['organizations'] is None): - raise ValueError("Missing the required parameter `organizations` when calling `delete_account`") - - resource_path = '/accounts/{account-ID}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'delete_gateway_data' in params: - query_params['delete_gateway_data'] = params['delete_gateway_data'] - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccountPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete_metadata_for_account(self, account_id, **kwargs): - """ - Remove any associated metadata. - {\"nickname\":\"Clear metadata from account\",\"request\" :\"deleteAccountMetadataRequest.html\",\"response\":\"deleteAccountMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_metadata_for_account(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_metadata_for_account_with_http_info(account_id, **kwargs) - else: - (data) = self.delete_metadata_for_account_with_http_info(account_id, **kwargs) - return data - - def delete_metadata_for_account_with_http_info(self, account_id, **kwargs): - """ - Remove any associated metadata. - {\"nickname\":\"Clear metadata from account\",\"request\" :\"deleteAccountMetadataRequest.html\",\"response\":\"deleteAccountMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_metadata_for_account_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_metadata_for_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `delete_metadata_for_account`") - - resource_path = '/accounts/{account-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_account_by_id(self, account_id, **kwargs): - """ - Returns a single account, specified by the account-ID parameter. - {\"nickname\":\"Retrieve an existing account\",\"response\":\"getAccountByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_account_by_id(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param list[str] organizations: - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_account_by_id_with_http_info(account_id, **kwargs) - else: - (data) = self.get_account_by_id_with_http_info(account_id, **kwargs) - return data - - def get_account_by_id_with_http_info(self, account_id, **kwargs): - """ - Returns a single account, specified by the account-ID parameter. - {\"nickname\":\"Retrieve an existing account\",\"response\":\"getAccountByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_account_by_id_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param list[str] organizations: - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_account_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_account_by_id`") - - resource_path = '/accounts/{account-ID}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccountPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_accounts_by_created(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of account objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by creation\",\"response\":\"getAccountByCreated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_accounts_by_created(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_accounts_by_created_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_accounts_by_created_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_accounts_by_created_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of account objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by creation\",\"response\":\"getAccountByCreated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_accounts_by_created_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_accounts_by_created" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_accounts_by_created`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_accounts_by_created`") - - resource_path = '/accounts/created/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/plain', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccountPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_accounts_by_updated(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of account objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by updated\",\"response\":\"getAccountByUpdated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_accounts_by_updated(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_accounts_by_updated_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_accounts_by_updated_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_accounts_by_updated_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of account objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by updated\",\"response\":\"getAccountByUpdated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_accounts_by_updated_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_accounts_by_updated" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_accounts_by_updated`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_accounts_by_updated`") - - resource_path = '/accounts/updated/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/plain', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccountPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_accounts_by_user_id(self, user_id, **kwargs): - """ - Returns a collection of accounts, specified by the user-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by user\",\"response\":\"getAccountByUserID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_accounts_by_user_id(user_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str user_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first account to return. - :param int records: The maximum number of accounts to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_accounts_by_user_id_with_http_info(user_id, **kwargs) - else: - (data) = self.get_accounts_by_user_id_with_http_info(user_id, **kwargs) - return data - - def get_accounts_by_user_id_with_http_info(self, user_id, **kwargs): - """ - Returns a collection of accounts, specified by the user-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by user\",\"response\":\"getAccountByUserID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_accounts_by_user_id_with_http_info(user_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str user_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first account to return. - :param int records: The maximum number of accounts to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['user_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_accounts_by_user_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'user_id' is set - if ('user_id' not in params) or (params['user_id'] is None): - raise ValueError("Missing the required parameter `user_id` when calling `get_accounts_by_user_id`") - - resource_path = '/accounts/user/{user-ID}'.replace('{format}', 'json') - path_params = {} - if 'user_id' in params: - path_params['user-ID'] = params['user_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccountPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_accounts(self, **kwargs): - """ - Returns a collection of all account objects. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all accounts\",\"response\":\"getAccountAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_accounts(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] id: A list of account IDs used to filter the output. - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool users_only: Whether only accounts have a user should be returned. - :param str metadata: - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_accounts_with_http_info(**kwargs) - else: - (data) = self.get_all_accounts_with_http_info(**kwargs) - return data - - def get_all_accounts_with_http_info(self, **kwargs): - """ - Returns a collection of all account objects. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all accounts\",\"response\":\"getAccountAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_accounts_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] id: A list of account IDs used to filter the output. - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool users_only: Whether only accounts have a user should be returned. - :param str metadata: - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'users_only', 'metadata'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_accounts" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/accounts'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'id' in params: - query_params['id'] = params['id'] - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'users_only' in params: - query_params['users_only'] = params['users_only'] - if 'metadata' in params: - query_params['metadata'] = params['metadata'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/plain', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccountPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_available_credit_on_account(self, account_id, **kwargs): - """ - Returns all available credit-notes for the specified account. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get available credit\",\"response\":\"getAvailableCreditAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_credit_on_account(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The ID of the account (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_available_credit_on_account_with_http_info(account_id, **kwargs) - else: - (data) = self.get_available_credit_on_account_with_http_info(account_id, **kwargs) - return data - - def get_available_credit_on_account_with_http_info(self, account_id, **kwargs): - """ - Returns all available credit-notes for the specified account. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get available credit\",\"response\":\"getAvailableCreditAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_credit_on_account_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The ID of the account (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_available_credit_on_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_available_credit_on_account`") - - resource_path = '/accounts/{account-ID}/credit'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CreditNotePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_metadata_for_account(self, account_id, **kwargs): - """ - Retrieve any associated metadata. - {\"nickname\":\"Retrieve metadata on account\",\"request\":\"getAccountMetadataRequest.html\",\"response\":\"getAccountMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_metadata_for_account(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_metadata_for_account_with_http_info(account_id, **kwargs) - else: - (data) = self.get_metadata_for_account_with_http_info(account_id, **kwargs) - return data - - def get_metadata_for_account_with_http_info(self, account_id, **kwargs): - """ - Retrieve any associated metadata. - {\"nickname\":\"Retrieve metadata on account\",\"request\":\"getAccountMetadataRequest.html\",\"response\":\"getAccountMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_metadata_for_account_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_metadata_for_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_metadata_for_account`") - - resource_path = '/accounts/{account-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_permissions_on_account(self, account_id, **kwargs): - """ - Retrieves a collection of roles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"List roles on account\",\"response\":\"getRoleByAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_permissions_on_account(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_permissions_on_account_with_http_info(account_id, **kwargs) - else: - (data) = self.get_permissions_on_account_with_http_info(account_id, **kwargs) - return data - - def get_permissions_on_account_with_http_info(self, account_id, **kwargs): - """ - Retrieves a collection of roles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"List roles on account\",\"response\":\"getRoleByAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_permissions_on_account_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_permissions_on_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_permissions_on_account`") - - resource_path = '/accounts/{account-ID}/roles'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RolePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def remove_credit_from_account(self, account_id, value, **kwargs): - """ - Decrease the amount of credit by the value specified or entirely if no value provided. - {\"nickname\":\"Remove Credit\",\"response\":\"removeCreditForAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_credit_from_account(account_id, value, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param str value:

Either a credit note ID or a currency value.

If a credit note ID is provided any remaining credit will be removed from this credit note.

If a currency value is provided the format should be in the form of valueCurrency, where value is the value to remove. The currency should be an ISO 4217 Currency Code. For example setting the value as 10USD will reduce the credit on this account by $10 or 9.86USD would reduce the credit by $9.86. Note: the value will be reduced from any credit notes with available balance.

(required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.remove_credit_from_account_with_http_info(account_id, value, **kwargs) - else: - (data) = self.remove_credit_from_account_with_http_info(account_id, value, **kwargs) - return data - - def remove_credit_from_account_with_http_info(self, account_id, value, **kwargs): - """ - Decrease the amount of credit by the value specified or entirely if no value provided. - {\"nickname\":\"Remove Credit\",\"response\":\"removeCreditForAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_credit_from_account_with_http_info(account_id, value, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param str value:

Either a credit note ID or a currency value.

If a credit note ID is provided any remaining credit will be removed from this credit note.

If a currency value is provided the format should be in the form of valueCurrency, where value is the value to remove. The currency should be an ISO 4217 Currency Code. For example setting the value as 10USD will reduce the credit on this account by $10 or 9.86USD would reduce the credit by $9.86. Note: the value will be reduced from any credit notes with available balance.

(required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'value', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method remove_credit_from_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `remove_credit_from_account`") - # verify the required parameter 'value' is set - if ('value' not in params) or (params['value'] is None): - raise ValueError("Missing the required parameter `value` when calling `remove_credit_from_account`") - - resource_path = '/accounts/{account-ID}/credit/{value}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - if 'value' in params: - path_params['value'] = params['value'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CreditNotePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def remove_permission_from_account(self, account_id, role, **kwargs): - """ - Revoke the specified role. - {\"nickname\":\"Remove Role\",\"response\":\"removeRoleFromAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_permission_from_account(account_id, role, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param str role: ID or name of the role. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.remove_permission_from_account_with_http_info(account_id, role, **kwargs) - else: - (data) = self.remove_permission_from_account_with_http_info(account_id, role, **kwargs) - return data - - def remove_permission_from_account_with_http_info(self, account_id, role, **kwargs): - """ - Revoke the specified role. - {\"nickname\":\"Remove Role\",\"response\":\"removeRoleFromAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_permission_from_account_with_http_info(account_id, role, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param str role: ID or name of the role. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'role', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method remove_permission_from_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `remove_permission_from_account`") - # verify the required parameter 'role' is set - if ('role' not in params) or (params['role'] is None): - raise ValueError("Missing the required parameter `role` when calling `remove_permission_from_account`") - - resource_path = '/accounts/{account-ID}/roles/{role}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - if 'role' in params: - path_params['role'] = params['role'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RolePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def set_metadata_for_account(self, metadata, account_id, **kwargs): - """ - Remove any existing metadata keys and create the provided data. - {\"nickname\":\"Set metadata on account\",\"request\":\"setAccountMetadataRequest.html\",\"response\":\"setAccountMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_metadata_for_account(metadata, account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.set_metadata_for_account_with_http_info(metadata, account_id, **kwargs) - else: - (data) = self.set_metadata_for_account_with_http_info(metadata, account_id, **kwargs) - return data - - def set_metadata_for_account_with_http_info(self, metadata, account_id, **kwargs): - """ - Remove any existing metadata keys and create the provided data. - {\"nickname\":\"Set metadata on account\",\"request\":\"setAccountMetadataRequest.html\",\"response\":\"setAccountMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_metadata_for_account_with_http_info(metadata, account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['metadata', 'account_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method set_metadata_for_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'metadata' is set - if ('metadata' not in params) or (params['metadata'] is None): - raise ValueError("Missing the required parameter `metadata` when calling `set_metadata_for_account`") - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `set_metadata_for_account`") - - resource_path = '/accounts/{account-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'metadata' in params: - body_params = params['metadata'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_account(self, account, **kwargs): - """ - Update an Account. - {\"nickname\":\"Update an account\",\"response\":\"updateAccountResponse.html\",\"request\":\"updateAccountRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_account(account, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Account account: The account object to be created. (required) - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_account_with_http_info(account, **kwargs) - else: - (data) = self.update_account_with_http_info(account, **kwargs) - return data - - def update_account_with_http_info(self, account, **kwargs): - """ - Update an Account. - {\"nickname\":\"Update an account\",\"response\":\"updateAccountResponse.html\",\"request\":\"updateAccountRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_account_with_http_info(account, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Account account: The account object to be created. (required) - :return: AccountPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account' is set - if ('account' not in params) or (params['account'] is None): - raise ValueError("Missing the required parameter `account` when calling `update_account`") - - resource_path = '/accounts'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'account' in params: - body_params = params['account'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccountPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def upsert_metadata_for_account(self, metadata, account_id, **kwargs): - """ - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - {\"nickname\":\"Upsert metadata on account\",\"request\":\"upsertAccountMetadataRequest.html\",\"response\":\"upsertAccountMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upsert_metadata_for_account(metadata, account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.upsert_metadata_for_account_with_http_info(metadata, account_id, **kwargs) - else: - (data) = self.upsert_metadata_for_account_with_http_info(metadata, account_id, **kwargs) - return data - - def upsert_metadata_for_account_with_http_info(self, metadata, account_id, **kwargs): - """ - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - {\"nickname\":\"Upsert metadata on account\",\"request\":\"upsertAccountMetadataRequest.html\",\"response\":\"upsertAccountMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upsert_metadata_for_account_with_http_info(metadata, account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['metadata', 'account_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method upsert_metadata_for_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'metadata' is set - if ('metadata' not in params) or (params['metadata'] is None): - raise ValueError("Missing the required parameter `metadata` when calling `upsert_metadata_for_account`") - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `upsert_metadata_for_account`") - - resource_path = '/accounts/{account-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'metadata' in params: - body_params = params['metadata'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/addresses_api.py b/billforward/apis/addresses_api.py deleted file mode 100644 index aef9919..0000000 --- a/billforward/apis/addresses_api.py +++ /dev/null @@ -1,259 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class AddressesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_address(self, request, **kwargs): - """ - Create - {\"nickname\":\"Create a new address\",\"response\":\"createAddressResponse.html\",\"request\":\"createAddressRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_address(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreateAddressRequest request: The address object to be created. (required) - :return: AddressPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_address_with_http_info(request, **kwargs) - else: - (data) = self.create_address_with_http_info(request, **kwargs) - return data - - def create_address_with_http_info(self, request, **kwargs): - """ - Create - {\"nickname\":\"Create a new address\",\"response\":\"createAddressResponse.html\",\"request\":\"createAddressRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_address_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreateAddressRequest request: The address object to be created. (required) - :return: AddressPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_address" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `create_address`") - - resource_path = '/addresses'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AddressPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_address(self, request, **kwargs): - """ - Update - {\"nickname\":\"Update an address\",\"response\":\"updateAddressResponse.html\",\"request\":\"updateAddressRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_address(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UpdateAddressRequest request: The address object to be created. (required) - :return: AddressPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_address_with_http_info(request, **kwargs) - else: - (data) = self.update_address_with_http_info(request, **kwargs) - return data - - def update_address_with_http_info(self, request, **kwargs): - """ - Update - {\"nickname\":\"Update an address\",\"response\":\"updateAddressResponse.html\",\"request\":\"updateAddressRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_address_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UpdateAddressRequest request: The address object to be created. (required) - :return: AddressPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_address" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `update_address`") - - resource_path = '/addresses'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AddressPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/amendments_api.py b/billforward/apis/amendments_api.py deleted file mode 100644 index 1416087..0000000 --- a/billforward/apis/amendments_api.py +++ /dev/null @@ -1,1372 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class AmendmentsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_amendment(self, amendment, **kwargs): - """ - Create an amendment. - {\"nickname\":\"Create a new amendment\",\"request\":\"createAmendmentRequest.html\",\"response\":\"createAmendmentResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_amendment(amendment, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Amendment amendment: The amendment object to be created. (required) - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_amendment_with_http_info(amendment, **kwargs) - else: - (data) = self.create_amendment_with_http_info(amendment, **kwargs) - return data - - def create_amendment_with_http_info(self, amendment, **kwargs): - """ - Create an amendment. - {\"nickname\":\"Create a new amendment\",\"request\":\"createAmendmentRequest.html\",\"response\":\"createAmendmentResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_amendment_with_http_info(amendment, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Amendment amendment: The amendment object to be created. (required) - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['amendment'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_amendment" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'amendment' is set - if ('amendment' not in params) or (params['amendment'] is None): - raise ValueError("Missing the required parameter `amendment` when calling `create_amendment`") - - resource_path = '/amendments'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'amendment' in params: - body_params = params['amendment'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AmendmentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_amendments(self, **kwargs): - """ - Returns a collection of all amendments. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all amendments\",\"response\":\"getAmendmentAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_amendments(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param str invoice_id: Ihe invoice ID associated with the amendment. - :param str state: Ihe state of the amendment. - :param str type: Ihe type of amendment. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_amendments_with_http_info(**kwargs) - else: - (data) = self.get_all_amendments_with_http_info(**kwargs) - return data - - def get_all_amendments_with_http_info(self, **kwargs): - """ - Returns a collection of all amendments. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all amendments\",\"response\":\"getAmendmentAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_amendments_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param str invoice_id: Ihe invoice ID associated with the amendment. - :param str state: Ihe state of the amendment. - :param str type: Ihe type of amendment. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'invoice_id', 'state', 'type'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_amendments" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/amendments'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'invoice_id' in params: - query_params['invoice_id'] = params['invoice_id'] - if 'state' in params: - query_params['state'] = params['state'] - if 'type' in params: - query_params['type'] = params['type'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AmendmentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_amendment_by_id(self, amendment_id, **kwargs): - """ - Returns a single amendment, specified by the amendment-ID parameter. - {\"nickname\":\"Retrieve an existing amendment\",\"response\":\"getAmendmentByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendment_by_id(amendment_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str amendment_id: The unique string-ID of the amendment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_amendment_by_id_with_http_info(amendment_id, **kwargs) - else: - (data) = self.get_amendment_by_id_with_http_info(amendment_id, **kwargs) - return data - - def get_amendment_by_id_with_http_info(self, amendment_id, **kwargs): - """ - Returns a single amendment, specified by the amendment-ID parameter. - {\"nickname\":\"Retrieve an existing amendment\",\"response\":\"getAmendmentByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendment_by_id_with_http_info(amendment_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str amendment_id: The unique string-ID of the amendment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['amendment_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_amendment_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'amendment_id' is set - if ('amendment_id' not in params) or (params['amendment_id'] is None): - raise ValueError("Missing the required parameter `amendment_id` when calling `get_amendment_by_id`") - - resource_path = '/amendments/{amendment-ID}'.replace('{format}', 'json') - path_params = {} - if 'amendment_id' in params: - path_params['amendment-ID'] = params['amendment_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AmendmentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_amendment_by_state(self, state, **kwargs): - """ - Returns a collection of amendments, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by state\",\"response\":\"getAmendmentsByState.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendment_by_state(state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the amendment, either pending, succeeded, failed or discarded (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_amendment_by_state_with_http_info(state, **kwargs) - else: - (data) = self.get_amendment_by_state_with_http_info(state, **kwargs) - return data - - def get_amendment_by_state_with_http_info(self, state, **kwargs): - """ - Returns a collection of amendments, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by state\",\"response\":\"getAmendmentsByState.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendment_by_state_with_http_info(state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the amendment, either pending, succeeded, failed or discarded (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['state', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_amendment_by_state" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'state' is set - if ('state' not in params) or (params['state'] is None): - raise ValueError("Missing the required parameter `state` when calling `get_amendment_by_state`") - - resource_path = '/amendments/state/{state}'.replace('{format}', 'json') - path_params = {} - if 'state' in params: - path_params['state'] = params['state'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AmendmentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_amendment_by_subscription_id(self, subscription_id, **kwargs): - """ - Returns a collection of amendments, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by subscription\",\"response\":\"getAmendmentsBySubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendment_by_subscription_id(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_amendment_by_subscription_id_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_amendment_by_subscription_id_with_http_info(subscription_id, **kwargs) - return data - - def get_amendment_by_subscription_id_with_http_info(self, subscription_id, **kwargs): - """ - Returns a collection of amendments, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by subscription\",\"response\":\"getAmendmentsBySubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendment_by_subscription_id_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_amendment_by_subscription_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_amendment_by_subscription_id`") - - resource_path = '/amendments/subscription/{subscription-ID}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AmendmentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_amendment_swagger(self, query_string, **kwargs): - """ - - {\"nickname\":\"\",\"response\":\"\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendment_swagger(query_string, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str query_string: The query string used to search. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The starting index of the search results. - :param int records: The number of search results to return. - :param bool wildcard: Toggle if we search for full words or whether a wildcard is used. - :param bool entity: Is an entity returned with the search results. - :return: SwaggerTypeList - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_amendment_swagger_with_http_info(query_string, **kwargs) - else: - (data) = self.get_amendment_swagger_with_http_info(query_string, **kwargs) - return data - - def get_amendment_swagger_with_http_info(self, query_string, **kwargs): - """ - - {\"nickname\":\"\",\"response\":\"\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendment_swagger_with_http_info(query_string, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str query_string: The query string used to search. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The starting index of the search results. - :param int records: The number of search results to return. - :param bool wildcard: Toggle if we search for full words or whether a wildcard is used. - :param bool entity: Is an entity returned with the search results. - :return: SwaggerTypeList - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['query_string', 'organizations', 'offset', 'records', 'wildcard', 'entity'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_amendment_swagger" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'query_string' is set - if ('query_string' not in params) or (params['query_string'] is None): - raise ValueError("Missing the required parameter `query_string` when calling `get_amendment_swagger`") - - resource_path = '/amendments/swagger-end-point/{query-string}'.replace('{format}', 'json') - path_params = {} - if 'query_string' in params: - path_params['query-string'] = params['query_string'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'wildcard' in params: - query_params['wildcard'] = params['wildcard'] - if 'entity' in params: - query_params['entity'] = params['entity'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SwaggerTypeList', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_amendments_by_actioning_time(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of amendment objects with an actioning-time within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by actioning\",\"response\":\"getAmendmentByActioningTime.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendments_by_actioning_time(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_amendments_by_actioning_time_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_amendments_by_actioning_time_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_amendments_by_actioning_time_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of amendment objects with an actioning-time within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by actioning\",\"response\":\"getAmendmentByActioningTime.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendments_by_actioning_time_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_amendments_by_actioning_time" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_amendments_by_actioning_time`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_amendments_by_actioning_time`") - - resource_path = '/amendments/actioning-time/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AmendmentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_amendments_by_created_date(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of amendment objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by creation\",\"response\":\"getAmendmentByCreated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendments_by_created_date(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_amendments_by_created_date_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_amendments_by_created_date_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_amendments_by_created_date_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of amendment objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by creation\",\"response\":\"getAmendmentByCreated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendments_by_created_date_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_amendments_by_created_date" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_amendments_by_created_date`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_amendments_by_created_date`") - - resource_path = '/amendments/created/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AmendmentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_amendments_by_updated_date(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of amendment objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by updated\",\"response\":\"getAmendmentByUpdated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendments_by_updated_date(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_amendments_by_updated_date_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_amendments_by_updated_date_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_amendments_by_updated_date_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of amendment objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by updated\",\"response\":\"getAmendmentByUpdated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendments_by_updated_date_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_amendments_by_updated_date" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_amendments_by_updated_date`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_amendments_by_updated_date`") - - resource_path = '/amendments/updated/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AmendmentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def retire_amendment(self, amendment_id, organizations, **kwargs): - """ - Retires the amendment specified by the amendment-ID parameter. Retiring a amendment causes it to cancel based on the specificed retirement settings for the product. - {\"nickname\":\"Delete an amendment\",\"response\":\"deleteAmendment.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_amendment(amendment_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str amendment_id: ID of the amendment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.retire_amendment_with_http_info(amendment_id, organizations, **kwargs) - else: - (data) = self.retire_amendment_with_http_info(amendment_id, organizations, **kwargs) - return data - - def retire_amendment_with_http_info(self, amendment_id, organizations, **kwargs): - """ - Retires the amendment specified by the amendment-ID parameter. Retiring a amendment causes it to cancel based on the specificed retirement settings for the product. - {\"nickname\":\"Delete an amendment\",\"response\":\"deleteAmendment.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_amendment_with_http_info(amendment_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str amendment_id: ID of the amendment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['amendment_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method retire_amendment" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'amendment_id' is set - if ('amendment_id' not in params) or (params['amendment_id'] is None): - raise ValueError("Missing the required parameter `amendment_id` when calling `retire_amendment`") - # verify the required parameter 'organizations' is set - if ('organizations' not in params) or (params['organizations'] is None): - raise ValueError("Missing the required parameter `organizations` when calling `retire_amendment`") - - resource_path = '/amendments/{amendment-ID}'.replace('{format}', 'json') - path_params = {} - if 'amendment_id' in params: - path_params['amendment-ID'] = params['amendment_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AmendmentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_amendment(self, amendment, **kwargs): - """ - Update an amendment. - {\"nickname\":\"Update an amendment\",\"request\":\"updateAmendmentRequest.html\",\"response\":\"updateAmendmentResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_amendment(amendment, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Amendment amendment: The amendment object to be updated. (required) - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_amendment_with_http_info(amendment, **kwargs) - else: - (data) = self.update_amendment_with_http_info(amendment, **kwargs) - return data - - def update_amendment_with_http_info(self, amendment, **kwargs): - """ - Update an amendment. - {\"nickname\":\"Update an amendment\",\"request\":\"updateAmendmentRequest.html\",\"response\":\"updateAmendmentResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_amendment_with_http_info(amendment, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Amendment amendment: The amendment object to be updated. (required) - :return: AmendmentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['amendment'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_amendment" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'amendment' is set - if ('amendment' not in params) or (params['amendment'] is None): - raise ValueError("Missing the required parameter `amendment` when calling `update_amendment`") - - resource_path = '/amendments'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'amendment' in params: - body_params = params['amendment'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AmendmentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/analytics_api.py b/billforward/apis/analytics_api.py deleted file mode 100644 index 118e076..0000000 --- a/billforward/apis/analytics_api.py +++ /dev/null @@ -1,1384 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class AnalyticsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def get_account_debts(self, debts_per_account, **kwargs): - """ - Gets outstanding debts per account, within a date range. - {\"nickname\" : \"Get account debts\",\"response\" : \"getAccountDebts.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_account_debts(debts_per_account, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase debts_per_account: The payments-per-account object. (required) - :return: AccountPaymentsResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_account_debts_with_http_info(debts_per_account, **kwargs) - else: - (data) = self.get_account_debts_with_http_info(debts_per_account, **kwargs) - return data - - def get_account_debts_with_http_info(self, debts_per_account, **kwargs): - """ - Gets outstanding debts per account, within a date range. - {\"nickname\" : \"Get account debts\",\"response\" : \"getAccountDebts.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_account_debts_with_http_info(debts_per_account, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase debts_per_account: The payments-per-account object. (required) - :return: AccountPaymentsResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['debts_per_account'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_account_debts" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'debts_per_account' is set - if ('debts_per_account' not in params) or (params['debts_per_account'] is None): - raise ValueError("Missing the required parameter `debts_per_account` when calling `get_account_debts`") - - resource_path = '/analytics/payments/accounts/outstanding'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'debts_per_account' in params: - body_params = params['debts_per_account'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccountPaymentsResultPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_account_ltv(self, account_id, end_datetime, **kwargs): - """ - Gets an account's life-time value, as of a given end date. - {\"nickname\":\"Get account life-time value\",\"response\":\"getAccountLTV.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_account_ltv(account_id, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The id of the account. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: AccountLTVResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_account_ltv_with_http_info(account_id, end_datetime, **kwargs) - else: - (data) = self.get_account_ltv_with_http_info(account_id, end_datetime, **kwargs) - return data - - def get_account_ltv_with_http_info(self, account_id, end_datetime, **kwargs): - """ - Gets an account's life-time value, as of a given end date. - {\"nickname\":\"Get account life-time value\",\"response\":\"getAccountLTV.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_account_ltv_with_http_info(account_id, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The id of the account. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: AccountLTVResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'end_datetime', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_account_ltv" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_account_ltv`") - # verify the required parameter 'end_datetime' is set - if ('end_datetime' not in params) or (params['end_datetime'] is None): - raise ValueError("Missing the required parameter `end_datetime` when calling `get_account_ltv`") - - resource_path = '/analytics/account-ltv/{account-id}/{end-datetime}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-id'] = params['account_id'] - if 'end_datetime' in params: - path_params['end-datetime'] = params['end_datetime'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccountLTVResultPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_account_payments(self, payments_per_account, **kwargs): - """ - Gets hourly payments per product, within a date range. - {\"nickname\" : \"Get payments per account\",\"response\" : \"getAccountPayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_account_payments(payments_per_account, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase payments_per_account: The payments-per-account object. (required) - :return: AccountPaymentsResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_account_payments_with_http_info(payments_per_account, **kwargs) - else: - (data) = self.get_account_payments_with_http_info(payments_per_account, **kwargs) - return data - - def get_account_payments_with_http_info(self, payments_per_account, **kwargs): - """ - Gets hourly payments per product, within a date range. - {\"nickname\" : \"Get payments per account\",\"response\" : \"getAccountPayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_account_payments_with_http_info(payments_per_account, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase payments_per_account: The payments-per-account object. (required) - :return: AccountPaymentsResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payments_per_account'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_account_payments" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payments_per_account' is set - if ('payments_per_account' not in params) or (params['payments_per_account'] is None): - raise ValueError("Missing the required parameter `payments_per_account` when calling `get_account_payments`") - - resource_path = '/analytics/payments/accounts'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'payments_per_account' in params: - body_params = params['payments_per_account'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AccountPaymentsResultPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_billforward_managed_payments(self, start_datetime, end_datetime, **kwargs): - """ - Gets all payments managed by BillForward, within a date range. - {\"nickname\":\"Get managed payments\",\"response\":\"getManagedPayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_billforward_managed_payments(start_datetime, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str start_datetime: The UTC DateTime specifying the start of the result period. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: BillforwardManagedPaymentsResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_billforward_managed_payments_with_http_info(start_datetime, end_datetime, **kwargs) - else: - (data) = self.get_billforward_managed_payments_with_http_info(start_datetime, end_datetime, **kwargs) - return data - - def get_billforward_managed_payments_with_http_info(self, start_datetime, end_datetime, **kwargs): - """ - Gets all payments managed by BillForward, within a date range. - {\"nickname\":\"Get managed payments\",\"response\":\"getManagedPayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_billforward_managed_payments_with_http_info(start_datetime, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str start_datetime: The UTC DateTime specifying the start of the result period. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: BillforwardManagedPaymentsResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['start_datetime', 'end_datetime', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_billforward_managed_payments" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'start_datetime' is set - if ('start_datetime' not in params) or (params['start_datetime'] is None): - raise ValueError("Missing the required parameter `start_datetime` when calling `get_billforward_managed_payments`") - # verify the required parameter 'end_datetime' is set - if ('end_datetime' not in params) or (params['end_datetime'] is None): - raise ValueError("Missing the required parameter `end_datetime` when calling `get_billforward_managed_payments`") - - resource_path = '/analytics/billforward-managed-payments/{start-datetime}/{end-datetime}'.replace('{format}', 'json') - path_params = {} - if 'start_datetime' in params: - path_params['start-datetime'] = params['start_datetime'] - if 'end_datetime' in params: - path_params['end-datetime'] = params['end_datetime'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='BillforwardManagedPaymentsResultPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_churn(self, start_datetime, end_datetime, **kwargs): - """ - Gets churn, within a date range. - {\"nickname\":\"Get churn\",\"response\":\"getChurn.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_churn(start_datetime, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str start_datetime: The UTC DateTime specifying the start of the result period. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: CassChurnResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_churn_with_http_info(start_datetime, end_datetime, **kwargs) - else: - (data) = self.get_churn_with_http_info(start_datetime, end_datetime, **kwargs) - return data - - def get_churn_with_http_info(self, start_datetime, end_datetime, **kwargs): - """ - Gets churn, within a date range. - {\"nickname\":\"Get churn\",\"response\":\"getChurn.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_churn_with_http_info(start_datetime, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str start_datetime: The UTC DateTime specifying the start of the result period. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: CassChurnResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['start_datetime', 'end_datetime', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_churn" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'start_datetime' is set - if ('start_datetime' not in params) or (params['start_datetime'] is None): - raise ValueError("Missing the required parameter `start_datetime` when calling `get_churn`") - # verify the required parameter 'end_datetime' is set - if ('end_datetime' not in params) or (params['end_datetime'] is None): - raise ValueError("Missing the required parameter `end_datetime` when calling `get_churn`") - - resource_path = '/analytics/churn/{start-datetime}/{end-datetime}'.replace('{format}', 'json') - path_params = {} - if 'start_datetime' in params: - path_params['start-datetime'] = params['start_datetime'] - if 'end_datetime' in params: - path_params['end-datetime'] = params['end_datetime'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CassChurnResultPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_debts(self, start_datetime, end_datetime, **kwargs): - """ - Gets debts within a date range. - {\"nickname\":\"Get debts\",\"response\":\"getDebts.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_debts(start_datetime, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str start_datetime: The UTC DateTime specifying the start of the result period. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: DebtsResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_debts_with_http_info(start_datetime, end_datetime, **kwargs) - else: - (data) = self.get_debts_with_http_info(start_datetime, end_datetime, **kwargs) - return data - - def get_debts_with_http_info(self, start_datetime, end_datetime, **kwargs): - """ - Gets debts within a date range. - {\"nickname\":\"Get debts\",\"response\":\"getDebts.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_debts_with_http_info(start_datetime, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str start_datetime: The UTC DateTime specifying the start of the result period. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: DebtsResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['start_datetime', 'end_datetime', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_debts" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'start_datetime' is set - if ('start_datetime' not in params) or (params['start_datetime'] is None): - raise ValueError("Missing the required parameter `start_datetime` when calling `get_debts`") - # verify the required parameter 'end_datetime' is set - if ('end_datetime' not in params) or (params['end_datetime'] is None): - raise ValueError("Missing the required parameter `end_datetime` when calling `get_debts`") - - resource_path = '/analytics/payments/outstanding/{start-datetime}/{end-datetime}'.replace('{format}', 'json') - path_params = {} - if 'start_datetime' in params: - path_params['start-datetime'] = params['start_datetime'] - if 'end_datetime' in params: - path_params['end-datetime'] = params['end_datetime'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DebtsResultPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_payments(self, start_datetime, end_datetime, **kwargs): - """ - Gets payments within a date range. - {\"nickname\":\"Get all payments\",\"response\":\"getPayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payments(start_datetime, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str start_datetime: The UTC DateTime specifying the start of the result period. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: CassPaymentResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_payments_with_http_info(start_datetime, end_datetime, **kwargs) - else: - (data) = self.get_payments_with_http_info(start_datetime, end_datetime, **kwargs) - return data - - def get_payments_with_http_info(self, start_datetime, end_datetime, **kwargs): - """ - Gets payments within a date range. - {\"nickname\":\"Get all payments\",\"response\":\"getPayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payments_with_http_info(start_datetime, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str start_datetime: The UTC DateTime specifying the start of the result period. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: CassPaymentResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['start_datetime', 'end_datetime', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_payments" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'start_datetime' is set - if ('start_datetime' not in params) or (params['start_datetime'] is None): - raise ValueError("Missing the required parameter `start_datetime` when calling `get_payments`") - # verify the required parameter 'end_datetime' is set - if ('end_datetime' not in params) or (params['end_datetime'] is None): - raise ValueError("Missing the required parameter `end_datetime` when calling `get_payments`") - - resource_path = '/analytics/payments/{start-datetime}/{end-datetime}'.replace('{format}', 'json') - path_params = {} - if 'start_datetime' in params: - path_params['start-datetime'] = params['start_datetime'] - if 'end_datetime' in params: - path_params['end-datetime'] = params['end_datetime'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CassPaymentResultPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_product_payments(self, payments_per_product, **kwargs): - """ - Gets hourly payments per product, within a date range. - {\"nickname\" : \"Get payments per product\",\"response\" : \"getProductPayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_product_payments(payments_per_product, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase payments_per_product: The payments-per-product object. (required) - :return: ProductPaymentsResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_product_payments_with_http_info(payments_per_product, **kwargs) - else: - (data) = self.get_product_payments_with_http_info(payments_per_product, **kwargs) - return data - - def get_product_payments_with_http_info(self, payments_per_product, **kwargs): - """ - Gets hourly payments per product, within a date range. - {\"nickname\" : \"Get payments per product\",\"response\" : \"getProductPayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_product_payments_with_http_info(payments_per_product, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase payments_per_product: The payments-per-product object. (required) - :return: ProductPaymentsResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payments_per_product'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_product_payments" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payments_per_product' is set - if ('payments_per_product' not in params) or (params['payments_per_product'] is None): - raise ValueError("Missing the required parameter `payments_per_product` when calling `get_product_payments`") - - resource_path = '/analytics/payments-per-product'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'payments_per_product' in params: - body_params = params['payments_per_product'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductPaymentsResultPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_product_rate_plan_payments(self, payments_per_product_rate_plan, **kwargs): - """ - Gets hourly payments per product, within a date range. - {\"nickname\" : \"Get payments per rate plan\",\"response\" : \"getRatePlanPayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_product_rate_plan_payments(payments_per_product_rate_plan, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase payments_per_product_rate_plan: The payments-per-product-rate-plan object. (required) - :return: ProductRatePlanPaymentsResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_product_rate_plan_payments_with_http_info(payments_per_product_rate_plan, **kwargs) - else: - (data) = self.get_product_rate_plan_payments_with_http_info(payments_per_product_rate_plan, **kwargs) - return data - - def get_product_rate_plan_payments_with_http_info(self, payments_per_product_rate_plan, **kwargs): - """ - Gets hourly payments per product, within a date range. - {\"nickname\" : \"Get payments per rate plan\",\"response\" : \"getRatePlanPayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_product_rate_plan_payments_with_http_info(payments_per_product_rate_plan, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase payments_per_product_rate_plan: The payments-per-product-rate-plan object. (required) - :return: ProductRatePlanPaymentsResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payments_per_product_rate_plan'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_product_rate_plan_payments" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payments_per_product_rate_plan' is set - if ('payments_per_product_rate_plan' not in params) or (params['payments_per_product_rate_plan'] is None): - raise ValueError("Missing the required parameter `payments_per_product_rate_plan` when calling `get_product_rate_plan_payments`") - - resource_path = '/analytics/payments/product-rate-plan'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'payments_per_product_rate_plan' in params: - body_params = params['payments_per_product_rate_plan'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductRatePlanPaymentsResultPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscription_ltv(self, subscription_id, end_datetime, **kwargs): - """ - Gets a subscription's life-time value, as of a given end date. - {\"nickname\":\"Get sub life-time value\",\"response\":\"getSubscriptionLTV.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_ltv(subscription_id, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The id of the subscription. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: SubscriptionLTVResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscription_ltv_with_http_info(subscription_id, end_datetime, **kwargs) - else: - (data) = self.get_subscription_ltv_with_http_info(subscription_id, end_datetime, **kwargs) - return data - - def get_subscription_ltv_with_http_info(self, subscription_id, end_datetime, **kwargs): - """ - Gets a subscription's life-time value, as of a given end date. - {\"nickname\":\"Get sub life-time value\",\"response\":\"getSubscriptionLTV.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_ltv_with_http_info(subscription_id, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The id of the subscription. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: SubscriptionLTVResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'end_datetime', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscription_ltv" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_subscription_ltv`") - # verify the required parameter 'end_datetime' is set - if ('end_datetime' not in params) or (params['end_datetime'] is None): - raise ValueError("Missing the required parameter `end_datetime` when calling `get_subscription_ltv`") - - resource_path = '/analytics/subscription-ltv/{subscription-id}/{end-datetime}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-id'] = params['subscription_id'] - if 'end_datetime' in params: - path_params['end-datetime'] = params['end_datetime'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionLTVResultPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_upgrades(self, start_datetime, end_datetime, **kwargs): - """ - Gets upgrades, within a date range. - {\"nickname\":\"Get upgrades\",\"response\":\"getUpgrades.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_upgrades(start_datetime, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str start_datetime: The UTC DateTime specifying the start of the result period. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: CassUpgradeResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_upgrades_with_http_info(start_datetime, end_datetime, **kwargs) - else: - (data) = self.get_upgrades_with_http_info(start_datetime, end_datetime, **kwargs) - return data - - def get_upgrades_with_http_info(self, start_datetime, end_datetime, **kwargs): - """ - Gets upgrades, within a date range. - {\"nickname\":\"Get upgrades\",\"response\":\"getUpgrades.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_upgrades_with_http_info(start_datetime, end_datetime, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str start_datetime: The UTC DateTime specifying the start of the result period. (required) - :param str end_datetime: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: CassUpgradeResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['start_datetime', 'end_datetime', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_upgrades" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'start_datetime' is set - if ('start_datetime' not in params) or (params['start_datetime'] is None): - raise ValueError("Missing the required parameter `start_datetime` when calling `get_upgrades`") - # verify the required parameter 'end_datetime' is set - if ('end_datetime' not in params) or (params['end_datetime'] is None): - raise ValueError("Missing the required parameter `end_datetime` when calling `get_upgrades`") - - resource_path = '/analytics/upgrades/{start-datetime}/{end-datetime}'.replace('{format}', 'json') - path_params = {} - if 'start_datetime' in params: - path_params['start-datetime'] = params['start_datetime'] - if 'end_datetime' in params: - path_params['end-datetime'] = params['end_datetime'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CassUpgradeResultPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/auditlogs_api.py b/billforward/apis/auditlogs_api.py deleted file mode 100644 index 4594509..0000000 --- a/billforward/apis/auditlogs_api.py +++ /dev/null @@ -1,671 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class AuditlogsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def get_all_audit_entries(self, **kwargs): - """ - Returns a collection of all audit-log objects. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all\",\"response\":\"getAuditAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_audit_entries(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first audit-log entry to return. - :param int records: The maximum number of audit-log entry to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AuditEntryPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_audit_entries_with_http_info(**kwargs) - else: - (data) = self.get_all_audit_entries_with_http_info(**kwargs) - return data - - def get_all_audit_entries_with_http_info(self, **kwargs): - """ - Returns a collection of all audit-log objects. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all\",\"response\":\"getAuditAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_audit_entries_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first audit-log entry to return. - :param int records: The maximum number of audit-log entry to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AuditEntryPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_audit_entries" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/audit-logs'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AuditEntryPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_audit_entries_by_created_date(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of audit-log objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by created time\",\"response\":\"getAuditByCreated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_audit_entries_by_created_date(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first audit-log entry to return. - :param int records: The maximum number of audit-log entry to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AuditEntryPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_audit_entries_by_created_date_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_audit_entries_by_created_date_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_audit_entries_by_created_date_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of audit-log objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by created time\",\"response\":\"getAuditByCreated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_audit_entries_by_created_date_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first audit-log entry to return. - :param int records: The maximum number of audit-log entry to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AuditEntryPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_audit_entries_by_created_date" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_audit_entries_by_created_date`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_audit_entries_by_created_date`") - - resource_path = '/audit-logs/created/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AuditEntryPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_audit_entry_by_entity_id(self, entity_id, **kwargs): - """ - Returns a collection of audit-log entries, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by entity-ID\",\"response\":\"getAuditByEntityID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_audit_entry_by_entity_id(entity_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str entity_id: The string ID of the entity whose changes are documented by the audit log. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first account to return. - :param int records: The maximum number of accounts to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AuditEntryPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_audit_entry_by_entity_id_with_http_info(entity_id, **kwargs) - else: - (data) = self.get_audit_entry_by_entity_id_with_http_info(entity_id, **kwargs) - return data - - def get_audit_entry_by_entity_id_with_http_info(self, entity_id, **kwargs): - """ - Returns a collection of audit-log entries, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by entity-ID\",\"response\":\"getAuditByEntityID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_audit_entry_by_entity_id_with_http_info(entity_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str entity_id: The string ID of the entity whose changes are documented by the audit log. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first account to return. - :param int records: The maximum number of accounts to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AuditEntryPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['entity_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_audit_entry_by_entity_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'entity_id' is set - if ('entity_id' not in params) or (params['entity_id'] is None): - raise ValueError("Missing the required parameter `entity_id` when calling `get_audit_entry_by_entity_id`") - - resource_path = '/audit-logs/entity/{entity-ID}'.replace('{format}', 'json') - path_params = {} - if 'entity_id' in params: - path_params['entity-ID'] = params['entity_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AuditEntryPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_audit_entry_by_entity_type(self, entity_type, **kwargs): - """ - Returns a collection of audit-log entries, specified by the entity-type parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by entity type\",\"response\":\"getAuditByEntityType.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_audit_entry_by_entity_type(entity_type, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str entity_type: The type of the entity whose changes are documented by the audit log. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first account to return. - :param int records: The maximum number of accounts to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AuditEntryPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_audit_entry_by_entity_type_with_http_info(entity_type, **kwargs) - else: - (data) = self.get_audit_entry_by_entity_type_with_http_info(entity_type, **kwargs) - return data - - def get_audit_entry_by_entity_type_with_http_info(self, entity_type, **kwargs): - """ - Returns a collection of audit-log entries, specified by the entity-type parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by entity type\",\"response\":\"getAuditByEntityType.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_audit_entry_by_entity_type_with_http_info(entity_type, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str entity_type: The type of the entity whose changes are documented by the audit log. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first account to return. - :param int records: The maximum number of accounts to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: AuditEntryPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['entity_type', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_audit_entry_by_entity_type" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'entity_type' is set - if ('entity_type' not in params) or (params['entity_type'] is None): - raise ValueError("Missing the required parameter `entity_type` when calling `get_audit_entry_by_entity_type`") - - resource_path = '/audit-logs/entity-type/{entity-type}'.replace('{format}', 'json') - path_params = {} - if 'entity_type' in params: - path_params['entity-type'] = params['entity_type'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AuditEntryPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_audit_entry_by_id(self, audit_id, **kwargs): - """ - Returns a single audit-log entry, specified by the audit-ID parameter. - {\"nickname\":\"Retrieve by id\",\"response\":\"getAuditByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_audit_entry_by_id(audit_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str audit_id: The string ID of the audit-log entry. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 - :return: AuditEntryPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_audit_entry_by_id_with_http_info(audit_id, **kwargs) - else: - (data) = self.get_audit_entry_by_id_with_http_info(audit_id, **kwargs) - return data - - def get_audit_entry_by_id_with_http_info(self, audit_id, **kwargs): - """ - Returns a single audit-log entry, specified by the audit-ID parameter. - {\"nickname\":\"Retrieve by id\",\"response\":\"getAuditByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_audit_entry_by_id_with_http_info(audit_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str audit_id: The string ID of the audit-log entry. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 - :return: AuditEntryPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['audit_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_audit_entry_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'audit_id' is set - if ('audit_id' not in params) or (params['audit_id'] is None): - raise ValueError("Missing the required parameter `audit_id` when calling `get_audit_entry_by_id`") - - resource_path = '/audit-logs/{audit-ID}'.replace('{format}', 'json') - path_params = {} - if 'audit_id' in params: - path_params['audit-ID'] = params['audit_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AuditEntryPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/charges_api.py b/billforward/apis/charges_api.py deleted file mode 100644 index a97d579..0000000 --- a/billforward/apis/charges_api.py +++ /dev/null @@ -1,883 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class ChargesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def get_all_subscription_charges(self, **kwargs): - """ - Retrieves a collection of all charges. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve all charges\",\"response\":\"getChargeAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_subscription_charges(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_subscription_charges_with_http_info(**kwargs) - else: - (data) = self.get_all_subscription_charges_with_http_info(**kwargs) - return data - - def get_all_subscription_charges_with_http_info(self, **kwargs): - """ - Retrieves a collection of all charges. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve all charges\",\"response\":\"getChargeAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_subscription_charges_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_subscription_charges" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/charges'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionChargePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscription_charge_by_account_id(self, account_id, **kwargs): - """ - Retrieves a collection of charges, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by account\",\"response\":\"getChargeByAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_charge_by_account_id(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The string ID of the account (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscription_charge_by_account_id_with_http_info(account_id, **kwargs) - else: - (data) = self.get_subscription_charge_by_account_id_with_http_info(account_id, **kwargs) - return data - - def get_subscription_charge_by_account_id_with_http_info(self, account_id, **kwargs): - """ - Retrieves a collection of charges, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by account\",\"response\":\"getChargeByAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_charge_by_account_id_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The string ID of the account (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscription_charge_by_account_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_subscription_charge_by_account_id`") - - resource_path = '/charges/account/{account-ID}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionChargePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscription_charge_by_id(self, charge_id, **kwargs): - """ - Retrieves a single charge, specified by the charge-id parameter. - {\"nickname\":\"Retrieve a charge\",\"response\":\"getChargeByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_charge_by_id(charge_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str charge_id: The unique string-ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscription_charge_by_id_with_http_info(charge_id, **kwargs) - else: - (data) = self.get_subscription_charge_by_id_with_http_info(charge_id, **kwargs) - return data - - def get_subscription_charge_by_id_with_http_info(self, charge_id, **kwargs): - """ - Retrieves a single charge, specified by the charge-id parameter. - {\"nickname\":\"Retrieve a charge\",\"response\":\"getChargeByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_charge_by_id_with_http_info(charge_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str charge_id: The unique string-ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['charge_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscription_charge_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'charge_id' is set - if ('charge_id' not in params) or (params['charge_id'] is None): - raise ValueError("Missing the required parameter `charge_id` when calling `get_subscription_charge_by_id`") - - resource_path = '/charges/{charge-id}'.replace('{format}', 'json') - path_params = {} - if 'charge_id' in params: - path_params['charge-id'] = params['charge_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionChargePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscription_charge_by_state(self, state, **kwargs): - """ - Retrieves a collection of charges, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by state\",\"response\":\"getChargeByState.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_charge_by_state(state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the charge (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscription_charge_by_state_with_http_info(state, **kwargs) - else: - (data) = self.get_subscription_charge_by_state_with_http_info(state, **kwargs) - return data - - def get_subscription_charge_by_state_with_http_info(self, state, **kwargs): - """ - Retrieves a collection of charges, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by state\",\"response\":\"getChargeByState.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_charge_by_state_with_http_info(state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the charge (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['state', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscription_charge_by_state" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'state' is set - if ('state' not in params) or (params['state'] is None): - raise ValueError("Missing the required parameter `state` when calling `get_subscription_charge_by_state`") - - resource_path = '/charges/state/{state}'.replace('{format}', 'json') - path_params = {} - if 'state' in params: - path_params['state'] = params['state'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionChargePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscription_charge_by_version_id(self, version_id, **kwargs): - """ - Retrieves a single charge, specified by the version-ID parameter. - {\"nickname\":\"Retrieve by version\",\"response\":\"getChargeByVersionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_charge_by_version_id(version_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version_id: The version-ID of the charge. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscription_charge_by_version_id_with_http_info(version_id, **kwargs) - else: - (data) = self.get_subscription_charge_by_version_id_with_http_info(version_id, **kwargs) - return data - - def get_subscription_charge_by_version_id_with_http_info(self, version_id, **kwargs): - """ - Retrieves a single charge, specified by the version-ID parameter. - {\"nickname\":\"Retrieve by version\",\"response\":\"getChargeByVersionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_charge_by_version_id_with_http_info(version_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version_id: The version-ID of the charge. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['version_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscription_charge_by_version_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'version_id' is set - if ('version_id' not in params) or (params['version_id'] is None): - raise ValueError("Missing the required parameter `version_id` when calling `get_subscription_charge_by_version_id`") - - resource_path = '/charges/version/{version-ID}'.replace('{format}', 'json') - path_params = {} - if 'version_id' in params: - path_params['version-ID'] = params['version_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionChargePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def recalculate_subscription_charge(self, charge_id, charge, **kwargs): - """ - Recalculate a charge. - {\"nickname\":\"Re-calculate a charge\",\"request\":\"recalculateChargeRequest.html\",\"response\":\"recalculateChargeResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.recalculate_subscription_charge(charge_id, charge, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str charge_id: Unique id of the charge. (required) - :param RecalculateChargeRequest charge: The charge to be re-calculated. (required) - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.recalculate_subscription_charge_with_http_info(charge_id, charge, **kwargs) - else: - (data) = self.recalculate_subscription_charge_with_http_info(charge_id, charge, **kwargs) - return data - - def recalculate_subscription_charge_with_http_info(self, charge_id, charge, **kwargs): - """ - Recalculate a charge. - {\"nickname\":\"Re-calculate a charge\",\"request\":\"recalculateChargeRequest.html\",\"response\":\"recalculateChargeResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.recalculate_subscription_charge_with_http_info(charge_id, charge, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str charge_id: Unique id of the charge. (required) - :param RecalculateChargeRequest charge: The charge to be re-calculated. (required) - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['charge_id', 'charge'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method recalculate_subscription_charge" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'charge_id' is set - if ('charge_id' not in params) or (params['charge_id'] is None): - raise ValueError("Missing the required parameter `charge_id` when calling `recalculate_subscription_charge`") - # verify the required parameter 'charge' is set - if ('charge' not in params) or (params['charge'] is None): - raise ValueError("Missing the required parameter `charge` when calling `recalculate_subscription_charge`") - - resource_path = '/charges/{charge-ID}/recalculate'.replace('{format}', 'json') - path_params = {} - if 'charge_id' in params: - path_params['charge-ID'] = params['charge_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'charge' in params: - body_params = params['charge'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionChargePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def void_subscription_charge(self, charge_id, **kwargs): - """ - Void the charge with the specified charge-ID. - {\"nickname\":\"Void charge\",\"response\":\"deleteCharge.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.void_subscription_charge(charge_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str charge_id: Unique id of the charge. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.void_subscription_charge_with_http_info(charge_id, **kwargs) - else: - (data) = self.void_subscription_charge_with_http_info(charge_id, **kwargs) - return data - - def void_subscription_charge_with_http_info(self, charge_id, **kwargs): - """ - Void the charge with the specified charge-ID. - {\"nickname\":\"Void charge\",\"response\":\"deleteCharge.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.void_subscription_charge_with_http_info(charge_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str charge_id: Unique id of the charge. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['charge_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method void_subscription_charge" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'charge_id' is set - if ('charge_id' not in params) or (params['charge_id'] is None): - raise ValueError("Missing the required parameter `charge_id` when calling `void_subscription_charge`") - - resource_path = '/charges/{charge-id}'.replace('{format}', 'json') - path_params = {} - if 'charge_id' in params: - path_params['charge-id'] = params['charge_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionChargePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/clients_api.py b/billforward/apis/clients_api.py deleted file mode 100644 index 596f06d..0000000 --- a/billforward/apis/clients_api.py +++ /dev/null @@ -1,488 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class ClientsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_client(self, client, **kwargs): - """ - Create a client. - {\"nickname\":\"Create\",\"request\":\"createClientRequest.html\",\"response\":\"createClientResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_client(client, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Client client: The client object to be updated. (required) - :return: ClientPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_client_with_http_info(client, **kwargs) - else: - (data) = self.create_client_with_http_info(client, **kwargs) - return data - - def create_client_with_http_info(self, client, **kwargs): - """ - Create a client. - {\"nickname\":\"Create\",\"request\":\"createClientRequest.html\",\"response\":\"createClientResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_client_with_http_info(client, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Client client: The client object to be updated. (required) - :return: ClientPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['client'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_client" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'client' is set - if ('client' not in params) or (params['client'] is None): - raise ValueError("Missing the required parameter `client` when calling `create_client`") - - resource_path = '/clients'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'client' in params: - body_params = params['client'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ClientPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_clients(self, **kwargs): - """ - Returns a collection of clients. - {\"nickname\":\"Get All\",\"response\":\"getClientAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_clients(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first client to return. - :param int records: The maximum number of clients to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: ClientPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_clients_with_http_info(**kwargs) - else: - (data) = self.get_all_clients_with_http_info(**kwargs) - return data - - def get_all_clients_with_http_info(self, **kwargs): - """ - Returns a collection of clients. - {\"nickname\":\"Get All\",\"response\":\"getClientAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_clients_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first client to return. - :param int records: The maximum number of clients to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: ClientPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_clients" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/clients'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ClientPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_client_by_id(self, client_id, **kwargs): - """ - Returns a single client, specified by the client-ID parameter. - {\"nickname\":\"Retrieve by id\",\"response\":\"getClientByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_client_by_id(client_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str client_id: The string ID of the client. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: ClientPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_client_by_id_with_http_info(client_id, **kwargs) - else: - (data) = self.get_client_by_id_with_http_info(client_id, **kwargs) - return data - - def get_client_by_id_with_http_info(self, client_id, **kwargs): - """ - Returns a single client, specified by the client-ID parameter. - {\"nickname\":\"Retrieve by id\",\"response\":\"getClientByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_client_by_id_with_http_info(client_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str client_id: The string ID of the client. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: ClientPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['client_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_client_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'client_id' is set - if ('client_id' not in params) or (params['client_id'] is None): - raise ValueError("Missing the required parameter `client_id` when calling `get_client_by_id`") - - resource_path = '/clients/{client-ID}'.replace('{format}', 'json') - path_params = {} - if 'client_id' in params: - path_params['client-ID'] = params['client_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ClientPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_client(self, client, **kwargs): - """ - Update a client. - {\"nickname\":\"Update\",\"request\":\"updateClientRequest.html\",\"response\":\"updateClientResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_client(client, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Client client: The client object to be updated. (required) - :return: ClientPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_client_with_http_info(client, **kwargs) - else: - (data) = self.update_client_with_http_info(client, **kwargs) - return data - - def update_client_with_http_info(self, client, **kwargs): - """ - Update a client. - {\"nickname\":\"Update\",\"request\":\"updateClientRequest.html\",\"response\":\"updateClientResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_client_with_http_info(client, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Client client: The client object to be updated. (required) - :return: ClientPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['client'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_client" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'client' is set - if ('client' not in params) or (params['client'] is None): - raise ValueError("Missing the required parameter `client` when calling `update_client`") - - resource_path = '/clients'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'client' in params: - body_params = params['client'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ClientPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/configurations_api.py b/billforward/apis/configurations_api.py deleted file mode 100644 index 8568194..0000000 --- a/billforward/apis/configurations_api.py +++ /dev/null @@ -1,500 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class ConfigurationsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_api_configuration(self, configuration, **kwargs): - """ - Create a configuration. - {\"nickname\":\"Create a new configuration\",\"request\":\"createConfigurationRequest.html\",\"response\":\"createConfigurationResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_api_configuration(configuration, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity configuration: The configuration object to be created. (required) - :return: APIConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_api_configuration_with_http_info(configuration, **kwargs) - else: - (data) = self.create_api_configuration_with_http_info(configuration, **kwargs) - return data - - def create_api_configuration_with_http_info(self, configuration, **kwargs): - """ - Create a configuration. - {\"nickname\":\"Create a new configuration\",\"request\":\"createConfigurationRequest.html\",\"response\":\"createConfigurationResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_api_configuration_with_http_info(configuration, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity configuration: The configuration object to be created. (required) - :return: APIConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['configuration'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_api_configuration" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'configuration' is set - if ('configuration' not in params) or (params['configuration'] is None): - raise ValueError("Missing the required parameter `configuration` when calling `create_api_configuration`") - - resource_path = '/configurations'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'configuration' in params: - body_params = params['configuration'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_api_configurations(self, **kwargs): - """ - Returns a collection of configurations. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all configurations\",\"response\":\"getConfigurationsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_api_configurations(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: APIConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_api_configurations_with_http_info(**kwargs) - else: - (data) = self.get_all_api_configurations_with_http_info(**kwargs) - return data - - def get_all_api_configurations_with_http_info(self, **kwargs): - """ - Returns a collection of configurations. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all configurations\",\"response\":\"getConfigurationsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_api_configurations_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: APIConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_api_configurations" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/configurations'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_api_configurations_by_type(self, configuration_type, **kwargs): - """ - Returns a single configuration, specified by the type parameter. - {\"nickname\":\"Retrieve by payment gateway\",\"response\":\"getConfigurationByType.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_api_configurations_by_type(configuration_type, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str configuration_type: The unique type of the configuration. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: APIConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_api_configurations_by_type_with_http_info(configuration_type, **kwargs) - else: - (data) = self.get_api_configurations_by_type_with_http_info(configuration_type, **kwargs) - return data - - def get_api_configurations_by_type_with_http_info(self, configuration_type, **kwargs): - """ - Returns a single configuration, specified by the type parameter. - {\"nickname\":\"Retrieve by payment gateway\",\"response\":\"getConfigurationByType.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_api_configurations_by_type_with_http_info(configuration_type, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str configuration_type: The unique type of the configuration. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: APIConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['configuration_type', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_api_configurations_by_type" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'configuration_type' is set - if ('configuration_type' not in params) or (params['configuration_type'] is None): - raise ValueError("Missing the required parameter `configuration_type` when calling `get_api_configurations_by_type`") - - resource_path = '/configurations/type/{configuration-type}'.replace('{format}', 'json') - path_params = {} - if 'configuration_type' in params: - path_params['configuration-type'] = params['configuration_type'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_api_configuration(self, configuration, **kwargs): - """ - Update a configuration. - {\"nickname\":\"Update a configuration\",\"request\":\"updateConfigurationRequest.html\",\"response\":\"updateConfigurationResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_api_configuration(configuration, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity configuration: The configuration object to be updated. (required) - :return: APIConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_api_configuration_with_http_info(configuration, **kwargs) - else: - (data) = self.update_api_configuration_with_http_info(configuration, **kwargs) - return data - - def update_api_configuration_with_http_info(self, configuration, **kwargs): - """ - Update a configuration. - {\"nickname\":\"Update a configuration\",\"request\":\"updateConfigurationRequest.html\",\"response\":\"updateConfigurationResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_api_configuration_with_http_info(configuration, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity configuration: The configuration object to be updated. (required) - :return: APIConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['configuration'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_api_configuration" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'configuration' is set - if ('configuration' not in params) or (params['configuration'] is None): - raise ValueError("Missing the required parameter `configuration` when calling `update_api_configuration`") - - resource_path = '/configurations'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'configuration' in params: - body_params = params['configuration'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/couponbook_api.py b/billforward/apis/couponbook_api.py deleted file mode 100644 index 2620ae9..0000000 --- a/billforward/apis/couponbook_api.py +++ /dev/null @@ -1,1071 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class CouponbookApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_coupon_book(self, coupon_book, **kwargs): - """ - Create a coupon-book. - {\"nickname\":\"Create a new coupon book\",\"request\":\"createCouponBookRequest.html\",\"response\":\"createCouponBookResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_book(coupon_book, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponBook coupon_book: The coupon-book object to be created. (required) - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_coupon_book_with_http_info(coupon_book, **kwargs) - else: - (data) = self.create_coupon_book_with_http_info(coupon_book, **kwargs) - return data - - def create_coupon_book_with_http_info(self, coupon_book, **kwargs): - """ - Create a coupon-book. - {\"nickname\":\"Create a new coupon book\",\"request\":\"createCouponBookRequest.html\",\"response\":\"createCouponBookResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_book_with_http_info(coupon_book, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponBook coupon_book: The coupon-book object to be created. (required) - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_book'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_coupon_book" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_book' is set - if ('coupon_book' not in params) or (params['coupon_book'] is None): - raise ValueError("Missing the required parameter `coupon_book` when calling `create_coupon_book`") - - resource_path = '/coupon-books'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'coupon_book' in params: - body_params = params['coupon_book'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete_coupon_book(self, coupon_book_id, **kwargs): - """ - Retire a coupon-book, specified by the coupon-book-ID parameter. - {\"nickname\":\"Delete coupon book\",\"response\":\"deleteCouponBookByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_coupon_book(coupon_book_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_book_id: ID of the coupon-book. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_coupon_book_with_http_info(coupon_book_id, **kwargs) - else: - (data) = self.delete_coupon_book_with_http_info(coupon_book_id, **kwargs) - return data - - def delete_coupon_book_with_http_info(self, coupon_book_id, **kwargs): - """ - Retire a coupon-book, specified by the coupon-book-ID parameter. - {\"nickname\":\"Delete coupon book\",\"response\":\"deleteCouponBookByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_coupon_book_with_http_info(coupon_book_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_book_id: ID of the coupon-book. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_book_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_coupon_book" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_book_id' is set - if ('coupon_book_id' not in params) or (params['coupon_book_id'] is None): - raise ValueError("Missing the required parameter `coupon_book_id` when calling `delete_coupon_book`") - - resource_path = '/coupon-books/{coupon-book-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_book_id' in params: - path_params['coupon-book-ID'] = params['coupon_book_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_attachable_coupon_books(self, attachableness, has_code, **kwargs): - """ - Returns a collection of attachable coupon-books. An attachable coupon-book has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all attachable coupon books\",\"response\":\"getCouponBookAllAttachable.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_attachable_coupon_books(attachableness, has_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param bool attachableness: The attachableness of the coupon-book. (required) - :param bool has_code: Whether the coupon-books have book codes or not. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-book to return. - :param int records: The maximum number of coupon-books to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_attachable_coupon_books_with_http_info(attachableness, has_code, **kwargs) - else: - (data) = self.get_all_attachable_coupon_books_with_http_info(attachableness, has_code, **kwargs) - return data - - def get_all_attachable_coupon_books_with_http_info(self, attachableness, has_code, **kwargs): - """ - Returns a collection of attachable coupon-books. An attachable coupon-book has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all attachable coupon books\",\"response\":\"getCouponBookAllAttachable.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_attachable_coupon_books_with_http_info(attachableness, has_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param bool attachableness: The attachableness of the coupon-book. (required) - :param bool has_code: Whether the coupon-books have book codes or not. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-book to return. - :param int records: The maximum number of coupon-books to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['attachableness', 'has_code', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_attachable_coupon_books" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'attachableness' is set - if ('attachableness' not in params) or (params['attachableness'] is None): - raise ValueError("Missing the required parameter `attachableness` when calling `get_all_attachable_coupon_books`") - # verify the required parameter 'has_code' is set - if ('has_code' not in params) or (params['has_code'] is None): - raise ValueError("Missing the required parameter `has_code` when calling `get_all_attachable_coupon_books`") - - resource_path = '/coupon-books/attachable/{attachableness}/{has_code}'.replace('{format}', 'json') - path_params = {} - if 'attachableness' in params: - path_params['attachableness'] = params['attachableness'] - if 'has_code' in params: - path_params['has_code'] = params['has_code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_coupon_books(self, **kwargs): - """ - Returns a collection of coupon-books. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all coupon books\",\"response\":\"getCouponBookAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupon_books(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-books to return. - :param int records: The maximum number of coupon-books to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-books should be returned. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_coupon_books_with_http_info(**kwargs) - else: - (data) = self.get_all_coupon_books_with_http_info(**kwargs) - return data - - def get_all_coupon_books_with_http_info(self, **kwargs): - """ - Returns a collection of coupon-books. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all coupon books\",\"response\":\"getCouponBookAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupon_books_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-books to return. - :param int records: The maximum number of coupon-books to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-books should be returned. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_coupon_books" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/coupon-books'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_book_by_book_code(self, book_code, **kwargs): - """ - Returns a single coupon-book, specified by the book-code parameter. - {\"nickname\":\"Retrieve by book code\",\"response\":\"getCouponBookByBookCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_book_by_book_code(book_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str book_code: The unique coupon-book-code. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_book_by_book_code_with_http_info(book_code, **kwargs) - else: - (data) = self.get_coupon_book_by_book_code_with_http_info(book_code, **kwargs) - return data - - def get_coupon_book_by_book_code_with_http_info(self, book_code, **kwargs): - """ - Returns a single coupon-book, specified by the book-code parameter. - {\"nickname\":\"Retrieve by book code\",\"response\":\"getCouponBookByBookCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_book_by_book_code_with_http_info(book_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str book_code: The unique coupon-book-code. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['book_code', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_book_by_book_code" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'book_code' is set - if ('book_code' not in params) or (params['book_code'] is None): - raise ValueError("Missing the required parameter `book_code` when calling `get_coupon_book_by_book_code`") - - resource_path = '/coupon-books/book-code/{book-code}'.replace('{format}', 'json') - path_params = {} - if 'book_code' in params: - path_params['book-code'] = params['book_code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_book_by_coupon_book_definition_id(self, coupon_book_definition_id, **kwargs): - """ - Returns a collection of coupon-books, specified by coupon-book-definition-ID parameter. By default 10 coupon-books are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by coupon book definition\",\"response\":\"getCouponBookByCouponBookDefinitionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_book_by_coupon_book_definition_id(coupon_book_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_book_definition_id: The string coupon-book-definition-ID of the coupon-book. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-book to return. - :param int records: The maximum number of coupon-books to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-books should be returned. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_book_by_coupon_book_definition_id_with_http_info(coupon_book_definition_id, **kwargs) - else: - (data) = self.get_coupon_book_by_coupon_book_definition_id_with_http_info(coupon_book_definition_id, **kwargs) - return data - - def get_coupon_book_by_coupon_book_definition_id_with_http_info(self, coupon_book_definition_id, **kwargs): - """ - Returns a collection of coupon-books, specified by coupon-book-definition-ID parameter. By default 10 coupon-books are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by coupon book definition\",\"response\":\"getCouponBookByCouponBookDefinitionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_book_by_coupon_book_definition_id_with_http_info(coupon_book_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_book_definition_id: The string coupon-book-definition-ID of the coupon-book. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-book to return. - :param int records: The maximum number of coupon-books to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-books should be returned. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_book_definition_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_book_by_coupon_book_definition_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_book_definition_id' is set - if ('coupon_book_definition_id' not in params) or (params['coupon_book_definition_id'] is None): - raise ValueError("Missing the required parameter `coupon_book_definition_id` when calling `get_coupon_book_by_coupon_book_definition_id`") - - resource_path = '/coupon-books/coupon-book-definition/{coupon-book-definition-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_book_definition_id' in params: - path_params['coupon-book-definition-ID'] = params['coupon_book_definition_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_book_by_coupon_code(self, coupon_code, **kwargs): - """ - Returns a single coupon-book, specified by the coupon-code parameter. - {\"nickname\":\"Retrieve by coupon code\",\"response\":\"getCouponBookByBookCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_book_by_coupon_code(coupon_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_code: The unique coupon-code. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_book_by_coupon_code_with_http_info(coupon_code, **kwargs) - else: - (data) = self.get_coupon_book_by_coupon_code_with_http_info(coupon_code, **kwargs) - return data - - def get_coupon_book_by_coupon_code_with_http_info(self, coupon_code, **kwargs): - """ - Returns a single coupon-book, specified by the coupon-code parameter. - {\"nickname\":\"Retrieve by coupon code\",\"response\":\"getCouponBookByBookCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_book_by_coupon_code_with_http_info(coupon_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_code: The unique coupon-code. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_code', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_book_by_coupon_code" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_code' is set - if ('coupon_code' not in params) or (params['coupon_code'] is None): - raise ValueError("Missing the required parameter `coupon_code` when calling `get_coupon_book_by_coupon_code`") - - resource_path = '/coupon-books/coupon/{coupon-code}'.replace('{format}', 'json') - path_params = {} - if 'coupon_code' in params: - path_params['coupon-code'] = params['coupon_code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_book_by_id(self, coupon_book_id, **kwargs): - """ - Returns a single coupon-book, specified by the coupon-book-ID parameter. - {\"nickname\":\"Retrieve an existing coupon book\",\"response\":\"getCouponBookByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_book_by_id(coupon_book_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_book_id: ID of the coupon-book. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_book_by_id_with_http_info(coupon_book_id, **kwargs) - else: - (data) = self.get_coupon_book_by_id_with_http_info(coupon_book_id, **kwargs) - return data - - def get_coupon_book_by_id_with_http_info(self, coupon_book_id, **kwargs): - """ - Returns a single coupon-book, specified by the coupon-book-ID parameter. - {\"nickname\":\"Retrieve an existing coupon book\",\"response\":\"getCouponBookByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_book_by_id_with_http_info(coupon_book_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_book_id: ID of the coupon-book. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_book_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_book_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_book_id' is set - if ('coupon_book_id' not in params) or (params['coupon_book_id'] is None): - raise ValueError("Missing the required parameter `coupon_book_id` when calling `get_coupon_book_by_id`") - - resource_path = '/coupon-books/{coupon-book-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_book_id' in params: - path_params['coupon-book-ID'] = params['coupon_book_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_coupon_book(self, coupon_book, **kwargs): - """ - Update a coupon-book. - {\"nickname\":\"Update a coupon book\",\"request\":\"updateCouponBookRequest.html\",\"response\":\"updateCouponBookResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_coupon_book(coupon_book, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponBook coupon_book: The coupon-book object to be updated. (required) - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_coupon_book_with_http_info(coupon_book, **kwargs) - else: - (data) = self.update_coupon_book_with_http_info(coupon_book, **kwargs) - return data - - def update_coupon_book_with_http_info(self, coupon_book, **kwargs): - """ - Update a coupon-book. - {\"nickname\":\"Update a coupon book\",\"request\":\"updateCouponBookRequest.html\",\"response\":\"updateCouponBookResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_coupon_book_with_http_info(coupon_book, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponBook coupon_book: The coupon-book object to be updated. (required) - :return: CouponBookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_book'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_coupon_book" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_book' is set - if ('coupon_book' not in params) or (params['coupon_book'] is None): - raise ValueError("Missing the required parameter `coupon_book` when calling `update_coupon_book`") - - resource_path = '/coupon-books'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'coupon_book' in params: - body_params = params['coupon_book'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/couponbookdefinition_api.py b/billforward/apis/couponbookdefinition_api.py deleted file mode 100644 index 41c9098..0000000 --- a/billforward/apis/couponbookdefinition_api.py +++ /dev/null @@ -1,724 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class CouponbookdefinitionApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_coupon_book_definition(self, coupon_book_definition, **kwargs): - """ - Create a coupon-book-definition. - {\"nickname\":\"Create a new book definition\",\"request\":\"createCouponBookDefinitionRequest.html\",\"response\":\"createCouponBookDefinitionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_book_definition(coupon_book_definition, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponBookDefinition coupon_book_definition: The coupon-book-definition object to be created. (required) - :return: CouponBookDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_coupon_book_definition_with_http_info(coupon_book_definition, **kwargs) - else: - (data) = self.create_coupon_book_definition_with_http_info(coupon_book_definition, **kwargs) - return data - - def create_coupon_book_definition_with_http_info(self, coupon_book_definition, **kwargs): - """ - Create a coupon-book-definition. - {\"nickname\":\"Create a new book definition\",\"request\":\"createCouponBookDefinitionRequest.html\",\"response\":\"createCouponBookDefinitionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_book_definition_with_http_info(coupon_book_definition, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponBookDefinition coupon_book_definition: The coupon-book-definition object to be created. (required) - :return: CouponBookDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_book_definition'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_coupon_book_definition" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_book_definition' is set - if ('coupon_book_definition' not in params) or (params['coupon_book_definition'] is None): - raise ValueError("Missing the required parameter `coupon_book_definition` when calling `create_coupon_book_definition`") - - resource_path = '/coupon-book-definitions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'coupon_book_definition' in params: - body_params = params['coupon_book_definition'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookDefinitionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete_coupon_book_definition(self, coupon_book_definition_id, **kwargs): - """ - Retire a coupon-book-definition, specified by the coupon-book-definition-ID parameter. - {\"nickname\":\"Delete book definition\",\"response\":\"deleteCouponBookDefinitionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_coupon_book_definition(coupon_book_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_book_definition_id: ID of the coupon-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponBookDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_coupon_book_definition_with_http_info(coupon_book_definition_id, **kwargs) - else: - (data) = self.delete_coupon_book_definition_with_http_info(coupon_book_definition_id, **kwargs) - return data - - def delete_coupon_book_definition_with_http_info(self, coupon_book_definition_id, **kwargs): - """ - Retire a coupon-book-definition, specified by the coupon-book-definition-ID parameter. - {\"nickname\":\"Delete book definition\",\"response\":\"deleteCouponBookDefinitionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_coupon_book_definition_with_http_info(coupon_book_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_book_definition_id: ID of the coupon-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponBookDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_book_definition_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_coupon_book_definition" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_book_definition_id' is set - if ('coupon_book_definition_id' not in params) or (params['coupon_book_definition_id'] is None): - raise ValueError("Missing the required parameter `coupon_book_definition_id` when calling `delete_coupon_book_definition`") - - resource_path = '/coupon-book-definitions/{coupon-book-definition-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_book_definition_id' in params: - path_params['coupon-book-definition-ID'] = params['coupon_book_definition_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookDefinitionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_coupon_book_definitions(self, **kwargs): - """ - Returns a collection of coupon-book-definitions. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all book definitions\",\"response\":\"getCouponBookDefinitionAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupon_book_definitions(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-book-definitions should be returned. - :return: CouponBookDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_coupon_book_definitions_with_http_info(**kwargs) - else: - (data) = self.get_all_coupon_book_definitions_with_http_info(**kwargs) - return data - - def get_all_coupon_book_definitions_with_http_info(self, **kwargs): - """ - Returns a collection of coupon-book-definitions. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all book definitions\",\"response\":\"getCouponBookDefinitionAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupon_book_definitions_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-book-definitions should be returned. - :return: CouponBookDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_coupon_book_definitions" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/coupon-book-definitions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookDefinitionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_book_definition_by_coupon_definition_id(self, coupon_definition_id, **kwargs): - """ - Returns a collection of coupon-book-definitions, specified by coupon-definition-ID parameter. By default 10 coupon-book-definitions are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by coupon definition\",\"response\":\"getCouponBookDefinitionByCouponDefinitionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_book_definition_by_coupon_definition_id(coupon_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_definition_id: The string coupon-definition-ID of the coupon-book-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-book-definition to return. - :param int records: The maximum number of coupon-book-definitions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-book-definitions should be returned. - :return: CouponBookDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_book_definition_by_coupon_definition_id_with_http_info(coupon_definition_id, **kwargs) - else: - (data) = self.get_coupon_book_definition_by_coupon_definition_id_with_http_info(coupon_definition_id, **kwargs) - return data - - def get_coupon_book_definition_by_coupon_definition_id_with_http_info(self, coupon_definition_id, **kwargs): - """ - Returns a collection of coupon-book-definitions, specified by coupon-definition-ID parameter. By default 10 coupon-book-definitions are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by coupon definition\",\"response\":\"getCouponBookDefinitionByCouponDefinitionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_book_definition_by_coupon_definition_id_with_http_info(coupon_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_definition_id: The string coupon-definition-ID of the coupon-book-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-book-definition to return. - :param int records: The maximum number of coupon-book-definitions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-book-definitions should be returned. - :return: CouponBookDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_definition_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_book_definition_by_coupon_definition_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_definition_id' is set - if ('coupon_definition_id' not in params) or (params['coupon_definition_id'] is None): - raise ValueError("Missing the required parameter `coupon_definition_id` when calling `get_coupon_book_definition_by_coupon_definition_id`") - - resource_path = '/coupon-book-definitions/coupon-definition/{coupon-definition-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_definition_id' in params: - path_params['coupon-definition-ID'] = params['coupon_definition_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookDefinitionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_book_definition_by_id(self, coupon_book_definition_id, **kwargs): - """ - Returns a single coupon-book-definition, specified by the coupon-book-definition-ID parameter. - {\"nickname\":\"Retrieve an existing book definition\",\"response\":\"getCouponBookDefinitionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_book_definition_by_id(coupon_book_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_book_definition_id: ID of the coupon-book-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponBookDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_book_definition_by_id_with_http_info(coupon_book_definition_id, **kwargs) - else: - (data) = self.get_coupon_book_definition_by_id_with_http_info(coupon_book_definition_id, **kwargs) - return data - - def get_coupon_book_definition_by_id_with_http_info(self, coupon_book_definition_id, **kwargs): - """ - Returns a single coupon-book-definition, specified by the coupon-book-definition-ID parameter. - {\"nickname\":\"Retrieve an existing book definition\",\"response\":\"getCouponBookDefinitionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_book_definition_by_id_with_http_info(coupon_book_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_book_definition_id: ID of the coupon-book-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponBookDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_book_definition_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_book_definition_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_book_definition_id' is set - if ('coupon_book_definition_id' not in params) or (params['coupon_book_definition_id'] is None): - raise ValueError("Missing the required parameter `coupon_book_definition_id` when calling `get_coupon_book_definition_by_id`") - - resource_path = '/coupon-book-definitions/{coupon-book-definition-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_book_definition_id' in params: - path_params['coupon-book-definition-ID'] = params['coupon_book_definition_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookDefinitionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_coupon_book_definition(self, coupon_book_definition, **kwargs): - """ - Update a coupon-book-definition. - {\"nickname\":\"Update a book definition\",\"request\":\"updateCouponBookDefinitionRequest.html\",\"response\":\"updateCouponBookDefinitionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_coupon_book_definition(coupon_book_definition, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponBookDefinition coupon_book_definition: The coupon-book-definition object to be updated. (required) - :return: CouponBookDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_coupon_book_definition_with_http_info(coupon_book_definition, **kwargs) - else: - (data) = self.update_coupon_book_definition_with_http_info(coupon_book_definition, **kwargs) - return data - - def update_coupon_book_definition_with_http_info(self, coupon_book_definition, **kwargs): - """ - Update a coupon-book-definition. - {\"nickname\":\"Update a book definition\",\"request\":\"updateCouponBookDefinitionRequest.html\",\"response\":\"updateCouponBookDefinitionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_coupon_book_definition_with_http_info(coupon_book_definition, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponBookDefinition coupon_book_definition: The coupon-book-definition object to be updated. (required) - :return: CouponBookDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_book_definition'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_coupon_book_definition" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_book_definition' is set - if ('coupon_book_definition' not in params) or (params['coupon_book_definition'] is None): - raise ValueError("Missing the required parameter `coupon_book_definition` when calling `update_coupon_book_definition`") - - resource_path = '/coupon-book-definitions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'coupon_book_definition' in params: - body_params = params['coupon_book_definition'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponBookDefinitionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/coupondefinition_api.py b/billforward/apis/coupondefinition_api.py deleted file mode 100644 index b801434..0000000 --- a/billforward/apis/coupondefinition_api.py +++ /dev/null @@ -1,596 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class CoupondefinitionApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_coupon_definition(self, coupon_definition, **kwargs): - """ - Create a coupon-definition. - {\"nickname\":\"Create a new definition\",\"request\":\"createCouponDefinitionRequest.html\",\"response\":\"createCouponDefinitionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_definition(coupon_definition, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponDefinition coupon_definition: The coupon-definiton object to be created. (required) - :return: CouponDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_coupon_definition_with_http_info(coupon_definition, **kwargs) - else: - (data) = self.create_coupon_definition_with_http_info(coupon_definition, **kwargs) - return data - - def create_coupon_definition_with_http_info(self, coupon_definition, **kwargs): - """ - Create a coupon-definition. - {\"nickname\":\"Create a new definition\",\"request\":\"createCouponDefinitionRequest.html\",\"response\":\"createCouponDefinitionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_definition_with_http_info(coupon_definition, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponDefinition coupon_definition: The coupon-definiton object to be created. (required) - :return: CouponDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_definition'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_coupon_definition" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_definition' is set - if ('coupon_definition' not in params) or (params['coupon_definition'] is None): - raise ValueError("Missing the required parameter `coupon_definition` when calling `create_coupon_definition`") - - resource_path = '/coupon-definitions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'coupon_definition' in params: - body_params = params['coupon_definition'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponDefinitionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete_coupon_definition(self, coupon_definition_id, **kwargs): - """ - Retire a coupon-definition, specified by the coupon-definition-ID parameter. - {\"nickname\":\"Delete a definition\",\"response\":\"deleteCouponDefinitionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_coupon_definition(coupon_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_definition_id: ID of the coupon-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_coupon_definition_with_http_info(coupon_definition_id, **kwargs) - else: - (data) = self.delete_coupon_definition_with_http_info(coupon_definition_id, **kwargs) - return data - - def delete_coupon_definition_with_http_info(self, coupon_definition_id, **kwargs): - """ - Retire a coupon-definition, specified by the coupon-definition-ID parameter. - {\"nickname\":\"Delete a definition\",\"response\":\"deleteCouponDefinitionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_coupon_definition_with_http_info(coupon_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_definition_id: ID of the coupon-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_definition_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_coupon_definition" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_definition_id' is set - if ('coupon_definition_id' not in params) or (params['coupon_definition_id'] is None): - raise ValueError("Missing the required parameter `coupon_definition_id` when calling `delete_coupon_definition`") - - resource_path = '/coupon-definitions/{coupon-definition-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_definition_id' in params: - path_params['coupon-definition-ID'] = params['coupon_definition_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponDefinitionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_coupon_definitions(self, **kwargs): - """ - Returns a collection of coupon-definitions. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all coupon definitions\",\"response\":\"getCouponDefinitionAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupon_definitions(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-definitions should be returned. - :return: CouponDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_coupon_definitions_with_http_info(**kwargs) - else: - (data) = self.get_all_coupon_definitions_with_http_info(**kwargs) - return data - - def get_all_coupon_definitions_with_http_info(self, **kwargs): - """ - Returns a collection of coupon-definitions. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all coupon definitions\",\"response\":\"getCouponDefinitionAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupon_definitions_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-definitions should be returned. - :return: CouponDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_coupon_definitions" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/coupon-definitions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponDefinitionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_definition_by_id(self, coupon_definition_id, **kwargs): - """ - Returns a single coupon-definition, specified by the coupon-definition-ID parameter. - {\"nickname\":\"Get existing coupon definition\",\"response\":\"getCouponDefinitionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_definition_by_id(coupon_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_definition_id: ID of the coupon-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_definition_by_id_with_http_info(coupon_definition_id, **kwargs) - else: - (data) = self.get_coupon_definition_by_id_with_http_info(coupon_definition_id, **kwargs) - return data - - def get_coupon_definition_by_id_with_http_info(self, coupon_definition_id, **kwargs): - """ - Returns a single coupon-definition, specified by the coupon-definition-ID parameter. - {\"nickname\":\"Get existing coupon definition\",\"response\":\"getCouponDefinitionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_definition_by_id_with_http_info(coupon_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_definition_id: ID of the coupon-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_definition_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_definition_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_definition_id' is set - if ('coupon_definition_id' not in params) or (params['coupon_definition_id'] is None): - raise ValueError("Missing the required parameter `coupon_definition_id` when calling `get_coupon_definition_by_id`") - - resource_path = '/coupon-definitions/{coupon-definition-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_definition_id' in params: - path_params['coupon-definition-ID'] = params['coupon_definition_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponDefinitionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_coupon_definition(self, coupon_definition, **kwargs): - """ - Update a coupon-definition. - {\"nickname\":\"Update a definition\",\"request\":\"updateCouponDefinitionRequest.html\",\"response\":\"updateCouponDefinitionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_coupon_definition(coupon_definition, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponDefinition coupon_definition: The coupon-definition object to be updated. (required) - :return: CouponDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_coupon_definition_with_http_info(coupon_definition, **kwargs) - else: - (data) = self.update_coupon_definition_with_http_info(coupon_definition, **kwargs) - return data - - def update_coupon_definition_with_http_info(self, coupon_definition, **kwargs): - """ - Update a coupon-definition. - {\"nickname\":\"Update a definition\",\"request\":\"updateCouponDefinitionRequest.html\",\"response\":\"updateCouponDefinitionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_coupon_definition_with_http_info(coupon_definition, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponDefinition coupon_definition: The coupon-definition object to be updated. (required) - :return: CouponDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_definition'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_coupon_definition" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_definition' is set - if ('coupon_definition' not in params) or (params['coupon_definition'] is None): - raise ValueError("Missing the required parameter `coupon_definition` when calling `update_coupon_definition`") - - resource_path = '/coupon-definitions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'coupon_definition' in params: - body_params = params['coupon_definition'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponDefinitionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/couponinstance_api.py b/billforward/apis/couponinstance_api.py deleted file mode 100644 index 52ed674..0000000 --- a/billforward/apis/couponinstance_api.py +++ /dev/null @@ -1,1239 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class CouponinstanceApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_coupon_instance(self, coupon_instance, **kwargs): - """ - Create a coupon-instance. - {\"nickname\":\"Create a new coupon\",\"request\":\"createCouponInstanceRequest.html\",\"response\":\"createCouponInstanceResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_instance(coupon_instance, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponInstance coupon_instance: The coupon-instance object to be created. (required) - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_coupon_instance_with_http_info(coupon_instance, **kwargs) - else: - (data) = self.create_coupon_instance_with_http_info(coupon_instance, **kwargs) - return data - - def create_coupon_instance_with_http_info(self, coupon_instance, **kwargs): - """ - Create a coupon-instance. - {\"nickname\":\"Create a new coupon\",\"request\":\"createCouponInstanceRequest.html\",\"response\":\"createCouponInstanceResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_instance_with_http_info(coupon_instance, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponInstance coupon_instance: The coupon-instance object to be created. (required) - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_instance'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_coupon_instance" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_instance' is set - if ('coupon_instance' not in params) or (params['coupon_instance'] is None): - raise ValueError("Missing the required parameter `coupon_instance` when calling `create_coupon_instance`") - - resource_path = '/coupon-instances'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'coupon_instance' in params: - body_params = params['coupon_instance'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponInstancePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete_coupon_instance(self, coupon_instance_id, **kwargs): - """ - Retire a coupon-instance, specified by the coupon-instance-ID parameter. - {\"nickname\":\"Delete a coupon\",\"response\":\"deleteCouponInstanceByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_coupon_instance(coupon_instance_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_instance_id: ID of the coupon-instance. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_coupon_instance_with_http_info(coupon_instance_id, **kwargs) - else: - (data) = self.delete_coupon_instance_with_http_info(coupon_instance_id, **kwargs) - return data - - def delete_coupon_instance_with_http_info(self, coupon_instance_id, **kwargs): - """ - Retire a coupon-instance, specified by the coupon-instance-ID parameter. - {\"nickname\":\"Delete a coupon\",\"response\":\"deleteCouponInstanceByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_coupon_instance_with_http_info(coupon_instance_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_instance_id: ID of the coupon-instance. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_instance_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_coupon_instance" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_instance_id' is set - if ('coupon_instance_id' not in params) or (params['coupon_instance_id'] is None): - raise ValueError("Missing the required parameter `coupon_instance_id` when calling `delete_coupon_instance`") - - resource_path = '/coupon-instances/{coupon-instance-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_instance_id' in params: - path_params['coupon-instance-ID'] = params['coupon_instance_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponInstancePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_attachable_coupon_instances(self, attachableness, has_code, **kwargs): - """ - Returns a collection of attachable coupon-instances. An attachable coupon-instance has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get attachable coupons\",\"response\":\"getCouponInstanceAllAttachable.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_attachable_coupon_instances(attachableness, has_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param bool attachableness: The attachableness of the coupon-instance. (required) - :param bool has_code: Whether the coupon-instances have coupon codes or not. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-instance to return. - :param int records: The maximum number of coupon-instances to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_attachable_coupon_instances_with_http_info(attachableness, has_code, **kwargs) - else: - (data) = self.get_all_attachable_coupon_instances_with_http_info(attachableness, has_code, **kwargs) - return data - - def get_all_attachable_coupon_instances_with_http_info(self, attachableness, has_code, **kwargs): - """ - Returns a collection of attachable coupon-instances. An attachable coupon-instance has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get attachable coupons\",\"response\":\"getCouponInstanceAllAttachable.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_attachable_coupon_instances_with_http_info(attachableness, has_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param bool attachableness: The attachableness of the coupon-instance. (required) - :param bool has_code: Whether the coupon-instances have coupon codes or not. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-instance to return. - :param int records: The maximum number of coupon-instances to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['attachableness', 'has_code', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_attachable_coupon_instances" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'attachableness' is set - if ('attachableness' not in params) or (params['attachableness'] is None): - raise ValueError("Missing the required parameter `attachableness` when calling `get_all_attachable_coupon_instances`") - # verify the required parameter 'has_code' is set - if ('has_code' not in params) or (params['has_code'] is None): - raise ValueError("Missing the required parameter `has_code` when calling `get_all_attachable_coupon_instances`") - - resource_path = '/coupon-instances/attachable/{attachableness}/{has_code}'.replace('{format}', 'json') - path_params = {} - if 'attachableness' in params: - path_params['attachableness'] = params['attachableness'] - if 'has_code' in params: - path_params['has_code'] = params['has_code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponInstancePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_coupon_instances(self, **kwargs): - """ - Returns a collection of coupon-instances. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all coupons\",\"response\":\"getCouponInstanceAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupon_instances(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-instance to return. - :param int records: The maximum number of coupon-instances to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-instances should be returned. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_coupon_instances_with_http_info(**kwargs) - else: - (data) = self.get_all_coupon_instances_with_http_info(**kwargs) - return data - - def get_all_coupon_instances_with_http_info(self, **kwargs): - """ - Returns a collection of coupon-instances. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all coupons\",\"response\":\"getCouponInstanceAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupon_instances_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-instance to return. - :param int records: The maximum number of coupon-instances to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-instances should be returned. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_coupon_instances" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/coupon-instances'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponInstancePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_instance_by_coupon_code(self, coupon_code, **kwargs): - """ - Returns a collection of coupon-instances, specified by coupon-code parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by coupon code\",\"response\":\"getCouponInstanceByCouponCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_instance_by_coupon_code(coupon_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_code: The string coupon-code of the coupon-instance. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-instance to return. - :param int records: The maximum number of coupon-instances to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-instances should be returned. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_instance_by_coupon_code_with_http_info(coupon_code, **kwargs) - else: - (data) = self.get_coupon_instance_by_coupon_code_with_http_info(coupon_code, **kwargs) - return data - - def get_coupon_instance_by_coupon_code_with_http_info(self, coupon_code, **kwargs): - """ - Returns a collection of coupon-instances, specified by coupon-code parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by coupon code\",\"response\":\"getCouponInstanceByCouponCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_instance_by_coupon_code_with_http_info(coupon_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_code: The string coupon-code of the coupon-instance. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-instance to return. - :param int records: The maximum number of coupon-instances to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-instances should be returned. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_code', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_instance_by_coupon_code" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_code' is set - if ('coupon_code' not in params) or (params['coupon_code'] is None): - raise ValueError("Missing the required parameter `coupon_code` when calling `get_coupon_instance_by_coupon_code`") - - resource_path = '/coupon-instances/coupon/{coupon-code}'.replace('{format}', 'json') - path_params = {} - if 'coupon_code' in params: - path_params['coupon-code'] = params['coupon_code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponInstancePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_instance_by_coupon_definition_id(self, coupon_definition_id, **kwargs): - """ - Returns a collection of coupon-instances, specified by coupon-definition-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by coupon definition\",\"response\":\"getCouponInstanceByCouponDefinitionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_instance_by_coupon_definition_id(coupon_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_definition_id: The string coupon-definition-ID of the coupon-instance. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-instance to return. - :param int records: The maximum number of coupon-instances to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-instances should be returned. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_instance_by_coupon_definition_id_with_http_info(coupon_definition_id, **kwargs) - else: - (data) = self.get_coupon_instance_by_coupon_definition_id_with_http_info(coupon_definition_id, **kwargs) - return data - - def get_coupon_instance_by_coupon_definition_id_with_http_info(self, coupon_definition_id, **kwargs): - """ - Returns a collection of coupon-instances, specified by coupon-definition-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by coupon definition\",\"response\":\"getCouponInstanceByCouponDefinitionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_instance_by_coupon_definition_id_with_http_info(coupon_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_definition_id: The string coupon-definition-ID of the coupon-instance. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-instance to return. - :param int records: The maximum number of coupon-instances to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-instances should be returned. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_definition_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_instance_by_coupon_definition_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_definition_id' is set - if ('coupon_definition_id' not in params) or (params['coupon_definition_id'] is None): - raise ValueError("Missing the required parameter `coupon_definition_id` when calling `get_coupon_instance_by_coupon_definition_id`") - - resource_path = '/coupon-instances/coupon-definition/{coupon-definition-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_definition_id' in params: - path_params['coupon-definition-ID'] = params['coupon_definition_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponInstancePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_instance_by_id(self, coupon_instance_id, **kwargs): - """ - Returns a single coupon-instance, specified by the coupon-instance-ID parameter. - {\"nickname\":\"Get existing coupon\",\"response\":\"getCouponInstanceByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_instance_by_id(coupon_instance_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_instance_id: ID of the coupon-instance. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_instance_by_id_with_http_info(coupon_instance_id, **kwargs) - else: - (data) = self.get_coupon_instance_by_id_with_http_info(coupon_instance_id, **kwargs) - return data - - def get_coupon_instance_by_id_with_http_info(self, coupon_instance_id, **kwargs): - """ - Returns a single coupon-instance, specified by the coupon-instance-ID parameter. - {\"nickname\":\"Get existing coupon\",\"response\":\"getCouponInstanceByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_instance_by_id_with_http_info(coupon_instance_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_instance_id: ID of the coupon-instance. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_instance_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_instance_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_instance_id' is set - if ('coupon_instance_id' not in params) or (params['coupon_instance_id'] is None): - raise ValueError("Missing the required parameter `coupon_instance_id` when calling `get_coupon_instance_by_id`") - - resource_path = '/coupon-instances/{coupon-instance-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_instance_id' in params: - path_params['coupon-instance-ID'] = params['coupon_instance_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponInstancePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_instance_by_target_id(self, target_id, **kwargs): - """ - Returns a collection of coupon-instances, specified by target-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by target\",\"response\":\"getCouponInstanceByTargetID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_instance_by_target_id(target_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str target_id: The string target-ID of the coupon-instance. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-instance to return. - :param int records: The maximum number of coupon-instances to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-instances should be returned. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_instance_by_target_id_with_http_info(target_id, **kwargs) - else: - (data) = self.get_coupon_instance_by_target_id_with_http_info(target_id, **kwargs) - return data - - def get_coupon_instance_by_target_id_with_http_info(self, target_id, **kwargs): - """ - Returns a collection of coupon-instances, specified by target-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by target\",\"response\":\"getCouponInstanceByTargetID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_instance_by_target_id_with_http_info(target_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str target_id: The string target-ID of the coupon-instance. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-instance to return. - :param int records: The maximum number of coupon-instances to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-instances should be returned. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['target_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_instance_by_target_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'target_id' is set - if ('target_id' not in params) or (params['target_id'] is None): - raise ValueError("Missing the required parameter `target_id` when calling `get_coupon_instance_by_target_id`") - - resource_path = '/coupon-instances/target/{target-ID}'.replace('{format}', 'json') - path_params = {} - if 'target_id' in params: - path_params['target-ID'] = params['target_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponInstancePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_instance_by_target_type(self, target, **kwargs): - """ - Returns a collection of coupon-instances, specified by target parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by target type\",\"response\":\"getCouponInstanceByTarget.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_instance_by_target_type(target, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str target: The string target of the coupon-instance. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-instance to return. - :param int records: The maximum number of coupon-instances to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-instances should be returned. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_instance_by_target_type_with_http_info(target, **kwargs) - else: - (data) = self.get_coupon_instance_by_target_type_with_http_info(target, **kwargs) - return data - - def get_coupon_instance_by_target_type_with_http_info(self, target, **kwargs): - """ - Returns a collection of coupon-instances, specified by target parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by target type\",\"response\":\"getCouponInstanceByTarget.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_instance_by_target_type_with_http_info(target, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str target: The string target of the coupon-instance. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first coupon-instance to return. - :param int records: The maximum number of coupon-instances to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired coupon-instances should be returned. - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['target', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_instance_by_target_type" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'target' is set - if ('target' not in params) or (params['target'] is None): - raise ValueError("Missing the required parameter `target` when calling `get_coupon_instance_by_target_type`") - - resource_path = '/coupon-instances/target-entity/{target}'.replace('{format}', 'json') - path_params = {} - if 'target' in params: - path_params['target'] = params['target'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponInstancePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_coupon_instance(self, coupon_instance, **kwargs): - """ - Update a coupon-instance. - {\"nickname\":\"Update a coupon\",\"request\":\"updateCouponInstanceRequest.html\",\"response\":\"updateCouponInstanceResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_coupon_instance(coupon_instance, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponInstance coupon_instance: The coupon-instance object to be updated. (required) - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_coupon_instance_with_http_info(coupon_instance, **kwargs) - else: - (data) = self.update_coupon_instance_with_http_info(coupon_instance, **kwargs) - return data - - def update_coupon_instance_with_http_info(self, coupon_instance, **kwargs): - """ - Update a coupon-instance. - {\"nickname\":\"Update a coupon\",\"request\":\"updateCouponInstanceRequest.html\",\"response\":\"updateCouponInstanceResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_coupon_instance_with_http_info(coupon_instance, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponInstance coupon_instance: The coupon-instance object to be updated. (required) - :return: CouponInstancePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_instance'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_coupon_instance" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_instance' is set - if ('coupon_instance' not in params) or (params['coupon_instance'] is None): - raise ValueError("Missing the required parameter `coupon_instance` when calling `update_coupon_instance`") - - resource_path = '/coupon-instances'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'coupon_instance' in params: - body_params = params['coupon_instance'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponInstancePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/couponmodifier_api.py b/billforward/apis/couponmodifier_api.py deleted file mode 100644 index d743cca..0000000 --- a/billforward/apis/couponmodifier_api.py +++ /dev/null @@ -1,808 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class CouponmodifierApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_coupon_modifier(self, coupon_instance, **kwargs): - """ - Create a coupon-modifier. - {\"nickname\":\"Create a new modifier\",\"request\":\"createCouponModifierRequest.html\",\"response\":\"createCouponModifierResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_modifier(coupon_instance, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponModifierBase coupon_instance: The coupon-instance object to be created. (required) - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_coupon_modifier_with_http_info(coupon_instance, **kwargs) - else: - (data) = self.create_coupon_modifier_with_http_info(coupon_instance, **kwargs) - return data - - def create_coupon_modifier_with_http_info(self, coupon_instance, **kwargs): - """ - Create a coupon-modifier. - {\"nickname\":\"Create a new modifier\",\"request\":\"createCouponModifierRequest.html\",\"response\":\"createCouponModifierResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_modifier_with_http_info(coupon_instance, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponModifierBase coupon_instance: The coupon-instance object to be created. (required) - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_instance'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_coupon_modifier" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_instance' is set - if ('coupon_instance' not in params) or (params['coupon_instance'] is None): - raise ValueError("Missing the required parameter `coupon_instance` when calling `create_coupon_modifier`") - - resource_path = '/coupon-modifiers'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'coupon_instance' in params: - body_params = params['coupon_instance'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponModifierBasePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete_coupon_modifier(self, coupon_modifier_id, **kwargs): - """ - Retire a coupon-modifier, specified by the coupon-modifier-ID parameter. - {\"nickname\":\"Delete a modifier\",\"response\":\"deleteCouponModifierByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_coupon_modifier(coupon_modifier_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_modifier_id: ID of the coupon-modifier. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_coupon_modifier_with_http_info(coupon_modifier_id, **kwargs) - else: - (data) = self.delete_coupon_modifier_with_http_info(coupon_modifier_id, **kwargs) - return data - - def delete_coupon_modifier_with_http_info(self, coupon_modifier_id, **kwargs): - """ - Retire a coupon-modifier, specified by the coupon-modifier-ID parameter. - {\"nickname\":\"Delete a modifier\",\"response\":\"deleteCouponModifierByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_coupon_modifier_with_http_info(coupon_modifier_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_modifier_id: ID of the coupon-modifier. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_modifier_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_coupon_modifier" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_modifier_id' is set - if ('coupon_modifier_id' not in params) or (params['coupon_modifier_id'] is None): - raise ValueError("Missing the required parameter `coupon_modifier_id` when calling `delete_coupon_modifier`") - - resource_path = '/coupon-modifiers/{coupon-modifier-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_modifier_id' in params: - path_params['coupon-modifier-ID'] = params['coupon_modifier_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponModifierBasePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_coupon_modifiers(self, **kwargs): - """ - Returns a collection of coupon-modifiers. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all modifiers\",\"response\":\"getCouponModifierAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupon_modifiers(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_coupon_modifiers_with_http_info(**kwargs) - else: - (data) = self.get_all_coupon_modifiers_with_http_info(**kwargs) - return data - - def get_all_coupon_modifiers_with_http_info(self, **kwargs): - """ - Returns a collection of coupon-modifiers. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all modifiers\",\"response\":\"getCouponModifierAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupon_modifiers_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_coupon_modifiers" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/coupon-modifiers'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponModifierBasePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_modifier_by_coupon_code(self, coupon_code, **kwargs): - """ - Returns a collection of coupon-modifiers, specified by the coupon-code parameter. - {\"nickname\":\"Retrieve by coupon code\",\"response\":\"getCouponCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_modifier_by_coupon_code(coupon_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_code: The coupon-code. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_modifier_by_coupon_code_with_http_info(coupon_code, **kwargs) - else: - (data) = self.get_coupon_modifier_by_coupon_code_with_http_info(coupon_code, **kwargs) - return data - - def get_coupon_modifier_by_coupon_code_with_http_info(self, coupon_code, **kwargs): - """ - Returns a collection of coupon-modifiers, specified by the coupon-code parameter. - {\"nickname\":\"Retrieve by coupon code\",\"response\":\"getCouponCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_modifier_by_coupon_code_with_http_info(coupon_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_code: The coupon-code. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_code', 'organizations', 'offset', 'records'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_modifier_by_coupon_code" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_code' is set - if ('coupon_code' not in params) or (params['coupon_code'] is None): - raise ValueError("Missing the required parameter `coupon_code` when calling `get_coupon_modifier_by_coupon_code`") - - resource_path = '/coupon-modifiers/coupon-code/{coupon-code}'.replace('{format}', 'json') - path_params = {} - if 'coupon_code' in params: - path_params['coupon-code'] = params['coupon_code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponModifierBasePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_modifier_by_coupon_definition_id(self, coupon_definition_id, **kwargs): - """ - Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter. - {\"nickname\":\"Retrieve by coupon definition\",\"response\":\"getCouponModifierByCouponDefinitionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_modifier_by_coupon_definition_id(coupon_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_definition_id: ID of the coupon-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_modifier_by_coupon_definition_id_with_http_info(coupon_definition_id, **kwargs) - else: - (data) = self.get_coupon_modifier_by_coupon_definition_id_with_http_info(coupon_definition_id, **kwargs) - return data - - def get_coupon_modifier_by_coupon_definition_id_with_http_info(self, coupon_definition_id, **kwargs): - """ - Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter. - {\"nickname\":\"Retrieve by coupon definition\",\"response\":\"getCouponModifierByCouponDefinitionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_modifier_by_coupon_definition_id_with_http_info(coupon_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_definition_id: ID of the coupon-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_definition_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_modifier_by_coupon_definition_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_definition_id' is set - if ('coupon_definition_id' not in params) or (params['coupon_definition_id'] is None): - raise ValueError("Missing the required parameter `coupon_definition_id` when calling `get_coupon_modifier_by_coupon_definition_id`") - - resource_path = '/coupon-modifiers/coupon-definition/{coupon-definition-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_definition_id' in params: - path_params['coupon-definition-ID'] = params['coupon_definition_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponModifierBasePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_modifier_by_id(self, coupon_modifier_id, **kwargs): - """ - Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter. - {\"nickname\":\"Get existing modifier\",\"response\":\"getCouponModifierByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_modifier_by_id(coupon_modifier_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_modifier_id: ID of the coupon-modifier. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_modifier_by_id_with_http_info(coupon_modifier_id, **kwargs) - else: - (data) = self.get_coupon_modifier_by_id_with_http_info(coupon_modifier_id, **kwargs) - return data - - def get_coupon_modifier_by_id_with_http_info(self, coupon_modifier_id, **kwargs): - """ - Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter. - {\"nickname\":\"Get existing modifier\",\"response\":\"getCouponModifierByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_modifier_by_id_with_http_info(coupon_modifier_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_modifier_id: ID of the coupon-modifier. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_modifier_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_modifier_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_modifier_id' is set - if ('coupon_modifier_id' not in params) or (params['coupon_modifier_id'] is None): - raise ValueError("Missing the required parameter `coupon_modifier_id` when calling `get_coupon_modifier_by_id`") - - resource_path = '/coupon-modifiers/{coupon-modifier-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_modifier_id' in params: - path_params['coupon-modifier-ID'] = params['coupon_modifier_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponModifierBasePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_coupon_modifier(self, coupon_instance, **kwargs): - """ - Update a coupon-instance. - {\"nickname\":\"Update a modifier\",\"request\":\"updateCouponInstanceRequest.html\",\"response\":\"updateCouponInstanceResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_coupon_modifier(coupon_instance, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponModifierBase coupon_instance: The coupon-instance object to be updated. (required) - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_coupon_modifier_with_http_info(coupon_instance, **kwargs) - else: - (data) = self.update_coupon_modifier_with_http_info(coupon_instance, **kwargs) - return data - - def update_coupon_modifier_with_http_info(self, coupon_instance, **kwargs): - """ - Update a coupon-instance. - {\"nickname\":\"Update a modifier\",\"request\":\"updateCouponInstanceRequest.html\",\"response\":\"updateCouponInstanceResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_coupon_modifier_with_http_info(coupon_instance, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponModifierBase coupon_instance: The coupon-instance object to be updated. (required) - :return: CouponModifierBasePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_instance'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_coupon_modifier" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_instance' is set - if ('coupon_instance' not in params) or (params['coupon_instance'] is None): - raise ValueError("Missing the required parameter `coupon_instance` when calling `update_coupon_modifier`") - - resource_path = '/coupon-modifiers'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'coupon_instance' in params: - body_params = params['coupon_instance'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponModifierBasePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/couponrule_api.py b/billforward/apis/couponrule_api.py deleted file mode 100644 index 8426b43..0000000 --- a/billforward/apis/couponrule_api.py +++ /dev/null @@ -1,596 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class CouponruleApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_coupon_rule(self, coupon_rule, **kwargs): - """ - Create a coupon-rule. - {\"nickname\":\"Create a new rule\", \"request\" : \"createCouponRuleRequest.html\" ,\"response\" : \"createCouponRuleResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_rule(coupon_rule, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponRule coupon_rule: The coupon-rule object to be created. (required) - :return: CouponRulePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_coupon_rule_with_http_info(coupon_rule, **kwargs) - else: - (data) = self.create_coupon_rule_with_http_info(coupon_rule, **kwargs) - return data - - def create_coupon_rule_with_http_info(self, coupon_rule, **kwargs): - """ - Create a coupon-rule. - {\"nickname\":\"Create a new rule\", \"request\" : \"createCouponRuleRequest.html\" ,\"response\" : \"createCouponRuleResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_rule_with_http_info(coupon_rule, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CouponRule coupon_rule: The coupon-rule object to be created. (required) - :return: CouponRulePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_rule'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_coupon_rule" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_rule' is set - if ('coupon_rule' not in params) or (params['coupon_rule'] is None): - raise ValueError("Missing the required parameter `coupon_rule` when calling `create_coupon_rule`") - - resource_path = '/coupon-rules'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'coupon_rule' in params: - body_params = params['coupon_rule'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponRulePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete_coupon_rule(self, coupon_rule_id, **kwargs): - """ - Retire a coupon-rule, specified by the coupon-rule-ID parameter. - {\"nickname\":\"Delete a rule\",\"response\" : \"deleteCouponRuleByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_coupon_rule(coupon_rule_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_rule_id: ID of the coupon-rule. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponRulePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_coupon_rule_with_http_info(coupon_rule_id, **kwargs) - else: - (data) = self.delete_coupon_rule_with_http_info(coupon_rule_id, **kwargs) - return data - - def delete_coupon_rule_with_http_info(self, coupon_rule_id, **kwargs): - """ - Retire a coupon-rule, specified by the coupon-rule-ID parameter. - {\"nickname\":\"Delete a rule\",\"response\" : \"deleteCouponRuleByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_coupon_rule_with_http_info(coupon_rule_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_rule_id: ID of the coupon-rule. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponRulePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_rule_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_coupon_rule" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_rule_id' is set - if ('coupon_rule_id' not in params) or (params['coupon_rule_id'] is None): - raise ValueError("Missing the required parameter `coupon_rule_id` when calling `delete_coupon_rule`") - - resource_path = '/coupon-rules/{coupon-rule-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_rule_id' in params: - path_params['coupon-rule-ID'] = params['coupon_rule_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponRulePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_coupon_rules(self, **kwargs): - """ - Returns a collection of coupon-rules. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all rules\",\"response\" : \"getCouponRuleAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupon_rules(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: CouponRulePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_coupon_rules_with_http_info(**kwargs) - else: - (data) = self.get_all_coupon_rules_with_http_info(**kwargs) - return data - - def get_all_coupon_rules_with_http_info(self, **kwargs): - """ - Returns a collection of coupon-rules. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all rules\",\"response\" : \"getCouponRuleAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupon_rules_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: CouponRulePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_coupon_rules" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/coupon-rules'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponRulePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_rule_by_coupon_definition_id(self, coupon_definition_id, **kwargs): - """ - Returns a single coupon-definition, specified by the coupon-definition-ID parameter. - {\"nickname\":\"Retrieve by coupon definition\",\"response\" : \"getCouponRuleByCouponDefinitionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_rule_by_coupon_definition_id(coupon_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_definition_id: ID of the coupon-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponRulePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_rule_by_coupon_definition_id_with_http_info(coupon_definition_id, **kwargs) - else: - (data) = self.get_coupon_rule_by_coupon_definition_id_with_http_info(coupon_definition_id, **kwargs) - return data - - def get_coupon_rule_by_coupon_definition_id_with_http_info(self, coupon_definition_id, **kwargs): - """ - Returns a single coupon-definition, specified by the coupon-definition-ID parameter. - {\"nickname\":\"Retrieve by coupon definition\",\"response\" : \"getCouponRuleByCouponDefinitionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_rule_by_coupon_definition_id_with_http_info(coupon_definition_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_definition_id: ID of the coupon-definition. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponRulePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_definition_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_rule_by_coupon_definition_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_definition_id' is set - if ('coupon_definition_id' not in params) or (params['coupon_definition_id'] is None): - raise ValueError("Missing the required parameter `coupon_definition_id` when calling `get_coupon_rule_by_coupon_definition_id`") - - resource_path = '/coupon-rules/coupon-definition/{coupon-definition-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_definition_id' in params: - path_params['coupon-definition-ID'] = params['coupon_definition_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponRulePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_rule_by_id(self, coupon_rule_id, **kwargs): - """ - Returns a single coupon-rule, specified by the coupon-rule-ID parameter. - {\"nickname\":\"Retrieve an existing rule\",\"response\" : \"getCouponRuleByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_rule_by_id(coupon_rule_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_rule_id: ID of the coupon-rule. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponRulePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_rule_by_id_with_http_info(coupon_rule_id, **kwargs) - else: - (data) = self.get_coupon_rule_by_id_with_http_info(coupon_rule_id, **kwargs) - return data - - def get_coupon_rule_by_id_with_http_info(self, coupon_rule_id, **kwargs): - """ - Returns a single coupon-rule, specified by the coupon-rule-ID parameter. - {\"nickname\":\"Retrieve an existing rule\",\"response\" : \"getCouponRuleByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_rule_by_id_with_http_info(coupon_rule_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str coupon_rule_id: ID of the coupon-rule. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponRulePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_rule_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_rule_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_rule_id' is set - if ('coupon_rule_id' not in params) or (params['coupon_rule_id'] is None): - raise ValueError("Missing the required parameter `coupon_rule_id` when calling `get_coupon_rule_by_id`") - - resource_path = '/coupon-rules/{coupon-rule-ID}'.replace('{format}', 'json') - path_params = {} - if 'coupon_rule_id' in params: - path_params['coupon-rule-ID'] = params['coupon_rule_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponRulePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/coupons_api.py b/billforward/apis/coupons_api.py deleted file mode 100644 index 3cc40b1..0000000 --- a/billforward/apis/coupons_api.py +++ /dev/null @@ -1,987 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class CouponsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_coupon(self, code, **kwargs): - """ - Create a coupon. - {\"nickname\":\"Create a new coupon\",\"request\":\"createCouponRequest.html\",\"response\":\"createCouponResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon(code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Coupon code: The coupon object to be created. (required) - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_coupon_with_http_info(code, **kwargs) - else: - (data) = self.create_coupon_with_http_info(code, **kwargs) - return data - - def create_coupon_with_http_info(self, code, **kwargs): - """ - Create a coupon. - {\"nickname\":\"Create a new coupon\",\"request\":\"createCouponRequest.html\",\"response\":\"createCouponResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_with_http_info(code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Coupon code: The coupon object to be created. (required) - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['code'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_coupon" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'code' is set - if ('code' not in params) or (params['code'] is None): - raise ValueError("Missing the required parameter `code` when calling `create_coupon`") - - resource_path = '/coupons'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'code' in params: - body_params = params['code'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def create_coupon_unique_codes(self, code, **kwargs): - """ - Create a list of unique coupon codes that can be applied to a subscription. - { \"nickname\":\"Create unique coupon codes\",\"request\":\"createUniqueCodesRequest.html\",\"response\":\"createUniqueCodesResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_unique_codes(code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str code: The coupon code to use in the generation of the unique codes. (required) - :param CouponUniqueCodesRequest request: The request object that specifies the number of codes to be created. - :return: CouponUniqueCodesResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_coupon_unique_codes_with_http_info(code, **kwargs) - else: - (data) = self.create_coupon_unique_codes_with_http_info(code, **kwargs) - return data - - def create_coupon_unique_codes_with_http_info(self, code, **kwargs): - """ - Create a list of unique coupon codes that can be applied to a subscription. - { \"nickname\":\"Create unique coupon codes\",\"request\":\"createUniqueCodesRequest.html\",\"response\":\"createUniqueCodesResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_coupon_unique_codes_with_http_info(code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str code: The coupon code to use in the generation of the unique codes. (required) - :param CouponUniqueCodesRequest request: The request object that specifies the number of codes to be created. - :return: CouponUniqueCodesResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['code', 'request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_coupon_unique_codes" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'code' is set - if ('code' not in params) or (params['code'] is None): - raise ValueError("Missing the required parameter `code` when calling `create_coupon_unique_codes`") - - resource_path = '/coupons/{code}/codes'.replace('{format}', 'json') - path_params = {} - if 'code' in params: - path_params['code'] = params['code'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponUniqueCodesResponsePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_coupons(self, **kwargs): - """ - Returns a collection of all coupons. By default 10 values are returned. Records are returned in natural order. - { \"nickname\":\"Retrieve all coupons\",\"response\":\"getCouponAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupons(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_coupons_with_http_info(**kwargs) - else: - (data) = self.get_all_coupons_with_http_info(**kwargs) - return data - - def get_all_coupons_with_http_info(self, **kwargs): - """ - Returns a collection of all coupons. By default 10 values are returned. Records are returned in natural order. - { \"nickname\":\"Retrieve all coupons\",\"response\":\"getCouponAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_coupons_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_coupons" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/coupons'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_applied_coupons(self, code, **kwargs): - """ - Returns a list of unique coupons which have been applied. - { \"nickname\":\"Retrieve used unique coupons\",\"response\":\"getAppliedCodesForCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_applied_coupons(code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str code: The base code to use in the generation of the unique codes. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_applied_coupons_with_http_info(code, **kwargs) - else: - (data) = self.get_applied_coupons_with_http_info(code, **kwargs) - return data - - def get_applied_coupons_with_http_info(self, code, **kwargs): - """ - Returns a list of unique coupons which have been applied. - { \"nickname\":\"Retrieve used unique coupons\",\"response\":\"getAppliedCodesForCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_applied_coupons_with_http_info(code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str code: The base code to use in the generation of the unique codes. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['code', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_applied_coupons" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'code' is set - if ('code' not in params) or (params['code'] is None): - raise ValueError("Missing the required parameter `code` when calling `get_applied_coupons`") - - resource_path = '/coupons/{code}/applied'.replace('{format}', 'json') - path_params = {} - if 'code' in params: - path_params['code'] = params['code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_available_coupon_codes_for_code(self, code, **kwargs): - """ - Returns a list of available unique coupon codes for the specified parent coupon code that can be applied to a subscription. - { \"nickname\":\"Retrieve unused unique coupons\",\"response\":\"getAvailableCodesForCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_coupon_codes_for_code(code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str code: The base code to use in the generation of the unique codes. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CouponUniqueCodesResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_available_coupon_codes_for_code_with_http_info(code, **kwargs) - else: - (data) = self.get_available_coupon_codes_for_code_with_http_info(code, **kwargs) - return data - - def get_available_coupon_codes_for_code_with_http_info(self, code, **kwargs): - """ - Returns a list of available unique coupon codes for the specified parent coupon code that can be applied to a subscription. - { \"nickname\":\"Retrieve unused unique coupons\",\"response\":\"getAvailableCodesForCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_coupon_codes_for_code_with_http_info(code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str code: The base code to use in the generation of the unique codes. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CouponUniqueCodesResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['code', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_available_coupon_codes_for_code" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'code' is set - if ('code' not in params) or (params['code'] is None): - raise ValueError("Missing the required parameter `code` when calling `get_available_coupon_codes_for_code`") - - resource_path = '/coupons/{code}/codes'.replace('{format}', 'json') - path_params = {} - if 'code' in params: - path_params['code'] = params['code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponUniqueCodesResponsePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_code(self, code, **kwargs): - """ - Returns the coupon for the specified code that can be applied to a subscription. - { \"nickname\":\"Retrieve coupon\",\"response\":\"getCouponByCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_code(code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str code: The parent coupon code to use in the generation of the unique codes. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponUniqueCodesResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_code_with_http_info(code, **kwargs) - else: - (data) = self.get_coupon_code_with_http_info(code, **kwargs) - return data - - def get_coupon_code_with_http_info(self, code, **kwargs): - """ - Returns the coupon for the specified code that can be applied to a subscription. - { \"nickname\":\"Retrieve coupon\",\"response\":\"getCouponByCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_code_with_http_info(code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str code: The parent coupon code to use in the generation of the unique codes. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponUniqueCodesResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['code', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_code" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'code' is set - if ('code' not in params) or (params['code'] is None): - raise ValueError("Missing the required parameter `code` when calling `get_coupon_code`") - - resource_path = '/coupons/{code}'.replace('{format}', 'json') - path_params = {} - if 'code' in params: - path_params['code'] = params['code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponUniqueCodesResponsePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscription_applications_of_coupons(self, code, **kwargs): - """ - Retrieves a collection of the coupons by this coupon code which have been applied. - { \"nickname\":\"Retrieve subscriptions to which the given coupon code has been applied.\",\"response\":\"getSubscriptionApplications.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_applications_of_coupons(code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str code: Base code of the coupon. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscription_applications_of_coupons_with_http_info(code, **kwargs) - else: - (data) = self.get_subscription_applications_of_coupons_with_http_info(code, **kwargs) - return data - - def get_subscription_applications_of_coupons_with_http_info(self, code, **kwargs): - """ - Retrieves a collection of the coupons by this coupon code which have been applied. - { \"nickname\":\"Retrieve subscriptions to which the given coupon code has been applied.\",\"response\":\"getSubscriptionApplications.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_applications_of_coupons_with_http_info(code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str code: Base code of the coupon. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['code', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscription_applications_of_coupons" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'code' is set - if ('code' not in params) or (params['code'] is None): - raise ValueError("Missing the required parameter `code` when calling `get_subscription_applications_of_coupons`") - - resource_path = '/coupons/{code}/subscriptions'.replace('{format}', 'json') - path_params = {} - if 'code' in params: - path_params['code'] = params['code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def retire_coupon(self, code, organizations, **kwargs): - """ -

This method has 2 main behaviours depending on what is passed in. If the parent coupon code, for example SUMMER, is given no new coupons can be issued or claimed from this code. Deleting will result in the deleted property being set to true.

If a unique coupon code, for example SUMMER-AGH8, is given this will stop the coupon from being applied to the subscription from that point onwards. When a coupon is deleted the validUntil property is set which is the date/time it stopped applying to the target.

- { \"nickname\":\"Retire coupon\",\"response\":\"retireCoupon.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_coupon(code, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str code: ID of the coupon to remove. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.retire_coupon_with_http_info(code, organizations, **kwargs) - else: - (data) = self.retire_coupon_with_http_info(code, organizations, **kwargs) - return data - - def retire_coupon_with_http_info(self, code, organizations, **kwargs): - """ -

This method has 2 main behaviours depending on what is passed in. If the parent coupon code, for example SUMMER, is given no new coupons can be issued or claimed from this code. Deleting will result in the deleted property being set to true.

If a unique coupon code, for example SUMMER-AGH8, is given this will stop the coupon from being applied to the subscription from that point onwards. When a coupon is deleted the validUntil property is set which is the date/time it stopped applying to the target.

- { \"nickname\":\"Retire coupon\",\"response\":\"retireCoupon.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_coupon_with_http_info(code, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str code: ID of the coupon to remove. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['code', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method retire_coupon" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'code' is set - if ('code' not in params) or (params['code'] is None): - raise ValueError("Missing the required parameter `code` when calling `retire_coupon`") - # verify the required parameter 'organizations' is set - if ('organizations' not in params) or (params['organizations'] is None): - raise ValueError("Missing the required parameter `organizations` when calling `retire_coupon`") - - resource_path = '/coupons/{code}'.replace('{format}', 'json') - path_params = {} - if 'code' in params: - path_params['code'] = params['code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/creditnotes_api.py b/billforward/apis/creditnotes_api.py deleted file mode 100644 index c15aeb3..0000000 --- a/billforward/apis/creditnotes_api.py +++ /dev/null @@ -1,746 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class CreditnotesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_credit_note(self, credit_note, **kwargs): - """ - Create a credit note. - {\"nickname\":\"Create a new credit note\",\"request\":\"createCreditNoteRequest.html\",\"response\":\"createCreditNoteResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_credit_note(credit_note, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreditNote credit_note: The credit note object to be created. (required) - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_credit_note_with_http_info(credit_note, **kwargs) - else: - (data) = self.create_credit_note_with_http_info(credit_note, **kwargs) - return data - - def create_credit_note_with_http_info(self, credit_note, **kwargs): - """ - Create a credit note. - {\"nickname\":\"Create a new credit note\",\"request\":\"createCreditNoteRequest.html\",\"response\":\"createCreditNoteResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_credit_note_with_http_info(credit_note, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreditNote credit_note: The credit note object to be created. (required) - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['credit_note'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_credit_note" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'credit_note' is set - if ('credit_note' not in params) or (params['credit_note'] is None): - raise ValueError("Missing the required parameter `credit_note` when calling `create_credit_note`") - - resource_path = '/credit-notes'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'credit_note' in params: - body_params = params['credit_note'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CreditNotePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_credit_note_by_id(self, credit_note_id, **kwargs): - """ - Returns a single credit-note, specified by the ID parameter. - {\"nickname\":\"Retrieve an existing credit note\",\"response\":\"getCreditNoteByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_credit_note_by_id(credit_note_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str credit_note_id: ID of the credit-note. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_credit_note_by_id_with_http_info(credit_note_id, **kwargs) - else: - (data) = self.get_credit_note_by_id_with_http_info(credit_note_id, **kwargs) - return data - - def get_credit_note_by_id_with_http_info(self, credit_note_id, **kwargs): - """ - Returns a single credit-note, specified by the ID parameter. - {\"nickname\":\"Retrieve an existing credit note\",\"response\":\"getCreditNoteByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_credit_note_by_id_with_http_info(credit_note_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str credit_note_id: ID of the credit-note. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['credit_note_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_credit_note_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'credit_note_id' is set - if ('credit_note_id' not in params) or (params['credit_note_id'] is None): - raise ValueError("Missing the required parameter `credit_note_id` when calling `get_credit_note_by_id`") - - resource_path = '/credit-notes/{credit-note-ID}'.replace('{format}', 'json') - path_params = {} - if 'credit_note_id' in params: - path_params['credit-note-ID'] = params['credit_note_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CreditNotePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_credit_note_for_account(self, account_id, **kwargs): - """ - Returns credit notes for an account. - {\"nickname\":\"Retrieve by account\",\"response\":\"getCreditNotesByAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_credit_note_for_account(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: ID of the account. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_credit_note_for_account_with_http_info(account_id, **kwargs) - else: - (data) = self.get_credit_note_for_account_with_http_info(account_id, **kwargs) - return data - - def get_credit_note_for_account_with_http_info(self, account_id, **kwargs): - """ - Returns credit notes for an account. - {\"nickname\":\"Retrieve by account\",\"response\":\"getCreditNotesByAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_credit_note_for_account_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: ID of the account. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_credit_note_for_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_credit_note_for_account`") - - resource_path = '/credit-notes/account/{account-ID}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CreditNotePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_credit_note_for_invoice(self, invoice_id, **kwargs): - """ - Returns credit notes for an invoice. - {\"nickname\":\"Retrieve by invoice\",\"response\":\"getCreditNotesByInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_credit_note_for_invoice(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: ID of the Invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_credit_note_for_invoice_with_http_info(invoice_id, **kwargs) - else: - (data) = self.get_credit_note_for_invoice_with_http_info(invoice_id, **kwargs) - return data - - def get_credit_note_for_invoice_with_http_info(self, invoice_id, **kwargs): - """ - Returns credit notes for an invoice. - {\"nickname\":\"Retrieve by invoice\",\"response\":\"getCreditNotesByInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_credit_note_for_invoice_with_http_info(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: ID of the Invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_credit_note_for_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `get_credit_note_for_invoice`") - - resource_path = '/credit-notes/invoice/{invoice-ID}'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CreditNotePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_credit_note_for_subscription(self, subscription_id, **kwargs): - """ - Returns credit notes for an subscription. - {\"nickname\":\"Retrieve by subscription\",\"response\":\"getCreditNotesSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_credit_note_for_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_credit_note_for_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_credit_note_for_subscription_with_http_info(subscription_id, **kwargs) - return data - - def get_credit_note_for_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Returns credit notes for an subscription. - {\"nickname\":\"Retrieve by subscription\",\"response\":\"getCreditNotesSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_credit_note_for_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_credit_note_for_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_credit_note_for_subscription`") - - resource_path = '/credit-notes/subscription/{subscription-ID}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CreditNotePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def retire_credit_note(self, credit_note_id, organizations, **kwargs): - """ - Removes any remaining value from credit note - {\"nickname\":\"Removes remaining value from credit note\",\"response\":\"deleteCreditNote.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_credit_note(credit_note_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str credit_note_id: ID of the credit-note. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.retire_credit_note_with_http_info(credit_note_id, organizations, **kwargs) - else: - (data) = self.retire_credit_note_with_http_info(credit_note_id, organizations, **kwargs) - return data - - def retire_credit_note_with_http_info(self, credit_note_id, organizations, **kwargs): - """ - Removes any remaining value from credit note - {\"nickname\":\"Removes remaining value from credit note\",\"response\":\"deleteCreditNote.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_credit_note_with_http_info(credit_note_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str credit_note_id: ID of the credit-note. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['credit_note_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method retire_credit_note" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'credit_note_id' is set - if ('credit_note_id' not in params) or (params['credit_note_id'] is None): - raise ValueError("Missing the required parameter `credit_note_id` when calling `retire_credit_note`") - # verify the required parameter 'organizations' is set - if ('organizations' not in params) or (params['organizations'] is None): - raise ValueError("Missing the required parameter `organizations` when calling `retire_credit_note`") - - resource_path = '/credit-notes/{credit-note-ID}'.replace('{format}', 'json') - path_params = {} - if 'credit_note_id' in params: - path_params['credit-note-ID'] = params['credit_note_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CreditNotePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/cybersourcetokens_api.py b/billforward/apis/cybersourcetokens_api.py deleted file mode 100644 index 92e089d..0000000 --- a/billforward/apis/cybersourcetokens_api.py +++ /dev/null @@ -1,586 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class CybersourcetokensApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_cybersource_token(self, cybersource_token, **kwargs): - """ - Create a cybersource-token. - {\"nickname\":\"Create a cybersource-token\",\"request\":\"createCybersourceTokenRequest.html\",\"response\":\"createCybersourceTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_cybersource_token(cybersource_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity cybersource_token: The cybersource-token object to be created. (required) - :return: CybersourceTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_cybersource_token_with_http_info(cybersource_token, **kwargs) - else: - (data) = self.create_cybersource_token_with_http_info(cybersource_token, **kwargs) - return data - - def create_cybersource_token_with_http_info(self, cybersource_token, **kwargs): - """ - Create a cybersource-token. - {\"nickname\":\"Create a cybersource-token\",\"request\":\"createCybersourceTokenRequest.html\",\"response\":\"createCybersourceTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_cybersource_token_with_http_info(cybersource_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity cybersource_token: The cybersource-token object to be created. (required) - :return: CybersourceTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['cybersource_token'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_cybersource_token" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'cybersource_token' is set - if ('cybersource_token' not in params) or (params['cybersource_token'] is None): - raise ValueError("Missing the required parameter `cybersource_token` when calling `create_cybersource_token`") - - resource_path = '/cybersource-tokens'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'cybersource_token' in params: - body_params = params['cybersource_token'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CybersourceTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_cybersource_token_by_id(self, token_id, **kwargs): - """ - Returns a single cybersource-token, specified by the token-ID parameter. - {\"nickname\":\"NICKNAME\",\"response\":\"getCybersourceTokenByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_cybersource_token_by_id(token_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str token_id: The unique sting ID of the cybersource token. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CybersourceTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_cybersource_token_by_id_with_http_info(token_id, **kwargs) - else: - (data) = self.get_cybersource_token_by_id_with_http_info(token_id, **kwargs) - return data - - def get_cybersource_token_by_id_with_http_info(self, token_id, **kwargs): - """ - Returns a single cybersource-token, specified by the token-ID parameter. - {\"nickname\":\"NICKNAME\",\"response\":\"getCybersourceTokenByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_cybersource_token_by_id_with_http_info(token_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str token_id: The unique sting ID of the cybersource token. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CybersourceTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['token_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_cybersource_token_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'token_id' is set - if ('token_id' not in params) or (params['token_id'] is None): - raise ValueError("Missing the required parameter `token_id` when calling `get_cybersource_token_by_id`") - - resource_path = '/cybersource-tokens/{token-ID}'.replace('{format}', 'json') - path_params = {} - if 'token_id' in params: - path_params['token-ID'] = params['token_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CybersourceTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_cybersource_token_by_recurring_subscription_id(self, recurring_subscription_id, **kwargs): - """ - Returns a single cybersource-token, specified by the recurring-subscription-ID parameter. - {\"nickname\":\"NICKNAME\",\"response\":\"getCybersourceTokenByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_cybersource_token_by_recurring_subscription_id(recurring_subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str recurring_subscription_id: The recurring-subscription-info-subscription-ID of the cybersource token. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CybersourceTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_cybersource_token_by_recurring_subscription_id_with_http_info(recurring_subscription_id, **kwargs) - else: - (data) = self.get_cybersource_token_by_recurring_subscription_id_with_http_info(recurring_subscription_id, **kwargs) - return data - - def get_cybersource_token_by_recurring_subscription_id_with_http_info(self, recurring_subscription_id, **kwargs): - """ - Returns a single cybersource-token, specified by the recurring-subscription-ID parameter. - {\"nickname\":\"NICKNAME\",\"response\":\"getCybersourceTokenByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_cybersource_token_by_recurring_subscription_id_with_http_info(recurring_subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str recurring_subscription_id: The recurring-subscription-info-subscription-ID of the cybersource token. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CybersourceTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['recurring_subscription_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_cybersource_token_by_recurring_subscription_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'recurring_subscription_id' is set - if ('recurring_subscription_id' not in params) or (params['recurring_subscription_id'] is None): - raise ValueError("Missing the required parameter `recurring_subscription_id` when calling `get_cybersource_token_by_recurring_subscription_id`") - - resource_path = '/cybersource-tokens/recurring-subscription-info/{recurring-subscription-ID}'.replace('{format}', 'json') - path_params = {} - if 'recurring_subscription_id' in params: - path_params['recurring-subscription-ID'] = params['recurring_subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CybersourceTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def retire_cybersource_token(self, token_id, organizations, **kwargs): - """ - Retires the cybersource token specified by the token-ID parameter. - {\"nickname\":\"NICKNAME\",\"response\":\"deleteCybersourceToken.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_cybersource_token(token_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str token_id: ID of the cybersource-token. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: CybersourceTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.retire_cybersource_token_with_http_info(token_id, organizations, **kwargs) - else: - (data) = self.retire_cybersource_token_with_http_info(token_id, organizations, **kwargs) - return data - - def retire_cybersource_token_with_http_info(self, token_id, organizations, **kwargs): - """ - Retires the cybersource token specified by the token-ID parameter. - {\"nickname\":\"NICKNAME\",\"response\":\"deleteCybersourceToken.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_cybersource_token_with_http_info(token_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str token_id: ID of the cybersource-token. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: CybersourceTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['token_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method retire_cybersource_token" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'token_id' is set - if ('token_id' not in params) or (params['token_id'] is None): - raise ValueError("Missing the required parameter `token_id` when calling `retire_cybersource_token`") - # verify the required parameter 'organizations' is set - if ('organizations' not in params) or (params['organizations'] is None): - raise ValueError("Missing the required parameter `organizations` when calling `retire_cybersource_token`") - - resource_path = '/cybersource-tokens/{token-ID}'.replace('{format}', 'json') - path_params = {} - if 'token_id' in params: - path_params['token-ID'] = params['token_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CybersourceTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_cybersource_token(self, cybersource_token, **kwargs): - """ - Update a cybersource-token. - {\"nickname\":\"Update a cybersource-token\",\"request\":\"updateCybersourceTokenRequest.html\",\"response\":\"updateCybersourceTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_cybersource_token(cybersource_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity cybersource_token: The cybersource-token object to be updated. (required) - :return: CybersourceTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_cybersource_token_with_http_info(cybersource_token, **kwargs) - else: - (data) = self.update_cybersource_token_with_http_info(cybersource_token, **kwargs) - return data - - def update_cybersource_token_with_http_info(self, cybersource_token, **kwargs): - """ - Update a cybersource-token. - {\"nickname\":\"Update a cybersource-token\",\"request\":\"updateCybersourceTokenRequest.html\",\"response\":\"updateCybersourceTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_cybersource_token_with_http_info(cybersource_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity cybersource_token: The cybersource-token object to be updated. (required) - :return: CybersourceTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['cybersource_token'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_cybersource_token" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'cybersource_token' is set - if ('cybersource_token' not in params) or (params['cybersource_token'] is None): - raise ValueError("Missing the required parameter `cybersource_token` when calling `update_cybersource_token`") - - resource_path = '/cybersource-tokens'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'cybersource_token' in params: - body_params = params['cybersource_token'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CybersourceTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/dunninglines_api.py b/billforward/apis/dunninglines_api.py deleted file mode 100644 index 71f2db3..0000000 --- a/billforward/apis/dunninglines_api.py +++ /dev/null @@ -1,727 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class DunninglinesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_dunning_line(self, dunning_line, **kwargs): - """ - Create a dunning-line. - {\"nickname\":\"Create a new dunning line\",\"request\":\"createDunningLineRequest.html\",\"response\":\"createDunningLineResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_dunning_line(dunning_line, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DunningLine dunning_line: The Dunning-Line object to be updated. (required) - :return: DunningLinePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_dunning_line_with_http_info(dunning_line, **kwargs) - else: - (data) = self.create_dunning_line_with_http_info(dunning_line, **kwargs) - return data - - def create_dunning_line_with_http_info(self, dunning_line, **kwargs): - """ - Create a dunning-line. - {\"nickname\":\"Create a new dunning line\",\"request\":\"createDunningLineRequest.html\",\"response\":\"createDunningLineResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_dunning_line_with_http_info(dunning_line, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DunningLine dunning_line: The Dunning-Line object to be updated. (required) - :return: DunningLinePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['dunning_line'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_dunning_line" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'dunning_line' is set - if ('dunning_line' not in params) or (params['dunning_line'] is None): - raise ValueError("Missing the required parameter `dunning_line` when calling `create_dunning_line`") - - resource_path = '/dunning-lines'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'dunning_line' in params: - body_params = params['dunning_line'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DunningLinePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_dunning_lines(self, **kwargs): - """ - Returns a collection of all dunning-lines. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all dunning lines\",\"response\":\"getDunningLineByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_dunning_lines(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: DunningLinePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_dunning_lines_with_http_info(**kwargs) - else: - (data) = self.get_all_dunning_lines_with_http_info(**kwargs) - return data - - def get_all_dunning_lines_with_http_info(self, **kwargs): - """ - Returns a collection of all dunning-lines. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all dunning lines\",\"response\":\"getDunningLineByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_dunning_lines_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: DunningLinePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_dunning_lines" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/dunning-lines'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DunningLinePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_dunning_line_by_attempt_index(self, index, **kwargs): - """ - Returns a collection of dunning-lines specified by the index parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by attempt\",\"response\":\"getDunningLineByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_dunning_line_by_attempt_index(index, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param int index: The attempt index of the dunning-line. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: DunningLinePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_dunning_line_by_attempt_index_with_http_info(index, **kwargs) - else: - (data) = self.get_dunning_line_by_attempt_index_with_http_info(index, **kwargs) - return data - - def get_dunning_line_by_attempt_index_with_http_info(self, index, **kwargs): - """ - Returns a collection of dunning-lines specified by the index parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by attempt\",\"response\":\"getDunningLineByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_dunning_line_by_attempt_index_with_http_info(index, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param int index: The attempt index of the dunning-line. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: DunningLinePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['index', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_dunning_line_by_attempt_index" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'index' is set - if ('index' not in params) or (params['index'] is None): - raise ValueError("Missing the required parameter `index` when calling `get_dunning_line_by_attempt_index`") - - resource_path = '/dunning-lines/attempt-index/{index}'.replace('{format}', 'json') - path_params = {} - if 'index' in params: - path_params['index'] = params['index'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DunningLinePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_dunning_line_by_id(self, dunning_line_id, **kwargs): - """ - Returns a single dunning-line, specified by the dunning-line-ID parameter. - {\"nickname\":\"Retrieve an existing dunning line\",\"response\":\"getDunningLineByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_dunning_line_by_id(dunning_line_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str dunning_line_id: ID of the dunning-line. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DunningLinePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_dunning_line_by_id_with_http_info(dunning_line_id, **kwargs) - else: - (data) = self.get_dunning_line_by_id_with_http_info(dunning_line_id, **kwargs) - return data - - def get_dunning_line_by_id_with_http_info(self, dunning_line_id, **kwargs): - """ - Returns a single dunning-line, specified by the dunning-line-ID parameter. - {\"nickname\":\"Retrieve an existing dunning line\",\"response\":\"getDunningLineByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_dunning_line_by_id_with_http_info(dunning_line_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str dunning_line_id: ID of the dunning-line. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DunningLinePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['dunning_line_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_dunning_line_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'dunning_line_id' is set - if ('dunning_line_id' not in params) or (params['dunning_line_id'] is None): - raise ValueError("Missing the required parameter `dunning_line_id` when calling `get_dunning_line_by_id`") - - resource_path = '/dunning-lines/{dunning-line-ID}'.replace('{format}', 'json') - path_params = {} - if 'dunning_line_id' in params: - path_params['dunning-line-ID'] = params['dunning_line_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json', 'text/xml']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DunningLinePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def retire_dunning_line(self, dunning_line_id, organizations, **kwargs): - """ - Retires the specified dunning-line. - {\"nickname\":\"Delete a dunning line\",\"response\":\"deleteDunningLine.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_dunning_line(dunning_line_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str dunning_line_id: ID of the dunning-line. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: DunningLinePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.retire_dunning_line_with_http_info(dunning_line_id, organizations, **kwargs) - else: - (data) = self.retire_dunning_line_with_http_info(dunning_line_id, organizations, **kwargs) - return data - - def retire_dunning_line_with_http_info(self, dunning_line_id, organizations, **kwargs): - """ - Retires the specified dunning-line. - {\"nickname\":\"Delete a dunning line\",\"response\":\"deleteDunningLine.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_dunning_line_with_http_info(dunning_line_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str dunning_line_id: ID of the dunning-line. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: DunningLinePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['dunning_line_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method retire_dunning_line" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'dunning_line_id' is set - if ('dunning_line_id' not in params) or (params['dunning_line_id'] is None): - raise ValueError("Missing the required parameter `dunning_line_id` when calling `retire_dunning_line`") - # verify the required parameter 'organizations' is set - if ('organizations' not in params) or (params['organizations'] is None): - raise ValueError("Missing the required parameter `organizations` when calling `retire_dunning_line`") - - resource_path = '/dunning-lines/{dunning-line-ID}'.replace('{format}', 'json') - path_params = {} - if 'dunning_line_id' in params: - path_params['dunning-line-ID'] = params['dunning_line_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DunningLinePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_dunning_line(self, dunning_line, **kwargs): - """ - Update a dunning-line. - {\"nickname\":\"Update a dunning line\",\"request\":\"updateDunningLineRequest.html\",\"response\":\"updateDunningLineResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_dunning_line(dunning_line, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DunningLine dunning_line: The Dunning-Line object to be updated. (required) - :return: DunningLinePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_dunning_line_with_http_info(dunning_line, **kwargs) - else: - (data) = self.update_dunning_line_with_http_info(dunning_line, **kwargs) - return data - - def update_dunning_line_with_http_info(self, dunning_line, **kwargs): - """ - Update a dunning-line. - {\"nickname\":\"Update a dunning line\",\"request\":\"updateDunningLineRequest.html\",\"response\":\"updateDunningLineResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_dunning_line_with_http_info(dunning_line, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DunningLine dunning_line: The Dunning-Line object to be updated. (required) - :return: DunningLinePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['dunning_line'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_dunning_line" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'dunning_line' is set - if ('dunning_line' not in params) or (params['dunning_line'] is None): - raise ValueError("Missing the required parameter `dunning_line` when calling `update_dunning_line`") - - resource_path = '/dunning-lines'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'dunning_line' in params: - body_params = params['dunning_line'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DunningLinePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/emailproviders_api.py b/billforward/apis/emailproviders_api.py deleted file mode 100644 index efafc77..0000000 --- a/billforward/apis/emailproviders_api.py +++ /dev/null @@ -1,496 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class EmailprovidersApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_email_provider(self, request, **kwargs): - """ - Create an email provider. - {\"nickname\":\"Create an email provider\",\"request\":\"createEmailProviderRequest.html\",\"response\":\"creatEmailProviderResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_email_provider(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: . (required) - :return: EmailProviderPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_email_provider_with_http_info(request, **kwargs) - else: - (data) = self.create_email_provider_with_http_info(request, **kwargs) - return data - - def create_email_provider_with_http_info(self, request, **kwargs): - """ - Create an email provider. - {\"nickname\":\"Create an email provider\",\"request\":\"createEmailProviderRequest.html\",\"response\":\"creatEmailProviderResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_email_provider_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: . (required) - :return: EmailProviderPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_email_provider" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `create_email_provider`") - - resource_path = '/email-providers'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EmailProviderPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete(self, email_provider_id, **kwargs): - """ - Deletes a single email provider, specified by id or name parameter. - { \"nickname\" : \"delete\",\"response\" : \"deleteEmailProvider.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete(email_provider_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email_provider_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: EmailProviderPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_with_http_info(email_provider_id, **kwargs) - else: - (data) = self.delete_with_http_info(email_provider_id, **kwargs) - return data - - def delete_with_http_info(self, email_provider_id, **kwargs): - """ - Deletes a single email provider, specified by id or name parameter. - { \"nickname\" : \"delete\",\"response\" : \"deleteEmailProvider.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_with_http_info(email_provider_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email_provider_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: EmailProviderPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['email_provider_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'email_provider_id' is set - if ('email_provider_id' not in params) or (params['email_provider_id'] is None): - raise ValueError("Missing the required parameter `email_provider_id` when calling `delete`") - - resource_path = '/email-providers/{email-provider-ID}'.replace('{format}', 'json') - path_params = {} - if 'email_provider_id' in params: - path_params['email-provider-ID'] = params['email_provider_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EmailProviderPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_email_providers(self, **kwargs): - """ - Returns a collection of all email-providers. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all email providers\",\"response\":\"getEmailProvidersAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_email_providers(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first email-provider to return. - :param int records: The maximum number of email-provider to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Include deleted email-providers - :return: EmailProviderPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_email_providers_with_http_info(**kwargs) - else: - (data) = self.get_all_email_providers_with_http_info(**kwargs) - return data - - def get_all_email_providers_with_http_info(self, **kwargs): - """ - Returns a collection of all email-providers. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all email providers\",\"response\":\"getEmailProvidersAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_email_providers_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first email-provider to return. - :param int records: The maximum number of email-provider to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Include deleted email-providers - :return: EmailProviderPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_email_providers" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/email-providers'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EmailProviderPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_email_by_provider_id(self, email_provider_id, **kwargs): - """ - Retrieves a single email provider, specified by the version-ID parameter. - { \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailProviderByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_email_by_provider_id(email_provider_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email_provider_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param bool include_retired: Include deleted email-providers - :return: EmailProviderPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_email_by_provider_id_with_http_info(email_provider_id, **kwargs) - else: - (data) = self.get_email_by_provider_id_with_http_info(email_provider_id, **kwargs) - return data - - def get_email_by_provider_id_with_http_info(self, email_provider_id, **kwargs): - """ - Retrieves a single email provider, specified by the version-ID parameter. - { \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailProviderByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_email_by_provider_id_with_http_info(email_provider_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email_provider_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param bool include_retired: Include deleted email-providers - :return: EmailProviderPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['email_provider_id', 'organizations', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_email_by_provider_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'email_provider_id' is set - if ('email_provider_id' not in params) or (params['email_provider_id'] is None): - raise ValueError("Missing the required parameter `email_provider_id` when calling `get_email_by_provider_id`") - - resource_path = '/email-providers/{email-provider-ID}'.replace('{format}', 'json') - path_params = {} - if 'email_provider_id' in params: - path_params['email-provider-ID'] = params['email_provider_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EmailProviderPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/emails_api.py b/billforward/apis/emails_api.py deleted file mode 100644 index 7944026..0000000 --- a/billforward/apis/emails_api.py +++ /dev/null @@ -1,375 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class EmailsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def get_email_by_id(self, email_id, **kwargs): - """ - Retrieves a single invoice, specified by the version-ID parameter. - { \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_email_by_id(email_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: EmailPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_email_by_id_with_http_info(email_id, **kwargs) - else: - (data) = self.get_email_by_id_with_http_info(email_id, **kwargs) - return data - - def get_email_by_id_with_http_info(self, email_id, **kwargs): - """ - Retrieves a single invoice, specified by the version-ID parameter. - { \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_email_by_id_with_http_info(email_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: EmailPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['email_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_email_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'email_id' is set - if ('email_id' not in params) or (params['email_id'] is None): - raise ValueError("Missing the required parameter `email_id` when calling `get_email_by_id`") - - resource_path = '/emails/{email-ID}'.replace('{format}', 'json') - path_params = {} - if 'email_id' in params: - path_params['email-ID'] = params['email_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json', 'text/xml']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EmailPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_email_html_by_id(self, email_id, **kwargs): - """ - Retrieves a single invoice, specified by the version-ID parameter. - { \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_email_html_by_id(email_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: str - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_email_html_by_id_with_http_info(email_id, **kwargs) - else: - (data) = self.get_email_html_by_id_with_http_info(email_id, **kwargs) - return data - - def get_email_html_by_id_with_http_info(self, email_id, **kwargs): - """ - Retrieves a single invoice, specified by the version-ID parameter. - { \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_email_html_by_id_with_http_info(email_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: str - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['email_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_email_html_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'email_id' is set - if ('email_id' not in params) or (params['email_id'] is None): - raise ValueError("Missing the required parameter `email_id` when calling `get_email_html_by_id`") - - resource_path = '/emails/{email-ID}.html'.replace('{format}', 'json') - path_params = {} - if 'email_id' in params: - path_params['email-ID'] = params['email_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/html']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='str', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_email_text_by_id(self, email_id, **kwargs): - """ - Retrieves a single invoice, specified by the version-ID parameter. - { \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_email_text_by_id(email_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: str - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_email_text_by_id_with_http_info(email_id, **kwargs) - else: - (data) = self.get_email_text_by_id_with_http_info(email_id, **kwargs) - return data - - def get_email_text_by_id_with_http_info(self, email_id, **kwargs): - """ - Retrieves a single invoice, specified by the version-ID parameter. - { \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_email_text_by_id_with_http_info(email_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: str - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['email_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_email_text_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'email_id' is set - if ('email_id' not in params) or (params['email_id'] is None): - raise ValueError("Missing the required parameter `email_id` when calling `get_email_text_by_id`") - - resource_path = '/emails/{email-ID}.txt'.replace('{format}', 'json') - path_params = {} - if 'email_id' in params: - path_params['email-ID'] = params['email_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/plain']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='str', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/emailsubscriptions_api.py b/billforward/apis/emailsubscriptions_api.py deleted file mode 100644 index eed5109..0000000 --- a/billforward/apis/emailsubscriptions_api.py +++ /dev/null @@ -1,610 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class EmailsubscriptionsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_email_subscription(self, request, **kwargs): - """ - Create an email subscription. - {\"nickname\":\"Create an email subscription\",\"request\":\"createEmailSubscriptionRequest.html\",\"response\":\"creatEmailSubscriptionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_email_subscription(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: . (required) - :return: EmailSubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_email_subscription_with_http_info(request, **kwargs) - else: - (data) = self.create_email_subscription_with_http_info(request, **kwargs) - return data - - def create_email_subscription_with_http_info(self, request, **kwargs): - """ - Create an email subscription. - {\"nickname\":\"Create an email subscription\",\"request\":\"createEmailSubscriptionRequest.html\",\"response\":\"creatEmailSubscriptionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_email_subscription_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: . (required) - :return: EmailSubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_email_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `create_email_subscription`") - - resource_path = '/email-subscriptions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EmailSubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete_email_subscription_by_type(self, type, **kwargs): - """ - Unsubscribe from the email specified by the type parameter. - { \"nickname\" : \"Unsubscribe\",\"response\" : \"unsubscribeEmail.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_email_subscription_by_type(type, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str type: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: EmailSubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_email_subscription_by_type_with_http_info(type, **kwargs) - else: - (data) = self.delete_email_subscription_by_type_with_http_info(type, **kwargs) - return data - - def delete_email_subscription_by_type_with_http_info(self, type, **kwargs): - """ - Unsubscribe from the email specified by the type parameter. - { \"nickname\" : \"Unsubscribe\",\"response\" : \"unsubscribeEmail.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_email_subscription_by_type_with_http_info(type, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str type: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: EmailSubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['type', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_email_subscription_by_type" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'type' is set - if ('type' not in params) or (params['type'] is None): - raise ValueError("Missing the required parameter `type` when calling `delete_email_subscription_by_type`") - - resource_path = '/email-subscriptions/type={type}'.replace('{format}', 'json') - path_params = {} - if 'type' in params: - path_params['type'] = params['type'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json', 'text/xml']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EmailSubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_email_subscriptions(self, state, type, **kwargs): - """ - Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all email subscriptions\",\"response\":\"getEmailSubscriptionsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_email_subscriptions(state, type, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: Constrains search to Email Subscriptions of a specific state. (required) - :param str type: Constrains search to Email Subscriptions of a specific type (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first email-subscription to return. - :param int records: The maximum number of email-subscription to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: EmailSubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_email_subscriptions_with_http_info(state, type, **kwargs) - else: - (data) = self.get_all_email_subscriptions_with_http_info(state, type, **kwargs) - return data - - def get_all_email_subscriptions_with_http_info(self, state, type, **kwargs): - """ - Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all email subscriptions\",\"response\":\"getEmailSubscriptionsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_email_subscriptions_with_http_info(state, type, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: Constrains search to Email Subscriptions of a specific state. (required) - :param str type: Constrains search to Email Subscriptions of a specific type (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first email-subscription to return. - :param int records: The maximum number of email-subscription to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: EmailSubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['state', 'type', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_email_subscriptions" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'state' is set - if ('state' not in params) or (params['state'] is None): - raise ValueError("Missing the required parameter `state` when calling `get_all_email_subscriptions`") - # verify the required parameter 'type' is set - if ('type' not in params) or (params['type'] is None): - raise ValueError("Missing the required parameter `type` when calling `get_all_email_subscriptions`") - - resource_path = '/email-subscriptions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'state' in params: - query_params['state'] = params['state'] - if 'type' in params: - query_params['type'] = params['type'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EmailSubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_email_subscription_by_id(self, email_subscription_id, **kwargs): - """ - Retrieves a single email subscription, specified by ID. - { \"nickname\" : \"Retrieve by ID\",\"response\" : \"getEmailSubscriptionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_email_subscription_by_id(email_subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email_subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param bool include_retired: Include deleted email-subscriptions - :return: EmailSubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_email_subscription_by_id_with_http_info(email_subscription_id, **kwargs) - else: - (data) = self.get_email_subscription_by_id_with_http_info(email_subscription_id, **kwargs) - return data - - def get_email_subscription_by_id_with_http_info(self, email_subscription_id, **kwargs): - """ - Retrieves a single email subscription, specified by ID. - { \"nickname\" : \"Retrieve by ID\",\"response\" : \"getEmailSubscriptionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_email_subscription_by_id_with_http_info(email_subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email_subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param bool include_retired: Include deleted email-subscriptions - :return: EmailSubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['email_subscription_id', 'organizations', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_email_subscription_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'email_subscription_id' is set - if ('email_subscription_id' not in params) or (params['email_subscription_id'] is None): - raise ValueError("Missing the required parameter `email_subscription_id` when calling `get_email_subscription_by_id`") - - resource_path = '/email-subscriptions/{email-subscription-id}'.replace('{format}', 'json') - path_params = {} - if 'email_subscription_id' in params: - path_params['email-subscription-id'] = params['email_subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EmailSubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_email_subscription(self, request, **kwargs): - """ - Update an email subscription. - {\"nickname\":\"Update EmailSubscription\",\"request\":\"updateEmailSubscriptionRequest.html\",\"response\":\"updateEmailSubscriptionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_email_subscription(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: . (required) - :return: EmailSubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_email_subscription_with_http_info(request, **kwargs) - else: - (data) = self.update_email_subscription_with_http_info(request, **kwargs) - return data - - def update_email_subscription_with_http_info(self, request, **kwargs): - """ - Update an email subscription. - {\"nickname\":\"Update EmailSubscription\",\"request\":\"updateEmailSubscriptionRequest.html\",\"response\":\"updateEmailSubscriptionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_email_subscription_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: . (required) - :return: EmailSubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_email_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `update_email_subscription`") - - resource_path = '/email-subscriptions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='EmailSubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/fixedtermdefinitions_api.py b/billforward/apis/fixedtermdefinitions_api.py deleted file mode 100644 index 7a64ef3..0000000 --- a/billforward/apis/fixedtermdefinitions_api.py +++ /dev/null @@ -1,259 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class FixedtermdefinitionsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_fixed_term_definition(self, fixed_term_definiton, **kwargs): - """ - Create - {\"nickname\":\"Create a new fixed term definition\",\"request\":\"createFixedTermDefinitionRequest.html\",\"response\":\"createFixedTermDefinitionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_fixed_term_definition(fixed_term_definiton, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity fixed_term_definiton: The fixed-term-definition object to be updated. (required) - :return: FixedTermDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_fixed_term_definition_with_http_info(fixed_term_definiton, **kwargs) - else: - (data) = self.create_fixed_term_definition_with_http_info(fixed_term_definiton, **kwargs) - return data - - def create_fixed_term_definition_with_http_info(self, fixed_term_definiton, **kwargs): - """ - Create - {\"nickname\":\"Create a new fixed term definition\",\"request\":\"createFixedTermDefinitionRequest.html\",\"response\":\"createFixedTermDefinitionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_fixed_term_definition_with_http_info(fixed_term_definiton, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity fixed_term_definiton: The fixed-term-definition object to be updated. (required) - :return: FixedTermDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['fixed_term_definiton'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_fixed_term_definition" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'fixed_term_definiton' is set - if ('fixed_term_definiton' not in params) or (params['fixed_term_definiton'] is None): - raise ValueError("Missing the required parameter `fixed_term_definiton` when calling `create_fixed_term_definition`") - - resource_path = '/fixed-term-definitions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'fixed_term_definiton' in params: - body_params = params['fixed_term_definiton'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='FixedTermDefinitionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_fixed_term_definition(self, fixed_term_definiton, **kwargs): - """ - Update - {\"nickname\":\"Update a fixed-term definition\",\"request\":\"updateFixedTermDefinitionRequest.html\",\"response\":\"updateFixedTermDefinitionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_fixed_term_definition(fixed_term_definiton, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity fixed_term_definiton: The fixed-term-definition object to be updated. (required) - :return: FixedTermDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_fixed_term_definition_with_http_info(fixed_term_definiton, **kwargs) - else: - (data) = self.update_fixed_term_definition_with_http_info(fixed_term_definiton, **kwargs) - return data - - def update_fixed_term_definition_with_http_info(self, fixed_term_definiton, **kwargs): - """ - Update - {\"nickname\":\"Update a fixed-term definition\",\"request\":\"updateFixedTermDefinitionRequest.html\",\"response\":\"updateFixedTermDefinitionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_fixed_term_definition_with_http_info(fixed_term_definiton, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity fixed_term_definiton: The fixed-term-definition object to be updated. (required) - :return: FixedTermDefinitionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['fixed_term_definiton'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_fixed_term_definition" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'fixed_term_definiton' is set - if ('fixed_term_definiton' not in params) or (params['fixed_term_definiton'] is None): - raise ValueError("Missing the required parameter `fixed_term_definiton` when calling `update_fixed_term_definition`") - - resource_path = '/fixed-term-definitions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'fixed_term_definiton' in params: - body_params = params['fixed_term_definiton'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='FixedTermDefinitionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/fixedterms_api.py b/billforward/apis/fixedterms_api.py deleted file mode 100644 index 24b8b46..0000000 --- a/billforward/apis/fixedterms_api.py +++ /dev/null @@ -1,155 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class FixedtermsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def update_fixed_term(self, payment_method, **kwargs): - """ - Update - {\"nickname\":\"Update a fixed term\",\"request\":\"updateFixedTermRequest.html\",\"response\":\"updateFixedTermResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_fixed_term(payment_method, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param FixedTerm payment_method: The payment-method object to be updated. (required) - :return: FixedTermPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_fixed_term_with_http_info(payment_method, **kwargs) - else: - (data) = self.update_fixed_term_with_http_info(payment_method, **kwargs) - return data - - def update_fixed_term_with_http_info(self, payment_method, **kwargs): - """ - Update - {\"nickname\":\"Update a fixed term\",\"request\":\"updateFixedTermRequest.html\",\"response\":\"updateFixedTermResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_fixed_term_with_http_info(payment_method, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param FixedTerm payment_method: The payment-method object to be updated. (required) - :return: FixedTermPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment_method'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_fixed_term" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment_method' is set - if ('payment_method' not in params) or (params['payment_method'] is None): - raise ValueError("Missing the required parameter `payment_method` when calling `update_fixed_term`") - - resource_path = '/fixed-terms'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'payment_method' in params: - body_params = params['payment_method'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='FixedTermPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/invoices_api.py b/billforward/apis/invoices_api.py deleted file mode 100644 index 99718ac..0000000 --- a/billforward/apis/invoices_api.py +++ /dev/null @@ -1,5183 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class InvoicesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def add_charge_to_invoice(self, invoice_id, charge, **kwargs): - """ - Creates a charge on the specified invoice. - {\"nickname\":\"Add to invoice\",\"response\":\"addChargeToInvoice.html\",\"request\":\"addChargeToInvoiceRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_charge_to_invoice(invoice_id, charge, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: ID of the invoice. (required) - :param AddChargeRequest charge: The charge request (required) - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.add_charge_to_invoice_with_http_info(invoice_id, charge, **kwargs) - else: - (data) = self.add_charge_to_invoice_with_http_info(invoice_id, charge, **kwargs) - return data - - def add_charge_to_invoice_with_http_info(self, invoice_id, charge, **kwargs): - """ - Creates a charge on the specified invoice. - {\"nickname\":\"Add to invoice\",\"response\":\"addChargeToInvoice.html\",\"request\":\"addChargeToInvoiceRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_charge_to_invoice_with_http_info(invoice_id, charge, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: ID of the invoice. (required) - :param AddChargeRequest charge: The charge request (required) - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'charge'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method add_charge_to_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `add_charge_to_invoice`") - # verify the required parameter 'charge' is set - if ('charge' not in params) or (params['charge'] is None): - raise ValueError("Missing the required parameter `charge` when calling `add_charge_to_invoice`") - - resource_path = '/invoices/{invoice-ID}/charges'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'charge' in params: - body_params = params['charge'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionChargePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def aggregate_invoices(self, request, **kwargs): - """ - Aggregate Invoices into to one parent Invoice - {\"nickname\":\"Aggregate invoices\",\"response\":\"AggregateResponse.html\",\"request\":\"AggregateRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.aggregate_invoices(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.aggregate_invoices_with_http_info(request, **kwargs) - else: - (data) = self.aggregate_invoices_with_http_info(request, **kwargs) - return data - - def aggregate_invoices_with_http_info(self, request, **kwargs): - """ - Aggregate Invoices into to one parent Invoice - {\"nickname\":\"Aggregate invoices\",\"response\":\"AggregateResponse.html\",\"request\":\"AggregateRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.aggregate_invoices_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method aggregate_invoices" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `aggregate_invoices`") - - resource_path = '/invoices/aggregate'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def execute_invoice(self, invoice_id, request, **kwargs): - """ - Attempt payment for the outstanding value of an invoice - {\"nickname\":\"Execute invoice\",\"response\":\"executeInvoiceResponse.html\",\"request\":\"ExecuteInvoiceRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.execute_invoice(invoice_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: (required) - :param BillingEntityBase request: (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.execute_invoice_with_http_info(invoice_id, request, **kwargs) - else: - (data) = self.execute_invoice_with_http_info(invoice_id, request, **kwargs) - return data - - def execute_invoice_with_http_info(self, invoice_id, request, **kwargs): - """ - Attempt payment for the outstanding value of an invoice - {\"nickname\":\"Execute invoice\",\"response\":\"executeInvoiceResponse.html\",\"request\":\"ExecuteInvoiceRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.execute_invoice_with_http_info(invoice_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: (required) - :param BillingEntityBase request: (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method execute_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `execute_invoice`") - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `execute_invoice`") - - resource_path = '/invoices/{invoice-ID}/execute'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def generate_line_payments_for_all_invoices(self, **kwargs): - """ - Generates InvoiceLinePayments for all existing InvoicePayments. - { \"nickname\" : \"Generate InvoiceLinePayments\",\"response\" : \"Generate InvoiceLinePayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.generate_line_payments_for_all_invoices(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.generate_line_payments_for_all_invoices_with_http_info(**kwargs) - else: - (data) = self.generate_line_payments_for_all_invoices_with_http_info(**kwargs) - return data - - def generate_line_payments_for_all_invoices_with_http_info(self, **kwargs): - """ - Generates InvoiceLinePayments for all existing InvoicePayments. - { \"nickname\" : \"Generate InvoiceLinePayments\",\"response\" : \"Generate InvoiceLinePayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.generate_line_payments_for_all_invoices_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method generate_line_payments_for_all_invoices" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices/generate-line-payments'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoiceLinePaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_invoices(self, **kwargs): - """ - Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve all invoices\",\"response\" : \"getInvoiceAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_invoices(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool exclude_children: Should child invoices be excluded. - :param str metadata: - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_invoices_with_http_info(**kwargs) - else: - (data) = self.get_all_invoices_with_http_info(**kwargs) - return data - - def get_all_invoices_with_http_info(self, **kwargs): - """ - Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve all invoices\",\"response\" : \"getInvoiceAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_invoices_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool exclude_children: Should child invoices be excluded. - :param str metadata: - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children', 'metadata'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_invoices" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'exclude_children' in params: - query_params['exclude_children'] = params['exclude_children'] - if 'metadata' in params: - query_params['metadata'] = params['metadata'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_invoices_as_csv(self, **kwargs): - """ - Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve all invoices\",\"response\" : \"getInvoiceAll.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_invoices_as_csv(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_invoices_as_csv_with_http_info(**kwargs) - else: - (data) = self.get_all_invoices_as_csv_with_http_info(**kwargs) - return data - - def get_all_invoices_as_csv_with_http_info(self, **kwargs): - """ - Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve all invoices\",\"response\" : \"getInvoiceAll.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_invoices_as_csv_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_invoices_as_csv" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices/all.csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_bucketed_revenue_attributions_as_csv(self, **kwargs): - """ - Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed. - { \"nickname\" : \"(CSV) Retrieve bucketed revenue attributions\",\"response\" : \"getBucketedRevenueAttributions.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bucketed_revenue_attributions_as_csv(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). - :return: str - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_bucketed_revenue_attributions_as_csv_with_http_info(**kwargs) - else: - (data) = self.get_bucketed_revenue_attributions_as_csv_with_http_info(**kwargs) - return data - - def get_bucketed_revenue_attributions_as_csv_with_http_info(self, **kwargs): - """ - Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed. - { \"nickname\" : \"(CSV) Retrieve bucketed revenue attributions\",\"response\" : \"getBucketedRevenueAttributions.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_bucketed_revenue_attributions_as_csv_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). - :return: str - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'recognition_start', 'recognition_end'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_bucketed_revenue_attributions_as_csv" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices/bucketed-revenue-attributions.csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'recognition_start' in params: - query_params['recognition_start'] = params['recognition_start'] - if 'recognition_end' in params: - query_params['recognition_end'] = params['recognition_end'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept([]) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='str', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_charges_on_invoice(self, invoice_id, **kwargs): - """ - Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"List on invoice\",\"response\":\"getChargesInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_charges_on_invoice(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param str state: Ihe direction of any ordering, either ASC or DESC. - :param str type: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_charges_on_invoice_with_http_info(invoice_id, **kwargs) - else: - (data) = self.get_charges_on_invoice_with_http_info(invoice_id, **kwargs) - return data - - def get_charges_on_invoice_with_http_info(self, invoice_id, **kwargs): - """ - Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"List on invoice\",\"response\":\"getChargesInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_charges_on_invoice_with_http_info(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param str state: Ihe direction of any ordering, either ASC or DESC. - :param str type: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'state', 'type', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_charges_on_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `get_charges_on_invoice`") - - resource_path = '/invoices/{invoice-ID}/charges'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'state' in params: - query_params['state'] = params['state'] - if 'type' in params: - query_params['type'] = params['type'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionChargePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_credit_invoice_line_payments_from_invoices_as_csv(self, **kwargs): - """ - Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. - { \"nickname\" : \"Credit InvoiceLinePayments CSV\",\"response\" : \"Credit InvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_credit_invoice_line_payments_from_invoices_as_csv(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24). - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_credit_invoice_line_payments_from_invoices_as_csv_with_http_info(**kwargs) - else: - (data) = self.get_credit_invoice_line_payments_from_invoices_as_csv_with_http_info(**kwargs) - return data - - def get_credit_invoice_line_payments_from_invoices_as_csv_with_http_info(self, **kwargs): - """ - Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. - { \"nickname\" : \"Credit InvoiceLinePayments CSV\",\"response\" : \"Credit InvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_credit_invoice_line_payments_from_invoices_as_csv_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24). - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'recognition_start', 'recognition_end'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_credit_invoice_line_payments_from_invoices_as_csv" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices/credit.csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'recognition_start' in params: - query_params['recognition_start'] = params['recognition_start'] - if 'recognition_end' in params: - query_params['recognition_end'] = params['recognition_end'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoiceLinePaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(self, **kwargs): - """ - Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. - { \"nickname\" : \"Credit InvoiceLinePayments CSV\",\"response\" : \"Credit InvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24). - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(**kwargs) - else: - (data) = self.get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(**kwargs) - return data - - def get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(self, **kwargs): - """ - Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. - { \"nickname\" : \"Credit InvoiceLinePayments CSV\",\"response\" : \"Credit InvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24). - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'recognition_start', 'recognition_end'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices/payment-received/credit.csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'recognition_start' in params: - query_params['recognition_start'] = params['recognition_start'] - if 'recognition_end' in params: - query_params['recognition_end'] = params['recognition_end'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoiceLinePaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_debit_invoice_line_payments_from_invoices_as_csv(self, **kwargs): - """ - Retrieves received revenue from InvoicePayments upon line items, in CSV format. - { \"nickname\" : \"Debit InvoiceLinePayments CSV\",\"response\" : \"Debit InvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_debit_invoice_line_payments_from_invoices_as_csv(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24). - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_debit_invoice_line_payments_from_invoices_as_csv_with_http_info(**kwargs) - else: - (data) = self.get_debit_invoice_line_payments_from_invoices_as_csv_with_http_info(**kwargs) - return data - - def get_debit_invoice_line_payments_from_invoices_as_csv_with_http_info(self, **kwargs): - """ - Retrieves received revenue from InvoicePayments upon line items, in CSV format. - { \"nickname\" : \"Debit InvoiceLinePayments CSV\",\"response\" : \"Debit InvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_debit_invoice_line_payments_from_invoices_as_csv_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24). - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'recognition_start', 'recognition_end'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_debit_invoice_line_payments_from_invoices_as_csv" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices/revenue.csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'recognition_start' in params: - query_params['recognition_start'] = params['recognition_start'] - if 'recognition_end' in params: - query_params['recognition_end'] = params['recognition_end'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoiceLinePaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(self, **kwargs): - """ - Retrieves received revenue from InvoicePayments upon line items, in CSV format. - { \"nickname\" : \"Debit InvoiceLinePayments CSV\",\"response\" : \"Debit InvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24). - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(**kwargs) - else: - (data) = self.get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(**kwargs) - return data - - def get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(self, **kwargs): - """ - Retrieves received revenue from InvoicePayments upon line items, in CSV format. - { \"nickname\" : \"Debit InvoiceLinePayments CSV\",\"response\" : \"Debit InvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24). - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'recognition_start', 'recognition_end'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices/payment-received/revenue.csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'recognition_start' in params: - query_params['recognition_start'] = params['recognition_start'] - if 'recognition_end' in params: - query_params['recognition_end'] = params['recognition_end'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoiceLinePaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoice_as_html(self, id, **kwargs): - """ - Retrieves a single invoice specified by the ID parameter. - { \"nickname\" : \"HTML invoice\",\"response\" : \"getInvoiceByID.HTML.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_as_html(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool tier_breakdown: Whether to provide a breakdown of charge tiering. - :param bool inclusive_end: Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \"period end\" date shown to the customer. - :param bool show_zero_cost: Whether to show zero-cost lines. - :param bool show_plan_only_when_ambiguous: Whether to state which plan the Invoice lines came from, regardless of whether there's only one plan involved in this Invoice. - :return: str - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoice_as_html_with_http_info(id, **kwargs) - else: - (data) = self.get_invoice_as_html_with_http_info(id, **kwargs) - return data - - def get_invoice_as_html_with_http_info(self, id, **kwargs): - """ - Retrieves a single invoice specified by the ID parameter. - { \"nickname\" : \"HTML invoice\",\"response\" : \"getInvoiceByID.HTML.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_as_html_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool tier_breakdown: Whether to provide a breakdown of charge tiering. - :param bool inclusive_end: Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \"period end\" date shown to the customer. - :param bool show_zero_cost: Whether to show zero-cost lines. - :param bool show_plan_only_when_ambiguous: Whether to state which plan the Invoice lines came from, regardless of whether there's only one plan involved in this Invoice. - :return: str - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'tier_breakdown', 'inclusive_end', 'show_zero_cost', 'show_plan_only_when_ambiguous'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoice_as_html" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `get_invoice_as_html`") - - resource_path = '/invoices/{ID}.html'.replace('{format}', 'json') - path_params = {} - if 'id' in params: - path_params['ID'] = params['id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'tier_breakdown' in params: - query_params['tier_breakdown'] = params['tier_breakdown'] - if 'inclusive_end' in params: - query_params['inclusive_end'] = params['inclusive_end'] - if 'show_zero_cost' in params: - query_params['show_zero_cost'] = params['show_zero_cost'] - if 'show_plan_only_when_ambiguous' in params: - query_params['show_plan_only_when_ambiguous'] = params['show_plan_only_when_ambiguous'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/html']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='str', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoice_as_pdf(self, id, **kwargs): - """ - Retrieves a single invoice specified by the ID parameter. - { \"nickname\" : \"PDF Invoice\",\"response\" : \"getInvoiceByID.pdf\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_as_pdf(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool tier_breakdown: Whether to provide a breakdown of charge tiering. - :param bool inclusive_end: Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \"period end\" date shown to the customer. - :param bool show_zero_cost: Whether to show zero-cost lines. - :param bool show_plan_only_when_ambiguous: Whether to state which plan the Invoice lines came from, regardless of whether there's only one plan involved in this Invoice. - :param bool include_footer: - :param str group_line_items_by: - :return: file - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoice_as_pdf_with_http_info(id, **kwargs) - else: - (data) = self.get_invoice_as_pdf_with_http_info(id, **kwargs) - return data - - def get_invoice_as_pdf_with_http_info(self, id, **kwargs): - """ - Retrieves a single invoice specified by the ID parameter. - { \"nickname\" : \"PDF Invoice\",\"response\" : \"getInvoiceByID.pdf\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_as_pdf_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool tier_breakdown: Whether to provide a breakdown of charge tiering. - :param bool inclusive_end: Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \"period end\" date shown to the customer. - :param bool show_zero_cost: Whether to show zero-cost lines. - :param bool show_plan_only_when_ambiguous: Whether to state which plan the Invoice lines came from, regardless of whether there's only one plan involved in this Invoice. - :param bool include_footer: - :param str group_line_items_by: - :return: file - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'tier_breakdown', 'inclusive_end', 'show_zero_cost', 'show_plan_only_when_ambiguous', 'include_footer', 'group_line_items_by'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoice_as_pdf" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `get_invoice_as_pdf`") - - resource_path = '/invoices/{ID}.pdf'.replace('{format}', 'json') - path_params = {} - if 'id' in params: - path_params['ID'] = params['id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'tier_breakdown' in params: - query_params['tier_breakdown'] = params['tier_breakdown'] - if 'inclusive_end' in params: - query_params['inclusive_end'] = params['inclusive_end'] - if 'show_zero_cost' in params: - query_params['show_zero_cost'] = params['show_zero_cost'] - if 'show_plan_only_when_ambiguous' in params: - query_params['show_plan_only_when_ambiguous'] = params['show_plan_only_when_ambiguous'] - if 'include_footer' in params: - query_params['include_footer'] = params['include_footer'] - if 'group_line_items_by' in params: - query_params['group_line_items_by'] = params['group_line_items_by'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/pdf']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='file', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoice_by_id(self, invoice_id, **kwargs): - """ - Retrieves a single invoice specified by the invoice-ID parameter. - { \"nickname\" : \"Retrieve an existing invoice\",\"response\" : \"getInvoiceByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_by_id(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: The ID of the invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool exclude_children: Should child invoices be excluded. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoice_by_id_with_http_info(invoice_id, **kwargs) - else: - (data) = self.get_invoice_by_id_with_http_info(invoice_id, **kwargs) - return data - - def get_invoice_by_id_with_http_info(self, invoice_id, **kwargs): - """ - Retrieves a single invoice specified by the invoice-ID parameter. - { \"nickname\" : \"Retrieve an existing invoice\",\"response\" : \"getInvoiceByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_by_id_with_http_info(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: The ID of the invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool exclude_children: Should child invoices be excluded. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoice_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `get_invoice_by_id`") - - resource_path = '/invoices/{invoice-ID}'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'exclude_children' in params: - query_params['exclude_children'] = params['exclude_children'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoice_by_id_as_csv(self, id, **kwargs): - """ - Retrieves a single invoice specified by the ID parameter. - { \"nickname\" : \"CSV invoice\",\"response\" : \"getInvoiceByID.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_by_id_as_csv(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: str - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoice_by_id_as_csv_with_http_info(id, **kwargs) - else: - (data) = self.get_invoice_by_id_as_csv_with_http_info(id, **kwargs) - return data - - def get_invoice_by_id_as_csv_with_http_info(self, id, **kwargs): - """ - Retrieves a single invoice specified by the ID parameter. - { \"nickname\" : \"CSV invoice\",\"response\" : \"getInvoiceByID.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_by_id_as_csv_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The ID of the invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: str - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoice_by_id_as_csv" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `get_invoice_by_id_as_csv`") - - resource_path = '/invoices/{ID}.csv'.replace('{format}', 'json') - path_params = {} - if 'id' in params: - path_params['ID'] = params['id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='str', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoice_by_subscription_id(self, subscription_id, **kwargs): - """ - Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by subscription\",\"response\" : \"getInvoiceBySubscriptionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_by_subscription_id(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool exclude_children: Should child invoices be excluded. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoice_by_subscription_id_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_invoice_by_subscription_id_with_http_info(subscription_id, **kwargs) - return data - - def get_invoice_by_subscription_id_with_http_info(self, subscription_id, **kwargs): - """ - Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by subscription\",\"response\" : \"getInvoiceBySubscriptionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_by_subscription_id_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool exclude_children: Should child invoices be excluded. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoice_by_subscription_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_invoice_by_subscription_id`") - - resource_path = '/invoices/subscription/{subscription-ID}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'exclude_children' in params: - query_params['exclude_children'] = params['exclude_children'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoice_by_subscription_version_id(self, subscription_version_id, **kwargs): - """ - Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by subscription version\",\"response\" : \"getInvoiceBySubscriptionVersionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_by_subscription_version_id(subscription_version_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_version_id: Version ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool exclude_children: Should child invoices be excluded. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoice_by_subscription_version_id_with_http_info(subscription_version_id, **kwargs) - else: - (data) = self.get_invoice_by_subscription_version_id_with_http_info(subscription_version_id, **kwargs) - return data - - def get_invoice_by_subscription_version_id_with_http_info(self, subscription_version_id, **kwargs): - """ - Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by subscription version\",\"response\" : \"getInvoiceBySubscriptionVersionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_by_subscription_version_id_with_http_info(subscription_version_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_version_id: Version ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool exclude_children: Should child invoices be excluded. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_version_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoice_by_subscription_version_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_version_id' is set - if ('subscription_version_id' not in params) or (params['subscription_version_id'] is None): - raise ValueError("Missing the required parameter `subscription_version_id` when calling `get_invoice_by_subscription_version_id`") - - resource_path = '/invoices/subscription/version/{subscription-version-ID}'.replace('{format}', 'json') - path_params = {} - if 'subscription_version_id' in params: - path_params['subscription-version-ID'] = params['subscription_version_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'exclude_children' in params: - query_params['exclude_children'] = params['exclude_children'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoice_by_version_id(self, version_id, **kwargs): - """ - Retrieves a single invoice, specified by the version-ID parameter. - { \"nickname\" : \"Retrieve by version\",\"response\" : \"getInvoiceByVersionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_by_version_id(version_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version_id: The version-ID of the invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoice_by_version_id_with_http_info(version_id, **kwargs) - else: - (data) = self.get_invoice_by_version_id_with_http_info(version_id, **kwargs) - return data - - def get_invoice_by_version_id_with_http_info(self, version_id, **kwargs): - """ - Retrieves a single invoice, specified by the version-ID parameter. - { \"nickname\" : \"Retrieve by version\",\"response\" : \"getInvoiceByVersionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoice_by_version_id_with_http_info(version_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version_id: The version-ID of the invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['version_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoice_by_version_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'version_id' is set - if ('version_id' not in params) or (params['version_id'] is None): - raise ValueError("Missing the required parameter `version_id` when calling `get_invoice_by_version_id`") - - resource_path = '/invoices/version/{version-ID}'.replace('{format}', 'json') - path_params = {} - if 'version_id' in params: - path_params['version-ID'] = params['version_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json', 'text/xml']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoices_by_account_id(self, account_id, **kwargs): - """ - Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by account\",\"response\" : \"getInvoiceByAccountID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_account_id(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: ID of the account. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool exclude_children: Should child invoices be excluded. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoices_by_account_id_with_http_info(account_id, **kwargs) - else: - (data) = self.get_invoices_by_account_id_with_http_info(account_id, **kwargs) - return data - - def get_invoices_by_account_id_with_http_info(self, account_id, **kwargs): - """ - Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by account\",\"response\" : \"getInvoiceByAccountID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_account_id_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: ID of the account. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first invoice to return. - :param int records: The maximum number of invoices to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool exclude_children: Should child invoices be excluded. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoices_by_account_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_invoices_by_account_id`") - - resource_path = '/invoices/account/{account-ID}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'exclude_children' in params: - query_params['exclude_children'] = params['exclude_children'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoices_by_period_end(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by period-end\",\"response\" : \"getInvoiceByPeriodEnd.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_period_end(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoices_by_period_end_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_invoices_by_period_end_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_invoices_by_period_end_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by period-end\",\"response\" : \"getInvoiceByPeriodEnd.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_period_end_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoices_by_period_end" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_invoices_by_period_end`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_invoices_by_period_end`") - - resource_path = '/invoices/period-end/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoices_by_period_start(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by period-start\",\"response\" : \"getInvoiceByPeriodStart.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_period_start(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoices_by_period_start_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_invoices_by_period_start_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_invoices_by_period_start_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by period-start\",\"response\" : \"getInvoiceByPeriodStart.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_period_start_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoices_by_period_start" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_invoices_by_period_start`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_invoices_by_period_start`") - - resource_path = '/invoices/period-start/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoices_by_period_start_as_csv(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by period-start\",\"response\" : \"getInvoiceByPeriodStart.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_period_start_as_csv(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoices_by_period_start_as_csv_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_invoices_by_period_start_as_csv_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_invoices_by_period_start_as_csv_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by period-start\",\"response\" : \"getInvoiceByPeriodStart.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_period_start_as_csv_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoices_by_period_start_as_csv" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_invoices_by_period_start_as_csv`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_invoices_by_period_start_as_csv`") - - resource_path = '/invoices/period-start/{lower-threshold}/{upper-threshold}.csv'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoices_by_state(self, state, **kwargs): - """ - Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by state\",\"response\" : \"getInvoiceByState.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_state(state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the invoice, either Paid, Pending, Unpaid or Voided. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoices_by_state_with_http_info(state, **kwargs) - else: - (data) = self.get_invoices_by_state_with_http_info(state, **kwargs) - return data - - def get_invoices_by_state_with_http_info(self, state, **kwargs): - """ - Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by state\",\"response\" : \"getInvoiceByState.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_state_with_http_info(state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the invoice, either Paid, Pending, Unpaid or Voided. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['state', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoices_by_state" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'state' is set - if ('state' not in params) or (params['state'] is None): - raise ValueError("Missing the required parameter `state` when calling `get_invoices_by_state`") - - resource_path = '/invoices/state/{state}'.replace('{format}', 'json') - path_params = {} - if 'state' in params: - path_params['state'] = params['state'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoices_by_state_and_period_start(self, state, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by state and period-start\",\"response\" : \"getInvoiceByStateAndPeriodStart.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_state_and_period_start(state, lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the invoice, either Paid, Pending, Unpaid or Voided. (required) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoices_by_state_and_period_start_with_http_info(state, lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_invoices_by_state_and_period_start_with_http_info(state, lower_threshold, upper_threshold, **kwargs) - return data - - def get_invoices_by_state_and_period_start_with_http_info(self, state, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by state and period-start\",\"response\" : \"getInvoiceByStateAndPeriodStart.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_state_and_period_start_with_http_info(state, lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the invoice, either Paid, Pending, Unpaid or Voided. (required) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['state', 'lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoices_by_state_and_period_start" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'state' is set - if ('state' not in params) or (params['state'] is None): - raise ValueError("Missing the required parameter `state` when calling `get_invoices_by_state_and_period_start`") - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_invoices_by_state_and_period_start`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_invoices_by_state_and_period_start`") - - resource_path = '/invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'state' in params: - path_params['state'] = params['state'] - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoices_by_state_and_period_start_as_csv(self, state, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by state and period-start\",\"response\" : \"getInvoiceByStateAndPeriodStart.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_state_and_period_start_as_csv(state, lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the invoice, either Paid, Pending, Unpaid or Voided. (required) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoices_by_state_and_period_start_as_csv_with_http_info(state, lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_invoices_by_state_and_period_start_as_csv_with_http_info(state, lower_threshold, upper_threshold, **kwargs) - return data - - def get_invoices_by_state_and_period_start_as_csv_with_http_info(self, state, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by state and period-start\",\"response\" : \"getInvoiceByStateAndPeriodStart.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_state_and_period_start_as_csv_with_http_info(state, lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the invoice, either Paid, Pending, Unpaid or Voided. (required) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['state', 'lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoices_by_state_and_period_start_as_csv" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'state' is set - if ('state' not in params) or (params['state'] is None): - raise ValueError("Missing the required parameter `state` when calling `get_invoices_by_state_and_period_start_as_csv`") - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_invoices_by_state_and_period_start_as_csv`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_invoices_by_state_and_period_start_as_csv`") - - resource_path = '/invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}.csv'.replace('{format}', 'json') - path_params = {} - if 'state' in params: - path_params['state'] = params['state'] - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoices_by_state_as_csv(self, state, **kwargs): - """ - Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by state\",\"response\" : \"getInvoiceByState.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_state_as_csv(state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the invoice, either Paid, Pending, Unpaid or Voided. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoices_by_state_as_csv_with_http_info(state, **kwargs) - else: - (data) = self.get_invoices_by_state_as_csv_with_http_info(state, **kwargs) - return data - - def get_invoices_by_state_as_csv_with_http_info(self, state, **kwargs): - """ - Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Retrieve by state\",\"response\" : \"getInvoiceByState.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_by_state_as_csv_with_http_info(state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the invoice, either Paid, Pending, Unpaid or Voided. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['state', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoices_by_state_as_csv" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'state' is set - if ('state' not in params) or (params['state'] is None): - raise ValueError("Missing the required parameter `state` when calling `get_invoices_by_state_as_csv`") - - resource_path = '/invoices/state/{state}.csv'.replace('{format}', 'json') - path_params = {} - if 'state' in params: - path_params['state'] = params['state'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_line_payments(self, **kwargs): - """ - Retrieves all InvoiceLine payment attributions. - { \"nickname\" : \"Retrieve InvoiceLine payment attributions\",\"response\" : \"getInvoiceLinePayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_line_payments(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24). - :param list[str] include_gateway: Include attributions only from payments made via these payment gateways. Takes precedence over `exclude_gateway` param (if both are provided). - :param list[str] exclude_gateway: Include attributions from payments made via all payment gateways, except these. - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_line_payments_with_http_info(**kwargs) - else: - (data) = self.get_line_payments_with_http_info(**kwargs) - return data - - def get_line_payments_with_http_info(self, **kwargs): - """ - Retrieves all InvoiceLine payment attributions. - { \"nickname\" : \"Retrieve InvoiceLine payment attributions\",\"response\" : \"getInvoiceLinePayments.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_line_payments_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24). - :param list[str] include_gateway: Include attributions only from payments made via these payment gateways. Takes precedence over `exclude_gateway` param (if both are provided). - :param list[str] exclude_gateway: Include attributions from payments made via all payment gateways, except these. - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'recognition_start', 'recognition_end', 'include_gateway', 'exclude_gateway'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_line_payments" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices/line-payments'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'recognition_start' in params: - query_params['recognition_start'] = params['recognition_start'] - if 'recognition_end' in params: - query_params['recognition_end'] = params['recognition_end'] - if 'include_gateway' in params: - query_params['include_gateway'] = params['include_gateway'] - if 'exclude_gateway' in params: - query_params['exclude_gateway'] = params['exclude_gateway'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept([]) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoiceLinePaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_line_payments_as_csv(self, **kwargs): - """ - Retrieves (as CSV) all InvoiceLine payment attributions. - { \"nickname\" : \"(CSV) Retrieve InvoiceLine payment attributions\",\"response\" : \"getInvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_line_payments_as_csv(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24). - :param list[str] include_gateway: Include attributions only from payments made via these payment gateways. Takes precedence over `exclude_gateway` param (if both are provided). - :param list[str] exclude_gateway: Include attributions from payments made via all payment gateways, except these. - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_line_payments_as_csv_with_http_info(**kwargs) - else: - (data) = self.get_line_payments_as_csv_with_http_info(**kwargs) - return data - - def get_line_payments_as_csv_with_http_info(self, **kwargs): - """ - Retrieves (as CSV) all InvoiceLine payment attributions. - { \"nickname\" : \"(CSV) Retrieve InvoiceLine payment attributions\",\"response\" : \"getInvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_line_payments_as_csv_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24). - :param list[str] include_gateway: Include attributions only from payments made via these payment gateways. Takes precedence over `exclude_gateway` param (if both are provided). - :param list[str] exclude_gateway: Include attributions from payments made via all payment gateways, except these. - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'recognition_start', 'recognition_end', 'include_gateway', 'exclude_gateway'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_line_payments_as_csv" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices/line-payments.csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'recognition_start' in params: - query_params['recognition_start'] = params['recognition_start'] - if 'recognition_end' in params: - query_params['recognition_end'] = params['recognition_end'] - if 'include_gateway' in params: - query_params['include_gateway'] = params['include_gateway'] - if 'exclude_gateway' in params: - query_params['exclude_gateway'] = params['exclude_gateway'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept([]) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoiceLinePaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_metadata_for_invoice(self, invoice_id, **kwargs): - """ - Retrieve any associated metadata. - {\"nickname\":\"Retrieve metadata on invoice\",\"request\":\"getInvoiceMetadataRequest.html\",\"response\":\"getInvoiceMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_metadata_for_invoice(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_metadata_for_invoice_with_http_info(invoice_id, **kwargs) - else: - (data) = self.get_metadata_for_invoice_with_http_info(invoice_id, **kwargs) - return data - - def get_metadata_for_invoice_with_http_info(self, invoice_id, **kwargs): - """ - Retrieve any associated metadata. - {\"nickname\":\"Retrieve metadata on invoice\",\"request\":\"getInvoiceMetadataRequest.html\",\"response\":\"getInvoiceMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_metadata_for_invoice_with_http_info(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_metadata_for_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `get_metadata_for_invoice`") - - resource_path = '/invoices/{invoice-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_refund_invoice_line_payments_from_invoices_as_csv(self, **kwargs): - """ - Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. - { \"nickname\" : \"Refund InvoiceLinePayments CSV\",\"response\" : \"Refund InvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refund_invoice_line_payments_from_invoices_as_csv(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24). - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_refund_invoice_line_payments_from_invoices_as_csv_with_http_info(**kwargs) - else: - (data) = self.get_refund_invoice_line_payments_from_invoices_as_csv_with_http_info(**kwargs) - return data - - def get_refund_invoice_line_payments_from_invoices_as_csv_with_http_info(self, **kwargs): - """ - Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. - { \"nickname\" : \"Refund InvoiceLinePayments CSV\",\"response\" : \"Refund InvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refund_invoice_line_payments_from_invoices_as_csv_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24). - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'recognition_start', 'recognition_end'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_refund_invoice_line_payments_from_invoices_as_csv" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices/refund.csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'recognition_start' in params: - query_params['recognition_start'] = params['recognition_start'] - if 'recognition_end' in params: - query_params['recognition_end'] = params['recognition_end'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoiceLinePaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(self, **kwargs): - """ - Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. - { \"nickname\" : \"Refund InvoiceLinePayments CSV\",\"response\" : \"Refund InvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24). - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received_with_http_info(**kwargs) - else: - (data) = self.get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received_with_http_info(**kwargs) - return data - - def get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received_with_http_info(self, **kwargs): - """ - Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. - { \"nickname\" : \"Refund InvoiceLinePayments CSV\",\"response\" : \"Refund InvoiceLinePayments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24). - :return: InvoiceLinePaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'recognition_start', 'recognition_end'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices/payment-received/refund.csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'recognition_start' in params: - query_params['recognition_start'] = params['recognition_start'] - if 'recognition_end' in params: - query_params['recognition_end'] = params['recognition_end'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoiceLinePaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_revenue_attributions(self, **kwargs): - """ - Retrieves all attributions of Invoice costs to Invoice lines. - { \"nickname\" : \"Retrieve revenue attributions\",\"response\" : \"getRevenueAttributions.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_revenue_attributions(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). - :return: RevenueAttributionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_revenue_attributions_with_http_info(**kwargs) - else: - (data) = self.get_revenue_attributions_with_http_info(**kwargs) - return data - - def get_revenue_attributions_with_http_info(self, **kwargs): - """ - Retrieves all attributions of Invoice costs to Invoice lines. - { \"nickname\" : \"Retrieve revenue attributions\",\"response\" : \"getRevenueAttributions.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_revenue_attributions_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). - :return: RevenueAttributionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'recognition_start', 'recognition_end'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_revenue_attributions" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices/revenue-attributions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'recognition_start' in params: - query_params['recognition_start'] = params['recognition_start'] - if 'recognition_end' in params: - query_params['recognition_end'] = params['recognition_end'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept([]) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RevenueAttributionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_revenue_attributions_as_csv(self, **kwargs): - """ - Retrieves (as CSV) all attributions of Invoice costs to Invoice lines. - { \"nickname\" : \"(CSV) Retrieve revenue attributions\",\"response\" : \"getRevenueAttributions.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_revenue_attributions_as_csv(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). - :return: str - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_revenue_attributions_as_csv_with_http_info(**kwargs) - else: - (data) = self.get_revenue_attributions_as_csv_with_http_info(**kwargs) - return data - - def get_revenue_attributions_as_csv_with_http_info(self, **kwargs): - """ - Retrieves (as CSV) all attributions of Invoice costs to Invoice lines. - { \"nickname\" : \"(CSV) Retrieve revenue attributions\",\"response\" : \"getRevenueAttributions.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_revenue_attributions_as_csv_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str recognition_start: The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). - :param str recognition_end: The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). - :return: str - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'recognition_start', 'recognition_end'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_revenue_attributions_as_csv" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/invoices/revenue-attributions.csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'recognition_start' in params: - query_params['recognition_start'] = params['recognition_start'] - if 'recognition_end' in params: - query_params['recognition_end'] = params['recognition_end'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept([]) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='str', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_swagger_for_invoice(self, query_string, **kwargs): - """ - - { \"nickname\" : \"\",\"response\" : \"\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_swagger_for_invoice(query_string, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str query_string: The query string used to search. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The starting index of the search results. - :param int records: The number of search results to return. - :param str format: The response format, either JSON or XML. - :param bool wildcard: Toggle if we search for full words or whether a wildcard is used. - :param bool entity: Is an entity returned with the search results. - :return: SwaggerTypeListInv - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_swagger_for_invoice_with_http_info(query_string, **kwargs) - else: - (data) = self.get_swagger_for_invoice_with_http_info(query_string, **kwargs) - return data - - def get_swagger_for_invoice_with_http_info(self, query_string, **kwargs): - """ - - { \"nickname\" : \"\",\"response\" : \"\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_swagger_for_invoice_with_http_info(query_string, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str query_string: The query string used to search. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The starting index of the search results. - :param int records: The number of search results to return. - :param str format: The response format, either JSON or XML. - :param bool wildcard: Toggle if we search for full words or whether a wildcard is used. - :param bool entity: Is an entity returned with the search results. - :return: SwaggerTypeListInv - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['query_string', 'organizations', 'offset', 'records', 'format', 'wildcard', 'entity'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_swagger_for_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'query_string' is set - if ('query_string' not in params) or (params['query_string'] is None): - raise ValueError("Missing the required parameter `query_string` when calling `get_swagger_for_invoice`") - - resource_path = '/invoices/swagger-end-point/{query-string}'.replace('{format}', 'json') - path_params = {} - if 'query_string' in params: - path_params['query-string'] = params['query_string'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'format' in params: - query_params['format'] = params['format'] - if 'wildcard' in params: - query_params['wildcard'] = params['wildcard'] - if 'entity' in params: - query_params['entity'] = params['entity'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SwaggerTypeListInv', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def import_invoice(self, request, **kwargs): - """ - Import an invoice. - {\"nickname\":\"Import invoice\",\"response\":\"ImportInvoiceResponse.html\",\"request\":\"ImportInvoiceRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.import_invoice(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.import_invoice_with_http_info(request, **kwargs) - else: - (data) = self.import_invoice_with_http_info(request, **kwargs) - return data - - def import_invoice_with_http_info(self, request, **kwargs): - """ - Import an invoice. - {\"nickname\":\"Import invoice\",\"response\":\"ImportInvoiceResponse.html\",\"request\":\"ImportInvoiceRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.import_invoice_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method import_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `import_invoice`") - - resource_path = '/invoices/import'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def recalculate_invoice(self, invoice_id, request, **kwargs): - """ - Re-calculate an Invoice. - {\"nickname\":\"Re-calculate an invoice\",\"response\":\"recalculateInvoiceResponse.html\",\"request\":\"RecalculateInvoiceRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.recalculate_invoice(invoice_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: (required) - :param InvoiceRecalculationRequest request: (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.recalculate_invoice_with_http_info(invoice_id, request, **kwargs) - else: - (data) = self.recalculate_invoice_with_http_info(invoice_id, request, **kwargs) - return data - - def recalculate_invoice_with_http_info(self, invoice_id, request, **kwargs): - """ - Re-calculate an Invoice. - {\"nickname\":\"Re-calculate an invoice\",\"response\":\"recalculateInvoiceResponse.html\",\"request\":\"RecalculateInvoiceRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.recalculate_invoice_with_http_info(invoice_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: (required) - :param InvoiceRecalculationRequest request: (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method recalculate_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `recalculate_invoice`") - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `recalculate_invoice`") - - resource_path = '/invoices/{invoice-ID}/recalculate'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def remove_charge_from_invoice(self, invoice_id, charge_id, **kwargs): - """ - Removes the specified charge from the specified Invoice. - {\"nickname\":\"Remove from invoice\",\"response\":\"deleteChargesInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_charge_from_invoice(invoice_id, charge_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: (required) - :param str charge_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.remove_charge_from_invoice_with_http_info(invoice_id, charge_id, **kwargs) - else: - (data) = self.remove_charge_from_invoice_with_http_info(invoice_id, charge_id, **kwargs) - return data - - def remove_charge_from_invoice_with_http_info(self, invoice_id, charge_id, **kwargs): - """ - Removes the specified charge from the specified Invoice. - {\"nickname\":\"Remove from invoice\",\"response\":\"deleteChargesInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_charge_from_invoice_with_http_info(invoice_id, charge_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: (required) - :param str charge_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'charge_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method remove_charge_from_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `remove_charge_from_invoice`") - # verify the required parameter 'charge_id' is set - if ('charge_id' not in params) or (params['charge_id'] is None): - raise ValueError("Missing the required parameter `charge_id` when calling `remove_charge_from_invoice`") - - resource_path = '/invoices/{invoice-ID}/charges/{charge-ID}'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - if 'charge_id' in params: - path_params['charge-ID'] = params['charge_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionChargePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def remove_metadata_from_invoice(self, invoice_id, **kwargs): - """ - Remove any associated metadata. - {\"nickname\":\"Clear metadata from invoice\",\"request\" :\"deleteInvoiceMetadataRequest.html\",\"response\":\"deleteInvoiceMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_metadata_from_invoice(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.remove_metadata_from_invoice_with_http_info(invoice_id, **kwargs) - else: - (data) = self.remove_metadata_from_invoice_with_http_info(invoice_id, **kwargs) - return data - - def remove_metadata_from_invoice_with_http_info(self, invoice_id, **kwargs): - """ - Remove any associated metadata. - {\"nickname\":\"Clear metadata from invoice\",\"request\" :\"deleteInvoiceMetadataRequest.html\",\"response\":\"deleteInvoiceMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_metadata_from_invoice_with_http_info(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method remove_metadata_from_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `remove_metadata_from_invoice`") - - resource_path = '/invoices/{invoice-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def set_metadata_for_invoice(self, metadata, invoice_id, **kwargs): - """ - Remove any existing metadata keys and create the provided data. - {\"nickname\":\"Set metadata on invoice\",\"request\":\"setInvoiceMetadataRequest.html\",\"response\":\"setInvoiceMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_metadata_for_invoice(metadata, invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str invoice_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.set_metadata_for_invoice_with_http_info(metadata, invoice_id, **kwargs) - else: - (data) = self.set_metadata_for_invoice_with_http_info(metadata, invoice_id, **kwargs) - return data - - def set_metadata_for_invoice_with_http_info(self, metadata, invoice_id, **kwargs): - """ - Remove any existing metadata keys and create the provided data. - {\"nickname\":\"Set metadata on invoice\",\"request\":\"setInvoiceMetadataRequest.html\",\"response\":\"setInvoiceMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_metadata_for_invoice_with_http_info(metadata, invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str invoice_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['metadata', 'invoice_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method set_metadata_for_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'metadata' is set - if ('metadata' not in params) or (params['metadata'] is None): - raise ValueError("Missing the required parameter `metadata` when calling `set_metadata_for_invoice`") - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `set_metadata_for_invoice`") - - resource_path = '/invoices/{invoice-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'metadata' in params: - body_params = params['metadata'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_invoice(self, invoice, **kwargs): - """ - Update an Invoice. - {\"nickname\":\"Update an invoice\",\"response\":\"updateInvoiceResponse.html\",\"request\":\"updateInvoiceRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_invoice(invoice, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Invoice invoice: The invoice object to be updated. (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_invoice_with_http_info(invoice, **kwargs) - else: - (data) = self.update_invoice_with_http_info(invoice, **kwargs) - return data - - def update_invoice_with_http_info(self, invoice, **kwargs): - """ - Update an Invoice. - {\"nickname\":\"Update an invoice\",\"response\":\"updateInvoiceResponse.html\",\"request\":\"updateInvoiceRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_invoice_with_http_info(invoice, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Invoice invoice: The invoice object to be updated. (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice' is set - if ('invoice' not in params) or (params['invoice'] is None): - raise ValueError("Missing the required parameter `invoice` when calling `update_invoice`") - - resource_path = '/invoices'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'invoice' in params: - body_params = params['invoice'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def upsert_metadata_for_invoice(self, metadata, invoice_id, **kwargs): - """ - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - {\"nickname\":\"Upsert metadata on invoice\",\"request\":\"upsertInvoiceMetadataRequest.html\",\"response\":\"upsertInvoiceMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upsert_metadata_for_invoice(metadata, invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str invoice_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.upsert_metadata_for_invoice_with_http_info(metadata, invoice_id, **kwargs) - else: - (data) = self.upsert_metadata_for_invoice_with_http_info(metadata, invoice_id, **kwargs) - return data - - def upsert_metadata_for_invoice_with_http_info(self, metadata, invoice_id, **kwargs): - """ - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - {\"nickname\":\"Upsert metadata on invoice\",\"request\":\"upsertInvoiceMetadataRequest.html\",\"response\":\"upsertInvoiceMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upsert_metadata_for_invoice_with_http_info(metadata, invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str invoice_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['metadata', 'invoice_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method upsert_metadata_for_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'metadata' is set - if ('metadata' not in params) or (params['metadata'] is None): - raise ValueError("Missing the required parameter `metadata` when calling `upsert_metadata_for_invoice`") - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `upsert_metadata_for_invoice`") - - resource_path = '/invoices/{invoice-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'metadata' in params: - body_params = params['metadata'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def void_invoice(self, invoice_id, organizations, **kwargs): - """ - Voids the invoice specified by the invoice identifier parameter. - { \"nickname\" : \"Void an invoice\",\"response\" : \"voidInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.void_invoice(invoice_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: ID of the invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.void_invoice_with_http_info(invoice_id, organizations, **kwargs) - else: - (data) = self.void_invoice_with_http_info(invoice_id, organizations, **kwargs) - return data - - def void_invoice_with_http_info(self, invoice_id, organizations, **kwargs): - """ - Voids the invoice specified by the invoice identifier parameter. - { \"nickname\" : \"Void an invoice\",\"response\" : \"voidInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.void_invoice_with_http_info(invoice_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: ID of the invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method void_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `void_invoice`") - # verify the required parameter 'organizations' is set - if ('organizations' not in params) or (params['organizations'] is None): - raise ValueError("Missing the required parameter `organizations` when calling `void_invoice`") - - resource_path = '/invoices/{invoice-ID}'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/metadata_api.py b/billforward/apis/metadata_api.py deleted file mode 100644 index 845213d..0000000 --- a/billforward/apis/metadata_api.py +++ /dev/null @@ -1,469 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class MetadataApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def delete_metadata_key_values(self, **kwargs): - """ - Remove any associated metadata. - {\"nickname\":\"Clear metadata from organization\",\"request\" :\"deleteOrganizationMetadataRequest.html\",\"response\":\"deleteOrganizationMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_metadata_key_values(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_metadata_key_values_with_http_info(**kwargs) - else: - (data) = self.delete_metadata_key_values_with_http_info(**kwargs) - return data - - def delete_metadata_key_values_with_http_info(self, **kwargs): - """ - Remove any associated metadata. - {\"nickname\":\"Clear metadata from organization\",\"request\" :\"deleteOrganizationMetadataRequest.html\",\"response\":\"deleteOrganizationMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_metadata_key_values_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_metadata_key_values" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/metadata'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_metadata_key_values(self, **kwargs): - """ - Retrieve any associated metadata. - {\"nickname\":\"Retrieve metadata on organization\",\"request\":\"getOrganizationMetadataRequest.html\",\"response\":\"getOrganizationMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_metadata_key_values(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_metadata_key_values_with_http_info(**kwargs) - else: - (data) = self.get_metadata_key_values_with_http_info(**kwargs) - return data - - def get_metadata_key_values_with_http_info(self, **kwargs): - """ - Retrieve any associated metadata. - {\"nickname\":\"Retrieve metadata on organization\",\"request\":\"getOrganizationMetadataRequest.html\",\"response\":\"getOrganizationMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_metadata_key_values_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_metadata_key_values" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/metadata'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def set_metadata_key_values(self, metadata, **kwargs): - """ - Remove any existing metadata keys and create the provided data. - {\"nickname\":\"Set metadata on organization\",\"request\":\"setOrganizationMetadataRequest.html\",\"response\":\"setOrganizationMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_metadata_key_values(metadata, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.set_metadata_key_values_with_http_info(metadata, **kwargs) - else: - (data) = self.set_metadata_key_values_with_http_info(metadata, **kwargs) - return data - - def set_metadata_key_values_with_http_info(self, metadata, **kwargs): - """ - Remove any existing metadata keys and create the provided data. - {\"nickname\":\"Set metadata on organization\",\"request\":\"setOrganizationMetadataRequest.html\",\"response\":\"setOrganizationMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_metadata_key_values_with_http_info(metadata, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['metadata', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method set_metadata_key_values" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'metadata' is set - if ('metadata' not in params) or (params['metadata'] is None): - raise ValueError("Missing the required parameter `metadata` when calling `set_metadata_key_values`") - - resource_path = '/metadata'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'metadata' in params: - body_params = params['metadata'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def upsert_metadata_key_values(self, metadata, **kwargs): - """ - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - {\"nickname\":\"Upsert metadata on organization\",\"request\":\"upsertOrganizationMetadataRequest.html\",\"response\":\"upsertOrganizationMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upsert_metadata_key_values(metadata, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.upsert_metadata_key_values_with_http_info(metadata, **kwargs) - else: - (data) = self.upsert_metadata_key_values_with_http_info(metadata, **kwargs) - return data - - def upsert_metadata_key_values_with_http_info(self, metadata, **kwargs): - """ - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - {\"nickname\":\"Upsert metadata on organization\",\"request\":\"upsertOrganizationMetadataRequest.html\",\"response\":\"upsertOrganizationMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upsert_metadata_key_values_with_http_info(metadata, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['metadata', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method upsert_metadata_key_values" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'metadata' is set - if ('metadata' not in params) or (params['metadata'] is None): - raise ValueError("Missing the required parameter `metadata` when calling `upsert_metadata_key_values`") - - resource_path = '/metadata'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'metadata' in params: - body_params = params['metadata'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/notifications_api.py b/billforward/apis/notifications_api.py deleted file mode 100644 index 697503d..0000000 --- a/billforward/apis/notifications_api.py +++ /dev/null @@ -1,801 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class NotificationsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def ack_notification(self, notification_id, **kwargs): - """ - Acknowledge a newly recevied notification. - {\"nickname\":\"Acknowledge\",\"response\":\"getNotificationACK.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.ack_notification(notification_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str notification_id: ID of the notification. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: NotificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.ack_notification_with_http_info(notification_id, **kwargs) - else: - (data) = self.ack_notification_with_http_info(notification_id, **kwargs) - return data - - def ack_notification_with_http_info(self, notification_id, **kwargs): - """ - Acknowledge a newly recevied notification. - {\"nickname\":\"Acknowledge\",\"response\":\"getNotificationACK.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.ack_notification_with_http_info(notification_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str notification_id: ID of the notification. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: NotificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['notification_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method ack_notification" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'notification_id' is set - if ('notification_id' not in params) or (params['notification_id'] is None): - raise ValueError("Missing the required parameter `notification_id` when calling `ack_notification`") - - resource_path = '/notifications/ack/{notification-ID}'.replace('{format}', 'json') - path_params = {} - if 'notification_id' in params: - path_params['notification-ID'] = params['notification_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='NotificationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_notifications(self, **kwargs): - """ - Returns a collection of all notifications. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all notifications\",\"response\":\"getNotificationAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_notifications(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first Subscription to return. - :param int records: The maximum number of Subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: NotificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_notifications_with_http_info(**kwargs) - else: - (data) = self.get_all_notifications_with_http_info(**kwargs) - return data - - def get_all_notifications_with_http_info(self, **kwargs): - """ - Returns a collection of all notifications. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all notifications\",\"response\":\"getNotificationAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_notifications_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first Subscription to return. - :param int records: The maximum number of Subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: NotificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_notifications" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/notifications'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='NotificationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_notification_by_entity_id(self, entity_id, **kwargs): - """ - Returns a collection of notifications, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by entity\",\"response\":\"getNotificationBySubscriptionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_notification_by_entity_id(entity_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str entity_id: The string entity-ID of the notification. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first notification to return. - :param int records: The maximum number of notifications to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: NotificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_notification_by_entity_id_with_http_info(entity_id, **kwargs) - else: - (data) = self.get_notification_by_entity_id_with_http_info(entity_id, **kwargs) - return data - - def get_notification_by_entity_id_with_http_info(self, entity_id, **kwargs): - """ - Returns a collection of notifications, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by entity\",\"response\":\"getNotificationBySubscriptionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_notification_by_entity_id_with_http_info(entity_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str entity_id: The string entity-ID of the notification. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first notification to return. - :param int records: The maximum number of notifications to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: NotificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['entity_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_notification_by_entity_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'entity_id' is set - if ('entity_id' not in params) or (params['entity_id'] is None): - raise ValueError("Missing the required parameter `entity_id` when calling `get_notification_by_entity_id`") - - resource_path = '/notifications/entity-ID/{entity-ID}'.replace('{format}', 'json') - path_params = {} - if 'entity_id' in params: - path_params['entity-ID'] = params['entity_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='NotificationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_notification_by_id(self, notification_id, **kwargs): - """ - Returns a single notification, specified by the notification-ID parameter. - {\"nickname\":\"Retrieve an existing notification\",\"response\":\"getNotificationByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_notification_by_id(notification_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str notification_id: ID of the notification. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: NotificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_notification_by_id_with_http_info(notification_id, **kwargs) - else: - (data) = self.get_notification_by_id_with_http_info(notification_id, **kwargs) - return data - - def get_notification_by_id_with_http_info(self, notification_id, **kwargs): - """ - Returns a single notification, specified by the notification-ID parameter. - {\"nickname\":\"Retrieve an existing notification\",\"response\":\"getNotificationByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_notification_by_id_with_http_info(notification_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str notification_id: ID of the notification. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: NotificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['notification_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_notification_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'notification_id' is set - if ('notification_id' not in params) or (params['notification_id'] is None): - raise ValueError("Missing the required parameter `notification_id` when calling `get_notification_by_id`") - - resource_path = '/notifications/{notification-ID}'.replace('{format}', 'json') - path_params = {} - if 'notification_id' in params: - path_params['notification-ID'] = params['notification_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='NotificationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_notifications_by_webhook_id(self, lower_threshold, upper_threshold, webhook_id, **kwargs): - """ - Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters for the given webhook id. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by creation\",\"response\":\"getNotificationByCreated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_notifications_by_webhook_id(lower_threshold, upper_threshold, webhook_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param str webhook_id: The id of the webhook. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param int safety_margin: How many seconds behind server-time upperThreshold may approach. - :return: NotificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_notifications_by_webhook_id_with_http_info(lower_threshold, upper_threshold, webhook_id, **kwargs) - else: - (data) = self.get_notifications_by_webhook_id_with_http_info(lower_threshold, upper_threshold, webhook_id, **kwargs) - return data - - def get_notifications_by_webhook_id_with_http_info(self, lower_threshold, upper_threshold, webhook_id, **kwargs): - """ - Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters for the given webhook id. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by creation\",\"response\":\"getNotificationByCreated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_notifications_by_webhook_id_with_http_info(lower_threshold, upper_threshold, webhook_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param str webhook_id: The id of the webhook. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param int safety_margin: How many seconds behind server-time upperThreshold may approach. - :return: NotificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'webhook_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'safety_margin'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_notifications_by_webhook_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_notifications_by_webhook_id`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_notifications_by_webhook_id`") - # verify the required parameter 'webhook_id' is set - if ('webhook_id' not in params) or (params['webhook_id'] is None): - raise ValueError("Missing the required parameter `webhook_id` when calling `get_notifications_by_webhook_id`") - - resource_path = '/notifications/{lower-threshold}/{upper-threshold}/{webhookID}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - if 'webhook_id' in params: - path_params['webhookID'] = params['webhook_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'safety_margin' in params: - query_params['safety_margin'] = params['safety_margin'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='NotificationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_notifications_within_date_range(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by creation\",\"response\":\"getNotificationByCreated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_notifications_within_date_range(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param int safety_margin: How many seconds behind server-time upperThreshold may approach. - :return: NotificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_notifications_within_date_range_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_notifications_within_date_range_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_notifications_within_date_range_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by creation\",\"response\":\"getNotificationByCreated.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_notifications_within_date_range_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param int safety_margin: How many seconds behind server-time upperThreshold may approach. - :return: NotificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'safety_margin'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_notifications_within_date_range" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_notifications_within_date_range`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_notifications_within_date_range`") - - resource_path = '/notifications/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'safety_margin' in params: - query_params['safety_margin'] = params['safety_margin'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='NotificationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/organizations_api.py b/billforward/apis/organizations_api.py deleted file mode 100644 index 02cee61..0000000 --- a/billforward/apis/organizations_api.py +++ /dev/null @@ -1,825 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class OrganizationsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_organization(self, organization, **kwargs): - """ - Create an organization. - {\"nickname\":\"Create\",\"request\":\"createOrganizationRequest.html\",\"response\":\"createOrganizationResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_organization(organization, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Organization organization: The organization object to be updated. (required) - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_organization_with_http_info(organization, **kwargs) - else: - (data) = self.create_organization_with_http_info(organization, **kwargs) - return data - - def create_organization_with_http_info(self, organization, **kwargs): - """ - Create an organization. - {\"nickname\":\"Create\",\"request\":\"createOrganizationRequest.html\",\"response\":\"createOrganizationResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_organization_with_http_info(organization, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Organization organization: The organization object to be updated. (required) - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organization'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_organization" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'organization' is set - if ('organization' not in params) or (params['organization'] is None): - raise ValueError("Missing the required parameter `organization` when calling `create_organization`") - - resource_path = '/organizations'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'organization' in params: - body_params = params['organization'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='OrganizationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_my_organizations(self, **kwargs): - """ - Returns a collection of all my asociated organizations. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get Mine\",\"response\":\"getOrganizationAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_my_organizations(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first organization to return. - :param int records: The maximum number of organizations to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_my_organizations_with_http_info(**kwargs) - else: - (data) = self.get_all_my_organizations_with_http_info(**kwargs) - return data - - def get_all_my_organizations_with_http_info(self, **kwargs): - """ - Returns a collection of all my asociated organizations. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get Mine\",\"response\":\"getOrganizationAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_my_organizations_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first organization to return. - :param int records: The maximum number of organizations to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_my_organizations" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/organizations/mine'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='OrganizationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_organizations(self, **kwargs): - """ - Returns a collection of all organizations. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get All\",\"response\":\"getOrganizationAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_organizations(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first organization to return. - :param int records: The maximum number of organizations to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_organizations_with_http_info(**kwargs) - else: - (data) = self.get_all_organizations_with_http_info(**kwargs) - return data - - def get_all_organizations_with_http_info(self, **kwargs): - """ - Returns a collection of all organizations. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get All\",\"response\":\"getOrganizationAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_organizations_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first organization to return. - :param int records: The maximum number of organizations to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_organizations" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/organizations'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='OrganizationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_organization_by_customer_code(self, customer_code, **kwargs): - """ - Returns a single organization, specified by the customer-code parameter. - {\"nickname\":\"Retrieve by Customer-Code\",\"response\":\"getOrganizationByCustomer.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_organization_by_customer_code(customer_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str customer_code: The unique customer code of the organization. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_organization_by_customer_code_with_http_info(customer_code, **kwargs) - else: - (data) = self.get_organization_by_customer_code_with_http_info(customer_code, **kwargs) - return data - - def get_organization_by_customer_code_with_http_info(self, customer_code, **kwargs): - """ - Returns a single organization, specified by the customer-code parameter. - {\"nickname\":\"Retrieve by Customer-Code\",\"response\":\"getOrganizationByCustomer.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_organization_by_customer_code_with_http_info(customer_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str customer_code: The unique customer code of the organization. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['customer_code', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_organization_by_customer_code" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'customer_code' is set - if ('customer_code' not in params) or (params['customer_code'] is None): - raise ValueError("Missing the required parameter `customer_code` when calling `get_organization_by_customer_code`") - - resource_path = '/organizations/customer-code/{customer-code}'.replace('{format}', 'json') - path_params = {} - if 'customer_code' in params: - path_params['customer-code'] = params['customer_code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='OrganizationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_organization_by_id(self, organization_id, **kwargs): - """ - Returns a single Organization, specified by the organization-ID parameter. - {\"nickname\":\"Retrieve by id\",\"response\":\"getOrganizationByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_organization_by_id(organization_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str organization_id: ID of the organization. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_organization_by_id_with_http_info(organization_id, **kwargs) - else: - (data) = self.get_organization_by_id_with_http_info(organization_id, **kwargs) - return data - - def get_organization_by_id_with_http_info(self, organization_id, **kwargs): - """ - Returns a single Organization, specified by the organization-ID parameter. - {\"nickname\":\"Retrieve by id\",\"response\":\"getOrganizationByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_organization_by_id_with_http_info(organization_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str organization_id: ID of the organization. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organization_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_organization_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'organization_id' is set - if ('organization_id' not in params) or (params['organization_id'] is None): - raise ValueError("Missing the required parameter `organization_id` when calling `get_organization_by_id`") - - resource_path = '/organizations/{organization-ID}'.replace('{format}', 'json') - path_params = {} - if 'organization_id' in params: - path_params['organization-ID'] = params['organization_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='OrganizationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_organization_by_name(self, name, **kwargs): - """ - Returns a single Organization, specified by the name parameter. - {\"nickname\":\"Retrieve by Name\",\"response\":\"getOrganizationByName.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_organization_by_name(name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str name: The name of the Organization. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_organization_by_name_with_http_info(name, **kwargs) - else: - (data) = self.get_organization_by_name_with_http_info(name, **kwargs) - return data - - def get_organization_by_name_with_http_info(self, name, **kwargs): - """ - Returns a single Organization, specified by the name parameter. - {\"nickname\":\"Retrieve by Name\",\"response\":\"getOrganizationByName.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_organization_by_name_with_http_info(name, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str name: The name of the Organization. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['name', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_organization_by_name" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'name' is set - if ('name' not in params) or (params['name'] is None): - raise ValueError("Missing the required parameter `name` when calling `get_organization_by_name`") - - resource_path = '/organizations/name/{name}'.replace('{format}', 'json') - path_params = {} - if 'name' in params: - path_params['name'] = params['name'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='OrganizationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_organization(self, organization, **kwargs): - """ - Update an organization. - {\"nickname\":\"Updated\",\"request\":\"updateOrganizationRequest.html\",\"response\":\"updateOrganizationResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_organization(organization, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Organization organization: The organization object to be updated. (required) - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_organization_with_http_info(organization, **kwargs) - else: - (data) = self.update_organization_with_http_info(organization, **kwargs) - return data - - def update_organization_with_http_info(self, organization, **kwargs): - """ - Update an organization. - {\"nickname\":\"Updated\",\"request\":\"updateOrganizationRequest.html\",\"response\":\"updateOrganizationResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_organization_with_http_info(organization, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Organization organization: The organization object to be updated. (required) - :return: OrganizationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organization'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_organization" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'organization' is set - if ('organization' not in params) or (params['organization'] is None): - raise ValueError("Missing the required parameter `organization` when calling `update_organization`") - - resource_path = '/organizations'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'organization' in params: - body_params = params['organization'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='OrganizationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/passwords_api.py b/billforward/apis/passwords_api.py deleted file mode 100644 index 72f9e4e..0000000 --- a/billforward/apis/passwords_api.py +++ /dev/null @@ -1,155 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class PasswordsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_password(self, password, **kwargs): - """ - Create - {\"nickname\":\"Create\",\"request\":\"createPasswordRequest.html\",\"response\":\"createPasswordResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_password(password, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Password password: The password object to be created. (required) - :return: PasswordPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_password_with_http_info(password, **kwargs) - else: - (data) = self.create_password_with_http_info(password, **kwargs) - return data - - def create_password_with_http_info(self, password, **kwargs): - """ - Create - {\"nickname\":\"Create\",\"request\":\"createPasswordRequest.html\",\"response\":\"createPasswordResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_password_with_http_info(password, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Password password: The password object to be created. (required) - :return: PasswordPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['password'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_password" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'password' is set - if ('password' not in params) or (params['password'] is None): - raise ValueError("Missing the required parameter `password` when calling `create_password`") - - resource_path = '/passwords'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'password' in params: - body_params = params['password'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PasswordPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/paymentmethods_api.py b/billforward/apis/paymentmethods_api.py deleted file mode 100644 index 5d0abe6..0000000 --- a/billforward/apis/paymentmethods_api.py +++ /dev/null @@ -1,964 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class PaymentmethodsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_payment_method(self, payment_method, **kwargs): - """ - Create a payment-method. - {\"nickname\":\"Create a new payment method\",\"request\":\"createPaymentMethodRequest.html\",\"response\":\"createPaymentMethodResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_payment_method(payment_method, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PaymentMethod payment_method: The payment-method object to be updated. (required) - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_payment_method_with_http_info(payment_method, **kwargs) - else: - (data) = self.create_payment_method_with_http_info(payment_method, **kwargs) - return data - - def create_payment_method_with_http_info(self, payment_method, **kwargs): - """ - Create a payment-method. - {\"nickname\":\"Create a new payment method\",\"request\":\"createPaymentMethodRequest.html\",\"response\":\"createPaymentMethodResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_payment_method_with_http_info(payment_method, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PaymentMethod payment_method: The payment-method object to be updated. (required) - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment_method'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_payment_method" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment_method' is set - if ('payment_method' not in params) or (params['payment_method'] is None): - raise ValueError("Missing the required parameter `payment_method` when calling `create_payment_method`") - - resource_path = '/payment-methods'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'payment_method' in params: - body_params = params['payment_method'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete_payment_method(self, payment_method_id, **kwargs): - """ - Deletes the payment-method specified by the payment-method-ID parameter. - {\"nickname\":\"Delete payment method\",\"response\":\"deletePaymentMethod.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_payment_method(payment_method_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_method_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_payment_method_with_http_info(payment_method_id, **kwargs) - else: - (data) = self.delete_payment_method_with_http_info(payment_method_id, **kwargs) - return data - - def delete_payment_method_with_http_info(self, payment_method_id, **kwargs): - """ - Deletes the payment-method specified by the payment-method-ID parameter. - {\"nickname\":\"Delete payment method\",\"response\":\"deletePaymentMethod.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_payment_method_with_http_info(payment_method_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_method_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment_method_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_payment_method" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment_method_id' is set - if ('payment_method_id' not in params) or (params['payment_method_id'] is None): - raise ValueError("Missing the required parameter `payment_method_id` when calling `delete_payment_method`") - - resource_path = '/payment-methods/{payment-method-ID}'.replace('{format}', 'json') - path_params = {} - if 'payment_method_id' in params: - path_params['payment-method-ID'] = params['payment_method_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_payment_methods(self, **kwargs): - """ - Returns a collection of all payment-methods. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all payment methods\",\"response\":\"getPaymentMethodAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_payment_methods(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment-method to return. - :param int records: The maximum number of payment-methods to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_payment_methods_with_http_info(**kwargs) - else: - (data) = self.get_all_payment_methods_with_http_info(**kwargs) - return data - - def get_all_payment_methods_with_http_info(self, **kwargs): - """ - Returns a collection of all payment-methods. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all payment methods\",\"response\":\"getPaymentMethodAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_payment_methods_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment-method to return. - :param int records: The maximum number of payment-methods to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_payment_methods" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/payment-methods'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_payment_method_by_account_id(self, account_id, **kwargs): - """ - Returns a collection of payment-methods, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by account\",\"response\":\"getPaymentMethodByAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_method_by_account_id(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment-method to return. - :param int records: The maximum number of payment-methods to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool default_only: Whether only the defualt payment method should be returned. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_payment_method_by_account_id_with_http_info(account_id, **kwargs) - else: - (data) = self.get_payment_method_by_account_id_with_http_info(account_id, **kwargs) - return data - - def get_payment_method_by_account_id_with_http_info(self, account_id, **kwargs): - """ - Returns a collection of payment-methods, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by account\",\"response\":\"getPaymentMethodByAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_method_by_account_id_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment-method to return. - :param int records: The maximum number of payment-methods to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param bool default_only: Whether only the defualt payment method should be returned. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'default_only'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_payment_method_by_account_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_payment_method_by_account_id`") - - resource_path = '/payment-methods/account/{account-ID}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'default_only' in params: - query_params['default_only'] = params['default_only'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_payment_method_by_id(self, payment_method_id, **kwargs): - """ - Returns a single payment-method, specified by the payment-method-ID parameter. - {\"nickname\":\"Get existing payment method\",\"response\":\"getPaymentMethodByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_method_by_id(payment_method_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_method_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_payment_method_by_id_with_http_info(payment_method_id, **kwargs) - else: - (data) = self.get_payment_method_by_id_with_http_info(payment_method_id, **kwargs) - return data - - def get_payment_method_by_id_with_http_info(self, payment_method_id, **kwargs): - """ - Returns a single payment-method, specified by the payment-method-ID parameter. - {\"nickname\":\"Get existing payment method\",\"response\":\"getPaymentMethodByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_method_by_id_with_http_info(payment_method_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_method_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment_method_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_payment_method_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment_method_id' is set - if ('payment_method_id' not in params) or (params['payment_method_id'] is None): - raise ValueError("Missing the required parameter `payment_method_id` when calling `get_payment_method_by_id`") - - resource_path = '/payment-methods/{payment-method-ID}'.replace('{format}', 'json') - path_params = {} - if 'payment_method_id' in params: - path_params['payment-method-ID'] = params['payment_method_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_payment_method_by_link_id(self, link_id, **kwargs): - """ - Returns a single payment-method, specified by the linkID parameter. - {\"nickname\":\"Retrieve by subscription link\",\"response\":\"getPaymentMethodByLinkID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_method_by_link_id(link_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str link_id: The link-id of the payment-method. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_payment_method_by_link_id_with_http_info(link_id, **kwargs) - else: - (data) = self.get_payment_method_by_link_id_with_http_info(link_id, **kwargs) - return data - - def get_payment_method_by_link_id_with_http_info(self, link_id, **kwargs): - """ - Returns a single payment-method, specified by the linkID parameter. - {\"nickname\":\"Retrieve by subscription link\",\"response\":\"getPaymentMethodByLinkID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_method_by_link_id_with_http_info(link_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str link_id: The link-id of the payment-method. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['link_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_payment_method_by_link_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'link_id' is set - if ('link_id' not in params) or (params['link_id'] is None): - raise ValueError("Missing the required parameter `link_id` when calling `get_payment_method_by_link_id`") - - resource_path = '/payment-methods/link-id/{linkID}'.replace('{format}', 'json') - path_params = {} - if 'link_id' in params: - path_params['linkID'] = params['link_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_payment_method_by_payment_gateway(self, gateway, **kwargs): - """ - Returns a collection of payment-methods, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by gateway\",\"response\":\"getPaymentMethodByGateway.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_method_by_payment_gateway(gateway, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str gateway: The payment-method gateway which generated the payment-method. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment-method to return. - :param int records: The maximum number of payment-methods to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_payment_method_by_payment_gateway_with_http_info(gateway, **kwargs) - else: - (data) = self.get_payment_method_by_payment_gateway_with_http_info(gateway, **kwargs) - return data - - def get_payment_method_by_payment_gateway_with_http_info(self, gateway, **kwargs): - """ - Returns a collection of payment-methods, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by gateway\",\"response\":\"getPaymentMethodByGateway.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_method_by_payment_gateway_with_http_info(gateway, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str gateway: The payment-method gateway which generated the payment-method. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment-method to return. - :param int records: The maximum number of payment-methods to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['gateway', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_payment_method_by_payment_gateway" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'gateway' is set - if ('gateway' not in params) or (params['gateway'] is None): - raise ValueError("Missing the required parameter `gateway` when calling `get_payment_method_by_payment_gateway`") - - resource_path = '/payment-methods/gateway/{gateway}'.replace('{format}', 'json') - path_params = {} - if 'gateway' in params: - path_params['gateway'] = params['gateway'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_payment_method(self, payment_method, **kwargs): - """ - Update a payment-method. - {\"nickname\":\"Update a payment-method\",\"request\":\"updatePaymentMethodRequest.html\",\"response\":\"updatePaymentMethodResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_payment_method(payment_method, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PaymentMethod payment_method: The payment-method object to be updated. (required) - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_payment_method_with_http_info(payment_method, **kwargs) - else: - (data) = self.update_payment_method_with_http_info(payment_method, **kwargs) - return data - - def update_payment_method_with_http_info(self, payment_method, **kwargs): - """ - Update a payment-method. - {\"nickname\":\"Update a payment-method\",\"request\":\"updatePaymentMethodRequest.html\",\"response\":\"updatePaymentMethodResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_payment_method_with_http_info(payment_method, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PaymentMethod payment_method: The payment-method object to be updated. (required) - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment_method'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_payment_method" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment_method' is set - if ('payment_method' not in params) or (params['payment_method'] is None): - raise ValueError("Missing the required parameter `payment_method` when calling `update_payment_method`") - - resource_path = '/payment-methods'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'payment_method' in params: - body_params = params['payment_method'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/paymentmethodsubscriptionlinks_api.py b/billforward/apis/paymentmethodsubscriptionlinks_api.py deleted file mode 100644 index dfbbe57..0000000 --- a/billforward/apis/paymentmethodsubscriptionlinks_api.py +++ /dev/null @@ -1,266 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class PaymentmethodsubscriptionlinksApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_payment_method_subscription_link(self, payment_method, **kwargs): - """ - Create - {\"nickname\":\"Add a payment method to a subscription\",\"request\":\"createPaymentMethodSubscriptionLinkRequest.html\",\"response\":\"createPaymentMethodSubscriptionLinkResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_payment_method_subscription_link(payment_method, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PaymentMethodSubscriptionLink payment_method: The payment-method object to be updated. (required) - :return: PaymentMethodSubscriptionLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_payment_method_subscription_link_with_http_info(payment_method, **kwargs) - else: - (data) = self.create_payment_method_subscription_link_with_http_info(payment_method, **kwargs) - return data - - def create_payment_method_subscription_link_with_http_info(self, payment_method, **kwargs): - """ - Create - {\"nickname\":\"Add a payment method to a subscription\",\"request\":\"createPaymentMethodSubscriptionLinkRequest.html\",\"response\":\"createPaymentMethodSubscriptionLinkResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_payment_method_subscription_link_with_http_info(payment_method, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PaymentMethodSubscriptionLink payment_method: The payment-method object to be updated. (required) - :return: PaymentMethodSubscriptionLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment_method'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_payment_method_subscription_link" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment_method' is set - if ('payment_method' not in params) or (params['payment_method'] is None): - raise ValueError("Missing the required parameter `payment_method` when calling `create_payment_method_subscription_link`") - - resource_path = '/payment-method-subscription-links'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'payment_method' in params: - body_params = params['payment_method'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodSubscriptionLinkPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def retire_payment_method_subscription_link(self, payment_method_subscription_link_id, organizations, **kwargs): - """ - Retires the payment-method-subscription-link specified by the link-ID parameter. - {\"nickname\":\"Remove a payment method from a subscription\",\"response\":\"deletePaymentMethodSubscriptionLink.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_payment_method_subscription_link(payment_method_subscription_link_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_method_subscription_link_id: ID of the link. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: PaymentMethodSubscriptionLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.retire_payment_method_subscription_link_with_http_info(payment_method_subscription_link_id, organizations, **kwargs) - else: - (data) = self.retire_payment_method_subscription_link_with_http_info(payment_method_subscription_link_id, organizations, **kwargs) - return data - - def retire_payment_method_subscription_link_with_http_info(self, payment_method_subscription_link_id, organizations, **kwargs): - """ - Retires the payment-method-subscription-link specified by the link-ID parameter. - {\"nickname\":\"Remove a payment method from a subscription\",\"response\":\"deletePaymentMethodSubscriptionLink.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_payment_method_subscription_link_with_http_info(payment_method_subscription_link_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_method_subscription_link_id: ID of the link. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: PaymentMethodSubscriptionLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment_method_subscription_link_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method retire_payment_method_subscription_link" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment_method_subscription_link_id' is set - if ('payment_method_subscription_link_id' not in params) or (params['payment_method_subscription_link_id'] is None): - raise ValueError("Missing the required parameter `payment_method_subscription_link_id` when calling `retire_payment_method_subscription_link`") - # verify the required parameter 'organizations' is set - if ('organizations' not in params) or (params['organizations'] is None): - raise ValueError("Missing the required parameter `organizations` when calling `retire_payment_method_subscription_link`") - - resource_path = '/payment-method-subscription-links/{payment-method-subscription-link-ID}'.replace('{format}', 'json') - path_params = {} - if 'payment_method_subscription_link_id' in params: - path_params['payment-method-subscription-link-ID'] = params['payment_method_subscription_link_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodSubscriptionLinkPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/payments_api.py b/billforward/apis/payments_api.py deleted file mode 100644 index 55b45cf..0000000 --- a/billforward/apis/payments_api.py +++ /dev/null @@ -1,1003 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class PaymentsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_payment(self, payment, **kwargs): - """ - Create a payment. - {\"nickname\":\"Create a new payment\",\"request\":\"createPaymentRequest.html\",\"response\":\"createPaymentResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_payment(payment, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Payment payment: The payment object to be updated. (required) - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_payment_with_http_info(payment, **kwargs) - else: - (data) = self.create_payment_with_http_info(payment, **kwargs) - return data - - def create_payment_with_http_info(self, payment, **kwargs): - """ - Create a payment. - {\"nickname\":\"Create a new payment\",\"request\":\"createPaymentRequest.html\",\"response\":\"createPaymentResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_payment_with_http_info(payment, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Payment payment: The payment object to be updated. (required) - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_payment" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment' is set - if ('payment' not in params) or (params['payment'] is None): - raise ValueError("Missing the required parameter `payment` when calling `create_payment`") - - resource_path = '/payments'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'payment' in params: - body_params = params['payment'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_payments(self, **kwargs): - """ - Returns a collection of all payments. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all payments\",\"response\":\"getPaymentAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_payments(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_payments_with_http_info(**kwargs) - else: - (data) = self.get_all_payments_with_http_info(**kwargs) - return data - - def get_all_payments_with_http_info(self, **kwargs): - """ - Returns a collection of all payments. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all payments\",\"response\":\"getPaymentAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_payments_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_payments" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/payments'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_payment_as_csv(self, received_start, received_end, **kwargs): - """ - Retrieves payments in CSV format. - { \"nickname\":\"Payments CSV\",\"response\":\"payments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_as_csv(received_start, received_end, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str received_start: The UTC DateTime specifying the start of the interval within which payments were received. (required) - :param str received_end: The UTC DateTime specifying the end of the interval within which payments were received. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_payment_as_csv_with_http_info(received_start, received_end, **kwargs) - else: - (data) = self.get_payment_as_csv_with_http_info(received_start, received_end, **kwargs) - return data - - def get_payment_as_csv_with_http_info(self, received_start, received_end, **kwargs): - """ - Retrieves payments in CSV format. - { \"nickname\":\"Payments CSV\",\"response\":\"payments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_as_csv_with_http_info(received_start, received_end, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str received_start: The UTC DateTime specifying the start of the interval within which payments were received. (required) - :param str received_end: The UTC DateTime specifying the end of the interval within which payments were received. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['received_start', 'received_end', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_payment_as_csv" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'received_start' is set - if ('received_start' not in params) or (params['received_start'] is None): - raise ValueError("Missing the required parameter `received_start` when calling `get_payment_as_csv`") - # verify the required parameter 'received_end' is set - if ('received_end' not in params) or (params['received_end'] is None): - raise ValueError("Missing the required parameter `received_end` when calling `get_payment_as_csv`") - - resource_path = '/payments/csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'received_start' in params: - query_params['received_start'] = params['received_start'] - if 'received_end' in params: - query_params['received_end'] = params['received_end'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_payment_by_id(self, payment_id, **kwargs): - """ - Returns a single payment, specified by the payment-ID parameter. - {\"nickname\":\"Retrieve an existing payment\",\"response\":\"getPaymentByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_by_id(payment_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_id: The unique string-ID of the payment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_payment_by_id_with_http_info(payment_id, **kwargs) - else: - (data) = self.get_payment_by_id_with_http_info(payment_id, **kwargs) - return data - - def get_payment_by_id_with_http_info(self, payment_id, **kwargs): - """ - Returns a single payment, specified by the payment-ID parameter. - {\"nickname\":\"Retrieve an existing payment\",\"response\":\"getPaymentByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_by_id_with_http_info(payment_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_id: The unique string-ID of the payment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_payment_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment_id' is set - if ('payment_id' not in params) or (params['payment_id'] is None): - raise ValueError("Missing the required parameter `payment_id` when calling `get_payment_by_id`") - - resource_path = '/payments/{payment-ID}'.replace('{format}', 'json') - path_params = {} - if 'payment_id' in params: - path_params['payment-ID'] = params['payment_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_payment_by_invoice_id(self, invoice_id, **kwargs): - """ - Returns a collection of payments, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get for invoice\",\"response\":\"getPaymentByInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_by_invoice_id(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: The string ID of the account (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_payment_by_invoice_id_with_http_info(invoice_id, **kwargs) - else: - (data) = self.get_payment_by_invoice_id_with_http_info(invoice_id, **kwargs) - return data - - def get_payment_by_invoice_id_with_http_info(self, invoice_id, **kwargs): - """ - Returns a collection of payments, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get for invoice\",\"response\":\"getPaymentByInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_by_invoice_id_with_http_info(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: The string ID of the account (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_payment_by_invoice_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `get_payment_by_invoice_id`") - - resource_path = '/payments/invoice/{invoice-ID}'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_payment_by_payment_gateway(self, gateway, **kwargs): - """ - Returns a collection of payments, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by gateway\",\"response\":\"getPaymentByGateway.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_by_payment_gateway(gateway, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str gateway: The payment gateway which generated the payment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_payment_by_payment_gateway_with_http_info(gateway, **kwargs) - else: - (data) = self.get_payment_by_payment_gateway_with_http_info(gateway, **kwargs) - return data - - def get_payment_by_payment_gateway_with_http_info(self, gateway, **kwargs): - """ - Returns a collection of payments, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by gateway\",\"response\":\"getPaymentByGateway.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_by_payment_gateway_with_http_info(gateway, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str gateway: The payment gateway which generated the payment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['gateway', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_payment_by_payment_gateway" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'gateway' is set - if ('gateway' not in params) or (params['gateway'] is None): - raise ValueError("Missing the required parameter `gateway` when calling `get_payment_by_payment_gateway`") - - resource_path = '/payments/gateway/{gateway}'.replace('{format}', 'json') - path_params = {} - if 'gateway' in params: - path_params['gateway'] = params['gateway'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_payment_by_payment_method_id(self, payment_method_id, **kwargs): - """ - Returns a collection of payments, specified by the payment-method-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by payment method\",\"response\":\"getPaymentByPaymentMethod.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_by_payment_method_id(payment_method_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_method_id: ID of the PaymentMethod (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_payment_by_payment_method_id_with_http_info(payment_method_id, **kwargs) - else: - (data) = self.get_payment_by_payment_method_id_with_http_info(payment_method_id, **kwargs) - return data - - def get_payment_by_payment_method_id_with_http_info(self, payment_method_id, **kwargs): - """ - Returns a collection of payments, specified by the payment-method-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by payment method\",\"response\":\"getPaymentByPaymentMethod.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_payment_by_payment_method_id_with_http_info(payment_method_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_method_id: ID of the PaymentMethod (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment_method_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_payment_by_payment_method_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment_method_id' is set - if ('payment_method_id' not in params) or (params['payment_method_id'] is None): - raise ValueError("Missing the required parameter `payment_method_id` when calling `get_payment_by_payment_method_id`") - - resource_path = '/payments/payment-method/{payment-method-ID}'.replace('{format}', 'json') - path_params = {} - if 'payment_method_id' in params: - path_params['payment-method-ID'] = params['payment_method_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_payment(self, payment, **kwargs): - """ - Update a payment. - {\"nickname\":\"Update a payment\",\"request\":\"updatePaymentRequest.html\",\"response\":\"updatePaymentResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_payment(payment, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Payment payment: The payment object to be updated. (required) - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_payment_with_http_info(payment, **kwargs) - else: - (data) = self.update_payment_with_http_info(payment, **kwargs) - return data - - def update_payment_with_http_info(self, payment, **kwargs): - """ - Update a payment. - {\"nickname\":\"Update a payment\",\"request\":\"updatePaymentRequest.html\",\"response\":\"updatePaymentResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_payment_with_http_info(payment, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Payment payment: The payment object to be updated. (required) - :return: PaymentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_payment" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment' is set - if ('payment' not in params) or (params['payment'] is None): - raise ValueError("Missing the required parameter `payment` when calling `update_payment`") - - resource_path = '/payments'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'payment' in params: - body_params = params['payment'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/periods_api.py b/billforward/apis/periods_api.py deleted file mode 100644 index f89afb4..0000000 --- a/billforward/apis/periods_api.py +++ /dev/null @@ -1,292 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class PeriodsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def get_all_periods_for_subscription(self, subscription_id, **kwargs): - """ - Retrieve by subscription) - { \"nickname\" : \"Retrieve by subscription\",\"response\" : \"getPeriodsForSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_periods_for_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the usage. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: PeriodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_periods_for_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_all_periods_for_subscription_with_http_info(subscription_id, **kwargs) - return data - - def get_all_periods_for_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Retrieve by subscription) - { \"nickname\" : \"Retrieve by subscription\",\"response\" : \"getPeriodsForSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_periods_for_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the usage. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: PeriodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_periods_for_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_all_periods_for_subscription`") - - resource_path = '/periods/{subscription-id}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-id'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PeriodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_latest_periods(self, **kwargs): - """ - Get all periods - { \"nickname\" : \"Get all periods\",\"response\" : \"getPeriods.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_latest_periods(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: PeriodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_latest_periods_with_http_info(**kwargs) - else: - (data) = self.get_latest_periods_with_http_info(**kwargs) - return data - - def get_latest_periods_with_http_info(self, **kwargs): - """ - Get all periods - { \"nickname\" : \"Get all periods\",\"response\" : \"getPeriods.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_latest_periods_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: PeriodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_latest_periods" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/periods'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PeriodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/permissions_api.py b/billforward/apis/permissions_api.py deleted file mode 100644 index bbba09b..0000000 --- a/billforward/apis/permissions_api.py +++ /dev/null @@ -1,705 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class PermissionsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_permission(self, permission_request, **kwargs): - """ - Create a new permission. - {\"nickname\":\"Create a new permission\",\"request\":\"createPermissionRequest.html\",\"response\":\"createPermissionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_permission(permission_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase permission_request: (required) - :return: BFPermissionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_permission_with_http_info(permission_request, **kwargs) - else: - (data) = self.create_permission_with_http_info(permission_request, **kwargs) - return data - - def create_permission_with_http_info(self, permission_request, **kwargs): - """ - Create a new permission. - {\"nickname\":\"Create a new permission\",\"request\":\"createPermissionRequest.html\",\"response\":\"createPermissionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_permission_with_http_info(permission_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase permission_request: (required) - :return: BFPermissionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['permission_request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_permission" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'permission_request' is set - if ('permission_request' not in params) or (params['permission_request'] is None): - raise ValueError("Missing the required parameter `permission_request` when calling `create_permission`") - - resource_path = '/permissions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'permission_request' in params: - body_params = params['permission_request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='BFPermissionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_permissions(self, **kwargs): - """ - Retrieves a collection of all permissions. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve all permissions\",\"response\":\"getPermissionAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_permissions(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: BFPermissionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_permissions_with_http_info(**kwargs) - else: - (data) = self.get_all_permissions_with_http_info(**kwargs) - return data - - def get_all_permissions_with_http_info(self, **kwargs): - """ - Retrieves a collection of all permissions. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve all permissions\",\"response\":\"getPermissionAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_permissions_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: BFPermissionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_permissions" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/permissions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='BFPermissionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_available_actions_for_resource(self, resource, **kwargs): - """ - Retrieves all the available actions for the specified resource. - {\"nickname\":\"Retrieve available actions\",\"response\":\"getAvailableActions.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_actions_for_resource(resource, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str resource: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PermissionActionEntityPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_available_actions_for_resource_with_http_info(resource, **kwargs) - else: - (data) = self.get_available_actions_for_resource_with_http_info(resource, **kwargs) - return data - - def get_available_actions_for_resource_with_http_info(self, resource, **kwargs): - """ - Retrieves all the available actions for the specified resource. - {\"nickname\":\"Retrieve available actions\",\"response\":\"getAvailableActions.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_actions_for_resource_with_http_info(resource, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str resource: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PermissionActionEntityPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['resource', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_available_actions_for_resource" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'resource' is set - if ('resource' not in params) or (params['resource'] is None): - raise ValueError("Missing the required parameter `resource` when calling `get_available_actions_for_resource`") - - resource_path = '/permissions/resources/{resource}'.replace('{format}', 'json') - path_params = {} - if 'resource' in params: - path_params['resource'] = params['resource'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PermissionActionEntityPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_available_resources(self, **kwargs): - """ - Retrieves all available resource. - {\"nickname\":\"Retrieve available resources\",\"response\":\"getAvailableResources.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_resources(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PermissionResourceEntityPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_available_resources_with_http_info(**kwargs) - else: - (data) = self.get_available_resources_with_http_info(**kwargs) - return data - - def get_available_resources_with_http_info(self, **kwargs): - """ - Retrieves all available resource. - {\"nickname\":\"Retrieve available resources\",\"response\":\"getAvailableResources.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_resources_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PermissionResourceEntityPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_available_resources" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/permissions/resources'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PermissionResourceEntityPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_permission_by_id(self, permission_id, **kwargs): - """ - Retrieves a single permission, specified by the ID parameter. - {\"nickname\":\"Retrieve a permission\",\"response\":\"getPermissionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_permission_by_id(permission_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str permission_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: BFPermissionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_permission_by_id_with_http_info(permission_id, **kwargs) - else: - (data) = self.get_permission_by_id_with_http_info(permission_id, **kwargs) - return data - - def get_permission_by_id_with_http_info(self, permission_id, **kwargs): - """ - Retrieves a single permission, specified by the ID parameter. - {\"nickname\":\"Retrieve a permission\",\"response\":\"getPermissionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_permission_by_id_with_http_info(permission_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str permission_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: BFPermissionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['permission_id', 'organizations', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_permission_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'permission_id' is set - if ('permission_id' not in params) or (params['permission_id'] is None): - raise ValueError("Missing the required parameter `permission_id` when calling `get_permission_by_id`") - - resource_path = '/permissions/{permission-ID}'.replace('{format}', 'json') - path_params = {} - if 'permission_id' in params: - path_params['permission-ID'] = params['permission_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='BFPermissionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def revoke_permission(self, permission_id, **kwargs): - """ - Revokes a permission - {\"nickname\":\"Revoke permission\",\"response\":\"revokePermission.html\",\"request\":\"revokePErmissionRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.revoke_permission(permission_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str permission_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: BFPermissionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.revoke_permission_with_http_info(permission_id, **kwargs) - else: - (data) = self.revoke_permission_with_http_info(permission_id, **kwargs) - return data - - def revoke_permission_with_http_info(self, permission_id, **kwargs): - """ - Revokes a permission - {\"nickname\":\"Revoke permission\",\"response\":\"revokePermission.html\",\"request\":\"revokePErmissionRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.revoke_permission_with_http_info(permission_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str permission_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: BFPermissionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['permission_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method revoke_permission" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'permission_id' is set - if ('permission_id' not in params) or (params['permission_id'] is None): - raise ValueError("Missing the required parameter `permission_id` when calling `revoke_permission`") - - resource_path = '/permissions/{permission-ID}'.replace('{format}', 'json') - path_params = {} - if 'permission_id' in params: - path_params['permission-ID'] = params['permission_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='BFPermissionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/pricingcalculator_api.py b/billforward/apis/pricingcalculator_api.py deleted file mode 100644 index 0e958c1..0000000 --- a/billforward/apis/pricingcalculator_api.py +++ /dev/null @@ -1,363 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class PricingcalculatorApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def get_amendment_cost(self, ammendment_price_request, **kwargs): - """ - Calculates the price of a subscription's upgrading/downgrading to a new pricing component value. - { \"nickname\" : \"Calculate upgrade price\", \"request\" : \"AmendmentPriceRequest.html\" ,\"response\" : \"AmendmentPriceNTime.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendment_cost(ammendment_price_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase ammendment_price_request: An amendment pricing request (required) - :return: AmendmentPriceNTimePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_amendment_cost_with_http_info(ammendment_price_request, **kwargs) - else: - (data) = self.get_amendment_cost_with_http_info(ammendment_price_request, **kwargs) - return data - - def get_amendment_cost_with_http_info(self, ammendment_price_request, **kwargs): - """ - Calculates the price of a subscription's upgrading/downgrading to a new pricing component value. - { \"nickname\" : \"Calculate upgrade price\", \"request\" : \"AmendmentPriceRequest.html\" ,\"response\" : \"AmendmentPriceNTime.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_amendment_cost_with_http_info(ammendment_price_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase ammendment_price_request: An amendment pricing request (required) - :return: AmendmentPriceNTimePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['ammendment_price_request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_amendment_cost" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'ammendment_price_request' is set - if ('ammendment_price_request' not in params) or (params['ammendment_price_request'] is None): - raise ValueError("Missing the required parameter `ammendment_price_request` when calling `get_amendment_cost`") - - resource_path = '/pricing-calculator/amendment-cost'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'ammendment_price_request' in params: - body_params = params['ammendment_price_request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AmendmentPriceNTimePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupon_instance_initialisation_cost(self, coupon_instance_initialisation_request, **kwargs): - """ - Calculates the price of a subscription to a rate plan, at specified values of pricing component values, and with the specified coupon applied. - { \"nickname\" : \"Calculate price with a coupon\",\"request\" : \"PriceRequestWithCoupon.html\" ,\"response\" : \"PriceCalculationWithCoupon.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_instance_initialisation_cost(coupon_instance_initialisation_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase coupon_instance_initialisation_request: A coupon instance initialisation request (required) - :return: PriceCalculationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupon_instance_initialisation_cost_with_http_info(coupon_instance_initialisation_request, **kwargs) - else: - (data) = self.get_coupon_instance_initialisation_cost_with_http_info(coupon_instance_initialisation_request, **kwargs) - return data - - def get_coupon_instance_initialisation_cost_with_http_info(self, coupon_instance_initialisation_request, **kwargs): - """ - Calculates the price of a subscription to a rate plan, at specified values of pricing component values, and with the specified coupon applied. - { \"nickname\" : \"Calculate price with a coupon\",\"request\" : \"PriceRequestWithCoupon.html\" ,\"response\" : \"PriceCalculationWithCoupon.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupon_instance_initialisation_cost_with_http_info(coupon_instance_initialisation_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase coupon_instance_initialisation_request: A coupon instance initialisation request (required) - :return: PriceCalculationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['coupon_instance_initialisation_request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupon_instance_initialisation_cost" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'coupon_instance_initialisation_request' is set - if ('coupon_instance_initialisation_request' not in params) or (params['coupon_instance_initialisation_request'] is None): - raise ValueError("Missing the required parameter `coupon_instance_initialisation_request` when calling `get_coupon_instance_initialisation_cost`") - - resource_path = '/pricing-calculator/coupon-instance/initialisation'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'coupon_instance_initialisation_request' in params: - body_params = params['coupon_instance_initialisation_request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PriceCalculationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_product_rate_plan_costs(self, price_request, **kwargs): - """ - Calculates the price of a subscription to a rate plan, at specified values of pricing component values. - { \"nickname\" : \"Calculate price\", \"request\" : \"PriceRequest.html\" ,\"response\" : \"PriceCalculation.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_product_rate_plan_costs(price_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase price_request: A price request (required) - :return: PriceCalculationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_product_rate_plan_costs_with_http_info(price_request, **kwargs) - else: - (data) = self.get_product_rate_plan_costs_with_http_info(price_request, **kwargs) - return data - - def get_product_rate_plan_costs_with_http_info(self, price_request, **kwargs): - """ - Calculates the price of a subscription to a rate plan, at specified values of pricing component values. - { \"nickname\" : \"Calculate price\", \"request\" : \"PriceRequest.html\" ,\"response\" : \"PriceCalculation.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_product_rate_plan_costs_with_http_info(price_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase price_request: A price request (required) - :return: PriceCalculationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['price_request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_product_rate_plan_costs" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'price_request' is set - if ('price_request' not in params) or (params['price_request'] is None): - raise ValueError("Missing the required parameter `price_request` when calling `get_product_rate_plan_costs`") - - resource_path = '/pricing-calculator/product-rate-plan'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'price_request' in params: - body_params = params['price_request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PriceCalculationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/pricingcomponents_api.py b/billforward/apis/pricingcomponents_api.py deleted file mode 100644 index ed40d91..0000000 --- a/billforward/apis/pricingcomponents_api.py +++ /dev/null @@ -1,744 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class PricingcomponentsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_pricing_component(self, pricing_component, **kwargs): - """ - Create a pricing-component. - {\"nickname\":\"Create a new pricing-component\",\"request\":\"createPricingComponentRequest.html\",\"response\":\"createPricingComponentResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_pricing_component(pricing_component, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PricingComponent pricing_component: The pricing-component object to be updated. (required) - :return: PricingComponentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_pricing_component_with_http_info(pricing_component, **kwargs) - else: - (data) = self.create_pricing_component_with_http_info(pricing_component, **kwargs) - return data - - def create_pricing_component_with_http_info(self, pricing_component, **kwargs): - """ - Create a pricing-component. - {\"nickname\":\"Create a new pricing-component\",\"request\":\"createPricingComponentRequest.html\",\"response\":\"createPricingComponentResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_pricing_component_with_http_info(pricing_component, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PricingComponent pricing_component: The pricing-component object to be updated. (required) - :return: PricingComponentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pricing_component'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_pricing_component" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pricing_component' is set - if ('pricing_component' not in params) or (params['pricing_component'] is None): - raise ValueError("Missing the required parameter `pricing_component` when calling `create_pricing_component`") - - resource_path = '/pricing-components'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'pricing_component' in params: - body_params = params['pricing_component'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_pricing_components(self, **kwargs): - """ - Returns a collection of pricing-components. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all pricing-components\",\"response\":\"getPricingComponentsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_pricing_components(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PricingComponentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_pricing_components_with_http_info(**kwargs) - else: - (data) = self.get_all_pricing_components_with_http_info(**kwargs) - return data - - def get_all_pricing_components_with_http_info(self, **kwargs): - """ - Returns a collection of pricing-components. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all pricing-components\",\"response\":\"getPricingComponentsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_pricing_components_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PricingComponentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_pricing_components" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/pricing-components'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_pricing_component(self, pricing_component_id, **kwargs): - """ - Returns a collection of pricing-components, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve an existing pricing-component\",\"response\":\"getPricingComponentsByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component(pricing_component_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str pricing_component_id: The string ID of the pricing-component. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PricingComponentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_pricing_component_with_http_info(pricing_component_id, **kwargs) - else: - (data) = self.get_pricing_component_with_http_info(pricing_component_id, **kwargs) - return data - - def get_pricing_component_with_http_info(self, pricing_component_id, **kwargs): - """ - Returns a collection of pricing-components, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve an existing pricing-component\",\"response\":\"getPricingComponentsByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_with_http_info(pricing_component_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str pricing_component_id: The string ID of the pricing-component. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PricingComponentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pricing_component_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_pricing_component" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pricing_component_id' is set - if ('pricing_component_id' not in params) or (params['pricing_component_id'] is None): - raise ValueError("Missing the required parameter `pricing_component_id` when calling `get_pricing_component`") - - resource_path = '/pricing-components/{pricing-component-ID}'.replace('{format}', 'json') - path_params = {} - if 'pricing_component_id' in params: - path_params['pricing-component-ID'] = params['pricing_component_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_pricing_component_by_product_rate_plan_id(self, product_rate_plan_id, **kwargs): - """ - Returns a collection of pricing-components, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by rate-plan\",\"response\":\"getPricingComponentsByPRP.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_by_product_rate_plan_id(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: The string product-rate-plan-ID of the pricing-component. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PricingComponentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_pricing_component_by_product_rate_plan_id_with_http_info(product_rate_plan_id, **kwargs) - else: - (data) = self.get_pricing_component_by_product_rate_plan_id_with_http_info(product_rate_plan_id, **kwargs) - return data - - def get_pricing_component_by_product_rate_plan_id_with_http_info(self, product_rate_plan_id, **kwargs): - """ - Returns a collection of pricing-components, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by rate-plan\",\"response\":\"getPricingComponentsByPRP.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_by_product_rate_plan_id_with_http_info(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: The string product-rate-plan-ID of the pricing-component. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PricingComponentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_rate_plan_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_pricing_component_by_product_rate_plan_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_rate_plan_id' is set - if ('product_rate_plan_id' not in params) or (params['product_rate_plan_id'] is None): - raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `get_pricing_component_by_product_rate_plan_id`") - - resource_path = '/pricing-components/product-rate-plan/{product-rate-plan-ID}'.replace('{format}', 'json') - path_params = {} - if 'product_rate_plan_id' in params: - path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def retire_pricing_component(self, pricing_component_id, **kwargs): - """ - Retires the pricing-component specified by the pricing-component-ID parameter. - {\"nickname\":\"Delete a pricing-component\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_pricing_component(pricing_component_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str pricing_component_id: The string ID of the pricing-component. (required) - :param list[str] organizations: A list of organization IDs used to restrict the scope of API calls. - :return: PricingComponentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.retire_pricing_component_with_http_info(pricing_component_id, **kwargs) - else: - (data) = self.retire_pricing_component_with_http_info(pricing_component_id, **kwargs) - return data - - def retire_pricing_component_with_http_info(self, pricing_component_id, **kwargs): - """ - Retires the pricing-component specified by the pricing-component-ID parameter. - {\"nickname\":\"Delete a pricing-component\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_pricing_component_with_http_info(pricing_component_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str pricing_component_id: The string ID of the pricing-component. (required) - :param list[str] organizations: A list of organization IDs used to restrict the scope of API calls. - :return: PricingComponentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pricing_component_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method retire_pricing_component" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pricing_component_id' is set - if ('pricing_component_id' not in params) or (params['pricing_component_id'] is None): - raise ValueError("Missing the required parameter `pricing_component_id` when calling `retire_pricing_component`") - - resource_path = '/pricing-components/{pricing-component-ID}'.replace('{format}', 'json') - path_params = {} - if 'pricing_component_id' in params: - path_params['pricing-component-ID'] = params['pricing_component_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_pricing_component(self, pricing_component, **kwargs): - """ - Update a pricing-component. - {\"nickname\":\"Update a pricing-component\",\"request\":\"updatePricingComponentRequest.html\",\"response\":\"updatePricingComponentResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_pricing_component(pricing_component, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PricingComponent pricing_component: The pricing-component object to be updated. (required) - :return: PricingComponentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_pricing_component_with_http_info(pricing_component, **kwargs) - else: - (data) = self.update_pricing_component_with_http_info(pricing_component, **kwargs) - return data - - def update_pricing_component_with_http_info(self, pricing_component, **kwargs): - """ - Update a pricing-component. - {\"nickname\":\"Update a pricing-component\",\"request\":\"updatePricingComponentRequest.html\",\"response\":\"updatePricingComponentResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_pricing_component_with_http_info(pricing_component, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PricingComponent pricing_component: The pricing-component object to be updated. (required) - :return: PricingComponentPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pricing_component'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_pricing_component" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pricing_component' is set - if ('pricing_component' not in params) or (params['pricing_component'] is None): - raise ValueError("Missing the required parameter `pricing_component` when calling `update_pricing_component`") - - resource_path = '/pricing-components'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'pricing_component' in params: - body_params = params['pricing_component'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/pricingcomponenttiers_api.py b/billforward/apis/pricingcomponenttiers_api.py deleted file mode 100644 index 2b0ca1d..0000000 --- a/billforward/apis/pricingcomponenttiers_api.py +++ /dev/null @@ -1,624 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class PricingcomponenttiersApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_pricing_component_tier(self, pricing_component_tier, **kwargs): - """ - Create - {\"nickname\":\"Create a new tier\",\"request\":\"createPricingComponentTierRequest.html\",\"response\":\"createPricingComponentTierResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_pricing_component_tier(pricing_component_tier, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PricingComponentTier pricing_component_tier: The pricing-component-tier object to be updated. (required) - :return: PricingComponentTierPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_pricing_component_tier_with_http_info(pricing_component_tier, **kwargs) - else: - (data) = self.create_pricing_component_tier_with_http_info(pricing_component_tier, **kwargs) - return data - - def create_pricing_component_tier_with_http_info(self, pricing_component_tier, **kwargs): - """ - Create - {\"nickname\":\"Create a new tier\",\"request\":\"createPricingComponentTierRequest.html\",\"response\":\"createPricingComponentTierResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_pricing_component_tier_with_http_info(pricing_component_tier, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PricingComponentTier pricing_component_tier: The pricing-component-tier object to be updated. (required) - :return: PricingComponentTierPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pricing_component_tier'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_pricing_component_tier" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pricing_component_tier' is set - if ('pricing_component_tier' not in params) or (params['pricing_component_tier'] is None): - raise ValueError("Missing the required parameter `pricing_component_tier` when calling `create_pricing_component_tier`") - - resource_path = '/pricing-component-tiers'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'pricing_component_tier' in params: - body_params = params['pricing_component_tier'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentTierPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_pricing_component_tiers(self, **kwargs): - """ - Returns a collection of pricing-component-tier-tiers. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all tiers\",\"response\":\"getPricingComponentTiersAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_pricing_component_tiers(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-tier-tier to return. - :param int records: The maximum number of pricing-component-tier-tiers to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentTierPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_pricing_component_tiers_with_http_info(**kwargs) - else: - (data) = self.get_all_pricing_component_tiers_with_http_info(**kwargs) - return data - - def get_all_pricing_component_tiers_with_http_info(self, **kwargs): - """ - Returns a collection of pricing-component-tier-tiers. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all tiers\",\"response\":\"getPricingComponentTiersAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_pricing_component_tiers_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-tier-tier to return. - :param int records: The maximum number of pricing-component-tier-tiers to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentTierPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_pricing_component_tiers" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/pricing-component-tiers'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentTierPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_pricing_component_tier(self, pricing_component_tier_id, **kwargs): - """ - Returns a collection of pricing-component-tier-tiers, specified by the pricing-component-tier-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve an existing tier\",\"response\":\"getPricingComponentTiersByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_tier(pricing_component_tier_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str pricing_component_tier_id: The string ID of the pricing-component-tier-tier. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-tier-tier to return. - :param int records: The maximum number of pricing-component-tier-tiers to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentTierPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_pricing_component_tier_with_http_info(pricing_component_tier_id, **kwargs) - else: - (data) = self.get_pricing_component_tier_with_http_info(pricing_component_tier_id, **kwargs) - return data - - def get_pricing_component_tier_with_http_info(self, pricing_component_tier_id, **kwargs): - """ - Returns a collection of pricing-component-tier-tiers, specified by the pricing-component-tier-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve an existing tier\",\"response\":\"getPricingComponentTiersByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_tier_with_http_info(pricing_component_tier_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str pricing_component_tier_id: The string ID of the pricing-component-tier-tier. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-tier-tier to return. - :param int records: The maximum number of pricing-component-tier-tiers to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentTierPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pricing_component_tier_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_pricing_component_tier" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pricing_component_tier_id' is set - if ('pricing_component_tier_id' not in params) or (params['pricing_component_tier_id'] is None): - raise ValueError("Missing the required parameter `pricing_component_tier_id` when calling `get_pricing_component_tier`") - - resource_path = '/pricing-component-tiers/{pricing-component-tier-ID}'.replace('{format}', 'json') - path_params = {} - if 'pricing_component_tier_id' in params: - path_params['pricing-component-tier-ID'] = params['pricing_component_tier_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentTierPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_pricing_component_tier_by_product_rate_plan_id(self, product_rate_plan_id, **kwargs): - """ - Returns a collection of pricing-component-tier-tiers, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by rate-plan\",\"response\":\"getPricingComponentTiersByPRP.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_tier_by_product_rate_plan_id(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: The string product-rate-plan-ID of the pricing-component-tier-tier. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-tier-tier to return. - :param int records: The maximum number of pricing-component-tier-tiers to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentTierPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_pricing_component_tier_by_product_rate_plan_id_with_http_info(product_rate_plan_id, **kwargs) - else: - (data) = self.get_pricing_component_tier_by_product_rate_plan_id_with_http_info(product_rate_plan_id, **kwargs) - return data - - def get_pricing_component_tier_by_product_rate_plan_id_with_http_info(self, product_rate_plan_id, **kwargs): - """ - Returns a collection of pricing-component-tier-tiers, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by rate-plan\",\"response\":\"getPricingComponentTiersByPRP.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_tier_by_product_rate_plan_id_with_http_info(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: The string product-rate-plan-ID of the pricing-component-tier-tier. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-tier-tier to return. - :param int records: The maximum number of pricing-component-tier-tiers to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentTierPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_rate_plan_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_pricing_component_tier_by_product_rate_plan_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_rate_plan_id' is set - if ('product_rate_plan_id' not in params) or (params['product_rate_plan_id'] is None): - raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `get_pricing_component_tier_by_product_rate_plan_id`") - - resource_path = '/pricing-component-tiers/product-rate-plan/{product-rate-plan-ID}'.replace('{format}', 'json') - path_params = {} - if 'product_rate_plan_id' in params: - path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentTierPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_pricing_component_tier(self, pricing_component_tier, **kwargs): - """ - Update. - {\"nickname\":\"Update a tier\",\"request\":\"updatePricingComponentTierRequest.html\",\"response\":\"updatePricingComponentTierResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_pricing_component_tier(pricing_component_tier, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PricingComponentTier pricing_component_tier: The pricing-component-tier object to be updated. (required) - :return: PricingComponentTierPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_pricing_component_tier_with_http_info(pricing_component_tier, **kwargs) - else: - (data) = self.update_pricing_component_tier_with_http_info(pricing_component_tier, **kwargs) - return data - - def update_pricing_component_tier_with_http_info(self, pricing_component_tier, **kwargs): - """ - Update. - {\"nickname\":\"Update a tier\",\"request\":\"updatePricingComponentTierRequest.html\",\"response\":\"updatePricingComponentTierResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_pricing_component_tier_with_http_info(pricing_component_tier, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PricingComponentTier pricing_component_tier: The pricing-component-tier object to be updated. (required) - :return: PricingComponentTierPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pricing_component_tier'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_pricing_component_tier" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pricing_component_tier' is set - if ('pricing_component_tier' not in params) or (params['pricing_component_tier'] is None): - raise ValueError("Missing the required parameter `pricing_component_tier` when calling `update_pricing_component_tier`") - - resource_path = '/pricing-component-tiers'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'pricing_component_tier' in params: - body_params = params['pricing_component_tier'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentTierPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/pricingcomponentvaluechanges_api.py b/billforward/apis/pricingcomponentvaluechanges_api.py deleted file mode 100644 index 51854b5..0000000 --- a/billforward/apis/pricingcomponentvaluechanges_api.py +++ /dev/null @@ -1,752 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class PricingcomponentvaluechangesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_pricing_component_value_change(self, pricing_component_value_change, **kwargs): - """ - Create a pricing-component-value-change. - {\"nickname\":\"Create\",\"request\":\"createPricingComponentValueChangeRequest.html\",\"response\":\"createPricingComponentValueChangeResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_pricing_component_value_change(pricing_component_value_change, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param InsertableBillingEntity pricing_component_value_change: The pricing-component-value-change object to be updated. (required) - :return: PricingComponentValueChangePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_pricing_component_value_change_with_http_info(pricing_component_value_change, **kwargs) - else: - (data) = self.create_pricing_component_value_change_with_http_info(pricing_component_value_change, **kwargs) - return data - - def create_pricing_component_value_change_with_http_info(self, pricing_component_value_change, **kwargs): - """ - Create a pricing-component-value-change. - {\"nickname\":\"Create\",\"request\":\"createPricingComponentValueChangeRequest.html\",\"response\":\"createPricingComponentValueChangeResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_pricing_component_value_change_with_http_info(pricing_component_value_change, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param InsertableBillingEntity pricing_component_value_change: The pricing-component-value-change object to be updated. (required) - :return: PricingComponentValueChangePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pricing_component_value_change'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_pricing_component_value_change" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pricing_component_value_change' is set - if ('pricing_component_value_change' not in params) or (params['pricing_component_value_change'] is None): - raise ValueError("Missing the required parameter `pricing_component_value_change` when calling `create_pricing_component_value_change`") - - resource_path = '/pricing-component-value-changes'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'pricing_component_value_change' in params: - body_params = params['pricing_component_value_change'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValueChangePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_pricing_component_value_changes(self, **kwargs): - """ - Returns a collection of pricing-component-value-changes. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get All\",\"response\":\"getPricingComponentValueChangeAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_pricing_component_value_changes(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value-change to return. - :param int records: The maximum number of pricing-component-value-changes to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentValueChangePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_pricing_component_value_changes_with_http_info(**kwargs) - else: - (data) = self.get_all_pricing_component_value_changes_with_http_info(**kwargs) - return data - - def get_all_pricing_component_value_changes_with_http_info(self, **kwargs): - """ - Returns a collection of pricing-component-value-changes. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get All\",\"response\":\"getPricingComponentValueChangeAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_pricing_component_value_changes_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value-change to return. - :param int records: The maximum number of pricing-component-value-changes to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentValueChangePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_pricing_component_value_changes" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/pricing-component-value-changes'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValueChangePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_pricing_component_value_change(self, id, **kwargs): - """ - Returns a single pricing-component-value-changes, specified by the ID parameter. - {\"nickname\":\"Retrieve by id\",\"response\":\"getPricingComponentValueChangeByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_value_change(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The string ID of the pricing-component-value-change. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PricingComponentValueChangePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_pricing_component_value_change_with_http_info(id, **kwargs) - else: - (data) = self.get_pricing_component_value_change_with_http_info(id, **kwargs) - return data - - def get_pricing_component_value_change_with_http_info(self, id, **kwargs): - """ - Returns a single pricing-component-value-changes, specified by the ID parameter. - {\"nickname\":\"Retrieve by id\",\"response\":\"getPricingComponentValueChangeByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_value_change_with_http_info(id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str id: The string ID of the pricing-component-value-change. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PricingComponentValueChangePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_pricing_component_value_change" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'id' is set - if ('id' not in params) or (params['id'] is None): - raise ValueError("Missing the required parameter `id` when calling `get_pricing_component_value_change`") - - resource_path = '/pricing-component-value-changes/{ID}'.replace('{format}', 'json') - path_params = {} - if 'id' in params: - path_params['ID'] = params['id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValueChangePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_pricing_component_value_change_by_component_id(self, pricing_component_id, **kwargs): - """ - Returns a collection of pricing-component-value-changes, specified by the pricing-component-value-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by Component-ID\",\"response\":\"getPricingComponentValueChangeByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_value_change_by_component_id(pricing_component_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str pricing_component_id: The string ID of the pricing-component-value. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value-change to return. - :param int records: The maximum number of pricing-component-value-changes to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentValueChangePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_pricing_component_value_change_by_component_id_with_http_info(pricing_component_id, **kwargs) - else: - (data) = self.get_pricing_component_value_change_by_component_id_with_http_info(pricing_component_id, **kwargs) - return data - - def get_pricing_component_value_change_by_component_id_with_http_info(self, pricing_component_id, **kwargs): - """ - Returns a collection of pricing-component-value-changes, specified by the pricing-component-value-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by Component-ID\",\"response\":\"getPricingComponentValueChangeByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_value_change_by_component_id_with_http_info(pricing_component_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str pricing_component_id: The string ID of the pricing-component-value. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value-change to return. - :param int records: The maximum number of pricing-component-value-changes to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentValueChangePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pricing_component_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_pricing_component_value_change_by_component_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pricing_component_id' is set - if ('pricing_component_id' not in params) or (params['pricing_component_id'] is None): - raise ValueError("Missing the required parameter `pricing_component_id` when calling `get_pricing_component_value_change_by_component_id`") - - resource_path = '/pricing-component-value-changes/component-ID/{pricing-component-ID}'.replace('{format}', 'json') - path_params = {} - if 'pricing_component_id' in params: - path_params['pricing-component-ID'] = params['pricing_component_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValueChangePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_pricing_component_value_change_by_invoice_id(self, invoice_id, **kwargs): - """ - Returns a collection of pricing-component-value-changes, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by Invoice-ID\",\"response\":\"getPricingComponentValueChangeByInvoiceID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_value_change_by_invoice_id(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: The string invoice-ID of the pricing-component-value-change. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value-change to return. - :param int records: The maximum number of pricing-component-value-changes to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentValueChangePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_pricing_component_value_change_by_invoice_id_with_http_info(invoice_id, **kwargs) - else: - (data) = self.get_pricing_component_value_change_by_invoice_id_with_http_info(invoice_id, **kwargs) - return data - - def get_pricing_component_value_change_by_invoice_id_with_http_info(self, invoice_id, **kwargs): - """ - Returns a collection of pricing-component-value-changes, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by Invoice-ID\",\"response\":\"getPricingComponentValueChangeByInvoiceID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_value_change_by_invoice_id_with_http_info(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: The string invoice-ID of the pricing-component-value-change. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value-change to return. - :param int records: The maximum number of pricing-component-value-changes to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentValueChangePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_pricing_component_value_change_by_invoice_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `get_pricing_component_value_change_by_invoice_id`") - - resource_path = '/pricing-component-value-changes/invoice/{invoice-ID}'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValueChangePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_pricing_component_value_change_by_subscription_id(self, subscription_id, **kwargs): - """ - Returns a collection of pricing-component-value-changes, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by Subscription-ID\",\"response\":\"getPricingComponentValueChangeBySubscriptionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_value_change_by_subscription_id(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value-change to return. - :param int records: The maximum number of pricing-component-value-changes to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentValueChangePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_pricing_component_value_change_by_subscription_id_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_pricing_component_value_change_by_subscription_id_with_http_info(subscription_id, **kwargs) - return data - - def get_pricing_component_value_change_by_subscription_id_with_http_info(self, subscription_id, **kwargs): - """ - Returns a collection of pricing-component-value-changes, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by Subscription-ID\",\"response\":\"getPricingComponentValueChangeBySubscriptionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_value_change_by_subscription_id_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value-change to return. - :param int records: The maximum number of pricing-component-value-changes to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PricingComponentValueChangePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_pricing_component_value_change_by_subscription_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_pricing_component_value_change_by_subscription_id`") - - resource_path = '/pricing-component-value-changes/subscription/{subscription-ID}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValueChangePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/pricingcomponentvalues_api.py b/billforward/apis/pricingcomponentvalues_api.py deleted file mode 100644 index 723cf30..0000000 --- a/billforward/apis/pricingcomponentvalues_api.py +++ /dev/null @@ -1,636 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class PricingcomponentvaluesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_pricing_component_value(self, pricing_component_value, **kwargs): - """ - Create a pricing-component-value. - {\"nickname\":\"Create a new value\",\"request\":\"createPricingComponentValueRequest.html\",\"response\":\"createPricingComponentValueResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_pricing_component_value(pricing_component_value, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PricingComponentValue pricing_component_value: The pricing-component-value object to be updated. (required) - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_pricing_component_value_with_http_info(pricing_component_value, **kwargs) - else: - (data) = self.create_pricing_component_value_with_http_info(pricing_component_value, **kwargs) - return data - - def create_pricing_component_value_with_http_info(self, pricing_component_value, **kwargs): - """ - Create a pricing-component-value. - {\"nickname\":\"Create a new value\",\"request\":\"createPricingComponentValueRequest.html\",\"response\":\"createPricingComponentValueResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_pricing_component_value_with_http_info(pricing_component_value, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PricingComponentValue pricing_component_value: The pricing-component-value object to be updated. (required) - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pricing_component_value'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_pricing_component_value" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pricing_component_value' is set - if ('pricing_component_value' not in params) or (params['pricing_component_value'] is None): - raise ValueError("Missing the required parameter `pricing_component_value` when calling `create_pricing_component_value`") - - resource_path = '/pricing-component-values'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'pricing_component_value' in params: - body_params = params['pricing_component_value'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValuePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_pricing_component_values(self, **kwargs): - """ - Returns a collection of pricing-component-values.By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all values\",\"response\":\"getPricingComponentValueAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_pricing_component_values(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value to return. - :param int records: The maximum number of pricing-component-values to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_pricing_component_values_with_http_info(**kwargs) - else: - (data) = self.get_all_pricing_component_values_with_http_info(**kwargs) - return data - - def get_all_pricing_component_values_with_http_info(self, **kwargs): - """ - Returns a collection of pricing-component-values.By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all values\",\"response\":\"getPricingComponentValueAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_pricing_component_values_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value to return. - :param int records: The maximum number of pricing-component-values to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_pricing_component_values" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/pricing-component-values'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValuePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_pricing_component_value(self, pricing_component_id, **kwargs): - """ - Returns a collection of pricing-component-values, specified by the pricing-component-ID parameter.By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get existing values\",\"response\":\"getPricingComponentValueByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_value(pricing_component_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str pricing_component_id: The string ID of the pricing-component-value. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value to return. - :param int records: The maximum number of pricing-component-values to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_pricing_component_value_with_http_info(pricing_component_id, **kwargs) - else: - (data) = self.get_pricing_component_value_with_http_info(pricing_component_id, **kwargs) - return data - - def get_pricing_component_value_with_http_info(self, pricing_component_id, **kwargs): - """ - Returns a collection of pricing-component-values, specified by the pricing-component-ID parameter.By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get existing values\",\"response\":\"getPricingComponentValueByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_value_with_http_info(pricing_component_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str pricing_component_id: The string ID of the pricing-component-value. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value to return. - :param int records: The maximum number of pricing-component-values to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pricing_component_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_pricing_component_value" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pricing_component_id' is set - if ('pricing_component_id' not in params) or (params['pricing_component_id'] is None): - raise ValueError("Missing the required parameter `pricing_component_id` when calling `get_pricing_component_value`") - - resource_path = '/pricing-component-values/{pricing-component-ID}'.replace('{format}', 'json') - path_params = {} - if 'pricing_component_id' in params: - path_params['pricing-component-ID'] = params['pricing_component_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValuePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_pricing_component_value_by_subscription_id(self, subscription_id, **kwargs): - """ - Returns a collection of pricing-component-values, specified by the subscription-ID parameter.By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by subscription\",\"response\":\"getPricingComponentValueBySubscriptionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_value_by_subscription_id(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The string subscription-ID of the pricing-component-value. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value to return. - :param int records: The maximum number of pricing-component-values to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_pricing_component_value_by_subscription_id_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_pricing_component_value_by_subscription_id_with_http_info(subscription_id, **kwargs) - return data - - def get_pricing_component_value_by_subscription_id_with_http_info(self, subscription_id, **kwargs): - """ - Returns a collection of pricing-component-values, specified by the subscription-ID parameter.By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by subscription\",\"response\":\"getPricingComponentValueBySubscriptionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_value_by_subscription_id_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The string subscription-ID of the pricing-component-value. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component-value to return. - :param int records: The maximum number of pricing-component-values to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_pricing_component_value_by_subscription_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_pricing_component_value_by_subscription_id`") - - resource_path = '/pricing-component-values/subscription/{subscription-ID}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValuePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_pricing_component_value(self, pricing_component_value, **kwargs): - """ - Update a pricing-component-value. - {\"nickname\":\"Update a value\",\"request\":\"updatePricingComponentValueRequest.html\",\"response\":\"updatePricingComponentValueResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_pricing_component_value(pricing_component_value, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PricingComponentValue pricing_component_value: The pricing-component-value object to be updated. (required) - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_pricing_component_value_with_http_info(pricing_component_value, **kwargs) - else: - (data) = self.update_pricing_component_value_with_http_info(pricing_component_value, **kwargs) - return data - - def update_pricing_component_value_with_http_info(self, pricing_component_value, **kwargs): - """ - Update a pricing-component-value. - {\"nickname\":\"Update a value\",\"request\":\"updatePricingComponentValueRequest.html\",\"response\":\"updatePricingComponentValueResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_pricing_component_value_with_http_info(pricing_component_value, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PricingComponentValue pricing_component_value: The pricing-component-value object to be updated. (required) - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pricing_component_value'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_pricing_component_value" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pricing_component_value' is set - if ('pricing_component_value' not in params) or (params['pricing_component_value'] is None): - raise ValueError("Missing the required parameter `pricing_component_value` when calling `update_pricing_component_value`") - - resource_path = '/pricing-component-values'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'pricing_component_value' in params: - body_params = params['pricing_component_value'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValuePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/productrateplans_api.py b/billforward/apis/productrateplans_api.py deleted file mode 100644 index f05e07a..0000000 --- a/billforward/apis/productrateplans_api.py +++ /dev/null @@ -1,1679 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class ProductrateplansApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def add_taxation_strategy_to_rate_plan(self, product_rate_plan_id, taxation_strategy, **kwargs): - """ - Adds or re-enables the specified taxation-strategy for the given product-rate-plan. - {\"nickname\":\"Add tax\",\"response\":\"addTaxationStrategy.html\",\"request\":\"addTaxationStrategy.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_taxation_strategy_to_rate_plan(product_rate_plan_id, taxation_strategy, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param AddTaxationStrategyRequest taxation_strategy: The taxation-strategy (required) - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.add_taxation_strategy_to_rate_plan_with_http_info(product_rate_plan_id, taxation_strategy, **kwargs) - else: - (data) = self.add_taxation_strategy_to_rate_plan_with_http_info(product_rate_plan_id, taxation_strategy, **kwargs) - return data - - def add_taxation_strategy_to_rate_plan_with_http_info(self, product_rate_plan_id, taxation_strategy, **kwargs): - """ - Adds or re-enables the specified taxation-strategy for the given product-rate-plan. - {\"nickname\":\"Add tax\",\"response\":\"addTaxationStrategy.html\",\"request\":\"addTaxationStrategy.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_taxation_strategy_to_rate_plan_with_http_info(product_rate_plan_id, taxation_strategy, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param AddTaxationStrategyRequest taxation_strategy: The taxation-strategy (required) - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_rate_plan_id', 'taxation_strategy'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method add_taxation_strategy_to_rate_plan" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_rate_plan_id' is set - if ('product_rate_plan_id' not in params) or (params['product_rate_plan_id'] is None): - raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `add_taxation_strategy_to_rate_plan`") - # verify the required parameter 'taxation_strategy' is set - if ('taxation_strategy' not in params) or (params['taxation_strategy'] is None): - raise ValueError("Missing the required parameter `taxation_strategy` when calling `add_taxation_strategy_to_rate_plan`") - - resource_path = '/product-rate-plans/{product-rate-plan-ID}/tax'.replace('{format}', 'json') - path_params = {} - if 'product_rate_plan_id' in params: - path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'taxation_strategy' in params: - body_params = params['taxation_strategy'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def create_rate_plan(self, product_rate_plan, **kwargs): - """ - Create a new rate-plan. - {\"nickname\":\"Create a new rate-plan\",\"request\":\"createPRPRequest.html\",\"response\":\"createPRPResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_rate_plan(product_rate_plan, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ProductRatePlan product_rate_plan: The product-rate-plan object to be created. (required) - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_rate_plan_with_http_info(product_rate_plan, **kwargs) - else: - (data) = self.create_rate_plan_with_http_info(product_rate_plan, **kwargs) - return data - - def create_rate_plan_with_http_info(self, product_rate_plan, **kwargs): - """ - Create a new rate-plan. - {\"nickname\":\"Create a new rate-plan\",\"request\":\"createPRPRequest.html\",\"response\":\"createPRPResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_rate_plan_with_http_info(product_rate_plan, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ProductRatePlan product_rate_plan: The product-rate-plan object to be created. (required) - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_rate_plan'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_rate_plan" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_rate_plan' is set - if ('product_rate_plan' not in params) or (params['product_rate_plan'] is None): - raise ValueError("Missing the required parameter `product_rate_plan` when calling `create_rate_plan`") - - resource_path = '/product-rate-plans'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'product_rate_plan' in params: - body_params = params['product_rate_plan'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductRatePlanPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete_metadata_for_rate_plan(self, product_rate_plan_id, **kwargs): - """ - Remove any associated metadata. - {\"nickname\":\"Clear metadata from rate-plan\",\"request\" :\"deleteRatePlanMetadataRequest.html\",\"response\":\"deleteRatePlanMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_metadata_for_rate_plan(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_metadata_for_rate_plan_with_http_info(product_rate_plan_id, **kwargs) - else: - (data) = self.delete_metadata_for_rate_plan_with_http_info(product_rate_plan_id, **kwargs) - return data - - def delete_metadata_for_rate_plan_with_http_info(self, product_rate_plan_id, **kwargs): - """ - Remove any associated metadata. - {\"nickname\":\"Clear metadata from rate-plan\",\"request\" :\"deleteRatePlanMetadataRequest.html\",\"response\":\"deleteRatePlanMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_metadata_for_rate_plan_with_http_info(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_rate_plan_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_metadata_for_rate_plan" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_rate_plan_id' is set - if ('product_rate_plan_id' not in params) or (params['product_rate_plan_id'] is None): - raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `delete_metadata_for_rate_plan`") - - resource_path = '/product-rate-plans/{product-rate-plan-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'product_rate_plan_id' in params: - path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_rate_plans(self, **kwargs): - """ - Returns a collection of product-rate-plans. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all rate-plans\",\"response\":\"getPRPAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_rate_plans(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param str metadata: - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_rate_plans_with_http_info(**kwargs) - else: - (data) = self.get_all_rate_plans_with_http_info(**kwargs) - return data - - def get_all_rate_plans_with_http_info(self, **kwargs): - """ - Returns a collection of product-rate-plans. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all rate-plans\",\"response\":\"getPRPAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_rate_plans_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param str metadata: - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'metadata'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_rate_plans" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/product-rate-plans'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'metadata' in params: - query_params['metadata'] = params['metadata'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json', 'text/plain']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductRatePlanPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_available_taxation_strategies_for_rate_plan(self, product_rate_plan_id, **kwargs): - """ - Returns all available taxes for the specified product-rate-plan. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"List taxes\",\"response\":\"getAvailableTaxationStrategies.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_taxation_strategies_for_rate_plan(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_available_taxation_strategies_for_rate_plan_with_http_info(product_rate_plan_id, **kwargs) - else: - (data) = self.get_available_taxation_strategies_for_rate_plan_with_http_info(product_rate_plan_id, **kwargs) - return data - - def get_available_taxation_strategies_for_rate_plan_with_http_info(self, product_rate_plan_id, **kwargs): - """ - Returns all available taxes for the specified product-rate-plan. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"List taxes\",\"response\":\"getAvailableTaxationStrategies.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_taxation_strategies_for_rate_plan_with_http_info(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_rate_plan_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_available_taxation_strategies_for_rate_plan" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_rate_plan_id' is set - if ('product_rate_plan_id' not in params) or (params['product_rate_plan_id'] is None): - raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `get_available_taxation_strategies_for_rate_plan`") - - resource_path = '/product-rate-plans/{product-rate-plan-ID}/tax'.replace('{format}', 'json') - path_params = {} - if 'product_rate_plan_id' in params: - path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_metadata_for_rate_plan(self, product_rate_plan_id, **kwargs): - """ - Retrieve any associated metadata. - {\"nickname\":\"Retrieve metadata on rate-plan\",\"request\":\"getRatePlanMetadataRequest.html\",\"response\":\"getRatePlanMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_metadata_for_rate_plan(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_metadata_for_rate_plan_with_http_info(product_rate_plan_id, **kwargs) - else: - (data) = self.get_metadata_for_rate_plan_with_http_info(product_rate_plan_id, **kwargs) - return data - - def get_metadata_for_rate_plan_with_http_info(self, product_rate_plan_id, **kwargs): - """ - Retrieve any associated metadata. - {\"nickname\":\"Retrieve metadata on rate-plan\",\"request\":\"getRatePlanMetadataRequest.html\",\"response\":\"getRatePlanMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_metadata_for_rate_plan_with_http_info(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_rate_plan_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_metadata_for_rate_plan" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_rate_plan_id' is set - if ('product_rate_plan_id' not in params) or (params['product_rate_plan_id'] is None): - raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `get_metadata_for_rate_plan`") - - resource_path = '/product-rate-plans/{product-rate-plan-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'product_rate_plan_id' in params: - path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json', 'text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_product_rate_plan_by_id(self, product_rate_plan_id, **kwargs): - """ - Returns product-rate-plans, specified by the product-rate-plan id or name. - {\"nickname\":\"Retrieve an existing rate-plan\",\"response\":\"getPRPByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_product_rate_plan_by_id(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: id or name of the product-rate-plan. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_product_rate_plan_by_id_with_http_info(product_rate_plan_id, **kwargs) - else: - (data) = self.get_product_rate_plan_by_id_with_http_info(product_rate_plan_id, **kwargs) - return data - - def get_product_rate_plan_by_id_with_http_info(self, product_rate_plan_id, **kwargs): - """ - Returns product-rate-plans, specified by the product-rate-plan id or name. - {\"nickname\":\"Retrieve an existing rate-plan\",\"response\":\"getPRPByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_product_rate_plan_by_id_with_http_info(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: id or name of the product-rate-plan. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_rate_plan_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_product_rate_plan_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_rate_plan_id' is set - if ('product_rate_plan_id' not in params) or (params['product_rate_plan_id'] is None): - raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `get_product_rate_plan_by_id`") - - resource_path = '/product-rate-plans/{product-rate-plan-ID}'.replace('{format}', 'json') - path_params = {} - if 'product_rate_plan_id' in params: - path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductRatePlanPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_rate_plan_by_product(self, product_id, **kwargs): - """ - Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by product\",\"response\":\"getPRPByProductID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_rate_plan_by_product(product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_rate_plan_by_product_with_http_info(product_id, **kwargs) - else: - (data) = self.get_rate_plan_by_product_with_http_info(product_id, **kwargs) - return data - - def get_rate_plan_by_product_with_http_info(self, product_id, **kwargs): - """ - Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by product\",\"response\":\"getPRPByProductID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_rate_plan_by_product_with_http_info(product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_rate_plan_by_product" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_id' is set - if ('product_id' not in params) or (params['product_id'] is None): - raise ValueError("Missing the required parameter `product_id` when calling `get_rate_plan_by_product`") - - resource_path = '/product-rate-plans/product/{product-ID}'.replace('{format}', 'json') - path_params = {} - if 'product_id' in params: - path_params['product-ID'] = params['product_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductRatePlanPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_rate_plan_by_product_and_rate_plan(self, product_id, rate_plan_id, **kwargs): - """ - Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by name\",\"response\":\"getPRPByNameAndProduct.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_rate_plan_by_product_and_rate_plan(product_id, rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: (required) - :param str rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_rate_plan_by_product_and_rate_plan_with_http_info(product_id, rate_plan_id, **kwargs) - else: - (data) = self.get_rate_plan_by_product_and_rate_plan_with_http_info(product_id, rate_plan_id, **kwargs) - return data - - def get_rate_plan_by_product_and_rate_plan_with_http_info(self, product_id, rate_plan_id, **kwargs): - """ - Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by name\",\"response\":\"getPRPByNameAndProduct.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_rate_plan_by_product_and_rate_plan_with_http_info(product_id, rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: (required) - :param str rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_id', 'rate_plan_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_rate_plan_by_product_and_rate_plan" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_id' is set - if ('product_id' not in params) or (params['product_id'] is None): - raise ValueError("Missing the required parameter `product_id` when calling `get_rate_plan_by_product_and_rate_plan`") - # verify the required parameter 'rate_plan_id' is set - if ('rate_plan_id' not in params) or (params['rate_plan_id'] is None): - raise ValueError("Missing the required parameter `rate_plan_id` when calling `get_rate_plan_by_product_and_rate_plan`") - - resource_path = '/product-rate-plans/product/{product-ID}/rate-plan/{rate-plan-ID}'.replace('{format}', 'json') - path_params = {} - if 'product_id' in params: - path_params['product-ID'] = params['product_id'] - if 'rate_plan_id' in params: - path_params['rate-plan-ID'] = params['rate_plan_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductRatePlanPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def remove_taxation_strategy_from_rate_plan(self, product_rate_plan_id, taxation_strategy_id, **kwargs): - """ - Removes the specified taxation-strategy for the given product-rate-plan. - {\"nickname\":\"Remove tax\",\"response\":\"removeTaxationStrategy.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_taxation_strategy_from_rate_plan(product_rate_plan_id, taxation_strategy_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param str taxation_strategy_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.remove_taxation_strategy_from_rate_plan_with_http_info(product_rate_plan_id, taxation_strategy_id, **kwargs) - else: - (data) = self.remove_taxation_strategy_from_rate_plan_with_http_info(product_rate_plan_id, taxation_strategy_id, **kwargs) - return data - - def remove_taxation_strategy_from_rate_plan_with_http_info(self, product_rate_plan_id, taxation_strategy_id, **kwargs): - """ - Removes the specified taxation-strategy for the given product-rate-plan. - {\"nickname\":\"Remove tax\",\"response\":\"removeTaxationStrategy.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_taxation_strategy_from_rate_plan_with_http_info(product_rate_plan_id, taxation_strategy_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param str taxation_strategy_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_rate_plan_id', 'taxation_strategy_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method remove_taxation_strategy_from_rate_plan" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_rate_plan_id' is set - if ('product_rate_plan_id' not in params) or (params['product_rate_plan_id'] is None): - raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `remove_taxation_strategy_from_rate_plan`") - # verify the required parameter 'taxation_strategy_id' is set - if ('taxation_strategy_id' not in params) or (params['taxation_strategy_id'] is None): - raise ValueError("Missing the required parameter `taxation_strategy_id` when calling `remove_taxation_strategy_from_rate_plan`") - - resource_path = '/product-rate-plans/{product-rate-plan-ID}/tax/{taxation-strategy-ID}'.replace('{format}', 'json') - path_params = {} - if 'product_rate_plan_id' in params: - path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] - if 'taxation_strategy_id' in params: - path_params['taxation-strategy-ID'] = params['taxation_strategy_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def retire_rate_plan(self, product_rate_plan_id, **kwargs): - """ - Retires the product-rate-plan specified product-rate-plan-ID. - {\"nickname\":\"Delete a rate-plan\",\"response\":\"deletePRP.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_rate_plan(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.retire_rate_plan_with_http_info(product_rate_plan_id, **kwargs) - else: - (data) = self.retire_rate_plan_with_http_info(product_rate_plan_id, **kwargs) - return data - - def retire_rate_plan_with_http_info(self, product_rate_plan_id, **kwargs): - """ - Retires the product-rate-plan specified product-rate-plan-ID. - {\"nickname\":\"Delete a rate-plan\",\"response\":\"deletePRP.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_rate_plan_with_http_info(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_rate_plan_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method retire_rate_plan" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_rate_plan_id' is set - if ('product_rate_plan_id' not in params) or (params['product_rate_plan_id'] is None): - raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `retire_rate_plan`") - - resource_path = '/product-rate-plans/{product-rate-plan-ID}'.replace('{format}', 'json') - path_params = {} - if 'product_rate_plan_id' in params: - path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductRatePlanPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def set_metadata_for_rate_plan(self, metadata, product_rate_plan_id, **kwargs): - """ - Remove any existing metadata keys and create the provided data. - {\"nickname\":\"Set metadata on rate-plan\",\"request\":\"setRatePlanMetadataRequest.html\",\"response\":\"setRatePlanMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_metadata_for_rate_plan(metadata, product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.set_metadata_for_rate_plan_with_http_info(metadata, product_rate_plan_id, **kwargs) - else: - (data) = self.set_metadata_for_rate_plan_with_http_info(metadata, product_rate_plan_id, **kwargs) - return data - - def set_metadata_for_rate_plan_with_http_info(self, metadata, product_rate_plan_id, **kwargs): - """ - Remove any existing metadata keys and create the provided data. - {\"nickname\":\"Set metadata on rate-plan\",\"request\":\"setRatePlanMetadataRequest.html\",\"response\":\"setRatePlanMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_metadata_for_rate_plan_with_http_info(metadata, product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['metadata', 'product_rate_plan_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method set_metadata_for_rate_plan" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'metadata' is set - if ('metadata' not in params) or (params['metadata'] is None): - raise ValueError("Missing the required parameter `metadata` when calling `set_metadata_for_rate_plan`") - # verify the required parameter 'product_rate_plan_id' is set - if ('product_rate_plan_id' not in params) or (params['product_rate_plan_id'] is None): - raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `set_metadata_for_rate_plan`") - - resource_path = '/product-rate-plans/{product-rate-plan-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'product_rate_plan_id' in params: - path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'metadata' in params: - body_params = params['metadata'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_rate_plan(self, product_rate_plan, **kwargs): - """ - Update a rate-plan. - {\"nickname\":\"Update a rate-plan\",\"request\":\"updatePRPRequest.html\",\"response\":\"updatePRPResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_rate_plan(product_rate_plan, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ProductRatePlan product_rate_plan: The product-rate-plan object to be updated. (required) - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_rate_plan_with_http_info(product_rate_plan, **kwargs) - else: - (data) = self.update_rate_plan_with_http_info(product_rate_plan, **kwargs) - return data - - def update_rate_plan_with_http_info(self, product_rate_plan, **kwargs): - """ - Update a rate-plan. - {\"nickname\":\"Update a rate-plan\",\"request\":\"updatePRPRequest.html\",\"response\":\"updatePRPResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_rate_plan_with_http_info(product_rate_plan, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param ProductRatePlan product_rate_plan: The product-rate-plan object to be updated. (required) - :return: ProductRatePlanPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_rate_plan'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_rate_plan" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_rate_plan' is set - if ('product_rate_plan' not in params) or (params['product_rate_plan'] is None): - raise ValueError("Missing the required parameter `product_rate_plan` when calling `update_rate_plan`") - - resource_path = '/product-rate-plans'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'product_rate_plan' in params: - body_params = params['product_rate_plan'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductRatePlanPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def upsert_metadata_for_rate_plan(self, metadata, product_rate_plan_id, **kwargs): - """ - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - {\"nickname\":\"Upsert metadata on rate-plan\",\"request\":\"upsertRatePlanMetadataRequest.html\",\"response\":\"upsertRatePlanMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upsert_metadata_for_rate_plan(metadata, product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.upsert_metadata_for_rate_plan_with_http_info(metadata, product_rate_plan_id, **kwargs) - else: - (data) = self.upsert_metadata_for_rate_plan_with_http_info(metadata, product_rate_plan_id, **kwargs) - return data - - def upsert_metadata_for_rate_plan_with_http_info(self, metadata, product_rate_plan_id, **kwargs): - """ - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - {\"nickname\":\"Upsert metadata on rate-plan\",\"request\":\"upsertRatePlanMetadataRequest.html\",\"response\":\"upsertRatePlanMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upsert_metadata_for_rate_plan_with_http_info(metadata, product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['metadata', 'product_rate_plan_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method upsert_metadata_for_rate_plan" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'metadata' is set - if ('metadata' not in params) or (params['metadata'] is None): - raise ValueError("Missing the required parameter `metadata` when calling `upsert_metadata_for_rate_plan`") - # verify the required parameter 'product_rate_plan_id' is set - if ('product_rate_plan_id' not in params) or (params['product_rate_plan_id'] is None): - raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `upsert_metadata_for_rate_plan`") - - resource_path = '/product-rate-plans/{product-rate-plan-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'product_rate_plan_id' in params: - path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'metadata' in params: - body_params = params['metadata'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/products_api.py b/billforward/apis/products_api.py deleted file mode 100644 index 6be2a74..0000000 --- a/billforward/apis/products_api.py +++ /dev/null @@ -1,1066 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class ProductsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_product(self, product, **kwargs): - """ - Create a product. - {\"nickname\":\"Create a new product\",\"request\":\"createProductRequest.html\",\"response\":\"createProductResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_product(product, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Product product: The product object to be updated. (required) - :return: ProductPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_product_with_http_info(product, **kwargs) - else: - (data) = self.create_product_with_http_info(product, **kwargs) - return data - - def create_product_with_http_info(self, product, **kwargs): - """ - Create a product. - {\"nickname\":\"Create a new product\",\"request\":\"createProductRequest.html\",\"response\":\"createProductResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_product_with_http_info(product, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Product product: The product object to be updated. (required) - :return: ProductPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_product" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product' is set - if ('product' not in params) or (params['product'] is None): - raise ValueError("Missing the required parameter `product` when calling `create_product`") - - resource_path = '/products'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'product' in params: - body_params = params['product'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete_metadata_for_product(self, product_id, **kwargs): - """ - Remove any associated metadata. - {\"nickname\":\"Clear metadata from product\",\"request\" :\"deleteProductMetadataRequest.html\",\"response\":\"deleteProductMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_metadata_for_product(product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_metadata_for_product_with_http_info(product_id, **kwargs) - else: - (data) = self.delete_metadata_for_product_with_http_info(product_id, **kwargs) - return data - - def delete_metadata_for_product_with_http_info(self, product_id, **kwargs): - """ - Remove any associated metadata. - {\"nickname\":\"Clear metadata from product\",\"request\" :\"deleteProductMetadataRequest.html\",\"response\":\"deleteProductMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_metadata_for_product_with_http_info(product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_metadata_for_product" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_id' is set - if ('product_id' not in params) or (params['product_id'] is None): - raise ValueError("Missing the required parameter `product_id` when calling `delete_metadata_for_product`") - - resource_path = '/products/{product-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'product_id' in params: - path_params['product-ID'] = params['product_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_products(self, **kwargs): - """ - Returns a collection of products. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all products\",\"response\":\"getProductAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_products(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product to return. - :param int records: The maximum number of products to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param str metadata: - :return: ProductPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_products_with_http_info(**kwargs) - else: - (data) = self.get_all_products_with_http_info(**kwargs) - return data - - def get_all_products_with_http_info(self, **kwargs): - """ - Returns a collection of products. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all products\",\"response\":\"getProductAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_products_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product to return. - :param int records: The maximum number of products to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :param str metadata: - :return: ProductPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'metadata'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_products" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/products'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'metadata' in params: - query_params['metadata'] = params['metadata'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json', 'text/plain']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_metadata_for_product(self, product_id, **kwargs): - """ - Retrieve any associated metadata. - {\"nickname\":\"Retrieve metadata on product\",\"request\":\"getProductMetadataRequest.html\",\"response\":\"getProductMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_metadata_for_product(product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_metadata_for_product_with_http_info(product_id, **kwargs) - else: - (data) = self.get_metadata_for_product_with_http_info(product_id, **kwargs) - return data - - def get_metadata_for_product_with_http_info(self, product_id, **kwargs): - """ - Retrieve any associated metadata. - {\"nickname\":\"Retrieve metadata on product\",\"request\":\"getProductMetadataRequest.html\",\"response\":\"getProductMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_metadata_for_product_with_http_info(product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_metadata_for_product" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_id' is set - if ('product_id' not in params) or (params['product_id'] is None): - raise ValueError("Missing the required parameter `product_id` when calling `get_metadata_for_product`") - - resource_path = '/products/{product-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'product_id' in params: - path_params['product-ID'] = params['product_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json', 'text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_product_by_id(self, product_id, **kwargs): - """ - Returns a single product, specified by the product-ID parameter. - {\"nickname\":\"Retrieve an existing product\",\"response\":\"getProductByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_product_by_id(product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: ID or name of the product. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: ProductPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_product_by_id_with_http_info(product_id, **kwargs) - else: - (data) = self.get_product_by_id_with_http_info(product_id, **kwargs) - return data - - def get_product_by_id_with_http_info(self, product_id, **kwargs): - """ - Returns a single product, specified by the product-ID parameter. - {\"nickname\":\"Retrieve an existing product\",\"response\":\"getProductByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_product_by_id_with_http_info(product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: ID or name of the product. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first product-rate-plan to return. - :param int records: The maximum number of product-rate-plans to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: ProductPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_product_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_id' is set - if ('product_id' not in params) or (params['product_id'] is None): - raise ValueError("Missing the required parameter `product_id` when calling `get_product_by_id`") - - resource_path = '/products/{product-ID}'.replace('{format}', 'json') - path_params = {} - if 'product_id' in params: - path_params['product-ID'] = params['product_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def retire_product(self, product_id, **kwargs): - """ - Deletes the product specified by the product-ID parameter. Any existing subscriptions will continue; it is a soft delete. - {\"nickname\":\"Delete a product\",\"response\":\"deleteProduct.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_product(product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: ID of the Product. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: ProductPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.retire_product_with_http_info(product_id, **kwargs) - else: - (data) = self.retire_product_with_http_info(product_id, **kwargs) - return data - - def retire_product_with_http_info(self, product_id, **kwargs): - """ - Deletes the product specified by the product-ID parameter. Any existing subscriptions will continue; it is a soft delete. - {\"nickname\":\"Delete a product\",\"response\":\"deleteProduct.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_product_with_http_info(product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: ID of the Product. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: ProductPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method retire_product" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_id' is set - if ('product_id' not in params) or (params['product_id'] is None): - raise ValueError("Missing the required parameter `product_id` when calling `retire_product`") - - resource_path = '/products/{product-ID}'.replace('{format}', 'json') - path_params = {} - if 'product_id' in params: - path_params['product-ID'] = params['product_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def set_metadata_for_product(self, metadata, product_id, **kwargs): - """ - Remove any existing metadata keys and create the provided data. - {\"nickname\":\"Set metadata on product\",\"request\":\"setProductMetadataRequest.html\",\"response\":\"setProductMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_metadata_for_product(metadata, product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str product_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.set_metadata_for_product_with_http_info(metadata, product_id, **kwargs) - else: - (data) = self.set_metadata_for_product_with_http_info(metadata, product_id, **kwargs) - return data - - def set_metadata_for_product_with_http_info(self, metadata, product_id, **kwargs): - """ - Remove any existing metadata keys and create the provided data. - {\"nickname\":\"Set metadata on product\",\"request\":\"setProductMetadataRequest.html\",\"response\":\"setProductMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_metadata_for_product_with_http_info(metadata, product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str product_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['metadata', 'product_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method set_metadata_for_product" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'metadata' is set - if ('metadata' not in params) or (params['metadata'] is None): - raise ValueError("Missing the required parameter `metadata` when calling `set_metadata_for_product`") - # verify the required parameter 'product_id' is set - if ('product_id' not in params) or (params['product_id'] is None): - raise ValueError("Missing the required parameter `product_id` when calling `set_metadata_for_product`") - - resource_path = '/products/{product-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'product_id' in params: - path_params['product-ID'] = params['product_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'metadata' in params: - body_params = params['metadata'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_product(self, product, **kwargs): - """ - Update a product. - {\"nickname\":\"Update a product\",\"request\":\"updateProductRequest.html\",\"response\":\"updateProductResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_product(product, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Product product: The product object to be updated. (required) - :return: ProductPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_product_with_http_info(product, **kwargs) - else: - (data) = self.update_product_with_http_info(product, **kwargs) - return data - - def update_product_with_http_info(self, product, **kwargs): - """ - Update a product. - {\"nickname\":\"Update a product\",\"request\":\"updateProductRequest.html\",\"response\":\"updateProductResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_product_with_http_info(product, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Product product: The product object to be updated. (required) - :return: ProductPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_product" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product' is set - if ('product' not in params) or (params['product'] is None): - raise ValueError("Missing the required parameter `product` when calling `update_product`") - - resource_path = '/products'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'product' in params: - body_params = params['product'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProductPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def upsert_metadata_for_product(self, metadata, product_id, **kwargs): - """ - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - {\"nickname\":\"Upsert metadata on product\",\"request\":\"upsertProductMetadataRequest.html\",\"response\":\"upsertProductMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upsert_metadata_for_product(metadata, product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str product_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.upsert_metadata_for_product_with_http_info(metadata, product_id, **kwargs) - else: - (data) = self.upsert_metadata_for_product_with_http_info(metadata, product_id, **kwargs) - return data - - def upsert_metadata_for_product_with_http_info(self, metadata, product_id, **kwargs): - """ - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - {\"nickname\":\"Upsert metadata on product\",\"request\":\"upsertProductMetadataRequest.html\",\"response\":\"upsertProductMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upsert_metadata_for_product_with_http_info(metadata, product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str product_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['metadata', 'product_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method upsert_metadata_for_product" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'metadata' is set - if ('metadata' not in params) or (params['metadata'] is None): - raise ValueError("Missing the required parameter `metadata` when calling `upsert_metadata_for_product`") - # verify the required parameter 'product_id' is set - if ('product_id' not in params) or (params['product_id'] is None): - raise ValueError("Missing the required parameter `product_id` when calling `upsert_metadata_for_product`") - - resource_path = '/products/{product-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'product_id' in params: - path_params['product-ID'] = params['product_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'metadata' in params: - body_params = params['metadata'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/profiles_api.py b/billforward/apis/profiles_api.py deleted file mode 100644 index 9ba2f5b..0000000 --- a/billforward/apis/profiles_api.py +++ /dev/null @@ -1,632 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class ProfilesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def get_all_profiles(self, **kwargs): - """ - Returns a collection of all profiles. By default 10 values are returned. Records are returned in natural order - {\"nickname\":\"Get all profiles\",\"response\":\"getProfileAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_profiles(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organizations used to restrict the scope of API calls. - :param int offset: The offset from the first profile to return. - :param int records: The maximum number of profiles to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: ProfilePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_profiles_with_http_info(**kwargs) - else: - (data) = self.get_all_profiles_with_http_info(**kwargs) - return data - - def get_all_profiles_with_http_info(self, **kwargs): - """ - Returns a collection of all profiles. By default 10 values are returned. Records are returned in natural order - {\"nickname\":\"Get all profiles\",\"response\":\"getProfileAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_profiles_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organizations used to restrict the scope of API calls. - :param int offset: The offset from the first profile to return. - :param int records: The maximum number of profiles to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: ProfilePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_profiles" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/profiles'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProfilePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_profile(self, profile_id, **kwargs): - """ - Returns a single profile, specified by the ID parameter. - {\"nickname\":\"Retrieve an existing profile\",\"response\":\"getProfileByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_profile(profile_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str profile_id: ID of the Profile. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: ProfilePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_profile_with_http_info(profile_id, **kwargs) - else: - (data) = self.get_profile_with_http_info(profile_id, **kwargs) - return data - - def get_profile_with_http_info(self, profile_id, **kwargs): - """ - Returns a single profile, specified by the ID parameter. - {\"nickname\":\"Retrieve an existing profile\",\"response\":\"getProfileByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_profile_with_http_info(profile_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str profile_id: ID of the Profile. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: ProfilePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['profile_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_profile" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'profile_id' is set - if ('profile_id' not in params) or (params['profile_id'] is None): - raise ValueError("Missing the required parameter `profile_id` when calling `get_profile`") - - resource_path = '/profiles/{profile-ID}'.replace('{format}', 'json') - path_params = {} - if 'profile_id' in params: - path_params['profile-ID'] = params['profile_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProfilePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_profile_by_account_id(self, account_id, **kwargs): - """ - Returns a collection of profiles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order - {\"nickname\":\"Retrieve by account\",\"response\":\"getProfileByAccountID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_profile_by_account_id(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The account-ID of the profile. (required) - :param list[str] organizations: A list of organizations used to restrict the scope of API calls. - :param int offset: The offset from the first profile to return. - :param int records: The maximum number of profiles to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: ProfilePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_profile_by_account_id_with_http_info(account_id, **kwargs) - else: - (data) = self.get_profile_by_account_id_with_http_info(account_id, **kwargs) - return data - - def get_profile_by_account_id_with_http_info(self, account_id, **kwargs): - """ - Returns a collection of profiles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order - {\"nickname\":\"Retrieve by account\",\"response\":\"getProfileByAccountID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_profile_by_account_id_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The account-ID of the profile. (required) - :param list[str] organizations: A list of organizations used to restrict the scope of API calls. - :param int offset: The offset from the first profile to return. - :param int records: The maximum number of profiles to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: ProfilePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_profile_by_account_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_profile_by_account_id`") - - resource_path = '/profiles/account/{account-ID}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProfilePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_profile_by_email_address(self, email, **kwargs): - """ - Returns a single profile, specified by the email parameter. - {\"nickname\":\"Retrieve by e-mail\",\"response\":\"getProfileByEmail.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_profile_by_email_address(email, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email: The email address of the profile. (required) - :param list[str] organizations: A list of organizations used to restrict the scope of API calls. - :param int offset: The offset from the first profile to return. - :param int records: The maximum number of profiles to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired profiles should be returned. - :return: ProfilePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_profile_by_email_address_with_http_info(email, **kwargs) - else: - (data) = self.get_profile_by_email_address_with_http_info(email, **kwargs) - return data - - def get_profile_by_email_address_with_http_info(self, email, **kwargs): - """ - Returns a single profile, specified by the email parameter. - {\"nickname\":\"Retrieve by e-mail\",\"response\":\"getProfileByEmail.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_profile_by_email_address_with_http_info(email, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str email: The email address of the profile. (required) - :param list[str] organizations: A list of organizations used to restrict the scope of API calls. - :param int offset: The offset from the first profile to return. - :param int records: The maximum number of profiles to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired profiles should be returned. - :return: ProfilePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['email', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_profile_by_email_address" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'email' is set - if ('email' not in params) or (params['email'] is None): - raise ValueError("Missing the required parameter `email` when calling `get_profile_by_email_address`") - - resource_path = '/profiles/email/{email}'.replace('{format}', 'json') - path_params = {} - if 'email' in params: - path_params['email'] = params['email'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProfilePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_profile(self, request, **kwargs): - """ - Update a profile - {\"nickname\":\"Update a profile\",\"request\":\"updateProfileRequest.html\",\"response\":\"updateProfileResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_profile(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UpdateProfileRequest request: The profile object to be updated. (required) - :return: ProfilePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_profile_with_http_info(request, **kwargs) - else: - (data) = self.update_profile_with_http_info(request, **kwargs) - return data - - def update_profile_with_http_info(self, request, **kwargs): - """ - Update a profile - {\"nickname\":\"Update a profile\",\"request\":\"updateProfileRequest.html\",\"response\":\"updateProfileResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_profile_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UpdateProfileRequest request: The profile object to be updated. (required) - :return: ProfilePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_profile" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `update_profile`") - - resource_path = '/profiles'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ProfilePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/quotes_api.py b/billforward/apis/quotes_api.py deleted file mode 100644 index 44a70eb..0000000 --- a/billforward/apis/quotes_api.py +++ /dev/null @@ -1,155 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class QuotesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def quote(self, quote_request, **kwargs): - """ - Returns a quote. - {\"nickname\":\"Returns a quote\",\"request\":\"PriceRequest.html\",\"response\":\"PriceCalculation.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.quote(quote_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param QuoteRequest quote_request: A quote request (required) - :return: APIQuotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.quote_with_http_info(quote_request, **kwargs) - else: - (data) = self.quote_with_http_info(quote_request, **kwargs) - return data - - def quote_with_http_info(self, quote_request, **kwargs): - """ - Returns a quote. - {\"nickname\":\"Returns a quote\",\"request\":\"PriceRequest.html\",\"response\":\"PriceCalculation.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.quote_with_http_info(quote_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param QuoteRequest quote_request: A quote request (required) - :return: APIQuotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['quote_request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method quote" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'quote_request' is set - if ('quote_request' not in params) or (params['quote_request'] is None): - raise ValueError("Missing the required parameter `quote_request` when calling `quote`") - - resource_path = '/quotes'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'quote_request' in params: - body_params = params['quote_request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='APIQuotePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/receipts_api.py b/billforward/apis/receipts_api.py deleted file mode 100644 index 271304a..0000000 --- a/billforward/apis/receipts_api.py +++ /dev/null @@ -1,906 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class ReceiptsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_receipt(self, receipt, **kwargs): - """ - Create a receipt. - {\"nickname\":\"Create a new receipt\",\"request\":\"createReceiptRequest.html\",\"response\":\"createReceiptResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_receipt(receipt, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Receipt receipt: The receipt object to be created. (required) - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_receipt_with_http_info(receipt, **kwargs) - else: - (data) = self.create_receipt_with_http_info(receipt, **kwargs) - return data - - def create_receipt_with_http_info(self, receipt, **kwargs): - """ - Create a receipt. - {\"nickname\":\"Create a new receipt\",\"request\":\"createReceiptRequest.html\",\"response\":\"createReceiptResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_receipt_with_http_info(receipt, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Receipt receipt: The receipt object to be created. (required) - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['receipt'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_receipt" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'receipt' is set - if ('receipt' not in params) or (params['receipt'] is None): - raise ValueError("Missing the required parameter `receipt` when calling `create_receipt`") - - resource_path = '/receipts'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'receipt' in params: - body_params = params['receipt'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ReceiptPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_receipts(self, **kwargs): - """ - Returns a collection of all receipts. By default 10 values are returned. receipts are returned in natural order - {\"nickname\":\"Get all receipts\",\"response\":\"getreceiptsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_receipts(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first receipt to return. - :param int records: The maximum number of receipts to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param list[str] account_id: - :param list[str] invoice_id: - :param list[str] payment_method_id: - :param str type: - :param str gateway: - :param str decision: - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_receipts_with_http_info(**kwargs) - else: - (data) = self.get_all_receipts_with_http_info(**kwargs) - return data - - def get_all_receipts_with_http_info(self, **kwargs): - """ - Returns a collection of all receipts. By default 10 values are returned. receipts are returned in natural order - {\"nickname\":\"Get all receipts\",\"response\":\"getreceiptsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_receipts_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first receipt to return. - :param int records: The maximum number of receipts to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param list[str] account_id: - :param list[str] invoice_id: - :param list[str] payment_method_id: - :param str type: - :param str gateway: - :param str decision: - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'account_id', 'invoice_id', 'payment_method_id', 'type', 'gateway', 'decision'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_receipts" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/receipts'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'account_id' in params: - query_params['account_id'] = params['account_id'] - if 'invoice_id' in params: - query_params['invoice_id'] = params['invoice_id'] - if 'payment_method_id' in params: - query_params['payment_method_id'] = params['payment_method_id'] - if 'type' in params: - query_params['type'] = params['type'] - if 'gateway' in params: - query_params['gateway'] = params['gateway'] - if 'decision' in params: - query_params['decision'] = params['decision'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ReceiptPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_receipt_by_id(self, receipt_id, **kwargs): - """ - Returns a single receipt, specified by the ID parameter. - {\"nickname\":\"Retrieve an existing receipt\",\"response\":\"getreceiptByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_receipt_by_id(receipt_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str receipt_id: ID of the receipt. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_receipt_by_id_with_http_info(receipt_id, **kwargs) - else: - (data) = self.get_receipt_by_id_with_http_info(receipt_id, **kwargs) - return data - - def get_receipt_by_id_with_http_info(self, receipt_id, **kwargs): - """ - Returns a single receipt, specified by the ID parameter. - {\"nickname\":\"Retrieve an existing receipt\",\"response\":\"getreceiptByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_receipt_by_id_with_http_info(receipt_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str receipt_id: ID of the receipt. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['receipt_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_receipt_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'receipt_id' is set - if ('receipt_id' not in params) or (params['receipt_id'] is None): - raise ValueError("Missing the required parameter `receipt_id` when calling `get_receipt_by_id`") - - resource_path = '/receipts/{receipt-ID}'.replace('{format}', 'json') - path_params = {} - if 'receipt_id' in params: - path_params['receipt-ID'] = params['receipt_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ReceiptPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_receipts_by_invoice(self, invoice_id, **kwargs): - """ - Returns a receipt for the receipt payment. - {\"nickname\":\"Retrieve by invoice\",\"response\":\"getreceiptsByInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_receipts_by_invoice(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: ID of the Invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first receipt to return. - :param int records: The maximum number of receipts to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_receipts_by_invoice_with_http_info(invoice_id, **kwargs) - else: - (data) = self.get_receipts_by_invoice_with_http_info(invoice_id, **kwargs) - return data - - def get_receipts_by_invoice_with_http_info(self, invoice_id, **kwargs): - """ - Returns a receipt for the receipt payment. - {\"nickname\":\"Retrieve by invoice\",\"response\":\"getreceiptsByInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_receipts_by_invoice_with_http_info(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: ID of the Invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first receipt to return. - :param int records: The maximum number of receipts to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_receipts_by_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `get_receipts_by_invoice`") - - resource_path = '/receipts/invoice/{invoice-ID}'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ReceiptPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_receipts_by_payment(self, payment_id, **kwargs): - """ - Returns a collection of receipts for the payment. - {\"nickname\":\"Retrieve by payment\",\"response\":\"getreceiptsByPayment.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_receipts_by_payment(payment_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_id: ID of the payment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first receipt to return. - :param int records: The maximum number of receipts to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_receipts_by_payment_with_http_info(payment_id, **kwargs) - else: - (data) = self.get_receipts_by_payment_with_http_info(payment_id, **kwargs) - return data - - def get_receipts_by_payment_with_http_info(self, payment_id, **kwargs): - """ - Returns a collection of receipts for the payment. - {\"nickname\":\"Retrieve by payment\",\"response\":\"getreceiptsByPayment.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_receipts_by_payment_with_http_info(payment_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_id: ID of the payment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first receipt to return. - :param int records: The maximum number of receipts to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_receipts_by_payment" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment_id' is set - if ('payment_id' not in params) or (params['payment_id'] is None): - raise ValueError("Missing the required parameter `payment_id` when calling `get_receipts_by_payment`") - - resource_path = '/receipts/payment/{payment-ID}'.replace('{format}', 'json') - path_params = {} - if 'payment_id' in params: - path_params['payment-ID'] = params['payment_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ReceiptPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_receipts_for_debit_payments_as_csv(self, **kwargs): - """ - Retrieves debit payments in CSV format. - { \"nickname\":\"Debit payments CSV\",\"response\":\"Debit payments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_receipts_for_debit_payments_as_csv(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str received_start: The UTC DateTime specifying the start of the interval within which payments were received. - :param str received_end: The UTC DateTime specifying the end of the interval within which payments were received. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :param list[str] gateway: A list of payment gateways to include in the account. If none are specified, all gateways will be included. - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_receipts_for_debit_payments_as_csv_with_http_info(**kwargs) - else: - (data) = self.get_receipts_for_debit_payments_as_csv_with_http_info(**kwargs) - return data - - def get_receipts_for_debit_payments_as_csv_with_http_info(self, **kwargs): - """ - Retrieves debit payments in CSV format. - { \"nickname\":\"Debit payments CSV\",\"response\":\"Debit payments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_receipts_for_debit_payments_as_csv_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str received_start: The UTC DateTime specifying the start of the interval within which payments were received. - :param str received_end: The UTC DateTime specifying the end of the interval within which payments were received. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :param list[str] gateway: A list of payment gateways to include in the account. If none are specified, all gateways will be included. - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'received_start', 'received_end', 'offset', 'records', 'order_by', 'order', 'gateway'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_receipts_for_debit_payments_as_csv" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/receipts/debits.csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'received_start' in params: - query_params['received_start'] = params['received_start'] - if 'received_end' in params: - query_params['received_end'] = params['received_end'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'gateway' in params: - query_params['gateway'] = params['gateway'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ReceiptPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_receipts_for_refund_payments_as_csv(self, **kwargs): - """ - Retrieves refunded payments in CSV format. - { \"nickname\":\"Refunded payments CSV\",\"response\":\"Refunded payments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_receipts_for_refund_payments_as_csv(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str completed_start: The UTC DateTime specifying the start of the interval within which payments were received. - :param str completed_end: The UTC DateTime specifying the end of the interval within which payments were received. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_receipts_for_refund_payments_as_csv_with_http_info(**kwargs) - else: - (data) = self.get_receipts_for_refund_payments_as_csv_with_http_info(**kwargs) - return data - - def get_receipts_for_refund_payments_as_csv_with_http_info(self, **kwargs): - """ - Retrieves refunded payments in CSV format. - { \"nickname\":\"Refunded payments CSV\",\"response\":\"Refunded payments.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_receipts_for_refund_payments_as_csv_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param str completed_start: The UTC DateTime specifying the start of the interval within which payments were received. - :param str completed_end: The UTC DateTime specifying the end of the interval within which payments were received. - :param int offset: The offset from the first payment to return. - :param int records: The maximum number of payments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: ReceiptPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'completed_start', 'completed_end', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_receipts_for_refund_payments_as_csv" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/receipts/refunds.csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'completed_start' in params: - query_params['completed_start'] = params['completed_start'] - if 'completed_end' in params: - query_params['completed_end'] = params['completed_end'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='ReceiptPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/refunds_api.py b/billforward/apis/refunds_api.py deleted file mode 100644 index 59b0c5a..0000000 --- a/billforward/apis/refunds_api.py +++ /dev/null @@ -1,939 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class RefundsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_refund(self, refund, **kwargs): - """ -

When creating a refund either the invoice, or invoice payment must be specified.

Creating a refund by specifying the invoiceID will refund any un-refunded value up to the full value of the payment. When refunding via the invoicePaymentID the same rules apply. Refunds will be processed by the same payment methods that took the payment.

Refunds can be for a partial amount of the payment. It is possible to create refunds up to the value of the total payment.

Once a payment or invoice is fully refunded, no more refunds can be created. Errors will be returned if the payment is greater than available refund funds.

- {\"nickname\":\"Create a new refund\",\"request\":\"createRefundRequest.html\",\"response\":\"createRefundResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_refund(refund, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Refund refund: The refund object to be created. (required) - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_refund_with_http_info(refund, **kwargs) - else: - (data) = self.create_refund_with_http_info(refund, **kwargs) - return data - - def create_refund_with_http_info(self, refund, **kwargs): - """ -

When creating a refund either the invoice, or invoice payment must be specified.

Creating a refund by specifying the invoiceID will refund any un-refunded value up to the full value of the payment. When refunding via the invoicePaymentID the same rules apply. Refunds will be processed by the same payment methods that took the payment.

Refunds can be for a partial amount of the payment. It is possible to create refunds up to the value of the total payment.

Once a payment or invoice is fully refunded, no more refunds can be created. Errors will be returned if the payment is greater than available refund funds.

- {\"nickname\":\"Create a new refund\",\"request\":\"createRefundRequest.html\",\"response\":\"createRefundResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_refund_with_http_info(refund, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Refund refund: The refund object to be created. (required) - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['refund'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_refund" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'refund' is set - if ('refund' not in params) or (params['refund'] is None): - raise ValueError("Missing the required parameter `refund` when calling `create_refund`") - - resource_path = '/refunds'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'refund' in params: - body_params = params['refund'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RefundPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_refunds(self, **kwargs): - """ - Returns a collection of all refunds. By default 10 values are returned. Refunds are returned in natural order - {\"nickname\":\"Get all refunds\",\"response\":\"getRefundsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_refunds(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first refund to return. - :param int records: The maximum number of refunds to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_refunds_with_http_info(**kwargs) - else: - (data) = self.get_all_refunds_with_http_info(**kwargs) - return data - - def get_all_refunds_with_http_info(self, **kwargs): - """ - Returns a collection of all refunds. By default 10 values are returned. Refunds are returned in natural order - {\"nickname\":\"Get all refunds\",\"response\":\"getRefundsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_refunds_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first refund to return. - :param int records: The maximum number of refunds to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_refunds" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/refunds'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RefundPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_refund_by_id(self, refund_id, **kwargs): - """ - Returns a single refund, specified by the ID parameter. - {\"nickname\":\"Retrieve an existing refund\",\"response\":\"getRefundByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refund_by_id(refund_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str refund_id: ID of the Refund. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_refund_by_id_with_http_info(refund_id, **kwargs) - else: - (data) = self.get_refund_by_id_with_http_info(refund_id, **kwargs) - return data - - def get_refund_by_id_with_http_info(self, refund_id, **kwargs): - """ - Returns a single refund, specified by the ID parameter. - {\"nickname\":\"Retrieve an existing refund\",\"response\":\"getRefundByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refund_by_id_with_http_info(refund_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str refund_id: ID of the Refund. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['refund_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_refund_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'refund_id' is set - if ('refund_id' not in params) or (params['refund_id'] is None): - raise ValueError("Missing the required parameter `refund_id` when calling `get_refund_by_id`") - - resource_path = '/refunds/{refund-ID}'.replace('{format}', 'json') - path_params = {} - if 'refund_id' in params: - path_params['refund-ID'] = params['refund_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RefundPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_refund_for_original_payment(self, payment_id, **kwargs): - """ - Returns a refund for the original payment. - {\"nickname\":\"Retrieve by originating payment\",\"response\":\"getRefundsByPayment.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refund_for_original_payment(payment_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_id: ID of the Payment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_refund_for_original_payment_with_http_info(payment_id, **kwargs) - else: - (data) = self.get_refund_for_original_payment_with_http_info(payment_id, **kwargs) - return data - - def get_refund_for_original_payment_with_http_info(self, payment_id, **kwargs): - """ - Returns a refund for the original payment. - {\"nickname\":\"Retrieve by originating payment\",\"response\":\"getRefundsByPayment.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refund_for_original_payment_with_http_info(payment_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_id: ID of the Payment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_refund_for_original_payment" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment_id' is set - if ('payment_id' not in params) or (params['payment_id'] is None): - raise ValueError("Missing the required parameter `payment_id` when calling `get_refund_for_original_payment`") - - resource_path = '/refunds/original-payment/{payment-ID}'.replace('{format}', 'json') - path_params = {} - if 'payment_id' in params: - path_params['payment-ID'] = params['payment_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RefundPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_refund_for_refund_payment(self, payment_id, **kwargs): - """ - Returns a refund for the refund payment. - {\"nickname\":\"Retrieve by refund payment\",\"response\":\"getRefundsByPayment.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refund_for_refund_payment(payment_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_id: ID of the Payment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_refund_for_refund_payment_with_http_info(payment_id, **kwargs) - else: - (data) = self.get_refund_for_refund_payment_with_http_info(payment_id, **kwargs) - return data - - def get_refund_for_refund_payment_with_http_info(self, payment_id, **kwargs): - """ - Returns a refund for the refund payment. - {\"nickname\":\"Retrieve by refund payment\",\"response\":\"getRefundsByPayment.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refund_for_refund_payment_with_http_info(payment_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str payment_id: ID of the Payment. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['payment_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_refund_for_refund_payment" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'payment_id' is set - if ('payment_id' not in params) or (params['payment_id'] is None): - raise ValueError("Missing the required parameter `payment_id` when calling `get_refund_for_refund_payment`") - - resource_path = '/refunds/refund-payment/{payment-ID}'.replace('{format}', 'json') - path_params = {} - if 'payment_id' in params: - path_params['payment-ID'] = params['payment_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RefundPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_refund_for_refunded_invoice(self, invoice_id, **kwargs): - """ - Returns a refund for the refund payment. - {\"nickname\":\"Retrieve by invoice\",\"response\":\"getRefundsByInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refund_for_refunded_invoice(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: ID of the Invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_refund_for_refunded_invoice_with_http_info(invoice_id, **kwargs) - else: - (data) = self.get_refund_for_refunded_invoice_with_http_info(invoice_id, **kwargs) - return data - - def get_refund_for_refunded_invoice_with_http_info(self, invoice_id, **kwargs): - """ - Returns a refund for the refund payment. - {\"nickname\":\"Retrieve by invoice\",\"response\":\"getRefundsByInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refund_for_refunded_invoice_with_http_info(invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str invoice_id: ID of the Invoice. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['invoice_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_refund_for_refunded_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `get_refund_for_refunded_invoice`") - - resource_path = '/refunds/invoice/{invoice-ID}'.replace('{format}', 'json') - path_params = {} - if 'invoice_id' in params: - path_params['invoice-ID'] = params['invoice_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RefundPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_refunds_as_csv(self, completed_start, completed_end, **kwargs): - """ - Retrieves refunds in CSV format. - { \"nickname\":\"Refunds CSV\",\"response\":\"refunds.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refunds_as_csv(completed_start, completed_end, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str completed_start: The UTC DateTime specifying the start of the interval within which refunds were completed. (required) - :param str completed_end: The UTC DateTime specifying the end of the interval within which refunds were completed. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first refund to return. - :param int records: The maximum number of refunds to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_refunds_as_csv_with_http_info(completed_start, completed_end, **kwargs) - else: - (data) = self.get_refunds_as_csv_with_http_info(completed_start, completed_end, **kwargs) - return data - - def get_refunds_as_csv_with_http_info(self, completed_start, completed_end, **kwargs): - """ - Retrieves refunds in CSV format. - { \"nickname\":\"Refunds CSV\",\"response\":\"refunds.csv\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_refunds_as_csv_with_http_info(completed_start, completed_end, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str completed_start: The UTC DateTime specifying the start of the interval within which refunds were completed. (required) - :param str completed_end: The UTC DateTime specifying the end of the interval within which refunds were completed. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first refund to return. - :param int records: The maximum number of refunds to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['completed_start', 'completed_end', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_refunds_as_csv" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'completed_start' is set - if ('completed_start' not in params) or (params['completed_start'] is None): - raise ValueError("Missing the required parameter `completed_start` when calling `get_refunds_as_csv`") - # verify the required parameter 'completed_end' is set - if ('completed_end' not in params) or (params['completed_end'] is None): - raise ValueError("Missing the required parameter `completed_end` when calling `get_refunds_as_csv`") - - resource_path = '/refunds/csv'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'completed_start' in params: - query_params['completed_start'] = params['completed_start'] - if 'completed_end' in params: - query_params['completed_end'] = params['completed_end'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/csv']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RefundPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_refund(self, refund, **kwargs): - """ - Update a refund - {\"nickname\":\"Update a refund\",\"request\":\"updateRefundRequest.html\",\"response\":\"updateRefundResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_refund(refund, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Refund refund: The refund object to be update. (required) - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_refund_with_http_info(refund, **kwargs) - else: - (data) = self.update_refund_with_http_info(refund, **kwargs) - return data - - def update_refund_with_http_info(self, refund, **kwargs): - """ - Update a refund - {\"nickname\":\"Update a refund\",\"request\":\"updateRefundRequest.html\",\"response\":\"updateRefundResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_refund_with_http_info(refund, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Refund refund: The refund object to be update. (required) - :return: RefundPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['refund'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_refund" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'refund' is set - if ('refund' not in params) or (params['refund'] is None): - raise ValueError("Missing the required parameter `refund` when calling `update_refund`") - - resource_path = '/refunds'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'refund' in params: - body_params = params['refund'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RefundPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/roles_api.py b/billforward/apis/roles_api.py deleted file mode 100644 index de86415..0000000 --- a/billforward/apis/roles_api.py +++ /dev/null @@ -1,722 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class RolesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_role(self, role_request, **kwargs): - """ - Create a new role. - {\"nickname\":\"Create a new role\",\"request\":\"createRoleRequest.html\",\"response\":\"createRoleResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_role(role_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase role_request: (required) - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_role_with_http_info(role_request, **kwargs) - else: - (data) = self.create_role_with_http_info(role_request, **kwargs) - return data - - def create_role_with_http_info(self, role_request, **kwargs): - """ - Create a new role. - {\"nickname\":\"Create a new role\",\"request\":\"createRoleRequest.html\",\"response\":\"createRoleResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_role_with_http_info(role_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase role_request: (required) - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['role_request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_role" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'role_request' is set - if ('role_request' not in params) or (params['role_request'] is None): - raise ValueError("Missing the required parameter `role_request` when calling `create_role`") - - resource_path = '/roles'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'role_request' in params: - body_params = params['role_request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RolePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_roles(self, **kwargs): - """ - Retrieves a collection of all roles. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve all roles\",\"response\":\"getRoleAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_roles(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_roles_with_http_info(**kwargs) - else: - (data) = self.get_all_roles_with_http_info(**kwargs) - return data - - def get_all_roles_with_http_info(self, **kwargs): - """ - Retrieves a collection of all roles. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve all roles\",\"response\":\"getRoleAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_roles_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_roles" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/roles'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RolePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_role_by_id(self, role, **kwargs): - """ - Retrieves a single role, specified by the ID parameter. - {\"nickname\":\"Retrieve a role\",\"response\":\"getRoleByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_role_by_id(role, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str role: ID or name of the role. (required) - :param list[str] organizations: - :param bool include_retired: Whether retired subscriptions should be returned. - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_role_by_id_with_http_info(role, **kwargs) - else: - (data) = self.get_role_by_id_with_http_info(role, **kwargs) - return data - - def get_role_by_id_with_http_info(self, role, **kwargs): - """ - Retrieves a single role, specified by the ID parameter. - {\"nickname\":\"Retrieve a role\",\"response\":\"getRoleByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_role_by_id_with_http_info(role, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str role: ID or name of the role. (required) - :param list[str] organizations: - :param bool include_retired: Whether retired subscriptions should be returned. - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['role', 'organizations', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_role_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'role' is set - if ('role' not in params) or (params['role'] is None): - raise ValueError("Missing the required parameter `role` when calling `get_role_by_id`") - - resource_path = '/roles/{role}'.replace('{format}', 'json') - path_params = {} - if 'role' in params: - path_params['role'] = params['role'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RolePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def remove_permission_from_role(self, role, resource, action, **kwargs): - """ - Revokes a particular permission - {\"nickname\":\"Remove Permission from role\",\"response\":\"removePermissionFromGroup.html\",\"request\":\"removePermissionFromGroupRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_permission_from_role(role, resource, action, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str role: ID or name of the role. (required) - :param str resource: (required) - :param str action: (required) - :param list[str] organizations: - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.remove_permission_from_role_with_http_info(role, resource, action, **kwargs) - else: - (data) = self.remove_permission_from_role_with_http_info(role, resource, action, **kwargs) - return data - - def remove_permission_from_role_with_http_info(self, role, resource, action, **kwargs): - """ - Revokes a particular permission - {\"nickname\":\"Remove Permission from role\",\"response\":\"removePermissionFromGroup.html\",\"request\":\"removePermissionFromGroupRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_permission_from_role_with_http_info(role, resource, action, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str role: ID or name of the role. (required) - :param str resource: (required) - :param str action: (required) - :param list[str] organizations: - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['role', 'resource', 'action', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method remove_permission_from_role" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'role' is set - if ('role' not in params) or (params['role'] is None): - raise ValueError("Missing the required parameter `role` when calling `remove_permission_from_role`") - # verify the required parameter 'resource' is set - if ('resource' not in params) or (params['resource'] is None): - raise ValueError("Missing the required parameter `resource` when calling `remove_permission_from_role`") - # verify the required parameter 'action' is set - if ('action' not in params) or (params['action'] is None): - raise ValueError("Missing the required parameter `action` when calling `remove_permission_from_role`") - - resource_path = '/roles/{role}/permission/{resource}/{action}'.replace('{format}', 'json') - path_params = {} - if 'role' in params: - path_params['role'] = params['role'] - if 'resource' in params: - path_params['resource'] = params['resource'] - if 'action' in params: - path_params['action'] = params['action'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RolePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def revoke_role(self, role, **kwargs): - """ - Revokes a role - {\"nickname\":\"Revoke role\",\"response\":\"revokeRole.html\",\"request\":\"revokeRoleRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.revoke_role(role, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str role: ID or name of the role. (required) - :param list[str] organizations: - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.revoke_role_with_http_info(role, **kwargs) - else: - (data) = self.revoke_role_with_http_info(role, **kwargs) - return data - - def revoke_role_with_http_info(self, role, **kwargs): - """ - Revokes a role - {\"nickname\":\"Revoke role\",\"response\":\"revokeRole.html\",\"request\":\"revokeRoleRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.revoke_role_with_http_info(role, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str role: ID or name of the role. (required) - :param list[str] organizations: - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['role', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method revoke_role" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'role' is set - if ('role' not in params) or (params['role'] is None): - raise ValueError("Missing the required parameter `role` when calling `revoke_role`") - - resource_path = '/roles/{role}'.replace('{format}', 'json') - path_params = {} - if 'role' in params: - path_params['role'] = params['role'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RolePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_role(self, role_request, **kwargs): - """ - Update a role. - {\"nickname\":\"Update a role\",\"request\":\"updateRoleRequest.html\",\"response\":\"updateRoleResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_role(role_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UpdateRoleRequest role_request: (required) - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_role_with_http_info(role_request, **kwargs) - else: - (data) = self.update_role_with_http_info(role_request, **kwargs) - return data - - def update_role_with_http_info(self, role_request, **kwargs): - """ - Update a role. - {\"nickname\":\"Update a role\",\"request\":\"updateRoleRequest.html\",\"response\":\"updateRoleResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_role_with_http_info(role_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UpdateRoleRequest role_request: (required) - :return: RolePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['role_request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_role" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'role_request' is set - if ('role_request' not in params) or (params['role_request'] is None): - raise ValueError("Missing the required parameter `role_request` when calling `update_role`") - - resource_path = '/roles'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'role_request' in params: - body_params = params['role_request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='RolePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/search_api.py b/billforward/apis/search_api.py deleted file mode 100644 index 486ee7b..0000000 --- a/billforward/apis/search_api.py +++ /dev/null @@ -1,179 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class SearchApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def perform_search(self, query_string, **kwargs): - """ - Returns the results of the global search specified by the query-string. - {\"nickname\":\"Search an organizations data\",\"response\":\"getSearchByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.perform_search(query_string, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str query_string: The query string used to search. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param list[str] types: A list of entities which will be checked when searching - :param int offset: The starting index of the search results. - :param int records: The number of search results to return. - :param bool wildcard: Toggle if we search for full words or whether a wildcard is used. - :param bool entity: Is an entity returned with the search results. - :return: SearchResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.perform_search_with_http_info(query_string, **kwargs) - else: - (data) = self.perform_search_with_http_info(query_string, **kwargs) - return data - - def perform_search_with_http_info(self, query_string, **kwargs): - """ - Returns the results of the global search specified by the query-string. - {\"nickname\":\"Search an organizations data\",\"response\":\"getSearchByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.perform_search_with_http_info(query_string, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str query_string: The query string used to search. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param list[str] types: A list of entities which will be checked when searching - :param int offset: The starting index of the search results. - :param int records: The number of search results to return. - :param bool wildcard: Toggle if we search for full words or whether a wildcard is used. - :param bool entity: Is an entity returned with the search results. - :return: SearchResultPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['query_string', 'organizations', 'types', 'offset', 'records', 'wildcard', 'entity'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method perform_search" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'query_string' is set - if ('query_string' not in params) or (params['query_string'] is None): - raise ValueError("Missing the required parameter `query_string` when calling `perform_search`") - - resource_path = '/search/{query-string}'.replace('{format}', 'json') - path_params = {} - if 'query_string' in params: - path_params['query-string'] = params['query_string'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'types' in params: - query_params['types'] = params['types'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'wildcard' in params: - query_params['wildcard'] = params['wildcard'] - if 'entity' in params: - query_params['entity'] = params['entity'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SearchResultPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/subscriptions_api.py b/billforward/apis/subscriptions_api.py deleted file mode 100644 index 4b6658c..0000000 --- a/billforward/apis/subscriptions_api.py +++ /dev/null @@ -1,6034 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class SubscriptionsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def add_charge_to_subscription(self, subscription_id, charge, **kwargs): - """ - Creates a charge on the specified subscription. - {\"nickname\":\"Add Charge\",\"response\":\"addChargeToSubscriptionRequest.html\",\"response\":\"addChargeToSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_charge_to_subscription(subscription_id, charge, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param AddChargeRequest charge: The charge request (required) - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.add_charge_to_subscription_with_http_info(subscription_id, charge, **kwargs) - else: - (data) = self.add_charge_to_subscription_with_http_info(subscription_id, charge, **kwargs) - return data - - def add_charge_to_subscription_with_http_info(self, subscription_id, charge, **kwargs): - """ - Creates a charge on the specified subscription. - {\"nickname\":\"Add Charge\",\"response\":\"addChargeToSubscriptionRequest.html\",\"response\":\"addChargeToSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_charge_to_subscription_with_http_info(subscription_id, charge, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param AddChargeRequest charge: The charge request (required) - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'charge'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method add_charge_to_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `add_charge_to_subscription`") - # verify the required parameter 'charge' is set - if ('charge' not in params) or (params['charge'] is None): - raise ValueError("Missing the required parameter `charge` when calling `add_charge_to_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/charge'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'charge' in params: - body_params = params['charge'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionChargePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def add_coupon_to_subscription(self, subscription_id, request, **kwargs): - """ - Applies a coupon to a subscription. - {\"nickname\":\"Apply coupon\", \"request\":\"addCouponCodeRequest.html\",\"response\":\"addCouponCodeResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_coupon_to_subscription(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param AddCouponCodeRequest request: Request containing the coupon code. (required) - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.add_coupon_to_subscription_with_http_info(subscription_id, request, **kwargs) - else: - (data) = self.add_coupon_to_subscription_with_http_info(subscription_id, request, **kwargs) - return data - - def add_coupon_to_subscription_with_http_info(self, subscription_id, request, **kwargs): - """ - Applies a coupon to a subscription. - {\"nickname\":\"Apply coupon\", \"request\":\"addCouponCodeRequest.html\",\"response\":\"addCouponCodeResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_coupon_to_subscription_with_http_info(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param AddCouponCodeRequest request: Request containing the coupon code. (required) - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method add_coupon_to_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `add_coupon_to_subscription`") - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `add_coupon_to_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/coupons'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def add_credit_note_to_subscription(self, subscription_id, credit_note, **kwargs): - """ - Creates a credit-note which may be used by only the specified subscription. - {\"nickname\":\"Add Credit\",\"request\":\"addCreditNoteToSubscriptionRequest.html\", \"response\":\"addCreditNoteToSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_credit_note_to_subscription(subscription_id, credit_note, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param CreditSubscriptionRequest credit_note: The credit-note request (required) - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.add_credit_note_to_subscription_with_http_info(subscription_id, credit_note, **kwargs) - else: - (data) = self.add_credit_note_to_subscription_with_http_info(subscription_id, credit_note, **kwargs) - return data - - def add_credit_note_to_subscription_with_http_info(self, subscription_id, credit_note, **kwargs): - """ - Creates a credit-note which may be used by only the specified subscription. - {\"nickname\":\"Add Credit\",\"request\":\"addCreditNoteToSubscriptionRequest.html\", \"response\":\"addCreditNoteToSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_credit_note_to_subscription_with_http_info(subscription_id, credit_note, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param CreditSubscriptionRequest credit_note: The credit-note request (required) - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'credit_note'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method add_credit_note_to_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `add_credit_note_to_subscription`") - # verify the required parameter 'credit_note' is set - if ('credit_note' not in params) or (params['credit_note'] is None): - raise ValueError("Missing the required parameter `credit_note` when calling `add_credit_note_to_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/credit'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'credit_note' in params: - body_params = params['credit_note'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CreditNotePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def add_payment_method_to_subscription(self, subscription_id, payment_method, **kwargs): - """ - Enables the payment method to pay invoices of this subscription. - {\"nickname\":\"Add payment-method to subscription\",\"response\":\"addPaymentMethod.html\",\"request\":\"addPaymentMethod.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_payment_method_to_subscription(subscription_id, payment_method, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param AddPaymentMethodRequest payment_method: (required) - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.add_payment_method_to_subscription_with_http_info(subscription_id, payment_method, **kwargs) - else: - (data) = self.add_payment_method_to_subscription_with_http_info(subscription_id, payment_method, **kwargs) - return data - - def add_payment_method_to_subscription_with_http_info(self, subscription_id, payment_method, **kwargs): - """ - Enables the payment method to pay invoices of this subscription. - {\"nickname\":\"Add payment-method to subscription\",\"response\":\"addPaymentMethod.html\",\"request\":\"addPaymentMethod.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.add_payment_method_to_subscription_with_http_info(subscription_id, payment_method, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param AddPaymentMethodRequest payment_method: (required) - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'payment_method'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method add_payment_method_to_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `add_payment_method_to_subscription`") - # verify the required parameter 'payment_method' is set - if ('payment_method' not in params) or (params['payment_method'] is None): - raise ValueError("Missing the required parameter `payment_method` when calling `add_payment_method_to_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/payment-methods'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'payment_method' in params: - body_params = params['payment_method'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def advance_subscription(self, subscription_id, request, **kwargs): - """ - Advance the subscription through time. - {\"nickname\":\"Advance\",\"request\":\"advanceSubscriptionRequest.html\",\"response\":\"advanceSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.advance_subscription(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param TimeRequest request: The request (required) - :return: TimeResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.advance_subscription_with_http_info(subscription_id, request, **kwargs) - else: - (data) = self.advance_subscription_with_http_info(subscription_id, request, **kwargs) - return data - - def advance_subscription_with_http_info(self, subscription_id, request, **kwargs): - """ - Advance the subscription through time. - {\"nickname\":\"Advance\",\"request\":\"advanceSubscriptionRequest.html\",\"response\":\"advanceSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.advance_subscription_with_http_info(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param TimeRequest request: The request (required) - :return: TimeResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method advance_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `advance_subscription`") - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `advance_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/advance'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TimeResponsePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def available_payment_methods_for_subscription(self, subscription_id, **kwargs): - """ - Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"List on subscription\",\"response\" : \"getAvailablePaymentMethods.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.available_payment_methods_for_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.available_payment_methods_for_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.available_payment_methods_for_subscription_with_http_info(subscription_id, **kwargs) - return data - - def available_payment_methods_for_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"List on subscription\",\"response\" : \"getAvailablePaymentMethods.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.available_payment_methods_for_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method available_payment_methods_for_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `available_payment_methods_for_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/payment-methods'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def batch_create_subscriptions(self, request, **kwargs): - """ - Create multiple subscriptions. - {\"nickname\":\"Create multiple subscriptions\",\"response\":\"createMultipleSubscriptionViaHelper.html\",\"request\":\"createMultipleSubscriptionViaHelper.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.batch_create_subscriptions(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreateSubscriptionBatchRequest request: (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.batch_create_subscriptions_with_http_info(request, **kwargs) - else: - (data) = self.batch_create_subscriptions_with_http_info(request, **kwargs) - return data - - def batch_create_subscriptions_with_http_info(self, request, **kwargs): - """ - Create multiple subscriptions. - {\"nickname\":\"Create multiple subscriptions\",\"response\":\"createMultipleSubscriptionViaHelper.html\",\"request\":\"createMultipleSubscriptionViaHelper.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.batch_create_subscriptions_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreateSubscriptionBatchRequest request: (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method batch_create_subscriptions" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `batch_create_subscriptions`") - - resource_path = '/subscriptions/batch'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def cancel_subscription(self, subscription_id, subscription_cancellation, **kwargs): - """ - Retires the subscription specified by the subscription-ID parameter. Retiring a subscription causes it to cancel based on the specified retirement settings for the product. - {\"nickname\":\"Cancel subscription\",\"response\":\"deleteSubscription.html\",\"request\":\"deleteSubscriptionRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.cancel_subscription(subscription_id, subscription_cancellation, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param CancelSubscriptionRequest subscription_cancellation: The cancellation request (required) - :return: SubscriptionCancellationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.cancel_subscription_with_http_info(subscription_id, subscription_cancellation, **kwargs) - else: - (data) = self.cancel_subscription_with_http_info(subscription_id, subscription_cancellation, **kwargs) - return data - - def cancel_subscription_with_http_info(self, subscription_id, subscription_cancellation, **kwargs): - """ - Retires the subscription specified by the subscription-ID parameter. Retiring a subscription causes it to cancel based on the specified retirement settings for the product. - {\"nickname\":\"Cancel subscription\",\"response\":\"deleteSubscription.html\",\"request\":\"deleteSubscriptionRequest.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.cancel_subscription_with_http_info(subscription_id, subscription_cancellation, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param CancelSubscriptionRequest subscription_cancellation: The cancellation request (required) - :return: SubscriptionCancellationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'subscription_cancellation'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method cancel_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `cancel_subscription`") - # verify the required parameter 'subscription_cancellation' is set - if ('subscription_cancellation' not in params) or (params['subscription_cancellation'] is None): - raise ValueError("Missing the required parameter `subscription_cancellation` when calling `cancel_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/cancel'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'subscription_cancellation' in params: - body_params = params['subscription_cancellation'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionCancellationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def create_aggregating_subscription(self, request, **kwargs): - """ - Create an aggregating subscription. - {\"nickname\":\"Create aggregating subscription\",\"response\":\"createAggregatingSubscription.html\",\"request\":\"createAggregatingSubscription.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_aggregating_subscription(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreateAggregatingSubscriptionRequest request: (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_aggregating_subscription_with_http_info(request, **kwargs) - else: - (data) = self.create_aggregating_subscription_with_http_info(request, **kwargs) - return data - - def create_aggregating_subscription_with_http_info(self, request, **kwargs): - """ - Create an aggregating subscription. - {\"nickname\":\"Create aggregating subscription\",\"response\":\"createAggregatingSubscription.html\",\"request\":\"createAggregatingSubscription.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_aggregating_subscription_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreateAggregatingSubscriptionRequest request: (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_aggregating_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `create_aggregating_subscription`") - - resource_path = '/subscriptions/aggregating'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def create_subscription(self, subscription, **kwargs): - """ - Create a new subscription. - {\"nickname\":\"Create a new subscription\",\"request\":\"createSubscriptionRequest.html\",\"response\":\"createSubscriptionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_subscription(subscription, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Subscription subscription: The subscription object to be updated. (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_subscription_with_http_info(subscription, **kwargs) - else: - (data) = self.create_subscription_with_http_info(subscription, **kwargs) - return data - - def create_subscription_with_http_info(self, subscription, **kwargs): - """ - Create a new subscription. - {\"nickname\":\"Create a new subscription\",\"request\":\"createSubscriptionRequest.html\",\"response\":\"createSubscriptionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_subscription_with_http_info(subscription, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Subscription subscription: The subscription object to be updated. (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription' is set - if ('subscription' not in params) or (params['subscription'] is None): - raise ValueError("Missing the required parameter `subscription` when calling `create_subscription`") - - resource_path = '/subscriptions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'subscription' in params: - body_params = params['subscription'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def create_subscription_v2(self, request, **kwargs): - """ - Create a subscription (V2). - {\"nickname\":\"Create a subscription (V2)\",\"response\":\"createSubscriptionViaHelper.html\",\"request\":\"createSubscriptionViaHelper.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_subscription_v2(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreateSubscriptionRequest request: (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_subscription_v2_with_http_info(request, **kwargs) - else: - (data) = self.create_subscription_v2_with_http_info(request, **kwargs) - return data - - def create_subscription_v2_with_http_info(self, request, **kwargs): - """ - Create a subscription (V2). - {\"nickname\":\"Create a subscription (V2)\",\"response\":\"createSubscriptionViaHelper.html\",\"request\":\"createSubscriptionViaHelper.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_subscription_v2_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CreateSubscriptionRequest request: (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_subscription_v2" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `create_subscription_v2`") - - resource_path = '/subscriptions/create'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def create_timer(self, subscription_id, request, **kwargs): - """ - Create a timer for a subscription event. - {\"nickname\":\"Create Timer\",\"response\":\"createSubscriptionTimer.html\",\"request\":\"createSubscriptionTimer.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_timer(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param BillingEntityBase request: (required) - :return: TimerAmendment - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_timer_with_http_info(subscription_id, request, **kwargs) - else: - (data) = self.create_timer_with_http_info(subscription_id, request, **kwargs) - return data - - def create_timer_with_http_info(self, subscription_id, request, **kwargs): - """ - Create a timer for a subscription event. - {\"nickname\":\"Create Timer\",\"response\":\"createSubscriptionTimer.html\",\"request\":\"createSubscriptionTimer.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_timer_with_http_info(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param BillingEntityBase request: (required) - :return: TimerAmendment - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_timer" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `create_timer`") - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `create_timer`") - - resource_path = '/subscriptions/{subscription-ID}/timer'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TimerAmendment', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def delete_metadata_for_subscription(self, subscription_id, **kwargs): - """ - Remove any associated metadata. - {\"nickname\":\"Clear from subscription\",\"request\" :\"deleteSubscriptionMetadataRequest.html\",\"response\":\"deleteSubscriptionMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_metadata_for_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.delete_metadata_for_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.delete_metadata_for_subscription_with_http_info(subscription_id, **kwargs) - return data - - def delete_metadata_for_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Remove any associated metadata. - {\"nickname\":\"Clear from subscription\",\"request\" :\"deleteSubscriptionMetadataRequest.html\",\"response\":\"deleteSubscriptionMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.delete_metadata_for_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method delete_metadata_for_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `delete_metadata_for_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def freeze_subscription(self, subscription_id, request, **kwargs): - """ - Freeze the subscription. - {\"nickname\":\"Freeze\",\"request\":\"freezeSubscriptionRequest.html\",\"response\":\"freezeSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.freeze_subscription(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param PauseRequest request: The request (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.freeze_subscription_with_http_info(subscription_id, request, **kwargs) - else: - (data) = self.freeze_subscription_with_http_info(subscription_id, request, **kwargs) - return data - - def freeze_subscription_with_http_info(self, subscription_id, request, **kwargs): - """ - Freeze the subscription. - {\"nickname\":\"Freeze\",\"request\":\"freezeSubscriptionRequest.html\",\"response\":\"freezeSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.freeze_subscription_with_http_info(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param PauseRequest request: The request (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method freeze_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `freeze_subscription`") - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `freeze_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/freeze'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_subscriptions(self, **kwargs): - """ - Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve all subscriptions\",\"response\":\"getSubscriptionAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_subscriptions(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :param bool exclude_children: Should child subscriptiosn be excluded. - :param str metadata: - :param bool exclude_service_ended: - :param list[str] account_id: A list of accountIDs to filter subscriptions on - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_subscriptions_with_http_info(**kwargs) - else: - (data) = self.get_all_subscriptions_with_http_info(**kwargs) - return data - - def get_all_subscriptions_with_http_info(self, **kwargs): - """ - Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve all subscriptions\",\"response\":\"getSubscriptionAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_subscriptions_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :param bool exclude_children: Should child subscriptiosn be excluded. - :param str metadata: - :param bool exclude_service_ended: - :param list[str] account_id: A list of accountIDs to filter subscriptions on - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children', 'metadata', 'exclude_service_ended', 'account_id'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_subscriptions" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/subscriptions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'exclude_children' in params: - query_params['exclude_children'] = params['exclude_children'] - if 'metadata' in params: - query_params['metadata'] = params['metadata'] - if 'exclude_service_ended' in params: - query_params['exclude_service_ended'] = params['exclude_service_ended'] - if 'account_id' in params: - query_params['accountID'] = params['account_id'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_applicable_coupons_for_subscription(self, subscription_id, **kwargs): - """ - Retrieves a collection of the coupons which can be applied to this subscription. - { \"nickname\" : \"Retrieve applicable coupons\",\"response\" : \"getApplicableCoupons.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_applicable_coupons_for_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_applicable_coupons_for_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_applicable_coupons_for_subscription_with_http_info(subscription_id, **kwargs) - return data - - def get_applicable_coupons_for_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Retrieves a collection of the coupons which can be applied to this subscription. - { \"nickname\" : \"Retrieve applicable coupons\",\"response\" : \"getApplicableCoupons.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_applicable_coupons_for_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_applicable_coupons_for_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_applicable_coupons_for_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/applicable-coupons'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_available_credit_subscription(self, subscription_id, **kwargs): - """ - Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get available credit\",\"response\":\"getAvailableCreditSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_credit_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_available_credit_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_available_credit_subscription_with_http_info(subscription_id, **kwargs) - return data - - def get_available_credit_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get available credit\",\"response\":\"getAvailableCreditSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_available_credit_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_available_credit_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_available_credit_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/credit'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CreditNotePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_charges_on_subscription(self, subscription_id, **kwargs): - """ - Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get charges\",\"response\":\"getChargesSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_charges_on_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param str state: Ihe direction of any ordering, either ASC or DESC. - :param str type: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_charges_on_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_charges_on_subscription_with_http_info(subscription_id, **kwargs) - return data - - def get_charges_on_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get charges\",\"response\":\"getChargesSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_charges_on_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param str state: Ihe direction of any ordering, either ASC or DESC. - :param str type: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionChargePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'state', 'type', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_charges_on_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_charges_on_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/charges'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'state' in params: - query_params['state'] = params['state'] - if 'type' in params: - query_params['type'] = params['type'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionChargePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_children_of_subscription(self, subscription_id, **kwargs): - """ - Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get Aggregated Entities\",\"response\":\"getAggregatedEntities.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_children_of_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_children_of_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_children_of_subscription_with_http_info(subscription_id, **kwargs) - return data - - def get_children_of_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get Aggregated Entities\",\"response\":\"getAggregatedEntities.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_children_of_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_children_of_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_children_of_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/children'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_coupons_on_subscription(self, subscription_id, **kwargs): - """ - Retrieves a collection of the coupons and the unique codes currently applied to the subscription. - {\"nickname\":\"Retrieve coupons\",\"response\":\"getCoupons.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupons_on_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_coupons_on_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_coupons_on_subscription_with_http_info(subscription_id, **kwargs) - return data - - def get_coupons_on_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Retrieves a collection of the coupons and the unique codes currently applied to the subscription. - {\"nickname\":\"Retrieve coupons\",\"response\":\"getCoupons.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_coupons_on_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_coupons_on_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_coupons_on_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/coupons'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_invoices_for_subscription_by_state(self, subscription_id, state, **kwargs): - """ - Retrieves a collection of invoice objects of the specified state for the given subscription. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve invoices by state for subscription\",\"response\":\"getInvoicesForSubscriptionByState.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_for_subscription_by_state(subscription_id, state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The unique id of the subscription. (required) - :param str state: The state of the invoices to retrieve. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_invoices_for_subscription_by_state_with_http_info(subscription_id, state, **kwargs) - else: - (data) = self.get_invoices_for_subscription_by_state_with_http_info(subscription_id, state, **kwargs) - return data - - def get_invoices_for_subscription_by_state_with_http_info(self, subscription_id, state, **kwargs): - """ - Retrieves a collection of invoice objects of the specified state for the given subscription. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve invoices by state for subscription\",\"response\":\"getInvoicesForSubscriptionByState.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_invoices_for_subscription_by_state_with_http_info(subscription_id, state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The unique id of the subscription. (required) - :param str state: The state of the invoices to retrieve. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'state', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_invoices_for_subscription_by_state" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_invoices_for_subscription_by_state`") - # verify the required parameter 'state' is set - if ('state' not in params) or (params['state'] is None): - raise ValueError("Missing the required parameter `state` when calling `get_invoices_for_subscription_by_state`") - - resource_path = '/subscriptions/{subscriptionID}/invoices/{state}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscriptionID'] = params['subscription_id'] - if 'state' in params: - path_params['state'] = params['state'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_metadata_for_subscription(self, subscription_id, **kwargs): - """ - Retrieve any associated metadata. - {\"nickname\":\"Retrieve on subscription\",\"request\":\"getSubscriptionMetadataRequest.html\",\"response\":\"getSubscriptionMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_metadata_for_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_metadata_for_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_metadata_for_subscription_with_http_info(subscription_id, **kwargs) - return data - - def get_metadata_for_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Retrieve any associated metadata. - {\"nickname\":\"Retrieve on subscription\",\"request\":\"getSubscriptionMetadataRequest.html\",\"response\":\"getSubscriptionMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_metadata_for_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_metadata_for_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_metadata_for_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_parent_subscription(self, subscription_id, **kwargs): - """ - Return the parent of the given subscription. - {\"nickname\":\"Get parent\",\"response\":\"getParentSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parent_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_parent_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_parent_subscription_with_http_info(subscription_id, **kwargs) - return data - - def get_parent_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Return the parent of the given subscription. - {\"nickname\":\"Get parent\",\"response\":\"getParentSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_parent_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_parent_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_parent_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/parent'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_pricing_component_values_of_subscription(self, subscription_id, **kwargs): - """ - Gets the subscription's current pricing-component values. - {\"nickname\":\"Get values\",\"response\":\"getPricingComponentValues.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_values_of_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_pricing_component_values_of_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_pricing_component_values_of_subscription_with_http_info(subscription_id, **kwargs) - return data - - def get_pricing_component_values_of_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Gets the subscription's current pricing-component values. - {\"nickname\":\"Get values\",\"response\":\"getPricingComponentValues.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_pricing_component_values_of_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_pricing_component_values_of_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_pricing_component_values_of_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/values'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValuePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscription_by_account_id(self, account_id, **kwargs): - """ - Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by account\",\"response\":\"getSubscriptionByAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_by_account_id(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :param bool exclude_children: Should child subscriptiosn be excluded. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscription_by_account_id_with_http_info(account_id, **kwargs) - else: - (data) = self.get_subscription_by_account_id_with_http_info(account_id, **kwargs) - return data - - def get_subscription_by_account_id_with_http_info(self, account_id, **kwargs): - """ - Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by account\",\"response\":\"getSubscriptionByAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_by_account_id_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :param bool exclude_children: Should child subscriptiosn be excluded. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscription_by_account_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_subscription_by_account_id`") - - resource_path = '/subscriptions/account/{account-ID}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['account-ID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'exclude_children' in params: - query_params['exclude_children'] = params['exclude_children'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscription_by_id(self, subscription_id, **kwargs): - """ - Retrieves a single subscription, specified by the ID parameter. - {\"nickname\":\"Retrieve an existing subscription\",\"response\":\"getSubscriptionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_by_id(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscription_by_id_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_subscription_by_id_with_http_info(subscription_id, **kwargs) - return data - - def get_subscription_by_id_with_http_info(self, subscription_id, **kwargs): - """ - Retrieves a single subscription, specified by the ID parameter. - {\"nickname\":\"Retrieve an existing subscription\",\"response\":\"getSubscriptionByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_by_id_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param bool include_retired: Whether retired subscriptions should be returned. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscription_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_subscription_by_id`") - - resource_path = '/subscriptions/{subscription-ID}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscription_by_product_id(self, product_id, **kwargs): - """ - Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by product\",\"response\":\"getSubscriptionByProduct.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_by_product_id(product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: ID of the product (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :param bool exclude_children: Should child subscriptiosn be excluded. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscription_by_product_id_with_http_info(product_id, **kwargs) - else: - (data) = self.get_subscription_by_product_id_with_http_info(product_id, **kwargs) - return data - - def get_subscription_by_product_id_with_http_info(self, product_id, **kwargs): - """ - Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by product\",\"response\":\"getSubscriptionByProduct.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_by_product_id_with_http_info(product_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_id: ID of the product (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :param bool exclude_children: Should child subscriptiosn be excluded. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscription_by_product_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_id' is set - if ('product_id' not in params) or (params['product_id'] is None): - raise ValueError("Missing the required parameter `product_id` when calling `get_subscription_by_product_id`") - - resource_path = '/subscriptions/product/{product-ID}'.replace('{format}', 'json') - path_params = {} - if 'product_id' in params: - path_params['product-ID'] = params['product_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'exclude_children' in params: - query_params['exclude_children'] = params['exclude_children'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscription_by_product_rate_plan_id(self, product_rate_plan_id, **kwargs): - """ - Retrieves a collection of subscriptions, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by rate-plan\",\"response\":\"getSubscriptionByProductRatePlan.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_by_product_rate_plan_id(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :param bool exclude_children: Should child subscriptiosn be excluded. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscription_by_product_rate_plan_id_with_http_info(product_rate_plan_id, **kwargs) - else: - (data) = self.get_subscription_by_product_rate_plan_id_with_http_info(product_rate_plan_id, **kwargs) - return data - - def get_subscription_by_product_rate_plan_id_with_http_info(self, product_rate_plan_id, **kwargs): - """ - Retrieves a collection of subscriptions, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by rate-plan\",\"response\":\"getSubscriptionByProductRatePlan.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_by_product_rate_plan_id_with_http_info(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :param bool exclude_children: Should child subscriptiosn be excluded. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_rate_plan_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscription_by_product_rate_plan_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_rate_plan_id' is set - if ('product_rate_plan_id' not in params) or (params['product_rate_plan_id'] is None): - raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `get_subscription_by_product_rate_plan_id`") - - resource_path = '/subscriptions/product-rate-plan/{product-rate-plan-ID}'.replace('{format}', 'json') - path_params = {} - if 'product_rate_plan_id' in params: - path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'exclude_children' in params: - query_params['exclude_children'] = params['exclude_children'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscription_by_state(self, state, **kwargs): - """ - Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by state\",\"response\":\"getSubscriptionByState.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_by_state(state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the subscription, either Provisioned, AwaitingPayment, Paid or Cancelled (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :param bool exclude_children: Should child subscriptiosn be excluded. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscription_by_state_with_http_info(state, **kwargs) - else: - (data) = self.get_subscription_by_state_with_http_info(state, **kwargs) - return data - - def get_subscription_by_state_with_http_info(self, state, **kwargs): - """ - Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by state\",\"response\":\"getSubscriptionByState.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_by_state_with_http_info(state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The current state of the subscription, either Provisioned, AwaitingPayment, Paid or Cancelled (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired subscriptions should be returned. - :param bool exclude_children: Should child subscriptiosn be excluded. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['state', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'exclude_children'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscription_by_state" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'state' is set - if ('state' not in params) or (params['state'] is None): - raise ValueError("Missing the required parameter `state` when calling `get_subscription_by_state`") - - resource_path = '/subscriptions/state/{state}'.replace('{format}', 'json') - path_params = {} - if 'state' in params: - path_params['state'] = params['state'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'exclude_children' in params: - query_params['exclude_children'] = params['exclude_children'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscription_by_version_id(self, version_id, **kwargs): - """ - Retrieves a single subscription, specified by the version-ID parameter. - {\"nickname\":\"Retrieve by version\",\"response\":\"getSubscriptionByVersionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_by_version_id(version_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version_id: The version-ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscription_by_version_id_with_http_info(version_id, **kwargs) - else: - (data) = self.get_subscription_by_version_id_with_http_info(version_id, **kwargs) - return data - - def get_subscription_by_version_id_with_http_info(self, version_id, **kwargs): - """ - Retrieves a single subscription, specified by the version-ID parameter. - {\"nickname\":\"Retrieve by version\",\"response\":\"getSubscriptionByVersionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscription_by_version_id_with_http_info(version_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version_id: The version-ID of the subscription. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['version_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscription_by_version_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'version_id' is set - if ('version_id' not in params) or (params['version_id'] is None): - raise ValueError("Missing the required parameter `version_id` when calling `get_subscription_by_version_id`") - - resource_path = '/subscriptions/version/{version-ID}'.replace('{format}', 'json') - path_params = {} - if 'version_id' in params: - path_params['version-ID'] = params['version_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscriptions_by_initial_period_start(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by initial period-start\",\"response\":\"getSubscriptionByInitialPeriodStart.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscriptions_by_initial_period_start(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscriptions_by_initial_period_start_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_subscriptions_by_initial_period_start_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_subscriptions_by_initial_period_start_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by initial period-start\",\"response\":\"getSubscriptionByInitialPeriodStart.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscriptions_by_initial_period_start_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscriptions_by_initial_period_start" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_subscriptions_by_initial_period_start`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_subscriptions_by_initial_period_start`") - - resource_path = '/subscriptions/initial-period-start/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscriptions_by_period_end(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by period-end\",\"response\":\"getSubscriptionByPeriodEnd.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscriptions_by_period_end(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscriptions_by_period_end_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_subscriptions_by_period_end_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_subscriptions_by_period_end_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by period-end\",\"response\":\"getSubscriptionByPeriodEnd.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscriptions_by_period_end_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscriptions_by_period_end" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_subscriptions_by_period_end`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_subscriptions_by_period_end`") - - resource_path = '/subscriptions/period-end/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscriptions_by_period_start(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of subscription objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by period-start\",\"response\":\"getSubscriptionByPeriodStart.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscriptions_by_period_start(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscriptions_by_period_start_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_subscriptions_by_period_start_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_subscriptions_by_period_start_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of subscription objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by period-start\",\"response\":\"getSubscriptionByPeriodStart.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscriptions_by_period_start_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str lower_threshold: The UTC DateTime specifying the start of the result period. (required) - :param str upper_threshold: The UTC DateTime specifying the end of the result period. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscriptions_by_period_start" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_subscriptions_by_period_start`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_subscriptions_by_period_start`") - - resource_path = '/subscriptions/period-start/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_subscriptions_by_successful_periods(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of subscription objects whose successful periods count falls within the range specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by successful period\",\"response\":\"getSubscriptionBySuccessfulPeriods.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscriptions_by_successful_periods(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param int lower_threshold: The lower threshold of the range (required) - :param int upper_threshold: The upper threshold of the range. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_subscriptions_by_successful_periods_with_http_info(lower_threshold, upper_threshold, **kwargs) - else: - (data) = self.get_subscriptions_by_successful_periods_with_http_info(lower_threshold, upper_threshold, **kwargs) - return data - - def get_subscriptions_by_successful_periods_with_http_info(self, lower_threshold, upper_threshold, **kwargs): - """ - Retrieves a collection of subscription objects whose successful periods count falls within the range specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by successful period\",\"response\":\"getSubscriptionBySuccessfulPeriods.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_subscriptions_by_successful_periods_with_http_info(lower_threshold, upper_threshold, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param int lower_threshold: The lower threshold of the range (required) - :param int upper_threshold: The upper threshold of the range. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['lower_threshold', 'upper_threshold', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_subscriptions_by_successful_periods" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'lower_threshold' is set - if ('lower_threshold' not in params) or (params['lower_threshold'] is None): - raise ValueError("Missing the required parameter `lower_threshold` when calling `get_subscriptions_by_successful_periods`") - # verify the required parameter 'upper_threshold' is set - if ('upper_threshold' not in params) or (params['upper_threshold'] is None): - raise ValueError("Missing the required parameter `upper_threshold` when calling `get_subscriptions_by_successful_periods`") - - resource_path = '/subscriptions/successful-periods/{lower-threshold}/{upper-threshold}'.replace('{format}', 'json') - path_params = {} - if 'lower_threshold' in params: - path_params['lower-threshold'] = params['lower_threshold'] - if 'upper_threshold' in params: - path_params['upper-threshold'] = params['upper_threshold'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_swagger_subscription(self, query_string, **kwargs): - """ - - { \"nickname\" : \"\",\"response\" : \"\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_swagger_subscription(query_string, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str query_string: The query string used to search. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The starting index of the search results. - :param int records: The number of search results to return. - :param str format: The response format, either JSON or XML. - :param bool wildcard: Toggle if we search for full words or whether a wildcard is used. - :param bool entity: Is an entity returned with the search results. - :return: SwaggerTypeListSubs - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_swagger_subscription_with_http_info(query_string, **kwargs) - else: - (data) = self.get_swagger_subscription_with_http_info(query_string, **kwargs) - return data - - def get_swagger_subscription_with_http_info(self, query_string, **kwargs): - """ - - { \"nickname\" : \"\",\"response\" : \"\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_swagger_subscription_with_http_info(query_string, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str query_string: The query string used to search. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The starting index of the search results. - :param int records: The number of search results to return. - :param str format: The response format, either JSON or XML. - :param bool wildcard: Toggle if we search for full words or whether a wildcard is used. - :param bool entity: Is an entity returned with the search results. - :return: SwaggerTypeListSubs - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['query_string', 'organizations', 'offset', 'records', 'format', 'wildcard', 'entity'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_swagger_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'query_string' is set - if ('query_string' not in params) or (params['query_string'] is None): - raise ValueError("Missing the required parameter `query_string` when calling `get_swagger_subscription`") - - resource_path = '/subscriptions/swagger-end-point/{query-string}'.replace('{format}', 'json') - path_params = {} - if 'query_string' in params: - path_params['query-string'] = params['query_string'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'format' in params: - query_params['format'] = params['format'] - if 'wildcard' in params: - query_params['wildcard'] = params['wildcard'] - if 'entity' in params: - query_params['entity'] = params['entity'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SwaggerTypeListSubs', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_timers_for_subscription(self, subscription_id, **kwargs): - """ - Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get Timers\",\"response\":\"getTimersforSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_timers_for_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired timers should be returned. - :param str state: The state of the timer amendment - :param str event: The type of timer event - :return: TimerAmendment - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_timers_for_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_timers_for_subscription_with_http_info(subscription_id, **kwargs) - return data - - def get_timers_for_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get Timers\",\"response\":\"getTimersforSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_timers_for_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first subscription to return. - :param int records: The maximum number of subscriptions to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired timers should be returned. - :param str state: The state of the timer amendment - :param str event: The type of timer event - :return: TimerAmendment - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired', 'state', 'event'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_timers_for_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_timers_for_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/timer'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - if 'state' in params: - query_params['state'] = params['state'] - if 'event' in params: - query_params['event'] = params['event'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TimerAmendment', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def import_subscription(self, request, **kwargs): - """ - Import a subscription. - {\"nickname\":\"Import\",\"request\":\"importSubscriptionRequest.html\",\"response\":\"importSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.import_subscription(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: The request (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.import_subscription_with_http_info(request, **kwargs) - else: - (data) = self.import_subscription_with_http_info(request, **kwargs) - return data - - def import_subscription_with_http_info(self, request, **kwargs): - """ - Import a subscription. - {\"nickname\":\"Import\",\"request\":\"importSubscriptionRequest.html\",\"response\":\"importSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.import_subscription_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: The request (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method import_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `import_subscription`") - - resource_path = '/subscriptions/import'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def invoice_charges_on_subscription(self, subscription_id, charge, **kwargs): - """ - Invoice any outstanding charges for the subscription. - {\"nickname\":\"Invoice Charges\",\"request\":\"invoiceChargesRequest.html\",\"response\":\"invoiceCharges.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.invoice_charges_on_subscription(subscription_id, charge, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param InvoiceChargeRequest charge: The charge request (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.invoice_charges_on_subscription_with_http_info(subscription_id, charge, **kwargs) - else: - (data) = self.invoice_charges_on_subscription_with_http_info(subscription_id, charge, **kwargs) - return data - - def invoice_charges_on_subscription_with_http_info(self, subscription_id, charge, **kwargs): - """ - Invoice any outstanding charges for the subscription. - {\"nickname\":\"Invoice Charges\",\"request\":\"invoiceChargesRequest.html\",\"response\":\"invoiceCharges.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.invoice_charges_on_subscription_with_http_info(subscription_id, charge, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param InvoiceChargeRequest charge: The charge request (required) - :return: InvoicePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'charge'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method invoice_charges_on_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `invoice_charges_on_subscription`") - # verify the required parameter 'charge' is set - if ('charge' not in params) or (params['charge'] is None): - raise ValueError("Missing the required parameter `charge` when calling `invoice_charges_on_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/invoice-charges'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'charge' in params: - body_params = params['charge'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InvoicePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def migrate_subscription(self, subscription_id, request, **kwargs): - """ - Migrate the subscription to a new plan. - {\"nickname\":\"Migrate\",\"request\":\"migrateSubscriptionRequest.html\", \"response\":\"migrateSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.migrate_subscription(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param MigrationRequest request: The migration request (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.migrate_subscription_with_http_info(subscription_id, request, **kwargs) - else: - (data) = self.migrate_subscription_with_http_info(subscription_id, request, **kwargs) - return data - - def migrate_subscription_with_http_info(self, subscription_id, request, **kwargs): - """ - Migrate the subscription to a new plan. - {\"nickname\":\"Migrate\",\"request\":\"migrateSubscriptionRequest.html\", \"response\":\"migrateSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.migrate_subscription_with_http_info(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param MigrationRequest request: The migration request (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method migrate_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `migrate_subscription`") - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `migrate_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/migrate'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def remove_coupon_from_subscription(self, subscription_id, coupon_code, **kwargs): - """ - Removes the coupon from the subscription. - {\"nickname\":\"Remove coupon\",\"response\":\"removeCouponResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_coupon_from_subscription(subscription_id, coupon_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param str coupon_code: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.remove_coupon_from_subscription_with_http_info(subscription_id, coupon_code, **kwargs) - else: - (data) = self.remove_coupon_from_subscription_with_http_info(subscription_id, coupon_code, **kwargs) - return data - - def remove_coupon_from_subscription_with_http_info(self, subscription_id, coupon_code, **kwargs): - """ - Removes the coupon from the subscription. - {\"nickname\":\"Remove coupon\",\"response\":\"removeCouponResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_coupon_from_subscription_with_http_info(subscription_id, coupon_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param str coupon_code: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CouponPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'coupon_code', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method remove_coupon_from_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `remove_coupon_from_subscription`") - # verify the required parameter 'coupon_code' is set - if ('coupon_code' not in params) or (params['coupon_code'] is None): - raise ValueError("Missing the required parameter `coupon_code` when calling `remove_coupon_from_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/coupons/{coupon-code}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - if 'coupon_code' in params: - path_params['coupon-code'] = params['coupon_code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CouponPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def remove_credit_from_subscription(self, subscription_id, value, **kwargs): - """ - Decrease the amount of credit available to the specified subscription. - {\"nickname\":\"Remove Credit\",\"response\":\"removeCreditForSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_credit_from_subscription(subscription_id, value, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param str value:

Either a credit note ID or a currency value.

If a credit note ID is provided any remaining credit will be removed.

If a decimal is provided this value will be removed from any credit available to the subscription. For example if the subscription is in USD setting the value as 10 will reduce credit by $10 (USD), setting 9.86 would reduce the credit by $9.86 (USD). The value will be reduced from any credit available.

(required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.remove_credit_from_subscription_with_http_info(subscription_id, value, **kwargs) - else: - (data) = self.remove_credit_from_subscription_with_http_info(subscription_id, value, **kwargs) - return data - - def remove_credit_from_subscription_with_http_info(self, subscription_id, value, **kwargs): - """ - Decrease the amount of credit available to the specified subscription. - {\"nickname\":\"Remove Credit\",\"response\":\"removeCreditForSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_credit_from_subscription_with_http_info(subscription_id, value, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param str value:

Either a credit note ID or a currency value.

If a credit note ID is provided any remaining credit will be removed.

If a decimal is provided this value will be removed from any credit available to the subscription. For example if the subscription is in USD setting the value as 10 will reduce credit by $10 (USD), setting 9.86 would reduce the credit by $9.86 (USD). The value will be reduced from any credit available.

(required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: CreditNotePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'value', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method remove_credit_from_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `remove_credit_from_subscription`") - # verify the required parameter 'value' is set - if ('value' not in params) or (params['value'] is None): - raise ValueError("Missing the required parameter `value` when calling `remove_credit_from_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/credit/{value}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - if 'value' in params: - path_params['value'] = params['value'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='CreditNotePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def remove_payment_method_from_subscription(self, subscription_id, payment_method_id, **kwargs): - """ - Removes the specified payment method for the given subscription. - {\"nickname\":\"Remove payment-method\",\"response\":\"removePaymentMethod.html\",\"request\":\"removePaymentMethod.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_payment_method_from_subscription(subscription_id, payment_method_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param str payment_method_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.remove_payment_method_from_subscription_with_http_info(subscription_id, payment_method_id, **kwargs) - else: - (data) = self.remove_payment_method_from_subscription_with_http_info(subscription_id, payment_method_id, **kwargs) - return data - - def remove_payment_method_from_subscription_with_http_info(self, subscription_id, payment_method_id, **kwargs): - """ - Removes the specified payment method for the given subscription. - {\"nickname\":\"Remove payment-method\",\"response\":\"removePaymentMethod.html\",\"request\":\"removePaymentMethod.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_payment_method_from_subscription_with_http_info(subscription_id, payment_method_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param str payment_method_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'payment_method_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method remove_payment_method_from_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `remove_payment_method_from_subscription`") - # verify the required parameter 'payment_method_id' is set - if ('payment_method_id' not in params) or (params['payment_method_id'] is None): - raise ValueError("Missing the required parameter `payment_method_id` when calling `remove_payment_method_from_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/payment-methods/{payment-method-ID}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - if 'payment_method_id' in params: - path_params['payment-method-ID'] = params['payment_method_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def remove_pricing_component_value_change_from_subscription(self, subscription_id, pricing_component, **kwargs): - """ - Discards from the subscription any scheduled changes in the value of the specified pricing-component. - {\"nickname\":\"Discard value changes\",\"response\":\"removePricingComponentValueChange.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_pricing_component_value_change_from_subscription(subscription_id, pricing_component, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param str pricing_component: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.remove_pricing_component_value_change_from_subscription_with_http_info(subscription_id, pricing_component, **kwargs) - else: - (data) = self.remove_pricing_component_value_change_from_subscription_with_http_info(subscription_id, pricing_component, **kwargs) - return data - - def remove_pricing_component_value_change_from_subscription_with_http_info(self, subscription_id, pricing_component, **kwargs): - """ - Discards from the subscription any scheduled changes in the value of the specified pricing-component. - {\"nickname\":\"Discard value changes\",\"response\":\"removePricingComponentValueChange.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.remove_pricing_component_value_change_from_subscription_with_http_info(subscription_id, pricing_component, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param str pricing_component: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'pricing_component', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method remove_pricing_component_value_change_from_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `remove_pricing_component_value_change_from_subscription`") - # verify the required parameter 'pricing_component' is set - if ('pricing_component' not in params) or (params['pricing_component'] is None): - raise ValueError("Missing the required parameter `pricing_component` when calling `remove_pricing_component_value_change_from_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/values/{pricing-component}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - if 'pricing_component' in params: - path_params['pricing-component'] = params['pricing_component'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain', 'application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def resume_subscription(self, subscription_id, request, **kwargs): - """ - Resume the frozen subscription. - {\"nickname\":\"Resume\",\"request\":\"resumeSubscriptionRequest.html\",\"response\":\"resumeSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.resume_subscription(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param ResumeRequest request: The request (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.resume_subscription_with_http_info(subscription_id, request, **kwargs) - else: - (data) = self.resume_subscription_with_http_info(subscription_id, request, **kwargs) - return data - - def resume_subscription_with_http_info(self, subscription_id, request, **kwargs): - """ - Resume the frozen subscription. - {\"nickname\":\"Resume\",\"request\":\"resumeSubscriptionRequest.html\",\"response\":\"resumeSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.resume_subscription_with_http_info(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param ResumeRequest request: The request (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method resume_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `resume_subscription`") - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `resume_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/resume'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def revive_subscription(self, subscription_id, request, **kwargs): - """ - Revives a cancelled subscription and returns it to its previous state - {\"nickname\":\"Revive subscription\",\"request\":\"reviveSubscriptionRequest.html\", \"response\":\"reviveSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.revive_subscription(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param ReviveSubscriptionRequest request: The revive request (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.revive_subscription_with_http_info(subscription_id, request, **kwargs) - else: - (data) = self.revive_subscription_with_http_info(subscription_id, request, **kwargs) - return data - - def revive_subscription_with_http_info(self, subscription_id, request, **kwargs): - """ - Revives a cancelled subscription and returns it to its previous state - {\"nickname\":\"Revive subscription\",\"request\":\"reviveSubscriptionRequest.html\", \"response\":\"reviveSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.revive_subscription_with_http_info(subscription_id, request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param ReviveSubscriptionRequest request: The revive request (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method revive_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `revive_subscription`") - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `revive_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/revive'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def set_metadata_for_subscription(self, metadata, subscription_id, **kwargs): - """ - Remove any existing metadata keys and create the provided data. - {\"nickname\":\"Set on subscription\",\"request\":\"setSubscriptionMetadataRequest.html\",\"response\":\"setSubscriptionMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_metadata_for_subscription(metadata, subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.set_metadata_for_subscription_with_http_info(metadata, subscription_id, **kwargs) - else: - (data) = self.set_metadata_for_subscription_with_http_info(metadata, subscription_id, **kwargs) - return data - - def set_metadata_for_subscription_with_http_info(self, metadata, subscription_id, **kwargs): - """ - Remove any existing metadata keys and create the provided data. - {\"nickname\":\"Set on subscription\",\"request\":\"setSubscriptionMetadataRequest.html\",\"response\":\"setSubscriptionMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_metadata_for_subscription_with_http_info(metadata, subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['metadata', 'subscription_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method set_metadata_for_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'metadata' is set - if ('metadata' not in params) or (params['metadata'] is None): - raise ValueError("Missing the required parameter `metadata` when calling `set_metadata_for_subscription`") - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `set_metadata_for_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'metadata' in params: - body_params = params['metadata'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def set_pricing_component_value_on_subscription(self, subscription_id, pricing_component_value, **kwargs): - """ - Sets upon this subscription a new value for the specified pricing-component without performing an upgrade. - {\"nickname\":\"Set values\",\"request\":\"setPricingComponentValuesRequest.html\",\"response\":\"setPricingComponentValues.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_pricing_component_value_on_subscription(subscription_id, pricing_component_value, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param PricingComponentValue pricing_component_value: The pricing-component-value request (required) - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.set_pricing_component_value_on_subscription_with_http_info(subscription_id, pricing_component_value, **kwargs) - else: - (data) = self.set_pricing_component_value_on_subscription_with_http_info(subscription_id, pricing_component_value, **kwargs) - return data - - def set_pricing_component_value_on_subscription_with_http_info(self, subscription_id, pricing_component_value, **kwargs): - """ - Sets upon this subscription a new value for the specified pricing-component without performing an upgrade. - {\"nickname\":\"Set values\",\"request\":\"setPricingComponentValuesRequest.html\",\"response\":\"setPricingComponentValues.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_pricing_component_value_on_subscription_with_http_info(subscription_id, pricing_component_value, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: ID of the subscription. (required) - :param PricingComponentValue pricing_component_value: The pricing-component-value request (required) - :return: PricingComponentValuePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'pricing_component_value'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method set_pricing_component_value_on_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `set_pricing_component_value_on_subscription`") - # verify the required parameter 'pricing_component_value' is set - if ('pricing_component_value' not in params) or (params['pricing_component_value'] is None): - raise ValueError("Missing the required parameter `pricing_component_value` when calling `set_pricing_component_value_on_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/pricing-component-values'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'pricing_component_value' in params: - body_params = params['pricing_component_value'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValuePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def set_pricing_component_value_on_subscription_v2(self, subscription_id, pricing_component, value, **kwargs): - """ - Upgrades/downgrades this subscription to some new value for the specified pricing-component. - {\"nickname\":\"Set value\",\"request\":\"setPricingComponentValueRequest.html\",\"response\":\"setPricingComponentValue.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_pricing_component_value_on_subscription_v2(subscription_id, pricing_component, value, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param str pricing_component: Name or ID of the pricing-component. (required) - :param PricingComponentValueRequest value: The pricing-component-value request (required) - :return: PricingComponentValueResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.set_pricing_component_value_on_subscription_v2_with_http_info(subscription_id, pricing_component, value, **kwargs) - else: - (data) = self.set_pricing_component_value_on_subscription_v2_with_http_info(subscription_id, pricing_component, value, **kwargs) - return data - - def set_pricing_component_value_on_subscription_v2_with_http_info(self, subscription_id, pricing_component, value, **kwargs): - """ - Upgrades/downgrades this subscription to some new value for the specified pricing-component. - {\"nickname\":\"Set value\",\"request\":\"setPricingComponentValueRequest.html\",\"response\":\"setPricingComponentValue.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.set_pricing_component_value_on_subscription_v2_with_http_info(subscription_id, pricing_component, value, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: (required) - :param str pricing_component: Name or ID of the pricing-component. (required) - :param PricingComponentValueRequest value: The pricing-component-value request (required) - :return: PricingComponentValueResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'pricing_component', 'value'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method set_pricing_component_value_on_subscription_v2" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `set_pricing_component_value_on_subscription_v2`") - # verify the required parameter 'pricing_component' is set - if ('pricing_component' not in params) or (params['pricing_component'] is None): - raise ValueError("Missing the required parameter `pricing_component` when calling `set_pricing_component_value_on_subscription_v2`") - # verify the required parameter 'value' is set - if ('value' not in params) or (params['value'] is None): - raise ValueError("Missing the required parameter `value` when calling `set_pricing_component_value_on_subscription_v2`") - - resource_path = '/subscriptions/{subscription-ID}/values/{pricing-component}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - if 'pricing_component' in params: - path_params['pricing-component'] = params['pricing_component'] - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'value' in params: - body_params = params['value'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PricingComponentValueResponsePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_subscription(self, subscription, **kwargs): - """ - Update a subscription. - {\"nickname\":\"Update a subscription\",\"request\":\"updateSubscriptionRequest.html\",\"response\":\"updateSubscriptionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_subscription(subscription, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Subscription subscription: The subscription object to be updated. (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_subscription_with_http_info(subscription, **kwargs) - else: - (data) = self.update_subscription_with_http_info(subscription, **kwargs) - return data - - def update_subscription_with_http_info(self, subscription, **kwargs): - """ - Update a subscription. - {\"nickname\":\"Update a subscription\",\"request\":\"updateSubscriptionRequest.html\",\"response\":\"updateSubscriptionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_subscription_with_http_info(subscription, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Subscription subscription: The subscription object to be updated. (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription' is set - if ('subscription' not in params) or (params['subscription'] is None): - raise ValueError("Missing the required parameter `subscription` when calling `update_subscription`") - - resource_path = '/subscriptions'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'subscription' in params: - body_params = params['subscription'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_subscription_v2(self, request, **kwargs): - """ - Update a subscription (V2). - {\"nickname\":\"Update subscription (V2)\",\"response\":\"updateSubscriptionViaHelper.html\",\"request\":\"updateSubscriptionViaHelper.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_subscription_v2(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UpdateSubscriptionRequest request: (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_subscription_v2_with_http_info(request, **kwargs) - else: - (data) = self.update_subscription_v2_with_http_info(request, **kwargs) - return data - - def update_subscription_v2_with_http_info(self, request, **kwargs): - """ - Update a subscription (V2). - {\"nickname\":\"Update subscription (V2)\",\"response\":\"updateSubscriptionViaHelper.html\",\"request\":\"updateSubscriptionViaHelper.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_subscription_v2_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UpdateSubscriptionRequest request: (required) - :return: SubscriptionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_subscription_v2" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `update_subscription_v2`") - - resource_path = '/subscriptions/update'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='SubscriptionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def upsert_metadata_for_subscription(self, metadata, subscription_id, **kwargs): - """ - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - {\"nickname\":\"Upsert on subscription\",\"request\":\"upsertSubscriptionMetadataRequest.html\",\"response\":\"upsertSubscriptionMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upsert_metadata_for_subscription(metadata, subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.upsert_metadata_for_subscription_with_http_info(metadata, subscription_id, **kwargs) - else: - (data) = self.upsert_metadata_for_subscription_with_http_info(metadata, subscription_id, **kwargs) - return data - - def upsert_metadata_for_subscription_with_http_info(self, metadata, subscription_id, **kwargs): - """ - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - {\"nickname\":\"Upsert on subscription\",\"request\":\"upsertSubscriptionMetadataRequest.html\",\"response\":\"upsertSubscriptionMetadataResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.upsert_metadata_for_subscription_with_http_info(metadata, subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DynamicMetadata metadata: (required) - :param str subscription_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DynamicMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['metadata', 'subscription_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method upsert_metadata_for_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'metadata' is set - if ('metadata' not in params) or (params['metadata'] is None): - raise ValueError("Missing the required parameter `metadata` when calling `upsert_metadata_for_subscription`") - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `upsert_metadata_for_subscription`") - - resource_path = '/subscriptions/{subscription-ID}/metadata'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-ID'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'metadata' in params: - body_params = params['metadata'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DynamicMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/synch_app_configs_api.py b/billforward/apis/synch_app_configs_api.py deleted file mode 100644 index a2a2af2..0000000 --- a/billforward/apis/synch_app_configs_api.py +++ /dev/null @@ -1,475 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class SynchAppConfigsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_sync_app_config(self, synch_app_config, **kwargs): - """ - Create a synch app configuration. - {\"nickname\":\"Create a new synch app configuration\",\"request\":\"createSynchAppConfigurationRequest.html\",\"response\":\"createSynchAppConfigurationResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_sync_app_config(synch_app_config, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity synch_app_config: The data synch app config object to be created. (required) - :return: DataSynchronisationAppConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_sync_app_config_with_http_info(synch_app_config, **kwargs) - else: - (data) = self.create_sync_app_config_with_http_info(synch_app_config, **kwargs) - return data - - def create_sync_app_config_with_http_info(self, synch_app_config, **kwargs): - """ - Create a synch app configuration. - {\"nickname\":\"Create a new synch app configuration\",\"request\":\"createSynchAppConfigurationRequest.html\",\"response\":\"createSynchAppConfigurationResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_sync_app_config_with_http_info(synch_app_config, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity synch_app_config: The data synch app config object to be created. (required) - :return: DataSynchronisationAppConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['synch_app_config'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_sync_app_config" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'synch_app_config' is set - if ('synch_app_config' not in params) or (params['synch_app_config'] is None): - raise ValueError("Missing the required parameter `synch_app_config` when calling `create_sync_app_config`") - - resource_path = '/synchAppConfigs'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'synch_app_config' in params: - body_params = params['synch_app_config'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronisationAppConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_sync_app_config(self, synch_app_configs_id, **kwargs): - """ - Returns a single config, specified by the ID parameter. - { \"nickname\" : \"Retrieve an existing synch config\",\"response\" : \"getSynchAppConfigByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_app_config(synch_app_configs_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str synch_app_configs_id: ID of the Synch App Configuration. (required) - :param list[str] organizations: A list of organization -IDs used to restrict the scope of API calls. - :return: DataSynchronisationAppConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_sync_app_config_with_http_info(synch_app_configs_id, **kwargs) - else: - (data) = self.get_sync_app_config_with_http_info(synch_app_configs_id, **kwargs) - return data - - def get_sync_app_config_with_http_info(self, synch_app_configs_id, **kwargs): - """ - Returns a single config, specified by the ID parameter. - { \"nickname\" : \"Retrieve an existing synch config\",\"response\" : \"getSynchAppConfigByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_app_config_with_http_info(synch_app_configs_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str synch_app_configs_id: ID of the Synch App Configuration. (required) - :param list[str] organizations: A list of organization -IDs used to restrict the scope of API calls. - :return: DataSynchronisationAppConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['synch_app_configs_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_sync_app_config" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'synch_app_configs_id' is set - if ('synch_app_configs_id' not in params) or (params['synch_app_configs_id'] is None): - raise ValueError("Missing the required parameter `synch_app_configs_id` when calling `get_sync_app_config`") - - resource_path = '/synchAppConfigs/{synchAppConfigs-ID}'.replace('{format}', 'json') - path_params = {} - if 'synch_app_configs_id' in params: - path_params['synchAppConfigs-ID'] = params['synch_app_configs_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronisationAppConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_sync_app_config_by_platform(self, platform, **kwargs): - """ - Returns a collection configurations, specified by the platform parameter. - { \"nickname\" : \"Retrieve by platform\",\"response\" : \"getSynchAppConfigsByPlatform.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_app_config_by_platform(platform, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str platform: The type of the synch app configuration. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronisationAppConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_sync_app_config_by_platform_with_http_info(platform, **kwargs) - else: - (data) = self.get_sync_app_config_by_platform_with_http_info(platform, **kwargs) - return data - - def get_sync_app_config_by_platform_with_http_info(self, platform, **kwargs): - """ - Returns a collection configurations, specified by the platform parameter. - { \"nickname\" : \"Retrieve by platform\",\"response\" : \"getSynchAppConfigsByPlatform.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_app_config_by_platform_with_http_info(platform, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str platform: The type of the synch app configuration. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronisationAppConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['platform', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_sync_app_config_by_platform" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'platform' is set - if ('platform' not in params) or (params['platform'] is None): - raise ValueError("Missing the required parameter `platform` when calling `get_sync_app_config_by_platform`") - - resource_path = '/synchAppConfigs/platform/{platform}'.replace('{format}', 'json') - path_params = {} - if 'platform' in params: - path_params['platform'] = params['platform'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronisationAppConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_sync_app_config(self, synch_app_config, **kwargs): - """ - Update a synch app configuration. - { \"nickname\" : \"Update a sync app configuration\", \"request\" : \"updateSyncAppConfigRequest.html\" ,\"response\" : \"updateSyncAppConfigResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_sync_app_config(synch_app_config, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity synch_app_config: The synch app configuration object to be updated. (required) - :return: DataSynchronisationAppConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_sync_app_config_with_http_info(synch_app_config, **kwargs) - else: - (data) = self.update_sync_app_config_with_http_info(synch_app_config, **kwargs) - return data - - def update_sync_app_config_with_http_info(self, synch_app_config, **kwargs): - """ - Update a synch app configuration. - { \"nickname\" : \"Update a sync app configuration\", \"request\" : \"updateSyncAppConfigRequest.html\" ,\"response\" : \"updateSyncAppConfigResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_sync_app_config_with_http_info(synch_app_config, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity synch_app_config: The synch app configuration object to be updated. (required) - :return: DataSynchronisationAppConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['synch_app_config'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_sync_app_config" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'synch_app_config' is set - if ('synch_app_config' not in params) or (params['synch_app_config'] is None): - raise ValueError("Missing the required parameter `synch_app_config` when calling `update_sync_app_config`") - - resource_path = '/synchAppConfigs'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'synch_app_config' in params: - body_params = params['synch_app_config'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronisationAppConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/synch_configs_api.py b/billforward/apis/synch_configs_api.py deleted file mode 100644 index bf4d656..0000000 --- a/billforward/apis/synch_configs_api.py +++ /dev/null @@ -1,700 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class SynchConfigsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_sync_config(self, synch_config, **kwargs): - """ - Create a synch configuration. - {\"nickname\":\"Create a new synch configuration\",\"request\":\"createSynchConfigRequest.html\",\"response\":\"createSynchConfigResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_sync_config(synch_config, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DataSynchronisationConfiguration synch_config: The data synch config object to be created. (required) - :return: DataSynchronisationConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_sync_config_with_http_info(synch_config, **kwargs) - else: - (data) = self.create_sync_config_with_http_info(synch_config, **kwargs) - return data - - def create_sync_config_with_http_info(self, synch_config, **kwargs): - """ - Create a synch configuration. - {\"nickname\":\"Create a new synch configuration\",\"request\":\"createSynchConfigRequest.html\",\"response\":\"createSynchConfigResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_sync_config_with_http_info(synch_config, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DataSynchronisationConfiguration synch_config: The data synch config object to be created. (required) - :return: DataSynchronisationConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['synch_config'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_sync_config" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'synch_config' is set - if ('synch_config' not in params) or (params['synch_config'] is None): - raise ValueError("Missing the required parameter `synch_config` when calling `create_sync_config`") - - resource_path = '/synchConfigs'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'synch_config' in params: - body_params = params['synch_config'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronisationConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_sync_configs(self, **kwargs): - """ - Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Get all synch configs\",\"response\" : \"getSynchConfigsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_sync_configs(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first synch configuration to return. - :param int records: The maximum number of configs to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: DataSynchronisationConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_sync_configs_with_http_info(**kwargs) - else: - (data) = self.get_all_sync_configs_with_http_info(**kwargs) - return data - - def get_all_sync_configs_with_http_info(self, **kwargs): - """ - Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Get all synch configs\",\"response\" : \"getSynchConfigsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_sync_configs_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first synch configuration to return. - :param int records: The maximum number of configs to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: DataSynchronisationConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_sync_configs" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/synchConfigs'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronisationConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_sync_config(self, synch_configs_id, **kwargs): - """ - Returns a single config, specified by the ID parameter. - { \"nickname\" : \"Retrieve an existing synch config\",\"response\" : \"getSynchConfigByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_config(synch_configs_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str synch_configs_id: ID of the Synch Configuration. (required) - :param list[str] organizations: A list of organization -IDs used to restrict the scope of API calls. - :return: DataSynchronisationConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_sync_config_with_http_info(synch_configs_id, **kwargs) - else: - (data) = self.get_sync_config_with_http_info(synch_configs_id, **kwargs) - return data - - def get_sync_config_with_http_info(self, synch_configs_id, **kwargs): - """ - Returns a single config, specified by the ID parameter. - { \"nickname\" : \"Retrieve an existing synch config\",\"response\" : \"getSynchConfigByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_config_with_http_info(synch_configs_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str synch_configs_id: ID of the Synch Configuration. (required) - :param list[str] organizations: A list of organization -IDs used to restrict the scope of API calls. - :return: DataSynchronisationConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['synch_configs_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_sync_config" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'synch_configs_id' is set - if ('synch_configs_id' not in params) or (params['synch_configs_id'] is None): - raise ValueError("Missing the required parameter `synch_configs_id` when calling `get_sync_config`") - - resource_path = '/synchConfigs/{synchConfigs-ID}'.replace('{format}', 'json') - path_params = {} - if 'synch_configs_id' in params: - path_params['synchConfigs-ID'] = params['synch_configs_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronisationConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_sync_config_by_platform(self, platform, **kwargs): - """ - Returns a collection configurations, specified by the platform parameter. - { \"nickname\" : \"Retrieve by platform\",\"response\" : \"getSynchConfigsByPlatform.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_config_by_platform(platform, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str platform: The type of the synch configuration. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronisationConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_sync_config_by_platform_with_http_info(platform, **kwargs) - else: - (data) = self.get_sync_config_by_platform_with_http_info(platform, **kwargs) - return data - - def get_sync_config_by_platform_with_http_info(self, platform, **kwargs): - """ - Returns a collection configurations, specified by the platform parameter. - { \"nickname\" : \"Retrieve by platform\",\"response\" : \"getSynchConfigsByPlatform.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_config_by_platform_with_http_info(platform, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str platform: The type of the synch configuration. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronisationConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['platform', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_sync_config_by_platform" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'platform' is set - if ('platform' not in params) or (params['platform'] is None): - raise ValueError("Missing the required parameter `platform` when calling `get_sync_config_by_platform`") - - resource_path = '/synchConfigs/platform/{platform}'.replace('{format}', 'json') - path_params = {} - if 'platform' in params: - path_params['platform'] = params['platform'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronisationConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_sync_config_by_username(self, username, **kwargs): - """ - Returns a collection configurations, specified by the username parameter. - { \"nickname\" : \"Retrieve by username\",\"response\" : \"getSynchConfigByUsername.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_config_by_username(username, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str username: The username in the synch configuration. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronisationConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_sync_config_by_username_with_http_info(username, **kwargs) - else: - (data) = self.get_sync_config_by_username_with_http_info(username, **kwargs) - return data - - def get_sync_config_by_username_with_http_info(self, username, **kwargs): - """ - Returns a collection configurations, specified by the username parameter. - { \"nickname\" : \"Retrieve by username\",\"response\" : \"getSynchConfigByUsername.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_config_by_username_with_http_info(username, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str username: The username in the synch configuration. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronisationConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['username', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_sync_config_by_username" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'username' is set - if ('username' not in params) or (params['username'] is None): - raise ValueError("Missing the required parameter `username` when calling `get_sync_config_by_username`") - - resource_path = '/synchConfigs/username/{username}'.replace('{format}', 'json') - path_params = {} - if 'username' in params: - path_params['username'] = params['username'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronisationConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_sync_config(self, synch_config, **kwargs): - """ - Update a synch configuration. - { \"nickname\" : \"Update a synch config\", \"request\" : \"updateSyncConfigRequest.html\" ,\"response\" : \"updateSyncConfigResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_sync_config(synch_config, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DataSynchronisationConfiguration synch_config: The synch configuration object to be updated. (required) - :return: DataSynchronisationConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_sync_config_with_http_info(synch_config, **kwargs) - else: - (data) = self.update_sync_config_with_http_info(synch_config, **kwargs) - return data - - def update_sync_config_with_http_info(self, synch_config, **kwargs): - """ - Update a synch configuration. - { \"nickname\" : \"Update a synch config\", \"request\" : \"updateSyncConfigRequest.html\" ,\"response\" : \"updateSyncConfigResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_sync_config_with_http_info(synch_config, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param DataSynchronisationConfiguration synch_config: The synch configuration object to be updated. (required) - :return: DataSynchronisationConfigurationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['synch_config'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_sync_config" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'synch_config' is set - if ('synch_config' not in params) or (params['synch_config'] is None): - raise ValueError("Missing the required parameter `synch_config` when calling `update_sync_config`") - - resource_path = '/synchConfigs'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'synch_config' in params: - body_params = params['synch_config'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronisationConfigurationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/synch_jobs_api.py b/billforward/apis/synch_jobs_api.py deleted file mode 100644 index c18ded3..0000000 --- a/billforward/apis/synch_jobs_api.py +++ /dev/null @@ -1,916 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class SynchJobsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_sync_job(self, synch_job, **kwargs): - """ - Create a synch job. - {\"nickname\":\"Create a new sync job\",\"request\":\"createSynchJobRequest.html\",\"response\":\"createSynchJobResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_sync_job(synch_job, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity synch_job: The data synch job object to be created. (required) - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_sync_job_with_http_info(synch_job, **kwargs) - else: - (data) = self.create_sync_job_with_http_info(synch_job, **kwargs) - return data - - def create_sync_job_with_http_info(self, synch_job, **kwargs): - """ - Create a synch job. - {\"nickname\":\"Create a new sync job\",\"request\":\"createSynchJobRequest.html\",\"response\":\"createSynchJobResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_sync_job_with_http_info(synch_job, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity synch_job: The data synch job object to be created. (required) - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['synch_job'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_sync_job" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'synch_job' is set - if ('synch_job' not in params) or (params['synch_job'] is None): - raise ValueError("Missing the required parameter `synch_job` when calling `create_sync_job`") - - resource_path = '/synchJobs'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'synch_job' in params: - body_params = params['synch_job'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronizationJobPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_sync_jobs(self, **kwargs): - """ - Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all synch jobs\",\"response\":\"getSynchJobsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_sync_jobs(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first synch job to return. - :param int records: The maximum number of synch jobs to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_sync_jobs_with_http_info(**kwargs) - else: - (data) = self.get_all_sync_jobs_with_http_info(**kwargs) - return data - - def get_all_sync_jobs_with_http_info(self, **kwargs): - """ - Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all synch jobs\",\"response\":\"getSynchJobsAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_sync_jobs_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first synch job to return. - :param int records: The maximum number of synch jobs to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_sync_jobs" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/synchJobs'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronizationJobPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_sync_job_by_id(self, synch_job_id, **kwargs): - """ - Returns a single job, specified by the ID parameter. - {\"nickname\":\"Retrieve an existing synch job\",\"response\":\"getSyncJobByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_job_by_id(synch_job_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str synch_job_id: ID of the Sync Job. (required) - :param list[str] organizations: A list of organization -IDs used to restrict the scope of API calls. - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_sync_job_by_id_with_http_info(synch_job_id, **kwargs) - else: - (data) = self.get_sync_job_by_id_with_http_info(synch_job_id, **kwargs) - return data - - def get_sync_job_by_id_with_http_info(self, synch_job_id, **kwargs): - """ - Returns a single job, specified by the ID parameter. - {\"nickname\":\"Retrieve an existing synch job\",\"response\":\"getSyncJobByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_job_by_id_with_http_info(synch_job_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str synch_job_id: ID of the Sync Job. (required) - :param list[str] organizations: A list of organization -IDs used to restrict the scope of API calls. - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['synch_job_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_sync_job_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'synch_job_id' is set - if ('synch_job_id' not in params) or (params['synch_job_id'] is None): - raise ValueError("Missing the required parameter `synch_job_id` when calling `get_sync_job_by_id`") - - resource_path = '/synchJobs/{synchJob-ID}'.replace('{format}', 'json') - path_params = {} - if 'synch_job_id' in params: - path_params['synchJob-ID'] = params['synch_job_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronizationJobPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_sync_job_by_scope(self, scope, **kwargs): - """ - Returns a collection jobs, specified by the scope parameter. - {\"nickname\":\"Retrieve by scope\",\"response\":\"getSyncJobByScope.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_job_by_scope(scope, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str scope: The scope of the synch job. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_sync_job_by_scope_with_http_info(scope, **kwargs) - else: - (data) = self.get_sync_job_by_scope_with_http_info(scope, **kwargs) - return data - - def get_sync_job_by_scope_with_http_info(self, scope, **kwargs): - """ - Returns a collection jobs, specified by the scope parameter. - {\"nickname\":\"Retrieve by scope\",\"response\":\"getSyncJobByScope.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_job_by_scope_with_http_info(scope, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str scope: The scope of the synch job. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['scope', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_sync_job_by_scope" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'scope' is set - if ('scope' not in params) or (params['scope'] is None): - raise ValueError("Missing the required parameter `scope` when calling `get_sync_job_by_scope`") - - resource_path = '/synchJobs/scope/{scope}'.replace('{format}', 'json') - path_params = {} - if 'scope' in params: - path_params['scope'] = params['scope'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronizationJobPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_sync_job_by_state(self, state, **kwargs): - """ - Returns a collection jobs, specified by the state parameter. - {\"nickname\":\"Retrieve by state\",\"response\":\"getSyncJobByState.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_job_by_state(state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The state of the synch job. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_sync_job_by_state_with_http_info(state, **kwargs) - else: - (data) = self.get_sync_job_by_state_with_http_info(state, **kwargs) - return data - - def get_sync_job_by_state_with_http_info(self, state, **kwargs): - """ - Returns a collection jobs, specified by the state parameter. - {\"nickname\":\"Retrieve by state\",\"response\":\"getSyncJobByState.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_job_by_state_with_http_info(state, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str state: The state of the synch job. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['state', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_sync_job_by_state" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'state' is set - if ('state' not in params) or (params['state'] is None): - raise ValueError("Missing the required parameter `state` when calling `get_sync_job_by_state`") - - resource_path = '/synchJobs/state/{state}'.replace('{format}', 'json') - path_params = {} - if 'state' in params: - path_params['state'] = params['state'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronizationJobPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_sync_job_by_target(self, target, **kwargs): - """ - Returns a collection jobs, specified by the target parameter. - {\"nickname\":\"Retrieve by target\",\"response\":\"getSyncJobByTarget.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_job_by_target(target, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str target: The target of the synch job. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_sync_job_by_target_with_http_info(target, **kwargs) - else: - (data) = self.get_sync_job_by_target_with_http_info(target, **kwargs) - return data - - def get_sync_job_by_target_with_http_info(self, target, **kwargs): - """ - Returns a collection jobs, specified by the target parameter. - {\"nickname\":\"Retrieve by target\",\"response\":\"getSyncJobByTarget.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_job_by_target_with_http_info(target, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str target: The target of the synch job. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['target', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_sync_job_by_target" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'target' is set - if ('target' not in params) or (params['target'] is None): - raise ValueError("Missing the required parameter `target` when calling `get_sync_job_by_target`") - - resource_path = '/synchJobs/target/{target}'.replace('{format}', 'json') - path_params = {} - if 'target' in params: - path_params['target'] = params['target'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronizationJobPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_sync_job_by_type(self, type, **kwargs): - """ - Returns a collection jobs, specified by the type parameter. - {\"nickname\":\"Retrieve by type\",\"response\":\"getSyncJobByType.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_job_by_type(type, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str type: The type of the synch job. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_sync_job_by_type_with_http_info(type, **kwargs) - else: - (data) = self.get_sync_job_by_type_with_http_info(type, **kwargs) - return data - - def get_sync_job_by_type_with_http_info(self, type, **kwargs): - """ - Returns a collection jobs, specified by the type parameter. - {\"nickname\":\"Retrieve by type\",\"response\":\"getSyncJobByType.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_sync_job_by_type_with_http_info(type, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str type: The type of the synch job. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['type', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_sync_job_by_type" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'type' is set - if ('type' not in params) or (params['type'] is None): - raise ValueError("Missing the required parameter `type` when calling `get_sync_job_by_type`") - - resource_path = '/synchJobs/type/{type}'.replace('{format}', 'json') - path_params = {} - if 'type' in params: - path_params['type'] = params['type'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronizationJobPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_sync_job(self, synch_job, **kwargs): - """ - Update a synch job. - {\"nickname\":\"Update a synch job\",\"request\":\"updateSyncJobRequest.html\",\"response\":\"updateSyncJobResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_sync_job(synch_job, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity synch_job: The synch job object to be updated. (required) - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_sync_job_with_http_info(synch_job, **kwargs) - else: - (data) = self.update_sync_job_with_http_info(synch_job, **kwargs) - return data - - def update_sync_job_with_http_info(self, synch_job, **kwargs): - """ - Update a synch job. - {\"nickname\":\"Update a synch job\",\"request\":\"updateSyncJobRequest.html\",\"response\":\"updateSyncJobResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_sync_job_with_http_info(synch_job, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity synch_job: The synch job object to be updated. (required) - :return: DataSynchronizationJobPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['synch_job'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_sync_job" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'synch_job' is set - if ('synch_job' not in params) or (params['synch_job'] is None): - raise ValueError("Missing the required parameter `synch_job` when calling `update_sync_job`") - - resource_path = '/synchJobs'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'synch_job' in params: - body_params = params['synch_job'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='DataSynchronizationJobPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/taxationlinks_api.py b/billforward/apis/taxationlinks_api.py deleted file mode 100644 index 9a5325e..0000000 --- a/billforward/apis/taxationlinks_api.py +++ /dev/null @@ -1,744 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class TaxationlinksApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_taxation_link(self, taxation_link, **kwargs): - """ - Create - {\"nickname\":\"Add a taxation strategy to a rate-plan\",\"request\":\"createTaxationLinkRequest.html\",\"response\":\"createTaxationLinkResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_taxation_link(taxation_link, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity taxation_link: The taxation-link object to be updated. (required) - :return: TaxationLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_taxation_link_with_http_info(taxation_link, **kwargs) - else: - (data) = self.create_taxation_link_with_http_info(taxation_link, **kwargs) - return data - - def create_taxation_link_with_http_info(self, taxation_link, **kwargs): - """ - Create - {\"nickname\":\"Add a taxation strategy to a rate-plan\",\"request\":\"createTaxationLinkRequest.html\",\"response\":\"createTaxationLinkResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_taxation_link_with_http_info(taxation_link, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity taxation_link: The taxation-link object to be updated. (required) - :return: TaxationLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['taxation_link'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_taxation_link" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'taxation_link' is set - if ('taxation_link' not in params) or (params['taxation_link'] is None): - raise ValueError("Missing the required parameter `taxation_link` when calling `create_taxation_link`") - - resource_path = '/taxation-links'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'taxation_link' in params: - body_params = params['taxation_link'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationLinkPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_taxation_links(self, **kwargs): - """ - Returns a collection of all taxation-links. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all taxation links\",\"response\":\"getTaxationLinkAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_taxation_links(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_taxation_links_with_http_info(**kwargs) - else: - (data) = self.get_all_taxation_links_with_http_info(**kwargs) - return data - - def get_all_taxation_links_with_http_info(self, **kwargs): - """ - Returns a collection of all taxation-links. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all taxation links\",\"response\":\"getTaxationLinkAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_taxation_links_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_taxation_links" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/taxation-links'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationLinkPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_taxation_link_by_id(self, taxation_link_id, **kwargs): - """ - Returns a single taxation-link, specified by the taxation-link-ID parameter. - {\"nickname\":\"Retrieve an existing taxation link\",\"response\":\"getTaxationLinkByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_link_by_id(taxation_link_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str taxation_link_id: The unique ID of the Taxation Link. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: TaxationLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_taxation_link_by_id_with_http_info(taxation_link_id, **kwargs) - else: - (data) = self.get_taxation_link_by_id_with_http_info(taxation_link_id, **kwargs) - return data - - def get_taxation_link_by_id_with_http_info(self, taxation_link_id, **kwargs): - """ - Returns a single taxation-link, specified by the taxation-link-ID parameter. - {\"nickname\":\"Retrieve an existing taxation link\",\"response\":\"getTaxationLinkByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_link_by_id_with_http_info(taxation_link_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str taxation_link_id: The unique ID of the Taxation Link. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: TaxationLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['taxation_link_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_taxation_link_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'taxation_link_id' is set - if ('taxation_link_id' not in params) or (params['taxation_link_id'] is None): - raise ValueError("Missing the required parameter `taxation_link_id` when calling `get_taxation_link_by_id`") - - resource_path = '/taxation-links/{taxation-link-ID}'.replace('{format}', 'json') - path_params = {} - if 'taxation_link_id' in params: - path_params['taxation-link-ID'] = params['taxation_link_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationLinkPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_taxation_link_by_product_rate_plan(self, product_rate_plan_id, **kwargs): - """ - Returns a collection of taxation-links, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by rate-plan\",\"response\":\"getTaxationLinkByPRPID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_link_by_product_rate_plan(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: The ID of the product-rate-plan (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_taxation_link_by_product_rate_plan_with_http_info(product_rate_plan_id, **kwargs) - else: - (data) = self.get_taxation_link_by_product_rate_plan_with_http_info(product_rate_plan_id, **kwargs) - return data - - def get_taxation_link_by_product_rate_plan_with_http_info(self, product_rate_plan_id, **kwargs): - """ - Returns a collection of taxation-links, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by rate-plan\",\"response\":\"getTaxationLinkByPRPID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_link_by_product_rate_plan_with_http_info(product_rate_plan_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str product_rate_plan_id: The ID of the product-rate-plan (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['product_rate_plan_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_taxation_link_by_product_rate_plan" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'product_rate_plan_id' is set - if ('product_rate_plan_id' not in params) or (params['product_rate_plan_id'] is None): - raise ValueError("Missing the required parameter `product_rate_plan_id` when calling `get_taxation_link_by_product_rate_plan`") - - resource_path = '/taxation-links/product-rate-plan/{product-rate-plan-ID}'.replace('{format}', 'json') - path_params = {} - if 'product_rate_plan_id' in params: - path_params['product-rate-plan-ID'] = params['product_rate_plan_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationLinkPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_taxation_link_by_taxation_strategy(self, taxation_strategy_id, **kwargs): - """ - Returns a collection of taxation-links, specified by the taxation-strategy-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by taxation strategy\",\"response\":\"getTaxationLinkByTSID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_link_by_taxation_strategy(taxation_strategy_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str taxation_strategy_id: The ID of the taxation-strategy (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_taxation_link_by_taxation_strategy_with_http_info(taxation_strategy_id, **kwargs) - else: - (data) = self.get_taxation_link_by_taxation_strategy_with_http_info(taxation_strategy_id, **kwargs) - return data - - def get_taxation_link_by_taxation_strategy_with_http_info(self, taxation_strategy_id, **kwargs): - """ - Returns a collection of taxation-links, specified by the taxation-strategy-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by taxation strategy\",\"response\":\"getTaxationLinkByTSID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_link_by_taxation_strategy_with_http_info(taxation_strategy_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str taxation_strategy_id: The ID of the taxation-strategy (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['taxation_strategy_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_taxation_link_by_taxation_strategy" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'taxation_strategy_id' is set - if ('taxation_strategy_id' not in params) or (params['taxation_strategy_id'] is None): - raise ValueError("Missing the required parameter `taxation_strategy_id` when calling `get_taxation_link_by_taxation_strategy`") - - resource_path = '/taxation-links/taxation-strategy/{taxation-strategy-ID}'.replace('{format}', 'json') - path_params = {} - if 'taxation_strategy_id' in params: - path_params['taxation-strategy-ID'] = params['taxation_strategy_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationLinkPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_taxation_link(self, taxation_link, **kwargs): - """ - Update - {\"nickname\":\"Change taxation linked to rate-plan\",\"request\":\"updateTaxationLinkRequest.html\",\"response\":\"updateTaxationLinkResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_taxation_link(taxation_link, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity taxation_link: The taxation-link object to be updated. (required) - :return: TaxationLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_taxation_link_with_http_info(taxation_link, **kwargs) - else: - (data) = self.update_taxation_link_with_http_info(taxation_link, **kwargs) - return data - - def update_taxation_link_with_http_info(self, taxation_link, **kwargs): - """ - Update - {\"nickname\":\"Change taxation linked to rate-plan\",\"request\":\"updateTaxationLinkRequest.html\",\"response\":\"updateTaxationLinkResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_taxation_link_with_http_info(taxation_link, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity taxation_link: The taxation-link object to be updated. (required) - :return: TaxationLinkPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['taxation_link'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_taxation_link" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'taxation_link' is set - if ('taxation_link' not in params) or (params['taxation_link'] is None): - raise ValueError("Missing the required parameter `taxation_link` when calling `update_taxation_link`") - - resource_path = '/taxation-links'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'taxation_link' in params: - body_params = params['taxation_link'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationLinkPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/taxationstrategies_api.py b/billforward/apis/taxationstrategies_api.py deleted file mode 100644 index 30cb7a1..0000000 --- a/billforward/apis/taxationstrategies_api.py +++ /dev/null @@ -1,1111 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class TaxationstrategiesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_taxation_strategy(self, taxation_strategy, **kwargs): - """ -

Add a new tax or schedule changes in an existing tax.

Add a new tax by providing the location and tax percentage. To schedule a tax change specify the ID of the current Tax. A new version of the will be created validFrom the specified date, the existing tax validTill the start of this new tax.

- {\"nickname\":\"Create a tax\",\"request\":\"createTaxationStrategyRequest.html\",\"response\":\"createTaxationStrategyResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_taxation_strategy(taxation_strategy, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity taxation_strategy: The taxation-strategy object to be updated. (required) - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_taxation_strategy_with_http_info(taxation_strategy, **kwargs) - else: - (data) = self.create_taxation_strategy_with_http_info(taxation_strategy, **kwargs) - return data - - def create_taxation_strategy_with_http_info(self, taxation_strategy, **kwargs): - """ -

Add a new tax or schedule changes in an existing tax.

Add a new tax by providing the location and tax percentage. To schedule a tax change specify the ID of the current Tax. A new version of the will be created validFrom the specified date, the existing tax validTill the start of this new tax.

- {\"nickname\":\"Create a tax\",\"request\":\"createTaxationStrategyRequest.html\",\"response\":\"createTaxationStrategyResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_taxation_strategy_with_http_info(taxation_strategy, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity taxation_strategy: The taxation-strategy object to be updated. (required) - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['taxation_strategy'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_taxation_strategy" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'taxation_strategy' is set - if ('taxation_strategy' not in params) or (params['taxation_strategy'] is None): - raise ValueError("Missing the required parameter `taxation_strategy` when calling `create_taxation_strategy`") - - resource_path = '/taxation-strategies'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'taxation_strategy' in params: - body_params = params['taxation_strategy'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_taxation_strategies(self, **kwargs): - """ - Returns a collection of all taxation-strategies. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all tax\",\"response\":\"getTaxationStrategyAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_taxation_strategies(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-strategy to return. - :param int records: The maximum number of taxation-strategies to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_taxation_strategies_with_http_info(**kwargs) - else: - (data) = self.get_all_taxation_strategies_with_http_info(**kwargs) - return data - - def get_all_taxation_strategies_with_http_info(self, **kwargs): - """ - Returns a collection of all taxation-strategies. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all tax\",\"response\":\"getTaxationStrategyAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_taxation_strategies_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-strategy to return. - :param int records: The maximum number of taxation-strategies to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_taxation_strategies" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/taxation-strategies'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_taxation_strategy_by_consistent_id(self, taxation_strategy_id, **kwargs): - """ - Returns the tax currently being applied for the taxation-strategy-ID. To return schedule or historic tax changes the include_retired query parameter should be set to true. - {\"nickname\":\"Retrieve an existing tax \",\"response\":\"getTaxationStrategyByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_strategy_by_consistent_id(taxation_strategy_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str taxation_strategy_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-strategy to return. - :param int records: The maximum number of taxation-strategies to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_taxation_strategy_by_consistent_id_with_http_info(taxation_strategy_id, **kwargs) - else: - (data) = self.get_taxation_strategy_by_consistent_id_with_http_info(taxation_strategy_id, **kwargs) - return data - - def get_taxation_strategy_by_consistent_id_with_http_info(self, taxation_strategy_id, **kwargs): - """ - Returns the tax currently being applied for the taxation-strategy-ID. To return schedule or historic tax changes the include_retired query parameter should be set to true. - {\"nickname\":\"Retrieve an existing tax \",\"response\":\"getTaxationStrategyByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_strategy_by_consistent_id_with_http_info(taxation_strategy_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str taxation_strategy_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-strategy to return. - :param int records: The maximum number of taxation-strategies to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['taxation_strategy_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_taxation_strategy_by_consistent_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'taxation_strategy_id' is set - if ('taxation_strategy_id' not in params) or (params['taxation_strategy_id'] is None): - raise ValueError("Missing the required parameter `taxation_strategy_id` when calling `get_taxation_strategy_by_consistent_id`") - - resource_path = '/taxation-strategies/{taxation-strategy-ID}'.replace('{format}', 'json') - path_params = {} - if 'taxation_strategy_id' in params: - path_params['taxation-strategy-ID'] = params['taxation_strategy_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_taxation_strategy_by_country(self, country, **kwargs): - """ - Returns a collection of taxation-strategies, specified by the country parameter. By default 10 values are returned. Records are returned in natural order. To return schedule or historic tax changes the include_retired query parameter should be set to true. - {\"nickname\":\"Retrieve by country\",\"response\":\"getTaxationStrategyByCountry.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_strategy_by_country(country, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str country: The country (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-strategy to return. - :param int records: The maximum number of taxation-strategies to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_taxation_strategy_by_country_with_http_info(country, **kwargs) - else: - (data) = self.get_taxation_strategy_by_country_with_http_info(country, **kwargs) - return data - - def get_taxation_strategy_by_country_with_http_info(self, country, **kwargs): - """ - Returns a collection of taxation-strategies, specified by the country parameter. By default 10 values are returned. Records are returned in natural order. To return schedule or historic tax changes the include_retired query parameter should be set to true. - {\"nickname\":\"Retrieve by country\",\"response\":\"getTaxationStrategyByCountry.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_strategy_by_country_with_http_info(country, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str country: The country (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-strategy to return. - :param int records: The maximum number of taxation-strategies to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['country', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_taxation_strategy_by_country" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'country' is set - if ('country' not in params) or (params['country'] is None): - raise ValueError("Missing the required parameter `country` when calling `get_taxation_strategy_by_country`") - - resource_path = '/taxation-strategies/country/{country}'.replace('{format}', 'json') - path_params = {} - if 'country' in params: - path_params['country'] = params['country'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_taxation_strategy_by_currency(self, currency, **kwargs): - """ - Returns a collection of taxation-strategies, specified by the currency parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by currency\",\"response\":\"getTaxationStrategyByProvince.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_strategy_by_currency(currency, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str currency: The currency (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-strategy to return. - :param int records: The maximum number of taxation-strategies to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_taxation_strategy_by_currency_with_http_info(currency, **kwargs) - else: - (data) = self.get_taxation_strategy_by_currency_with_http_info(currency, **kwargs) - return data - - def get_taxation_strategy_by_currency_with_http_info(self, currency, **kwargs): - """ - Returns a collection of taxation-strategies, specified by the currency parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by currency\",\"response\":\"getTaxationStrategyByProvince.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_strategy_by_currency_with_http_info(currency, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str currency: The currency (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-strategy to return. - :param int records: The maximum number of taxation-strategies to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['currency', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_taxation_strategy_by_currency" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'currency' is set - if ('currency' not in params) or (params['currency'] is None): - raise ValueError("Missing the required parameter `currency` when calling `get_taxation_strategy_by_currency`") - - resource_path = '/taxation-strategies/currency/{currency}'.replace('{format}', 'json') - path_params = {} - if 'currency' in params: - path_params['currency'] = params['currency'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_taxation_strategy_by_province(self, province, **kwargs): - """ - Returns a collection of taxation-strategies, specified by the province parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by province\",\"response\":\"getTaxationStrategyByProvince.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_strategy_by_province(province, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str province: The province (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-strategy to return. - :param int records: The maximum number of taxation-strategies to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_taxation_strategy_by_province_with_http_info(province, **kwargs) - else: - (data) = self.get_taxation_strategy_by_province_with_http_info(province, **kwargs) - return data - - def get_taxation_strategy_by_province_with_http_info(self, province, **kwargs): - """ - Returns a collection of taxation-strategies, specified by the province parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by province\",\"response\":\"getTaxationStrategyByProvince.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_strategy_by_province_with_http_info(province, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str province: The province (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-strategy to return. - :param int records: The maximum number of taxation-strategies to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['province', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_taxation_strategy_by_province" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'province' is set - if ('province' not in params) or (params['province'] is None): - raise ValueError("Missing the required parameter `province` when calling `get_taxation_strategy_by_province`") - - resource_path = '/taxation-strategies/province/{province}'.replace('{format}', 'json') - path_params = {} - if 'province' in params: - path_params['province'] = params['province'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_taxation_strategy_by_version_id(self, version_id, **kwargs): - """ - Returns a single taxation-strategy, specified by the taxation-strategy-ID parameter. - {\"nickname\":\"Retrieve by version\",\"response\":\"getTaxationStrategyByVersionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_strategy_by_version_id(version_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_taxation_strategy_by_version_id_with_http_info(version_id, **kwargs) - else: - (data) = self.get_taxation_strategy_by_version_id_with_http_info(version_id, **kwargs) - return data - - def get_taxation_strategy_by_version_id_with_http_info(self, version_id, **kwargs): - """ - Returns a single taxation-strategy, specified by the taxation-strategy-ID parameter. - {\"nickname\":\"Retrieve by version\",\"response\":\"getTaxationStrategyByVersionID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_taxation_strategy_by_version_id_with_http_info(version_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['version_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_taxation_strategy_by_version_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'version_id' is set - if ('version_id' not in params) or (params['version_id'] is None): - raise ValueError("Missing the required parameter `version_id` when calling `get_taxation_strategy_by_version_id`") - - resource_path = '/taxation-strategies/version/{version-ID}'.replace('{format}', 'json') - path_params = {} - if 'version_id' in params: - path_params['version-ID'] = params['version_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def retire_taxation_strategy(self, version_id, organizations, **kwargs): - """ - Retires the taxation-strategy specified by taxation-strategy-ID parameter. Only the version of the tax which has an unbounded (null) validTill can be removed. Removing a tax change will make the previous tax come into effect. For example if you have a Tax in January and 5% and a new tax at 7% from February onwards, you can remove the February tax. Remove the February tax will re-instate the January tax. - {\"nickname\":\"Remove a tax change\",\"response\":\"deleteSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_taxation_strategy(version_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.retire_taxation_strategy_with_http_info(version_id, organizations, **kwargs) - else: - (data) = self.retire_taxation_strategy_with_http_info(version_id, organizations, **kwargs) - return data - - def retire_taxation_strategy_with_http_info(self, version_id, organizations, **kwargs): - """ - Retires the taxation-strategy specified by taxation-strategy-ID parameter. Only the version of the tax which has an unbounded (null) validTill can be removed. Removing a tax change will make the previous tax come into effect. For example if you have a Tax in January and 5% and a new tax at 7% from February onwards, you can remove the February tax. Remove the February tax will re-instate the January tax. - {\"nickname\":\"Remove a tax change\",\"response\":\"deleteSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_taxation_strategy_with_http_info(version_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str version_id: (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['version_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method retire_taxation_strategy" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'version_id' is set - if ('version_id' not in params) or (params['version_id'] is None): - raise ValueError("Missing the required parameter `version_id` when calling `retire_taxation_strategy`") - # verify the required parameter 'organizations' is set - if ('organizations' not in params) or (params['organizations'] is None): - raise ValueError("Missing the required parameter `organizations` when calling `retire_taxation_strategy`") - - resource_path = '/taxation-strategies/version/{version-ID}'.replace('{format}', 'json') - path_params = {} - if 'version_id' in params: - path_params['version-ID'] = params['version_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_taxation_strategy(self, taxation_strategy, **kwargs): - """ - Update a tax. - {\"nickname\":\"Update a tax\",\"request\":\"updateTaxationStrategyRequest.html\",\"response\":\"updateTaxationStrategyResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_taxation_strategy(taxation_strategy, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity taxation_strategy: The taxation-strategy object to be updated. (required) - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_taxation_strategy_with_http_info(taxation_strategy, **kwargs) - else: - (data) = self.update_taxation_strategy_with_http_info(taxation_strategy, **kwargs) - return data - - def update_taxation_strategy_with_http_info(self, taxation_strategy, **kwargs): - """ - Update a tax. - {\"nickname\":\"Update a tax\",\"request\":\"updateTaxationStrategyRequest.html\",\"response\":\"updateTaxationStrategyResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_taxation_strategy_with_http_info(taxation_strategy, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity taxation_strategy: The taxation-strategy object to be updated. (required) - :return: TaxationStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['taxation_strategy'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_taxation_strategy" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'taxation_strategy' is set - if ('taxation_strategy' not in params) or (params['taxation_strategy'] is None): - raise ValueError("Missing the required parameter `taxation_strategy` when calling `update_taxation_strategy`") - - resource_path = '/taxation-strategies'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'taxation_strategy' in params: - body_params = params['taxation_strategy'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TaxationStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/time_api.py b/billforward/apis/time_api.py deleted file mode 100644 index 6292216..0000000 --- a/billforward/apis/time_api.py +++ /dev/null @@ -1,155 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class TimeApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def get_time_swagger(self, request, **kwargs): - """ - - {\"nickname\":\"\",\"request\":\"advanceSubscriptionRequest.html\",\"response\":\"advanceSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_time_swagger(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param TimeRequest request: The request (required) - :return: TimeResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_time_swagger_with_http_info(request, **kwargs) - else: - (data) = self.get_time_swagger_with_http_info(request, **kwargs) - return data - - def get_time_swagger_with_http_info(self, request, **kwargs): - """ - - {\"nickname\":\"\",\"request\":\"advanceSubscriptionRequest.html\",\"response\":\"advanceSubscription.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_time_swagger_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param TimeRequest request: The request (required) - :return: TimeResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_time_swagger" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `get_time_swagger`") - - resource_path = '/time/swagger-end-point'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TimeResponsePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/tokenization_api.py b/billforward/apis/tokenization_api.py deleted file mode 100644 index 6cab67f..0000000 --- a/billforward/apis/tokenization_api.py +++ /dev/null @@ -1,743 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class TokenizationApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def auth_capture(self, auth_capture_request, **kwargs): - """ - [Note: this API can be invoked more simply by our client-side card capture library, BillForward.js; you should not need to interact with this API manually unless you have particularly bespoke requirements] - {\"nickname\":\"Authorized card capture\",\"response\":\"BFJSAuthCapture.html\",\"request\":\"BFJSAuthCapture.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.auth_capture(auth_capture_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param AuthCaptureRequest auth_capture_request: The auth capture request. (required) - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.auth_capture_with_http_info(auth_capture_request, **kwargs) - else: - (data) = self.auth_capture_with_http_info(auth_capture_request, **kwargs) - return data - - def auth_capture_with_http_info(self, auth_capture_request, **kwargs): - """ - [Note: this API can be invoked more simply by our client-side card capture library, BillForward.js; you should not need to interact with this API manually unless you have particularly bespoke requirements] - {\"nickname\":\"Authorized card capture\",\"response\":\"BFJSAuthCapture.html\",\"request\":\"BFJSAuthCapture.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.auth_capture_with_http_info(auth_capture_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param AuthCaptureRequest auth_capture_request: The auth capture request. (required) - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['auth_capture_request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method auth_capture" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'auth_capture_request' is set - if ('auth_capture_request' not in params) or (params['auth_capture_request'] is None): - raise ValueError("Missing the required parameter `auth_capture_request` when calling `auth_capture`") - - resource_path = '/tokenization/auth-capture'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'auth_capture_request' in params: - body_params = params['auth_capture_request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def braintree_card_capture(self, **kwargs): - """ - [Warning: for use only in PCI-compliant environments; for more information, contact us regarding provisioning of your own on-premise BillForward instance] Captures raw credit card details into Braintree's vault. - {\"nickname\":\"Braintree Tokenization\",\"response\":\"braintreeDirectTokenization.html\",\"request\":\"braintreeDirectTokenization.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.braintree_card_capture(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BraintreeCaptureRequest body: - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.braintree_card_capture_with_http_info(**kwargs) - else: - (data) = self.braintree_card_capture_with_http_info(**kwargs) - return data - - def braintree_card_capture_with_http_info(self, **kwargs): - """ - [Warning: for use only in PCI-compliant environments; for more information, contact us regarding provisioning of your own on-premise BillForward instance] Captures raw credit card details into Braintree's vault. - {\"nickname\":\"Braintree Tokenization\",\"response\":\"braintreeDirectTokenization.html\",\"request\":\"braintreeDirectTokenization.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.braintree_card_capture_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BraintreeCaptureRequest body: - :return: PaymentMethodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['body'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method braintree_card_capture" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/tokenization/braintree'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'body' in params: - body_params = params['body'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='PaymentMethodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def pay_vision_shout_v1(self, **kwargs): - """ - [Note: this API is intended to be invoked by the PayVision servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. - {\"nickname\":\"Generate PayVision iframe redirect\",\"response\":\"payVisionShoutV1.html\",\"request\":\"payVisionShoutV1.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.pay_vision_shout_v1(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str _resource_path: - :param str id: - :return: str - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.pay_vision_shout_v1_with_http_info(**kwargs) - else: - (data) = self.pay_vision_shout_v1_with_http_info(**kwargs) - return data - - def pay_vision_shout_v1_with_http_info(self, **kwargs): - """ - [Note: this API is intended to be invoked by the PayVision servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. - {\"nickname\":\"Generate PayVision iframe redirect\",\"response\":\"payVisionShoutV1.html\",\"request\":\"payVisionShoutV1.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.pay_vision_shout_v1_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str _resource_path: - :param str id: - :return: str - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['_resource_path', 'id'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method pay_vision_shout_v1" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/tokenization/payvision-shout-v1'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - if '_resource_path' in params: - form_params.append(('resourcePath', params['_resource_path'])) - if 'id' in params: - form_params.append(('id', params['id'])) - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/html']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/x-www-form-urlencoded']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='str', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def pre_auth(self, pre_auth_request, **kwargs): - """ - [Note: this API can be invoked more simply by our client-side card capture library, BillForward.js; you should not need to interact with this API manually unless you have particularly bespoke requirements] - {\"nickname\":\"Pre-authorize card capture\",\"response\":\"BFJSPreAuth.html\",\"request\":\"BFJSPreAuth.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.pre_auth(pre_auth_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param InsertableBillingEntity pre_auth_request: The auth request. (required) - :return: TokenizationPreAuthPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.pre_auth_with_http_info(pre_auth_request, **kwargs) - else: - (data) = self.pre_auth_with_http_info(pre_auth_request, **kwargs) - return data - - def pre_auth_with_http_info(self, pre_auth_request, **kwargs): - """ - [Note: this API can be invoked more simply by our client-side card capture library, BillForward.js; you should not need to interact with this API manually unless you have particularly bespoke requirements] - {\"nickname\":\"Pre-authorize card capture\",\"response\":\"BFJSPreAuth.html\",\"request\":\"BFJSPreAuth.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.pre_auth_with_http_info(pre_auth_request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param InsertableBillingEntity pre_auth_request: The auth request. (required) - :return: TokenizationPreAuthPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pre_auth_request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method pre_auth" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pre_auth_request' is set - if ('pre_auth_request' not in params) or (params['pre_auth_request'] is None): - raise ValueError("Missing the required parameter `pre_auth_request` when calling `pre_auth`") - - resource_path = '/tokenization/pre-auth'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'pre_auth_request' in params: - body_params = params['pre_auth_request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TokenizationPreAuthPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def sage_pay_notify_v300(self, **kwargs): - """ - [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of receiving a callback from a SagePay card capture operation, using SagePay's FORM Protocol, v3.0] Handles SagePay Notification. - {\"nickname\":\"Handle SagePay Notification\",\"response\":\"sagePayNotifyV3_00.html\",\"request\":\"sagePayNotifyV3_00.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.sage_pay_notify_v300(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the queryparameter. Example: ...&organizations=org1&organizations=org2 - :param str bill_forward_url_root: The URL through which BFJS connected to BillForward. - :param str access_token: The public token through which BFJS connected to BillForward. - :param str vps_protocol: - :param str tx_type: - :param str vendor_tx_code: - :param str status: - :param str vps_tx_id: - :param str card_type: - :param str token: - :param str status_detail: - :param str last4_digits: - :param str vps_signature: - :param str expiry_date: - :return: str - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.sage_pay_notify_v300_with_http_info(**kwargs) - else: - (data) = self.sage_pay_notify_v300_with_http_info(**kwargs) - return data - - def sage_pay_notify_v300_with_http_info(self, **kwargs): - """ - [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of receiving a callback from a SagePay card capture operation, using SagePay's FORM Protocol, v3.0] Handles SagePay Notification. - {\"nickname\":\"Handle SagePay Notification\",\"response\":\"sagePayNotifyV3_00.html\",\"request\":\"sagePayNotifyV3_00.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.sage_pay_notify_v300_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the queryparameter. Example: ...&organizations=org1&organizations=org2 - :param str bill_forward_url_root: The URL through which BFJS connected to BillForward. - :param str access_token: The public token through which BFJS connected to BillForward. - :param str vps_protocol: - :param str tx_type: - :param str vendor_tx_code: - :param str status: - :param str vps_tx_id: - :param str card_type: - :param str token: - :param str status_detail: - :param str last4_digits: - :param str vps_signature: - :param str expiry_date: - :return: str - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'bill_forward_url_root', 'access_token', 'vps_protocol', 'tx_type', 'vendor_tx_code', 'status', 'vps_tx_id', 'card_type', 'token', 'status_detail', 'last4_digits', 'vps_signature', 'expiry_date'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method sage_pay_notify_v300" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/tokenization/sagepay-notify-v3-00'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'bill_forward_url_root' in params: - query_params['billForwardURLRoot'] = params['bill_forward_url_root'] - if 'access_token' in params: - query_params['access_token'] = params['access_token'] - - header_params = {} - - form_params = [] - local_var_files = {} - if 'vps_protocol' in params: - form_params.append(('VPSProtocol', params['vps_protocol'])) - if 'tx_type' in params: - form_params.append(('TxType', params['tx_type'])) - if 'vendor_tx_code' in params: - form_params.append(('VendorTxCode', params['vendor_tx_code'])) - if 'status' in params: - form_params.append(('Status', params['status'])) - if 'vps_tx_id' in params: - form_params.append(('VPSTxId', params['vps_tx_id'])) - if 'card_type' in params: - form_params.append(('CardType', params['card_type'])) - if 'token' in params: - form_params.append(('Token', params['token'])) - if 'status_detail' in params: - form_params.append(('StatusDetail', params['status_detail'])) - if 'last4_digits' in params: - form_params.append(('Last4Digits', params['last4_digits'])) - if 'vps_signature' in params: - form_params.append(('VPSSignature', params['vps_signature'])) - if 'expiry_date' in params: - form_params.append(('ExpiryDate', params['expiry_date'])) - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/plain']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/x-www-form-urlencoded']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='str', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def sage_pay_shout_v300(self, **kwargs): - """ - [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe, using SagePay's FORM Protocol, v3.0] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. - {\"nickname\":\"Generate SagePay iframe redirect\",\"response\":\"sagePayShoutV3_00.html\",\"request\":\"sagePayShoutV3_00.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.sage_pay_shout_v300(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the queryparameter. Example: ...&organizations=org1&organizations=org2 - :param str s: - :param str t: - :param str c: - :param str e: - :param str l: - :param str d: - :return: str - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.sage_pay_shout_v300_with_http_info(**kwargs) - else: - (data) = self.sage_pay_shout_v300_with_http_info(**kwargs) - return data - - def sage_pay_shout_v300_with_http_info(self, **kwargs): - """ - [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe, using SagePay's FORM Protocol, v3.0] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. - {\"nickname\":\"Generate SagePay iframe redirect\",\"response\":\"sagePayShoutV3_00.html\",\"request\":\"sagePayShoutV3_00.request.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.sage_pay_shout_v300_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the queryparameter. Example: ...&organizations=org1&organizations=org2 - :param str s: - :param str t: - :param str c: - :param str e: - :param str l: - :param str d: - :return: str - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 's', 't', 'c', 'e', 'l', 'd'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method sage_pay_shout_v300" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/tokenization/sagepay-shout-v3-00'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 's' in params: - query_params['s'] = params['s'] - if 't' in params: - query_params['t'] = params['t'] - if 'c' in params: - query_params['c'] = params['c'] - if 'e' in params: - query_params['e'] = params['e'] - if 'l' in params: - query_params['l'] = params['l'] - if 'd' in params: - query_params['d'] = params['d'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/html']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='str', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/unitofmeasure_api.py b/billforward/apis/unitofmeasure_api.py deleted file mode 100644 index 090bb1b..0000000 --- a/billforward/apis/unitofmeasure_api.py +++ /dev/null @@ -1,488 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class UnitofmeasureApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_unit_of_measure(self, unit_of_measure, **kwargs): - """ - Create a unit-of-measure. - {\"nickname\":\"Create a new unit of measure\",\"request\":\"createUnitOfMeasureRequest.html\",\"response\":\"createUnitOfMeasureResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_unit_of_measure(unit_of_measure, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UnitOfMeasure unit_of_measure: The unit-of-measure object to be created. (required) - :return: UnitOfMeasurePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_unit_of_measure_with_http_info(unit_of_measure, **kwargs) - else: - (data) = self.create_unit_of_measure_with_http_info(unit_of_measure, **kwargs) - return data - - def create_unit_of_measure_with_http_info(self, unit_of_measure, **kwargs): - """ - Create a unit-of-measure. - {\"nickname\":\"Create a new unit of measure\",\"request\":\"createUnitOfMeasureRequest.html\",\"response\":\"createUnitOfMeasureResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_unit_of_measure_with_http_info(unit_of_measure, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UnitOfMeasure unit_of_measure: The unit-of-measure object to be created. (required) - :return: UnitOfMeasurePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['unit_of_measure'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_unit_of_measure" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'unit_of_measure' is set - if ('unit_of_measure' not in params) or (params['unit_of_measure'] is None): - raise ValueError("Missing the required parameter `unit_of_measure` when calling `create_unit_of_measure`") - - resource_path = '/units-of-measure'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'unit_of_measure' in params: - body_params = params['unit_of_measure'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UnitOfMeasurePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_units_of_measure(self, **kwargs): - """ - Returns a collection of all unit-of-measure objects. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all units of measure\",\"response\":\"getUnitOfMeasureAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_units_of_measure(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: UnitOfMeasurePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_units_of_measure_with_http_info(**kwargs) - else: - (data) = self.get_all_units_of_measure_with_http_info(**kwargs) - return data - - def get_all_units_of_measure_with_http_info(self, **kwargs): - """ - Returns a collection of all unit-of-measure objects. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all units of measure\",\"response\":\"getUnitOfMeasureAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_units_of_measure_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first taxation-link to return. - :param int records: The maximum number of taxation-links to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: UnitOfMeasurePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_units_of_measure" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/units-of-measure'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UnitOfMeasurePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_unit_of_measure_by_id(self, unit_of_measure_identifier, **kwargs): - """ - Returns a single unit-of-measure corresponding to the unique id or name specified. - {\"nickname\":\"Retrieve an existing unit of measure\",\"response\":\"getUnitOfMeasureByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_unit_of_measure_by_id(unit_of_measure_identifier, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str unit_of_measure_identifier: The unique id or name of the unit-of-measure. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: UnitOfMeasurePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_unit_of_measure_by_id_with_http_info(unit_of_measure_identifier, **kwargs) - else: - (data) = self.get_unit_of_measure_by_id_with_http_info(unit_of_measure_identifier, **kwargs) - return data - - def get_unit_of_measure_by_id_with_http_info(self, unit_of_measure_identifier, **kwargs): - """ - Returns a single unit-of-measure corresponding to the unique id or name specified. - {\"nickname\":\"Retrieve an existing unit of measure\",\"response\":\"getUnitOfMeasureByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_unit_of_measure_by_id_with_http_info(unit_of_measure_identifier, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str unit_of_measure_identifier: The unique id or name of the unit-of-measure. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: UnitOfMeasurePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['unit_of_measure_identifier', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_unit_of_measure_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'unit_of_measure_identifier' is set - if ('unit_of_measure_identifier' not in params) or (params['unit_of_measure_identifier'] is None): - raise ValueError("Missing the required parameter `unit_of_measure_identifier` when calling `get_unit_of_measure_by_id`") - - resource_path = '/units-of-measure/{unit-of-measure-identifier}'.replace('{format}', 'json') - path_params = {} - if 'unit_of_measure_identifier' in params: - path_params['unit-of-measure-identifier'] = params['unit_of_measure_identifier'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UnitOfMeasurePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_unit_of_measure(self, unit_of_measure, **kwargs): - """ - Update a unit-of-measure. - {\"nickname\":\"Update a unit of measure\",\"request\":\"updateUnitOfMeasureRequest.html\",\"response\":\"updateUnitOfMeasureResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_unit_of_measure(unit_of_measure, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UnitOfMeasure unit_of_measure: The unit-of-measure object to be updated. (required) - :return: UnitOfMeasurePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_unit_of_measure_with_http_info(unit_of_measure, **kwargs) - else: - (data) = self.update_unit_of_measure_with_http_info(unit_of_measure, **kwargs) - return data - - def update_unit_of_measure_with_http_info(self, unit_of_measure, **kwargs): - """ - Update a unit-of-measure. - {\"nickname\":\"Update a unit of measure\",\"request\":\"updateUnitOfMeasureRequest.html\",\"response\":\"updateUnitOfMeasureResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_unit_of_measure_with_http_info(unit_of_measure, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UnitOfMeasure unit_of_measure: The unit-of-measure object to be updated. (required) - :return: UnitOfMeasurePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['unit_of_measure'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_unit_of_measure" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'unit_of_measure' is set - if ('unit_of_measure' not in params) or (params['unit_of_measure'] is None): - raise ValueError("Missing the required parameter `unit_of_measure` when calling `update_unit_of_measure`") - - resource_path = '/units-of-measure'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'unit_of_measure' in params: - body_params = params['unit_of_measure'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UnitOfMeasurePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/usage_api.py b/billforward/apis/usage_api.py deleted file mode 100644 index bc4c66f..0000000 --- a/billforward/apis/usage_api.py +++ /dev/null @@ -1,659 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class UsageApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_usage_instance(self, usage, **kwargs): - """ - Add usage - {\"nickname\":\"Add usage\",\"request\":\"createUsageRequest.html\",\"response\":\"createUsageResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_usage_instance(usage, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CompoundUsage usage: An array of The 'Usage' objects to be created. (required) - :return: UsagePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_usage_instance_with_http_info(usage, **kwargs) - else: - (data) = self.create_usage_instance_with_http_info(usage, **kwargs) - return data - - def create_usage_instance_with_http_info(self, usage, **kwargs): - """ - Add usage - {\"nickname\":\"Add usage\",\"request\":\"createUsageRequest.html\",\"response\":\"createUsageResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_usage_instance_with_http_info(usage, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CompoundUsage usage: An array of The 'Usage' objects to be created. (required) - :return: UsagePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['usage'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_usage_instance" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'usage' is set - if ('usage' not in params) or (params['usage'] is None): - raise ValueError("Missing the required parameter `usage` when calling `create_usage_instance`") - - resource_path = '/usage'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'usage' in params: - body_params = params['usage'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsagePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_usage_by_id(self, subscription_id, period_id, **kwargs): - """ - Retrieve by subscription and period - {\"nickname\":\"Retrieve by subscription and period\",\"response\":\"getUsageForPeriod.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_by_id(subscription_id, period_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the usage. (required) - :param int period_id: The periodID of the usage. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsagePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_usage_by_id_with_http_info(subscription_id, period_id, **kwargs) - else: - (data) = self.get_usage_by_id_with_http_info(subscription_id, period_id, **kwargs) - return data - - def get_usage_by_id_with_http_info(self, subscription_id, period_id, **kwargs): - """ - Retrieve by subscription and period - {\"nickname\":\"Retrieve by subscription and period\",\"response\":\"getUsageForPeriod.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_by_id_with_http_info(subscription_id, period_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the usage. (required) - :param int period_id: The periodID of the usage. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsagePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'period_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_usage_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_usage_by_id`") - # verify the required parameter 'period_id' is set - if ('period_id' not in params) or (params['period_id'] is None): - raise ValueError("Missing the required parameter `period_id` when calling `get_usage_by_id`") - - resource_path = '/usage/{subscription-id}/{period-id}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-id'] = params['subscription_id'] - if 'period_id' in params: - path_params['period-id'] = params['period_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsagePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_usage_by_subscription_id(self, subscription_id, **kwargs): - """ - Retrieve by subscription - {\"nickname\":\"Retrieve by subscription\",\"response\":\"getUsage.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_by_subscription_id(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the subscription whose Usage instances you wish to GET. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsagePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_usage_by_subscription_id_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_usage_by_subscription_id_with_http_info(subscription_id, **kwargs) - return data - - def get_usage_by_subscription_id_with_http_info(self, subscription_id, **kwargs): - """ - Retrieve by subscription - {\"nickname\":\"Retrieve by subscription\",\"response\":\"getUsage.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_by_subscription_id_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the subscription whose Usage instances you wish to GET. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsagePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_usage_by_subscription_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_usage_by_subscription_id`") - - resource_path = '/usage/{subscription-id}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-id'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsagePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_usage_by_subscription_id_uo_m_period_and_usage_type(self, subscription_id, uom, period_id, usage_type, **kwargs): - """ - Retrieve by subscription, period and type - {\"nickname\":\"Retrieve by subscription, period and type\",\"response\":\"getDetailedUsageForPeriod.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_by_subscription_id_uo_m_period_and_usage_type(subscription_id, uom, period_id, usage_type, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the usage. (required) - :param str uom: The uom of the usage. (required) - :param int period_id: The periodID of the usage. (required) - :param str usage_type: The type of the usage. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsagePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_usage_by_subscription_id_uo_m_period_and_usage_type_with_http_info(subscription_id, uom, period_id, usage_type, **kwargs) - else: - (data) = self.get_usage_by_subscription_id_uo_m_period_and_usage_type_with_http_info(subscription_id, uom, period_id, usage_type, **kwargs) - return data - - def get_usage_by_subscription_id_uo_m_period_and_usage_type_with_http_info(self, subscription_id, uom, period_id, usage_type, **kwargs): - """ - Retrieve by subscription, period and type - {\"nickname\":\"Retrieve by subscription, period and type\",\"response\":\"getDetailedUsageForPeriod.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_by_subscription_id_uo_m_period_and_usage_type_with_http_info(subscription_id, uom, period_id, usage_type, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the usage. (required) - :param str uom: The uom of the usage. (required) - :param int period_id: The periodID of the usage. (required) - :param str usage_type: The type of the usage. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsagePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'uom', 'period_id', 'usage_type', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_usage_by_subscription_id_uo_m_period_and_usage_type" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_usage_by_subscription_id_uo_m_period_and_usage_type`") - # verify the required parameter 'uom' is set - if ('uom' not in params) or (params['uom'] is None): - raise ValueError("Missing the required parameter `uom` when calling `get_usage_by_subscription_id_uo_m_period_and_usage_type`") - # verify the required parameter 'period_id' is set - if ('period_id' not in params) or (params['period_id'] is None): - raise ValueError("Missing the required parameter `period_id` when calling `get_usage_by_subscription_id_uo_m_period_and_usage_type`") - # verify the required parameter 'usage_type' is set - if ('usage_type' not in params) or (params['usage_type'] is None): - raise ValueError("Missing the required parameter `usage_type` when calling `get_usage_by_subscription_id_uo_m_period_and_usage_type`") - - resource_path = '/usage/{subscription-id}/{uom}/{period-id}/{usage-type}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-id'] = params['subscription_id'] - if 'uom' in params: - path_params['uom'] = params['uom'] - if 'period_id' in params: - path_params['period-id'] = params['period_id'] - if 'usage_type' in params: - path_params['usage-type'] = params['usage_type'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsagePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_usage_instance(self, usage, **kwargs): - """ - Update usage - {\"nickname\":\"Update usage\",\"request\":\"updateUsageRequest.html\",\"response\":\"updateUsageResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_usage_instance(usage, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CompoundUsage usage: An array of The 'Usage' objects to be updated. (required) - :return: UsagePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_usage_instance_with_http_info(usage, **kwargs) - else: - (data) = self.update_usage_instance_with_http_info(usage, **kwargs) - return data - - def update_usage_instance_with_http_info(self, usage, **kwargs): - """ - Update usage - {\"nickname\":\"Update usage\",\"request\":\"updateUsageRequest.html\",\"response\":\"updateUsageResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_usage_instance_with_http_info(usage, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CompoundUsage usage: An array of The 'Usage' objects to be updated. (required) - :return: UsagePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['usage'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_usage_instance" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'usage' is set - if ('usage' not in params) or (params['usage'] is None): - raise ValueError("Missing the required parameter `usage` when calling `update_usage_instance`") - - resource_path = '/usage'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'usage' in params: - body_params = params['usage'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsagePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/usageperiods_api.py b/billforward/apis/usageperiods_api.py deleted file mode 100644 index 080a9c1..0000000 --- a/billforward/apis/usageperiods_api.py +++ /dev/null @@ -1,437 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class UsageperiodsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def get_usage_period(self, subscription_id, period_id, **kwargs): - """ - Retrieve by subscription and period - { \"nickname\" : \"Retrieve by subscription and period\",\"response\" : \"getUsagePeriodsForPeriod.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_period(subscription_id, period_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the usage. (required) - :param int period_id: The periodID of the usage. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsagePeriodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_usage_period_with_http_info(subscription_id, period_id, **kwargs) - else: - (data) = self.get_usage_period_with_http_info(subscription_id, period_id, **kwargs) - return data - - def get_usage_period_with_http_info(self, subscription_id, period_id, **kwargs): - """ - Retrieve by subscription and period - { \"nickname\" : \"Retrieve by subscription and period\",\"response\" : \"getUsagePeriodsForPeriod.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_period_with_http_info(subscription_id, period_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the usage. (required) - :param int period_id: The periodID of the usage. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsagePeriodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'period_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_usage_period" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_usage_period`") - # verify the required parameter 'period_id' is set - if ('period_id' not in params) or (params['period_id'] is None): - raise ValueError("Missing the required parameter `period_id` when calling `get_usage_period`") - - resource_path = '/usage-periods/{subscription-id}/{period-id}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-id'] = params['subscription_id'] - if 'period_id' in params: - path_params['period-id'] = params['period_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsagePeriodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_usage_period_for_all(self, subscription_id, **kwargs): - """ - Retrieve by subscription - { \"nickname\" : \"Retrieve by subscription\",\"response\" : \"getUsagePeriods.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_period_for_all(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the usage. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsagePeriodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_usage_period_for_all_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_usage_period_for_all_with_http_info(subscription_id, **kwargs) - return data - - def get_usage_period_for_all_with_http_info(self, subscription_id, **kwargs): - """ - Retrieve by subscription - { \"nickname\" : \"Retrieve by subscription\",\"response\" : \"getUsagePeriods.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_period_for_all_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the usage. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsagePeriodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_usage_period_for_all" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_usage_period_for_all`") - - resource_path = '/usage-periods/{subscription-id}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-id'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsagePeriodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_usage_period_for_invoice(self, subscription_id, invoice_id, **kwargs): - """ - Retrieve by invoice) - { \"nickname\" : \"Retrieve by invoice\",\"response\" : \"getUsagePeriodForInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_period_for_invoice(subscription_id, invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the usage. (required) - :param str invoice_id: The invoiceID of the usage. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsagePeriodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_usage_period_for_invoice_with_http_info(subscription_id, invoice_id, **kwargs) - else: - (data) = self.get_usage_period_for_invoice_with_http_info(subscription_id, invoice_id, **kwargs) - return data - - def get_usage_period_for_invoice_with_http_info(self, subscription_id, invoice_id, **kwargs): - """ - Retrieve by invoice) - { \"nickname\" : \"Retrieve by invoice\",\"response\" : \"getUsagePeriodForInvoice.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_period_for_invoice_with_http_info(subscription_id, invoice_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the usage. (required) - :param str invoice_id: The invoiceID of the usage. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsagePeriodPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'invoice_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_usage_period_for_invoice" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_usage_period_for_invoice`") - # verify the required parameter 'invoice_id' is set - if ('invoice_id' not in params) or (params['invoice_id'] is None): - raise ValueError("Missing the required parameter `invoice_id` when calling `get_usage_period_for_invoice`") - - resource_path = '/usage-periods/{subscription-id}/invoice/{invoice-id}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-id'] = params['subscription_id'] - if 'invoice_id' in params: - path_params['invoice-id'] = params['invoice_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsagePeriodPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/usageroundingstrategies_api.py b/billforward/apis/usageroundingstrategies_api.py deleted file mode 100644 index dfa3103..0000000 --- a/billforward/apis/usageroundingstrategies_api.py +++ /dev/null @@ -1,515 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class UsageroundingstrategiesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_usage_rounding_strategy(self, usage_rounding_strategy, **kwargs): - """ - Create a new rounding strategy - {\"nickname\":\"Create a new rounding strategy\",\"request\":\"createUsageRoundingStrategiesRequest.html\",\"response\":\"createUsageRoundingStrategiesResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_usage_rounding_strategy(usage_rounding_strategy, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity usage_rounding_strategy: The usage-rounding-strategy object to be created. (required) - :return: UsageRoundingStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_usage_rounding_strategy_with_http_info(usage_rounding_strategy, **kwargs) - else: - (data) = self.create_usage_rounding_strategy_with_http_info(usage_rounding_strategy, **kwargs) - return data - - def create_usage_rounding_strategy_with_http_info(self, usage_rounding_strategy, **kwargs): - """ - Create a new rounding strategy - {\"nickname\":\"Create a new rounding strategy\",\"request\":\"createUsageRoundingStrategiesRequest.html\",\"response\":\"createUsageRoundingStrategiesResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_usage_rounding_strategy_with_http_info(usage_rounding_strategy, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity usage_rounding_strategy: The usage-rounding-strategy object to be created. (required) - :return: UsageRoundingStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['usage_rounding_strategy'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_usage_rounding_strategy" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'usage_rounding_strategy' is set - if ('usage_rounding_strategy' not in params) or (params['usage_rounding_strategy'] is None): - raise ValueError("Missing the required parameter `usage_rounding_strategy` when calling `create_usage_rounding_strategy`") - - resource_path = '/usage-rounding-strategies'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'usage_rounding_strategy' in params: - body_params = params['usage_rounding_strategy'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsageRoundingStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_usage_rounding_strategy_by_id(self, usage_rounding_strategies_id, **kwargs): - """ - Returns a collection of usage-rounding-strategies, specified by the usage-rounding-strategies-id parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve an existing round strategy\",\"response\":\"getUsageRoundingStrategiesByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_rounding_strategy_by_id(usage_rounding_strategies_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str usage_rounding_strategies_id: The string ID of the usage-rounding-strategies. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: UsageRoundingStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_usage_rounding_strategy_by_id_with_http_info(usage_rounding_strategies_id, **kwargs) - else: - (data) = self.get_usage_rounding_strategy_by_id_with_http_info(usage_rounding_strategies_id, **kwargs) - return data - - def get_usage_rounding_strategy_by_id_with_http_info(self, usage_rounding_strategies_id, **kwargs): - """ - Returns a collection of usage-rounding-strategies, specified by the usage-rounding-strategies-id parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve an existing round strategy\",\"response\":\"getUsageRoundingStrategiesByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_rounding_strategy_by_id_with_http_info(usage_rounding_strategies_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str usage_rounding_strategies_id: The string ID of the usage-rounding-strategies. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: UsageRoundingStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['usage_rounding_strategies_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_usage_rounding_strategy_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'usage_rounding_strategies_id' is set - if ('usage_rounding_strategies_id' not in params) or (params['usage_rounding_strategies_id'] is None): - raise ValueError("Missing the required parameter `usage_rounding_strategies_id` when calling `get_usage_rounding_strategy_by_id`") - - resource_path = '/usage-rounding-strategies/{usage-rounding-strategies-ID}'.replace('{format}', 'json') - path_params = {} - if 'usage_rounding_strategies_id' in params: - path_params['usage-rounding-strategies-ID'] = params['usage_rounding_strategies_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsageRoundingStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_usage_rounding_strategy_by_pricing_component_id(self, pricing_component_id, **kwargs): - """ - Returns a collection of usage-rounding-strategies, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by pricing component\",\"response\":\"getUsageRoundingStrategiesByPricingComponent.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_rounding_strategy_by_pricing_component_id(pricing_component_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str pricing_component_id: The string pricing-component-ID of the pricing-component. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: UsageRoundingStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_usage_rounding_strategy_by_pricing_component_id_with_http_info(pricing_component_id, **kwargs) - else: - (data) = self.get_usage_rounding_strategy_by_pricing_component_id_with_http_info(pricing_component_id, **kwargs) - return data - - def get_usage_rounding_strategy_by_pricing_component_id_with_http_info(self, pricing_component_id, **kwargs): - """ - Returns a collection of usage-rounding-strategies, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Retrieve by pricing component\",\"response\":\"getUsageRoundingStrategiesByPricingComponent.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_rounding_strategy_by_pricing_component_id_with_http_info(pricing_component_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str pricing_component_id: The string pricing-component-ID of the pricing-component. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first pricing-component to return. - :param int records: The maximum number of pricing-components to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: UsageRoundingStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['pricing_component_id', 'organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_usage_rounding_strategy_by_pricing_component_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'pricing_component_id' is set - if ('pricing_component_id' not in params) or (params['pricing_component_id'] is None): - raise ValueError("Missing the required parameter `pricing_component_id` when calling `get_usage_rounding_strategy_by_pricing_component_id`") - - resource_path = '/usage-rounding-strategies/pricing-component/{pricing-component-ID}'.replace('{format}', 'json') - path_params = {} - if 'pricing_component_id' in params: - path_params['pricing-component-ID'] = params['pricing_component_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsageRoundingStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_usage_rounding_strategy(self, usage_rounding_strategy, **kwargs): - """ - Update a rounding strategy - {\"nickname\":\"Update a rounding strategy\",\"request\":\"updateUsageRoundingStrategiesRequest.html\",\"response\":\"updateUsageRoundingStrategiesResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_usage_rounding_strategy(usage_rounding_strategy, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity usage_rounding_strategy: The usage-rounding-strategy object to be updated. (required) - :return: UsageRoundingStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_usage_rounding_strategy_with_http_info(usage_rounding_strategy, **kwargs) - else: - (data) = self.update_usage_rounding_strategy_with_http_info(usage_rounding_strategy, **kwargs) - return data - - def update_usage_rounding_strategy_with_http_info(self, usage_rounding_strategy, **kwargs): - """ - Update a rounding strategy - {\"nickname\":\"Update a rounding strategy\",\"request\":\"updateUsageRoundingStrategiesRequest.html\",\"response\":\"updateUsageRoundingStrategiesResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_usage_rounding_strategy_with_http_info(usage_rounding_strategy, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity usage_rounding_strategy: The usage-rounding-strategy object to be updated. (required) - :return: UsageRoundingStrategyPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['usage_rounding_strategy'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_usage_rounding_strategy" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'usage_rounding_strategy' is set - if ('usage_rounding_strategy' not in params) or (params['usage_rounding_strategy'] is None): - raise ValueError("Missing the required parameter `usage_rounding_strategy` when calling `update_usage_rounding_strategy`") - - resource_path = '/usage-rounding-strategies'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'usage_rounding_strategy' in params: - body_params = params['usage_rounding_strategy'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsageRoundingStrategyPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/usagesessions_api.py b/billforward/apis/usagesessions_api.py deleted file mode 100644 index 80d5016..0000000 --- a/billforward/apis/usagesessions_api.py +++ /dev/null @@ -1,507 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class UsagesessionsApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def get_active_sessions_for_subscription(self, subscription_id, **kwargs): - """ - Get active by subscription - {\"nickname\":\"Get active by subscription\",\"response\":\"getActiveSessions.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_active_sessions_for_subscription(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the subscription whose active sessions you wish to GET. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsageSessionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_active_sessions_for_subscription_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_active_sessions_for_subscription_with_http_info(subscription_id, **kwargs) - return data - - def get_active_sessions_for_subscription_with_http_info(self, subscription_id, **kwargs): - """ - Get active by subscription - {\"nickname\":\"Get active by subscription\",\"response\":\"getActiveSessions.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_active_sessions_for_subscription_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the subscription whose active sessions you wish to GET. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsageSessionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_active_sessions_for_subscription" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_active_sessions_for_subscription`") - - resource_path = '/usage-sessions/{subscription-id}/active'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-id'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsageSessionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_usage_list_for_usage_session(self, subscription_id, **kwargs): - """ - Retrieve by subscription - {\"nickname\":\"Retrieve by subscription\",\"response\":\"getAllSessions.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_list_for_usage_session(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the subscription whose sessions you wish to GET. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsageSessionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_usage_list_for_usage_session_with_http_info(subscription_id, **kwargs) - else: - (data) = self.get_usage_list_for_usage_session_with_http_info(subscription_id, **kwargs) - return data - - def get_usage_list_for_usage_session_with_http_info(self, subscription_id, **kwargs): - """ - Retrieve by subscription - {\"nickname\":\"Retrieve by subscription\",\"response\":\"getAllSessions.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_usage_list_for_usage_session_with_http_info(subscription_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str subscription_id: The subscriptionID of the subscription whose sessions you wish to GET. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first amendment to return. - :param int records: The maximum number of amendments to return. - :param str order_by: Specify a field used to order the result set. - :param str order: The direction of any ordering, either ASC or DESC. - :return: UsageSessionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['subscription_id', 'organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_usage_list_for_usage_session" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'subscription_id' is set - if ('subscription_id' not in params) or (params['subscription_id'] is None): - raise ValueError("Missing the required parameter `subscription_id` when calling `get_usage_list_for_usage_session`") - - resource_path = '/usage-sessions/{subscription-id}'.replace('{format}', 'json') - path_params = {} - if 'subscription_id' in params: - path_params['subscription-id'] = params['subscription_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsageSessionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def start_usage_session(self, usage_sessions, **kwargs): - """ - Start a new session - {\"nickname\":\"Start a new session\",\"request\":\"createStartUsageSessionRequest.html\",\"response\":\"createStartUsageSessionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.start_usage_session(usage_sessions, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CompoundUsageSession usage_sessions: An array of 'Usage Session' objects whose sessions you wish to start. (required) - :return: UsageSessionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.start_usage_session_with_http_info(usage_sessions, **kwargs) - else: - (data) = self.start_usage_session_with_http_info(usage_sessions, **kwargs) - return data - - def start_usage_session_with_http_info(self, usage_sessions, **kwargs): - """ - Start a new session - {\"nickname\":\"Start a new session\",\"request\":\"createStartUsageSessionRequest.html\",\"response\":\"createStartUsageSessionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.start_usage_session_with_http_info(usage_sessions, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CompoundUsageSession usage_sessions: An array of 'Usage Session' objects whose sessions you wish to start. (required) - :return: UsageSessionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['usage_sessions'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method start_usage_session" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'usage_sessions' is set - if ('usage_sessions' not in params) or (params['usage_sessions'] is None): - raise ValueError("Missing the required parameter `usage_sessions` when calling `start_usage_session`") - - resource_path = '/usage-sessions/start'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'usage_sessions' in params: - body_params = params['usage_sessions'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsageSessionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def stop_usage_session(self, usage_sessions, **kwargs): - """ - Stop a specified session - {\"nickname\":\"Stop a specified session\",\"request\":\"createStopUsageSessionRequest.html\",\"response\":\"createStopUsageSessionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.stop_usage_session(usage_sessions, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CompoundUsageSession usage_sessions: An array of 'Usage Session' objects whose sessions you wish to stop. (required) - :return: UsageSessionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.stop_usage_session_with_http_info(usage_sessions, **kwargs) - else: - (data) = self.stop_usage_session_with_http_info(usage_sessions, **kwargs) - return data - - def stop_usage_session_with_http_info(self, usage_sessions, **kwargs): - """ - Stop a specified session - {\"nickname\":\"Stop a specified session\",\"request\":\"createStopUsageSessionRequest.html\",\"response\":\"createStopUsageSessionResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.stop_usage_session_with_http_info(usage_sessions, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param CompoundUsageSession usage_sessions: An array of 'Usage Session' objects whose sessions you wish to stop. (required) - :return: UsageSessionPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['usage_sessions'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method stop_usage_session" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'usage_sessions' is set - if ('usage_sessions' not in params) or (params['usage_sessions'] is None): - raise ValueError("Missing the required parameter `usage_sessions` when calling `stop_usage_session`") - - resource_path = '/usage-sessions/stop'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'usage_sessions' in params: - body_params = params['usage_sessions'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsageSessionPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/usernames_api.py b/billforward/apis/usernames_api.py deleted file mode 100644 index 94b45dc..0000000 --- a/billforward/apis/usernames_api.py +++ /dev/null @@ -1,155 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class UsernamesApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_username(self, username, **kwargs): - """ - Create a username. - {\"nickname\":\"Create\",\"request\":\"createUsernameRequest.html\",\"response\":\"createUsernameResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_username(username, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Username username: The username object to be created. (required) - :return: UsernamePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_username_with_http_info(username, **kwargs) - else: - (data) = self.create_username_with_http_info(username, **kwargs) - return data - - def create_username_with_http_info(self, username, **kwargs): - """ - Create a username. - {\"nickname\":\"Create\",\"request\":\"createUsernameRequest.html\",\"response\":\"createUsernameResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_username_with_http_info(username, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Username username: The username object to be created. (required) - :return: UsernamePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['username'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_username" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'username' is set - if ('username' not in params) or (params['username'] is None): - raise ValueError("Missing the required parameter `username` when calling `create_username`") - - resource_path = '/usernames'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'username' in params: - body_params = params['username'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UsernamePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/users_api.py b/billforward/apis/users_api.py deleted file mode 100644 index 1aa3ac0..0000000 --- a/billforward/apis/users_api.py +++ /dev/null @@ -1,1231 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class UsersApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_user(self, user, **kwargs): - """ - Create a user. - {\"nickname\":\"Create a new user\",\"request\":\"createUserRequest.html\",\"response\":\"createUserResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_user(user, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param User user: The user object to be created. (required) - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_user_with_http_info(user, **kwargs) - else: - (data) = self.create_user_with_http_info(user, **kwargs) - return data - - def create_user_with_http_info(self, user, **kwargs): - """ - Create a user. - {\"nickname\":\"Create a new user\",\"request\":\"createUserRequest.html\",\"response\":\"createUserResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_user_with_http_info(user, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param User user: The user object to be created. (required) - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['user'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_user" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'user' is set - if ('user' not in params) or (params['user'] is None): - raise ValueError("Missing the required parameter `user` when calling `create_user`") - - resource_path = '/users'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'user' in params: - body_params = params['user'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UserPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def create_user_login(self, user, **kwargs): - """ - Create a user. - {\"nickname\":\"Create a new user with login\",\"request\":\"createUserWithLoginRequest.html\",\"response\":\"createUserWithLoginResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_user_login(user, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UserCreationRequest user: The user object to be created. (required) - :return: UserCreationResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_user_login_with_http_info(user, **kwargs) - else: - (data) = self.create_user_login_with_http_info(user, **kwargs) - return data - - def create_user_login_with_http_info(self, user, **kwargs): - """ - Create a user. - {\"nickname\":\"Create a new user with login\",\"request\":\"createUserWithLoginRequest.html\",\"response\":\"createUserWithLoginResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_user_login_with_http_info(user, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param UserCreationRequest user: The user object to be created. (required) - :return: UserCreationResponsePagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['user'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_user_login" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'user' is set - if ('user' not in params) or (params['user'] is None): - raise ValueError("Missing the required parameter `user` when calling `create_user_login`") - - resource_path = '/users/create-user-login'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'user' in params: - body_params = params['user'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UserCreationResponsePagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_users(self, **kwargs): - """ - Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Get all users\",\"response\" : \"getUserAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_users(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first user to return. - :param int records: The maximum number of users to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_users_with_http_info(**kwargs) - else: - (data) = self.get_all_users_with_http_info(**kwargs) - return data - - def get_all_users_with_http_info(self, **kwargs): - """ - Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - { \"nickname\" : \"Get all users\",\"response\" : \"getUserAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_users_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first user to return. - :param int records: The maximum number of users to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_users" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/users'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UserPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_user_by_id(self, user_id, **kwargs): - """ - Returns a single User, specified by the ID parameter. - { \"nickname\" : \"Retrieve an existing user\",\"response\" : \"getUserByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_by_id(user_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str user_id: ID of the User. (required) - :param list[str] organizations: A list of organization -IDs used to restrict the scope of API calls. - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_user_by_id_with_http_info(user_id, **kwargs) - else: - (data) = self.get_user_by_id_with_http_info(user_id, **kwargs) - return data - - def get_user_by_id_with_http_info(self, user_id, **kwargs): - """ - Returns a single User, specified by the ID parameter. - { \"nickname\" : \"Retrieve an existing user\",\"response\" : \"getUserByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_by_id_with_http_info(user_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str user_id: ID of the User. (required) - :param list[str] organizations: A list of organization -IDs used to restrict the scope of API calls. - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['user_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_user_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'user_id' is set - if ('user_id' not in params) or (params['user_id'] is None): - raise ValueError("Missing the required parameter `user_id` when calling `get_user_by_id`") - - resource_path = '/users/{user-ID}'.replace('{format}', 'json') - path_params = {} - if 'user_id' in params: - path_params['user-ID'] = params['user_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UserPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_user_by_password_reset_code(self, password_reset_code, **kwargs): - """ - Returns a single User, specified by the password-reset-code parameter. - { \"nickname\" : \"Retrieve by reset code\",\"response\" : \"getUserByPasswordResetCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_by_password_reset_code(password_reset_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str password_reset_code: The unique password reset code of the User. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_user_by_password_reset_code_with_http_info(password_reset_code, **kwargs) - else: - (data) = self.get_user_by_password_reset_code_with_http_info(password_reset_code, **kwargs) - return data - - def get_user_by_password_reset_code_with_http_info(self, password_reset_code, **kwargs): - """ - Returns a single User, specified by the password-reset-code parameter. - { \"nickname\" : \"Retrieve by reset code\",\"response\" : \"getUserByPasswordResetCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_by_password_reset_code_with_http_info(password_reset_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str password_reset_code: The unique password reset code of the User. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['password_reset_code', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_user_by_password_reset_code" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'password_reset_code' is set - if ('password_reset_code' not in params) or (params['password_reset_code'] is None): - raise ValueError("Missing the required parameter `password_reset_code` when calling `get_user_by_password_reset_code`") - - resource_path = '/users/password-reset-code/{password-reset-code}'.replace('{format}', 'json') - path_params = {} - if 'password_reset_code' in params: - path_params['password-reset-code'] = params['password_reset_code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UserPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_user_by_sms_password_reset_code(self, sms_password_reset_code, **kwargs): - """ - Returns a single User, specified by the sms-password-reset-code parameter. - { \"nickname\" : \"Retrieve by sms reset code\",\"response\" : \"getUserBySMSPasswordResetCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_by_sms_password_reset_code(sms_password_reset_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str sms_password_reset_code: The unique SMS password reset code of the User. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_user_by_sms_password_reset_code_with_http_info(sms_password_reset_code, **kwargs) - else: - (data) = self.get_user_by_sms_password_reset_code_with_http_info(sms_password_reset_code, **kwargs) - return data - - def get_user_by_sms_password_reset_code_with_http_info(self, sms_password_reset_code, **kwargs): - """ - Returns a single User, specified by the sms-password-reset-code parameter. - { \"nickname\" : \"Retrieve by sms reset code\",\"response\" : \"getUserBySMSPasswordResetCode.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_by_sms_password_reset_code_with_http_info(sms_password_reset_code, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str sms_password_reset_code: The unique SMS password reset code of the User. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['sms_password_reset_code', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_user_by_sms_password_reset_code" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'sms_password_reset_code' is set - if ('sms_password_reset_code' not in params) or (params['sms_password_reset_code'] is None): - raise ValueError("Missing the required parameter `sms_password_reset_code` when calling `get_user_by_sms_password_reset_code`") - - resource_path = '/users/sms-password-reset-code/{sms-password-reset-code}'.replace('{format}', 'json') - path_params = {} - if 'sms_password_reset_code' in params: - path_params['sms-password-reset-code'] = params['sms_password_reset_code'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UserPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_user_by_username(self, username, **kwargs): - """ - Returns a single User, specified by the username parameter, this is by default the e-mail address of the user. - { \"nickname\" : \"Retrieve by username\",\"response\" : \"getUserByUsername.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_by_username(username, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str username: The unique username of the User. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_user_by_username_with_http_info(username, **kwargs) - else: - (data) = self.get_user_by_username_with_http_info(username, **kwargs) - return data - - def get_user_by_username_with_http_info(self, username, **kwargs): - """ - Returns a single User, specified by the username parameter, this is by default the e-mail address of the user. - { \"nickname\" : \"Retrieve by username\",\"response\" : \"getUserByUsername.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_user_by_username_with_http_info(username, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str username: The unique username of the User. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['username', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_user_by_username" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'username' is set - if ('username' not in params) or (params['username'] is None): - raise ValueError("Missing the required parameter `username` when calling `get_user_by_username`") - - resource_path = '/users/username/{username}'.replace('{format}', 'json') - path_params = {} - if 'username' in params: - path_params['username'] = params['username'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UserPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def reset_user_password(self, request, **kwargs): - """ - Create a password reset request. - {\"nickname\":\"Create a password reset request\",\"request\":\"PasswordResetRequest.html\",\"response\":\"PasswordResetResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.reset_user_password(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PasswordResetRequest request: (required) - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.reset_user_password_with_http_info(request, **kwargs) - else: - (data) = self.reset_user_password_with_http_info(request, **kwargs) - return data - - def reset_user_password_with_http_info(self, request, **kwargs): - """ - Create a password reset request. - {\"nickname\":\"Create a password reset request\",\"request\":\"PasswordResetRequest.html\",\"response\":\"PasswordResetResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.reset_user_password_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param PasswordResetRequest request: (required) - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method reset_user_password" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `reset_user_password`") - - resource_path = '/users/password-reset'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UserPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def retire_user(self, user_id, organizations, **kwargs): - """ - Retires the user with the specified user-ID. - { \"nickname\" : \"Delete a user\",\"response\" : \"deleteUser.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_user(user_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str user_id: ID of the User. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.retire_user_with_http_info(user_id, organizations, **kwargs) - else: - (data) = self.retire_user_with_http_info(user_id, organizations, **kwargs) - return data - - def retire_user_with_http_info(self, user_id, organizations, **kwargs): - """ - Retires the user with the specified user-ID. - { \"nickname\" : \"Delete a user\",\"response\" : \"deleteUser.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_user_with_http_info(user_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str user_id: ID of the User. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['user_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method retire_user" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'user_id' is set - if ('user_id' not in params) or (params['user_id'] is None): - raise ValueError("Missing the required parameter `user_id` when calling `retire_user`") - # verify the required parameter 'organizations' is set - if ('organizations' not in params) or (params['organizations'] is None): - raise ValueError("Missing the required parameter `organizations` when calling `retire_user`") - - resource_path = '/users/{user-ID}'.replace('{format}', 'json') - path_params = {} - if 'user_id' in params: - path_params['user-ID'] = params['user_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UserPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_user(self, user, **kwargs): - """ - Update a user. - { \"nickname\" : \"Update a user\", \"request\" : \"updateUserRequest.html\" ,\"response\" : \"updateUserResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_user(user, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param User user: The user object to be updated. (required) - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_user_with_http_info(user, **kwargs) - else: - (data) = self.update_user_with_http_info(user, **kwargs) - return data - - def update_user_with_http_info(self, user, **kwargs): - """ - Update a user. - { \"nickname\" : \"Update a user\", \"request\" : \"updateUserRequest.html\" ,\"response\" : \"updateUserResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_user_with_http_info(user, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param User user: The user object to be updated. (required) - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['user'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_user" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'user' is set - if ('user' not in params) or (params['user'] is None): - raise ValueError("Missing the required parameter `user` when calling `update_user`") - - resource_path = '/users'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'user' in params: - body_params = params['user'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UserPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_user_password(self, password_reset, **kwargs): - """ - Update a user's password. - { \"nickname\" : \"Update password using reset code\", \"request\" : \"updateUserPassword.html\" ,\"response\" : \"updateUserPasswordResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_user_password(password_reset, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase password_reset: The password reset object. (required) - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_user_password_with_http_info(password_reset, **kwargs) - else: - (data) = self.update_user_password_with_http_info(password_reset, **kwargs) - return data - - def update_user_password_with_http_info(self, password_reset, **kwargs): - """ - Update a user's password. - { \"nickname\" : \"Update password using reset code\", \"request\" : \"updateUserPassword.html\" ,\"response\" : \"updateUserPasswordResponse.html\" } - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_user_password_with_http_info(password_reset, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase password_reset: The password reset object. (required) - :return: UserPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['password_reset'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_user_password" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'password_reset' is set - if ('password_reset' not in params) or (params['password_reset'] is None): - raise ValueError("Missing the required parameter `password_reset` when calling `update_user_password`") - - resource_path = '/users/password-update'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'password_reset' in params: - body_params = params['password_reset'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='UserPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/vaultedgateways_api.py b/billforward/apis/vaultedgateways_api.py deleted file mode 100644 index bb70d81..0000000 --- a/billforward/apis/vaultedgateways_api.py +++ /dev/null @@ -1,1419 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class VaultedgatewaysApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_authorize_net_token(self, authorize_net_token, **kwargs): - """ - Create an authorize-net-token. - {\"nickname\":\"Create a authorize-net-token\",\"request\":\"createAuthorizeNetTokenRequest.html\",\"response\":\"createAuthorizeNetTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_authorize_net_token(authorize_net_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity authorize_net_token: The authorize-net-token object to be created. (required) - :return: AuthorizeNetTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_authorize_net_token_with_http_info(authorize_net_token, **kwargs) - else: - (data) = self.create_authorize_net_token_with_http_info(authorize_net_token, **kwargs) - return data - - def create_authorize_net_token_with_http_info(self, authorize_net_token, **kwargs): - """ - Create an authorize-net-token. - {\"nickname\":\"Create a authorize-net-token\",\"request\":\"createAuthorizeNetTokenRequest.html\",\"response\":\"createAuthorizeNetTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_authorize_net_token_with_http_info(authorize_net_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity authorize_net_token: The authorize-net-token object to be created. (required) - :return: AuthorizeNetTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['authorize_net_token'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_authorize_net_token" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'authorize_net_token' is set - if ('authorize_net_token' not in params) or (params['authorize_net_token'] is None): - raise ValueError("Missing the required parameter `authorize_net_token` when calling `create_authorize_net_token`") - - resource_path = '/vaulted-gateways/authorize-net'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'authorize_net_token' in params: - body_params = params['authorize_net_token'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='AuthorizeNetTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def create_braintree_token(self, braintree_token, **kwargs): - """ - Create a braintree-token. - {\"nickname\":\"Create a braintree-token\",\"request\":\"createBraintreeTokenRequest.html\",\"response\":\"BraintreeTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_braintree_token(braintree_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity braintree_token: The braintree-token object to be created. (required) - :return: BraintreeTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_braintree_token_with_http_info(braintree_token, **kwargs) - else: - (data) = self.create_braintree_token_with_http_info(braintree_token, **kwargs) - return data - - def create_braintree_token_with_http_info(self, braintree_token, **kwargs): - """ - Create a braintree-token. - {\"nickname\":\"Create a braintree-token\",\"request\":\"createBraintreeTokenRequest.html\",\"response\":\"BraintreeTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_braintree_token_with_http_info(braintree_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity braintree_token: The braintree-token object to be created. (required) - :return: BraintreeTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['braintree_token'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_braintree_token" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'braintree_token' is set - if ('braintree_token' not in params) or (params['braintree_token'] is None): - raise ValueError("Missing the required parameter `braintree_token` when calling `create_braintree_token`") - - resource_path = '/vaulted-gateways/braintree'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'braintree_token' in params: - body_params = params['braintree_token'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='BraintreeTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def create_stripe_ach_token(self, stripe_ach_token, **kwargs): - """ - Create a stripe-ACH-token. - {\"nickname\":\"Create a stripe-ACH-token\",\"request\":\"createstripeACHTokenRequest.html\",\"response\":\"createstripeACHTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_stripe_ach_token(stripe_ach_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity stripe_ach_token: The stripe-ACH-token object to be created. (required) - :return: StripeACHTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_stripe_ach_token_with_http_info(stripe_ach_token, **kwargs) - else: - (data) = self.create_stripe_ach_token_with_http_info(stripe_ach_token, **kwargs) - return data - - def create_stripe_ach_token_with_http_info(self, stripe_ach_token, **kwargs): - """ - Create a stripe-ACH-token. - {\"nickname\":\"Create a stripe-ACH-token\",\"request\":\"createstripeACHTokenRequest.html\",\"response\":\"createstripeACHTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_stripe_ach_token_with_http_info(stripe_ach_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity stripe_ach_token: The stripe-ACH-token object to be created. (required) - :return: StripeACHTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['stripe_ach_token'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_stripe_ach_token" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'stripe_ach_token' is set - if ('stripe_ach_token' not in params) or (params['stripe_ach_token'] is None): - raise ValueError("Missing the required parameter `stripe_ach_token` when calling `create_stripe_ach_token`") - - resource_path = '/vaulted-gateways/stripe-ACH'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'stripe_ach_token' in params: - body_params = params['stripe_ach_token'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='StripeACHTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def create_stripe_token(self, stripe_token, **kwargs): - """ - Create a stripe-token. - {\"nickname\":\"Create a stripe-token\",\"request\":\"createstripeTokenRequest.html\",\"response\":\"createstripeTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_stripe_token(stripe_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity stripe_token: The stripe-token object to be created. (required) - :return: StripeTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_stripe_token_with_http_info(stripe_token, **kwargs) - else: - (data) = self.create_stripe_token_with_http_info(stripe_token, **kwargs) - return data - - def create_stripe_token_with_http_info(self, stripe_token, **kwargs): - """ - Create a stripe-token. - {\"nickname\":\"Create a stripe-token\",\"request\":\"createstripeTokenRequest.html\",\"response\":\"createstripeTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_stripe_token_with_http_info(stripe_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity stripe_token: The stripe-token object to be created. (required) - :return: StripeTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['stripe_token'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_stripe_token" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'stripe_token' is set - if ('stripe_token' not in params) or (params['stripe_token'] is None): - raise ValueError("Missing the required parameter `stripe_token` when calling `create_stripe_token`") - - resource_path = '/vaulted-gateways/stripe'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'stripe_token' in params: - body_params = params['stripe_token'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='StripeTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def create_trust_commerce_token(self, trust_commerce_token, **kwargs): - """ - Create a trust-commerce-token. - {\"nickname\":\"Create a trust-commerce-token\",\"request\":\"createTrustCommerceTokenRequest.html\",\"response\":\"TrustCommerceTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_trust_commerce_token(trust_commerce_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity trust_commerce_token: The trust-commerce-token object to be created. (required) - :return: TrustCommerceTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_trust_commerce_token_with_http_info(trust_commerce_token, **kwargs) - else: - (data) = self.create_trust_commerce_token_with_http_info(trust_commerce_token, **kwargs) - return data - - def create_trust_commerce_token_with_http_info(self, trust_commerce_token, **kwargs): - """ - Create a trust-commerce-token. - {\"nickname\":\"Create a trust-commerce-token\",\"request\":\"createTrustCommerceTokenRequest.html\",\"response\":\"TrustCommerceTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_trust_commerce_token_with_http_info(trust_commerce_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity trust_commerce_token: The trust-commerce-token object to be created. (required) - :return: TrustCommerceTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['trust_commerce_token'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_trust_commerce_token" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'trust_commerce_token' is set - if ('trust_commerce_token' not in params) or (params['trust_commerce_token'] is None): - raise ValueError("Missing the required parameter `trust_commerce_token` when calling `create_trust_commerce_token`") - - resource_path = '/vaulted-gateways/trustCommerce'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'trust_commerce_token' in params: - body_params = params['trust_commerce_token'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='TrustCommerceTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_braintree_by_account_id(self, account_id, **kwargs): - """ - Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter. - {\"nickname\":\"Retrieve a list of braintree-token\",\"response\":\"getBraintreeByAccountID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_braintree_by_account_id(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The string ID of the account-ID. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 - :return: BraintreeTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_braintree_by_account_id_with_http_info(account_id, **kwargs) - else: - (data) = self.get_braintree_by_account_id_with_http_info(account_id, **kwargs) - return data - - def get_braintree_by_account_id_with_http_info(self, account_id, **kwargs): - """ - Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter. - {\"nickname\":\"Retrieve a list of braintree-token\",\"response\":\"getBraintreeByAccountID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_braintree_by_account_id_with_http_info(account_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str account_id: The string ID of the account-ID. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 - :return: BraintreeTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['account_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_braintree_by_account_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'account_id' is set - if ('account_id' not in params) or (params['account_id'] is None): - raise ValueError("Missing the required parameter `account_id` when calling `get_braintree_by_account_id`") - - resource_path = '/vaulted-gateways/braintree/{accountID}'.replace('{format}', 'json') - path_params = {} - if 'account_id' in params: - path_params['accountID'] = params['account_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='BraintreeTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_by_card_details_id(self, card_details_id, **kwargs): - """ - Returns a single stripe-token, specified by the cardDetailsID parameter. - {\"nickname\":\"Retrieve a stripe-token by cardDetailsID\",\"response\":\"getStripeTokenByCardDetailsID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_by_card_details_id(card_details_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str card_details_id: The card details id of the stripe-token. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: StripeTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_by_card_details_id_with_http_info(card_details_id, **kwargs) - else: - (data) = self.get_by_card_details_id_with_http_info(card_details_id, **kwargs) - return data - - def get_by_card_details_id_with_http_info(self, card_details_id, **kwargs): - """ - Returns a single stripe-token, specified by the cardDetailsID parameter. - {\"nickname\":\"Retrieve a stripe-token by cardDetailsID\",\"response\":\"getStripeTokenByCardDetailsID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_by_card_details_id_with_http_info(card_details_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str card_details_id: The card details id of the stripe-token. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: StripeTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['card_details_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_by_card_details_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'card_details_id' is set - if ('card_details_id' not in params) or (params['card_details_id'] is None): - raise ValueError("Missing the required parameter `card_details_id` when calling `get_by_card_details_id`") - - resource_path = '/vaulted-gateways/stripe/card-details-id/{cardDetailsID}'.replace('{format}', 'json') - path_params = {} - if 'card_details_id' in params: - path_params['cardDetailsID'] = params['card_details_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='StripeTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_stripe_ach(self, stripe_ach_token_id, **kwargs): - """ - Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter. - {\"nickname\":\"Retrieve a stripe-ACH-token\",\"response\":\"getStripeACHTokenByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_stripe_ach(stripe_ach_token_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str stripe_ach_token_id: The string ID of the stripe-ACH-token. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 - :return: StripeACHTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_stripe_ach_with_http_info(stripe_ach_token_id, **kwargs) - else: - (data) = self.get_stripe_ach_with_http_info(stripe_ach_token_id, **kwargs) - return data - - def get_stripe_ach_with_http_info(self, stripe_ach_token_id, **kwargs): - """ - Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter. - {\"nickname\":\"Retrieve a stripe-ACH-token\",\"response\":\"getStripeACHTokenByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_stripe_ach_with_http_info(stripe_ach_token_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str stripe_ach_token_id: The string ID of the stripe-ACH-token. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 - :return: StripeACHTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['stripe_ach_token_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_stripe_ach" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'stripe_ach_token_id' is set - if ('stripe_ach_token_id' not in params) or (params['stripe_ach_token_id'] is None): - raise ValueError("Missing the required parameter `stripe_ach_token_id` when calling `get_stripe_ach`") - - resource_path = '/vaulted-gateways/stripe-ACH/{stripeACHTokenID}'.replace('{format}', 'json') - path_params = {} - if 'stripe_ach_token_id' in params: - path_params['stripeACHTokenID'] = params['stripe_ach_token_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='StripeACHTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_stripe_token(self, stripe_token_id, **kwargs): - """ - Returns a single stripe-token, specified by the stripeTokenID parameter. - {\"nickname\":\"Retrieve a stripe-token\",\"response\":\"getStripeTokenByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_stripe_token(stripe_token_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str stripe_token_id: The string ID of the stripe-token. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 - :return: StripeTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_stripe_token_with_http_info(stripe_token_id, **kwargs) - else: - (data) = self.get_stripe_token_with_http_info(stripe_token_id, **kwargs) - return data - - def get_stripe_token_with_http_info(self, stripe_token_id, **kwargs): - """ - Returns a single stripe-token, specified by the stripeTokenID parameter. - {\"nickname\":\"Retrieve a stripe-token\",\"response\":\"getStripeTokenByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_stripe_token_with_http_info(stripe_token_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str stripe_token_id: The string ID of the stripe-token. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 - :return: StripeTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['stripe_token_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_stripe_token" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'stripe_token_id' is set - if ('stripe_token_id' not in params) or (params['stripe_token_id'] is None): - raise ValueError("Missing the required parameter `stripe_token_id` when calling `get_stripe_token`") - - resource_path = '/vaulted-gateways/stripe/{stripeTokenID}'.replace('{format}', 'json') - path_params = {} - if 'stripe_token_id' in params: - path_params['stripeTokenID'] = params['stripe_token_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='StripeTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_stripe_ach_token(self, stripe_token, **kwargs): - """ - Update a stripe-ACH-token. - {\"nickname\":\"Update a stripe-ACH-token\",\"request\":\"updatestripeACHTokenRequest.html\",\"response\":\"updatestripeACHTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_stripe_ach_token(stripe_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity stripe_token: The stripe-ACH-token object to be updated. (required) - :return: StripeACHTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_stripe_ach_token_with_http_info(stripe_token, **kwargs) - else: - (data) = self.update_stripe_ach_token_with_http_info(stripe_token, **kwargs) - return data - - def update_stripe_ach_token_with_http_info(self, stripe_token, **kwargs): - """ - Update a stripe-ACH-token. - {\"nickname\":\"Update a stripe-ACH-token\",\"request\":\"updatestripeACHTokenRequest.html\",\"response\":\"updatestripeACHTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_stripe_ach_token_with_http_info(stripe_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity stripe_token: The stripe-ACH-token object to be updated. (required) - :return: StripeACHTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['stripe_token'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_stripe_ach_token" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'stripe_token' is set - if ('stripe_token' not in params) or (params['stripe_token'] is None): - raise ValueError("Missing the required parameter `stripe_token` when calling `update_stripe_ach_token`") - - resource_path = '/vaulted-gateways/stripe-ACH'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'stripe_token' in params: - body_params = params['stripe_token'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='StripeACHTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_stripe_token(self, stripe_token, **kwargs): - """ - Update a stripe-token. - {\"nickname\":\"Update a stripe-token\",\"request\":\"updatestripeTokenRequest.html\",\"response\":\"updatestripeTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_stripe_token(stripe_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity stripe_token: The stripe-token object to be updated. (required) - :return: StripeTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_stripe_token_with_http_info(stripe_token, **kwargs) - else: - (data) = self.update_stripe_token_with_http_info(stripe_token, **kwargs) - return data - - def update_stripe_token_with_http_info(self, stripe_token, **kwargs): - """ - Update a stripe-token. - {\"nickname\":\"Update a stripe-token\",\"request\":\"updatestripeTokenRequest.html\",\"response\":\"updatestripeTokenResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_stripe_token_with_http_info(stripe_token, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity stripe_token: The stripe-token object to be updated. (required) - :return: StripeTokenPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['stripe_token'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_stripe_token" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'stripe_token' is set - if ('stripe_token' not in params) or (params['stripe_token'] is None): - raise ValueError("Missing the required parameter `stripe_token` when calling `update_stripe_token`") - - resource_path = '/vaulted-gateways/stripe'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'stripe_token' in params: - body_params = params['stripe_token'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='StripeTokenPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def verify_bank_account(self, bank_account_verification, **kwargs): - """ - Verify Stripe bank account. - {\"nickname\":\"Verify Stripe bank account\",\"response\":\"verifyStripeBankAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.verify_bank_account(bank_account_verification, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase bank_account_verification: The Bank-Account-Verification object. (required) - :return: BankAccountVerificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.verify_bank_account_with_http_info(bank_account_verification, **kwargs) - else: - (data) = self.verify_bank_account_with_http_info(bank_account_verification, **kwargs) - return data - - def verify_bank_account_with_http_info(self, bank_account_verification, **kwargs): - """ - Verify Stripe bank account. - {\"nickname\":\"Verify Stripe bank account\",\"response\":\"verifyStripeBankAccount.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.verify_bank_account_with_http_info(bank_account_verification, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase bank_account_verification: The Bank-Account-Verification object. (required) - :return: BankAccountVerificationPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['bank_account_verification'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method verify_bank_account" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'bank_account_verification' is set - if ('bank_account_verification' not in params) or (params['bank_account_verification'] is None): - raise ValueError("Missing the required parameter `bank_account_verification` when calling `verify_bank_account`") - - resource_path = '/vaulted-gateways/stripe/verify-bank-account'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'bank_account_verification' in params: - body_params = params['bank_account_verification'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='BankAccountVerificationPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def webhook(self, event, **kwargs): - """ - Receive and handle webhook from Stripe. - {\"nickname\":\"Receive Stripe webhook\",\"response\":\"receiveStripeWebhook.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.webhook(event, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Event event: The event received. (required) - :return: str - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.webhook_with_http_info(event, **kwargs) - else: - (data) = self.webhook_with_http_info(event, **kwargs) - return data - - def webhook_with_http_info(self, event, **kwargs): - """ - Receive and handle webhook from Stripe. - {\"nickname\":\"Receive Stripe webhook\",\"response\":\"receiveStripeWebhook.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.webhook_with_http_info(event, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param Event event: The event received. (required) - :return: str - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['event'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method webhook" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'event' is set - if ('event' not in params) or (params['event'] is None): - raise ValueError("Missing the required parameter `event` when calling `webhook`") - - resource_path = '/vaulted-gateways/stripe/webhook'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'event' in params: - body_params = params['event'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='str', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/apis/webhooks_api.py b/billforward/apis/webhooks_api.py deleted file mode 100644 index 76be934..0000000 --- a/billforward/apis/webhooks_api.py +++ /dev/null @@ -1,811 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import sys -import os -import re - -# python 2 and python 3 compatibility library -from six import iteritems - -from ..configuration import Configuration -from ..api_client import ApiClient - - -class WebhooksApi(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - Ref: https://github.com/swagger-api/swagger-codegen - """ - - def __init__(self, api_client=None): - config = Configuration() - if api_client: - self.api_client = api_client - else: - if not config.api_client: - config.api_client = ApiClient() - self.api_client = config.api_client - - def create_webhook(self, webhook, **kwargs): - """ - Create a webhook. - {\"nickname\":\"Add a new webhook\",\"request\":\"createWebhookRequest.html\",\"response\":\"createWebhookResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_webhook(webhook, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity webhook: The webhook object to be created. (required) - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_webhook_with_http_info(webhook, **kwargs) - else: - (data) = self.create_webhook_with_http_info(webhook, **kwargs) - return data - - def create_webhook_with_http_info(self, webhook, **kwargs): - """ - Create a webhook. - {\"nickname\":\"Add a new webhook\",\"request\":\"createWebhookRequest.html\",\"response\":\"createWebhookResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_webhook_with_http_info(webhook, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity webhook: The webhook object to be created. (required) - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['webhook'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_webhook" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'webhook' is set - if ('webhook' not in params) or (params['webhook'] is None): - raise ValueError("Missing the required parameter `webhook` when calling `create_webhook`") - - resource_path = '/webhooks'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'webhook' in params: - body_params = params['webhook'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='WebhookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def create_webhook_v2(self, request, **kwargs): - """ - Create a webhook. - {\"nickname\":\"Add a new webhook\",\"request\":\"createWebhookRequest.html\",\"response\":\"createWebhookResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_webhook_v2(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: (required) - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.create_webhook_v2_with_http_info(request, **kwargs) - else: - (data) = self.create_webhook_v2_with_http_info(request, **kwargs) - return data - - def create_webhook_v2_with_http_info(self, request, **kwargs): - """ - Create a webhook. - {\"nickname\":\"Add a new webhook\",\"request\":\"createWebhookRequest.html\",\"response\":\"createWebhookResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.create_webhook_v2_with_http_info(request, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param BillingEntityBase request: (required) - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['request'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method create_webhook_v2" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'request' is set - if ('request' not in params) or (params['request'] is None): - raise ValueError("Missing the required parameter `request` when calling `create_webhook_v2`") - - resource_path = '/webhooks/create'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'request' in params: - body_params = params['request'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='WebhookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_all_webhooks(self, **kwargs): - """ - Returns a collection of Webhooks, specified by the accountID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all webhooks\",\"response\":\"getWebhookAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_webhooks(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first webhook to return. - :param int records: The maximum number of webhooks to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_all_webhooks_with_http_info(**kwargs) - else: - (data) = self.get_all_webhooks_with_http_info(**kwargs) - return data - - def get_all_webhooks_with_http_info(self, **kwargs): - """ - Returns a collection of Webhooks, specified by the accountID parameter. By default 10 values are returned. Records are returned in natural order. - {\"nickname\":\"Get all webhooks\",\"response\":\"getWebhookAll.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_all_webhooks_with_http_info(callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :param int offset: The offset from the first webhook to return. - :param int records: The maximum number of webhooks to return. - :param str order_by: Specify a field used to order the result set. - :param str order: Ihe direction of any ordering, either ASC or DESC. - :param bool include_retired: Whether retired products should be returned. - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['organizations', 'offset', 'records', 'order_by', 'order', 'include_retired'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_all_webhooks" % key - ) - params[key] = val - del params['kwargs'] - - resource_path = '/webhooks'.replace('{format}', 'json') - path_params = {} - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - if 'offset' in params: - query_params['offset'] = params['offset'] - if 'records' in params: - query_params['records'] = params['records'] - if 'order_by' in params: - query_params['order_by'] = params['order_by'] - if 'order' in params: - query_params['order'] = params['order'] - if 'include_retired' in params: - query_params['include_retired'] = params['include_retired'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type([]) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='WebhookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def get_webhook_by_id(self, webhook_id, **kwargs): - """ - Returns a single webhook, specified by the webhook-ID parameter. - {\"nickname\":\"Retrieve an existing webhook\",\"response\":\"getWebhookByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_webhook_by_id(webhook_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str webhook_id: ID of the webhook. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.get_webhook_by_id_with_http_info(webhook_id, **kwargs) - else: - (data) = self.get_webhook_by_id_with_http_info(webhook_id, **kwargs) - return data - - def get_webhook_by_id_with_http_info(self, webhook_id, **kwargs): - """ - Returns a single webhook, specified by the webhook-ID parameter. - {\"nickname\":\"Retrieve an existing webhook\",\"response\":\"getWebhookByID.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.get_webhook_by_id_with_http_info(webhook_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str webhook_id: ID of the webhook. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['webhook_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method get_webhook_by_id" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'webhook_id' is set - if ('webhook_id' not in params) or (params['webhook_id'] is None): - raise ValueError("Missing the required parameter `webhook_id` when calling `get_webhook_by_id`") - - resource_path = '/webhooks/{webhook-ID}'.replace('{format}', 'json') - path_params = {} - if 'webhook_id' in params: - path_params['webhook-ID'] = params['webhook_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='WebhookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def retire_webhook(self, webhook_id, organizations, **kwargs): - """ - Retires the specified webhook. - {\"nickname\":\"Remove a webhook\",\"response\":\"deleteWebhook.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_webhook(webhook_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str webhook_id: ID of the webhook. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.retire_webhook_with_http_info(webhook_id, organizations, **kwargs) - else: - (data) = self.retire_webhook_with_http_info(webhook_id, organizations, **kwargs) - return data - - def retire_webhook_with_http_info(self, webhook_id, organizations, **kwargs): - """ - Retires the specified webhook. - {\"nickname\":\"Remove a webhook\",\"response\":\"deleteWebhook.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.retire_webhook_with_http_info(webhook_id, organizations, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str webhook_id: ID of the webhook. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. (required) - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['webhook_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method retire_webhook" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'webhook_id' is set - if ('webhook_id' not in params) or (params['webhook_id'] is None): - raise ValueError("Missing the required parameter `webhook_id` when calling `retire_webhook`") - # verify the required parameter 'organizations' is set - if ('organizations' not in params) or (params['organizations'] is None): - raise ValueError("Missing the required parameter `organizations` when calling `retire_webhook`") - - resource_path = '/webhooks/{webhook-ID}'.replace('{format}', 'json') - path_params = {} - if 'webhook_id' in params: - path_params['webhook-ID'] = params['webhook_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'DELETE', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='WebhookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def update_webhook(self, webhook, **kwargs): - """ - Update a webhook. - {\"nickname\":\"Update a webhook\",\"request\":\"updateWebhookRequest.html\",\"response\":\"updateWebhookResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_webhook(webhook, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity webhook: The webhook object to be updated. (required) - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.update_webhook_with_http_info(webhook, **kwargs) - else: - (data) = self.update_webhook_with_http_info(webhook, **kwargs) - return data - - def update_webhook_with_http_info(self, webhook, **kwargs): - """ - Update a webhook. - {\"nickname\":\"Update a webhook\",\"request\":\"updateWebhookRequest.html\",\"response\":\"updateWebhookResponse.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.update_webhook_with_http_info(webhook, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param MutableBillingEntity webhook: The webhook object to be updated. (required) - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['webhook'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method update_webhook" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'webhook' is set - if ('webhook' not in params) or (params['webhook'] is None): - raise ValueError("Missing the required parameter `webhook` when calling `update_webhook`") - - resource_path = '/webhooks'.replace('{format}', 'json') - path_params = {} - - query_params = {} - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'webhook' in params: - body_params = params['webhook'] - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['text/xml', 'application/xml', 'application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['application/json']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'PUT', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='WebhookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) - - def verify_webhook(self, verification_id, **kwargs): - """ - New webhooks must be verified before use, use the verificationID of the webhook to perform verification. - {\"nickname\":\"Verify a webhook\",\"response\":\"verifyWebhook.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.verify_webhook(verification_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str verification_id: verificationID of the webhook. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('callback'): - return self.verify_webhook_with_http_info(verification_id, **kwargs) - else: - (data) = self.verify_webhook_with_http_info(verification_id, **kwargs) - return data - - def verify_webhook_with_http_info(self, verification_id, **kwargs): - """ - New webhooks must be verified before use, use the verificationID of the webhook to perform verification. - {\"nickname\":\"Verify a webhook\",\"response\":\"verifyWebhook.html\"} - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please define a `callback` function - to be invoked when receiving the response. - >>> def callback_function(response): - >>> pprint(response) - >>> - >>> thread = api.verify_webhook_with_http_info(verification_id, callback=callback_function) - - :param callback function: The callback function - for asynchronous request. (optional) - :param str verification_id: verificationID of the webhook. (required) - :param list[str] organizations: A list of organization-IDs used to restrict the scope of API calls. - :return: WebhookPagedMetadata - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['verification_id', 'organizations'] - all_params.append('callback') - all_params.append('_return_http_data_only') - - params = locals() - for key, val in iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method verify_webhook" % key - ) - params[key] = val - del params['kwargs'] - # verify the required parameter 'verification_id' is set - if ('verification_id' not in params) or (params['verification_id'] is None): - raise ValueError("Missing the required parameter `verification_id` when calling `verify_webhook`") - - resource_path = '/webhooks/verify/{verification-ID}'.replace('{format}', 'json') - path_params = {} - if 'verification_id' in params: - path_params['verification-ID'] = params['verification_id'] - - query_params = {} - if 'organizations' in params: - query_params['organizations'] = params['organizations'] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - - # HTTP header `Accept` - header_params['Accept'] = self.api_client.\ - select_header_accept(['application/json']) - if not header_params['Accept']: - del header_params['Accept'] - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.\ - select_header_content_type(['text/plain']) - - # Authentication setting - auth_settings = [] - - return self.api_client.call_api(resource_path, 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='WebhookPagedMetadata', - auth_settings=auth_settings, - callback=params.get('callback'), - _return_http_data_only=params.get('_return_http_data_only')) diff --git a/billforward/configuration.py b/billforward/configuration.py index 5472998..622b0df 100644 --- a/billforward/configuration.py +++ b/billforward/configuration.py @@ -1,68 +1,52 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import base64 + +import copy +import logging +import multiprocessing +import sys import urllib3 -try: - import httplib -except ImportError: - # for python3 - import http.client as httplib +import six +from six.moves import http_client as httplib -import sys -import logging -from six import iteritems +class TypeWithDefault(type): + def __init__(cls, name, bases, dct): + super(TypeWithDefault, cls).__init__(name, bases, dct) + cls._default = None + def __call__(cls): + if cls._default is None: + cls._default = type.__call__(cls) + return copy.copy(cls._default) -def singleton(cls, *args, **kw): - instances = {} + def set_default(cls, default): + cls._default = copy.copy(default) - def _singleton(): - if cls not in instances: - instances[cls] = cls(*args, **kw) - return instances[cls] - return _singleton +class Configuration(six.with_metaclass(TypeWithDefault, object)): + """NOTE: This class is auto generated by the swagger code generator program. -@singleton -class Configuration(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Ref: https://github.com/swagger-api/swagger-codegen Do not edit the class manually. """ def __init__(self): - """ - Constructor - """ + """Constructor""" # Default Base url - self.host = "https://api-sandbox.billforward.net:443/v1" - # Default api client - self.api_client = None + self.host = "https://app.billforward.net/v1" # Temp file folder for downloading files self.temp_folder_path = None @@ -71,11 +55,12 @@ def __init__(self): self.api_key = {} # dict to store API prefix (e.g. Bearer) self.api_key_prefix = {} + # function to refresh API key if expired + self.refresh_api_key_hook = None # Username for HTTP basic authentication self.username = "" # Password for HTTP basic authentication self.password = "" - # Logging Settings self.logger = {} self.logger["package_logger"] = logging.getLogger("billforward") @@ -92,7 +77,8 @@ def __init__(self): self.debug = False # SSL/TLS verification - # Set this to false to skip verifying SSL certificate when calling API from https server. + # Set this to false to skip verifying SSL certificate when calling API + # from https server. self.verify_ssl = True # Set this to customize the certificate file to verify the peer. self.ssl_ca_cert = None @@ -100,21 +86,39 @@ def __init__(self): self.cert_file = None # client key file self.key_file = None + # Set this to True/False to enable/disable SSL hostname verification. + self.assert_hostname = None + + # urllib3 connection pool's maximum number of connections saved + # per pool. urllib3 uses 1 connection as default value, but this is + # not the best value when you are making a lot of possibly parallel + # requests to the same host, which is often the case here. + # cpu_count * 5 is used as default value to increase performance. + self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 + + # Proxy URL + self.proxy = None + # Safe chars for path_param + self.safe_chars_for_path_param = '' @property def logger_file(self): - """ - Gets the logger_file. + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str """ return self.__logger_file @logger_file.setter def logger_file(self, value): - """ - Sets the logger_file. + """The logger file. - If the logger_file is None, then add stream handler and remove file handler. - Otherwise, add file handler and remove stream handler. + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. :param value: The logger_file path. :type: str @@ -125,7 +129,7 @@ def logger_file(self, value): # then add file handler and remove stream handler. self.logger_file_handler = logging.FileHandler(self.__logger_file) self.logger_file_handler.setFormatter(self.logger_formatter) - for _, logger in iteritems(self.logger): + for _, logger in six.iteritems(self.logger): logger.addHandler(self.logger_file_handler) if self.logger_stream_handler: logger.removeHandler(self.logger_stream_handler) @@ -134,22 +138,23 @@ def logger_file(self, value): # then add stream handler and remove file handler. self.logger_stream_handler = logging.StreamHandler() self.logger_stream_handler.setFormatter(self.logger_formatter) - for _, logger in iteritems(self.logger): + for _, logger in six.iteritems(self.logger): logger.addHandler(self.logger_stream_handler) if self.logger_file_handler: logger.removeHandler(self.logger_file_handler) @property def debug(self): - """ - Gets the debug status. + """Debug status + + :param value: The debug status, True or False. + :type: bool """ return self.__debug @debug.setter def debug(self, value): - """ - Sets the debug status. + """Debug status :param value: The debug status, True or False. :type: bool @@ -157,29 +162,32 @@ def debug(self, value): self.__debug = value if self.__debug: # if debug status is True, turn on debug logging - for _, logger in iteritems(self.logger): + for _, logger in six.iteritems(self.logger): logger.setLevel(logging.DEBUG) # turn on httplib debug httplib.HTTPConnection.debuglevel = 1 else: # if debug status is False, turn off debug logging, # setting log level to default `logging.WARNING` - for _, logger in iteritems(self.logger): + for _, logger in six.iteritems(self.logger): logger.setLevel(logging.WARNING) # turn off httplib debug httplib.HTTPConnection.debuglevel = 0 @property def logger_format(self): - """ - Gets the logger_format. + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str """ return self.__logger_format @logger_format.setter def logger_format(self, value): - """ - Sets the logger_format. + """The logger format. The logger_formatter will be updated when sets logger_format. @@ -190,45 +198,47 @@ def logger_format(self, value): self.logger_formatter = logging.Formatter(self.__logger_format) def get_api_key_with_prefix(self, identifier): - """ - Gets API key (with prefix if set). + """Gets API key (with prefix if set). :param identifier: The identifier of apiKey. :return: The token for api key authentication. """ - if self.api_key.get(identifier) and self.api_key_prefix.get(identifier): - return self.api_key_prefix[identifier] + ' ' + self.api_key[identifier] - elif self.api_key.get(identifier): - return self.api_key[identifier] + if self.refresh_api_key_hook: + self.refresh_api_key_hook(self) + + key = self.api_key.get(identifier) + if key: + prefix = self.api_key_prefix.get(identifier) + if prefix: + return "%s %s" % (prefix, key) + else: + return key def get_basic_auth_token(self): - """ - Gets HTTP basic authentication header (string). + """Gets HTTP basic authentication header (string). :return: The token for basic HTTP authentication. """ - return urllib3.util.make_headers(basic_auth=self.username + ':' + self.password)\ - .get('authorization') + return urllib3.util.make_headers( + basic_auth=self.username + ':' + self.password + ).get('authorization') def auth_settings(self): - """ - Gets Auth Settings dict for api client. + """Gets Auth Settings dict for api client. :return: The Auth Settings information dict. """ return { - } def to_debug_report(self): - """ - Gets the essential information for debugging. + """Gets the essential information for debugging. :return: The report for debugging. """ return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: 1.0.0\n"\ + "Version of the API: 1.0\n"\ "SDK Package Version: 1.0.0".\ format(env=sys.platform, pyversion=sys.version) diff --git a/billforward/models/__init__.py b/billforward/models/__init__.py index eaf07d0..922046a 100644 --- a/billforward/models/__init__.py +++ b/billforward/models/__init__.py @@ -1,253 +1,482 @@ # coding: utf-8 +# flake8: noqa """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import # import models into model package -from .api_configuration_paged_metadata import APIConfigurationPagedMetadata -from .api_quote import APIQuote -from .api_quote_paged_metadata import APIQuotePagedMetadata -from .api_quote_response_quantity import APIQuoteResponseQuantity -from .account import Account -from .account_ltv_result_paged_metadata import AccountLTVResultPagedMetadata -from .account_paged_metadata import AccountPagedMetadata -from .account_payments_result_paged_metadata import AccountPaymentsResultPagedMetadata -from .add_charge_request import AddChargeRequest -from .add_coupon_code_request import AddCouponCodeRequest -from .add_payment_method_request import AddPaymentMethodRequest -from .add_taxation_strategy_request import AddTaxationStrategyRequest -from .address import Address -from .address_paged_metadata import AddressPagedMetadata -from .aggregating_component import AggregatingComponent -from .alias import Alias -from .amendment import Amendment -from .amendment_discard_amendment import AmendmentDiscardAmendment -from .amendment_paged_metadata import AmendmentPagedMetadata -from .amendment_price_n_time_paged_metadata import AmendmentPriceNTimePagedMetadata -from .audit_entry import AuditEntry -from .audit_entry_paged_metadata import AuditEntryPagedMetadata -from .auth_capture_request import AuthCaptureRequest -from .authorize_net_token_paged_metadata import AuthorizeNetTokenPagedMetadata -from .bf_error import BFError -from .bf_permission import BFPermission -from .bf_permission_paged_metadata import BFPermissionPagedMetadata -from .bank_account_verification_paged_metadata import BankAccountVerificationPagedMetadata -from .billforward_managed_payments_result_paged_metadata import BillforwardManagedPaymentsResultPagedMetadata -from .billing_entity_base import BillingEntityBase -from .braintree_auth_capture_request import BraintreeAuthCaptureRequest -from .braintree_capture_request import BraintreeCaptureRequest -from .braintree_token_paged_metadata import BraintreeTokenPagedMetadata -from .cancel_subscription_request import CancelSubscriptionRequest -from .cancellation_amendment import CancellationAmendment -from .cass_churn_result_paged_metadata import CassChurnResultPagedMetadata -from .cass_payment_result_paged_metadata import CassPaymentResultPagedMetadata -from .cass_upgrade_result_paged_metadata import CassUpgradeResultPagedMetadata -from .client import Client -from .client_paged_metadata import ClientPagedMetadata -from .component_change import ComponentChange -from .component_cost import ComponentCost -from .compound_usage import CompoundUsage -from .compound_usage_session import CompoundUsageSession -from .coupon import Coupon -from .coupon_book import CouponBook -from .coupon_book_definition import CouponBookDefinition -from .coupon_book_definition_paged_metadata import CouponBookDefinitionPagedMetadata -from .coupon_book_paged_metadata import CouponBookPagedMetadata -from .coupon_definition import CouponDefinition -from .coupon_definition_paged_metadata import CouponDefinitionPagedMetadata -from .coupon_discount import CouponDiscount -from .coupon_discount_estimate import CouponDiscountEstimate -from .coupon_instance import CouponInstance -from .coupon_instance_existing_value import CouponInstanceExistingValue -from .coupon_instance_paged_metadata import CouponInstancePagedMetadata -from .coupon_modifier_base import CouponModifierBase -from .coupon_modifier_base_paged_metadata import CouponModifierBasePagedMetadata -from .coupon_paged_metadata import CouponPagedMetadata -from .coupon_rule import CouponRule -from .coupon_rule_paged_metadata import CouponRulePagedMetadata -from .coupon_unique_codes_request import CouponUniqueCodesRequest -from .coupon_unique_codes_response import CouponUniqueCodesResponse -from .coupon_unique_codes_response_paged_metadata import CouponUniqueCodesResponsePagedMetadata -from .coupon_wrapper_response import CouponWrapperResponse -from .create_account_profile_request import CreateAccountProfileRequest -from .create_account_request import CreateAccountRequest -from .create_address_request import CreateAddressRequest -from .create_aggregating_component_request import CreateAggregatingComponentRequest -from .create_aggregating_subscription_request import CreateAggregatingSubscriptionRequest -from .create_profile_address_request import CreateProfileAddressRequest -from .create_subscription_batch_request import CreateSubscriptionBatchRequest -from .create_subscription_charge_amendment import CreateSubscriptionChargeAmendment -from .create_subscription_request import CreateSubscriptionRequest -from .credit_account_request import CreditAccountRequest -from .credit_note import CreditNote -from .credit_note_paged_metadata import CreditNotePagedMetadata -from .credit_subscription_request import CreditSubscriptionRequest -from .cybersource_token_paged_metadata import CybersourceTokenPagedMetadata -from .data_synchronisation_app_configuration_paged_metadata import DataSynchronisationAppConfigurationPagedMetadata -from .data_synchronisation_configuration import DataSynchronisationConfiguration -from .data_synchronisation_configuration_paged_metadata import DataSynchronisationConfigurationPagedMetadata -from .data_synchronization_job_paged_metadata import DataSynchronizationJobPagedMetadata -from .debts_result_paged_metadata import DebtsResultPagedMetadata -from .dunning_line import DunningLine -from .dunning_line_paged_metadata import DunningLinePagedMetadata -from .dynamic_metadata import DynamicMetadata -from .email import Email -from .email_paged_metadata import EmailPagedMetadata -from .email_provider import EmailProvider -from .email_provider_paged_metadata import EmailProviderPagedMetadata -from .email_subscription import EmailSubscription -from .email_subscription_paged_metadata import EmailSubscriptionPagedMetadata -from .end_trial_amendment import EndTrialAmendment -from .event import Event -from .event_data import EventData -from .file_sham import FileSham -from .fixed_term import FixedTerm -from .fixed_term_definition_paged_metadata import FixedTermDefinitionPagedMetadata -from .fixed_term_expiry_amendment import FixedTermExpiryAmendment -from .fixed_term_paged_metadata import FixedTermPagedMetadata -from .flat_pricing_component import FlatPricingComponent -from .import_invoice_line import ImportInvoiceLine -from .insertable_billing_entity import InsertableBillingEntity -from .invoice import Invoice -from .invoice_charge_request import InvoiceChargeRequest -from .invoice_line import InvoiceLine -from .invoice_line_payment import InvoiceLinePayment -from .invoice_line_payment_paged_metadata import InvoiceLinePaymentPagedMetadata -from .invoice_next_execution_attempt_amendment import InvoiceNextExecutionAttemptAmendment -from .invoice_outstanding_charges_amendment import InvoiceOutstandingChargesAmendment -from .invoice_paged_metadata import InvoicePagedMetadata -from .invoice_payment import InvoicePayment -from .invoice_recalculation_amendment import InvoiceRecalculationAmendment -from .invoice_recalculation_request import InvoiceRecalculationRequest -from .issue_invoice_amendment import IssueInvoiceAmendment -from .metadata_key_values_paged_metadata import MetadataKeyValuesPagedMetadata -from .migration_request import MigrationRequest -from .mutable_billing_entity import MutableBillingEntity -from .notification import Notification -from .notification_paged_metadata import NotificationPagedMetadata -from .organization import Organization -from .organization_paged_metadata import OrganizationPagedMetadata -from .password import Password -from .password_paged_metadata import PasswordPagedMetadata -from .password_reset_request import PasswordResetRequest -from .pause_request import PauseRequest -from .payment import Payment -from .payment_method import PaymentMethod -from .payment_method_paged_metadata import PaymentMethodPagedMetadata -from .payment_method_subscription_link import PaymentMethodSubscriptionLink -from .payment_method_subscription_link_paged_metadata import PaymentMethodSubscriptionLinkPagedMetadata -from .payment_paged_metadata import PaymentPagedMetadata -from .payment_retry_request import PaymentRetryRequest -from .pending_component_value_change import PendingComponentValueChange -from .period import Period -from .period_paged_metadata import PeriodPagedMetadata -from .permission_action_entity_paged_metadata import PermissionActionEntityPagedMetadata -from .permission_resource_entity_paged_metadata import PermissionResourceEntityPagedMetadata -from .price_calculation_paged_metadata import PriceCalculationPagedMetadata -from .pricing_component import PricingComponent -from .pricing_component_coupon_modifier import PricingComponentCouponModifier -from .pricing_component_migration_value import PricingComponentMigrationValue -from .pricing_component_paged_metadata import PricingComponentPagedMetadata -from .pricing_component_quantity_request import PricingComponentQuantityRequest -from .pricing_component_tier import PricingComponentTier -from .pricing_component_tier_paged_metadata import PricingComponentTierPagedMetadata -from .pricing_component_value import PricingComponentValue -from .pricing_component_value_change_amendment import PricingComponentValueChangeAmendment -from .pricing_component_value_change_paged_metadata import PricingComponentValueChangePagedMetadata -from .pricing_component_value_migration_amendment_mapping import PricingComponentValueMigrationAmendmentMapping -from .pricing_component_value_paged_metadata import PricingComponentValuePagedMetadata -from .pricing_component_value_request import PricingComponentValueRequest -from .pricing_component_value_response_paged_metadata import PricingComponentValueResponsePagedMetadata -from .product import Product -from .product_coupon_modifier import ProductCouponModifier -from .product_paged_metadata import ProductPagedMetadata -from .product_payments_result_paged_metadata import ProductPaymentsResultPagedMetadata -from .product_rate_plan import ProductRatePlan -from .product_rate_plan_migration_amendment import ProductRatePlanMigrationAmendment -from .product_rate_plan_paged_metadata import ProductRatePlanPagedMetadata -from .product_rate_plan_payments_result_paged_metadata import ProductRatePlanPaymentsResultPagedMetadata -from .profile import Profile -from .profile_paged_metadata import ProfilePagedMetadata -from .quote_request import QuoteRequest -from .quote_request_value import QuoteRequestValue -from .recalculate_charge_request import RecalculateChargeRequest -from .receipt import Receipt -from .receipt_paged_metadata import ReceiptPagedMetadata -from .refund import Refund -from .refund_paged_metadata import RefundPagedMetadata -from .resume_request import ResumeRequest -from .resume_subscription_amendment import ResumeSubscriptionAmendment -from .revenue_attribution import RevenueAttribution -from .revenue_attribution_paged_metadata import RevenueAttributionPagedMetadata -from .revive_subscription_request import ReviveSubscriptionRequest -from .role import Role -from .role_paged_metadata import RolePagedMetadata -from .rule_satisfaction import RuleSatisfaction -from .search_result_paged_metadata import SearchResultPagedMetadata -from .service_end_amendment import ServiceEndAmendment -from .stripe_ach_token_paged_metadata import StripeACHTokenPagedMetadata -from .stripe_auth_capture_request import StripeAuthCaptureRequest -from .stripe_object import StripeObject -from .stripe_token_paged_metadata import StripeTokenPagedMetadata -from .subscription import Subscription -from .subscription_cancellation_paged_metadata import SubscriptionCancellationPagedMetadata -from .subscription_charge import SubscriptionCharge -from .subscription_charge_paged_metadata import SubscriptionChargePagedMetadata -from .subscription_ltv_result_paged_metadata import SubscriptionLTVResultPagedMetadata -from .subscription_paged_metadata import SubscriptionPagedMetadata -from .swagger_type_list import SwaggerTypeList -from .swagger_type_list_inv import SwaggerTypeListInv -from .swagger_type_list_subs import SwaggerTypeListSubs -from .taxation_link_paged_metadata import TaxationLinkPagedMetadata -from .taxation_strategy_paged_metadata import TaxationStrategyPagedMetadata -from .tiered_pricing_component import TieredPricingComponent -from .tiered_volume_pricing_component import TieredVolumePricingComponent -from .time_request import TimeRequest -from .time_response import TimeResponse -from .time_response_paged_metadata import TimeResponsePagedMetadata -from .time_zone import TimeZone -from .timer_amendment import TimerAmendment -from .tokenization_pre_auth_paged_metadata import TokenizationPreAuthPagedMetadata -from .trust_commerce_token_paged_metadata import TrustCommerceTokenPagedMetadata -from .unit_discount import UnitDiscount -from .unit_of_measure import UnitOfMeasure -from .unit_of_measure_coupon_modifier import UnitOfMeasureCouponModifier -from .unit_of_measure_paged_metadata import UnitOfMeasurePagedMetadata -from .update_address_request import UpdateAddressRequest -from .update_component_value_amendment import UpdateComponentValueAmendment -from .update_profile_request import UpdateProfileRequest -from .update_role_request import UpdateRoleRequest -from .update_subscription_request import UpdateSubscriptionRequest -from .usage import Usage -from .usage_paged_metadata import UsagePagedMetadata -from .usage_period_paged_metadata import UsagePeriodPagedMetadata -from .usage_rounding_strategy_paged_metadata import UsageRoundingStrategyPagedMetadata -from .usage_session import UsageSession -from .usage_session_paged_metadata import UsageSessionPagedMetadata -from .user import User -from .user_creation_request import UserCreationRequest -from .user_creation_response_paged_metadata import UserCreationResponsePagedMetadata -from .user_paged_metadata import UserPagedMetadata -from .username import Username -from .username_paged_metadata import UsernamePagedMetadata -from .webhook_paged_metadata import WebhookPagedMetadata +from billforward.models.api_configuration import APIConfiguration +from billforward.models.api_quote_response_quantity import APIQuoteResponseQuantity +from billforward.models.account import Account +from billforward.models.add_charge_request import AddChargeRequest +from billforward.models.add_charge_response import AddChargeResponse +from billforward.models.add_charge_to_account_response import AddChargeToAccountResponse +from billforward.models.add_charges_to_account_api_request import AddChargesToAccountAPIRequest +from billforward.models.add_contract_period_request import AddContractPeriodRequest +from billforward.models.add_coupon_code_request import AddCouponCodeRequest +from billforward.models.add_payment_method_request import AddPaymentMethodRequest +from billforward.models.additional_data import AdditionalData +from billforward.models.address import Address +from billforward.models.advance_pricing_components_by_charge_model import AdvancePricingComponentsByChargeModel +from billforward.models.affiliate import Affiliate +from billforward.models.affiliate_commission_charge import AffiliateCommissionCharge +from billforward.models.affiliate_rate_plan_relationships import AffiliateRatePlanRelationships +from billforward.models.affiliate_subscription_relationship import AffiliateSubscriptionRelationship +from billforward.models.aggregating_component_description import AggregatingComponentDescription +from billforward.models.allowed_webhook_subscription_values import AllowedWebhookSubscriptionValues +from billforward.models.amendment import Amendment +from billforward.models.amendment_discard_amendment import AmendmentDiscardAmendment +from billforward.models.api_quote import ApiQuote +from billforward.models.arrears_charge import ArrearsCharge +from billforward.models.arrears_pricing_components_by_charge_model import ArrearsPricingComponentsByChargeModel +from billforward.models.auth_capture_request import AuthCaptureRequest +from billforward.models.authorize_net_configuration import AuthorizeNetConfiguration +from billforward.models.authorize_net_payment import AuthorizeNetPayment +from billforward.models.authorize_net_token import AuthorizeNetToken +from billforward.models.avatax_config_request import AvataxConfigRequest +from billforward.models.avatax_configuration import AvataxConfiguration +from billforward.models.avatax_ping_request import AvataxPingRequest +from billforward.models.avatax_ping_response import AvataxPingResponse +from billforward.models.bf_permission import BFPermission +from billforward.models.bank_account import BankAccount +from billforward.models.batch_increment_values_request import BatchIncrementValuesRequest +from billforward.models.batch_update_pricing_component_values_request import BatchUpdatePricingComponentValuesRequest +from billforward.models.billing_entity_base import BillingEntityBase +from billforward.models.braintree_auth_capture_request import BraintreeAuthCaptureRequest +from billforward.models.braintree_capture_request import BraintreeCaptureRequest +from billforward.models.braintree_configuration import BraintreeConfiguration +from billforward.models.braintree_merchant_account import BraintreeMerchantAccount +from billforward.models.braintree_payment import BraintreePayment +from billforward.models.braintree_pre_auth_request import BraintreePreAuthRequest +from billforward.models.braintree_token import BraintreeToken +from billforward.models.calculator_result import CalculatorResult +from billforward.models.cancellation_amendment import CancellationAmendment +from billforward.models.card_connect_auth_capture_request import CardConnectAuthCaptureRequest +from billforward.models.card_connect_configuration import CardConnectConfiguration +from billforward.models.card_connect_gateway_request import CardConnectGatewayRequest +from billforward.models.card_connect_payment import CardConnectPayment +from billforward.models.commission_structure import CommissionStructure +from billforward.models.component_change import ComponentChange +from billforward.models.contract import Contract +from billforward.models.contract_period import ContractPeriod +from billforward.models.coupon import Coupon +from billforward.models.coupon_charge import CouponCharge +from billforward.models.coupon_code_response import CouponCodeResponse +from billforward.models.coupon_discount import CouponDiscount +from billforward.models.coupon_instance import CouponInstance +from billforward.models.coupon_instance_existing_value import CouponInstanceExistingValue +from billforward.models.coupon_payment import CouponPayment +from billforward.models.coupon_unique_codes_request import CouponUniqueCodesRequest +from billforward.models.coupon_unique_codes_response import CouponUniqueCodesResponse +from billforward.models.coupon_wrapper_response import CouponWrapperResponse +from billforward.models.create_aggregating_component_request import CreateAggregatingComponentRequest +from billforward.models.create_aggregating_subscription_request import CreateAggregatingSubscriptionRequest +from billforward.models.create_commission_invoice_request import CreateCommissionInvoiceRequest +from billforward.models.create_contract_period_request import CreateContractPeriodRequest +from billforward.models.create_contract_request import CreateContractRequest +from billforward.models.create_coupon_discount_request import CreateCouponDiscountRequest +from billforward.models.create_coupon_request import CreateCouponRequest +from billforward.models.create_offline_payment_request import CreateOfflinePaymentRequest +from billforward.models.create_permission_on_role_request import CreatePermissionOnRoleRequest +from billforward.models.create_permission_request import CreatePermissionRequest +from billforward.models.create_pricing_component_quantity_request import CreatePricingComponentQuantityRequest +from billforward.models.create_profile_request import CreateProfileRequest +from billforward.models.create_role_request import CreateRoleRequest +from billforward.models.create_salesforce_configuration_request import CreateSalesforceConfigurationRequest +from billforward.models.create_subscription_batch_request import CreateSubscriptionBatchRequest +from billforward.models.create_subscription_charge_amendment import CreateSubscriptionChargeAmendment +from billforward.models.create_subscription_checkout_definition_request import CreateSubscriptionCheckoutDefinitionRequest +from billforward.models.create_subscription_request import CreateSubscriptionRequest +from billforward.models.create_subscription_timer_request import CreateSubscriptionTimerRequest +from billforward.models.create_totp_request import CreateTOTPRequest +from billforward.models.credit_account_request import CreditAccountRequest +from billforward.models.credit_note import CreditNote +from billforward.models.credit_note_currency import CreditNoteCurrency +from billforward.models.credit_note_payment import CreditNotePayment +from billforward.models.credit_subscription_request import CreditSubscriptionRequest +from billforward.models.cybersource_configuration import CybersourceConfiguration +from billforward.models.cybersource_payment import CybersourcePayment +from billforward.models.data_sync_job_error_response import DataSyncJobErrorResponse +from billforward.models.data_sync_job_response import DataSyncJobResponse +from billforward.models.dunning_line import DunningLine +from billforward.models.ebanx_auth_capture_request import EBANXAuthCaptureRequest +from billforward.models.ebanx_configuration import EBANXConfiguration +from billforward.models.ebanx_gateway_request import EBANXGatewayRequest +from billforward.models.ebanx_payment import EBANXPayment +from billforward.models.ebanx_webhook import EBANXWebhook +from billforward.models.email_tokenization import EmailTokenization +from billforward.models.email_tokenization_create_api_request import EmailTokenizationCreateAPIRequest +from billforward.models.email_tokenization_send_api_request import EmailTokenizationSendAPIRequest +from billforward.models.email_tokenization_update_api_request import EmailTokenizationUpdateAPIRequest +from billforward.models.end_trial_amendment import EndTrialAmendment +from billforward.models.epx_capture_request import EpxCaptureRequest +from billforward.models.epx_configuration import EpxConfiguration +from billforward.models.epx_payment import EpxPayment +from billforward.models.epx_pre_auth_request import EpxPreAuthRequest +from billforward.models.epx_pre_auth_response import EpxPreAuthResponse +from billforward.models.execution_receipt_response import ExecutionReceiptResponse +from billforward.models.execution_response import ExecutionResponse +from billforward.models.extras import Extras +from billforward.models.fixed_term import FixedTerm +from billforward.models.fixed_term_definition import FixedTermDefinition +from billforward.models.fixed_term_expiry_amendment import FixedTermExpiryAmendment +from billforward.models.flat_advance_pricing_component import FlatAdvancePricingComponent +from billforward.models.flat_arrears_pricing_component import FlatArrearsPricingComponent +from billforward.models.flat_pricing_component import FlatPricingComponent +from billforward.models.flat_setup_pricing_component import FlatSetupPricingComponent +from billforward.models.flat_usage_pricing_component import FlatUsagePricingComponent +from billforward.models.get_rate_plan_affiliate_response import GetRatePlanAffiliateResponse +from billforward.models.get_subscription_affiliate_response import GetSubscriptionAffiliateResponse +from billforward.models.go_cardless_configuration import GoCardlessConfiguration +from billforward.models.go_cardless_tokenization_request import GoCardlessTokenizationRequest +from billforward.models.halt_aggregation_request import HaltAggregationRequest +from billforward.models.halt_aggregation_response import HaltAggregationResponse +from billforward.models.hosted_payment import HostedPayment +from billforward.models.hosted_payment_config import HostedPaymentConfig +from billforward.models.i_discardable import IDiscardable +from billforward.models.import_invoice_line import ImportInvoiceLine +from billforward.models.import_invoice_request import ImportInvoiceRequest +from billforward.models.import_subscription_request import ImportSubscriptionRequest +from billforward.models.inline_response_default import InlineResponseDefault +from billforward.models.inline_response_default1 import InlineResponseDefault1 +from billforward.models.inline_response_default10 import InlineResponseDefault10 +from billforward.models.inline_response_default100 import InlineResponseDefault100 +from billforward.models.inline_response_default101 import InlineResponseDefault101 +from billforward.models.inline_response_default102 import InlineResponseDefault102 +from billforward.models.inline_response_default103 import InlineResponseDefault103 +from billforward.models.inline_response_default11 import InlineResponseDefault11 +from billforward.models.inline_response_default12 import InlineResponseDefault12 +from billforward.models.inline_response_default13 import InlineResponseDefault13 +from billforward.models.inline_response_default14 import InlineResponseDefault14 +from billforward.models.inline_response_default15 import InlineResponseDefault15 +from billforward.models.inline_response_default16 import InlineResponseDefault16 +from billforward.models.inline_response_default17 import InlineResponseDefault17 +from billforward.models.inline_response_default18 import InlineResponseDefault18 +from billforward.models.inline_response_default19 import InlineResponseDefault19 +from billforward.models.inline_response_default2 import InlineResponseDefault2 +from billforward.models.inline_response_default20 import InlineResponseDefault20 +from billforward.models.inline_response_default21 import InlineResponseDefault21 +from billforward.models.inline_response_default22 import InlineResponseDefault22 +from billforward.models.inline_response_default23 import InlineResponseDefault23 +from billforward.models.inline_response_default24 import InlineResponseDefault24 +from billforward.models.inline_response_default25 import InlineResponseDefault25 +from billforward.models.inline_response_default26 import InlineResponseDefault26 +from billforward.models.inline_response_default27 import InlineResponseDefault27 +from billforward.models.inline_response_default28 import InlineResponseDefault28 +from billforward.models.inline_response_default29 import InlineResponseDefault29 +from billforward.models.inline_response_default3 import InlineResponseDefault3 +from billforward.models.inline_response_default30 import InlineResponseDefault30 +from billforward.models.inline_response_default31 import InlineResponseDefault31 +from billforward.models.inline_response_default32 import InlineResponseDefault32 +from billforward.models.inline_response_default33 import InlineResponseDefault33 +from billforward.models.inline_response_default34 import InlineResponseDefault34 +from billforward.models.inline_response_default35 import InlineResponseDefault35 +from billforward.models.inline_response_default36 import InlineResponseDefault36 +from billforward.models.inline_response_default37 import InlineResponseDefault37 +from billforward.models.inline_response_default38 import InlineResponseDefault38 +from billforward.models.inline_response_default39 import InlineResponseDefault39 +from billforward.models.inline_response_default4 import InlineResponseDefault4 +from billforward.models.inline_response_default40 import InlineResponseDefault40 +from billforward.models.inline_response_default41 import InlineResponseDefault41 +from billforward.models.inline_response_default42 import InlineResponseDefault42 +from billforward.models.inline_response_default43 import InlineResponseDefault43 +from billforward.models.inline_response_default44 import InlineResponseDefault44 +from billforward.models.inline_response_default45 import InlineResponseDefault45 +from billforward.models.inline_response_default46 import InlineResponseDefault46 +from billforward.models.inline_response_default47 import InlineResponseDefault47 +from billforward.models.inline_response_default48 import InlineResponseDefault48 +from billforward.models.inline_response_default49 import InlineResponseDefault49 +from billforward.models.inline_response_default5 import InlineResponseDefault5 +from billforward.models.inline_response_default50 import InlineResponseDefault50 +from billforward.models.inline_response_default51 import InlineResponseDefault51 +from billforward.models.inline_response_default52 import InlineResponseDefault52 +from billforward.models.inline_response_default53 import InlineResponseDefault53 +from billforward.models.inline_response_default54 import InlineResponseDefault54 +from billforward.models.inline_response_default55 import InlineResponseDefault55 +from billforward.models.inline_response_default56 import InlineResponseDefault56 +from billforward.models.inline_response_default57 import InlineResponseDefault57 +from billforward.models.inline_response_default58 import InlineResponseDefault58 +from billforward.models.inline_response_default59 import InlineResponseDefault59 +from billforward.models.inline_response_default6 import InlineResponseDefault6 +from billforward.models.inline_response_default60 import InlineResponseDefault60 +from billforward.models.inline_response_default61 import InlineResponseDefault61 +from billforward.models.inline_response_default62 import InlineResponseDefault62 +from billforward.models.inline_response_default63 import InlineResponseDefault63 +from billforward.models.inline_response_default64 import InlineResponseDefault64 +from billforward.models.inline_response_default65 import InlineResponseDefault65 +from billforward.models.inline_response_default66 import InlineResponseDefault66 +from billforward.models.inline_response_default67 import InlineResponseDefault67 +from billforward.models.inline_response_default68 import InlineResponseDefault68 +from billforward.models.inline_response_default69 import InlineResponseDefault69 +from billforward.models.inline_response_default7 import InlineResponseDefault7 +from billforward.models.inline_response_default70 import InlineResponseDefault70 +from billforward.models.inline_response_default71 import InlineResponseDefault71 +from billforward.models.inline_response_default72 import InlineResponseDefault72 +from billforward.models.inline_response_default73 import InlineResponseDefault73 +from billforward.models.inline_response_default74 import InlineResponseDefault74 +from billforward.models.inline_response_default75 import InlineResponseDefault75 +from billforward.models.inline_response_default76 import InlineResponseDefault76 +from billforward.models.inline_response_default77 import InlineResponseDefault77 +from billforward.models.inline_response_default78 import InlineResponseDefault78 +from billforward.models.inline_response_default79 import InlineResponseDefault79 +from billforward.models.inline_response_default8 import InlineResponseDefault8 +from billforward.models.inline_response_default80 import InlineResponseDefault80 +from billforward.models.inline_response_default81 import InlineResponseDefault81 +from billforward.models.inline_response_default82 import InlineResponseDefault82 +from billforward.models.inline_response_default83 import InlineResponseDefault83 +from billforward.models.inline_response_default84 import InlineResponseDefault84 +from billforward.models.inline_response_default85 import InlineResponseDefault85 +from billforward.models.inline_response_default86 import InlineResponseDefault86 +from billforward.models.inline_response_default87 import InlineResponseDefault87 +from billforward.models.inline_response_default88 import InlineResponseDefault88 +from billforward.models.inline_response_default89 import InlineResponseDefault89 +from billforward.models.inline_response_default9 import InlineResponseDefault9 +from billforward.models.inline_response_default90 import InlineResponseDefault90 +from billforward.models.inline_response_default91 import InlineResponseDefault91 +from billforward.models.inline_response_default92 import InlineResponseDefault92 +from billforward.models.inline_response_default93 import InlineResponseDefault93 +from billforward.models.inline_response_default94 import InlineResponseDefault94 +from billforward.models.inline_response_default95 import InlineResponseDefault95 +from billforward.models.inline_response_default96 import InlineResponseDefault96 +from billforward.models.inline_response_default97 import InlineResponseDefault97 +from billforward.models.inline_response_default98 import InlineResponseDefault98 +from billforward.models.inline_response_default99 import InlineResponseDefault99 +from billforward.models.interval_date import IntervalDate +from billforward.models.invoice import Invoice +from billforward.models.invoice_charge_request import InvoiceChargeRequest +from billforward.models.invoice_execution_request import InvoiceExecutionRequest +from billforward.models.invoice_line_payments import InvoiceLinePayments +from billforward.models.invoice_lines import InvoiceLines +from billforward.models.invoice_next_execution_attempt_amendment import InvoiceNextExecutionAttemptAmendment +from billforward.models.invoice_outstanding_charges_amendment import InvoiceOutstandingChargesAmendment +from billforward.models.invoice_payments import InvoicePayments +from billforward.models.invoice_recalculation_amendment import InvoiceRecalculationAmendment +from billforward.models.invoice_recalculation_request import InvoiceRecalculationRequest +from billforward.models.invoice_refund_request import InvoiceRefundRequest +from billforward.models.invoice_refund_response import InvoiceRefundResponse +from billforward.models.invoice_split import InvoiceSplit +from billforward.models.invoice_split_service_request import InvoiceSplitServiceRequest +from billforward.models.invoice_template_config_response import InvoiceTemplateConfigResponse +from billforward.models.issue_invoice_amendment import IssueInvoiceAmendment +from billforward.models.issue_invoice_request import IssueInvoiceRequest +from billforward.models.issue_invoice_response import IssueInvoiceResponse +from billforward.models.kash_configuration import KashConfiguration +from billforward.models.legacy_create_webhook_request import LegacyCreateWebhookRequest +from billforward.models.manual_charge import ManualCharge +from billforward.models.marketplace_quote import MarketplaceQuote +from billforward.models.metadata import Metadata +from billforward.models.metadata_key_values import MetadataKeyValues +from billforward.models.migration import Migration +from billforward.models.migration_request import MigrationRequest +from billforward.models.migration_response import MigrationResponse +from billforward.models.nested_adhoc_charge_request import NestedAdhocChargeRequest +from billforward.models.nested_charge_request import NestedChargeRequest +from billforward.models.notification_send_request import NotificationSendRequest +from billforward.models.notification_send_response import NotificationSendResponse +from billforward.models.notifications import Notifications +from billforward.models.o_auth_token import OAuthToken +from billforward.models.offline_payment import OfflinePayment +from billforward.models.open_id_registration_response import OpenIDRegistrationResponse +from billforward.models.open_id_user_link_request import OpenIdUserLinkRequest +from billforward.models.organization_lite_view import OrganizationLiteView +from billforward.models.password import Password +from billforward.models.password_reset_code_request import PasswordResetCodeRequest +from billforward.models.password_reset_response import PasswordResetResponse +from billforward.models.password_update_with_reset_code_request import PasswordUpdateWithResetCodeRequest +from billforward.models.pause_request import PauseRequest +from billforward.models.pay_vision_auth_capture_request import PayVisionAuthCaptureRequest +from billforward.models.pay_vision_configuration import PayVisionConfiguration +from billforward.models.pay_vision_pre_auth_request import PayVisionPreAuthRequest +from billforward.models.payment import Payment +from billforward.models.payment_accounting_view import PaymentAccountingView +from billforward.models.payment_method import PaymentMethod +from billforward.models.payment_method_subscription_link import PaymentMethodSubscriptionLink +from billforward.models.payment_refund_request import PaymentRefundRequest +from billforward.models.payment_refund_response import PaymentRefundResponse +from billforward.models.payment_retry_request import PaymentRetryRequest +from billforward.models.paypal_configuration import PaypalConfiguration +from billforward.models.paypal_payment import PaypalPayment +from billforward.models.pending_component_value_change import PendingComponentValueChange +from billforward.models.permission_action_entity import PermissionActionEntity +from billforward.models.permission_resource_entity import PermissionResourceEntity +from billforward.models.plan_aggregation import PlanAggregation +from billforward.models.plan_request import PlanRequest +from billforward.models.plan_response import PlanResponse +from billforward.models.prepayment_charge import PrepaymentCharge +from billforward.models.price_breakdown import PriceBreakdown +from billforward.models.price_line import PriceLine +from billforward.models.pricing_component import PricingComponent +from billforward.models.pricing_component_charge import PricingComponentCharge +from billforward.models.pricing_component_migration_value import PricingComponentMigrationValue +from billforward.models.pricing_component_tier import PricingComponentTier +from billforward.models.pricing_component_value import PricingComponentValue +from billforward.models.pricing_component_value_amendment import PricingComponentValueAmendment +from billforward.models.pricing_component_value_change import PricingComponentValueChange +from billforward.models.pricing_component_value_migration_amendment_mapping import PricingComponentValueMigrationAmendmentMapping +from billforward.models.pricing_component_value_request import PricingComponentValueRequest +from billforward.models.pricing_component_value_response import PricingComponentValueResponse +from billforward.models.pricing_components_by_charge_type import PricingComponentsByChargeType +from billforward.models.pricing_tier import PricingTier +from billforward.models.product_rate_plan_migration_amendment import ProductRatePlanMigrationAmendment +from billforward.models.product_rate_plan_migration_charge import ProductRatePlanMigrationCharge +from billforward.models.profile import Profile +from billforward.models.public_configuration_response import PublicConfigurationResponse +from billforward.models.quote_request import QuoteRequest +from billforward.models.quote_request_value import QuoteRequestValue +from billforward.models.recalculate_charge_batch_request import RecalculateChargeBatchRequest +from billforward.models.recalculate_charge_batch_response import RecalculateChargeBatchResponse +from billforward.models.recalculate_charge_request import RecalculateChargeRequest +from billforward.models.receipt import Receipt +from billforward.models.refund import Refund +from billforward.models.refund_accounting_view import RefundAccountingView +from billforward.models.remove_credit_account_request import RemoveCreditAccountRequest +from billforward.models.resume_request import ResumeRequest +from billforward.models.resume_subscription_amendment import ResumeSubscriptionAmendment +from billforward.models.revenue_attributions import RevenueAttributions +from billforward.models.role import Role +from billforward.models.sage_pay_auth_capture_request import SagePayAuthCaptureRequest +from billforward.models.sage_pay_card_payment import SagePayCardPayment +from billforward.models.sage_pay_configuration import SagePayConfiguration +from billforward.models.sage_pay_enabled_card_type import SagePayEnabledCardType +from billforward.models.sage_pay_pre_auth_request import SagePayPreAuthRequest +from billforward.models.salesforce_configuration_response import SalesforceConfigurationResponse +from billforward.models.service_end_amendment import ServiceEndAmendment +from billforward.models.set_rate_plan_affiliate_request import SetRatePlanAffiliateRequest +from billforward.models.set_subscription_affiliate_request import SetSubscriptionAffiliateRequest +from billforward.models.setup_charge import SetupCharge +from billforward.models.setup_pricing_components_by_charge_model import SetupPricingComponentsByChargeModel +from billforward.models.shuttle_auth_capture_request import ShuttleAuthCaptureRequest +from billforward.models.shuttle_configuration import ShuttleConfiguration +from billforward.models.shuttle_payment import ShuttlePayment +from billforward.models.shuttle_pre_auth_request import ShuttlePreAuthRequest +from billforward.models.simple_date_param import SimpleDateParam +from billforward.models.simple_user import SimpleUser +from billforward.models.single_recalculate_charge_request import SingleRecalculateChargeRequest +from billforward.models.spreedly_auth_capture_request import SpreedlyAuthCaptureRequest +from billforward.models.spreedly_configuration import SpreedlyConfiguration +from billforward.models.spreedly_pre_auth_request import SpreedlyPreAuthRequest +from billforward.models.square_auth_capture_request import SquareAuthCaptureRequest +from billforward.models.square_configuration import SquareConfiguration +from billforward.models.square_configuration_data import SquareConfigurationData +from billforward.models.square_data import SquareData +from billforward.models.square_payment import SquarePayment +from billforward.models.square_subscription import SquareSubscription +from billforward.models.start_all_subscriptions_request import StartAllSubscriptionsRequest +from billforward.models.start_all_subscriptions_response import StartAllSubscriptionsResponse +from billforward.models.start_contract_request import StartContractRequest +from billforward.models.start_contract_response import StartContractResponse +from billforward.models.stripe_ach_capture_request import StripeACHCaptureRequest +from billforward.models.stripe_ach_payment import StripeACHPayment +from billforward.models.stripe_ach_token import StripeAchToken +from billforward.models.stripe_additional_data import StripeAdditionalData +from billforward.models.stripe_auth_capture_request import StripeAuthCaptureRequest +from billforward.models.stripe_card_payment import StripeCardPayment +from billforward.models.stripe_configuration import StripeConfiguration +from billforward.models.stripe_pre_auth_request import StripePreAuthRequest +from billforward.models.stripe_token import StripeToken +from billforward.models.subscription import Subscription +from billforward.models.subscription_cancellation import SubscriptionCancellation +from billforward.models.subscription_charge import SubscriptionCharge +from billforward.models.subscription_checkout_action_request import SubscriptionCheckoutActionRequest +from billforward.models.subscription_checkout_definition_description import SubscriptionCheckoutDefinitionDescription +from billforward.models.subscription_checkout_response import SubscriptionCheckoutResponse +from billforward.models.subscription_revive_amendment import SubscriptionReviveAmendment +from billforward.models.subscription_revive_partial_request import SubscriptionRevivePartialRequest +from billforward.models.subscription_revive_request import SubscriptionReviveRequest +from billforward.models.swagger_type_list_inv import SwaggerTypeListInv +from billforward.models.swagger_type_list_subs import SwaggerTypeListSubs +from billforward.models.sync_action_request import SyncActionRequest +from billforward.models.tax_line import TaxLine +from billforward.models.taxation_strategy import TaxationStrategy +from billforward.models.tiered_advance_pricing_component import TieredAdvancePricingComponent +from billforward.models.tiered_arrears_pricing_component import TieredArrearsPricingComponent +from billforward.models.tiered_pricing_component import TieredPricingComponent +from billforward.models.tiered_setup_pricing_component import TieredSetupPricingComponent +from billforward.models.tiered_usage_pricing_component import TieredUsagePricingComponent +from billforward.models.tiered_volume_pricing_component import TieredVolumePricingComponent +from billforward.models.time_request import TimeRequest +from billforward.models.time_response import TimeResponse +from billforward.models.timer_amendment import TimerAmendment +from billforward.models.tokenization_epxredirect_body import TokenizationEpxredirectBody +from billforward.models.tokenization_payvisionshoutv1_body import TokenizationPayvisionshoutv1Body +from billforward.models.tokenization_pre_auth import TokenizationPreAuth +from billforward.models.tokenization_pre_auth_request import TokenizationPreAuthRequest +from billforward.models.tokenization_sagepaynotifyv300_body import TokenizationSagepaynotifyv300Body +from billforward.models.tokens_response import TokensResponse +from billforward.models.trust_commerce_configuration import TrustCommerceConfiguration +from billforward.models.trust_commerce_token import TrustCommerceToken +from billforward.models.typed_query_result_wrapper_api_quote import TypedQueryResultWrapperAPIQuote +from billforward.models.typed_query_result_wrapper_account import TypedQueryResultWrapperAccount +from billforward.models.typed_query_result_wrapper_address import TypedQueryResultWrapperAddress +from billforward.models.typed_query_result_wrapper_amendment import TypedQueryResultWrapperAmendment +from billforward.models.typed_query_result_wrapper_avatax_configuration import TypedQueryResultWrapperAvataxConfiguration +from billforward.models.typed_query_result_wrapper_bf_permission import TypedQueryResultWrapperBFPermission +from billforward.models.typed_query_result_wrapper_braintree_token import TypedQueryResultWrapperBraintreeToken +from billforward.models.typed_query_result_wrapper_contract import TypedQueryResultWrapperContract +from billforward.models.typed_query_result_wrapper_coupon import TypedQueryResultWrapperCoupon +from billforward.models.typed_query_result_wrapper_credit_note import TypedQueryResultWrapperCreditNote +from billforward.models.typed_query_result_wrapper_data_sync_job_response import TypedQueryResultWrapperDataSyncJobResponse +from billforward.models.typed_query_result_wrapper_dunning_line import TypedQueryResultWrapperDunningLine +from billforward.models.typed_query_result_wrapper_invoice import TypedQueryResultWrapperInvoice +from billforward.models.typed_query_result_wrapper_invoice_line_payment import TypedQueryResultWrapperInvoiceLinePayment +from billforward.models.typed_query_result_wrapper_notification import TypedQueryResultWrapperNotification +from billforward.models.typed_query_result_wrapper_payment import TypedQueryResultWrapperPayment +from billforward.models.typed_query_result_wrapper_payment_method import TypedQueryResultWrapperPaymentMethod +from billforward.models.typed_query_result_wrapper_plan_response import TypedQueryResultWrapperPlanResponse +from billforward.models.typed_query_result_wrapper_profile import TypedQueryResultWrapperProfile +from billforward.models.typed_query_result_wrapper_receipt import TypedQueryResultWrapperReceipt +from billforward.models.typed_query_result_wrapper_refund import TypedQueryResultWrapperRefund +from billforward.models.typed_query_result_wrapper_revenue_attribution import TypedQueryResultWrapperRevenueAttribution +from billforward.models.typed_query_result_wrapper_role import TypedQueryResultWrapperRole +from billforward.models.typed_query_result_wrapper_stripe_ach_token import TypedQueryResultWrapperStripeACHToken +from billforward.models.typed_query_result_wrapper_stripe_token import TypedQueryResultWrapperStripeToken +from billforward.models.typed_query_result_wrapper_subscription import TypedQueryResultWrapperSubscription +from billforward.models.typed_query_result_wrapper_subscription_charge import TypedQueryResultWrapperSubscriptionCharge +from billforward.models.typed_query_result_wrapper_taxation_strategy import TypedQueryResultWrapperTaxationStrategy +from billforward.models.typed_query_result_wrapper_user_response import TypedQueryResultWrapperUserResponse +from billforward.models.typed_query_result_wrapper_webhook import TypedQueryResultWrapperWebhook +from billforward.models.unit_of_measure import UnitOfMeasure +from billforward.models.update_component_value_amendment import UpdateComponentValueAmendment +from billforward.models.update_contract_request import UpdateContractRequest +from billforward.models.update_email_request import UpdateEmailRequest +from billforward.models.update_invoice_request import UpdateInvoiceRequest +from billforward.models.update_invoice_template_request import UpdateInvoiceTemplateRequest +from billforward.models.update_password_request import UpdatePasswordRequest +from billforward.models.update_password_response import UpdatePasswordResponse +from billforward.models.update_pricing_component_value_change_result import UpdatePricingComponentValueChangeResult +from billforward.models.update_pricing_component_value_request import UpdatePricingComponentValueRequest +from billforward.models.update_pricing_component_value_response import UpdatePricingComponentValueResponse +from billforward.models.update_rate_plan_affiliate_request import UpdateRatePlanAffiliateRequest +from billforward.models.update_role_request import UpdateRoleRequest +from billforward.models.update_salesforce_configuration_request import UpdateSalesforceConfigurationRequest +from billforward.models.update_subscription_request import UpdateSubscriptionRequest +from billforward.models.update_user_info_request import UpdateUserInfoRequest +from billforward.models.upgrade_charge import UpgradeCharge +from billforward.models.usage_pricing_components_by_charge_model import UsagePricingComponentsByChargeModel +from billforward.models.user import User +from billforward.models.user_create_request import UserCreateRequest +from billforward.models.user_creation_request import UserCreationRequest +from billforward.models.user_creation_response import UserCreationResponse +from billforward.models.user_invite_request import UserInviteRequest +from billforward.models.user_private_permanent_token_refresh_request import UserPrivatePermanentTokenRefreshRequest +from billforward.models.user_private_permanent_token_request import UserPrivatePermanentTokenRequest +from billforward.models.user_response import UserResponse +from billforward.models.user_timezone import UserTimezone +from billforward.models.username import Username +from billforward.models.username_response import UsernameResponse +from billforward.models.value_increment import ValueIncrement +from billforward.models.verify_payment_method_request import VerifyPaymentMethodRequest +from billforward.models.webhook import Webhook +from billforward.models.webhook_subscription import WebhookSubscription +from billforward.models.zooz_capture_request import ZoozCaptureRequest +from billforward.models.zooz_configuration import ZoozConfiguration +from billforward.models.zooz_payment import ZoozPayment diff --git a/billforward/models/account.py b/billforward/models/account.py index a30e367..2045097 100644 --- a/billforward/models/account.py +++ b/billforward/models/account.py @@ -1,135 +1,142 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class Account(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, crm_id=None, created=None, changed_by=None, updated=None, metadata=None, id=None, organization_id=None, user_id=None, successful_subscriptions=None, aggregating_product_rate_plan_id=None, aggregating_subscription_id=None, deleted=False, profile=None, payment_methods=None): - """ - Account - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'crm_id': 'str', - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'metadata': 'DynamicMetadata', - 'id': 'str', - 'organization_id': 'str', - 'user_id': 'str', - 'successful_subscriptions': 'int', - 'aggregating_product_rate_plan_id': 'str', - 'aggregating_subscription_id': 'str', - 'deleted': 'bool', - 'profile': 'Profile', - 'payment_methods': 'list[PaymentMethod]' - } - - self.attribute_map = { - 'crm_id': 'crmID', - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'metadata': 'metadata', - 'id': 'id', - 'organization_id': 'organizationID', - 'user_id': 'userID', - 'successful_subscriptions': 'successfulSubscriptions', - 'aggregating_product_rate_plan_id': 'aggregatingProductRatePlanID', - 'aggregating_subscription_id': 'aggregatingSubscriptionID', - 'deleted': 'deleted', - 'profile': 'profile', - 'payment_methods': 'paymentMethods' - } - - self._crm_id = crm_id - self._created = created - self._changed_by = changed_by - self._updated = updated - self._metadata = metadata - self._id = id - self._organization_id = organization_id - self._user_id = user_id - self._successful_subscriptions = successful_subscriptions - self._aggregating_product_rate_plan_id = aggregating_product_rate_plan_id - self._aggregating_subscription_id = aggregating_subscription_id - self._deleted = deleted - self._profile = profile - self._payment_methods = payment_methods - - @property - def crm_id(self): - """ - Gets the crm_id of this Account. - { \"description\" : \"CRM ID of the account.\", \"verbs\":[\"GET\"] } - - :return: The crm_id of this Account. - :rtype: str - """ - return self._crm_id - - @crm_id.setter - def crm_id(self, crm_id): - """ - Sets the crm_id of this Account. - { \"description\" : \"CRM ID of the account.\", \"verbs\":[\"GET\"] } - - :param crm_id: The crm_id of this Account. - :type: str - """ - - self._crm_id = crm_id + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'metadata': 'dict(str, object)', + 'id': 'str', + 'crm_id': 'str', + 'organization_id': 'str', + 'user_id': 'str', + 'successful_subscriptions': 'int', + 'aggregating_product_rate_plan_id': 'str', + 'aggregating_subscription_id': 'str', + 'parent_id': 'str', + 'deleted': 'bool', + 'profile': 'Profile', + 'affiliate': 'Affiliate', + 'payment_methods': 'list[PaymentMethod]', + 'profile_from_request': 'CreateProfileRequest' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'metadata': 'metadata', + 'id': 'id', + 'crm_id': 'crmID', + 'organization_id': 'organizationID', + 'user_id': 'userID', + 'successful_subscriptions': 'successfulSubscriptions', + 'aggregating_product_rate_plan_id': 'aggregatingProductRatePlanID', + 'aggregating_subscription_id': 'aggregatingSubscriptionID', + 'parent_id': 'parentID', + 'deleted': 'deleted', + 'profile': 'profile', + 'affiliate': 'affiliate', + 'payment_methods': 'paymentMethods', + 'profile_from_request': 'profileFromRequest' + } + + def __init__(self, created=None, changed_by=None, updated=None, metadata=None, id=None, crm_id=None, organization_id=None, user_id=None, successful_subscriptions=None, aggregating_product_rate_plan_id=None, aggregating_subscription_id=None, parent_id=None, deleted=None, profile=None, affiliate=None, payment_methods=None, profile_from_request=None): # noqa: E501 + """Account - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._metadata = None + self._id = None + self._crm_id = None + self._organization_id = None + self._user_id = None + self._successful_subscriptions = None + self._aggregating_product_rate_plan_id = None + self._aggregating_subscription_id = None + self._parent_id = None + self._deleted = None + self._profile = None + self._affiliate = None + self._payment_methods = None + self._profile_from_request = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if metadata is not None: + self.metadata = metadata + if id is not None: + self.id = id + if crm_id is not None: + self.crm_id = crm_id + self.organization_id = organization_id + if user_id is not None: + self.user_id = user_id + if successful_subscriptions is not None: + self.successful_subscriptions = successful_subscriptions + if aggregating_product_rate_plan_id is not None: + self.aggregating_product_rate_plan_id = aggregating_product_rate_plan_id + if aggregating_subscription_id is not None: + self.aggregating_subscription_id = aggregating_subscription_id + if parent_id is not None: + self.parent_id = parent_id + if deleted is not None: + self.deleted = deleted + if profile is not None: + self.profile = profile + if affiliate is not None: + self.affiliate = affiliate + if payment_methods is not None: + self.payment_methods = payment_methods + if profile_from_request is not None: + self.profile_from_request = profile_from_request @property def created(self): - """ - Gets the created of this Account. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this Account. # noqa: E501 - :return: The created of this Account. + + :return: The created of this Account. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this Account. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this Account. - :param created: The created of this Account. + + :param created: The created of this Account. # noqa: E501 :type: datetime """ @@ -137,22 +144,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this Account. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this Account. # noqa: E501 + - :return: The changed_by of this Account. + :return: The changed_by of this Account. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this Account. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this Account. + - :param changed_by: The changed_by of this Account. + :param changed_by: The changed_by of this Account. # noqa: E501 :type: str """ @@ -160,22 +165,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this Account. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this Account. # noqa: E501 + - :return: The updated of this Account. + :return: The updated of this Account. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this Account. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this Account. - :param updated: The updated of this Account. + + :param updated: The updated of this Account. # noqa: E501 :type: datetime """ @@ -183,91 +186,106 @@ def updated(self, updated): @property def metadata(self): - """ - Gets the metadata of this Account. - { \"description\" : \"Add metadata.\", \"verbs\":[\"POST\"] } + """Gets the metadata of this Account. # noqa: E501 - :return: The metadata of this Account. - :rtype: DynamicMetadata + + :return: The metadata of this Account. # noqa: E501 + :rtype: dict(str, object) """ return self._metadata @metadata.setter def metadata(self, metadata): - """ - Sets the metadata of this Account. - { \"description\" : \"Add metadata.\", \"verbs\":[\"POST\"] } + """Sets the metadata of this Account. - :param metadata: The metadata of this Account. - :type: DynamicMetadata + + :param metadata: The metadata of this Account. # noqa: E501 + :type: dict(str, object) """ self._metadata = metadata @property def id(self): - """ - Gets the id of this Account. - { \"description\" : \"ID of the account.\", \"verbs\":[\"GET\"] } + """Gets the id of this Account. # noqa: E501 - :return: The id of this Account. + + :return: The id of this Account. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this Account. - { \"description\" : \"ID of the account.\", \"verbs\":[\"GET\"] } + """Sets the id of this Account. + - :param id: The id of this Account. + :param id: The id of this Account. # noqa: E501 :type: str """ self._id = id @property - def organization_id(self): + def crm_id(self): + """Gets the crm_id of this Account. # noqa: E501 + + + :return: The crm_id of this Account. # noqa: E501 + :rtype: str + """ + return self._crm_id + + @crm_id.setter + def crm_id(self, crm_id): + """Sets the crm_id of this Account. + + + :param crm_id: The crm_id of this Account. # noqa: E501 + :type: str """ - Gets the organization_id of this Account. - { \"description\" : \"Organization associated with the account.\", \"verbs\":[] } - :return: The organization_id of this Account. + self._crm_id = crm_id + + @property + def organization_id(self): + """Gets the organization_id of this Account. # noqa: E501 + + + :return: The organization_id of this Account. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this Account. - { \"description\" : \"Organization associated with the account.\", \"verbs\":[] } + """Sets the organization_id of this Account. - :param organization_id: The organization_id of this Account. + + :param organization_id: The organization_id of this Account. # noqa: E501 :type: str """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 self._organization_id = organization_id @property def user_id(self): - """ - Gets the user_id of this Account. - { \"description\" : \"User associated with the account. If this is null, no user is currently assocaited with the account. A user is only set when an account is associated with a user account.\", \"verbs\":[] } + """Gets the user_id of this Account. # noqa: E501 + - :return: The user_id of this Account. + :return: The user_id of this Account. # noqa: E501 :rtype: str """ return self._user_id @user_id.setter def user_id(self, user_id): - """ - Sets the user_id of this Account. - { \"description\" : \"User associated with the account. If this is null, no user is currently assocaited with the account. A user is only set when an account is associated with a user account.\", \"verbs\":[] } + """Sets the user_id of this Account. + - :param user_id: The user_id of this Account. + :param user_id: The user_id of this Account. # noqa: E501 :type: str """ @@ -275,22 +293,20 @@ def user_id(self, user_id): @property def successful_subscriptions(self): - """ - Gets the successful_subscriptions of this Account. - { \"description\" : \"Number of distinct, paid subscriptions associated with this account. Initially the value will be 0 when no successful subscriptions have been taken. A subscription cancelled whilst in trial is counted as successful.\", \"verbs\":[\"GET\"] } + """Gets the successful_subscriptions of this Account. # noqa: E501 + - :return: The successful_subscriptions of this Account. + :return: The successful_subscriptions of this Account. # noqa: E501 :rtype: int """ return self._successful_subscriptions @successful_subscriptions.setter def successful_subscriptions(self, successful_subscriptions): - """ - Sets the successful_subscriptions of this Account. - { \"description\" : \"Number of distinct, paid subscriptions associated with this account. Initially the value will be 0 when no successful subscriptions have been taken. A subscription cancelled whilst in trial is counted as successful.\", \"verbs\":[\"GET\"] } + """Sets the successful_subscriptions of this Account. - :param successful_subscriptions: The successful_subscriptions of this Account. + + :param successful_subscriptions: The successful_subscriptions of this Account. # noqa: E501 :type: int """ @@ -298,22 +314,20 @@ def successful_subscriptions(self, successful_subscriptions): @property def aggregating_product_rate_plan_id(self): - """ - Gets the aggregating_product_rate_plan_id of this Account. - { \"description\" : \"If present, this will be the product rate plan to use when creating an aggregating subscription. An account level aggregating subscription will be created when the first subscription is created against the account.\", \"verbs\":[] } + """Gets the aggregating_product_rate_plan_id of this Account. # noqa: E501 - :return: The aggregating_product_rate_plan_id of this Account. + + :return: The aggregating_product_rate_plan_id of this Account. # noqa: E501 :rtype: str """ return self._aggregating_product_rate_plan_id @aggregating_product_rate_plan_id.setter def aggregating_product_rate_plan_id(self, aggregating_product_rate_plan_id): - """ - Sets the aggregating_product_rate_plan_id of this Account. - { \"description\" : \"If present, this will be the product rate plan to use when creating an aggregating subscription. An account level aggregating subscription will be created when the first subscription is created against the account.\", \"verbs\":[] } + """Sets the aggregating_product_rate_plan_id of this Account. - :param aggregating_product_rate_plan_id: The aggregating_product_rate_plan_id of this Account. + + :param aggregating_product_rate_plan_id: The aggregating_product_rate_plan_id of this Account. # noqa: E501 :type: str """ @@ -321,45 +335,62 @@ def aggregating_product_rate_plan_id(self, aggregating_product_rate_plan_id): @property def aggregating_subscription_id(self): - """ - Gets the aggregating_subscription_id of this Account. - { \"description\" : \"The consistent ID of the account level aggregating subscription, if one exists.\", \"verbs\":[] } + """Gets the aggregating_subscription_id of this Account. # noqa: E501 - :return: The aggregating_subscription_id of this Account. + + :return: The aggregating_subscription_id of this Account. # noqa: E501 :rtype: str """ return self._aggregating_subscription_id @aggregating_subscription_id.setter def aggregating_subscription_id(self, aggregating_subscription_id): - """ - Sets the aggregating_subscription_id of this Account. - { \"description\" : \"The consistent ID of the account level aggregating subscription, if one exists.\", \"verbs\":[] } + """Sets the aggregating_subscription_id of this Account. + - :param aggregating_subscription_id: The aggregating_subscription_id of this Account. + :param aggregating_subscription_id: The aggregating_subscription_id of this Account. # noqa: E501 :type: str """ self._aggregating_subscription_id = aggregating_subscription_id @property - def deleted(self): + def parent_id(self): + """Gets the parent_id of this Account. # noqa: E501 + + + :return: The parent_id of this Account. # noqa: E501 + :rtype: str + """ + return self._parent_id + + @parent_id.setter + def parent_id(self, parent_id): + """Sets the parent_id of this Account. + + + :param parent_id: The parent_id of this Account. # noqa: E501 + :type: str """ - Gets the deleted of this Account. - { \"default\" : \"false\", \"description\" : \"Indicates if an account has been retired. If an account has been retired it can still be retrieved using the appropriate flag on API requests.\", \"verbs\":[\"GET\"] } - :return: The deleted of this Account. + self._parent_id = parent_id + + @property + def deleted(self): + """Gets the deleted of this Account. # noqa: E501 + + + :return: The deleted of this Account. # noqa: E501 :rtype: bool """ return self._deleted @deleted.setter def deleted(self, deleted): - """ - Sets the deleted of this Account. - { \"default\" : \"false\", \"description\" : \"Indicates if an account has been retired. If an account has been retired it can still be retrieved using the appropriate flag on API requests.\", \"verbs\":[\"GET\"] } + """Sets the deleted of this Account. - :param deleted: The deleted of this Account. + + :param deleted: The deleted of this Account. # noqa: E501 :type: bool """ @@ -367,57 +398,93 @@ def deleted(self, deleted): @property def profile(self): - """ - Gets the profile of this Account. + """Gets the profile of this Account. # noqa: E501 - :return: The profile of this Account. + :return: The profile of this Account. # noqa: E501 :rtype: Profile """ return self._profile @profile.setter def profile(self, profile): - """ - Sets the profile of this Account. + """Sets the profile of this Account. - :param profile: The profile of this Account. + :param profile: The profile of this Account. # noqa: E501 :type: Profile """ self._profile = profile @property - def payment_methods(self): + def affiliate(self): + """Gets the affiliate of this Account. # noqa: E501 + + + :return: The affiliate of this Account. # noqa: E501 + :rtype: Affiliate + """ + return self._affiliate + + @affiliate.setter + def affiliate(self, affiliate): + """Sets the affiliate of this Account. + + + :param affiliate: The affiliate of this Account. # noqa: E501 + :type: Affiliate """ - Gets the payment_methods of this Account. - { \"description\" : \"The payment-methods associated with the account.\", \"verbs\":[\"GET\"] } - :return: The payment_methods of this Account. + self._affiliate = affiliate + + @property + def payment_methods(self): + """Gets the payment_methods of this Account. # noqa: E501 + + + :return: The payment_methods of this Account. # noqa: E501 :rtype: list[PaymentMethod] """ return self._payment_methods @payment_methods.setter def payment_methods(self, payment_methods): - """ - Sets the payment_methods of this Account. - { \"description\" : \"The payment-methods associated with the account.\", \"verbs\":[\"GET\"] } + """Sets the payment_methods of this Account. - :param payment_methods: The payment_methods of this Account. + + :param payment_methods: The payment_methods of this Account. # noqa: E501 :type: list[PaymentMethod] """ self._payment_methods = payment_methods - def to_dict(self): + @property + def profile_from_request(self): + """Gets the profile_from_request of this Account. # noqa: E501 + + + :return: The profile_from_request of this Account. # noqa: E501 + :rtype: CreateProfileRequest """ - Returns the model properties as a dict + return self._profile_from_request + + @profile_from_request.setter + def profile_from_request(self, profile_from_request): + """Sets the profile_from_request of this Account. + + + :param profile_from_request: The profile_from_request of this Account. # noqa: E501 + :type: CreateProfileRequest """ + + self._profile_from_request = profile_from_request + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -434,29 +501,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Account, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Account): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/account_ltv_result_paged_metadata.py b/billforward/models/account_ltv_result_paged_metadata.py deleted file mode 100644 index 98e0f31..0000000 --- a/billforward/models/account_ltv_result_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class AccountLTVResultPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - AccountLTVResultPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this AccountLTVResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this AccountLTVResultPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this AccountLTVResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this AccountLTVResultPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this AccountLTVResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this AccountLTVResultPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this AccountLTVResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this AccountLTVResultPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this AccountLTVResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this AccountLTVResultPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this AccountLTVResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this AccountLTVResultPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this AccountLTVResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this AccountLTVResultPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this AccountLTVResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this AccountLTVResultPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this AccountLTVResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this AccountLTVResultPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this AccountLTVResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this AccountLTVResultPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this AccountLTVResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this AccountLTVResultPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this AccountLTVResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this AccountLTVResultPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this AccountLTVResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this AccountLTVResultPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this AccountLTVResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this AccountLTVResultPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/account_paged_metadata.py b/billforward/models/account_paged_metadata.py deleted file mode 100644 index 789d804..0000000 --- a/billforward/models/account_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class AccountPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - AccountPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Account]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this AccountPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this AccountPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this AccountPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this AccountPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this AccountPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this AccountPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this AccountPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this AccountPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this AccountPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this AccountPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this AccountPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this AccountPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this AccountPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this AccountPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this AccountPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this AccountPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this AccountPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this AccountPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this AccountPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this AccountPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this AccountPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this AccountPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this AccountPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this AccountPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this AccountPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this AccountPagedMetadata. - :rtype: list[Account] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this AccountPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this AccountPagedMetadata. - :type: list[Account] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/account_payments_result_paged_metadata.py b/billforward/models/account_payments_result_paged_metadata.py deleted file mode 100644 index 6afd0e9..0000000 --- a/billforward/models/account_payments_result_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class AccountPaymentsResultPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - AccountPaymentsResultPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this AccountPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this AccountPaymentsResultPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this AccountPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this AccountPaymentsResultPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this AccountPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this AccountPaymentsResultPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this AccountPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this AccountPaymentsResultPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this AccountPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this AccountPaymentsResultPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this AccountPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this AccountPaymentsResultPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this AccountPaymentsResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this AccountPaymentsResultPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this AccountPaymentsResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this AccountPaymentsResultPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this AccountPaymentsResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this AccountPaymentsResultPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this AccountPaymentsResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this AccountPaymentsResultPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this AccountPaymentsResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this AccountPaymentsResultPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this AccountPaymentsResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this AccountPaymentsResultPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this AccountPaymentsResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this AccountPaymentsResultPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this AccountPaymentsResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this AccountPaymentsResultPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/add_charge_request.py b/billforward/models/add_charge_request.py index 5b23f7e..dfb6e95 100644 --- a/billforward/models/add_charge_request.py +++ b/billforward/models/add_charge_request.py @@ -1,118 +1,152 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class AddChargeRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, id=None, name=None, description=None, currency=None, amount=None, tax_amount=False, period_start=None, period_end=None, invoicing_type=None, charge_type=None, trial=False, remaining_credit_behaviour=None, pricing_component=None, pricing_component_value=None, dry_run=False): - """ - AddChargeRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'id': 'str', - 'name': 'str', - 'description': 'str', - 'currency': 'str', - 'amount': 'float', - 'tax_amount': 'bool', - 'period_start': 'datetime', - 'period_end': 'datetime', - 'invoicing_type': 'str', - 'charge_type': 'str', - 'trial': 'bool', - 'remaining_credit_behaviour': 'str', - 'pricing_component': 'str', - 'pricing_component_value': 'int', - 'dry_run': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'id': 'id', - 'name': 'name', - 'description': 'description', - 'currency': 'currency', - 'amount': 'amount', - 'tax_amount': 'taxAmount', - 'period_start': 'periodStart', - 'period_end': 'periodEnd', - 'invoicing_type': 'invoicingType', - 'charge_type': 'chargeType', - 'trial': 'trial', - 'remaining_credit_behaviour': 'remainingCreditBehaviour', - 'pricing_component': 'pricingComponent', - 'pricing_component_value': 'pricingComponentValue', - 'dry_run': 'dryRun' - } - - self._created = created - self._id = id - self._name = name - self._description = description - self._currency = currency - self._amount = amount - self._tax_amount = tax_amount - self._period_start = period_start - self._period_end = period_end - self._invoicing_type = invoicing_type - self._charge_type = charge_type - self._trial = trial - self._remaining_credit_behaviour = remaining_credit_behaviour - self._pricing_component = pricing_component - self._pricing_component_value = pricing_component_value - self._dry_run = dry_run + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'name': 'str', + 'description': 'str', + 'currency': 'CreditNoteCurrency', + 'amount': 'float', + 'tax_amount': 'bool', + 'period_start': 'datetime', + 'period_end': 'datetime', + 'invoicing_type': 'str', + 'charge_type': 'str', + 'trial': 'bool', + 'remaining_credit_behaviour': 'str', + 'pricing_component': 'str', + 'pricing_component_value': 'int', + 'dry_run': 'bool', + 'invoice_state': 'str', + 'void_on_failure': 'bool' + } + + attribute_map = { + 'created': 'created', + 'id': 'id', + 'organization_id': 'organizationID', + 'name': 'name', + 'description': 'description', + 'currency': 'currency', + 'amount': 'amount', + 'tax_amount': 'taxAmount', + 'period_start': 'periodStart', + 'period_end': 'periodEnd', + 'invoicing_type': 'invoicingType', + 'charge_type': 'chargeType', + 'trial': 'trial', + 'remaining_credit_behaviour': 'remainingCreditBehaviour', + 'pricing_component': 'pricingComponent', + 'pricing_component_value': 'pricingComponentValue', + 'dry_run': 'dryRun', + 'invoice_state': 'invoiceState', + 'void_on_failure': 'voidOnFailure' + } + + def __init__(self, created=None, id=None, organization_id=None, name=None, description=None, currency=None, amount=None, tax_amount=None, period_start=None, period_end=None, invoicing_type=None, charge_type=None, trial=None, remaining_credit_behaviour=None, pricing_component=None, pricing_component_value=None, dry_run=None, invoice_state=None, void_on_failure=None): # noqa: E501 + """AddChargeRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._id = None + self._organization_id = None + self._name = None + self._description = None + self._currency = None + self._amount = None + self._tax_amount = None + self._period_start = None + self._period_end = None + self._invoicing_type = None + self._charge_type = None + self._trial = None + self._remaining_credit_behaviour = None + self._pricing_component = None + self._pricing_component_value = None + self._dry_run = None + self._invoice_state = None + self._void_on_failure = None + self.discriminator = None + if created is not None: + self.created = created + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if description is not None: + self.description = description + if currency is not None: + self.currency = currency + if amount is not None: + self.amount = amount + if tax_amount is not None: + self.tax_amount = tax_amount + if period_start is not None: + self.period_start = period_start + if period_end is not None: + self.period_end = period_end + if invoicing_type is not None: + self.invoicing_type = invoicing_type + if charge_type is not None: + self.charge_type = charge_type + if trial is not None: + self.trial = trial + self.remaining_credit_behaviour = remaining_credit_behaviour + if pricing_component is not None: + self.pricing_component = pricing_component + if pricing_component_value is not None: + self.pricing_component_value = pricing_component_value + if dry_run is not None: + self.dry_run = dry_run + if invoice_state is not None: + self.invoice_state = invoice_state + if void_on_failure is not None: + self.void_on_failure = void_on_failure @property def created(self): - """ - Gets the created of this AddChargeRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this AddChargeRequest. # noqa: E501 - :return: The created of this AddChargeRequest. + + :return: The created of this AddChargeRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this AddChargeRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this AddChargeRequest. - :param created: The created of this AddChargeRequest. + + :param created: The created of this AddChargeRequest. # noqa: E501 :type: datetime """ @@ -120,45 +154,62 @@ def created(self, created): @property def id(self): - """ - Gets the id of this AddChargeRequest. - {\"description\":\"ID of an existing charge to add to the invoice \",\"verbs\":[\"POST\",\"GET\"]} + """Gets the id of this AddChargeRequest. # noqa: E501 - :return: The id of this AddChargeRequest. + + :return: The id of this AddChargeRequest. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this AddChargeRequest. - {\"description\":\"ID of an existing charge to add to the invoice \",\"verbs\":[\"POST\",\"GET\"]} + """Sets the id of this AddChargeRequest. - :param id: The id of this AddChargeRequest. + + :param id: The id of this AddChargeRequest. # noqa: E501 :type: str """ self._id = id @property - def name(self): + def organization_id(self): + """Gets the organization_id of this AddChargeRequest. # noqa: E501 + + + :return: The organization_id of this AddChargeRequest. # noqa: E501 + :rtype: str """ - Gets the name of this AddChargeRequest. - {\"description\":\"Friendly name given to the charge to help identify it.\",\"verbs\":[\"POST\",\"GET\"]} + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AddChargeRequest. + - :return: The name of this AddChargeRequest. + :param organization_id: The organization_id of this AddChargeRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def name(self): + """Gets the name of this AddChargeRequest. # noqa: E501 + + + :return: The name of this AddChargeRequest. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this AddChargeRequest. - {\"description\":\"Friendly name given to the charge to help identify it.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the name of this AddChargeRequest. + - :param name: The name of this AddChargeRequest. + :param name: The name of this AddChargeRequest. # noqa: E501 :type: str """ @@ -166,22 +217,20 @@ def name(self, name): @property def description(self): - """ - Gets the description of this AddChargeRequest. - {\"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the description of this AddChargeRequest. # noqa: E501 + - :return: The description of this AddChargeRequest. + :return: The description of this AddChargeRequest. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this AddChargeRequest. - {\"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the description of this AddChargeRequest. + - :param description: The description of this AddChargeRequest. + :param description: The description of this AddChargeRequest. # noqa: E501 :type: str """ @@ -189,45 +238,41 @@ def description(self, description): @property def currency(self): - """ - Gets the currency of this AddChargeRequest. - { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } + """Gets the currency of this AddChargeRequest. # noqa: E501 - :return: The currency of this AddChargeRequest. - :rtype: str + + :return: The currency of this AddChargeRequest. # noqa: E501 + :rtype: CreditNoteCurrency """ return self._currency @currency.setter def currency(self, currency): - """ - Sets the currency of this AddChargeRequest. - { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } + """Sets the currency of this AddChargeRequest. - :param currency: The currency of this AddChargeRequest. - :type: str + + :param currency: The currency of this AddChargeRequest. # noqa: E501 + :type: CreditNoteCurrency """ self._currency = currency @property def amount(self): - """ - Gets the amount of this AddChargeRequest. - {\"description\":\"Monetary amount for which to charge. Used only for ad-hoc charges i.e charges not associated with any pricing component. Applicable if pricingComponent is NOT defined\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the amount of this AddChargeRequest. # noqa: E501 - :return: The amount of this AddChargeRequest. + + :return: The amount of this AddChargeRequest. # noqa: E501 :rtype: float """ return self._amount @amount.setter def amount(self, amount): - """ - Sets the amount of this AddChargeRequest. - {\"description\":\"Monetary amount for which to charge. Used only for ad-hoc charges i.e charges not associated with any pricing component. Applicable if pricingComponent is NOT defined\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the amount of this AddChargeRequest. - :param amount: The amount of this AddChargeRequest. + + :param amount: The amount of this AddChargeRequest. # noqa: E501 :type: float """ @@ -235,22 +280,20 @@ def amount(self, amount): @property def tax_amount(self): - """ - Gets the tax_amount of this AddChargeRequest. - {\"default\":false,\"description\":\"Applicable if amount is specified and indicates whether or not to apply tax in addition to the value specified.
true — Tax will be added on top of the nominal price specified in amount — in accordance with any taxation strategies you have defined.
false — No tax will be applied on top of the price specified in amount.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the tax_amount of this AddChargeRequest. # noqa: E501 - :return: The tax_amount of this AddChargeRequest. + + :return: The tax_amount of this AddChargeRequest. # noqa: E501 :rtype: bool """ return self._tax_amount @tax_amount.setter def tax_amount(self, tax_amount): - """ - Sets the tax_amount of this AddChargeRequest. - {\"default\":false,\"description\":\"Applicable if amount is specified and indicates whether or not to apply tax in addition to the value specified.
true — Tax will be added on top of the nominal price specified in amount — in accordance with any taxation strategies you have defined.
false — No tax will be applied on top of the price specified in amount.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the tax_amount of this AddChargeRequest. - :param tax_amount: The tax_amount of this AddChargeRequest. + + :param tax_amount: The tax_amount of this AddChargeRequest. # noqa: E501 :type: bool """ @@ -258,22 +301,20 @@ def tax_amount(self, tax_amount): @property def period_start(self): - """ - Gets the period_start of this AddChargeRequest. - {\"default\":\"Now\",\"description\":\"Start of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods. Pro-rating the price of pricingComponents purchased\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the period_start of this AddChargeRequest. # noqa: E501 - :return: The period_start of this AddChargeRequest. + + :return: The period_start of this AddChargeRequest. # noqa: E501 :rtype: datetime """ return self._period_start @period_start.setter def period_start(self, period_start): - """ - Sets the period_start of this AddChargeRequest. - {\"default\":\"Now\",\"description\":\"Start of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods. Pro-rating the price of pricingComponents purchased\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the period_start of this AddChargeRequest. - :param period_start: The period_start of this AddChargeRequest. + + :param period_start: The period_start of this AddChargeRequest. # noqa: E501 :type: datetime """ @@ -281,22 +322,20 @@ def period_start(self, period_start): @property def period_end(self): - """ - Gets the period_end of this AddChargeRequest. - {\"default\":\"(End of current period)\",\"description\":\"(Applicable only if `pricingComponent` is defined)
End of the interval to which the charge applies. Used in pro-rata calculation\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the period_end of this AddChargeRequest. # noqa: E501 + - :return: The period_end of this AddChargeRequest. + :return: The period_end of this AddChargeRequest. # noqa: E501 :rtype: datetime """ return self._period_end @period_end.setter def period_end(self, period_end): - """ - Sets the period_end of this AddChargeRequest. - {\"default\":\"(End of current period)\",\"description\":\"(Applicable only if `pricingComponent` is defined)
End of the interval to which the charge applies. Used in pro-rata calculation\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the period_end of this AddChargeRequest. + - :param period_end: The period_end of this AddChargeRequest. + :param period_end: The period_end of this AddChargeRequest. # noqa: E501 :type: datetime """ @@ -304,28 +343,26 @@ def period_end(self, period_end): @property def invoicing_type(self): - """ - Gets the invoicing_type of this AddChargeRequest. - {\"default\":\"Aggregated\",\"description\":\"Applicable if adding a charge to the subscription.
Immediate — Generate straight-away an invoice containing these charges.
Aggregated — Add these charges to the next invoice — for example the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the invoicing_type of this AddChargeRequest. # noqa: E501 + - :return: The invoicing_type of this AddChargeRequest. + :return: The invoicing_type of this AddChargeRequest. # noqa: E501 :rtype: str """ return self._invoicing_type @invoicing_type.setter def invoicing_type(self, invoicing_type): - """ - Sets the invoicing_type of this AddChargeRequest. - {\"default\":\"Aggregated\",\"description\":\"Applicable if adding a charge to the subscription.
Immediate — Generate straight-away an invoice containing these charges.
Aggregated — Add these charges to the next invoice — for example the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the invoicing_type of this AddChargeRequest. + - :param invoicing_type: The invoicing_type of this AddChargeRequest. + :param invoicing_type: The invoicing_type of this AddChargeRequest. # noqa: E501 :type: str """ - allowed_values = ["Immediate", "Aggregated"] + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 if invoicing_type not in allowed_values: raise ValueError( - "Invalid value for `invoicing_type` ({0}), must be one of {1}" + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 .format(invoicing_type, allowed_values) ) @@ -333,28 +370,26 @@ def invoicing_type(self, invoicing_type): @property def charge_type(self): - """ - Gets the charge_type of this AddChargeRequest. - {\"default\":\"Debit\",\"description\":\"Whether this charge represents an increase or decrease in invoice cost
Credit — This results in a reduction to the invoice cost
Debit — This will increase the invoice cost\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the charge_type of this AddChargeRequest. # noqa: E501 + - :return: The charge_type of this AddChargeRequest. + :return: The charge_type of this AddChargeRequest. # noqa: E501 :rtype: str """ return self._charge_type @charge_type.setter def charge_type(self, charge_type): - """ - Sets the charge_type of this AddChargeRequest. - {\"default\":\"Debit\",\"description\":\"Whether this charge represents an increase or decrease in invoice cost
Credit — This results in a reduction to the invoice cost
Debit — This will increase the invoice cost\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the charge_type of this AddChargeRequest. + - :param charge_type: The charge_type of this AddChargeRequest. + :param charge_type: The charge_type of this AddChargeRequest. # noqa: E501 :type: str """ - allowed_values = ["Credit", "Debit"] + allowed_values = ["Credit", "Debit"] # noqa: E501 if charge_type not in allowed_values: raise ValueError( - "Invalid value for `charge_type` ({0}), must be one of {1}" + "Invalid value for `charge_type` ({0}), must be one of {1}" # noqa: E501 .format(charge_type, allowed_values) ) @@ -362,22 +397,20 @@ def charge_type(self, charge_type): @property def trial(self): - """ - Gets the trial of this AddChargeRequest. - {\"default\":\"false\",\"description\":\"Whether the charge is meant in the context of a trial.
false — This is a non-trial charge, so funds will be sought from the customer.
true — This is a trial charge, soThe charge can be considered 'Paid' without taking any funds from the customer.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the trial of this AddChargeRequest. # noqa: E501 + - :return: The trial of this AddChargeRequest. + :return: The trial of this AddChargeRequest. # noqa: E501 :rtype: bool """ return self._trial @trial.setter def trial(self, trial): - """ - Sets the trial of this AddChargeRequest. - {\"default\":\"false\",\"description\":\"Whether the charge is meant in the context of a trial.
false — This is a non-trial charge, so funds will be sought from the customer.
true — This is a trial charge, soThe charge can be considered 'Paid' without taking any funds from the customer.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the trial of this AddChargeRequest. + - :param trial: The trial of this AddChargeRequest. + :param trial: The trial of this AddChargeRequest. # noqa: E501 :type: bool """ @@ -385,28 +418,28 @@ def trial(self, trial): @property def remaining_credit_behaviour(self): - """ - Gets the remaining_credit_behaviour of this AddChargeRequest. - {\"default\":\"Rollover\",\"description\":\"Defines the behaviour applied to any outstanding credit resulting from the application of the charge.
Rollover — Outstanding credit is returned to the accounts credit pool.
Discard — Outstanding credit is lost.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the remaining_credit_behaviour of this AddChargeRequest. # noqa: E501 + - :return: The remaining_credit_behaviour of this AddChargeRequest. + :return: The remaining_credit_behaviour of this AddChargeRequest. # noqa: E501 :rtype: str """ return self._remaining_credit_behaviour @remaining_credit_behaviour.setter def remaining_credit_behaviour(self, remaining_credit_behaviour): - """ - Sets the remaining_credit_behaviour of this AddChargeRequest. - {\"default\":\"Rollover\",\"description\":\"Defines the behaviour applied to any outstanding credit resulting from the application of the charge.
Rollover — Outstanding credit is returned to the accounts credit pool.
Discard — Outstanding credit is lost.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the remaining_credit_behaviour of this AddChargeRequest. - :param remaining_credit_behaviour: The remaining_credit_behaviour of this AddChargeRequest. + + :param remaining_credit_behaviour: The remaining_credit_behaviour of this AddChargeRequest. # noqa: E501 :type: str """ - allowed_values = ["Rollover", "Discard"] + if remaining_credit_behaviour is None: + raise ValueError("Invalid value for `remaining_credit_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["Rollover", "Discard"] # noqa: E501 if remaining_credit_behaviour not in allowed_values: raise ValueError( - "Invalid value for `remaining_credit_behaviour` ({0}), must be one of {1}" + "Invalid value for `remaining_credit_behaviour` ({0}), must be one of {1}" # noqa: E501 .format(remaining_credit_behaviour, allowed_values) ) @@ -414,22 +447,20 @@ def remaining_credit_behaviour(self, remaining_credit_behaviour): @property def pricing_component(self): - """ - Gets the pricing_component of this AddChargeRequest. - {\"description\":\"Specifies that this charge is for consumption of some quantity of this pricing component (whose name or ID can be provided).
If left blank:
The charge will be created as 'ad-hoc'. That is: a monetary lump sum, associated with no pricing component\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the pricing_component of this AddChargeRequest. # noqa: E501 - :return: The pricing_component of this AddChargeRequest. + + :return: The pricing_component of this AddChargeRequest. # noqa: E501 :rtype: str """ return self._pricing_component @pricing_component.setter def pricing_component(self, pricing_component): - """ - Sets the pricing_component of this AddChargeRequest. - {\"description\":\"Specifies that this charge is for consumption of some quantity of this pricing component (whose name or ID can be provided).
If left blank:
The charge will be created as 'ad-hoc'. That is: a monetary lump sum, associated with no pricing component\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the pricing_component of this AddChargeRequest. - :param pricing_component: The pricing_component of this AddChargeRequest. + + :param pricing_component: The pricing_component of this AddChargeRequest. # noqa: E501 :type: str """ @@ -437,22 +468,20 @@ def pricing_component(self, pricing_component): @property def pricing_component_value(self): - """ - Gets the pricing_component_value of this AddChargeRequest. - {\"description\":\"The value consumed of the pricing component which this charge concerns.Required if pricingComponent is defined\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the pricing_component_value of this AddChargeRequest. # noqa: E501 - :return: The pricing_component_value of this AddChargeRequest. + + :return: The pricing_component_value of this AddChargeRequest. # noqa: E501 :rtype: int """ return self._pricing_component_value @pricing_component_value.setter def pricing_component_value(self, pricing_component_value): - """ - Sets the pricing_component_value of this AddChargeRequest. - {\"description\":\"The value consumed of the pricing component which this charge concerns.Required if pricingComponent is defined\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the pricing_component_value of this AddChargeRequest. - :param pricing_component_value: The pricing_component_value of this AddChargeRequest. + + :param pricing_component_value: The pricing_component_value of this AddChargeRequest. # noqa: E501 :type: int """ @@ -460,34 +489,78 @@ def pricing_component_value(self, pricing_component_value): @property def dry_run(self): - """ - Gets the dry_run of this AddChargeRequest. - {\"default\":false,\"description\":\"Changes described in the response:
true — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.
false — Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the dry_run of this AddChargeRequest. # noqa: E501 - :return: The dry_run of this AddChargeRequest. + + :return: The dry_run of this AddChargeRequest. # noqa: E501 :rtype: bool """ return self._dry_run @dry_run.setter def dry_run(self, dry_run): - """ - Sets the dry_run of this AddChargeRequest. - {\"default\":false,\"description\":\"Changes described in the response:
true — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.
false — Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the dry_run of this AddChargeRequest. - :param dry_run: The dry_run of this AddChargeRequest. + + :param dry_run: The dry_run of this AddChargeRequest. # noqa: E501 :type: bool """ self._dry_run = dry_run - def to_dict(self): + @property + def invoice_state(self): + """Gets the invoice_state of this AddChargeRequest. # noqa: E501 + + + :return: The invoice_state of this AddChargeRequest. # noqa: E501 + :rtype: str + """ + return self._invoice_state + + @invoice_state.setter + def invoice_state(self, invoice_state): + """Sets the invoice_state of this AddChargeRequest. + + + :param invoice_state: The invoice_state of this AddChargeRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Paid", "Unpaid", "Pending", "Voided"] # noqa: E501 + if invoice_state not in allowed_values: + raise ValueError( + "Invalid value for `invoice_state` ({0}), must be one of {1}" # noqa: E501 + .format(invoice_state, allowed_values) + ) + + self._invoice_state = invoice_state + + @property + def void_on_failure(self): + """Gets the void_on_failure of this AddChargeRequest. # noqa: E501 + + + :return: The void_on_failure of this AddChargeRequest. # noqa: E501 + :rtype: bool """ - Returns the model properties as a dict + return self._void_on_failure + + @void_on_failure.setter + def void_on_failure(self, void_on_failure): + """Sets the void_on_failure of this AddChargeRequest. + + + :param void_on_failure: The void_on_failure of this AddChargeRequest. # noqa: E501 + :type: bool """ + + self._void_on_failure = void_on_failure + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -504,29 +577,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(AddChargeRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, AddChargeRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/add_charge_response.py b/billforward/models/add_charge_response.py new file mode 100644 index 0000000..f66c55e --- /dev/null +++ b/billforward/models/add_charge_response.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AddChargeResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'request': 'AddChargeRequest', + 'charges': 'list[SubscriptionCharge]', + 'invoice': 'Invoice', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'request': 'request', + 'charges': 'charges', + 'invoice': 'invoice', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, request=None, charges=None, invoice=None, organization_id=None): # noqa: E501 + """AddChargeResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._request = None + self._charges = None + self._invoice = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if request is not None: + self.request = request + if charges is not None: + self.charges = charges + if invoice is not None: + self.invoice = invoice + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this AddChargeResponse. # noqa: E501 + + + :return: The created of this AddChargeResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this AddChargeResponse. + + + :param created: The created of this AddChargeResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def request(self): + """Gets the request of this AddChargeResponse. # noqa: E501 + + + :return: The request of this AddChargeResponse. # noqa: E501 + :rtype: AddChargeRequest + """ + return self._request + + @request.setter + def request(self, request): + """Sets the request of this AddChargeResponse. + + + :param request: The request of this AddChargeResponse. # noqa: E501 + :type: AddChargeRequest + """ + + self._request = request + + @property + def charges(self): + """Gets the charges of this AddChargeResponse. # noqa: E501 + + + :return: The charges of this AddChargeResponse. # noqa: E501 + :rtype: list[SubscriptionCharge] + """ + return self._charges + + @charges.setter + def charges(self, charges): + """Sets the charges of this AddChargeResponse. + + + :param charges: The charges of this AddChargeResponse. # noqa: E501 + :type: list[SubscriptionCharge] + """ + + self._charges = charges + + @property + def invoice(self): + """Gets the invoice of this AddChargeResponse. # noqa: E501 + + + :return: The invoice of this AddChargeResponse. # noqa: E501 + :rtype: Invoice + """ + return self._invoice + + @invoice.setter + def invoice(self, invoice): + """Sets the invoice of this AddChargeResponse. + + + :param invoice: The invoice of this AddChargeResponse. # noqa: E501 + :type: Invoice + """ + + self._invoice = invoice + + @property + def organization_id(self): + """Gets the organization_id of this AddChargeResponse. # noqa: E501 + + + :return: The organization_id of this AddChargeResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AddChargeResponse. + + + :param organization_id: The organization_id of this AddChargeResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AddChargeResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AddChargeResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/add_charge_to_account_response.py b/billforward/models/add_charge_to_account_response.py new file mode 100644 index 0000000..aac24bb --- /dev/null +++ b/billforward/models/add_charge_to_account_response.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AddChargeToAccountResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'charges': 'list[SubscriptionCharge]', + 'invoice': 'Invoice', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'charges': 'charges', + 'invoice': 'invoice', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, charges=None, invoice=None, organization_id=None): # noqa: E501 + """AddChargeToAccountResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._charges = None + self._invoice = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if charges is not None: + self.charges = charges + if invoice is not None: + self.invoice = invoice + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this AddChargeToAccountResponse. # noqa: E501 + + + :return: The created of this AddChargeToAccountResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this AddChargeToAccountResponse. + + + :param created: The created of this AddChargeToAccountResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def charges(self): + """Gets the charges of this AddChargeToAccountResponse. # noqa: E501 + + + :return: The charges of this AddChargeToAccountResponse. # noqa: E501 + :rtype: list[SubscriptionCharge] + """ + return self._charges + + @charges.setter + def charges(self, charges): + """Sets the charges of this AddChargeToAccountResponse. + + + :param charges: The charges of this AddChargeToAccountResponse. # noqa: E501 + :type: list[SubscriptionCharge] + """ + + self._charges = charges + + @property + def invoice(self): + """Gets the invoice of this AddChargeToAccountResponse. # noqa: E501 + + + :return: The invoice of this AddChargeToAccountResponse. # noqa: E501 + :rtype: Invoice + """ + return self._invoice + + @invoice.setter + def invoice(self, invoice): + """Sets the invoice of this AddChargeToAccountResponse. + + + :param invoice: The invoice of this AddChargeToAccountResponse. # noqa: E501 + :type: Invoice + """ + + self._invoice = invoice + + @property + def organization_id(self): + """Gets the organization_id of this AddChargeToAccountResponse. # noqa: E501 + + + :return: The organization_id of this AddChargeToAccountResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AddChargeToAccountResponse. + + + :param organization_id: The organization_id of this AddChargeToAccountResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AddChargeToAccountResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AddChargeToAccountResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/add_charges_to_account_api_request.py b/billforward/models/add_charges_to_account_api_request.py new file mode 100644 index 0000000..06f2a39 --- /dev/null +++ b/billforward/models/add_charges_to_account_api_request.py @@ -0,0 +1,415 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AddChargesToAccountAPIRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'name': 'str', + 'purchase_order': 'str', + 'description': 'str', + 'currency': 'CreditNoteCurrency', + 'invoicing_type': 'str', + 'payment_terms': 'int', + 'remaining_credit_behaviour': 'str', + 'invoice_state': 'str', + 'charges': 'list[NestedChargeRequest]', + 'adhoc_charges': 'list[NestedAdhocChargeRequest]', + 'dry_run': 'bool' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'name': 'name', + 'purchase_order': 'purchaseOrder', + 'description': 'description', + 'currency': 'currency', + 'invoicing_type': 'invoicingType', + 'payment_terms': 'paymentTerms', + 'remaining_credit_behaviour': 'remainingCreditBehaviour', + 'invoice_state': 'invoiceState', + 'charges': 'charges', + 'adhoc_charges': 'adhocCharges', + 'dry_run': 'dryRun' + } + + def __init__(self, organization_id=None, name=None, purchase_order=None, description=None, currency=None, invoicing_type=None, payment_terms=None, remaining_credit_behaviour=None, invoice_state=None, charges=None, adhoc_charges=None, dry_run=None): # noqa: E501 + """AddChargesToAccountAPIRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._name = None + self._purchase_order = None + self._description = None + self._currency = None + self._invoicing_type = None + self._payment_terms = None + self._remaining_credit_behaviour = None + self._invoice_state = None + self._charges = None + self._adhoc_charges = None + self._dry_run = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if purchase_order is not None: + self.purchase_order = purchase_order + if description is not None: + self.description = description + if currency is not None: + self.currency = currency + if invoicing_type is not None: + self.invoicing_type = invoicing_type + if payment_terms is not None: + self.payment_terms = payment_terms + self.remaining_credit_behaviour = remaining_credit_behaviour + if invoice_state is not None: + self.invoice_state = invoice_state + if charges is not None: + self.charges = charges + if adhoc_charges is not None: + self.adhoc_charges = adhoc_charges + if dry_run is not None: + self.dry_run = dry_run + + @property + def organization_id(self): + """Gets the organization_id of this AddChargesToAccountAPIRequest. # noqa: E501 + + + :return: The organization_id of this AddChargesToAccountAPIRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AddChargesToAccountAPIRequest. + + + :param organization_id: The organization_id of this AddChargesToAccountAPIRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def name(self): + """Gets the name of this AddChargesToAccountAPIRequest. # noqa: E501 + + + :return: The name of this AddChargesToAccountAPIRequest. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this AddChargesToAccountAPIRequest. + + + :param name: The name of this AddChargesToAccountAPIRequest. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def purchase_order(self): + """Gets the purchase_order of this AddChargesToAccountAPIRequest. # noqa: E501 + + + :return: The purchase_order of this AddChargesToAccountAPIRequest. # noqa: E501 + :rtype: str + """ + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this AddChargesToAccountAPIRequest. + + + :param purchase_order: The purchase_order of this AddChargesToAccountAPIRequest. # noqa: E501 + :type: str + """ + + self._purchase_order = purchase_order + + @property + def description(self): + """Gets the description of this AddChargesToAccountAPIRequest. # noqa: E501 + + + :return: The description of this AddChargesToAccountAPIRequest. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this AddChargesToAccountAPIRequest. + + + :param description: The description of this AddChargesToAccountAPIRequest. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def currency(self): + """Gets the currency of this AddChargesToAccountAPIRequest. # noqa: E501 + + + :return: The currency of this AddChargesToAccountAPIRequest. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this AddChargesToAccountAPIRequest. + + + :param currency: The currency of this AddChargesToAccountAPIRequest. # noqa: E501 + :type: CreditNoteCurrency + """ + + self._currency = currency + + @property + def invoicing_type(self): + """Gets the invoicing_type of this AddChargesToAccountAPIRequest. # noqa: E501 + + + :return: The invoicing_type of this AddChargesToAccountAPIRequest. # noqa: E501 + :rtype: str + """ + return self._invoicing_type + + @invoicing_type.setter + def invoicing_type(self, invoicing_type): + """Sets the invoicing_type of this AddChargesToAccountAPIRequest. + + + :param invoicing_type: The invoicing_type of this AddChargesToAccountAPIRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 + if invoicing_type not in allowed_values: + raise ValueError( + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 + .format(invoicing_type, allowed_values) + ) + + self._invoicing_type = invoicing_type + + @property + def payment_terms(self): + """Gets the payment_terms of this AddChargesToAccountAPIRequest. # noqa: E501 + + + :return: The payment_terms of this AddChargesToAccountAPIRequest. # noqa: E501 + :rtype: int + """ + return self._payment_terms + + @payment_terms.setter + def payment_terms(self, payment_terms): + """Sets the payment_terms of this AddChargesToAccountAPIRequest. + + + :param payment_terms: The payment_terms of this AddChargesToAccountAPIRequest. # noqa: E501 + :type: int + """ + + self._payment_terms = payment_terms + + @property + def remaining_credit_behaviour(self): + """Gets the remaining_credit_behaviour of this AddChargesToAccountAPIRequest. # noqa: E501 + + + :return: The remaining_credit_behaviour of this AddChargesToAccountAPIRequest. # noqa: E501 + :rtype: str + """ + return self._remaining_credit_behaviour + + @remaining_credit_behaviour.setter + def remaining_credit_behaviour(self, remaining_credit_behaviour): + """Sets the remaining_credit_behaviour of this AddChargesToAccountAPIRequest. + + + :param remaining_credit_behaviour: The remaining_credit_behaviour of this AddChargesToAccountAPIRequest. # noqa: E501 + :type: str + """ + if remaining_credit_behaviour is None: + raise ValueError("Invalid value for `remaining_credit_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["Rollover", "Discard"] # noqa: E501 + if remaining_credit_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `remaining_credit_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(remaining_credit_behaviour, allowed_values) + ) + + self._remaining_credit_behaviour = remaining_credit_behaviour + + @property + def invoice_state(self): + """Gets the invoice_state of this AddChargesToAccountAPIRequest. # noqa: E501 + + + :return: The invoice_state of this AddChargesToAccountAPIRequest. # noqa: E501 + :rtype: str + """ + return self._invoice_state + + @invoice_state.setter + def invoice_state(self, invoice_state): + """Sets the invoice_state of this AddChargesToAccountAPIRequest. + + + :param invoice_state: The invoice_state of this AddChargesToAccountAPIRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Unpaid", "Pending"] # noqa: E501 + if invoice_state not in allowed_values: + raise ValueError( + "Invalid value for `invoice_state` ({0}), must be one of {1}" # noqa: E501 + .format(invoice_state, allowed_values) + ) + + self._invoice_state = invoice_state + + @property + def charges(self): + """Gets the charges of this AddChargesToAccountAPIRequest. # noqa: E501 + + + :return: The charges of this AddChargesToAccountAPIRequest. # noqa: E501 + :rtype: list[NestedChargeRequest] + """ + return self._charges + + @charges.setter + def charges(self, charges): + """Sets the charges of this AddChargesToAccountAPIRequest. + + + :param charges: The charges of this AddChargesToAccountAPIRequest. # noqa: E501 + :type: list[NestedChargeRequest] + """ + + self._charges = charges + + @property + def adhoc_charges(self): + """Gets the adhoc_charges of this AddChargesToAccountAPIRequest. # noqa: E501 + + + :return: The adhoc_charges of this AddChargesToAccountAPIRequest. # noqa: E501 + :rtype: list[NestedAdhocChargeRequest] + """ + return self._adhoc_charges + + @adhoc_charges.setter + def adhoc_charges(self, adhoc_charges): + """Sets the adhoc_charges of this AddChargesToAccountAPIRequest. + + + :param adhoc_charges: The adhoc_charges of this AddChargesToAccountAPIRequest. # noqa: E501 + :type: list[NestedAdhocChargeRequest] + """ + + self._adhoc_charges = adhoc_charges + + @property + def dry_run(self): + """Gets the dry_run of this AddChargesToAccountAPIRequest. # noqa: E501 + + + :return: The dry_run of this AddChargesToAccountAPIRequest. # noqa: E501 + :rtype: bool + """ + return self._dry_run + + @dry_run.setter + def dry_run(self, dry_run): + """Sets the dry_run of this AddChargesToAccountAPIRequest. + + + :param dry_run: The dry_run of this AddChargesToAccountAPIRequest. # noqa: E501 + :type: bool + """ + + self._dry_run = dry_run + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AddChargesToAccountAPIRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AddChargesToAccountAPIRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/add_contract_period_request.py b/billforward/models/add_contract_period_request.py new file mode 100644 index 0000000..c7c2111 --- /dev/null +++ b/billforward/models/add_contract_period_request.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AddContractPeriodRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'contract_period': 'int', + 'subscription_periods': 'int', + 'quote_id': 'str', + 'purchase_order': 'str' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'contract_period': 'contractPeriod', + 'subscription_periods': 'subscriptionPeriods', + 'quote_id': 'quoteID', + 'purchase_order': 'purchaseOrder' + } + + def __init__(self, organization_id=None, contract_period=None, subscription_periods=None, quote_id=None, purchase_order=None): # noqa: E501 + """AddContractPeriodRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._contract_period = None + self._subscription_periods = None + self._quote_id = None + self._purchase_order = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if contract_period is not None: + self.contract_period = contract_period + if subscription_periods is not None: + self.subscription_periods = subscription_periods + if quote_id is not None: + self.quote_id = quote_id + if purchase_order is not None: + self.purchase_order = purchase_order + + @property + def organization_id(self): + """Gets the organization_id of this AddContractPeriodRequest. # noqa: E501 + + + :return: The organization_id of this AddContractPeriodRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AddContractPeriodRequest. + + + :param organization_id: The organization_id of this AddContractPeriodRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def contract_period(self): + """Gets the contract_period of this AddContractPeriodRequest. # noqa: E501 + + + :return: The contract_period of this AddContractPeriodRequest. # noqa: E501 + :rtype: int + """ + return self._contract_period + + @contract_period.setter + def contract_period(self, contract_period): + """Sets the contract_period of this AddContractPeriodRequest. + + + :param contract_period: The contract_period of this AddContractPeriodRequest. # noqa: E501 + :type: int + """ + + self._contract_period = contract_period + + @property + def subscription_periods(self): + """Gets the subscription_periods of this AddContractPeriodRequest. # noqa: E501 + + + :return: The subscription_periods of this AddContractPeriodRequest. # noqa: E501 + :rtype: int + """ + return self._subscription_periods + + @subscription_periods.setter + def subscription_periods(self, subscription_periods): + """Sets the subscription_periods of this AddContractPeriodRequest. + + + :param subscription_periods: The subscription_periods of this AddContractPeriodRequest. # noqa: E501 + :type: int + """ + + self._subscription_periods = subscription_periods + + @property + def quote_id(self): + """Gets the quote_id of this AddContractPeriodRequest. # noqa: E501 + + + :return: The quote_id of this AddContractPeriodRequest. # noqa: E501 + :rtype: str + """ + return self._quote_id + + @quote_id.setter + def quote_id(self, quote_id): + """Sets the quote_id of this AddContractPeriodRequest. + + + :param quote_id: The quote_id of this AddContractPeriodRequest. # noqa: E501 + :type: str + """ + + self._quote_id = quote_id + + @property + def purchase_order(self): + """Gets the purchase_order of this AddContractPeriodRequest. # noqa: E501 + + + :return: The purchase_order of this AddContractPeriodRequest. # noqa: E501 + :rtype: str + """ + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this AddContractPeriodRequest. + + + :param purchase_order: The purchase_order of this AddContractPeriodRequest. # noqa: E501 + :type: str + """ + + self._purchase_order = purchase_order + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AddContractPeriodRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AddContractPeriodRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/add_coupon_code_request.py b/billforward/models/add_coupon_code_request.py index 5974672..dcaee7b 100644 --- a/billforward/models/add_coupon_code_request.py +++ b/billforward/models/add_coupon_code_request.py @@ -1,82 +1,83 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class AddCouponCodeRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, organization_id=None, coupon_code=None): - """ - AddCouponCodeRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'organization_id': 'str', - 'coupon_code': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'organization_id': 'organizationID', - 'coupon_code': 'couponCode' - } - - self._created = created - self._changed_by = changed_by - self._organization_id = organization_id - self._coupon_code = coupon_code + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'organization_id': 'str', + 'coupon_code': 'str', + 'id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'organization_id': 'organizationID', + 'coupon_code': 'couponCode', + 'id': 'id' + } + + def __init__(self, created=None, changed_by=None, organization_id=None, coupon_code=None, id=None): # noqa: E501 + """AddCouponCodeRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._organization_id = None + self._coupon_code = None + self._id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if organization_id is not None: + self.organization_id = organization_id + if coupon_code is not None: + self.coupon_code = coupon_code + if id is not None: + self.id = id @property def created(self): - """ - Gets the created of this AddCouponCodeRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this AddCouponCodeRequest. # noqa: E501 + - :return: The created of this AddCouponCodeRequest. + :return: The created of this AddCouponCodeRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this AddCouponCodeRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this AddCouponCodeRequest. + - :param created: The created of this AddCouponCodeRequest. + :param created: The created of this AddCouponCodeRequest. # noqa: E501 :type: datetime """ @@ -84,22 +85,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this AddCouponCodeRequest. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this AddCouponCodeRequest. # noqa: E501 - :return: The changed_by of this AddCouponCodeRequest. + + :return: The changed_by of this AddCouponCodeRequest. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this AddCouponCodeRequest. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this AddCouponCodeRequest. + - :param changed_by: The changed_by of this AddCouponCodeRequest. + :param changed_by: The changed_by of this AddCouponCodeRequest. # noqa: E501 :type: str """ @@ -107,22 +106,20 @@ def changed_by(self, changed_by): @property def organization_id(self): - """ - Gets the organization_id of this AddCouponCodeRequest. - { \"description\" : \"\", \"verbs\":[\"POST\"]} + """Gets the organization_id of this AddCouponCodeRequest. # noqa: E501 + - :return: The organization_id of this AddCouponCodeRequest. + :return: The organization_id of this AddCouponCodeRequest. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this AddCouponCodeRequest. - { \"description\" : \"\", \"verbs\":[\"POST\"]} + """Sets the organization_id of this AddCouponCodeRequest. - :param organization_id: The organization_id of this AddCouponCodeRequest. + + :param organization_id: The organization_id of this AddCouponCodeRequest. # noqa: E501 :type: str """ @@ -130,34 +127,51 @@ def organization_id(self, organization_id): @property def coupon_code(self): - """ - Gets the coupon_code of this AddCouponCodeRequest. - { \"description\" : \"The couponCode can be either a unique code or the master code of a coupon.\", \"verbs\":[\"POST\"]} + """Gets the coupon_code of this AddCouponCodeRequest. # noqa: E501 - :return: The coupon_code of this AddCouponCodeRequest. + + :return: The coupon_code of this AddCouponCodeRequest. # noqa: E501 :rtype: str """ return self._coupon_code @coupon_code.setter def coupon_code(self, coupon_code): - """ - Sets the coupon_code of this AddCouponCodeRequest. - { \"description\" : \"The couponCode can be either a unique code or the master code of a coupon.\", \"verbs\":[\"POST\"]} + """Sets the coupon_code of this AddCouponCodeRequest. - :param coupon_code: The coupon_code of this AddCouponCodeRequest. + + :param coupon_code: The coupon_code of this AddCouponCodeRequest. # noqa: E501 :type: str """ self._coupon_code = coupon_code - def to_dict(self): + @property + def id(self): + """Gets the id of this AddCouponCodeRequest. # noqa: E501 + + + :return: The id of this AddCouponCodeRequest. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._id + + @id.setter + def id(self, id): + """Sets the id of this AddCouponCodeRequest. + + + :param id: The id of this AddCouponCodeRequest. # noqa: E501 + :type: str """ + + self._id = id + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -174,29 +188,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(AddCouponCodeRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, AddCouponCodeRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/add_payment_method_request.py b/billforward/models/add_payment_method_request.py index 8a55298..a68d7a4 100644 --- a/billforward/models/add_payment_method_request.py +++ b/billforward/models/add_payment_method_request.py @@ -1,85 +1,151 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class AddPaymentMethodRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, id=None): + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'organization_id': 'str', + 'id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'organization_id': 'organizationID', + 'id': 'id' + } + + def __init__(self, created=None, changed_by=None, organization_id=None, id=None): # noqa: E501 + """AddPaymentMethodRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._organization_id = None + self._id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if organization_id is not None: + self.organization_id = organization_id + if id is not None: + self.id = id + + @property + def created(self): + """Gets the created of this AddPaymentMethodRequest. # noqa: E501 + + + :return: The created of this AddPaymentMethodRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this AddPaymentMethodRequest. + + + :param created: The created of this AddPaymentMethodRequest. # noqa: E501 + :type: datetime """ - AddPaymentMethodRequest - a model defined in Swagger - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this AddPaymentMethodRequest. # noqa: E501 + + + :return: The changed_by of this AddPaymentMethodRequest. # noqa: E501 + :rtype: str """ - self.swagger_types = { - 'id': 'str' - } + return self._changed_by - self.attribute_map = { - 'id': 'id' - } + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this AddPaymentMethodRequest. - self._id = id + + :param changed_by: The changed_by of this AddPaymentMethodRequest. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by @property - def id(self): + def organization_id(self): + """Gets the organization_id of this AddPaymentMethodRequest. # noqa: E501 + + + :return: The organization_id of this AddPaymentMethodRequest. # noqa: E501 + :rtype: str """ - Gets the id of this AddPaymentMethodRequest. - { \"description\" : \"ID of the payment method to add\", \"verbs\":[\"POST\",\"GET\"] } + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AddPaymentMethodRequest. + + + :param organization_id: The organization_id of this AddPaymentMethodRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def id(self): + """Gets the id of this AddPaymentMethodRequest. # noqa: E501 + - :return: The id of this AddPaymentMethodRequest. + :return: The id of this AddPaymentMethodRequest. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this AddPaymentMethodRequest. - { \"description\" : \"ID of the payment method to add\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the id of this AddPaymentMethodRequest. + - :param id: The id of this AddPaymentMethodRequest. + :param id: The id of this AddPaymentMethodRequest. # noqa: E501 :type: str """ self._id = id def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -96,29 +162,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(AddPaymentMethodRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, AddPaymentMethodRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/add_taxation_strategy_request.py b/billforward/models/add_taxation_strategy_request.py deleted file mode 100644 index 12513da..0000000 --- a/billforward/models/add_taxation_strategy_request.py +++ /dev/null @@ -1,202 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class AddTaxationStrategyRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, organization_id=None, id=None): - """ - AddTaxationStrategyRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'organization_id': 'str', - 'id': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'organization_id': 'organizationID', - 'id': 'id' - } - - self._created = created - self._changed_by = changed_by - self._organization_id = organization_id - self._id = id - - @property - def created(self): - """ - Gets the created of this AddTaxationStrategyRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this AddTaxationStrategyRequest. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this AddTaxationStrategyRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this AddTaxationStrategyRequest. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this AddTaxationStrategyRequest. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this AddTaxationStrategyRequest. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this AddTaxationStrategyRequest. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this AddTaxationStrategyRequest. - :type: str - """ - - self._changed_by = changed_by - - @property - def organization_id(self): - """ - Gets the organization_id of this AddTaxationStrategyRequest. - { \"description\" : \"\", \"verbs\":[] } - - :return: The organization_id of this AddTaxationStrategyRequest. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this AddTaxationStrategyRequest. - { \"description\" : \"\", \"verbs\":[] } - - :param organization_id: The organization_id of this AddTaxationStrategyRequest. - :type: str - """ - - self._organization_id = organization_id - - @property - def id(self): - """ - Gets the id of this AddTaxationStrategyRequest. - { \"description\" : \"ID of the taxation strategy to add\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The id of this AddTaxationStrategyRequest. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this AddTaxationStrategyRequest. - { \"description\" : \"ID of the taxation strategy to add\", \"verbs\":[\"POST\",\"GET\"] } - - :param id: The id of this AddTaxationStrategyRequest. - :type: str - """ - - self._id = id - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/additional_data.py b/billforward/models/additional_data.py new file mode 100644 index 0000000..a29f7b8 --- /dev/null +++ b/billforward/models/additional_data.py @@ -0,0 +1,119 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AdditionalData(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'type': 'str' + } + + attribute_map = { + 'type': '@type' + } + + discriminator_value_class_map = { + 'StripeAdditionalData': 'StripeAdditionalData' } + + def __init__(self, type=None): # noqa: E501 + """AdditionalData - a model defined in Swagger""" # noqa: E501 + self._type = None + self.discriminator = '@type' + self.type = type + + @property + def type(self): + """Gets the type of this AdditionalData. # noqa: E501 + + + :return: The type of this AdditionalData. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this AdditionalData. + + + :param type: The type of this AdditionalData. # noqa: E501 + :type: str + """ + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + + self._type = type + + def get_real_child_model(self, data): + """Returns the real base class specified by the discriminator""" + discriminator_value = data[self.discriminator].lower() + return self.discriminator_value_class_map.get(discriminator_value) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AdditionalData, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AdditionalData): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/address.py b/billforward/models/address.py index 42a4608..77f1e81 100644 --- a/billforward/models/address.py +++ b/billforward/models/address.py @@ -1,118 +1,148 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class Address(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, profile_id=None, organization_id=None, address_line1=None, address_line2=None, address_line3=None, city=None, province=None, country=None, postcode=None, landline=None, primary_address=False, deleted=False): - """ - Address - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'profile_id': 'str', - 'organization_id': 'str', - 'address_line1': 'str', - 'address_line2': 'str', - 'address_line3': 'str', - 'city': 'str', - 'province': 'str', - 'country': 'str', - 'postcode': 'str', - 'landline': 'str', - 'primary_address': 'bool', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'profile_id': 'profileID', - 'organization_id': 'organizationID', - 'address_line1': 'addressLine1', - 'address_line2': 'addressLine2', - 'address_line3': 'addressLine3', - 'city': 'city', - 'province': 'province', - 'country': 'country', - 'postcode': 'postcode', - 'landline': 'landline', - 'primary_address': 'primaryAddress', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._profile_id = profile_id - self._organization_id = organization_id - self._address_line1 = address_line1 - self._address_line2 = address_line2 - self._address_line3 = address_line3 - self._city = city - self._province = province - self._country = country - self._postcode = postcode - self._landline = landline - self._primary_address = primary_address - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'profile_id': 'str', + 'organization_id': 'str', + 'address_line1': 'str', + 'address_line2': 'str', + 'address_line3': 'str', + 'city': 'str', + 'province': 'str', + 'country': 'str', + 'postcode': 'str', + 'landline': 'str', + 'primary_address': 'bool', + 'primary_shipping_address': 'bool', + 'deleted': 'bool', + 'validated': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'profile_id': 'profileID', + 'organization_id': 'organizationID', + 'address_line1': 'addressLine1', + 'address_line2': 'addressLine2', + 'address_line3': 'addressLine3', + 'city': 'city', + 'province': 'province', + 'country': 'country', + 'postcode': 'postcode', + 'landline': 'landline', + 'primary_address': 'primaryAddress', + 'primary_shipping_address': 'primaryShippingAddress', + 'deleted': 'deleted', + 'validated': 'validated' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, profile_id=None, organization_id=None, address_line1=None, address_line2=None, address_line3=None, city=None, province=None, country=None, postcode=None, landline=None, primary_address=None, primary_shipping_address=None, deleted=None, validated=None): # noqa: E501 + """Address - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._profile_id = None + self._organization_id = None + self._address_line1 = None + self._address_line2 = None + self._address_line3 = None + self._city = None + self._province = None + self._country = None + self._postcode = None + self._landline = None + self._primary_address = None + self._primary_shipping_address = None + self._deleted = None + self._validated = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if profile_id is not None: + self.profile_id = profile_id + if organization_id is not None: + self.organization_id = organization_id + if address_line1 is not None: + self.address_line1 = address_line1 + if address_line2 is not None: + self.address_line2 = address_line2 + if address_line3 is not None: + self.address_line3 = address_line3 + if city is not None: + self.city = city + if province is not None: + self.province = province + if country is not None: + self.country = country + if postcode is not None: + self.postcode = postcode + if landline is not None: + self.landline = landline + if primary_address is not None: + self.primary_address = primary_address + if primary_shipping_address is not None: + self.primary_shipping_address = primary_shipping_address + if deleted is not None: + self.deleted = deleted + if validated is not None: + self.validated = validated @property def created(self): - """ - Gets the created of this Address. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this Address. # noqa: E501 + - :return: The created of this Address. + :return: The created of this Address. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this Address. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this Address. + - :param created: The created of this Address. + :param created: The created of this Address. # noqa: E501 :type: datetime """ @@ -120,22 +150,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this Address. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this Address. # noqa: E501 + - :return: The changed_by of this Address. + :return: The changed_by of this Address. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this Address. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this Address. - :param changed_by: The changed_by of this Address. + + :param changed_by: The changed_by of this Address. # noqa: E501 :type: str """ @@ -143,22 +171,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this Address. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this Address. # noqa: E501 - :return: The updated of this Address. + + :return: The updated of this Address. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this Address. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this Address. - :param updated: The updated of this Address. + + :param updated: The updated of this Address. # noqa: E501 :type: datetime """ @@ -166,22 +192,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this Address. - { \"description\" : \"\", \"verbs\":[\"PUT\",\"GET\"] } + """Gets the id of this Address. # noqa: E501 - :return: The id of this Address. + + :return: The id of this Address. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this Address. - { \"description\" : \"\", \"verbs\":[\"PUT\",\"GET\"] } + """Sets the id of this Address. - :param id: The id of this Address. + + :param id: The id of this Address. # noqa: E501 :type: str """ @@ -189,22 +213,20 @@ def id(self, id): @property def profile_id(self): - """ - Gets the profile_id of this Address. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the profile_id of this Address. # noqa: E501 - :return: The profile_id of this Address. + + :return: The profile_id of this Address. # noqa: E501 :rtype: str """ return self._profile_id @profile_id.setter def profile_id(self, profile_id): - """ - Sets the profile_id of this Address. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the profile_id of this Address. - :param profile_id: The profile_id of this Address. + + :param profile_id: The profile_id of this Address. # noqa: E501 :type: str """ @@ -212,22 +234,20 @@ def profile_id(self, profile_id): @property def organization_id(self): - """ - Gets the organization_id of this Address. - { \"description\" : \"\", \"verbs\":[] } + """Gets the organization_id of this Address. # noqa: E501 + - :return: The organization_id of this Address. + :return: The organization_id of this Address. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this Address. - { \"description\" : \"\", \"verbs\":[] } + """Sets the organization_id of this Address. + - :param organization_id: The organization_id of this Address. + :param organization_id: The organization_id of this Address. # noqa: E501 :type: str """ @@ -235,22 +255,20 @@ def organization_id(self, organization_id): @property def address_line1(self): - """ - Gets the address_line1 of this Address. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the address_line1 of this Address. # noqa: E501 + - :return: The address_line1 of this Address. + :return: The address_line1 of this Address. # noqa: E501 :rtype: str """ return self._address_line1 @address_line1.setter def address_line1(self, address_line1): - """ - Sets the address_line1 of this Address. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the address_line1 of this Address. + - :param address_line1: The address_line1 of this Address. + :param address_line1: The address_line1 of this Address. # noqa: E501 :type: str """ @@ -258,22 +276,20 @@ def address_line1(self, address_line1): @property def address_line2(self): - """ - Gets the address_line2 of this Address. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the address_line2 of this Address. # noqa: E501 + - :return: The address_line2 of this Address. + :return: The address_line2 of this Address. # noqa: E501 :rtype: str """ return self._address_line2 @address_line2.setter def address_line2(self, address_line2): - """ - Sets the address_line2 of this Address. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the address_line2 of this Address. + - :param address_line2: The address_line2 of this Address. + :param address_line2: The address_line2 of this Address. # noqa: E501 :type: str """ @@ -281,22 +297,20 @@ def address_line2(self, address_line2): @property def address_line3(self): - """ - Gets the address_line3 of this Address. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the address_line3 of this Address. # noqa: E501 + - :return: The address_line3 of this Address. + :return: The address_line3 of this Address. # noqa: E501 :rtype: str """ return self._address_line3 @address_line3.setter def address_line3(self, address_line3): - """ - Sets the address_line3 of this Address. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the address_line3 of this Address. + - :param address_line3: The address_line3 of this Address. + :param address_line3: The address_line3 of this Address. # noqa: E501 :type: str """ @@ -304,22 +318,20 @@ def address_line3(self, address_line3): @property def city(self): - """ - Gets the city of this Address. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the city of this Address. # noqa: E501 - :return: The city of this Address. + + :return: The city of this Address. # noqa: E501 :rtype: str """ return self._city @city.setter def city(self, city): - """ - Sets the city of this Address. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the city of this Address. - :param city: The city of this Address. + + :param city: The city of this Address. # noqa: E501 :type: str """ @@ -327,22 +339,20 @@ def city(self, city): @property def province(self): - """ - Gets the province of this Address. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the province of this Address. # noqa: E501 - :return: The province of this Address. + + :return: The province of this Address. # noqa: E501 :rtype: str """ return self._province @province.setter def province(self, province): - """ - Sets the province of this Address. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the province of this Address. - :param province: The province of this Address. + + :param province: The province of this Address. # noqa: E501 :type: str """ @@ -350,22 +360,20 @@ def province(self, province): @property def country(self): - """ - Gets the country of this Address. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the country of this Address. # noqa: E501 - :return: The country of this Address. + + :return: The country of this Address. # noqa: E501 :rtype: str """ return self._country @country.setter def country(self, country): - """ - Sets the country of this Address. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the country of this Address. - :param country: The country of this Address. + + :param country: The country of this Address. # noqa: E501 :type: str """ @@ -373,22 +381,20 @@ def country(self, country): @property def postcode(self): - """ - Gets the postcode of this Address. - { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the postcode of this Address. # noqa: E501 - :return: The postcode of this Address. + + :return: The postcode of this Address. # noqa: E501 :rtype: str """ return self._postcode @postcode.setter def postcode(self, postcode): - """ - Sets the postcode of this Address. - { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the postcode of this Address. + - :param postcode: The postcode of this Address. + :param postcode: The postcode of this Address. # noqa: E501 :type: str """ @@ -396,22 +402,20 @@ def postcode(self, postcode): @property def landline(self): - """ - Gets the landline of this Address. - { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the landline of this Address. # noqa: E501 + - :return: The landline of this Address. + :return: The landline of this Address. # noqa: E501 :rtype: str """ return self._landline @landline.setter def landline(self, landline): - """ - Sets the landline of this Address. - { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the landline of this Address. + - :param landline: The landline of this Address. + :param landline: The landline of this Address. # noqa: E501 :type: str """ @@ -419,57 +423,93 @@ def landline(self, landline): @property def primary_address(self): - """ - Gets the primary_address of this Address. - { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the primary_address of this Address. # noqa: E501 + - :return: The primary_address of this Address. + :return: The primary_address of this Address. # noqa: E501 :rtype: bool """ return self._primary_address @primary_address.setter def primary_address(self, primary_address): - """ - Sets the primary_address of this Address. - { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the primary_address of this Address. + - :param primary_address: The primary_address of this Address. + :param primary_address: The primary_address of this Address. # noqa: E501 :type: bool """ self._primary_address = primary_address @property - def deleted(self): + def primary_shipping_address(self): + """Gets the primary_shipping_address of this Address. # noqa: E501 + + + :return: The primary_shipping_address of this Address. # noqa: E501 + :rtype: bool + """ + return self._primary_shipping_address + + @primary_shipping_address.setter + def primary_shipping_address(self, primary_shipping_address): + """Sets the primary_shipping_address of this Address. + + + :param primary_shipping_address: The primary_shipping_address of this Address. # noqa: E501 + :type: bool """ - Gets the deleted of this Address. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - :return: The deleted of this Address. + self._primary_shipping_address = primary_shipping_address + + @property + def deleted(self): + """Gets the deleted of this Address. # noqa: E501 + + + :return: The deleted of this Address. # noqa: E501 :rtype: bool """ return self._deleted @deleted.setter def deleted(self, deleted): - """ - Sets the deleted of this Address. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the deleted of this Address. - :param deleted: The deleted of this Address. + + :param deleted: The deleted of this Address. # noqa: E501 :type: bool """ self._deleted = deleted - def to_dict(self): + @property + def validated(self): + """Gets the validated of this Address. # noqa: E501 + + + :return: The validated of this Address. # noqa: E501 + :rtype: bool """ - Returns the model properties as a dict + return self._validated + + @validated.setter + def validated(self, validated): + """Sets the validated of this Address. + + + :param validated: The validated of this Address. # noqa: E501 + :type: bool """ + + self._validated = validated + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -486,29 +526,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Address, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Address): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/address_paged_metadata.py b/billforward/models/address_paged_metadata.py deleted file mode 100644 index 9f37afa..0000000 --- a/billforward/models/address_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class AddressPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - AddressPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Address]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this AddressPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this AddressPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this AddressPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this AddressPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this AddressPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this AddressPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this AddressPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this AddressPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this AddressPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this AddressPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this AddressPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this AddressPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this AddressPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this AddressPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this AddressPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this AddressPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this AddressPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this AddressPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this AddressPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this AddressPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this AddressPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this AddressPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this AddressPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this AddressPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this AddressPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this AddressPagedMetadata. - :rtype: list[Address] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this AddressPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this AddressPagedMetadata. - :type: list[Address] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/advance_pricing_components_by_charge_model.py b/billforward/models/advance_pricing_components_by_charge_model.py new file mode 100644 index 0000000..885564a --- /dev/null +++ b/billforward/models/advance_pricing_components_by_charge_model.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AdvancePricingComponentsByChargeModel(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'flat': 'list[FlatAdvancePricingComponent]', + 'tiered': 'list[TieredAdvancePricingComponent]', + 'volume': 'list[TieredAdvancePricingComponent]' + } + + attribute_map = { + 'flat': 'flat', + 'tiered': 'tiered', + 'volume': 'volume' + } + + def __init__(self, flat=None, tiered=None, volume=None): # noqa: E501 + """AdvancePricingComponentsByChargeModel - a model defined in Swagger""" # noqa: E501 + self._flat = None + self._tiered = None + self._volume = None + self.discriminator = None + if flat is not None: + self.flat = flat + if tiered is not None: + self.tiered = tiered + if volume is not None: + self.volume = volume + + @property + def flat(self): + """Gets the flat of this AdvancePricingComponentsByChargeModel. # noqa: E501 + + + :return: The flat of this AdvancePricingComponentsByChargeModel. # noqa: E501 + :rtype: list[FlatAdvancePricingComponent] + """ + return self._flat + + @flat.setter + def flat(self, flat): + """Sets the flat of this AdvancePricingComponentsByChargeModel. + + + :param flat: The flat of this AdvancePricingComponentsByChargeModel. # noqa: E501 + :type: list[FlatAdvancePricingComponent] + """ + + self._flat = flat + + @property + def tiered(self): + """Gets the tiered of this AdvancePricingComponentsByChargeModel. # noqa: E501 + + + :return: The tiered of this AdvancePricingComponentsByChargeModel. # noqa: E501 + :rtype: list[TieredAdvancePricingComponent] + """ + return self._tiered + + @tiered.setter + def tiered(self, tiered): + """Sets the tiered of this AdvancePricingComponentsByChargeModel. + + + :param tiered: The tiered of this AdvancePricingComponentsByChargeModel. # noqa: E501 + :type: list[TieredAdvancePricingComponent] + """ + + self._tiered = tiered + + @property + def volume(self): + """Gets the volume of this AdvancePricingComponentsByChargeModel. # noqa: E501 + + + :return: The volume of this AdvancePricingComponentsByChargeModel. # noqa: E501 + :rtype: list[TieredAdvancePricingComponent] + """ + return self._volume + + @volume.setter + def volume(self, volume): + """Sets the volume of this AdvancePricingComponentsByChargeModel. + + + :param volume: The volume of this AdvancePricingComponentsByChargeModel. # noqa: E501 + :type: list[TieredAdvancePricingComponent] + """ + + self._volume = volume + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AdvancePricingComponentsByChargeModel, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AdvancePricingComponentsByChargeModel): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/affiliate.py b/billforward/models/affiliate.py new file mode 100644 index 0000000..62733df --- /dev/null +++ b/billforward/models/affiliate.py @@ -0,0 +1,344 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class Affiliate(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'name': 'str', + 'account_id': 'str', + 'affiliate_subscription_relationships': 'list[AffiliateSubscriptionRelationship]', + 'affiliate_rate_plan_relationships': 'list[AffiliateRatePlanRelationships]', + 'accumulated_commissions': 'dict(str, float)' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'name': 'name', + 'account_id': 'accountID', + 'affiliate_subscription_relationships': 'affiliateSubscriptionRelationships', + 'affiliate_rate_plan_relationships': 'affiliateRatePlanRelationships', + 'accumulated_commissions': 'accumulatedCommissions' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, name=None, account_id=None, affiliate_subscription_relationships=None, affiliate_rate_plan_relationships=None, accumulated_commissions=None): # noqa: E501 + """Affiliate - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._name = None + self._account_id = None + self._affiliate_subscription_relationships = None + self._affiliate_rate_plan_relationships = None + self._accumulated_commissions = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if account_id is not None: + self.account_id = account_id + if affiliate_subscription_relationships is not None: + self.affiliate_subscription_relationships = affiliate_subscription_relationships + if affiliate_rate_plan_relationships is not None: + self.affiliate_rate_plan_relationships = affiliate_rate_plan_relationships + if accumulated_commissions is not None: + self.accumulated_commissions = accumulated_commissions + + @property + def created(self): + """Gets the created of this Affiliate. # noqa: E501 + + + :return: The created of this Affiliate. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this Affiliate. + + + :param created: The created of this Affiliate. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this Affiliate. # noqa: E501 + + + :return: The changed_by of this Affiliate. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this Affiliate. + + + :param changed_by: The changed_by of this Affiliate. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this Affiliate. # noqa: E501 + + + :return: The updated of this Affiliate. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this Affiliate. + + + :param updated: The updated of this Affiliate. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this Affiliate. # noqa: E501 + + + :return: The id of this Affiliate. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this Affiliate. + + + :param id: The id of this Affiliate. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this Affiliate. # noqa: E501 + + + :return: The organization_id of this Affiliate. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this Affiliate. + + + :param organization_id: The organization_id of this Affiliate. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def name(self): + """Gets the name of this Affiliate. # noqa: E501 + + + :return: The name of this Affiliate. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this Affiliate. + + + :param name: The name of this Affiliate. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def account_id(self): + """Gets the account_id of this Affiliate. # noqa: E501 + + + :return: The account_id of this Affiliate. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this Affiliate. + + + :param account_id: The account_id of this Affiliate. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def affiliate_subscription_relationships(self): + """Gets the affiliate_subscription_relationships of this Affiliate. # noqa: E501 + + + :return: The affiliate_subscription_relationships of this Affiliate. # noqa: E501 + :rtype: list[AffiliateSubscriptionRelationship] + """ + return self._affiliate_subscription_relationships + + @affiliate_subscription_relationships.setter + def affiliate_subscription_relationships(self, affiliate_subscription_relationships): + """Sets the affiliate_subscription_relationships of this Affiliate. + + + :param affiliate_subscription_relationships: The affiliate_subscription_relationships of this Affiliate. # noqa: E501 + :type: list[AffiliateSubscriptionRelationship] + """ + + self._affiliate_subscription_relationships = affiliate_subscription_relationships + + @property + def affiliate_rate_plan_relationships(self): + """Gets the affiliate_rate_plan_relationships of this Affiliate. # noqa: E501 + + + :return: The affiliate_rate_plan_relationships of this Affiliate. # noqa: E501 + :rtype: list[AffiliateRatePlanRelationships] + """ + return self._affiliate_rate_plan_relationships + + @affiliate_rate_plan_relationships.setter + def affiliate_rate_plan_relationships(self, affiliate_rate_plan_relationships): + """Sets the affiliate_rate_plan_relationships of this Affiliate. + + + :param affiliate_rate_plan_relationships: The affiliate_rate_plan_relationships of this Affiliate. # noqa: E501 + :type: list[AffiliateRatePlanRelationships] + """ + + self._affiliate_rate_plan_relationships = affiliate_rate_plan_relationships + + @property + def accumulated_commissions(self): + """Gets the accumulated_commissions of this Affiliate. # noqa: E501 + + + :return: The accumulated_commissions of this Affiliate. # noqa: E501 + :rtype: dict(str, float) + """ + return self._accumulated_commissions + + @accumulated_commissions.setter + def accumulated_commissions(self, accumulated_commissions): + """Sets the accumulated_commissions of this Affiliate. + + + :param accumulated_commissions: The accumulated_commissions of this Affiliate. # noqa: E501 + :type: dict(str, float) + """ + + self._accumulated_commissions = accumulated_commissions + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(Affiliate, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, Affiliate): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/affiliate_commission_charge.py b/billforward/models/affiliate_commission_charge.py new file mode 100644 index 0000000..5af4dac --- /dev/null +++ b/billforward/models/affiliate_commission_charge.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.subscription_charge import SubscriptionCharge # noqa: F401,E501 + +class AffiliateCommissionCharge(SubscriptionCharge): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'affiliate_id': 'str', + 'commission_invoice_id': 'str', + 'raw_commission_structure': 'str' + } + if hasattr(SubscriptionCharge, "swagger_types"): + swagger_types.update(SubscriptionCharge.swagger_types) + + attribute_map = { + 'affiliate_id': 'affiliateID', + 'commission_invoice_id': 'commissionInvoiceID', + 'raw_commission_structure': 'rawCommissionStructure' + } + if hasattr(SubscriptionCharge, "attribute_map"): + attribute_map.update(SubscriptionCharge.attribute_map) + + def __init__(self, affiliate_id=None, commission_invoice_id=None, raw_commission_structure=None, *args, **kwargs): # noqa: E501 + """AffiliateCommissionCharge - a model defined in Swagger""" # noqa: E501 + self._affiliate_id = None + self._commission_invoice_id = None + self._raw_commission_structure = None + self.discriminator = None + if affiliate_id is not None: + self.affiliate_id = affiliate_id + if commission_invoice_id is not None: + self.commission_invoice_id = commission_invoice_id + if raw_commission_structure is not None: + self.raw_commission_structure = raw_commission_structure + SubscriptionCharge.__init__(self, *args, **kwargs) + + @property + def affiliate_id(self): + """Gets the affiliate_id of this AffiliateCommissionCharge. # noqa: E501 + + + :return: The affiliate_id of this AffiliateCommissionCharge. # noqa: E501 + :rtype: str + """ + return self._affiliate_id + + @affiliate_id.setter + def affiliate_id(self, affiliate_id): + """Sets the affiliate_id of this AffiliateCommissionCharge. + + + :param affiliate_id: The affiliate_id of this AffiliateCommissionCharge. # noqa: E501 + :type: str + """ + + self._affiliate_id = affiliate_id + + @property + def commission_invoice_id(self): + """Gets the commission_invoice_id of this AffiliateCommissionCharge. # noqa: E501 + + + :return: The commission_invoice_id of this AffiliateCommissionCharge. # noqa: E501 + :rtype: str + """ + return self._commission_invoice_id + + @commission_invoice_id.setter + def commission_invoice_id(self, commission_invoice_id): + """Sets the commission_invoice_id of this AffiliateCommissionCharge. + + + :param commission_invoice_id: The commission_invoice_id of this AffiliateCommissionCharge. # noqa: E501 + :type: str + """ + + self._commission_invoice_id = commission_invoice_id + + @property + def raw_commission_structure(self): + """Gets the raw_commission_structure of this AffiliateCommissionCharge. # noqa: E501 + + + :return: The raw_commission_structure of this AffiliateCommissionCharge. # noqa: E501 + :rtype: str + """ + return self._raw_commission_structure + + @raw_commission_structure.setter + def raw_commission_structure(self, raw_commission_structure): + """Sets the raw_commission_structure of this AffiliateCommissionCharge. + + + :param raw_commission_structure: The raw_commission_structure of this AffiliateCommissionCharge. # noqa: E501 + :type: str + """ + + self._raw_commission_structure = raw_commission_structure + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AffiliateCommissionCharge, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AffiliateCommissionCharge): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/affiliate_rate_plan_relationships.py b/billforward/models/affiliate_rate_plan_relationships.py new file mode 100644 index 0000000..7358899 --- /dev/null +++ b/billforward/models/affiliate_rate_plan_relationships.py @@ -0,0 +1,370 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AffiliateRatePlanRelationships(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'commission_structure': 'CommissionStructure', + 'product_rate_plan_id': 'str', + 'start_date': 'datetime', + 'end_date': 'datetime', + 'interval': 'IntervalDate', + 'account_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'commission_structure': 'commissionStructure', + 'product_rate_plan_id': 'productRatePlanID', + 'start_date': 'startDate', + 'end_date': 'endDate', + 'interval': 'interval', + 'account_id': 'accountID' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, commission_structure=None, product_rate_plan_id=None, start_date=None, end_date=None, interval=None, account_id=None): # noqa: E501 + """AffiliateRatePlanRelationships - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._commission_structure = None + self._product_rate_plan_id = None + self._start_date = None + self._end_date = None + self._interval = None + self._account_id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if commission_structure is not None: + self.commission_structure = commission_structure + if product_rate_plan_id is not None: + self.product_rate_plan_id = product_rate_plan_id + if start_date is not None: + self.start_date = start_date + if end_date is not None: + self.end_date = end_date + if interval is not None: + self.interval = interval + if account_id is not None: + self.account_id = account_id + + @property + def created(self): + """Gets the created of this AffiliateRatePlanRelationships. # noqa: E501 + + + :return: The created of this AffiliateRatePlanRelationships. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this AffiliateRatePlanRelationships. + + + :param created: The created of this AffiliateRatePlanRelationships. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this AffiliateRatePlanRelationships. # noqa: E501 + + + :return: The changed_by of this AffiliateRatePlanRelationships. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this AffiliateRatePlanRelationships. + + + :param changed_by: The changed_by of this AffiliateRatePlanRelationships. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this AffiliateRatePlanRelationships. # noqa: E501 + + + :return: The updated of this AffiliateRatePlanRelationships. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this AffiliateRatePlanRelationships. + + + :param updated: The updated of this AffiliateRatePlanRelationships. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this AffiliateRatePlanRelationships. # noqa: E501 + + + :return: The id of this AffiliateRatePlanRelationships. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this AffiliateRatePlanRelationships. + + + :param id: The id of this AffiliateRatePlanRelationships. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this AffiliateRatePlanRelationships. # noqa: E501 + + + :return: The organization_id of this AffiliateRatePlanRelationships. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AffiliateRatePlanRelationships. + + + :param organization_id: The organization_id of this AffiliateRatePlanRelationships. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def commission_structure(self): + """Gets the commission_structure of this AffiliateRatePlanRelationships. # noqa: E501 + + + :return: The commission_structure of this AffiliateRatePlanRelationships. # noqa: E501 + :rtype: CommissionStructure + """ + return self._commission_structure + + @commission_structure.setter + def commission_structure(self, commission_structure): + """Sets the commission_structure of this AffiliateRatePlanRelationships. + + + :param commission_structure: The commission_structure of this AffiliateRatePlanRelationships. # noqa: E501 + :type: CommissionStructure + """ + + self._commission_structure = commission_structure + + @property + def product_rate_plan_id(self): + """Gets the product_rate_plan_id of this AffiliateRatePlanRelationships. # noqa: E501 + + + :return: The product_rate_plan_id of this AffiliateRatePlanRelationships. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_id + + @product_rate_plan_id.setter + def product_rate_plan_id(self, product_rate_plan_id): + """Sets the product_rate_plan_id of this AffiliateRatePlanRelationships. + + + :param product_rate_plan_id: The product_rate_plan_id of this AffiliateRatePlanRelationships. # noqa: E501 + :type: str + """ + + self._product_rate_plan_id = product_rate_plan_id + + @property + def start_date(self): + """Gets the start_date of this AffiliateRatePlanRelationships. # noqa: E501 + + + :return: The start_date of this AffiliateRatePlanRelationships. # noqa: E501 + :rtype: datetime + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this AffiliateRatePlanRelationships. + + + :param start_date: The start_date of this AffiliateRatePlanRelationships. # noqa: E501 + :type: datetime + """ + + self._start_date = start_date + + @property + def end_date(self): + """Gets the end_date of this AffiliateRatePlanRelationships. # noqa: E501 + + + :return: The end_date of this AffiliateRatePlanRelationships. # noqa: E501 + :rtype: datetime + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this AffiliateRatePlanRelationships. + + + :param end_date: The end_date of this AffiliateRatePlanRelationships. # noqa: E501 + :type: datetime + """ + + self._end_date = end_date + + @property + def interval(self): + """Gets the interval of this AffiliateRatePlanRelationships. # noqa: E501 + + + :return: The interval of this AffiliateRatePlanRelationships. # noqa: E501 + :rtype: IntervalDate + """ + return self._interval + + @interval.setter + def interval(self, interval): + """Sets the interval of this AffiliateRatePlanRelationships. + + + :param interval: The interval of this AffiliateRatePlanRelationships. # noqa: E501 + :type: IntervalDate + """ + + self._interval = interval + + @property + def account_id(self): + """Gets the account_id of this AffiliateRatePlanRelationships. # noqa: E501 + + + :return: The account_id of this AffiliateRatePlanRelationships. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this AffiliateRatePlanRelationships. + + + :param account_id: The account_id of this AffiliateRatePlanRelationships. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AffiliateRatePlanRelationships, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AffiliateRatePlanRelationships): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/affiliate_subscription_relationship.py b/billforward/models/affiliate_subscription_relationship.py new file mode 100644 index 0000000..45d848e --- /dev/null +++ b/billforward/models/affiliate_subscription_relationship.py @@ -0,0 +1,292 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AffiliateSubscriptionRelationship(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'subscription_id': 'str', + 'commission_structure': 'CommissionStructure', + 'account_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'subscription_id': 'subscriptionID', + 'commission_structure': 'commissionStructure', + 'account_id': 'accountID' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, subscription_id=None, commission_structure=None, account_id=None): # noqa: E501 + """AffiliateSubscriptionRelationship - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._subscription_id = None + self._commission_structure = None + self._account_id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if subscription_id is not None: + self.subscription_id = subscription_id + if commission_structure is not None: + self.commission_structure = commission_structure + if account_id is not None: + self.account_id = account_id + + @property + def created(self): + """Gets the created of this AffiliateSubscriptionRelationship. # noqa: E501 + + + :return: The created of this AffiliateSubscriptionRelationship. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this AffiliateSubscriptionRelationship. + + + :param created: The created of this AffiliateSubscriptionRelationship. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this AffiliateSubscriptionRelationship. # noqa: E501 + + + :return: The changed_by of this AffiliateSubscriptionRelationship. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this AffiliateSubscriptionRelationship. + + + :param changed_by: The changed_by of this AffiliateSubscriptionRelationship. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this AffiliateSubscriptionRelationship. # noqa: E501 + + + :return: The updated of this AffiliateSubscriptionRelationship. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this AffiliateSubscriptionRelationship. + + + :param updated: The updated of this AffiliateSubscriptionRelationship. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this AffiliateSubscriptionRelationship. # noqa: E501 + + + :return: The id of this AffiliateSubscriptionRelationship. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this AffiliateSubscriptionRelationship. + + + :param id: The id of this AffiliateSubscriptionRelationship. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this AffiliateSubscriptionRelationship. # noqa: E501 + + + :return: The organization_id of this AffiliateSubscriptionRelationship. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AffiliateSubscriptionRelationship. + + + :param organization_id: The organization_id of this AffiliateSubscriptionRelationship. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def subscription_id(self): + """Gets the subscription_id of this AffiliateSubscriptionRelationship. # noqa: E501 + + + :return: The subscription_id of this AffiliateSubscriptionRelationship. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this AffiliateSubscriptionRelationship. + + + :param subscription_id: The subscription_id of this AffiliateSubscriptionRelationship. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def commission_structure(self): + """Gets the commission_structure of this AffiliateSubscriptionRelationship. # noqa: E501 + + + :return: The commission_structure of this AffiliateSubscriptionRelationship. # noqa: E501 + :rtype: CommissionStructure + """ + return self._commission_structure + + @commission_structure.setter + def commission_structure(self, commission_structure): + """Sets the commission_structure of this AffiliateSubscriptionRelationship. + + + :param commission_structure: The commission_structure of this AffiliateSubscriptionRelationship. # noqa: E501 + :type: CommissionStructure + """ + + self._commission_structure = commission_structure + + @property + def account_id(self): + """Gets the account_id of this AffiliateSubscriptionRelationship. # noqa: E501 + + + :return: The account_id of this AffiliateSubscriptionRelationship. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this AffiliateSubscriptionRelationship. + + + :param account_id: The account_id of this AffiliateSubscriptionRelationship. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AffiliateSubscriptionRelationship, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AffiliateSubscriptionRelationship): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/aggregating_component.py b/billforward/models/aggregating_component.py deleted file mode 100644 index 2a7cf65..0000000 --- a/billforward/models/aggregating_component.py +++ /dev/null @@ -1,358 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class AggregatingComponent(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, product_rate_plan_id=None, product_rate_plan_name=None, pricing_component_id=None, pricing_component_name=None, deleted=False): - """ - AggregatingComponent - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'product_rate_plan_id': 'str', - 'product_rate_plan_name': 'str', - 'pricing_component_id': 'str', - 'pricing_component_name': 'str', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'product_rate_plan_id': 'productRatePlanID', - 'product_rate_plan_name': 'productRatePlanName', - 'pricing_component_id': 'pricingComponentID', - 'pricing_component_name': 'pricingComponentName', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._product_rate_plan_id = product_rate_plan_id - self._product_rate_plan_name = product_rate_plan_name - self._pricing_component_id = pricing_component_id - self._pricing_component_name = pricing_component_name - self._deleted = deleted - - @property - def created(self): - """ - Gets the created of this AggregatingComponent. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this AggregatingComponent. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this AggregatingComponent. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this AggregatingComponent. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this AggregatingComponent. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this AggregatingComponent. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this AggregatingComponent. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this AggregatingComponent. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this AggregatingComponent. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this AggregatingComponent. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this AggregatingComponent. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this AggregatingComponent. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this AggregatingComponent. - {\"description\":\"Unique ID by which the AggregatingComponent can be looked up.\",\"verbs\":[\"GET\"]} - - :return: The id of this AggregatingComponent. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this AggregatingComponent. - {\"description\":\"Unique ID by which the AggregatingComponent can be looked up.\",\"verbs\":[\"GET\"]} - - :param id: The id of this AggregatingComponent. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this AggregatingComponent. - {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The organization_id of this AggregatingComponent. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this AggregatingComponent. - {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\",\"GET\"]} - - :param organization_id: The organization_id of this AggregatingComponent. - :type: str - """ - - self._organization_id = organization_id - - @property - def product_rate_plan_id(self): - """ - Gets the product_rate_plan_id of this AggregatingComponent. - {\"description\":\"ID of the rate plan upon which this AggregatingComponent is defined.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The product_rate_plan_id of this AggregatingComponent. - :rtype: str - """ - return self._product_rate_plan_id - - @product_rate_plan_id.setter - def product_rate_plan_id(self, product_rate_plan_id): - """ - Sets the product_rate_plan_id of this AggregatingComponent. - {\"description\":\"ID of the rate plan upon which this AggregatingComponent is defined.\",\"verbs\":[\"POST\",\"GET\"]} - - :param product_rate_plan_id: The product_rate_plan_id of this AggregatingComponent. - :type: str - """ - - self._product_rate_plan_id = product_rate_plan_id - - @property - def product_rate_plan_name(self): - """ - Gets the product_rate_plan_name of this AggregatingComponent. - {\"description\":\"Name of the rate plan upon which this AggregatingComponent is defined.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The product_rate_plan_name of this AggregatingComponent. - :rtype: str - """ - return self._product_rate_plan_name - - @product_rate_plan_name.setter - def product_rate_plan_name(self, product_rate_plan_name): - """ - Sets the product_rate_plan_name of this AggregatingComponent. - {\"description\":\"Name of the rate plan upon which this AggregatingComponent is defined.\",\"verbs\":[\"POST\",\"GET\"]} - - :param product_rate_plan_name: The product_rate_plan_name of this AggregatingComponent. - :type: str - """ - - self._product_rate_plan_name = product_rate_plan_name - - @property - def pricing_component_id(self): - """ - Gets the pricing_component_id of this AggregatingComponent. - {\"description\":\"ID of the pricing component to which this AggregatingComponent's aggregation applies. The subscriber to the aggregating rate plan (which contains this AggregatingComponent), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches this ID. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge — to account for the more favourable price tiering that emerges when aggregating.\",\"verbs\":[\"POST\"]} - - :return: The pricing_component_id of this AggregatingComponent. - :rtype: str - """ - return self._pricing_component_id - - @pricing_component_id.setter - def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this AggregatingComponent. - {\"description\":\"ID of the pricing component to which this AggregatingComponent's aggregation applies. The subscriber to the aggregating rate plan (which contains this AggregatingComponent), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches this ID. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge — to account for the more favourable price tiering that emerges when aggregating.\",\"verbs\":[\"POST\"]} - - :param pricing_component_id: The pricing_component_id of this AggregatingComponent. - :type: str - """ - - self._pricing_component_id = pricing_component_id - - @property - def pricing_component_name(self): - """ - Gets the pricing_component_name of this AggregatingComponent. - {\"description\":\"Name of the pricing component to which this AggregatingComponent's aggregation applies. The subscriber to the aggregating rate plan (which contains this AggregatingComponent), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches this ID. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge — to account for the more favourable price tiering that emerges when aggregating.\",\"verbs\":[\"POST\"]} - - :return: The pricing_component_name of this AggregatingComponent. - :rtype: str - """ - return self._pricing_component_name - - @pricing_component_name.setter - def pricing_component_name(self, pricing_component_name): - """ - Sets the pricing_component_name of this AggregatingComponent. - {\"description\":\"Name of the pricing component to which this AggregatingComponent's aggregation applies. The subscriber to the aggregating rate plan (which contains this AggregatingComponent), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches this ID. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge — to account for the more favourable price tiering that emerges when aggregating.\",\"verbs\":[\"POST\"]} - - :param pricing_component_name: The pricing_component_name of this AggregatingComponent. - :type: str - """ - - self._pricing_component_name = pricing_component_name - - @property - def deleted(self): - """ - Gets the deleted of this AggregatingComponent. - {\"default\":false,\"description\":\"Whether the AggregatingComponent has been retired.\",\"verbs\":[\"GET\"]} - - :return: The deleted of this AggregatingComponent. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this AggregatingComponent. - {\"default\":false,\"description\":\"Whether the AggregatingComponent has been retired.\",\"verbs\":[\"GET\"]} - - :param deleted: The deleted of this AggregatingComponent. - :type: bool - """ - - self._deleted = deleted - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/aggregating_component_description.py b/billforward/models/aggregating_component_description.py new file mode 100644 index 0000000..9c40108 --- /dev/null +++ b/billforward/models/aggregating_component_description.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AggregatingComponentDescription(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str' + } + + attribute_map = { + 'name': 'name' + } + + def __init__(self, name=None): # noqa: E501 + """AggregatingComponentDescription - a model defined in Swagger""" # noqa: E501 + self._name = None + self.discriminator = None + if name is not None: + self.name = name + + @property + def name(self): + """Gets the name of this AggregatingComponentDescription. # noqa: E501 + + + :return: The name of this AggregatingComponentDescription. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this AggregatingComponentDescription. + + + :param name: The name of this AggregatingComponentDescription. # noqa: E501 + :type: str + """ + + self._name = name + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AggregatingComponentDescription, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AggregatingComponentDescription): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/alias.py b/billforward/models/alias.py deleted file mode 100644 index 8f76bb5..0000000 --- a/billforward/models/alias.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class Alias(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, id=None, organization_id=None, alias=None, deleted=False, created=None, changed_by=None, updated=None): - """ - Alias - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'id': 'str', - 'organization_id': 'str', - 'alias': 'str', - 'deleted': 'bool', - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime' - } - - self.attribute_map = { - 'id': 'id', - 'organization_id': 'organizationID', - 'alias': 'alias', - 'deleted': 'deleted', - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated' - } - - self._id = id - self._organization_id = organization_id - self._alias = alias - self._deleted = deleted - self._created = created - self._changed_by = changed_by - self._updated = updated - - @property - def id(self): - """ - Gets the id of this Alias. - { \"description\" : \"ID of the alias.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this Alias. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this Alias. - { \"description\" : \"ID of the alias.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this Alias. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this Alias. - { \"description\" : \"ID of the organization associated with the alias.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this Alias. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this Alias. - { \"description\" : \"ID of the organization associated with the alias.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this Alias. - :type: str - """ - - self._organization_id = organization_id - - @property - def alias(self): - """ - Gets the alias of this Alias. - { \"description\" : \"A string representation of the alias.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The alias of this Alias. - :rtype: str - """ - return self._alias - - @alias.setter - def alias(self, alias): - """ - Sets the alias of this Alias. - { \"description\" : \"A string representation of the alias.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param alias: The alias of this Alias. - :type: str - """ - - self._alias = alias - - @property - def deleted(self): - """ - Gets the deleted of this Alias. - { \"description\" : \"Has this alias been deleted?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The deleted of this Alias. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this Alias. - { \"description\" : \"Has this alias been deleted?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param deleted: The deleted of this Alias. - :type: bool - """ - - self._deleted = deleted - - @property - def created(self): - """ - Gets the created of this Alias. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this Alias. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this Alias. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this Alias. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this Alias. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this Alias. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this Alias. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this Alias. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this Alias. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this Alias. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this Alias. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this Alias. - :type: datetime - """ - - self._updated = updated - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/allowed_webhook_subscription_values.py b/billforward/models/allowed_webhook_subscription_values.py new file mode 100644 index 0000000..0afb1f4 --- /dev/null +++ b/billforward/models/allowed_webhook_subscription_values.py @@ -0,0 +1,202 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AllowedWebhookSubscriptionValues(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'domains': 'list[str]', + 'actions': 'list[str]', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'domains': 'domains', + 'actions': 'actions', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, domains=None, actions=None, organization_id=None): # noqa: E501 + """AllowedWebhookSubscriptionValues - a model defined in Swagger""" # noqa: E501 + self._created = None + self._domains = None + self._actions = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if domains is not None: + self.domains = domains + if actions is not None: + self.actions = actions + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this AllowedWebhookSubscriptionValues. # noqa: E501 + + + :return: The created of this AllowedWebhookSubscriptionValues. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this AllowedWebhookSubscriptionValues. + + + :param created: The created of this AllowedWebhookSubscriptionValues. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def domains(self): + """Gets the domains of this AllowedWebhookSubscriptionValues. # noqa: E501 + + + :return: The domains of this AllowedWebhookSubscriptionValues. # noqa: E501 + :rtype: list[str] + """ + return self._domains + + @domains.setter + def domains(self, domains): + """Sets the domains of this AllowedWebhookSubscriptionValues. + + + :param domains: The domains of this AllowedWebhookSubscriptionValues. # noqa: E501 + :type: list[str] + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if not set(domains).issubset(set(allowed_values)): + raise ValueError( + "Invalid values for `domains` [{0}], must be a subset of [{1}]" # noqa: E501 + .format(", ".join(map(str, set(domains) - set(allowed_values))), # noqa: E501 + ", ".join(map(str, allowed_values))) + ) + + self._domains = domains + + @property + def actions(self): + """Gets the actions of this AllowedWebhookSubscriptionValues. # noqa: E501 + + + :return: The actions of this AllowedWebhookSubscriptionValues. # noqa: E501 + :rtype: list[str] + """ + return self._actions + + @actions.setter + def actions(self, actions): + """Sets the actions of this AllowedWebhookSubscriptionValues. + + + :param actions: The actions of this AllowedWebhookSubscriptionValues. # noqa: E501 + :type: list[str] + """ + allowed_values = ["Accept", "Active", "AwaitingPayment", "AwaitingRefund", "Cancelled", "Completed", "Created", "Current", "Error", "Expiring", "Expired", "Failed", "Migrated", "NeedsAmendments", "Paid", "Pending", "Provisioned", "Refunded", "Reject", "Restarted", "Trial", "Unknown", "Unpaid", "Updated", "Voided", "PaymentFailed", "ProcessingPayment", "ServiceEnded", "AdvanceNotification"] # noqa: E501 + if not set(actions).issubset(set(allowed_values)): + raise ValueError( + "Invalid values for `actions` [{0}], must be a subset of [{1}]" # noqa: E501 + .format(", ".join(map(str, set(actions) - set(allowed_values))), # noqa: E501 + ", ".join(map(str, allowed_values))) + ) + + self._actions = actions + + @property + def organization_id(self): + """Gets the organization_id of this AllowedWebhookSubscriptionValues. # noqa: E501 + + + :return: The organization_id of this AllowedWebhookSubscriptionValues. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AllowedWebhookSubscriptionValues. + + + :param organization_id: The organization_id of this AllowedWebhookSubscriptionValues. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AllowedWebhookSubscriptionValues, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AllowedWebhookSubscriptionValues): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/amendment.py b/billforward/models/amendment.py index e1b9f77..4964dd9 100644 --- a/billforward/models/amendment.py +++ b/billforward/models/amendment.py @@ -1,106 +1,148 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class Amendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False): - """ - Amendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'dummy_field': 'str', + 'id': 'str', + 'organization_id': 'str', + 'subscription_id': 'str', + 'description': 'str', + 'actioning_time': 'datetime', + 'actioned_time': 'datetime', + 'state': 'str', + 'deleted': 'bool', + 'amendment_type': 'str', + 'discardable_subsystem_object': 'IDiscardable', + 'type': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'dummy_field': 'dummyField', + 'id': 'id', + 'organization_id': 'organizationID', + 'subscription_id': 'subscriptionID', + 'description': 'description', + 'actioning_time': 'actioningTime', + 'actioned_time': 'actionedTime', + 'state': 'state', + 'deleted': 'deleted', + 'amendment_type': 'amendmentType', + 'discardable_subsystem_object': 'discardableSubsystemObject', + 'type': '@type' + } + + discriminator_value_class_map = { + 'SubscriptionReviveAmendment': 'SubscriptionReviveAmendment', +'AmendmentDiscardAmendment': 'AmendmentDiscardAmendment', +'UpdateComponentValueAmendment': 'UpdateComponentValueAmendment', +'InvoiceNextExecutionAttemptAmendment': 'InvoiceNextExecutionAttemptAmendment', +'CreateSubscriptionChargeAmendment': 'CreateSubscriptionChargeAmendment', +'ResumeSubscriptionAmendment': 'ResumeSubscriptionAmendment', +'CancellationAmendment': 'CancellationAmendment', +'PricingComponentValueAmendment': 'PricingComponentValueAmendment', +'InvoiceOutstandingChargesAmendment': 'InvoiceOutstandingChargesAmendment', +'FixedTermExpiryAmendment': 'FixedTermExpiryAmendment', +'IssueInvoiceAmendment': 'IssueInvoiceAmendment', +'InvoiceRecalculationAmendment': 'InvoiceRecalculationAmendment', +'EndTrialAmendment': 'EndTrialAmendment', +'ProductRatePlanMigrationAmendment': 'ProductRatePlanMigrationAmendment', +'ServiceEndAmendment': 'ServiceEndAmendment', +'TimerAmendment': 'TimerAmendment' } + + def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None, id=None, organization_id=None, subscription_id=None, description=None, actioning_time=None, actioned_time=None, state=None, deleted=None, amendment_type=None, discardable_subsystem_object=None, type=None): # noqa: E501 + """Amendment - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._dummy_field = None + self._id = None + self._organization_id = None + self._subscription_id = None + self._description = None + self._actioning_time = None + self._actioned_time = None + self._state = None + self._deleted = None + self._amendment_type = None + self._discardable_subsystem_object = None + self._type = None + self.discriminator = '@type' + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if dummy_field is not None: + self.dummy_field = dummy_field + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if subscription_id is not None: + self.subscription_id = subscription_id + if description is not None: + self.description = description + if actioning_time is not None: + self.actioning_time = actioning_time + if actioned_time is not None: + self.actioned_time = actioned_time + self.state = state + self.deleted = deleted + if amendment_type is not None: + self.amendment_type = amendment_type + if discardable_subsystem_object is not None: + self.discardable_subsystem_object = discardable_subsystem_object + self.type = type @property def created(self): - """ - Gets the created of this Amendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this Amendment. # noqa: E501 - :return: The created of this Amendment. + + :return: The created of this Amendment. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this Amendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this Amendment. - :param created: The created of this Amendment. + + :param created: The created of this Amendment. # noqa: E501 :type: datetime """ @@ -108,22 +150,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this Amendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this Amendment. # noqa: E501 - :return: The changed_by of this Amendment. + + :return: The changed_by of this Amendment. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this Amendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this Amendment. + - :param changed_by: The changed_by of this Amendment. + :param changed_by: The changed_by of this Amendment. # noqa: E501 :type: str """ @@ -131,74 +171,62 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this Amendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this Amendment. # noqa: E501 + - :return: The updated of this Amendment. + :return: The updated of this Amendment. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this Amendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this Amendment. + - :param updated: The updated of this Amendment. + :param updated: The updated of this Amendment. # noqa: E501 :type: datetime """ self._updated = updated @property - def type(self): - """ - Gets the type of this Amendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + def dummy_field(self): + """Gets the dummy_field of this Amendment. # noqa: E501 - :return: The type of this Amendment. + + :return: The dummy_field of this Amendment. # noqa: E501 :rtype: str """ - return self._type + return self._dummy_field - @type.setter - def type(self, type): - """ - Sets the type of this Amendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + @dummy_field.setter + def dummy_field(self, dummy_field): + """Sets the dummy_field of this Amendment. - :param type: The type of this Amendment. + + :param dummy_field: The dummy_field of this Amendment. # noqa: E501 :type: str """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - self._type = type + self._dummy_field = dummy_field @property def id(self): - """ - Gets the id of this Amendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the id of this Amendment. # noqa: E501 + - :return: The id of this Amendment. + :return: The id of this Amendment. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this Amendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the id of this Amendment. - :param id: The id of this Amendment. + + :param id: The id of this Amendment. # noqa: E501 :type: str """ @@ -206,22 +234,20 @@ def id(self, id): @property def organization_id(self): - """ - Gets the organization_id of this Amendment. - { \"description\" : \"\", \"verbs\":[\"\"] } + """Gets the organization_id of this Amendment. # noqa: E501 - :return: The organization_id of this Amendment. + + :return: The organization_id of this Amendment. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this Amendment. - { \"description\" : \"\", \"verbs\":[\"\"] } + """Sets the organization_id of this Amendment. - :param organization_id: The organization_id of this Amendment. + + :param organization_id: The organization_id of this Amendment. # noqa: E501 :type: str """ @@ -229,74 +255,62 @@ def organization_id(self, organization_id): @property def subscription_id(self): - """ - Gets the subscription_id of this Amendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the subscription_id of this Amendment. # noqa: E501 - :return: The subscription_id of this Amendment. + + :return: The subscription_id of this Amendment. # noqa: E501 :rtype: str """ return self._subscription_id @subscription_id.setter def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this Amendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the subscription_id of this Amendment. + - :param subscription_id: The subscription_id of this Amendment. + :param subscription_id: The subscription_id of this Amendment. # noqa: E501 :type: str """ self._subscription_id = subscription_id @property - def amendment_type(self): - """ - Gets the amendment_type of this Amendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } + def description(self): + """Gets the description of this Amendment. # noqa: E501 - :return: The amendment_type of this Amendment. + + :return: The description of this Amendment. # noqa: E501 :rtype: str """ - return self._amendment_type + return self._description + + @description.setter + def description(self, description): + """Sets the description of this Amendment. - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this Amendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - :param amendment_type: The amendment_type of this Amendment. + :param description: The description of this Amendment. # noqa: E501 :type: str """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - self._amendment_type = amendment_type + self._description = description @property def actioning_time(self): - """ - Gets the actioning_time of this Amendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the actioning_time of this Amendment. # noqa: E501 + - :return: The actioning_time of this Amendment. + :return: The actioning_time of this Amendment. # noqa: E501 :rtype: datetime """ return self._actioning_time @actioning_time.setter def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this Amendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the actioning_time of this Amendment. + - :param actioning_time: The actioning_time of this Amendment. + :param actioning_time: The actioning_time of this Amendment. # noqa: E501 :type: datetime """ @@ -304,22 +318,20 @@ def actioning_time(self, actioning_time): @property def actioned_time(self): - """ - Gets the actioned_time of this Amendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } + """Gets the actioned_time of this Amendment. # noqa: E501 - :return: The actioned_time of this Amendment. + + :return: The actioned_time of this Amendment. # noqa: E501 :rtype: datetime """ return self._actioned_time @actioned_time.setter def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this Amendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } + """Sets the actioned_time of this Amendment. - :param actioned_time: The actioned_time of this Amendment. + + :param actioned_time: The actioned_time of this Amendment. # noqa: E501 :type: datetime """ @@ -327,28 +339,28 @@ def actioned_time(self, actioned_time): @property def state(self): - """ - Gets the state of this Amendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending + """Gets the state of this Amendment. # noqa: E501 - :return: The state of this Amendment. + + :return: The state of this Amendment. # noqa: E501 :rtype: str """ return self._state @state.setter def state(self, state): - """ - Sets the state of this Amendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending + """Sets the state of this Amendment. - :param state: The state of this Amendment. + + :param state: The state of this Amendment. # noqa: E501 :type: str """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] + if state is None: + raise ValueError("Invalid value for `state`, must not be `None`") # noqa: E501 + allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] # noqa: E501 if state not in allowed_values: raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 .format(state, allowed_values) ) @@ -356,34 +368,108 @@ def state(self, state): @property def deleted(self): - """ - Gets the deleted of this Amendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } + """Gets the deleted of this Amendment. # noqa: E501 + - :return: The deleted of this Amendment. + :return: The deleted of this Amendment. # noqa: E501 :rtype: bool """ return self._deleted @deleted.setter def deleted(self, deleted): - """ - Sets the deleted of this Amendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } + """Sets the deleted of this Amendment. + - :param deleted: The deleted of this Amendment. + :param deleted: The deleted of this Amendment. # noqa: E501 :type: bool """ + if deleted is None: + raise ValueError("Invalid value for `deleted`, must not be `None`") # noqa: E501 self._deleted = deleted - def to_dict(self): + @property + def amendment_type(self): + """Gets the amendment_type of this Amendment. # noqa: E501 + + + :return: The amendment_type of this Amendment. # noqa: E501 + :rtype: str + """ + return self._amendment_type + + @amendment_type.setter + def amendment_type(self, amendment_type): + """Sets the amendment_type of this Amendment. + + + :param amendment_type: The amendment_type of this Amendment. # noqa: E501 + :type: str + """ + allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer", "SubscriptionRevive"] # noqa: E501 + if amendment_type not in allowed_values: + raise ValueError( + "Invalid value for `amendment_type` ({0}), must be one of {1}" # noqa: E501 + .format(amendment_type, allowed_values) + ) + + self._amendment_type = amendment_type + + @property + def discardable_subsystem_object(self): + """Gets the discardable_subsystem_object of this Amendment. # noqa: E501 + + + :return: The discardable_subsystem_object of this Amendment. # noqa: E501 + :rtype: IDiscardable + """ + return self._discardable_subsystem_object + + @discardable_subsystem_object.setter + def discardable_subsystem_object(self, discardable_subsystem_object): + """Sets the discardable_subsystem_object of this Amendment. + + + :param discardable_subsystem_object: The discardable_subsystem_object of this Amendment. # noqa: E501 + :type: IDiscardable + """ + + self._discardable_subsystem_object = discardable_subsystem_object + + @property + def type(self): + """Gets the type of this Amendment. # noqa: E501 + + + :return: The type of this Amendment. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._type + + @type.setter + def type(self, type): + """Sets the type of this Amendment. + + + :param type: The type of this Amendment. # noqa: E501 + :type: str """ + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + + self._type = type + + def get_real_child_model(self, data): + """Returns the real base class specified by the discriminator""" + discriminator_value = data[self.discriminator].lower() + return self.discriminator_value_class_map.get(discriminator_value) + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -400,29 +486,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Amendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Amendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/amendment_discard_amendment.py b/billforward/models/amendment_discard_amendment.py index a292225..a1b052a 100644 --- a/billforward/models/amendment_discard_amendment.py +++ b/billforward/models/amendment_discard_amendment.py @@ -1,415 +1,80 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class AmendmentDiscardAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class AmendmentDiscardAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False, amendment_to_discard_id=None): - """ - AmendmentDiscardAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool', - 'amendment_to_discard_id': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted', - 'amendment_to_discard_id': 'amendmentToDiscardID' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - self._amendment_to_discard_id = amendment_to_discard_id - - @property - def created(self): - """ - Gets the created of this AmendmentDiscardAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this AmendmentDiscardAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this AmendmentDiscardAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this AmendmentDiscardAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this AmendmentDiscardAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this AmendmentDiscardAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this AmendmentDiscardAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this AmendmentDiscardAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this AmendmentDiscardAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this AmendmentDiscardAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this AmendmentDiscardAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this AmendmentDiscardAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this AmendmentDiscardAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this AmendmentDiscardAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this AmendmentDiscardAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this AmendmentDiscardAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def id(self): - """ - Gets the id of this AmendmentDiscardAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this AmendmentDiscardAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this AmendmentDiscardAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this AmendmentDiscardAmendment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this AmendmentDiscardAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this AmendmentDiscardAmendment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this AmendmentDiscardAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this AmendmentDiscardAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this AmendmentDiscardAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this AmendmentDiscardAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this AmendmentDiscardAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this AmendmentDiscardAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this AmendmentDiscardAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this AmendmentDiscardAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this AmendmentDiscardAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this AmendmentDiscardAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this AmendmentDiscardAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this AmendmentDiscardAmendment. - :rtype: datetime - """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this AmendmentDiscardAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actioning_time: The actioning_time of this AmendmentDiscardAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this AmendmentDiscardAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this AmendmentDiscardAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this AmendmentDiscardAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :param actioned_time: The actioned_time of this AmendmentDiscardAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this AmendmentDiscardAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this AmendmentDiscardAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this AmendmentDiscardAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this AmendmentDiscardAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this AmendmentDiscardAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this AmendmentDiscardAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this AmendmentDiscardAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this AmendmentDiscardAmendment. - :type: bool - """ - - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'amendment_to_discard_id': 'str' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'amendment_to_discard_id': 'amendmentToDiscardID' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, amendment_to_discard_id=None, *args, **kwargs): # noqa: E501 + """AmendmentDiscardAmendment - a model defined in Swagger""" # noqa: E501 + self._amendment_to_discard_id = None + self.discriminator = None + self.amendment_to_discard_id = amendment_to_discard_id + Amendment.__init__(self, *args, **kwargs) @property def amendment_to_discard_id(self): - """ - Gets the amendment_to_discard_id of this AmendmentDiscardAmendment. - { \"description\" : \"ID of the amendment to discard.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the amendment_to_discard_id of this AmendmentDiscardAmendment. # noqa: E501 + - :return: The amendment_to_discard_id of this AmendmentDiscardAmendment. + :return: The amendment_to_discard_id of this AmendmentDiscardAmendment. # noqa: E501 :rtype: str """ return self._amendment_to_discard_id @amendment_to_discard_id.setter def amendment_to_discard_id(self, amendment_to_discard_id): - """ - Sets the amendment_to_discard_id of this AmendmentDiscardAmendment. - { \"description\" : \"ID of the amendment to discard.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the amendment_to_discard_id of this AmendmentDiscardAmendment. - :param amendment_to_discard_id: The amendment_to_discard_id of this AmendmentDiscardAmendment. + + :param amendment_to_discard_id: The amendment_to_discard_id of this AmendmentDiscardAmendment. # noqa: E501 :type: str """ + if amendment_to_discard_id is None: + raise ValueError("Invalid value for `amendment_to_discard_id`, must not be `None`") # noqa: E501 self._amendment_to_discard_id = amendment_to_discard_id def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -426,29 +91,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(AmendmentDiscardAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, AmendmentDiscardAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/amendment_paged_metadata.py b/billforward/models/amendment_paged_metadata.py deleted file mode 100644 index 7115a06..0000000 --- a/billforward/models/amendment_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class AmendmentPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - AmendmentPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Amendment]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this AmendmentPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this AmendmentPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this AmendmentPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this AmendmentPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this AmendmentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this AmendmentPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this AmendmentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this AmendmentPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this AmendmentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this AmendmentPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this AmendmentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this AmendmentPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this AmendmentPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this AmendmentPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this AmendmentPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this AmendmentPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this AmendmentPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this AmendmentPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this AmendmentPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this AmendmentPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this AmendmentPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this AmendmentPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this AmendmentPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this AmendmentPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this AmendmentPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this AmendmentPagedMetadata. - :rtype: list[Amendment] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this AmendmentPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this AmendmentPagedMetadata. - :type: list[Amendment] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/amendment_price_n_time_paged_metadata.py b/billforward/models/amendment_price_n_time_paged_metadata.py deleted file mode 100644 index 58bd496..0000000 --- a/billforward/models/amendment_price_n_time_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class AmendmentPriceNTimePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - AmendmentPriceNTimePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this AmendmentPriceNTimePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this AmendmentPriceNTimePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this AmendmentPriceNTimePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this AmendmentPriceNTimePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this AmendmentPriceNTimePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this AmendmentPriceNTimePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this AmendmentPriceNTimePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this AmendmentPriceNTimePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this AmendmentPriceNTimePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this AmendmentPriceNTimePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this AmendmentPriceNTimePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this AmendmentPriceNTimePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this AmendmentPriceNTimePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this AmendmentPriceNTimePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this AmendmentPriceNTimePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this AmendmentPriceNTimePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this AmendmentPriceNTimePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this AmendmentPriceNTimePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this AmendmentPriceNTimePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this AmendmentPriceNTimePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this AmendmentPriceNTimePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this AmendmentPriceNTimePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this AmendmentPriceNTimePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this AmendmentPriceNTimePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this AmendmentPriceNTimePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this AmendmentPriceNTimePagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this AmendmentPriceNTimePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this AmendmentPriceNTimePagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/api_configuration.py b/billforward/models/api_configuration.py new file mode 100644 index 0000000..bf7d6ad --- /dev/null +++ b/billforward/models/api_configuration.py @@ -0,0 +1,759 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class APIConfiguration(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'type': 'str', + 'environment': 'str', + 'merchant_id': 'str', + 'public_key': 'str', + 'private_key': 'str', + 'endpoint': 'str', + 'client_id': 'str', + 'client_secret': 'str', + 'gateway_account_id': 'str', + 'refresh_token': 'str', + 'deleted': 'bool', + 'api_login_id': 'str', + 'transaction_key': 'str', + 'expires_at': 'datetime', + 'migrations': 'list[Migration]', + 'gateway_type': 'str', + 'environment_type': 'str', + 'production': 'bool', + 'apilogin_id': 'str', + 'apikey': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'type': 'type', + 'environment': 'environment', + 'merchant_id': 'merchantID', + 'public_key': 'publicKey', + 'private_key': 'privateKey', + 'endpoint': 'endpoint', + 'client_id': 'clientID', + 'client_secret': 'clientSecret', + 'gateway_account_id': 'gatewayAccountID', + 'refresh_token': 'refreshToken', + 'deleted': 'deleted', + 'api_login_id': 'APILoginID', + 'transaction_key': 'transactionKey', + 'expires_at': 'expiresAt', + 'migrations': 'migrations', + 'gateway_type': 'gatewayType', + 'environment_type': 'environmentType', + 'production': 'production', + 'apilogin_id': 'apiloginID', + 'apikey': 'apikey' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, type=None, environment=None, merchant_id=None, public_key=None, private_key=None, endpoint=None, client_id=None, client_secret=None, gateway_account_id=None, refresh_token=None, deleted=None, api_login_id=None, transaction_key=None, expires_at=None, migrations=None, gateway_type=None, environment_type=None, production=None, apilogin_id=None, apikey=None): # noqa: E501 + """APIConfiguration - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._type = None + self._environment = None + self._merchant_id = None + self._public_key = None + self._private_key = None + self._endpoint = None + self._client_id = None + self._client_secret = None + self._gateway_account_id = None + self._refresh_token = None + self._deleted = None + self._api_login_id = None + self._transaction_key = None + self._expires_at = None + self._migrations = None + self._gateway_type = None + self._environment_type = None + self._production = None + self._apilogin_id = None + self._apikey = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if type is not None: + self.type = type + if environment is not None: + self.environment = environment + if merchant_id is not None: + self.merchant_id = merchant_id + if public_key is not None: + self.public_key = public_key + if private_key is not None: + self.private_key = private_key + if endpoint is not None: + self.endpoint = endpoint + if client_id is not None: + self.client_id = client_id + if client_secret is not None: + self.client_secret = client_secret + if gateway_account_id is not None: + self.gateway_account_id = gateway_account_id + if refresh_token is not None: + self.refresh_token = refresh_token + self.deleted = deleted + if api_login_id is not None: + self.api_login_id = api_login_id + if transaction_key is not None: + self.transaction_key = transaction_key + if expires_at is not None: + self.expires_at = expires_at + if migrations is not None: + self.migrations = migrations + if gateway_type is not None: + self.gateway_type = gateway_type + if environment_type is not None: + self.environment_type = environment_type + if production is not None: + self.production = production + if apilogin_id is not None: + self.apilogin_id = apilogin_id + if apikey is not None: + self.apikey = apikey + + @property + def created(self): + """Gets the created of this APIConfiguration. # noqa: E501 + + + :return: The created of this APIConfiguration. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this APIConfiguration. + + + :param created: The created of this APIConfiguration. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this APIConfiguration. # noqa: E501 + + + :return: The changed_by of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this APIConfiguration. + + + :param changed_by: The changed_by of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this APIConfiguration. # noqa: E501 + + + :return: The updated of this APIConfiguration. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this APIConfiguration. + + + :param updated: The updated of this APIConfiguration. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this APIConfiguration. # noqa: E501 + + + :return: The id of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this APIConfiguration. + + + :param id: The id of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this APIConfiguration. # noqa: E501 + + + :return: The organization_id of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this APIConfiguration. + + + :param organization_id: The organization_id of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def type(self): + """Gets the type of this APIConfiguration. # noqa: E501 + + + :return: The type of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this APIConfiguration. + + + :param type: The type of this APIConfiguration. # noqa: E501 + :type: str + """ + allowed_values = ["Balanced", "Braintree", "Cybersource", "Paypal", "Stripe", "Shuttle", "AuthorizeNet", "Spreedly", "SagePay", "GoCardless", "TrustCommerce", "Payvision", "Epx", "Kash", "Zooz", "Square", "CardConnect", "EBANX"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def environment(self): + """Gets the environment of this APIConfiguration. # noqa: E501 + + + :return: The environment of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._environment + + @environment.setter + def environment(self, environment): + """Sets the environment of this APIConfiguration. + + + :param environment: The environment of this APIConfiguration. # noqa: E501 + :type: str + """ + allowed_values = ["Sandbox", "Production"] # noqa: E501 + if environment not in allowed_values: + raise ValueError( + "Invalid value for `environment` ({0}), must be one of {1}" # noqa: E501 + .format(environment, allowed_values) + ) + + self._environment = environment + + @property + def merchant_id(self): + """Gets the merchant_id of this APIConfiguration. # noqa: E501 + + + :return: The merchant_id of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._merchant_id + + @merchant_id.setter + def merchant_id(self, merchant_id): + """Sets the merchant_id of this APIConfiguration. + + + :param merchant_id: The merchant_id of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._merchant_id = merchant_id + + @property + def public_key(self): + """Gets the public_key of this APIConfiguration. # noqa: E501 + + + :return: The public_key of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._public_key + + @public_key.setter + def public_key(self, public_key): + """Sets the public_key of this APIConfiguration. + + + :param public_key: The public_key of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._public_key = public_key + + @property + def private_key(self): + """Gets the private_key of this APIConfiguration. # noqa: E501 + + + :return: The private_key of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._private_key + + @private_key.setter + def private_key(self, private_key): + """Sets the private_key of this APIConfiguration. + + + :param private_key: The private_key of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._private_key = private_key + + @property + def endpoint(self): + """Gets the endpoint of this APIConfiguration. # noqa: E501 + + + :return: The endpoint of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._endpoint + + @endpoint.setter + def endpoint(self, endpoint): + """Sets the endpoint of this APIConfiguration. + + + :param endpoint: The endpoint of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._endpoint = endpoint + + @property + def client_id(self): + """Gets the client_id of this APIConfiguration. # noqa: E501 + + + :return: The client_id of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._client_id + + @client_id.setter + def client_id(self, client_id): + """Sets the client_id of this APIConfiguration. + + + :param client_id: The client_id of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._client_id = client_id + + @property + def client_secret(self): + """Gets the client_secret of this APIConfiguration. # noqa: E501 + + + :return: The client_secret of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._client_secret + + @client_secret.setter + def client_secret(self, client_secret): + """Sets the client_secret of this APIConfiguration. + + + :param client_secret: The client_secret of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._client_secret = client_secret + + @property + def gateway_account_id(self): + """Gets the gateway_account_id of this APIConfiguration. # noqa: E501 + + + :return: The gateway_account_id of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._gateway_account_id + + @gateway_account_id.setter + def gateway_account_id(self, gateway_account_id): + """Sets the gateway_account_id of this APIConfiguration. + + + :param gateway_account_id: The gateway_account_id of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._gateway_account_id = gateway_account_id + + @property + def refresh_token(self): + """Gets the refresh_token of this APIConfiguration. # noqa: E501 + + + :return: The refresh_token of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._refresh_token + + @refresh_token.setter + def refresh_token(self, refresh_token): + """Sets the refresh_token of this APIConfiguration. + + + :param refresh_token: The refresh_token of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._refresh_token = refresh_token + + @property + def deleted(self): + """Gets the deleted of this APIConfiguration. # noqa: E501 + + + :return: The deleted of this APIConfiguration. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this APIConfiguration. + + + :param deleted: The deleted of this APIConfiguration. # noqa: E501 + :type: bool + """ + if deleted is None: + raise ValueError("Invalid value for `deleted`, must not be `None`") # noqa: E501 + + self._deleted = deleted + + @property + def api_login_id(self): + """Gets the api_login_id of this APIConfiguration. # noqa: E501 + + + :return: The api_login_id of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._api_login_id + + @api_login_id.setter + def api_login_id(self, api_login_id): + """Sets the api_login_id of this APIConfiguration. + + + :param api_login_id: The api_login_id of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._api_login_id = api_login_id + + @property + def transaction_key(self): + """Gets the transaction_key of this APIConfiguration. # noqa: E501 + + + :return: The transaction_key of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._transaction_key + + @transaction_key.setter + def transaction_key(self, transaction_key): + """Sets the transaction_key of this APIConfiguration. + + + :param transaction_key: The transaction_key of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._transaction_key = transaction_key + + @property + def expires_at(self): + """Gets the expires_at of this APIConfiguration. # noqa: E501 + + + :return: The expires_at of this APIConfiguration. # noqa: E501 + :rtype: datetime + """ + return self._expires_at + + @expires_at.setter + def expires_at(self, expires_at): + """Sets the expires_at of this APIConfiguration. + + + :param expires_at: The expires_at of this APIConfiguration. # noqa: E501 + :type: datetime + """ + + self._expires_at = expires_at + + @property + def migrations(self): + """Gets the migrations of this APIConfiguration. # noqa: E501 + + + :return: The migrations of this APIConfiguration. # noqa: E501 + :rtype: list[Migration] + """ + return self._migrations + + @migrations.setter + def migrations(self, migrations): + """Sets the migrations of this APIConfiguration. + + + :param migrations: The migrations of this APIConfiguration. # noqa: E501 + :type: list[Migration] + """ + + self._migrations = migrations + + @property + def gateway_type(self): + """Gets the gateway_type of this APIConfiguration. # noqa: E501 + + + :return: The gateway_type of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._gateway_type + + @gateway_type.setter + def gateway_type(self, gateway_type): + """Sets the gateway_type of this APIConfiguration. + + + :param gateway_type: The gateway_type of this APIConfiguration. # noqa: E501 + :type: str + """ + allowed_values = ["VOID", "cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "zooz", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "goCardless", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash", "epx", "shuttle", "square", "billforwardRandomizer", "cardConnect", "ebanx"] # noqa: E501 + if gateway_type not in allowed_values: + raise ValueError( + "Invalid value for `gateway_type` ({0}), must be one of {1}" # noqa: E501 + .format(gateway_type, allowed_values) + ) + + self._gateway_type = gateway_type + + @property + def environment_type(self): + """Gets the environment_type of this APIConfiguration. # noqa: E501 + + + :return: The environment_type of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._environment_type + + @environment_type.setter + def environment_type(self, environment_type): + """Sets the environment_type of this APIConfiguration. + + + :param environment_type: The environment_type of this APIConfiguration. # noqa: E501 + :type: str + """ + allowed_values = ["Sandbox", "Production"] # noqa: E501 + if environment_type not in allowed_values: + raise ValueError( + "Invalid value for `environment_type` ({0}), must be one of {1}" # noqa: E501 + .format(environment_type, allowed_values) + ) + + self._environment_type = environment_type + + @property + def production(self): + """Gets the production of this APIConfiguration. # noqa: E501 + + + :return: The production of this APIConfiguration. # noqa: E501 + :rtype: bool + """ + return self._production + + @production.setter + def production(self, production): + """Sets the production of this APIConfiguration. + + + :param production: The production of this APIConfiguration. # noqa: E501 + :type: bool + """ + + self._production = production + + @property + def apilogin_id(self): + """Gets the apilogin_id of this APIConfiguration. # noqa: E501 + + + :return: The apilogin_id of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._apilogin_id + + @apilogin_id.setter + def apilogin_id(self, apilogin_id): + """Sets the apilogin_id of this APIConfiguration. + + + :param apilogin_id: The apilogin_id of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._apilogin_id = apilogin_id + + @property + def apikey(self): + """Gets the apikey of this APIConfiguration. # noqa: E501 + + + :return: The apikey of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._apikey + + @apikey.setter + def apikey(self, apikey): + """Sets the apikey of this APIConfiguration. + + + :param apikey: The apikey of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._apikey = apikey + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(APIConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, APIConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/api_configuration_paged_metadata.py b/billforward/models/api_configuration_paged_metadata.py deleted file mode 100644 index 75be43c..0000000 --- a/billforward/models/api_configuration_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class APIConfigurationPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - APIConfigurationPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this APIConfigurationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this APIConfigurationPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this APIConfigurationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this APIConfigurationPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this APIConfigurationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this APIConfigurationPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this APIConfigurationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this APIConfigurationPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this APIConfigurationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this APIConfigurationPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this APIConfigurationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this APIConfigurationPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this APIConfigurationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this APIConfigurationPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this APIConfigurationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this APIConfigurationPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this APIConfigurationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this APIConfigurationPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this APIConfigurationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this APIConfigurationPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this APIConfigurationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this APIConfigurationPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this APIConfigurationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this APIConfigurationPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this APIConfigurationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this APIConfigurationPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this APIConfigurationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this APIConfigurationPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/api_quote.py b/billforward/models/api_quote.py index 2736612..96d6f2e 100644 --- a/billforward/models/api_quote.py +++ b/billforward/models/api_quote.py @@ -1,157 +1,216 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six + +class ApiQuote(object): + """NOTE: This class is auto generated by the swagger code generator program. -class APIQuote(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, subtotal=None, subtotal_excluding_tax=None, total=None, total_excluding_tax=None, tax=None, discount=None, discount_excluding_tax=None, currency=None, product_name=None, public_product_name=None, product_rate_plan_name=None, public_product_rate_plan_name=None, product_id=None, product_rate_plan_id=None, subscription_id=None, account_id=None, quantities=None, discounts=None, quote_for=None, period_start=None, period_end=None, total_periods=None, proration_enabled=False, uplift=None, coupon_codes=None, organization_id=None, same_product_period=False): - """ - APIQuote - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'subtotal': 'float', - 'subtotal_excluding_tax': 'float', - 'total': 'float', - 'total_excluding_tax': 'float', - 'tax': 'float', - 'discount': 'float', - 'discount_excluding_tax': 'float', - 'currency': 'str', - 'product_name': 'str', - 'public_product_name': 'str', - 'product_rate_plan_name': 'str', - 'public_product_rate_plan_name': 'str', - 'product_id': 'str', - 'product_rate_plan_id': 'str', - 'subscription_id': 'str', - 'account_id': 'str', - 'quantities': 'list[APIQuoteResponseQuantity]', - 'discounts': 'list[CouponWrapperResponse]', - 'quote_for': 'str', - 'period_start': 'datetime', - 'period_end': 'datetime', - 'total_periods': 'float', - 'proration_enabled': 'bool', - 'uplift': 'float', - 'coupon_codes': 'list[str]', - 'organization_id': 'str', - 'same_product_period': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'subtotal': 'subtotal', - 'subtotal_excluding_tax': 'subtotalExcludingTax', - 'total': 'total', - 'total_excluding_tax': 'totalExcludingTax', - 'tax': 'tax', - 'discount': 'discount', - 'discount_excluding_tax': 'discountExcludingTax', - 'currency': 'currency', - 'product_name': 'productName', - 'public_product_name': 'publicProductName', - 'product_rate_plan_name': 'productRatePlanName', - 'public_product_rate_plan_name': 'publicProductRatePlanName', - 'product_id': 'productID', - 'product_rate_plan_id': 'productRatePlanID', - 'subscription_id': 'subscriptionID', - 'account_id': 'accountID', - 'quantities': 'quantities', - 'discounts': 'discounts', - 'quote_for': 'quoteFor', - 'period_start': 'periodStart', - 'period_end': 'periodEnd', - 'total_periods': 'totalPeriods', - 'proration_enabled': 'prorationEnabled', - 'uplift': 'uplift', - 'coupon_codes': 'couponCodes', - 'organization_id': 'organizationID', - 'same_product_period': 'sameProductPeriod' - } - - self._created = created - self._changed_by = changed_by - self._subtotal = subtotal - self._subtotal_excluding_tax = subtotal_excluding_tax - self._total = total - self._total_excluding_tax = total_excluding_tax - self._tax = tax - self._discount = discount - self._discount_excluding_tax = discount_excluding_tax - self._currency = currency - self._product_name = product_name - self._public_product_name = public_product_name - self._product_rate_plan_name = product_rate_plan_name - self._public_product_rate_plan_name = public_product_rate_plan_name - self._product_id = product_id - self._product_rate_plan_id = product_rate_plan_id - self._subscription_id = subscription_id - self._account_id = account_id - self._quantities = quantities - self._discounts = discounts - self._quote_for = quote_for - self._period_start = period_start - self._period_end = period_end - self._total_periods = total_periods - self._proration_enabled = proration_enabled - self._uplift = uplift - self._coupon_codes = coupon_codes - self._organization_id = organization_id - self._same_product_period = same_product_period + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'subtotal': 'float', + 'subtotal_excluding_tax': 'float', + 'total': 'float', + 'total_excluding_tax': 'float', + 'tax': 'float', + 'discount': 'float', + 'discount_excluding_tax': 'float', + 'currency': 'CreditNoteCurrency', + 'product_name': 'str', + 'public_product_name': 'str', + 'product_rate_plan_name': 'str', + 'public_product_rate_plan_name': 'str', + 'product_id': 'str', + 'product_rate_plan_id': 'str', + 'subscription_id': 'str', + 'account_id': 'str', + 'quantities': 'list[APIQuoteResponseQuantity]', + 'discounts': 'list[CouponWrapperResponse]', + 'quote_for': 'str', + 'period_start': 'datetime', + 'period_end': 'datetime', + 'total_periods': 'float', + 'proration_enabled': 'bool', + 'uplift': 'float', + 'coupon_codes': 'list[str]', + 'organization_id': 'str', + 'same_product_period': 'bool', + 'purchase_order': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'subtotal': 'subtotal', + 'subtotal_excluding_tax': 'subtotalExcludingTax', + 'total': 'total', + 'total_excluding_tax': 'totalExcludingTax', + 'tax': 'tax', + 'discount': 'discount', + 'discount_excluding_tax': 'discountExcludingTax', + 'currency': 'currency', + 'product_name': 'productName', + 'public_product_name': 'publicProductName', + 'product_rate_plan_name': 'productRatePlanName', + 'public_product_rate_plan_name': 'publicProductRatePlanName', + 'product_id': 'productID', + 'product_rate_plan_id': 'productRatePlanID', + 'subscription_id': 'subscriptionID', + 'account_id': 'accountID', + 'quantities': 'quantities', + 'discounts': 'discounts', + 'quote_for': 'quoteFor', + 'period_start': 'periodStart', + 'period_end': 'periodEnd', + 'total_periods': 'totalPeriods', + 'proration_enabled': 'prorationEnabled', + 'uplift': 'uplift', + 'coupon_codes': 'couponCodes', + 'organization_id': 'organizationID', + 'same_product_period': 'sameProductPeriod', + 'purchase_order': 'purchaseOrder' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, subtotal=None, subtotal_excluding_tax=None, total=None, total_excluding_tax=None, tax=None, discount=None, discount_excluding_tax=None, currency=None, product_name=None, public_product_name=None, product_rate_plan_name=None, public_product_rate_plan_name=None, product_id=None, product_rate_plan_id=None, subscription_id=None, account_id=None, quantities=None, discounts=None, quote_for=None, period_start=None, period_end=None, total_periods=None, proration_enabled=None, uplift=None, coupon_codes=None, organization_id=None, same_product_period=None, purchase_order=None): # noqa: E501 + """ApiQuote - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._subtotal = None + self._subtotal_excluding_tax = None + self._total = None + self._total_excluding_tax = None + self._tax = None + self._discount = None + self._discount_excluding_tax = None + self._currency = None + self._product_name = None + self._public_product_name = None + self._product_rate_plan_name = None + self._public_product_rate_plan_name = None + self._product_id = None + self._product_rate_plan_id = None + self._subscription_id = None + self._account_id = None + self._quantities = None + self._discounts = None + self._quote_for = None + self._period_start = None + self._period_end = None + self._total_periods = None + self._proration_enabled = None + self._uplift = None + self._coupon_codes = None + self._organization_id = None + self._same_product_period = None + self._purchase_order = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if subtotal is not None: + self.subtotal = subtotal + if subtotal_excluding_tax is not None: + self.subtotal_excluding_tax = subtotal_excluding_tax + if total is not None: + self.total = total + if total_excluding_tax is not None: + self.total_excluding_tax = total_excluding_tax + if tax is not None: + self.tax = tax + if discount is not None: + self.discount = discount + if discount_excluding_tax is not None: + self.discount_excluding_tax = discount_excluding_tax + if currency is not None: + self.currency = currency + if product_name is not None: + self.product_name = product_name + if public_product_name is not None: + self.public_product_name = public_product_name + if product_rate_plan_name is not None: + self.product_rate_plan_name = product_rate_plan_name + if public_product_rate_plan_name is not None: + self.public_product_rate_plan_name = public_product_rate_plan_name + if product_id is not None: + self.product_id = product_id + if product_rate_plan_id is not None: + self.product_rate_plan_id = product_rate_plan_id + if subscription_id is not None: + self.subscription_id = subscription_id + if account_id is not None: + self.account_id = account_id + if quantities is not None: + self.quantities = quantities + if discounts is not None: + self.discounts = discounts + if quote_for is not None: + self.quote_for = quote_for + self.period_start = period_start + self.period_end = period_end + if total_periods is not None: + self.total_periods = total_periods + if proration_enabled is not None: + self.proration_enabled = proration_enabled + if uplift is not None: + self.uplift = uplift + if coupon_codes is not None: + self.coupon_codes = coupon_codes + if organization_id is not None: + self.organization_id = organization_id + if same_product_period is not None: + self.same_product_period = same_product_period + if purchase_order is not None: + self.purchase_order = purchase_order @property def created(self): - """ - Gets the created of this APIQuote. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this ApiQuote. # noqa: E501 - :return: The created of this APIQuote. + + :return: The created of this ApiQuote. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this APIQuote. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this ApiQuote. + - :param created: The created of this APIQuote. + :param created: The created of this ApiQuote. # noqa: E501 :type: datetime """ @@ -159,45 +218,83 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this APIQuote. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this ApiQuote. # noqa: E501 + - :return: The changed_by of this APIQuote. + :return: The changed_by of this ApiQuote. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this APIQuote. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this ApiQuote. - :param changed_by: The changed_by of this APIQuote. + + :param changed_by: The changed_by of this ApiQuote. # noqa: E501 :type: str """ self._changed_by = changed_by @property - def subtotal(self): + def updated(self): + """Gets the updated of this ApiQuote. # noqa: E501 + + + :return: The updated of this ApiQuote. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this ApiQuote. + + + :param updated: The updated of this ApiQuote. # noqa: E501 + :type: datetime """ - Gets the subtotal of this APIQuote. - {\"description\":\"The cost — including tax, but excluding discounts — of all items described in the quote.\",\"verbs\":[\"POST\",\"GET\"]} - :return: The subtotal of this APIQuote. + self._updated = updated + + @property + def id(self): + """Gets the id of this ApiQuote. # noqa: E501 + + + :return: The id of this ApiQuote. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this ApiQuote. + + + :param id: The id of this ApiQuote. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def subtotal(self): + """Gets the subtotal of this ApiQuote. # noqa: E501 + + + :return: The subtotal of this ApiQuote. # noqa: E501 :rtype: float """ return self._subtotal @subtotal.setter def subtotal(self, subtotal): - """ - Sets the subtotal of this APIQuote. - {\"description\":\"The cost — including tax, but excluding discounts — of all items described in the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the subtotal of this ApiQuote. - :param subtotal: The subtotal of this APIQuote. + + :param subtotal: The subtotal of this ApiQuote. # noqa: E501 :type: float """ @@ -205,22 +302,20 @@ def subtotal(self, subtotal): @property def subtotal_excluding_tax(self): - """ - Gets the subtotal_excluding_tax of this APIQuote. - {\"description\":\"The cost — excluding tax, and excluding discounts — of all items described in the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the subtotal_excluding_tax of this ApiQuote. # noqa: E501 + - :return: The subtotal_excluding_tax of this APIQuote. + :return: The subtotal_excluding_tax of this ApiQuote. # noqa: E501 :rtype: float """ return self._subtotal_excluding_tax @subtotal_excluding_tax.setter def subtotal_excluding_tax(self, subtotal_excluding_tax): - """ - Sets the subtotal_excluding_tax of this APIQuote. - {\"description\":\"The cost — excluding tax, and excluding discounts — of all items described in the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the subtotal_excluding_tax of this ApiQuote. + - :param subtotal_excluding_tax: The subtotal_excluding_tax of this APIQuote. + :param subtotal_excluding_tax: The subtotal_excluding_tax of this ApiQuote. # noqa: E501 :type: float """ @@ -228,22 +323,20 @@ def subtotal_excluding_tax(self, subtotal_excluding_tax): @property def total(self): - """ - Gets the total of this APIQuote. - {\"description\":\"The cost — including tax, and with discounts (themselves including tax) applied — of all items described in the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the total of this ApiQuote. # noqa: E501 + - :return: The total of this APIQuote. + :return: The total of this ApiQuote. # noqa: E501 :rtype: float """ return self._total @total.setter def total(self, total): - """ - Sets the total of this APIQuote. - {\"description\":\"The cost — including tax, and with discounts (themselves including tax) applied — of all items described in the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the total of this ApiQuote. + - :param total: The total of this APIQuote. + :param total: The total of this ApiQuote. # noqa: E501 :type: float """ @@ -251,22 +344,20 @@ def total(self, total): @property def total_excluding_tax(self): - """ - Gets the total_excluding_tax of this APIQuote. - {\"description\":\"The cost — excluding tax, and with discounts (themselves excluding tax) applied — of all items described in the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the total_excluding_tax of this ApiQuote. # noqa: E501 - :return: The total_excluding_tax of this APIQuote. + + :return: The total_excluding_tax of this ApiQuote. # noqa: E501 :rtype: float """ return self._total_excluding_tax @total_excluding_tax.setter def total_excluding_tax(self, total_excluding_tax): - """ - Sets the total_excluding_tax of this APIQuote. - {\"description\":\"The cost — excluding tax, and with discounts (themselves excluding tax) applied — of all items described in the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the total_excluding_tax of this ApiQuote. + - :param total_excluding_tax: The total_excluding_tax of this APIQuote. + :param total_excluding_tax: The total_excluding_tax of this ApiQuote. # noqa: E501 :type: float """ @@ -274,22 +365,20 @@ def total_excluding_tax(self, total_excluding_tax): @property def tax(self): - """ - Gets the tax of this APIQuote. - {\"description\":\"The portion of this quote's cost which is comprised of tax.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the tax of this ApiQuote. # noqa: E501 + - :return: The tax of this APIQuote. + :return: The tax of this ApiQuote. # noqa: E501 :rtype: float """ return self._tax @tax.setter def tax(self, tax): - """ - Sets the tax of this APIQuote. - {\"description\":\"The portion of this quote's cost which is comprised of tax.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the tax of this ApiQuote. - :param tax: The tax of this APIQuote. + + :param tax: The tax of this ApiQuote. # noqa: E501 :type: float """ @@ -297,22 +386,20 @@ def tax(self, tax): @property def discount(self): - """ - Gets the discount of this APIQuote. - {\"description\":\"Total amount deducted from price via discounts — includes any tax upon the discounts themselves.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the discount of this ApiQuote. # noqa: E501 + - :return: The discount of this APIQuote. + :return: The discount of this ApiQuote. # noqa: E501 :rtype: float """ return self._discount @discount.setter def discount(self, discount): - """ - Sets the discount of this APIQuote. - {\"description\":\"Total amount deducted from price via discounts — includes any tax upon the discounts themselves.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the discount of this ApiQuote. + - :param discount: The discount of this APIQuote. + :param discount: The discount of this ApiQuote. # noqa: E501 :type: float """ @@ -320,22 +407,20 @@ def discount(self, discount): @property def discount_excluding_tax(self): - """ - Gets the discount_excluding_tax of this APIQuote. - {\"description\":\"Total amount deducted from price via discounts — excludes any tax upon the discounts themselves.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the discount_excluding_tax of this ApiQuote. # noqa: E501 - :return: The discount_excluding_tax of this APIQuote. + + :return: The discount_excluding_tax of this ApiQuote. # noqa: E501 :rtype: float """ return self._discount_excluding_tax @discount_excluding_tax.setter def discount_excluding_tax(self, discount_excluding_tax): - """ - Sets the discount_excluding_tax of this APIQuote. - {\"description\":\"Total amount deducted from price via discounts — excludes any tax upon the discounts themselves.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the discount_excluding_tax of this ApiQuote. + - :param discount_excluding_tax: The discount_excluding_tax of this APIQuote. + :param discount_excluding_tax: The discount_excluding_tax of this ApiQuote. # noqa: E501 :type: float """ @@ -343,45 +428,41 @@ def discount_excluding_tax(self, discount_excluding_tax): @property def currency(self): - """ - Gets the currency of this APIQuote. - {\"description\":\"The currency of any quoted prices — as specified by a three-character ISO 4217 currency code (i.e. USD).\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the currency of this ApiQuote. # noqa: E501 - :return: The currency of this APIQuote. - :rtype: str + + :return: The currency of this ApiQuote. # noqa: E501 + :rtype: CreditNoteCurrency """ return self._currency @currency.setter def currency(self, currency): - """ - Sets the currency of this APIQuote. - {\"description\":\"The currency of any quoted prices — as specified by a three-character ISO 4217 currency code (i.e. USD).\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the currency of this ApiQuote. - :param currency: The currency of this APIQuote. - :type: str + + :param currency: The currency of this ApiQuote. # noqa: E501 + :type: CreditNoteCurrency """ self._currency = currency @property def product_name(self): - """ - Gets the product_name of this APIQuote. - {\"description\":\"Name of the product for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the product_name of this ApiQuote. # noqa: E501 - :return: The product_name of this APIQuote. + + :return: The product_name of this ApiQuote. # noqa: E501 :rtype: str """ return self._product_name @product_name.setter def product_name(self, product_name): - """ - Sets the product_name of this APIQuote. - {\"description\":\"Name of the product for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the product_name of this ApiQuote. + - :param product_name: The product_name of this APIQuote. + :param product_name: The product_name of this ApiQuote. # noqa: E501 :type: str """ @@ -389,22 +470,20 @@ def product_name(self, product_name): @property def public_product_name(self): - """ - Gets the public_product_name of this APIQuote. - {\"description\":\"Public name of the product for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the public_product_name of this ApiQuote. # noqa: E501 + - :return: The public_product_name of this APIQuote. + :return: The public_product_name of this ApiQuote. # noqa: E501 :rtype: str """ return self._public_product_name @public_product_name.setter def public_product_name(self, public_product_name): - """ - Sets the public_product_name of this APIQuote. - {\"description\":\"Public name of the product for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the public_product_name of this ApiQuote. - :param public_product_name: The public_product_name of this APIQuote. + + :param public_product_name: The public_product_name of this ApiQuote. # noqa: E501 :type: str """ @@ -412,22 +491,20 @@ def public_product_name(self, public_product_name): @property def product_rate_plan_name(self): - """ - Gets the product_rate_plan_name of this APIQuote. - {\"description\":\"Name of the rate plan (of some product) for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the product_rate_plan_name of this ApiQuote. # noqa: E501 + - :return: The product_rate_plan_name of this APIQuote. + :return: The product_rate_plan_name of this ApiQuote. # noqa: E501 :rtype: str """ return self._product_rate_plan_name @product_rate_plan_name.setter def product_rate_plan_name(self, product_rate_plan_name): - """ - Sets the product_rate_plan_name of this APIQuote. - {\"description\":\"Name of the rate plan (of some product) for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the product_rate_plan_name of this ApiQuote. + - :param product_rate_plan_name: The product_rate_plan_name of this APIQuote. + :param product_rate_plan_name: The product_rate_plan_name of this ApiQuote. # noqa: E501 :type: str """ @@ -435,22 +512,20 @@ def product_rate_plan_name(self, product_rate_plan_name): @property def public_product_rate_plan_name(self): - """ - Gets the public_product_rate_plan_name of this APIQuote. - {\"description\":\"Public name of the rate plan (of some product) for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the public_product_rate_plan_name of this ApiQuote. # noqa: E501 - :return: The public_product_rate_plan_name of this APIQuote. + + :return: The public_product_rate_plan_name of this ApiQuote. # noqa: E501 :rtype: str """ return self._public_product_rate_plan_name @public_product_rate_plan_name.setter def public_product_rate_plan_name(self, public_product_rate_plan_name): - """ - Sets the public_product_rate_plan_name of this APIQuote. - {\"description\":\"Public name of the rate plan (of some product) for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the public_product_rate_plan_name of this ApiQuote. + - :param public_product_rate_plan_name: The public_product_rate_plan_name of this APIQuote. + :param public_product_rate_plan_name: The public_product_rate_plan_name of this ApiQuote. # noqa: E501 :type: str """ @@ -458,22 +533,20 @@ def public_product_rate_plan_name(self, public_product_rate_plan_name): @property def product_id(self): - """ - Gets the product_id of this APIQuote. - {\"description\":\"ID of the product for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the product_id of this ApiQuote. # noqa: E501 + - :return: The product_id of this APIQuote. + :return: The product_id of this ApiQuote. # noqa: E501 :rtype: str """ return self._product_id @product_id.setter def product_id(self, product_id): - """ - Sets the product_id of this APIQuote. - {\"description\":\"ID of the product for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the product_id of this ApiQuote. - :param product_id: The product_id of this APIQuote. + + :param product_id: The product_id of this ApiQuote. # noqa: E501 :type: str """ @@ -481,22 +554,20 @@ def product_id(self, product_id): @property def product_rate_plan_id(self): - """ - Gets the product_rate_plan_id of this APIQuote. - {\"description\":\"ID of the rate plan (of some product) for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the product_rate_plan_id of this ApiQuote. # noqa: E501 + - :return: The product_rate_plan_id of this APIQuote. + :return: The product_rate_plan_id of this ApiQuote. # noqa: E501 :rtype: str """ return self._product_rate_plan_id @product_rate_plan_id.setter def product_rate_plan_id(self, product_rate_plan_id): - """ - Sets the product_rate_plan_id of this APIQuote. - {\"description\":\"ID of the rate plan (of some product) for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the product_rate_plan_id of this ApiQuote. + - :param product_rate_plan_id: The product_rate_plan_id of this APIQuote. + :param product_rate_plan_id: The product_rate_plan_id of this ApiQuote. # noqa: E501 :type: str """ @@ -504,22 +575,20 @@ def product_rate_plan_id(self, product_rate_plan_id): @property def subscription_id(self): - """ - Gets the subscription_id of this APIQuote. - {\"description\":\"ID of the subscription for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the subscription_id of this ApiQuote. # noqa: E501 + - :return: The subscription_id of this APIQuote. + :return: The subscription_id of this ApiQuote. # noqa: E501 :rtype: str """ return self._subscription_id @subscription_id.setter def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this APIQuote. - {\"description\":\"ID of the subscription for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the subscription_id of this ApiQuote. + - :param subscription_id: The subscription_id of this APIQuote. + :param subscription_id: The subscription_id of this ApiQuote. # noqa: E501 :type: str """ @@ -527,22 +596,20 @@ def subscription_id(self, subscription_id): @property def account_id(self): - """ - Gets the account_id of this APIQuote. - {\"description\":\"ID of the account for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the account_id of this ApiQuote. # noqa: E501 - :return: The account_id of this APIQuote. + + :return: The account_id of this ApiQuote. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this APIQuote. - {\"description\":\"ID of the account for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the account_id of this ApiQuote. + - :param account_id: The account_id of this APIQuote. + :param account_id: The account_id of this ApiQuote. # noqa: E501 :type: str """ @@ -550,22 +617,20 @@ def account_id(self, account_id): @property def quantities(self): - """ - Gets the quantities of this APIQuote. - {\"description\":\"A list of calculated prices for each pricing component described in the quote request.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the quantities of this ApiQuote. # noqa: E501 + - :return: The quantities of this APIQuote. + :return: The quantities of this ApiQuote. # noqa: E501 :rtype: list[APIQuoteResponseQuantity] """ return self._quantities @quantities.setter def quantities(self, quantities): - """ - Sets the quantities of this APIQuote. - {\"description\":\"A list of calculated prices for each pricing component described in the quote request.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the quantities of this ApiQuote. - :param quantities: The quantities of this APIQuote. + + :param quantities: The quantities of this ApiQuote. # noqa: E501 :type: list[APIQuoteResponseQuantity] """ @@ -573,22 +638,20 @@ def quantities(self, quantities): @property def discounts(self): - """ - Gets the discounts of this APIQuote. - {\"description\":\"A list of discounts applied in calculating the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the discounts of this ApiQuote. # noqa: E501 + - :return: The discounts of this APIQuote. + :return: The discounts of this ApiQuote. # noqa: E501 :rtype: list[CouponWrapperResponse] """ return self._discounts @discounts.setter def discounts(self, discounts): - """ - Sets the discounts of this APIQuote. - {\"description\":\"A list of discounts applied in calculating the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the discounts of this ApiQuote. + - :param discounts: The discounts of this APIQuote. + :param discounts: The discounts of this ApiQuote. # noqa: E501 :type: list[CouponWrapperResponse] """ @@ -596,28 +659,26 @@ def discounts(self, discounts): @property def quote_for(self): - """ - Gets the quote_for of this APIQuote. - {\"default\":\"RecurringPeriod\",\"description\":\"Subscription scenario with which the quote is concerned.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the quote_for of this ApiQuote. # noqa: E501 - :return: The quote_for of this APIQuote. + + :return: The quote_for of this ApiQuote. # noqa: E501 :rtype: str """ return self._quote_for @quote_for.setter def quote_for(self, quote_for): - """ - Sets the quote_for of this APIQuote. - {\"default\":\"RecurringPeriod\",\"description\":\"Subscription scenario with which the quote is concerned.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the quote_for of this ApiQuote. + - :param quote_for: The quote_for of this APIQuote. + :param quote_for: The quote_for of this ApiQuote. # noqa: E501 :type: str """ - allowed_values = ["InitialPeriod", "RecurringPeriod", "Upgrade", "Migration"] + allowed_values = ["InitialPeriod", "RecurringPeriod", "Upgrade", "Migration"] # noqa: E501 if quote_for not in allowed_values: raise ValueError( - "Invalid value for `quote_for` ({0}), must be one of {1}" + "Invalid value for `quote_for` ({0}), must be one of {1}" # noqa: E501 .format(quote_for, allowed_values) ) @@ -625,68 +686,66 @@ def quote_for(self, quote_for): @property def period_start(self): - """ - Gets the period_start of this APIQuote. - {\"default\":\"(Time at which quote is requested)\",\"description\":\"The start date-time of the interval for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the period_start of this ApiQuote. # noqa: E501 + - :return: The period_start of this APIQuote. + :return: The period_start of this ApiQuote. # noqa: E501 :rtype: datetime """ return self._period_start @period_start.setter def period_start(self, period_start): - """ - Sets the period_start of this APIQuote. - {\"default\":\"(Time at which quote is requested)\",\"description\":\"The start date-time of the interval for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the period_start of this ApiQuote. - :param period_start: The period_start of this APIQuote. + + :param period_start: The period_start of this ApiQuote. # noqa: E501 :type: datetime """ + if period_start is None: + raise ValueError("Invalid value for `period_start`, must not be `None`") # noqa: E501 self._period_start = period_start @property def period_end(self): - """ - Gets the period_end of this APIQuote. - {\"default\":\"(End of period described in `periodStart`)\",\"description\":\"The end date-time of the interval for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the period_end of this ApiQuote. # noqa: E501 - :return: The period_end of this APIQuote. + + :return: The period_end of this ApiQuote. # noqa: E501 :rtype: datetime """ return self._period_end @period_end.setter def period_end(self, period_end): - """ - Sets the period_end of this APIQuote. - {\"default\":\"(End of period described in `periodStart`)\",\"description\":\"The end date-time of the interval for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the period_end of this ApiQuote. - :param period_end: The period_end of this APIQuote. + + :param period_end: The period_end of this ApiQuote. # noqa: E501 :type: datetime """ + if period_end is None: + raise ValueError("Invalid value for `period_end`, must not be `None`") # noqa: E501 self._period_end = period_end @property def total_periods(self): - """ - Gets the total_periods of this APIQuote. - {\"default\":\"ZERO\",\"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the total_periods of this ApiQuote. # noqa: E501 + - :return: The total_periods of this APIQuote. + :return: The total_periods of this ApiQuote. # noqa: E501 :rtype: float """ return self._total_periods @total_periods.setter def total_periods(self, total_periods): - """ - Sets the total_periods of this APIQuote. - {\"default\":\"ZERO\",\"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the total_periods of this ApiQuote. + - :param total_periods: The total_periods of this APIQuote. + :param total_periods: The total_periods of this ApiQuote. # noqa: E501 :type: float """ @@ -694,22 +753,20 @@ def total_periods(self, total_periods): @property def proration_enabled(self): - """ - Gets the proration_enabled of this APIQuote. - {\"default\":true,\"description\":\"Whether consumption for fractions/multiples of periods is calculated as a fraction/multiple of the cost of consumption for a whole period.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the proration_enabled of this ApiQuote. # noqa: E501 - :return: The proration_enabled of this APIQuote. + + :return: The proration_enabled of this ApiQuote. # noqa: E501 :rtype: bool """ return self._proration_enabled @proration_enabled.setter def proration_enabled(self, proration_enabled): - """ - Sets the proration_enabled of this APIQuote. - {\"default\":true,\"description\":\"Whether consumption for fractions/multiples of periods is calculated as a fraction/multiple of the cost of consumption for a whole period.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the proration_enabled of this ApiQuote. + - :param proration_enabled: The proration_enabled of this APIQuote. + :param proration_enabled: The proration_enabled of this ApiQuote. # noqa: E501 :type: bool """ @@ -717,22 +774,20 @@ def proration_enabled(self, proration_enabled): @property def uplift(self): - """ - Gets the uplift of this APIQuote. - {\"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the uplift of this ApiQuote. # noqa: E501 + - :return: The uplift of this APIQuote. + :return: The uplift of this ApiQuote. # noqa: E501 :rtype: float """ return self._uplift @uplift.setter def uplift(self, uplift): - """ - Sets the uplift of this APIQuote. - {\"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the uplift of this ApiQuote. - :param uplift: The uplift of this APIQuote. + + :param uplift: The uplift of this ApiQuote. # noqa: E501 :type: float """ @@ -740,22 +795,20 @@ def uplift(self, uplift): @property def coupon_codes(self): - """ - Gets the coupon_codes of this APIQuote. - {\"description\":\"A list of coupon codes to consider in calculating the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the coupon_codes of this ApiQuote. # noqa: E501 + - :return: The coupon_codes of this APIQuote. + :return: The coupon_codes of this ApiQuote. # noqa: E501 :rtype: list[str] """ return self._coupon_codes @coupon_codes.setter def coupon_codes(self, coupon_codes): - """ - Sets the coupon_codes of this APIQuote. - {\"description\":\"A list of coupon codes to consider in calculating the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the coupon_codes of this ApiQuote. + - :param coupon_codes: The coupon_codes of this APIQuote. + :param coupon_codes: The coupon_codes of this ApiQuote. # noqa: E501 :type: list[str] """ @@ -763,22 +816,20 @@ def coupon_codes(self, coupon_codes): @property def organization_id(self): - """ - Gets the organization_id of this APIQuote. - {\"description\":\"ID of the organization in whose name the quote was generated.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the organization_id of this ApiQuote. # noqa: E501 - :return: The organization_id of this APIQuote. + + :return: The organization_id of this ApiQuote. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this APIQuote. - {\"description\":\"ID of the organization in whose name the quote was generated.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the organization_id of this ApiQuote. + - :param organization_id: The organization_id of this APIQuote. + :param organization_id: The organization_id of this ApiQuote. # noqa: E501 :type: str """ @@ -786,34 +837,51 @@ def organization_id(self, organization_id): @property def same_product_period(self): - """ - Gets the same_product_period of this APIQuote. - {\"description\":\"If migration quote whether or not the rate plans have the same duration\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the same_product_period of this ApiQuote. # noqa: E501 + - :return: The same_product_period of this APIQuote. + :return: The same_product_period of this ApiQuote. # noqa: E501 :rtype: bool """ return self._same_product_period @same_product_period.setter def same_product_period(self, same_product_period): - """ - Sets the same_product_period of this APIQuote. - {\"description\":\"If migration quote whether or not the rate plans have the same duration\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the same_product_period of this ApiQuote. + - :param same_product_period: The same_product_period of this APIQuote. + :param same_product_period: The same_product_period of this ApiQuote. # noqa: E501 :type: bool """ self._same_product_period = same_product_period - def to_dict(self): + @property + def purchase_order(self): + """Gets the purchase_order of this ApiQuote. # noqa: E501 + + + :return: The purchase_order of this ApiQuote. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this ApiQuote. + + + :param purchase_order: The purchase_order of this ApiQuote. # noqa: E501 + :type: str """ + + self._purchase_order = purchase_order + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -830,29 +898,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(ApiQuote, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, ApiQuote): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/api_quote_paged_metadata.py b/billforward/models/api_quote_paged_metadata.py deleted file mode 100644 index aa21cbf..0000000 --- a/billforward/models/api_quote_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class APIQuotePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - APIQuotePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[APIQuote]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this APIQuotePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this APIQuotePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this APIQuotePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this APIQuotePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this APIQuotePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this APIQuotePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this APIQuotePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this APIQuotePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this APIQuotePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this APIQuotePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this APIQuotePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this APIQuotePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this APIQuotePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this APIQuotePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this APIQuotePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this APIQuotePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this APIQuotePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this APIQuotePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this APIQuotePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this APIQuotePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this APIQuotePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this APIQuotePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this APIQuotePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this APIQuotePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this APIQuotePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this APIQuotePagedMetadata. - :rtype: list[APIQuote] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this APIQuotePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this APIQuotePagedMetadata. - :type: list[APIQuote] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/api_quote_response_quantity.py b/billforward/models/api_quote_response_quantity.py index 83d38bf..5fe89d6 100644 --- a/billforward/models/api_quote_response_quantity.py +++ b/billforward/models/api_quote_response_quantity.py @@ -1,124 +1,293 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class APIQuoteResponseQuantity(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, pricing_component_name=None, pricing_component_type=None, pricing_component_id=None, quantity=None, existing_quantity=None, final_cost=None, final_cost_excluding_tax=None, cost=None, cost_excluding_tax=None, tax=None, discount=None, discount_excluding_tax=None, unit_of_measure_id=None, unit_of_measure_name=None, unit_of_measure_display=None, unit_of_measure=None, applies_from=None, discounts=None): - """ - APIQuoteResponseQuantity - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'pricing_component_name': 'str', - 'pricing_component_type': 'str', - 'pricing_component_id': 'str', - 'quantity': 'int', - 'existing_quantity': 'int', - 'final_cost': 'float', - 'final_cost_excluding_tax': 'float', - 'cost': 'float', - 'cost_excluding_tax': 'float', - 'tax': 'float', - 'discount': 'float', - 'discount_excluding_tax': 'float', - 'unit_of_measure_id': 'str', - 'unit_of_measure_name': 'str', - 'unit_of_measure_display': 'str', - 'unit_of_measure': 'str', - 'applies_from': 'datetime', - 'discounts': 'list[CouponWrapperResponse]' - } - - self.attribute_map = { - 'pricing_component_name': 'pricingComponentName', - 'pricing_component_type': 'pricingComponentType', - 'pricing_component_id': 'pricingComponentID', - 'quantity': 'quantity', - 'existing_quantity': 'existingQuantity', - 'final_cost': 'finalCost', - 'final_cost_excluding_tax': 'finalCostExcludingTax', - 'cost': 'cost', - 'cost_excluding_tax': 'costExcludingTax', - 'tax': 'tax', - 'discount': 'discount', - 'discount_excluding_tax': 'discountExcludingTax', - 'unit_of_measure_id': 'unitOfMeasureID', - 'unit_of_measure_name': 'unitOfMeasureName', - 'unit_of_measure_display': 'unitOfMeasureDisplay', - 'unit_of_measure': 'unitOfMeasure', - 'applies_from': 'appliesFrom', - 'discounts': 'discounts' - } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'pricing_component_name': 'str', + 'pricing_component_type': 'str', + 'pricing_component_id': 'str', + 'quantity': 'int', + 'existing_quantity': 'int', + 'final_cost': 'float', + 'final_cost_excluding_tax': 'float', + 'cost': 'float', + 'cost_excluding_tax': 'float', + 'tax': 'float', + 'discount': 'float', + 'discount_excluding_tax': 'float', + 'percentage_discount': 'float', + 'unit_of_measure_id': 'str', + 'unit_of_measure_name': 'str', + 'unit_of_measure_display': 'str', + 'unit_of_measure': 'str', + 'applies_from': 'datetime', + 'charge_model': 'str', + 'discounts': 'list[CouponWrapperResponse]', + 'price_breakdown': 'PriceBreakdown' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'pricing_component_name': 'pricingComponentName', + 'pricing_component_type': 'pricingComponentType', + 'pricing_component_id': 'pricingComponentID', + 'quantity': 'quantity', + 'existing_quantity': 'existingQuantity', + 'final_cost': 'finalCost', + 'final_cost_excluding_tax': 'finalCostExcludingTax', + 'cost': 'cost', + 'cost_excluding_tax': 'costExcludingTax', + 'tax': 'tax', + 'discount': 'discount', + 'discount_excluding_tax': 'discountExcludingTax', + 'percentage_discount': 'percentageDiscount', + 'unit_of_measure_id': 'unitOfMeasureID', + 'unit_of_measure_name': 'unitOfMeasureName', + 'unit_of_measure_display': 'unitOfMeasureDisplay', + 'unit_of_measure': 'unitOfMeasure', + 'applies_from': 'appliesFrom', + 'charge_model': 'chargeModel', + 'discounts': 'discounts', + 'price_breakdown': 'priceBreakdown' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, pricing_component_name=None, pricing_component_type=None, pricing_component_id=None, quantity=None, existing_quantity=None, final_cost=None, final_cost_excluding_tax=None, cost=None, cost_excluding_tax=None, tax=None, discount=None, discount_excluding_tax=None, percentage_discount=None, unit_of_measure_id=None, unit_of_measure_name=None, unit_of_measure_display=None, unit_of_measure=None, applies_from=None, charge_model=None, discounts=None, price_breakdown=None): # noqa: E501 + """APIQuoteResponseQuantity - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._pricing_component_name = None + self._pricing_component_type = None + self._pricing_component_id = None + self._quantity = None + self._existing_quantity = None + self._final_cost = None + self._final_cost_excluding_tax = None + self._cost = None + self._cost_excluding_tax = None + self._tax = None + self._discount = None + self._discount_excluding_tax = None + self._percentage_discount = None + self._unit_of_measure_id = None + self._unit_of_measure_name = None + self._unit_of_measure_display = None + self._unit_of_measure = None + self._applies_from = None + self._charge_model = None + self._discounts = None + self._price_breakdown = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if pricing_component_type is not None: + self.pricing_component_type = pricing_component_type + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + if quantity is not None: + self.quantity = quantity + if existing_quantity is not None: + self.existing_quantity = existing_quantity + if final_cost is not None: + self.final_cost = final_cost + if final_cost_excluding_tax is not None: + self.final_cost_excluding_tax = final_cost_excluding_tax + if cost is not None: + self.cost = cost + if cost_excluding_tax is not None: + self.cost_excluding_tax = cost_excluding_tax + if tax is not None: + self.tax = tax + if discount is not None: + self.discount = discount + if discount_excluding_tax is not None: + self.discount_excluding_tax = discount_excluding_tax + if percentage_discount is not None: + self.percentage_discount = percentage_discount + if unit_of_measure_id is not None: + self.unit_of_measure_id = unit_of_measure_id + if unit_of_measure_name is not None: + self.unit_of_measure_name = unit_of_measure_name + if unit_of_measure_display is not None: + self.unit_of_measure_display = unit_of_measure_display + if unit_of_measure is not None: + self.unit_of_measure = unit_of_measure + if applies_from is not None: + self.applies_from = applies_from + if charge_model is not None: + self.charge_model = charge_model + if discounts is not None: + self.discounts = discounts + if price_breakdown is not None: + self.price_breakdown = price_breakdown - self._pricing_component_name = pricing_component_name - self._pricing_component_type = pricing_component_type - self._pricing_component_id = pricing_component_id - self._quantity = quantity - self._existing_quantity = existing_quantity - self._final_cost = final_cost - self._final_cost_excluding_tax = final_cost_excluding_tax - self._cost = cost - self._cost_excluding_tax = cost_excluding_tax - self._tax = tax - self._discount = discount - self._discount_excluding_tax = discount_excluding_tax - self._unit_of_measure_id = unit_of_measure_id - self._unit_of_measure_name = unit_of_measure_name - self._unit_of_measure_display = unit_of_measure_display - self._unit_of_measure = unit_of_measure - self._applies_from = applies_from - self._discounts = discounts + @property + def created(self): + """Gets the created of this APIQuoteResponseQuantity. # noqa: E501 + + + :return: The created of this APIQuoteResponseQuantity. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this APIQuoteResponseQuantity. + + + :param created: The created of this APIQuoteResponseQuantity. # noqa: E501 + :type: datetime + """ + + self._created = created @property - def pricing_component_name(self): + def changed_by(self): + """Gets the changed_by of this APIQuoteResponseQuantity. # noqa: E501 + + + :return: The changed_by of this APIQuoteResponseQuantity. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this APIQuoteResponseQuantity. + + + :param changed_by: The changed_by of this APIQuoteResponseQuantity. # noqa: E501 + :type: str """ - Gets the pricing_component_name of this APIQuoteResponseQuantity. - {\"description\":\"Name of the pricing component whose price was calculated.\",\"verbs\":[\"POST\",\"GET\"]} - :return: The pricing_component_name of this APIQuoteResponseQuantity. + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this APIQuoteResponseQuantity. # noqa: E501 + + + :return: The updated of this APIQuoteResponseQuantity. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this APIQuoteResponseQuantity. + + + :param updated: The updated of this APIQuoteResponseQuantity. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this APIQuoteResponseQuantity. # noqa: E501 + + + :return: The id of this APIQuoteResponseQuantity. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this APIQuoteResponseQuantity. + + + :param id: The id of this APIQuoteResponseQuantity. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this APIQuoteResponseQuantity. # noqa: E501 + + + :return: The organization_id of this APIQuoteResponseQuantity. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this APIQuoteResponseQuantity. + + + :param organization_id: The organization_id of this APIQuoteResponseQuantity. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this APIQuoteResponseQuantity. # noqa: E501 + + + :return: The pricing_component_name of this APIQuoteResponseQuantity. # noqa: E501 :rtype: str """ return self._pricing_component_name @pricing_component_name.setter def pricing_component_name(self, pricing_component_name): - """ - Sets the pricing_component_name of this APIQuoteResponseQuantity. - {\"description\":\"Name of the pricing component whose price was calculated.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the pricing_component_name of this APIQuoteResponseQuantity. + - :param pricing_component_name: The pricing_component_name of this APIQuoteResponseQuantity. + :param pricing_component_name: The pricing_component_name of this APIQuoteResponseQuantity. # noqa: E501 :type: str """ @@ -126,28 +295,26 @@ def pricing_component_name(self, pricing_component_name): @property def pricing_component_type(self): - """ - Gets the pricing_component_type of this APIQuoteResponseQuantity. - {\"description\":\"Charge type of the pricing component whose price was calculated.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the pricing_component_type of this APIQuoteResponseQuantity. # noqa: E501 - :return: The pricing_component_type of this APIQuoteResponseQuantity. + + :return: The pricing_component_type of this APIQuoteResponseQuantity. # noqa: E501 :rtype: str """ return self._pricing_component_type @pricing_component_type.setter def pricing_component_type(self, pricing_component_type): - """ - Sets the pricing_component_type of this APIQuoteResponseQuantity. - {\"description\":\"Charge type of the pricing component whose price was calculated.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the pricing_component_type of this APIQuoteResponseQuantity. + - :param pricing_component_type: The pricing_component_type of this APIQuoteResponseQuantity. + :param pricing_component_type: The pricing_component_type of this APIQuoteResponseQuantity. # noqa: E501 :type: str """ - allowed_values = ["setup", "subscription", "arrears", "usage"] + allowed_values = ["setup", "subscription", "arrears", "usage"] # noqa: E501 if pricing_component_type not in allowed_values: raise ValueError( - "Invalid value for `pricing_component_type` ({0}), must be one of {1}" + "Invalid value for `pricing_component_type` ({0}), must be one of {1}" # noqa: E501 .format(pricing_component_type, allowed_values) ) @@ -155,22 +322,20 @@ def pricing_component_type(self, pricing_component_type): @property def pricing_component_id(self): - """ - Gets the pricing_component_id of this APIQuoteResponseQuantity. - {\"description\":\"ID of the pricing component whose price was calculated.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the pricing_component_id of this APIQuoteResponseQuantity. # noqa: E501 + - :return: The pricing_component_id of this APIQuoteResponseQuantity. + :return: The pricing_component_id of this APIQuoteResponseQuantity. # noqa: E501 :rtype: str """ return self._pricing_component_id @pricing_component_id.setter def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this APIQuoteResponseQuantity. - {\"description\":\"ID of the pricing component whose price was calculated.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the pricing_component_id of this APIQuoteResponseQuantity. - :param pricing_component_id: The pricing_component_id of this APIQuoteResponseQuantity. + + :param pricing_component_id: The pricing_component_id of this APIQuoteResponseQuantity. # noqa: E501 :type: str """ @@ -178,22 +343,20 @@ def pricing_component_id(self, pricing_component_id): @property def quantity(self): - """ - Gets the quantity of this APIQuoteResponseQuantity. - {\"description\":\"Quantity of the pricing component whose price was calculated.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the quantity of this APIQuoteResponseQuantity. # noqa: E501 + - :return: The quantity of this APIQuoteResponseQuantity. + :return: The quantity of this APIQuoteResponseQuantity. # noqa: E501 :rtype: int """ return self._quantity @quantity.setter def quantity(self, quantity): - """ - Sets the quantity of this APIQuoteResponseQuantity. - {\"description\":\"Quantity of the pricing component whose price was calculated.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the quantity of this APIQuoteResponseQuantity. + - :param quantity: The quantity of this APIQuoteResponseQuantity. + :param quantity: The quantity of this APIQuoteResponseQuantity. # noqa: E501 :type: int """ @@ -201,22 +364,20 @@ def quantity(self, quantity): @property def existing_quantity(self): - """ - Gets the existing_quantity of this APIQuoteResponseQuantity. - {\"description\":\"Previous quantity of the pricing component. Price is calculated with respect to a delta from this quantity.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the existing_quantity of this APIQuoteResponseQuantity. # noqa: E501 - :return: The existing_quantity of this APIQuoteResponseQuantity. + + :return: The existing_quantity of this APIQuoteResponseQuantity. # noqa: E501 :rtype: int """ return self._existing_quantity @existing_quantity.setter def existing_quantity(self, existing_quantity): - """ - Sets the existing_quantity of this APIQuoteResponseQuantity. - {\"description\":\"Previous quantity of the pricing component. Price is calculated with respect to a delta from this quantity.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the existing_quantity of this APIQuoteResponseQuantity. - :param existing_quantity: The existing_quantity of this APIQuoteResponseQuantity. + + :param existing_quantity: The existing_quantity of this APIQuoteResponseQuantity. # noqa: E501 :type: int """ @@ -224,22 +385,20 @@ def existing_quantity(self, existing_quantity): @property def final_cost(self): - """ - Gets the final_cost of this APIQuoteResponseQuantity. - {\"description\":\"The cost — including tax, and with discounts (themselves including tax) applied — contributed by consumption of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the final_cost of this APIQuoteResponseQuantity. # noqa: E501 - :return: The final_cost of this APIQuoteResponseQuantity. + + :return: The final_cost of this APIQuoteResponseQuantity. # noqa: E501 :rtype: float """ return self._final_cost @final_cost.setter def final_cost(self, final_cost): - """ - Sets the final_cost of this APIQuoteResponseQuantity. - {\"description\":\"The cost — including tax, and with discounts (themselves including tax) applied — contributed by consumption of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the final_cost of this APIQuoteResponseQuantity. + - :param final_cost: The final_cost of this APIQuoteResponseQuantity. + :param final_cost: The final_cost of this APIQuoteResponseQuantity. # noqa: E501 :type: float """ @@ -247,22 +406,20 @@ def final_cost(self, final_cost): @property def final_cost_excluding_tax(self): - """ - Gets the final_cost_excluding_tax of this APIQuoteResponseQuantity. - {\"description\":\"The cost — excluding tax, and with discounts (themselves excluding tax) applied — contributed by consumption of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the final_cost_excluding_tax of this APIQuoteResponseQuantity. # noqa: E501 + - :return: The final_cost_excluding_tax of this APIQuoteResponseQuantity. + :return: The final_cost_excluding_tax of this APIQuoteResponseQuantity. # noqa: E501 :rtype: float """ return self._final_cost_excluding_tax @final_cost_excluding_tax.setter def final_cost_excluding_tax(self, final_cost_excluding_tax): - """ - Sets the final_cost_excluding_tax of this APIQuoteResponseQuantity. - {\"description\":\"The cost — excluding tax, and with discounts (themselves excluding tax) applied — contributed by consumption of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the final_cost_excluding_tax of this APIQuoteResponseQuantity. - :param final_cost_excluding_tax: The final_cost_excluding_tax of this APIQuoteResponseQuantity. + + :param final_cost_excluding_tax: The final_cost_excluding_tax of this APIQuoteResponseQuantity. # noqa: E501 :type: float """ @@ -270,22 +427,20 @@ def final_cost_excluding_tax(self, final_cost_excluding_tax): @property def cost(self): - """ - Gets the cost of this APIQuoteResponseQuantity. - {\"description\":\"The cost — including tax, but excluding discounts — contributed by consumption of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the cost of this APIQuoteResponseQuantity. # noqa: E501 + - :return: The cost of this APIQuoteResponseQuantity. + :return: The cost of this APIQuoteResponseQuantity. # noqa: E501 :rtype: float """ return self._cost @cost.setter def cost(self, cost): - """ - Sets the cost of this APIQuoteResponseQuantity. - {\"description\":\"The cost — including tax, but excluding discounts — contributed by consumption of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the cost of this APIQuoteResponseQuantity. + - :param cost: The cost of this APIQuoteResponseQuantity. + :param cost: The cost of this APIQuoteResponseQuantity. # noqa: E501 :type: float """ @@ -293,22 +448,20 @@ def cost(self, cost): @property def cost_excluding_tax(self): - """ - Gets the cost_excluding_tax of this APIQuoteResponseQuantity. - {\"description\":\"The cost — excluding tax, and excluding discounts — contributed by consumption of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the cost_excluding_tax of this APIQuoteResponseQuantity. # noqa: E501 - :return: The cost_excluding_tax of this APIQuoteResponseQuantity. + + :return: The cost_excluding_tax of this APIQuoteResponseQuantity. # noqa: E501 :rtype: float """ return self._cost_excluding_tax @cost_excluding_tax.setter def cost_excluding_tax(self, cost_excluding_tax): - """ - Sets the cost_excluding_tax of this APIQuoteResponseQuantity. - {\"description\":\"The cost — excluding tax, and excluding discounts — contributed by consumption of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the cost_excluding_tax of this APIQuoteResponseQuantity. + - :param cost_excluding_tax: The cost_excluding_tax of this APIQuoteResponseQuantity. + :param cost_excluding_tax: The cost_excluding_tax of this APIQuoteResponseQuantity. # noqa: E501 :type: float """ @@ -316,22 +469,20 @@ def cost_excluding_tax(self, cost_excluding_tax): @property def tax(self): - """ - Gets the tax of this APIQuoteResponseQuantity. - {\"description\":\"The portion of this pricing component's cost which is comprised of tax.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the tax of this APIQuoteResponseQuantity. # noqa: E501 + - :return: The tax of this APIQuoteResponseQuantity. + :return: The tax of this APIQuoteResponseQuantity. # noqa: E501 :rtype: float """ return self._tax @tax.setter def tax(self, tax): - """ - Sets the tax of this APIQuoteResponseQuantity. - {\"description\":\"The portion of this pricing component's cost which is comprised of tax.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the tax of this APIQuoteResponseQuantity. - :param tax: The tax of this APIQuoteResponseQuantity. + + :param tax: The tax of this APIQuoteResponseQuantity. # noqa: E501 :type: float """ @@ -339,22 +490,20 @@ def tax(self, tax): @property def discount(self): - """ - Gets the discount of this APIQuoteResponseQuantity. - {\"description\":\"The discount — including tax — applied to this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the discount of this APIQuoteResponseQuantity. # noqa: E501 + - :return: The discount of this APIQuoteResponseQuantity. + :return: The discount of this APIQuoteResponseQuantity. # noqa: E501 :rtype: float """ return self._discount @discount.setter def discount(self, discount): - """ - Sets the discount of this APIQuoteResponseQuantity. - {\"description\":\"The discount — including tax — applied to this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the discount of this APIQuoteResponseQuantity. + - :param discount: The discount of this APIQuoteResponseQuantity. + :param discount: The discount of this APIQuoteResponseQuantity. # noqa: E501 :type: float """ @@ -362,45 +511,62 @@ def discount(self, discount): @property def discount_excluding_tax(self): - """ - Gets the discount_excluding_tax of this APIQuoteResponseQuantity. - {\"description\":\"The discount — excluding tax — applied to this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the discount_excluding_tax of this APIQuoteResponseQuantity. # noqa: E501 + - :return: The discount_excluding_tax of this APIQuoteResponseQuantity. + :return: The discount_excluding_tax of this APIQuoteResponseQuantity. # noqa: E501 :rtype: float """ return self._discount_excluding_tax @discount_excluding_tax.setter def discount_excluding_tax(self, discount_excluding_tax): - """ - Sets the discount_excluding_tax of this APIQuoteResponseQuantity. - {\"description\":\"The discount — excluding tax — applied to this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the discount_excluding_tax of this APIQuoteResponseQuantity. + - :param discount_excluding_tax: The discount_excluding_tax of this APIQuoteResponseQuantity. + :param discount_excluding_tax: The discount_excluding_tax of this APIQuoteResponseQuantity. # noqa: E501 :type: float """ self._discount_excluding_tax = discount_excluding_tax @property - def unit_of_measure_id(self): + def percentage_discount(self): + """Gets the percentage_discount of this APIQuoteResponseQuantity. # noqa: E501 + + + :return: The percentage_discount of this APIQuoteResponseQuantity. # noqa: E501 + :rtype: float """ - Gets the unit_of_measure_id of this APIQuoteResponseQuantity. - {\"description\":\"ID of the 'Unit of Measure' entity — in which this pricing component is measured.\",\"verbs\":[\"POST\",\"GET\"]} + return self._percentage_discount - :return: The unit_of_measure_id of this APIQuoteResponseQuantity. + @percentage_discount.setter + def percentage_discount(self, percentage_discount): + """Sets the percentage_discount of this APIQuoteResponseQuantity. + + + :param percentage_discount: The percentage_discount of this APIQuoteResponseQuantity. # noqa: E501 + :type: float + """ + + self._percentage_discount = percentage_discount + + @property + def unit_of_measure_id(self): + """Gets the unit_of_measure_id of this APIQuoteResponseQuantity. # noqa: E501 + + + :return: The unit_of_measure_id of this APIQuoteResponseQuantity. # noqa: E501 :rtype: str """ return self._unit_of_measure_id @unit_of_measure_id.setter def unit_of_measure_id(self, unit_of_measure_id): - """ - Sets the unit_of_measure_id of this APIQuoteResponseQuantity. - {\"description\":\"ID of the 'Unit of Measure' entity — in which this pricing component is measured.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the unit_of_measure_id of this APIQuoteResponseQuantity. + - :param unit_of_measure_id: The unit_of_measure_id of this APIQuoteResponseQuantity. + :param unit_of_measure_id: The unit_of_measure_id of this APIQuoteResponseQuantity. # noqa: E501 :type: str """ @@ -408,22 +574,20 @@ def unit_of_measure_id(self, unit_of_measure_id): @property def unit_of_measure_name(self): - """ - Gets the unit_of_measure_name of this APIQuoteResponseQuantity. - {\"description\":\"Name of the 'Unit of Measure' entity — in which this pricing component is measured.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the unit_of_measure_name of this APIQuoteResponseQuantity. # noqa: E501 + - :return: The unit_of_measure_name of this APIQuoteResponseQuantity. + :return: The unit_of_measure_name of this APIQuoteResponseQuantity. # noqa: E501 :rtype: str """ return self._unit_of_measure_name @unit_of_measure_name.setter def unit_of_measure_name(self, unit_of_measure_name): - """ - Sets the unit_of_measure_name of this APIQuoteResponseQuantity. - {\"description\":\"Name of the 'Unit of Measure' entity — in which this pricing component is measured.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the unit_of_measure_name of this APIQuoteResponseQuantity. - :param unit_of_measure_name: The unit_of_measure_name of this APIQuoteResponseQuantity. + + :param unit_of_measure_name: The unit_of_measure_name of this APIQuoteResponseQuantity. # noqa: E501 :type: str """ @@ -431,22 +595,20 @@ def unit_of_measure_name(self, unit_of_measure_name): @property def unit_of_measure_display(self): - """ - Gets the unit_of_measure_display of this APIQuoteResponseQuantity. - {\"description\":\"Displayable units of the 'Unit of Measure' entity — in which this pricing component is measured.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the unit_of_measure_display of this APIQuoteResponseQuantity. # noqa: E501 - :return: The unit_of_measure_display of this APIQuoteResponseQuantity. + + :return: The unit_of_measure_display of this APIQuoteResponseQuantity. # noqa: E501 :rtype: str """ return self._unit_of_measure_display @unit_of_measure_display.setter def unit_of_measure_display(self, unit_of_measure_display): - """ - Sets the unit_of_measure_display of this APIQuoteResponseQuantity. - {\"description\":\"Displayable units of the 'Unit of Measure' entity — in which this pricing component is measured.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the unit_of_measure_display of this APIQuoteResponseQuantity. - :param unit_of_measure_display: The unit_of_measure_display of this APIQuoteResponseQuantity. + + :param unit_of_measure_display: The unit_of_measure_display of this APIQuoteResponseQuantity. # noqa: E501 :type: str """ @@ -454,22 +616,20 @@ def unit_of_measure_display(self, unit_of_measure_display): @property def unit_of_measure(self): - """ - Gets the unit_of_measure of this APIQuoteResponseQuantity. - {\"description\":\"The 'Unit of Measure' entity used to measure this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the unit_of_measure of this APIQuoteResponseQuantity. # noqa: E501 + - :return: The unit_of_measure of this APIQuoteResponseQuantity. + :return: The unit_of_measure of this APIQuoteResponseQuantity. # noqa: E501 :rtype: str """ return self._unit_of_measure @unit_of_measure.setter def unit_of_measure(self, unit_of_measure): - """ - Sets the unit_of_measure of this APIQuoteResponseQuantity. - {\"description\":\"The 'Unit of Measure' entity used to measure this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the unit_of_measure of this APIQuoteResponseQuantity. + - :param unit_of_measure: The unit_of_measure of this APIQuoteResponseQuantity. + :param unit_of_measure: The unit_of_measure of this APIQuoteResponseQuantity. # noqa: E501 :type: str """ @@ -477,57 +637,99 @@ def unit_of_measure(self, unit_of_measure): @property def applies_from(self): - """ - Gets the applies_from of this APIQuoteResponseQuantity. - {\"description\":\"The date-time from which the pricing component's new value would apply.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the applies_from of this APIQuoteResponseQuantity. # noqa: E501 - :return: The applies_from of this APIQuoteResponseQuantity. + + :return: The applies_from of this APIQuoteResponseQuantity. # noqa: E501 :rtype: datetime """ return self._applies_from @applies_from.setter def applies_from(self, applies_from): - """ - Sets the applies_from of this APIQuoteResponseQuantity. - {\"description\":\"The date-time from which the pricing component's new value would apply.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the applies_from of this APIQuoteResponseQuantity. + - :param applies_from: The applies_from of this APIQuoteResponseQuantity. + :param applies_from: The applies_from of this APIQuoteResponseQuantity. # noqa: E501 :type: datetime """ self._applies_from = applies_from @property - def discounts(self): + def charge_model(self): + """Gets the charge_model of this APIQuoteResponseQuantity. # noqa: E501 + + + :return: The charge_model of this APIQuoteResponseQuantity. # noqa: E501 + :rtype: str + """ + return self._charge_model + + @charge_model.setter + def charge_model(self, charge_model): + """Sets the charge_model of this APIQuoteResponseQuantity. + + + :param charge_model: The charge_model of this APIQuoteResponseQuantity. # noqa: E501 + :type: str """ - Gets the discounts of this APIQuoteResponseQuantity. - {\"description\":\"A list of discounts applied in calculating the price of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + allowed_values = ["flat", "tiered", "tiered_volume"] # noqa: E501 + if charge_model not in allowed_values: + raise ValueError( + "Invalid value for `charge_model` ({0}), must be one of {1}" # noqa: E501 + .format(charge_model, allowed_values) + ) + + self._charge_model = charge_model - :return: The discounts of this APIQuoteResponseQuantity. + @property + def discounts(self): + """Gets the discounts of this APIQuoteResponseQuantity. # noqa: E501 + + + :return: The discounts of this APIQuoteResponseQuantity. # noqa: E501 :rtype: list[CouponWrapperResponse] """ return self._discounts @discounts.setter def discounts(self, discounts): - """ - Sets the discounts of this APIQuoteResponseQuantity. - {\"description\":\"A list of discounts applied in calculating the price of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the discounts of this APIQuoteResponseQuantity. + - :param discounts: The discounts of this APIQuoteResponseQuantity. + :param discounts: The discounts of this APIQuoteResponseQuantity. # noqa: E501 :type: list[CouponWrapperResponse] """ self._discounts = discounts - def to_dict(self): + @property + def price_breakdown(self): + """Gets the price_breakdown of this APIQuoteResponseQuantity. # noqa: E501 + + + :return: The price_breakdown of this APIQuoteResponseQuantity. # noqa: E501 + :rtype: PriceBreakdown """ - Returns the model properties as a dict + return self._price_breakdown + + @price_breakdown.setter + def price_breakdown(self, price_breakdown): + """Sets the price_breakdown of this APIQuoteResponseQuantity. + + + :param price_breakdown: The price_breakdown of this APIQuoteResponseQuantity. # noqa: E501 + :type: PriceBreakdown """ + + self._price_breakdown = price_breakdown + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -544,29 +746,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(APIQuoteResponseQuantity, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, APIQuoteResponseQuantity): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/arrears_charge.py b/billforward/models/arrears_charge.py new file mode 100644 index 0000000..8f1c83a --- /dev/null +++ b/billforward/models/arrears_charge.py @@ -0,0 +1,171 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.subscription_charge import SubscriptionCharge # noqa: F401,E501 + +class ArrearsCharge(SubscriptionCharge): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'pricing_component_id': 'str', + 'unit_of_measure_id': 'str', + 'pricing_component_value': 'int' + } + if hasattr(SubscriptionCharge, "swagger_types"): + swagger_types.update(SubscriptionCharge.swagger_types) + + attribute_map = { + 'pricing_component_id': 'pricingComponentID', + 'unit_of_measure_id': 'unitOfMeasureID', + 'pricing_component_value': 'pricingComponentValue' + } + if hasattr(SubscriptionCharge, "attribute_map"): + attribute_map.update(SubscriptionCharge.attribute_map) + + def __init__(self, pricing_component_id=None, unit_of_measure_id=None, pricing_component_value=None, *args, **kwargs): # noqa: E501 + """ArrearsCharge - a model defined in Swagger""" # noqa: E501 + self._pricing_component_id = None + self._unit_of_measure_id = None + self._pricing_component_value = None + self.discriminator = None + self.pricing_component_id = pricing_component_id + self.unit_of_measure_id = unit_of_measure_id + self.pricing_component_value = pricing_component_value + SubscriptionCharge.__init__(self, *args, **kwargs) + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this ArrearsCharge. # noqa: E501 + + + :return: The pricing_component_id of this ArrearsCharge. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this ArrearsCharge. + + + :param pricing_component_id: The pricing_component_id of this ArrearsCharge. # noqa: E501 + :type: str + """ + if pricing_component_id is None: + raise ValueError("Invalid value for `pricing_component_id`, must not be `None`") # noqa: E501 + + self._pricing_component_id = pricing_component_id + + @property + def unit_of_measure_id(self): + """Gets the unit_of_measure_id of this ArrearsCharge. # noqa: E501 + + + :return: The unit_of_measure_id of this ArrearsCharge. # noqa: E501 + :rtype: str + """ + return self._unit_of_measure_id + + @unit_of_measure_id.setter + def unit_of_measure_id(self, unit_of_measure_id): + """Sets the unit_of_measure_id of this ArrearsCharge. + + + :param unit_of_measure_id: The unit_of_measure_id of this ArrearsCharge. # noqa: E501 + :type: str + """ + if unit_of_measure_id is None: + raise ValueError("Invalid value for `unit_of_measure_id`, must not be `None`") # noqa: E501 + + self._unit_of_measure_id = unit_of_measure_id + + @property + def pricing_component_value(self): + """Gets the pricing_component_value of this ArrearsCharge. # noqa: E501 + + + :return: The pricing_component_value of this ArrearsCharge. # noqa: E501 + :rtype: int + """ + return self._pricing_component_value + + @pricing_component_value.setter + def pricing_component_value(self, pricing_component_value): + """Sets the pricing_component_value of this ArrearsCharge. + + + :param pricing_component_value: The pricing_component_value of this ArrearsCharge. # noqa: E501 + :type: int + """ + if pricing_component_value is None: + raise ValueError("Invalid value for `pricing_component_value`, must not be `None`") # noqa: E501 + + self._pricing_component_value = pricing_component_value + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ArrearsCharge, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ArrearsCharge): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/arrears_pricing_components_by_charge_model.py b/billforward/models/arrears_pricing_components_by_charge_model.py new file mode 100644 index 0000000..911eb2e --- /dev/null +++ b/billforward/models/arrears_pricing_components_by_charge_model.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class ArrearsPricingComponentsByChargeModel(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'flat': 'list[FlatArrearsPricingComponent]', + 'tiered': 'list[TieredArrearsPricingComponent]', + 'volume': 'list[TieredArrearsPricingComponent]' + } + + attribute_map = { + 'flat': 'flat', + 'tiered': 'tiered', + 'volume': 'volume' + } + + def __init__(self, flat=None, tiered=None, volume=None): # noqa: E501 + """ArrearsPricingComponentsByChargeModel - a model defined in Swagger""" # noqa: E501 + self._flat = None + self._tiered = None + self._volume = None + self.discriminator = None + if flat is not None: + self.flat = flat + if tiered is not None: + self.tiered = tiered + if volume is not None: + self.volume = volume + + @property + def flat(self): + """Gets the flat of this ArrearsPricingComponentsByChargeModel. # noqa: E501 + + + :return: The flat of this ArrearsPricingComponentsByChargeModel. # noqa: E501 + :rtype: list[FlatArrearsPricingComponent] + """ + return self._flat + + @flat.setter + def flat(self, flat): + """Sets the flat of this ArrearsPricingComponentsByChargeModel. + + + :param flat: The flat of this ArrearsPricingComponentsByChargeModel. # noqa: E501 + :type: list[FlatArrearsPricingComponent] + """ + + self._flat = flat + + @property + def tiered(self): + """Gets the tiered of this ArrearsPricingComponentsByChargeModel. # noqa: E501 + + + :return: The tiered of this ArrearsPricingComponentsByChargeModel. # noqa: E501 + :rtype: list[TieredArrearsPricingComponent] + """ + return self._tiered + + @tiered.setter + def tiered(self, tiered): + """Sets the tiered of this ArrearsPricingComponentsByChargeModel. + + + :param tiered: The tiered of this ArrearsPricingComponentsByChargeModel. # noqa: E501 + :type: list[TieredArrearsPricingComponent] + """ + + self._tiered = tiered + + @property + def volume(self): + """Gets the volume of this ArrearsPricingComponentsByChargeModel. # noqa: E501 + + + :return: The volume of this ArrearsPricingComponentsByChargeModel. # noqa: E501 + :rtype: list[TieredArrearsPricingComponent] + """ + return self._volume + + @volume.setter + def volume(self, volume): + """Sets the volume of this ArrearsPricingComponentsByChargeModel. + + + :param volume: The volume of this ArrearsPricingComponentsByChargeModel. # noqa: E501 + :type: list[TieredArrearsPricingComponent] + """ + + self._volume = volume + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ArrearsPricingComponentsByChargeModel, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ArrearsPricingComponentsByChargeModel): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/audit_entry.py b/billforward/models/audit_entry.py deleted file mode 100644 index 3e70320..0000000 --- a/billforward/models/audit_entry.py +++ /dev/null @@ -1,376 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class AuditEntry(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, changed_by=None, id=None, organization_id=None, entity=None, entity_id=None, audit_action=None, field_changes=None, new_entity=None, state=None, created=None): - """ - AuditEntry - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'changed_by': 'str', - 'id': 'str', - 'organization_id': 'str', - 'entity': 'str', - 'entity_id': 'str', - 'audit_action': 'str', - 'field_changes': 'list[str]', - 'new_entity': 'list[str]', - 'state': 'str', - 'created': 'datetime' - } - - self.attribute_map = { - 'changed_by': 'changedBy', - 'id': 'id', - 'organization_id': 'organizationID', - 'entity': 'entity', - 'entity_id': 'entityID', - 'audit_action': 'auditAction', - 'field_changes': 'fieldChanges', - 'new_entity': 'newEntity', - 'state': 'state', - 'created': 'created' - } - - self._changed_by = changed_by - self._id = id - self._organization_id = organization_id - self._entity = entity - self._entity_id = entity_id - self._audit_action = audit_action - self._field_changes = field_changes - self._new_entity = new_entity - self._state = state - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this AuditEntry. - { \"description\" : \"ID of the user who made the change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The changed_by of this AuditEntry. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this AuditEntry. - { \"description\" : \"ID of the user who made the change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param changed_by: The changed_by of this AuditEntry. - :type: str - """ - - self._changed_by = changed_by - - @property - def id(self): - """ - Gets the id of this AuditEntry. - { \"description\" : \"ID of the audit-entry.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this AuditEntry. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this AuditEntry. - { \"description\" : \"ID of the audit-entry.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this AuditEntry. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this AuditEntry. - { \"description\" : \"ID of the organization associated with the audit-entry.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this AuditEntry. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this AuditEntry. - { \"description\" : \"ID of the organization associated with the audit-entry.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this AuditEntry. - :type: str - """ - - self._organization_id = organization_id - - @property - def entity(self): - """ - Gets the entity of this AuditEntry. - { \"description\" : \"The entity type.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The entity of this AuditEntry. - :rtype: str - """ - return self._entity - - @entity.setter - def entity(self, entity): - """ - Sets the entity of this AuditEntry. - { \"description\" : \"The entity type.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param entity: The entity of this AuditEntry. - :type: str - """ - allowed_values = ["Notification", "Organization", "OrganizationGateway", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "PaypalSimplePaymentReconciliation", "FreePaymentReconciliation", "LocustworldPaymentReconciliation", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "SearchResult", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "BalancedToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "GatewayRevenue", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "CassResult", "CassPaymentResult", "CassProductRatePlanResult", "CassChurnResult", "CassUpgradeResult", "SubscriptionCharge", "CassPaymentPProductResult", "ProductPaymentsArgs", "StripeACHToken", "UsageAmount", "UsageSession", "Usage", "UsagePeriod", "Period", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "FreePayment", "BraintreePayment", "BalancedPayment", "CybersourcePayment", "PaypalPayment", "PaypalSimplePayment", "LocustWorldPayment", "StripeOnlyPayment", "ProductPaymentsResult", "StripeACHPayment", "AuthorizeNetPayment", "CompoundUsageSession", "CompoundUsage", "UsageRoundingStrategies", "BillforwardManagedPaymentsResult", "PricingComponentValueMigrationChargeAmendmentMapping", "SubscriptionLTVResult", "AccountLTVResult", "ProductRatePlanPaymentsResult", "DebtsResult", "AccountPaymentsResult", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "AggregationLink", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "RevenueAttribution"] - if entity not in allowed_values: - raise ValueError( - "Invalid value for `entity` ({0}), must be one of {1}" - .format(entity, allowed_values) - ) - - self._entity = entity - - @property - def entity_id(self): - """ - Gets the entity_id of this AuditEntry. - { \"description\" : \"ID of the entity.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The entity_id of this AuditEntry. - :rtype: str - """ - return self._entity_id - - @entity_id.setter - def entity_id(self, entity_id): - """ - Sets the entity_id of this AuditEntry. - { \"description\" : \"ID of the entity.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param entity_id: The entity_id of this AuditEntry. - :type: str - """ - - self._entity_id = entity_id - - @property - def audit_action(self): - """ - Gets the audit_action of this AuditEntry. - { \"description\" : \"update, insert\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The audit_action of this AuditEntry. - :rtype: str - """ - return self._audit_action - - @audit_action.setter - def audit_action(self, audit_action): - """ - Sets the audit_action of this AuditEntry. - { \"description\" : \"update, insert\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param audit_action: The audit_action of this AuditEntry. - :type: str - """ - allowed_values = ["Accept", "Active", "AwaitingPayment", "AwaitingRefund", "Cancelled", "Completed", "Created", "Error", "Expiring", "Expired", "Failed", "Migrated", "NeedsAmendments", "Paid", "Pending", "Provisioned", "Refunded", "Reject", "Trial", "Unknown", "Unpaid", "Updated", "Voided", "PaymentFailed"] - if audit_action not in allowed_values: - raise ValueError( - "Invalid value for `audit_action` ({0}), must be one of {1}" - .format(audit_action, allowed_values) - ) - - self._audit_action = audit_action - - @property - def field_changes(self): - """ - Gets the field_changes of this AuditEntry. - { \"description\" : \"A description of the changes.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The field_changes of this AuditEntry. - :rtype: list[str] - """ - return self._field_changes - - @field_changes.setter - def field_changes(self, field_changes): - """ - Sets the field_changes of this AuditEntry. - { \"description\" : \"A description of the changes.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param field_changes: The field_changes of this AuditEntry. - :type: list[str] - """ - - self._field_changes = field_changes - - @property - def new_entity(self): - """ - Gets the new_entity of this AuditEntry. - - - :return: The new_entity of this AuditEntry. - :rtype: list[str] - """ - return self._new_entity - - @new_entity.setter - def new_entity(self, new_entity): - """ - Sets the new_entity of this AuditEntry. - - - :param new_entity: The new_entity of this AuditEntry. - :type: list[str] - """ - - self._new_entity = new_entity - - @property - def state(self): - """ - Gets the state of this AuditEntry. - { \"description\" : \"The state of the audit entry.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The state of this AuditEntry. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this AuditEntry. - { \"description\" : \"The state of the audit entry.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param state: The state of this AuditEntry. - :type: str - """ - allowed_values = ["New", "Processed"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def created(self): - """ - Gets the created of this AuditEntry. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this AuditEntry. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this AuditEntry. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this AuditEntry. - :type: datetime - """ - - self._created = created - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/audit_entry_paged_metadata.py b/billforward/models/audit_entry_paged_metadata.py deleted file mode 100644 index 3cb1556..0000000 --- a/billforward/models/audit_entry_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class AuditEntryPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - AuditEntryPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[AuditEntry]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this AuditEntryPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this AuditEntryPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this AuditEntryPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this AuditEntryPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this AuditEntryPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this AuditEntryPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this AuditEntryPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this AuditEntryPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this AuditEntryPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this AuditEntryPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this AuditEntryPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this AuditEntryPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this AuditEntryPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this AuditEntryPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this AuditEntryPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this AuditEntryPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this AuditEntryPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this AuditEntryPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this AuditEntryPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this AuditEntryPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this AuditEntryPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this AuditEntryPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this AuditEntryPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this AuditEntryPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this AuditEntryPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this AuditEntryPagedMetadata. - :rtype: list[AuditEntry] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this AuditEntryPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this AuditEntryPagedMetadata. - :type: list[AuditEntry] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/auth_capture_request.py b/billforward/models/auth_capture_request.py index f6b692a..0a87e3a 100644 --- a/billforward/models/auth_capture_request.py +++ b/billforward/models/auth_capture_request.py @@ -1,129 +1,189 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class AuthCaptureRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, type=None, account_id=None, gateway=None, company_name=None, email=None, first_name=None, last_name=None, mobile=None, default_payment_method=False, organization_id=None): - """ - AuthCaptureRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'type': 'str', - 'account_id': 'str', - 'gateway': 'str', - 'company_name': 'str', - 'email': 'str', - 'first_name': 'str', - 'last_name': 'str', - 'mobile': 'str', - 'default_payment_method': 'bool', - 'organization_id': 'str' - } - - self.attribute_map = { - 'type': '@type', - 'account_id': 'accountID', - 'gateway': 'gateway', - 'company_name': 'companyName', - 'email': 'email', - 'first_name': 'firstName', - 'last_name': 'lastName', - 'mobile': 'mobile', - 'default_payment_method': 'defaultPaymentMethod', - 'organization_id': 'organizationID' - } - - self._type = type - self._account_id = account_id - self._gateway = gateway - self._company_name = company_name - self._email = email - self._first_name = first_name - self._last_name = last_name - self._mobile = mobile - self._default_payment_method = default_payment_method - self._organization_id = organization_id + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'account_id': 'str', + 'gateway': 'str', + 'company_name': 'str', + 'email': 'str', + 'first_name': 'str', + 'last_name': 'str', + 'mobile': 'str', + 'default_payment_method': 'bool', + 'organization_id': 'str', + 'ip_address': 'str', + 'ip_address_country': 'str', + 'email_tokenization_id': 'str', + 'id': 'str', + 'type': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'account_id': 'accountID', + 'gateway': 'gateway', + 'company_name': 'companyName', + 'email': 'email', + 'first_name': 'firstName', + 'last_name': 'lastName', + 'mobile': 'mobile', + 'default_payment_method': 'defaultPaymentMethod', + 'organization_id': 'organizationID', + 'ip_address': 'ipAddress', + 'ip_address_country': 'ipAddressCountry', + 'email_tokenization_id': 'emailTokenizationID', + 'id': 'id', + 'type': '@type' + } + + discriminator_value_class_map = { + 'SquareAuthCaptureRequest': 'SquareAuthCaptureRequest', +'SagePayAuthCaptureRequest': 'SagePayAuthCaptureRequest', +'SpreedlyAuthCaptureRequest': 'SpreedlyAuthCaptureRequest', +'BraintreeAuthCaptureRequest': 'BraintreeAuthCaptureRequest', +'EBANXAuthCaptureRequest': 'EBANXAuthCaptureRequest', +'CardConnectAuthCaptureRequest': 'CardConnectAuthCaptureRequest', +'PayVisionAuthCaptureRequest': 'PayVisionAuthCaptureRequest', +'ShuttleAuthCaptureRequest': 'ShuttleAuthCaptureRequest', +'StripeAuthCaptureRequest': 'StripeAuthCaptureRequest' } + + def __init__(self, created=None, changed_by=None, account_id=None, gateway=None, company_name=None, email=None, first_name=None, last_name=None, mobile=None, default_payment_method=None, organization_id=None, ip_address=None, ip_address_country=None, email_tokenization_id=None, id=None, type=None): # noqa: E501 + """AuthCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._account_id = None + self._gateway = None + self._company_name = None + self._email = None + self._first_name = None + self._last_name = None + self._mobile = None + self._default_payment_method = None + self._organization_id = None + self._ip_address = None + self._ip_address_country = None + self._email_tokenization_id = None + self._id = None + self._type = None + self.discriminator = '@type' + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if account_id is not None: + self.account_id = account_id + self.gateway = gateway + if company_name is not None: + self.company_name = company_name + if email is not None: + self.email = email + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if mobile is not None: + self.mobile = mobile + if default_payment_method is not None: + self.default_payment_method = default_payment_method + if organization_id is not None: + self.organization_id = organization_id + if ip_address is not None: + self.ip_address = ip_address + if ip_address_country is not None: + self.ip_address_country = ip_address_country + if email_tokenization_id is not None: + self.email_tokenization_id = email_tokenization_id + if id is not None: + self.id = id + self.type = type @property - def type(self): + def created(self): + """Gets the created of this AuthCaptureRequest. # noqa: E501 + + + :return: The created of this AuthCaptureRequest. # noqa: E501 + :rtype: datetime """ - Gets the type of this AuthCaptureRequest. + return self._created + @created.setter + def created(self, created): + """Sets the created of this AuthCaptureRequest. - :return: The type of this AuthCaptureRequest. - :rtype: str + + :param created: The created of this AuthCaptureRequest. # noqa: E501 + :type: datetime """ - return self._type - @type.setter - def type(self, type): + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this AuthCaptureRequest. # noqa: E501 + + + :return: The changed_by of this AuthCaptureRequest. # noqa: E501 + :rtype: str """ - Sets the type of this AuthCaptureRequest. + return self._changed_by + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this AuthCaptureRequest. - :param type: The type of this AuthCaptureRequest. + + :param changed_by: The changed_by of this AuthCaptureRequest. # noqa: E501 :type: str """ - allowed_values = ["StripeAuthCaptureRequest"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - self._type = type + self._changed_by = changed_by @property def account_id(self): - """ - Gets the account_id of this AuthCaptureRequest. - {\"description\":\"ID of the BillForward Account with which you would like to associate the created payment method.
If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.\",\"verbs\":[\"POST\"]} + """Gets the account_id of this AuthCaptureRequest. # noqa: E501 + - :return: The account_id of this AuthCaptureRequest. + :return: The account_id of this AuthCaptureRequest. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this AuthCaptureRequest. - {\"description\":\"ID of the BillForward Account with which you would like to associate the created payment method.
If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.\",\"verbs\":[\"POST\"]} + """Sets the account_id of this AuthCaptureRequest. + - :param account_id: The account_id of this AuthCaptureRequest. + :param account_id: The account_id of this AuthCaptureRequest. # noqa: E501 :type: str """ @@ -131,28 +191,28 @@ def account_id(self, account_id): @property def gateway(self): - """ - Gets the gateway of this AuthCaptureRequest. - {\"description\":\"The gateway with which your funding instrument has been vaulted.\",\"verbs\":[\"POST\"]} + """Gets the gateway of this AuthCaptureRequest. # noqa: E501 - :return: The gateway of this AuthCaptureRequest. + + :return: The gateway of this AuthCaptureRequest. # noqa: E501 :rtype: str """ return self._gateway @gateway.setter def gateway(self, gateway): - """ - Sets the gateway of this AuthCaptureRequest. - {\"description\":\"The gateway with which your funding instrument has been vaulted.\",\"verbs\":[\"POST\"]} + """Sets the gateway of this AuthCaptureRequest. - :param gateway: The gateway of this AuthCaptureRequest. + + :param gateway: The gateway of this AuthCaptureRequest. # noqa: E501 :type: str """ - allowed_values = ["Balanced", "Braintree", "Cybersource", "Paypal", "Stripe", "AuthorizeNet", "Spreedly", "SagePay", "TrustCommerce", "Payvision", "Kash"] + if gateway is None: + raise ValueError("Invalid value for `gateway`, must not be `None`") # noqa: E501 + allowed_values = ["Balanced", "Braintree", "Cybersource", "Paypal", "Stripe", "Shuttle", "AuthorizeNet", "Spreedly", "SagePay", "GoCardless", "TrustCommerce", "Payvision", "Epx", "Kash", "Zooz", "Square", "CardConnect", "EBANX"] # noqa: E501 if gateway not in allowed_values: raise ValueError( - "Invalid value for `gateway` ({0}), must be one of {1}" + "Invalid value for `gateway` ({0}), must be one of {1}" # noqa: E501 .format(gateway, allowed_values) ) @@ -160,22 +220,20 @@ def gateway(self, gateway): @property def company_name(self): - """ - Gets the company_name of this AuthCaptureRequest. - {\"description\":\"The name of the company of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} + """Gets the company_name of this AuthCaptureRequest. # noqa: E501 - :return: The company_name of this AuthCaptureRequest. + + :return: The company_name of this AuthCaptureRequest. # noqa: E501 :rtype: str """ return self._company_name @company_name.setter def company_name(self, company_name): - """ - Sets the company_name of this AuthCaptureRequest. - {\"description\":\"The name of the company of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} + """Sets the company_name of this AuthCaptureRequest. - :param company_name: The company_name of this AuthCaptureRequest. + + :param company_name: The company_name of this AuthCaptureRequest. # noqa: E501 :type: str """ @@ -183,22 +241,20 @@ def company_name(self, company_name): @property def email(self): - """ - Gets the email of this AuthCaptureRequest. - {\"description\":\"The email address of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} + """Gets the email of this AuthCaptureRequest. # noqa: E501 + - :return: The email of this AuthCaptureRequest. + :return: The email of this AuthCaptureRequest. # noqa: E501 :rtype: str """ return self._email @email.setter def email(self, email): - """ - Sets the email of this AuthCaptureRequest. - {\"description\":\"The email address of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} + """Sets the email of this AuthCaptureRequest. + - :param email: The email of this AuthCaptureRequest. + :param email: The email of this AuthCaptureRequest. # noqa: E501 :type: str """ @@ -206,22 +262,20 @@ def email(self, email): @property def first_name(self): - """ - Gets the first_name of this AuthCaptureRequest. - {\"description\":\"The first name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} + """Gets the first_name of this AuthCaptureRequest. # noqa: E501 + - :return: The first_name of this AuthCaptureRequest. + :return: The first_name of this AuthCaptureRequest. # noqa: E501 :rtype: str """ return self._first_name @first_name.setter def first_name(self, first_name): - """ - Sets the first_name of this AuthCaptureRequest. - {\"description\":\"The first name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} + """Sets the first_name of this AuthCaptureRequest. + - :param first_name: The first_name of this AuthCaptureRequest. + :param first_name: The first_name of this AuthCaptureRequest. # noqa: E501 :type: str """ @@ -229,22 +283,20 @@ def first_name(self, first_name): @property def last_name(self): - """ - Gets the last_name of this AuthCaptureRequest. - {\"description\":\"The last name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} + """Gets the last_name of this AuthCaptureRequest. # noqa: E501 + - :return: The last_name of this AuthCaptureRequest. + :return: The last_name of this AuthCaptureRequest. # noqa: E501 :rtype: str """ return self._last_name @last_name.setter def last_name(self, last_name): - """ - Sets the last_name of this AuthCaptureRequest. - {\"description\":\"The last name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} + """Sets the last_name of this AuthCaptureRequest. - :param last_name: The last_name of this AuthCaptureRequest. + + :param last_name: The last_name of this AuthCaptureRequest. # noqa: E501 :type: str """ @@ -252,22 +304,20 @@ def last_name(self, last_name): @property def mobile(self): - """ - Gets the mobile of this AuthCaptureRequest. - {\"description\":\"The mobile phone number of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} + """Gets the mobile of this AuthCaptureRequest. # noqa: E501 - :return: The mobile of this AuthCaptureRequest. + + :return: The mobile of this AuthCaptureRequest. # noqa: E501 :rtype: str """ return self._mobile @mobile.setter def mobile(self, mobile): - """ - Sets the mobile of this AuthCaptureRequest. - {\"description\":\"The mobile phone number of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} + """Sets the mobile of this AuthCaptureRequest. - :param mobile: The mobile of this AuthCaptureRequest. + + :param mobile: The mobile of this AuthCaptureRequest. # noqa: E501 :type: str """ @@ -275,22 +325,20 @@ def mobile(self, mobile): @property def default_payment_method(self): - """ - Gets the default_payment_method of this AuthCaptureRequest. - {\"default\":false,\"description\":\"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).\",\"verbs\":[\"POST\"]} + """Gets the default_payment_method of this AuthCaptureRequest. # noqa: E501 - :return: The default_payment_method of this AuthCaptureRequest. + + :return: The default_payment_method of this AuthCaptureRequest. # noqa: E501 :rtype: bool """ return self._default_payment_method @default_payment_method.setter def default_payment_method(self, default_payment_method): - """ - Sets the default_payment_method of this AuthCaptureRequest. - {\"default\":false,\"description\":\"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).\",\"verbs\":[\"POST\"]} + """Sets the default_payment_method of this AuthCaptureRequest. + - :param default_payment_method: The default_payment_method of this AuthCaptureRequest. + :param default_payment_method: The default_payment_method of this AuthCaptureRequest. # noqa: E501 :type: bool """ @@ -298,34 +346,142 @@ def default_payment_method(self, default_payment_method): @property def organization_id(self): - """ - Gets the organization_id of this AuthCaptureRequest. - {\"description\":\"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} + """Gets the organization_id of this AuthCaptureRequest. # noqa: E501 + - :return: The organization_id of this AuthCaptureRequest. + :return: The organization_id of this AuthCaptureRequest. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this AuthCaptureRequest. - {\"description\":\"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} + """Sets the organization_id of this AuthCaptureRequest. + - :param organization_id: The organization_id of this AuthCaptureRequest. + :param organization_id: The organization_id of this AuthCaptureRequest. # noqa: E501 :type: str """ self._organization_id = organization_id - def to_dict(self): + @property + def ip_address(self): + """Gets the ip_address of this AuthCaptureRequest. # noqa: E501 + + + :return: The ip_address of this AuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._ip_address + + @ip_address.setter + def ip_address(self, ip_address): + """Sets the ip_address of this AuthCaptureRequest. + + + :param ip_address: The ip_address of this AuthCaptureRequest. # noqa: E501 + :type: str """ - Returns the model properties as a dict + + self._ip_address = ip_address + + @property + def ip_address_country(self): + """Gets the ip_address_country of this AuthCaptureRequest. # noqa: E501 + + + :return: The ip_address_country of this AuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._ip_address_country + + @ip_address_country.setter + def ip_address_country(self, ip_address_country): + """Sets the ip_address_country of this AuthCaptureRequest. + + + :param ip_address_country: The ip_address_country of this AuthCaptureRequest. # noqa: E501 + :type: str """ + + self._ip_address_country = ip_address_country + + @property + def email_tokenization_id(self): + """Gets the email_tokenization_id of this AuthCaptureRequest. # noqa: E501 + + + :return: The email_tokenization_id of this AuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._email_tokenization_id + + @email_tokenization_id.setter + def email_tokenization_id(self, email_tokenization_id): + """Sets the email_tokenization_id of this AuthCaptureRequest. + + + :param email_tokenization_id: The email_tokenization_id of this AuthCaptureRequest. # noqa: E501 + :type: str + """ + + self._email_tokenization_id = email_tokenization_id + + @property + def id(self): + """Gets the id of this AuthCaptureRequest. # noqa: E501 + + + :return: The id of this AuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this AuthCaptureRequest. + + + :param id: The id of this AuthCaptureRequest. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def type(self): + """Gets the type of this AuthCaptureRequest. # noqa: E501 + + + :return: The type of this AuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this AuthCaptureRequest. + + + :param type: The type of this AuthCaptureRequest. # noqa: E501 + :type: str + """ + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + + self._type = type + + def get_real_child_model(self, data): + """Returns the real base class specified by the discriminator""" + discriminator_value = data[self.discriminator].lower() + return self.discriminator_value_class_map.get(discriminator_value) + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -342,29 +498,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(AuthCaptureRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, AuthCaptureRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/authorize_net_configuration.py b/billforward/models/authorize_net_configuration.py new file mode 100644 index 0000000..37fcee4 --- /dev/null +++ b/billforward/models/authorize_net_configuration.py @@ -0,0 +1,122 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class AuthorizeNetConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'authorize_net_environment': 'str' + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + 'authorize_net_environment': 'authorizeNetEnvironment' + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, authorize_net_environment=None, *args, **kwargs): # noqa: E501 + """AuthorizeNetConfiguration - a model defined in Swagger""" # noqa: E501 + self._authorize_net_environment = None + self.discriminator = None + if authorize_net_environment is not None: + self.authorize_net_environment = authorize_net_environment + APIConfiguration.__init__(self, *args, **kwargs) + + @property + def authorize_net_environment(self): + """Gets the authorize_net_environment of this AuthorizeNetConfiguration. # noqa: E501 + + + :return: The authorize_net_environment of this AuthorizeNetConfiguration. # noqa: E501 + :rtype: str + """ + return self._authorize_net_environment + + @authorize_net_environment.setter + def authorize_net_environment(self, authorize_net_environment): + """Sets the authorize_net_environment of this AuthorizeNetConfiguration. + + + :param authorize_net_environment: The authorize_net_environment of this AuthorizeNetConfiguration. # noqa: E501 + :type: str + """ + allowed_values = ["SANDBOX", "PRODUCTION", "LOCAL_VM", "HOSTED_VM", "CUSTOM"] # noqa: E501 + if authorize_net_environment not in allowed_values: + raise ValueError( + "Invalid value for `authorize_net_environment` ({0}), must be one of {1}" # noqa: E501 + .format(authorize_net_environment, allowed_values) + ) + + self._authorize_net_environment = authorize_net_environment + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AuthorizeNetConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AuthorizeNetConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/authorize_net_payment.py b/billforward/models/authorize_net_payment.py new file mode 100644 index 0000000..a7becff --- /dev/null +++ b/billforward/models/authorize_net_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class AuthorizeNetPayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """AuthorizeNetPayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AuthorizeNetPayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AuthorizeNetPayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/authorize_net_token.py b/billforward/models/authorize_net_token.py new file mode 100644 index 0000000..206b28c --- /dev/null +++ b/billforward/models/authorize_net_token.py @@ -0,0 +1,376 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AuthorizeNetToken(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'account_id': 'str', + 'card_details_id': 'str', + 'organization_id': 'str', + 'deleted': 'bool', + 'customer_profile_id': 'str', + 'customer_payment_profile_id': 'str', + 'last_four_digits': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'account_id': 'accountID', + 'card_details_id': 'cardDetailsID', + 'organization_id': 'organizationID', + 'deleted': 'deleted', + 'customer_profile_id': 'customerProfileID', + 'customer_payment_profile_id': 'customerPaymentProfileID', + 'last_four_digits': 'lastFourDigits' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, card_details_id=None, organization_id=None, deleted=None, customer_profile_id=None, customer_payment_profile_id=None, last_four_digits=None): # noqa: E501 + """AuthorizeNetToken - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._account_id = None + self._card_details_id = None + self._organization_id = None + self._deleted = None + self._customer_profile_id = None + self._customer_payment_profile_id = None + self._last_four_digits = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.account_id = account_id + if card_details_id is not None: + self.card_details_id = card_details_id + self.organization_id = organization_id + self.deleted = deleted + self.customer_profile_id = customer_profile_id + self.customer_payment_profile_id = customer_payment_profile_id + self.last_four_digits = last_four_digits + + @property + def created(self): + """Gets the created of this AuthorizeNetToken. # noqa: E501 + + + :return: The created of this AuthorizeNetToken. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this AuthorizeNetToken. + + + :param created: The created of this AuthorizeNetToken. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this AuthorizeNetToken. # noqa: E501 + + + :return: The changed_by of this AuthorizeNetToken. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this AuthorizeNetToken. + + + :param changed_by: The changed_by of this AuthorizeNetToken. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this AuthorizeNetToken. # noqa: E501 + + + :return: The updated of this AuthorizeNetToken. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this AuthorizeNetToken. + + + :param updated: The updated of this AuthorizeNetToken. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this AuthorizeNetToken. # noqa: E501 + + + :return: The id of this AuthorizeNetToken. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this AuthorizeNetToken. + + + :param id: The id of this AuthorizeNetToken. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def account_id(self): + """Gets the account_id of this AuthorizeNetToken. # noqa: E501 + + + :return: The account_id of this AuthorizeNetToken. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this AuthorizeNetToken. + + + :param account_id: The account_id of this AuthorizeNetToken. # noqa: E501 + :type: str + """ + if account_id is None: + raise ValueError("Invalid value for `account_id`, must not be `None`") # noqa: E501 + + self._account_id = account_id + + @property + def card_details_id(self): + """Gets the card_details_id of this AuthorizeNetToken. # noqa: E501 + + + :return: The card_details_id of this AuthorizeNetToken. # noqa: E501 + :rtype: str + """ + return self._card_details_id + + @card_details_id.setter + def card_details_id(self, card_details_id): + """Sets the card_details_id of this AuthorizeNetToken. + + + :param card_details_id: The card_details_id of this AuthorizeNetToken. # noqa: E501 + :type: str + """ + + self._card_details_id = card_details_id + + @property + def organization_id(self): + """Gets the organization_id of this AuthorizeNetToken. # noqa: E501 + + + :return: The organization_id of this AuthorizeNetToken. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AuthorizeNetToken. + + + :param organization_id: The organization_id of this AuthorizeNetToken. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def deleted(self): + """Gets the deleted of this AuthorizeNetToken. # noqa: E501 + + + :return: The deleted of this AuthorizeNetToken. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this AuthorizeNetToken. + + + :param deleted: The deleted of this AuthorizeNetToken. # noqa: E501 + :type: bool + """ + if deleted is None: + raise ValueError("Invalid value for `deleted`, must not be `None`") # noqa: E501 + + self._deleted = deleted + + @property + def customer_profile_id(self): + """Gets the customer_profile_id of this AuthorizeNetToken. # noqa: E501 + + + :return: The customer_profile_id of this AuthorizeNetToken. # noqa: E501 + :rtype: str + """ + return self._customer_profile_id + + @customer_profile_id.setter + def customer_profile_id(self, customer_profile_id): + """Sets the customer_profile_id of this AuthorizeNetToken. + + + :param customer_profile_id: The customer_profile_id of this AuthorizeNetToken. # noqa: E501 + :type: str + """ + if customer_profile_id is None: + raise ValueError("Invalid value for `customer_profile_id`, must not be `None`") # noqa: E501 + + self._customer_profile_id = customer_profile_id + + @property + def customer_payment_profile_id(self): + """Gets the customer_payment_profile_id of this AuthorizeNetToken. # noqa: E501 + + + :return: The customer_payment_profile_id of this AuthorizeNetToken. # noqa: E501 + :rtype: str + """ + return self._customer_payment_profile_id + + @customer_payment_profile_id.setter + def customer_payment_profile_id(self, customer_payment_profile_id): + """Sets the customer_payment_profile_id of this AuthorizeNetToken. + + + :param customer_payment_profile_id: The customer_payment_profile_id of this AuthorizeNetToken. # noqa: E501 + :type: str + """ + if customer_payment_profile_id is None: + raise ValueError("Invalid value for `customer_payment_profile_id`, must not be `None`") # noqa: E501 + + self._customer_payment_profile_id = customer_payment_profile_id + + @property + def last_four_digits(self): + """Gets the last_four_digits of this AuthorizeNetToken. # noqa: E501 + + + :return: The last_four_digits of this AuthorizeNetToken. # noqa: E501 + :rtype: str + """ + return self._last_four_digits + + @last_four_digits.setter + def last_four_digits(self, last_four_digits): + """Sets the last_four_digits of this AuthorizeNetToken. + + + :param last_four_digits: The last_four_digits of this AuthorizeNetToken. # noqa: E501 + :type: str + """ + if last_four_digits is None: + raise ValueError("Invalid value for `last_four_digits`, must not be `None`") # noqa: E501 + + self._last_four_digits = last_four_digits + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AuthorizeNetToken, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AuthorizeNetToken): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/authorize_net_token_paged_metadata.py b/billforward/models/authorize_net_token_paged_metadata.py deleted file mode 100644 index 108dd5a..0000000 --- a/billforward/models/authorize_net_token_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class AuthorizeNetTokenPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - AuthorizeNetTokenPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this AuthorizeNetTokenPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this AuthorizeNetTokenPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this AuthorizeNetTokenPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this AuthorizeNetTokenPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this AuthorizeNetTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this AuthorizeNetTokenPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this AuthorizeNetTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this AuthorizeNetTokenPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this AuthorizeNetTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this AuthorizeNetTokenPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this AuthorizeNetTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this AuthorizeNetTokenPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this AuthorizeNetTokenPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this AuthorizeNetTokenPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this AuthorizeNetTokenPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this AuthorizeNetTokenPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this AuthorizeNetTokenPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this AuthorizeNetTokenPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this AuthorizeNetTokenPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this AuthorizeNetTokenPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this AuthorizeNetTokenPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this AuthorizeNetTokenPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this AuthorizeNetTokenPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this AuthorizeNetTokenPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this AuthorizeNetTokenPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this AuthorizeNetTokenPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this AuthorizeNetTokenPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this AuthorizeNetTokenPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/avatax_config_request.py b/billforward/models/avatax_config_request.py new file mode 100644 index 0000000..7b53991 --- /dev/null +++ b/billforward/models/avatax_config_request.py @@ -0,0 +1,344 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AvataxConfigRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'account_number': 'str', + 'licence_key': 'str', + 'company_code': 'str', + 'address_id': 'str', + 'enabled': 'bool', + 'enable_logging': 'bool', + 'commit_transactions': 'bool', + 'address_validation': 'bool', + 'prod_env': 'bool' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'account_number': 'accountNumber', + 'licence_key': 'licenceKey', + 'company_code': 'companyCode', + 'address_id': 'addressId', + 'enabled': 'enabled', + 'enable_logging': 'enableLogging', + 'commit_transactions': 'commitTransactions', + 'address_validation': 'addressValidation', + 'prod_env': 'prodEnv' + } + + def __init__(self, organization_id=None, account_number=None, licence_key=None, company_code=None, address_id=None, enabled=None, enable_logging=None, commit_transactions=None, address_validation=None, prod_env=None): # noqa: E501 + """AvataxConfigRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._account_number = None + self._licence_key = None + self._company_code = None + self._address_id = None + self._enabled = None + self._enable_logging = None + self._commit_transactions = None + self._address_validation = None + self._prod_env = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if account_number is not None: + self.account_number = account_number + if licence_key is not None: + self.licence_key = licence_key + if company_code is not None: + self.company_code = company_code + if address_id is not None: + self.address_id = address_id + if enabled is not None: + self.enabled = enabled + if enable_logging is not None: + self.enable_logging = enable_logging + if commit_transactions is not None: + self.commit_transactions = commit_transactions + if address_validation is not None: + self.address_validation = address_validation + if prod_env is not None: + self.prod_env = prod_env + + @property + def organization_id(self): + """Gets the organization_id of this AvataxConfigRequest. # noqa: E501 + + + :return: The organization_id of this AvataxConfigRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AvataxConfigRequest. + + + :param organization_id: The organization_id of this AvataxConfigRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_number(self): + """Gets the account_number of this AvataxConfigRequest. # noqa: E501 + + + :return: The account_number of this AvataxConfigRequest. # noqa: E501 + :rtype: str + """ + return self._account_number + + @account_number.setter + def account_number(self, account_number): + """Sets the account_number of this AvataxConfigRequest. + + + :param account_number: The account_number of this AvataxConfigRequest. # noqa: E501 + :type: str + """ + + self._account_number = account_number + + @property + def licence_key(self): + """Gets the licence_key of this AvataxConfigRequest. # noqa: E501 + + + :return: The licence_key of this AvataxConfigRequest. # noqa: E501 + :rtype: str + """ + return self._licence_key + + @licence_key.setter + def licence_key(self, licence_key): + """Sets the licence_key of this AvataxConfigRequest. + + + :param licence_key: The licence_key of this AvataxConfigRequest. # noqa: E501 + :type: str + """ + + self._licence_key = licence_key + + @property + def company_code(self): + """Gets the company_code of this AvataxConfigRequest. # noqa: E501 + + + :return: The company_code of this AvataxConfigRequest. # noqa: E501 + :rtype: str + """ + return self._company_code + + @company_code.setter + def company_code(self, company_code): + """Sets the company_code of this AvataxConfigRequest. + + + :param company_code: The company_code of this AvataxConfigRequest. # noqa: E501 + :type: str + """ + + self._company_code = company_code + + @property + def address_id(self): + """Gets the address_id of this AvataxConfigRequest. # noqa: E501 + + + :return: The address_id of this AvataxConfigRequest. # noqa: E501 + :rtype: str + """ + return self._address_id + + @address_id.setter + def address_id(self, address_id): + """Sets the address_id of this AvataxConfigRequest. + + + :param address_id: The address_id of this AvataxConfigRequest. # noqa: E501 + :type: str + """ + + self._address_id = address_id + + @property + def enabled(self): + """Gets the enabled of this AvataxConfigRequest. # noqa: E501 + + + :return: The enabled of this AvataxConfigRequest. # noqa: E501 + :rtype: bool + """ + return self._enabled + + @enabled.setter + def enabled(self, enabled): + """Sets the enabled of this AvataxConfigRequest. + + + :param enabled: The enabled of this AvataxConfigRequest. # noqa: E501 + :type: bool + """ + + self._enabled = enabled + + @property + def enable_logging(self): + """Gets the enable_logging of this AvataxConfigRequest. # noqa: E501 + + + :return: The enable_logging of this AvataxConfigRequest. # noqa: E501 + :rtype: bool + """ + return self._enable_logging + + @enable_logging.setter + def enable_logging(self, enable_logging): + """Sets the enable_logging of this AvataxConfigRequest. + + + :param enable_logging: The enable_logging of this AvataxConfigRequest. # noqa: E501 + :type: bool + """ + + self._enable_logging = enable_logging + + @property + def commit_transactions(self): + """Gets the commit_transactions of this AvataxConfigRequest. # noqa: E501 + + + :return: The commit_transactions of this AvataxConfigRequest. # noqa: E501 + :rtype: bool + """ + return self._commit_transactions + + @commit_transactions.setter + def commit_transactions(self, commit_transactions): + """Sets the commit_transactions of this AvataxConfigRequest. + + + :param commit_transactions: The commit_transactions of this AvataxConfigRequest. # noqa: E501 + :type: bool + """ + + self._commit_transactions = commit_transactions + + @property + def address_validation(self): + """Gets the address_validation of this AvataxConfigRequest. # noqa: E501 + + + :return: The address_validation of this AvataxConfigRequest. # noqa: E501 + :rtype: bool + """ + return self._address_validation + + @address_validation.setter + def address_validation(self, address_validation): + """Sets the address_validation of this AvataxConfigRequest. + + + :param address_validation: The address_validation of this AvataxConfigRequest. # noqa: E501 + :type: bool + """ + + self._address_validation = address_validation + + @property + def prod_env(self): + """Gets the prod_env of this AvataxConfigRequest. # noqa: E501 + + + :return: The prod_env of this AvataxConfigRequest. # noqa: E501 + :rtype: bool + """ + return self._prod_env + + @prod_env.setter + def prod_env(self, prod_env): + """Sets the prod_env of this AvataxConfigRequest. + + + :param prod_env: The prod_env of this AvataxConfigRequest. # noqa: E501 + :type: bool + """ + + self._prod_env = prod_env + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AvataxConfigRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AvataxConfigRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/avatax_configuration.py b/billforward/models/avatax_configuration.py new file mode 100644 index 0000000..020bf04 --- /dev/null +++ b/billforward/models/avatax_configuration.py @@ -0,0 +1,484 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AvataxConfiguration(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'account_number': 'str', + 'licence_key': 'str', + 'company_code': 'str', + 'address_id': 'str', + 'enabled': 'bool', + 'enable_logging': 'bool', + 'commit_transactions': 'bool', + 'address_validation': 'bool', + 'prod_env': 'bool', + 'deleted': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'account_number': 'accountNumber', + 'licence_key': 'licenceKey', + 'company_code': 'companyCode', + 'address_id': 'addressId', + 'enabled': 'enabled', + 'enable_logging': 'enableLogging', + 'commit_transactions': 'commitTransactions', + 'address_validation': 'addressValidation', + 'prod_env': 'prodEnv', + 'deleted': 'deleted' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, account_number=None, licence_key=None, company_code=None, address_id=None, enabled=None, enable_logging=None, commit_transactions=None, address_validation=None, prod_env=None, deleted=None): # noqa: E501 + """AvataxConfiguration - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._account_number = None + self._licence_key = None + self._company_code = None + self._address_id = None + self._enabled = None + self._enable_logging = None + self._commit_transactions = None + self._address_validation = None + self._prod_env = None + self._deleted = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.organization_id = organization_id + self.account_number = account_number + self.licence_key = licence_key + self.company_code = company_code + self.address_id = address_id + self.enabled = enabled + self.enable_logging = enable_logging + self.commit_transactions = commit_transactions + self.address_validation = address_validation + self.prod_env = prod_env + if deleted is not None: + self.deleted = deleted + + @property + def created(self): + """Gets the created of this AvataxConfiguration. # noqa: E501 + + + :return: The created of this AvataxConfiguration. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this AvataxConfiguration. + + + :param created: The created of this AvataxConfiguration. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this AvataxConfiguration. # noqa: E501 + + + :return: The changed_by of this AvataxConfiguration. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this AvataxConfiguration. + + + :param changed_by: The changed_by of this AvataxConfiguration. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this AvataxConfiguration. # noqa: E501 + + + :return: The updated of this AvataxConfiguration. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this AvataxConfiguration. + + + :param updated: The updated of this AvataxConfiguration. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this AvataxConfiguration. # noqa: E501 + + + :return: The id of this AvataxConfiguration. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this AvataxConfiguration. + + + :param id: The id of this AvataxConfiguration. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this AvataxConfiguration. # noqa: E501 + + + :return: The organization_id of this AvataxConfiguration. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AvataxConfiguration. + + + :param organization_id: The organization_id of this AvataxConfiguration. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def account_number(self): + """Gets the account_number of this AvataxConfiguration. # noqa: E501 + + + :return: The account_number of this AvataxConfiguration. # noqa: E501 + :rtype: str + """ + return self._account_number + + @account_number.setter + def account_number(self, account_number): + """Sets the account_number of this AvataxConfiguration. + + + :param account_number: The account_number of this AvataxConfiguration. # noqa: E501 + :type: str + """ + if account_number is None: + raise ValueError("Invalid value for `account_number`, must not be `None`") # noqa: E501 + + self._account_number = account_number + + @property + def licence_key(self): + """Gets the licence_key of this AvataxConfiguration. # noqa: E501 + + + :return: The licence_key of this AvataxConfiguration. # noqa: E501 + :rtype: str + """ + return self._licence_key + + @licence_key.setter + def licence_key(self, licence_key): + """Sets the licence_key of this AvataxConfiguration. + + + :param licence_key: The licence_key of this AvataxConfiguration. # noqa: E501 + :type: str + """ + if licence_key is None: + raise ValueError("Invalid value for `licence_key`, must not be `None`") # noqa: E501 + + self._licence_key = licence_key + + @property + def company_code(self): + """Gets the company_code of this AvataxConfiguration. # noqa: E501 + + + :return: The company_code of this AvataxConfiguration. # noqa: E501 + :rtype: str + """ + return self._company_code + + @company_code.setter + def company_code(self, company_code): + """Sets the company_code of this AvataxConfiguration. + + + :param company_code: The company_code of this AvataxConfiguration. # noqa: E501 + :type: str + """ + if company_code is None: + raise ValueError("Invalid value for `company_code`, must not be `None`") # noqa: E501 + + self._company_code = company_code + + @property + def address_id(self): + """Gets the address_id of this AvataxConfiguration. # noqa: E501 + + + :return: The address_id of this AvataxConfiguration. # noqa: E501 + :rtype: str + """ + return self._address_id + + @address_id.setter + def address_id(self, address_id): + """Sets the address_id of this AvataxConfiguration. + + + :param address_id: The address_id of this AvataxConfiguration. # noqa: E501 + :type: str + """ + if address_id is None: + raise ValueError("Invalid value for `address_id`, must not be `None`") # noqa: E501 + + self._address_id = address_id + + @property + def enabled(self): + """Gets the enabled of this AvataxConfiguration. # noqa: E501 + + + :return: The enabled of this AvataxConfiguration. # noqa: E501 + :rtype: bool + """ + return self._enabled + + @enabled.setter + def enabled(self, enabled): + """Sets the enabled of this AvataxConfiguration. + + + :param enabled: The enabled of this AvataxConfiguration. # noqa: E501 + :type: bool + """ + if enabled is None: + raise ValueError("Invalid value for `enabled`, must not be `None`") # noqa: E501 + + self._enabled = enabled + + @property + def enable_logging(self): + """Gets the enable_logging of this AvataxConfiguration. # noqa: E501 + + + :return: The enable_logging of this AvataxConfiguration. # noqa: E501 + :rtype: bool + """ + return self._enable_logging + + @enable_logging.setter + def enable_logging(self, enable_logging): + """Sets the enable_logging of this AvataxConfiguration. + + + :param enable_logging: The enable_logging of this AvataxConfiguration. # noqa: E501 + :type: bool + """ + if enable_logging is None: + raise ValueError("Invalid value for `enable_logging`, must not be `None`") # noqa: E501 + + self._enable_logging = enable_logging + + @property + def commit_transactions(self): + """Gets the commit_transactions of this AvataxConfiguration. # noqa: E501 + + + :return: The commit_transactions of this AvataxConfiguration. # noqa: E501 + :rtype: bool + """ + return self._commit_transactions + + @commit_transactions.setter + def commit_transactions(self, commit_transactions): + """Sets the commit_transactions of this AvataxConfiguration. + + + :param commit_transactions: The commit_transactions of this AvataxConfiguration. # noqa: E501 + :type: bool + """ + if commit_transactions is None: + raise ValueError("Invalid value for `commit_transactions`, must not be `None`") # noqa: E501 + + self._commit_transactions = commit_transactions + + @property + def address_validation(self): + """Gets the address_validation of this AvataxConfiguration. # noqa: E501 + + + :return: The address_validation of this AvataxConfiguration. # noqa: E501 + :rtype: bool + """ + return self._address_validation + + @address_validation.setter + def address_validation(self, address_validation): + """Sets the address_validation of this AvataxConfiguration. + + + :param address_validation: The address_validation of this AvataxConfiguration. # noqa: E501 + :type: bool + """ + if address_validation is None: + raise ValueError("Invalid value for `address_validation`, must not be `None`") # noqa: E501 + + self._address_validation = address_validation + + @property + def prod_env(self): + """Gets the prod_env of this AvataxConfiguration. # noqa: E501 + + + :return: The prod_env of this AvataxConfiguration. # noqa: E501 + :rtype: bool + """ + return self._prod_env + + @prod_env.setter + def prod_env(self, prod_env): + """Sets the prod_env of this AvataxConfiguration. + + + :param prod_env: The prod_env of this AvataxConfiguration. # noqa: E501 + :type: bool + """ + if prod_env is None: + raise ValueError("Invalid value for `prod_env`, must not be `None`") # noqa: E501 + + self._prod_env = prod_env + + @property + def deleted(self): + """Gets the deleted of this AvataxConfiguration. # noqa: E501 + + + :return: The deleted of this AvataxConfiguration. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this AvataxConfiguration. + + + :param deleted: The deleted of this AvataxConfiguration. # noqa: E501 + :type: bool + """ + + self._deleted = deleted + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AvataxConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AvataxConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/avatax_ping_request.py b/billforward/models/avatax_ping_request.py new file mode 100644 index 0000000..fcb6684 --- /dev/null +++ b/billforward/models/avatax_ping_request.py @@ -0,0 +1,240 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AvataxPingRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'account_id': 'str', + 'license_key': 'str', + 'prod_env': 'bool', + 'enable_logging': 'bool' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'account_id': 'accountId', + 'license_key': 'licenseKey', + 'prod_env': 'prodEnv', + 'enable_logging': 'enableLogging' + } + + def __init__(self, created=None, organization_id=None, account_id=None, license_key=None, prod_env=None, enable_logging=None): # noqa: E501 + """AvataxPingRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._account_id = None + self._license_key = None + self._prod_env = None + self._enable_logging = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if license_key is not None: + self.license_key = license_key + if prod_env is not None: + self.prod_env = prod_env + if enable_logging is not None: + self.enable_logging = enable_logging + + @property + def created(self): + """Gets the created of this AvataxPingRequest. # noqa: E501 + + + :return: The created of this AvataxPingRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this AvataxPingRequest. + + + :param created: The created of this AvataxPingRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this AvataxPingRequest. # noqa: E501 + + + :return: The organization_id of this AvataxPingRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AvataxPingRequest. + + + :param organization_id: The organization_id of this AvataxPingRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_id(self): + """Gets the account_id of this AvataxPingRequest. # noqa: E501 + + + :return: The account_id of this AvataxPingRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this AvataxPingRequest. + + + :param account_id: The account_id of this AvataxPingRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def license_key(self): + """Gets the license_key of this AvataxPingRequest. # noqa: E501 + + + :return: The license_key of this AvataxPingRequest. # noqa: E501 + :rtype: str + """ + return self._license_key + + @license_key.setter + def license_key(self, license_key): + """Sets the license_key of this AvataxPingRequest. + + + :param license_key: The license_key of this AvataxPingRequest. # noqa: E501 + :type: str + """ + + self._license_key = license_key + + @property + def prod_env(self): + """Gets the prod_env of this AvataxPingRequest. # noqa: E501 + + + :return: The prod_env of this AvataxPingRequest. # noqa: E501 + :rtype: bool + """ + return self._prod_env + + @prod_env.setter + def prod_env(self, prod_env): + """Sets the prod_env of this AvataxPingRequest. + + + :param prod_env: The prod_env of this AvataxPingRequest. # noqa: E501 + :type: bool + """ + + self._prod_env = prod_env + + @property + def enable_logging(self): + """Gets the enable_logging of this AvataxPingRequest. # noqa: E501 + + + :return: The enable_logging of this AvataxPingRequest. # noqa: E501 + :rtype: bool + """ + return self._enable_logging + + @enable_logging.setter + def enable_logging(self, enable_logging): + """Sets the enable_logging of this AvataxPingRequest. + + + :param enable_logging: The enable_logging of this AvataxPingRequest. # noqa: E501 + :type: bool + """ + + self._enable_logging = enable_logging + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AvataxPingRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AvataxPingRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/avatax_ping_response.py b/billforward/models/avatax_ping_response.py new file mode 100644 index 0000000..a32ff66 --- /dev/null +++ b/billforward/models/avatax_ping_response.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class AvataxPingResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, organization_id=None): # noqa: E501 + """AvataxPingResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this AvataxPingResponse. # noqa: E501 + + + :return: The created of this AvataxPingResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this AvataxPingResponse. + + + :param created: The created of this AvataxPingResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this AvataxPingResponse. # noqa: E501 + + + :return: The organization_id of this AvataxPingResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this AvataxPingResponse. + + + :param organization_id: The organization_id of this AvataxPingResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(AvataxPingResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, AvataxPingResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/bank_account.py b/billforward/models/bank_account.py new file mode 100644 index 0000000..9aab41b --- /dev/null +++ b/billforward/models/bank_account.py @@ -0,0 +1,430 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class BankAccount(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'account_id': 'str', + 'organization_id': 'str', + 'routing_number': 'str', + 'account_number': 'str', + 'payment_method_id': 'str', + 'country': 'str', + 'holder_name': 'str', + 'account_holder_type': 'str', + 'verification_status': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'account_id': 'accountID', + 'organization_id': 'organizationID', + 'routing_number': 'routingNumber', + 'account_number': 'accountNumber', + 'payment_method_id': 'paymentMethodID', + 'country': 'country', + 'holder_name': 'holderName', + 'account_holder_type': 'accountHolderType', + 'verification_status': 'verificationStatus' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, organization_id=None, routing_number=None, account_number=None, payment_method_id=None, country=None, holder_name=None, account_holder_type=None, verification_status=None): # noqa: E501 + """BankAccount - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._account_id = None + self._organization_id = None + self._routing_number = None + self._account_number = None + self._payment_method_id = None + self._country = None + self._holder_name = None + self._account_holder_type = None + self._verification_status = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if account_id is not None: + self.account_id = account_id + if organization_id is not None: + self.organization_id = organization_id + self.routing_number = routing_number + self.account_number = account_number + if payment_method_id is not None: + self.payment_method_id = payment_method_id + if country is not None: + self.country = country + if holder_name is not None: + self.holder_name = holder_name + if account_holder_type is not None: + self.account_holder_type = account_holder_type + if verification_status is not None: + self.verification_status = verification_status + + @property + def created(self): + """Gets the created of this BankAccount. # noqa: E501 + + + :return: The created of this BankAccount. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this BankAccount. + + + :param created: The created of this BankAccount. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this BankAccount. # noqa: E501 + + + :return: The changed_by of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this BankAccount. + + + :param changed_by: The changed_by of this BankAccount. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this BankAccount. # noqa: E501 + + + :return: The updated of this BankAccount. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this BankAccount. + + + :param updated: The updated of this BankAccount. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this BankAccount. # noqa: E501 + + + :return: The id of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this BankAccount. + + + :param id: The id of this BankAccount. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def account_id(self): + """Gets the account_id of this BankAccount. # noqa: E501 + + + :return: The account_id of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this BankAccount. + + + :param account_id: The account_id of this BankAccount. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def organization_id(self): + """Gets the organization_id of this BankAccount. # noqa: E501 + + + :return: The organization_id of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this BankAccount. + + + :param organization_id: The organization_id of this BankAccount. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def routing_number(self): + """Gets the routing_number of this BankAccount. # noqa: E501 + + + :return: The routing_number of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._routing_number + + @routing_number.setter + def routing_number(self, routing_number): + """Sets the routing_number of this BankAccount. + + + :param routing_number: The routing_number of this BankAccount. # noqa: E501 + :type: str + """ + if routing_number is None: + raise ValueError("Invalid value for `routing_number`, must not be `None`") # noqa: E501 + + self._routing_number = routing_number + + @property + def account_number(self): + """Gets the account_number of this BankAccount. # noqa: E501 + + + :return: The account_number of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._account_number + + @account_number.setter + def account_number(self, account_number): + """Sets the account_number of this BankAccount. + + + :param account_number: The account_number of this BankAccount. # noqa: E501 + :type: str + """ + if account_number is None: + raise ValueError("Invalid value for `account_number`, must not be `None`") # noqa: E501 + + self._account_number = account_number + + @property + def payment_method_id(self): + """Gets the payment_method_id of this BankAccount. # noqa: E501 + + + :return: The payment_method_id of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._payment_method_id + + @payment_method_id.setter + def payment_method_id(self, payment_method_id): + """Sets the payment_method_id of this BankAccount. + + + :param payment_method_id: The payment_method_id of this BankAccount. # noqa: E501 + :type: str + """ + + self._payment_method_id = payment_method_id + + @property + def country(self): + """Gets the country of this BankAccount. # noqa: E501 + + + :return: The country of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._country + + @country.setter + def country(self, country): + """Sets the country of this BankAccount. + + + :param country: The country of this BankAccount. # noqa: E501 + :type: str + """ + + self._country = country + + @property + def holder_name(self): + """Gets the holder_name of this BankAccount. # noqa: E501 + + + :return: The holder_name of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._holder_name + + @holder_name.setter + def holder_name(self, holder_name): + """Sets the holder_name of this BankAccount. + + + :param holder_name: The holder_name of this BankAccount. # noqa: E501 + :type: str + """ + + self._holder_name = holder_name + + @property + def account_holder_type(self): + """Gets the account_holder_type of this BankAccount. # noqa: E501 + + + :return: The account_holder_type of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._account_holder_type + + @account_holder_type.setter + def account_holder_type(self, account_holder_type): + """Sets the account_holder_type of this BankAccount. + + + :param account_holder_type: The account_holder_type of this BankAccount. # noqa: E501 + :type: str + """ + + self._account_holder_type = account_holder_type + + @property + def verification_status(self): + """Gets the verification_status of this BankAccount. # noqa: E501 + + + :return: The verification_status of this BankAccount. # noqa: E501 + :rtype: str + """ + return self._verification_status + + @verification_status.setter + def verification_status(self, verification_status): + """Sets the verification_status of this BankAccount. + + + :param verification_status: The verification_status of this BankAccount. # noqa: E501 + :type: str + """ + allowed_values = ["Pending", "Failed", "Verified"] # noqa: E501 + if verification_status not in allowed_values: + raise ValueError( + "Invalid value for `verification_status` ({0}), must be one of {1}" # noqa: E501 + .format(verification_status, allowed_values) + ) + + self._verification_status = verification_status + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(BankAccount, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, BankAccount): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/bank_account_verification_paged_metadata.py b/billforward/models/bank_account_verification_paged_metadata.py deleted file mode 100644 index e42db83..0000000 --- a/billforward/models/bank_account_verification_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class BankAccountVerificationPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - BankAccountVerificationPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this BankAccountVerificationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this BankAccountVerificationPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this BankAccountVerificationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this BankAccountVerificationPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this BankAccountVerificationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this BankAccountVerificationPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this BankAccountVerificationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this BankAccountVerificationPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this BankAccountVerificationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this BankAccountVerificationPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this BankAccountVerificationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this BankAccountVerificationPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this BankAccountVerificationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this BankAccountVerificationPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this BankAccountVerificationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this BankAccountVerificationPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this BankAccountVerificationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this BankAccountVerificationPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this BankAccountVerificationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this BankAccountVerificationPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this BankAccountVerificationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this BankAccountVerificationPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this BankAccountVerificationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this BankAccountVerificationPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this BankAccountVerificationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this BankAccountVerificationPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this BankAccountVerificationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this BankAccountVerificationPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/batch_increment_values_request.py b/billforward/models/batch_increment_values_request.py new file mode 100644 index 0000000..8dbda67 --- /dev/null +++ b/billforward/models/batch_increment_values_request.py @@ -0,0 +1,137 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class BatchIncrementValuesRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'values': 'list[ValueIncrement]', + 'organization_id': 'str' + } + + attribute_map = { + 'values': 'values', + 'organization_id': 'organizationID' + } + + def __init__(self, values=None, organization_id=None): # noqa: E501 + """BatchIncrementValuesRequest - a model defined in Swagger""" # noqa: E501 + self._values = None + self._organization_id = None + self.discriminator = None + self.values = values + if organization_id is not None: + self.organization_id = organization_id + + @property + def values(self): + """Gets the values of this BatchIncrementValuesRequest. # noqa: E501 + + + :return: The values of this BatchIncrementValuesRequest. # noqa: E501 + :rtype: list[ValueIncrement] + """ + return self._values + + @values.setter + def values(self, values): + """Sets the values of this BatchIncrementValuesRequest. + + + :param values: The values of this BatchIncrementValuesRequest. # noqa: E501 + :type: list[ValueIncrement] + """ + if values is None: + raise ValueError("Invalid value for `values`, must not be `None`") # noqa: E501 + + self._values = values + + @property + def organization_id(self): + """Gets the organization_id of this BatchIncrementValuesRequest. # noqa: E501 + + + :return: The organization_id of this BatchIncrementValuesRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this BatchIncrementValuesRequest. + + + :param organization_id: The organization_id of this BatchIncrementValuesRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(BatchIncrementValuesRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, BatchIncrementValuesRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/batch_update_pricing_component_values_request.py b/billforward/models/batch_update_pricing_component_values_request.py new file mode 100644 index 0000000..3b9e949 --- /dev/null +++ b/billforward/models/batch_update_pricing_component_values_request.py @@ -0,0 +1,169 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class BatchUpdatePricingComponentValuesRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'values': 'list[UpdatePricingComponentValueRequest]', + 'issue_invoice_mode': 'str' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'values': 'values', + 'issue_invoice_mode': 'issueInvoiceMode' + } + + def __init__(self, organization_id=None, values=None, issue_invoice_mode=None): # noqa: E501 + """BatchUpdatePricingComponentValuesRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._values = None + self._issue_invoice_mode = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + self.values = values + if issue_invoice_mode is not None: + self.issue_invoice_mode = issue_invoice_mode + + @property + def organization_id(self): + """Gets the organization_id of this BatchUpdatePricingComponentValuesRequest. # noqa: E501 + + + :return: The organization_id of this BatchUpdatePricingComponentValuesRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this BatchUpdatePricingComponentValuesRequest. + + + :param organization_id: The organization_id of this BatchUpdatePricingComponentValuesRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def values(self): + """Gets the values of this BatchUpdatePricingComponentValuesRequest. # noqa: E501 + + + :return: The values of this BatchUpdatePricingComponentValuesRequest. # noqa: E501 + :rtype: list[UpdatePricingComponentValueRequest] + """ + return self._values + + @values.setter + def values(self, values): + """Sets the values of this BatchUpdatePricingComponentValuesRequest. + + + :param values: The values of this BatchUpdatePricingComponentValuesRequest. # noqa: E501 + :type: list[UpdatePricingComponentValueRequest] + """ + if values is None: + raise ValueError("Invalid value for `values`, must not be `None`") # noqa: E501 + + self._values = values + + @property + def issue_invoice_mode(self): + """Gets the issue_invoice_mode of this BatchUpdatePricingComponentValuesRequest. # noqa: E501 + + + :return: The issue_invoice_mode of this BatchUpdatePricingComponentValuesRequest. # noqa: E501 + :rtype: str + """ + return self._issue_invoice_mode + + @issue_invoice_mode.setter + def issue_invoice_mode(self, issue_invoice_mode): + """Sets the issue_invoice_mode of this BatchUpdatePricingComponentValuesRequest. + + + :param issue_invoice_mode: The issue_invoice_mode of this BatchUpdatePricingComponentValuesRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Immediate", "AtPeriodEnd"] # noqa: E501 + if issue_invoice_mode not in allowed_values: + raise ValueError( + "Invalid value for `issue_invoice_mode` ({0}), must be one of {1}" # noqa: E501 + .format(issue_invoice_mode, allowed_values) + ) + + self._issue_invoice_mode = issue_invoice_mode + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(BatchUpdatePricingComponentValuesRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, BatchUpdatePricingComponentValuesRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/bf_error.py b/billforward/models/bf_error.py deleted file mode 100644 index e459739..0000000 --- a/billforward/models/bf_error.py +++ /dev/null @@ -1,208 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class BFError(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, error_type=None, error_message=None, error_code=None, error_parameters=None): - """ - BFError - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'error_type': 'str', - 'error_message': 'str', - 'error_code': 'int', - 'error_parameters': 'list[str]' - } - - self.attribute_map = { - 'error_type': 'errorType', - 'error_message': 'errorMessage', - 'error_code': 'errorCode', - 'error_parameters': 'errorParameters' - } - - self._error_type = error_type - self._error_message = error_message - self._error_code = error_code - self._error_parameters = error_parameters - - @property - def error_type(self): - """ - Gets the error_type of this BFError. - {\"description\":\"Enum categorizing the nature of the error.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The error_type of this BFError. - :rtype: str - """ - return self._error_type - - @error_type.setter - def error_type(self, error_type): - """ - Sets the error_type of this BFError. - {\"description\":\"Enum categorizing the nature of the error.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param error_type: The error_type of this BFError. - :type: str - """ - allowed_values = ["BFError", "ServerError", "ValidationError", "UnserializationException", "Oauth", "PermissionsError", "PreconditionFailed", "NotImplemented", "InvocationError", "NoSuchEntity", "InconsistentState", "StripeOperationFailure", "BraintreeOperationFailure", "BraintreeValidationError", "SagePayOperationFailure", "TokenizationAuthCaptureFailure", "TokenizationPreAuthFailure", "CouponException", "CouponUniqueCodesRequestException", "CouponUniqueCodesResponseException", "RemoveCouponException", "AddCouponCodeToSubscriptionRequestException", "GatewayAuthenticationError", "GatewayAuthorizationError", "GatewayResourceNotFoundError", "GatewayProtocolVersionError", "GatewayInternalError", "GatewayDownTemporarilyError", "GatewayUnexpectedError", "GatewayUnhandledError", "GatewaySDKUnhandledError"] - if error_type not in allowed_values: - raise ValueError( - "Invalid value for `error_type` ({0}), must be one of {1}" - .format(error_type, allowed_values) - ) - - self._error_type = error_type - - @property - def error_message(self): - """ - Gets the error_message of this BFError. - {\"description\":\"Human-readable description of the reason for the error.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The error_message of this BFError. - :rtype: str - """ - return self._error_message - - @error_message.setter - def error_message(self, error_message): - """ - Sets the error_message of this BFError. - {\"description\":\"Human-readable description of the reason for the error.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param error_message: The error_message of this BFError. - :type: str - """ - - self._error_message = error_message - - @property - def error_code(self): - """ - Gets the error_code of this BFError. - {\"description\":\"Code describing the nature of the error. Currently unused; prefer `errorType`.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The error_code of this BFError. - :rtype: int - """ - return self._error_code - - @error_code.setter - def error_code(self, error_code): - """ - Sets the error_code of this BFError. - {\"description\":\"Code describing the nature of the error. Currently unused; prefer `errorType`.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param error_code: The error_code of this BFError. - :type: int - """ - - self._error_code = error_code - - @property - def error_parameters(self): - """ - Gets the error_parameters of this BFError. - {\"description\":\"List of erroneous parameters found in your input (if applicable).\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The error_parameters of this BFError. - :rtype: list[str] - """ - return self._error_parameters - - @error_parameters.setter - def error_parameters(self, error_parameters): - """ - Sets the error_parameters of this BFError. - {\"description\":\"List of erroneous parameters found in your input (if applicable).\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param error_parameters: The error_parameters of this BFError. - :type: list[str] - """ - - self._error_parameters = error_parameters - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/bf_permission.py b/billforward/models/bf_permission.py index 839b1ed..60158fb 100644 --- a/billforward/models/bf_permission.py +++ b/billforward/models/bf_permission.py @@ -1,100 +1,113 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class BFPermission(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, role_id=None, role_name=None, resource=None, action=None, revoked=None, deleted=False): - """ - BFPermission - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'role_id': 'str', - 'role_name': 'str', - 'resource': 'str', - 'action': 'str', - 'revoked': 'datetime', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'role_id': 'roleID', - 'role_name': 'roleName', - 'resource': 'resource', - 'action': 'action', - 'revoked': 'revoked', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._role_id = role_id - self._role_name = role_name - self._resource = resource - self._action = action - self._revoked = revoked - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'role_id': 'str', + 'role_name': 'str', + 'resource': 'str', + 'action': 'str', + 'revoked': 'datetime', + 'deleted': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'role_id': 'roleID', + 'role_name': 'roleName', + 'resource': 'resource', + 'action': 'action', + 'revoked': 'revoked', + 'deleted': 'deleted' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, role_id=None, role_name=None, resource=None, action=None, revoked=None, deleted=None): # noqa: E501 + """BFPermission - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._role_id = None + self._role_name = None + self._resource = None + self._action = None + self._revoked = None + self._deleted = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if role_id is not None: + self.role_id = role_id + if role_name is not None: + self.role_name = role_name + if resource is not None: + self.resource = resource + if action is not None: + self.action = action + if revoked is not None: + self.revoked = revoked + if deleted is not None: + self.deleted = deleted @property def created(self): - """ - Gets the created of this BFPermission. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this BFPermission. # noqa: E501 + - :return: The created of this BFPermission. + :return: The created of this BFPermission. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this BFPermission. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this BFPermission. - :param created: The created of this BFPermission. + + :param created: The created of this BFPermission. # noqa: E501 :type: datetime """ @@ -102,22 +115,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this BFPermission. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this BFPermission. # noqa: E501 + - :return: The changed_by of this BFPermission. + :return: The changed_by of this BFPermission. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this BFPermission. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this BFPermission. + - :param changed_by: The changed_by of this BFPermission. + :param changed_by: The changed_by of this BFPermission. # noqa: E501 :type: str """ @@ -125,22 +136,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this BFPermission. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this BFPermission. # noqa: E501 - :return: The updated of this BFPermission. + + :return: The updated of this BFPermission. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this BFPermission. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this BFPermission. - :param updated: The updated of this BFPermission. + + :param updated: The updated of this BFPermission. # noqa: E501 :type: datetime """ @@ -148,45 +157,62 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this BFPermission. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the id of this BFPermission. # noqa: E501 + - :return: The id of this BFPermission. + :return: The id of this BFPermission. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this BFPermission. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the id of this BFPermission. + - :param id: The id of this BFPermission. + :param id: The id of this BFPermission. # noqa: E501 :type: str """ self._id = id @property - def role_id(self): + def organization_id(self): + """Gets the organization_id of this BFPermission. # noqa: E501 + + + :return: The organization_id of this BFPermission. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this BFPermission. + + + :param organization_id: The organization_id of this BFPermission. # noqa: E501 + :type: str """ - Gets the role_id of this BFPermission. - { \"description\" : \"\", \"verbs\":[\"GET\", \"POST\"] } - :return: The role_id of this BFPermission. + self._organization_id = organization_id + + @property + def role_id(self): + """Gets the role_id of this BFPermission. # noqa: E501 + + + :return: The role_id of this BFPermission. # noqa: E501 :rtype: str """ return self._role_id @role_id.setter def role_id(self, role_id): - """ - Sets the role_id of this BFPermission. - { \"description\" : \"\", \"verbs\":[\"GET\", \"POST\"] } + """Sets the role_id of this BFPermission. + - :param role_id: The role_id of this BFPermission. + :param role_id: The role_id of this BFPermission. # noqa: E501 :type: str """ @@ -194,22 +220,20 @@ def role_id(self, role_id): @property def role_name(self): - """ - Gets the role_name of this BFPermission. - { \"description\" : \"\", \"verbs\":[\"GET\", \"POST\"] } + """Gets the role_name of this BFPermission. # noqa: E501 + - :return: The role_name of this BFPermission. + :return: The role_name of this BFPermission. # noqa: E501 :rtype: str """ return self._role_name @role_name.setter def role_name(self, role_name): - """ - Sets the role_name of this BFPermission. - { \"description\" : \"\", \"verbs\":[\"GET\", \"POST\"] } + """Sets the role_name of this BFPermission. - :param role_name: The role_name of this BFPermission. + + :param role_name: The role_name of this BFPermission. # noqa: E501 :type: str """ @@ -217,28 +241,26 @@ def role_name(self, role_name): @property def resource(self): - """ - Gets the resource of this BFPermission. - { \"description\" : \"BillForward resource associated with this permission.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the resource of this BFPermission. # noqa: E501 - :return: The resource of this BFPermission. + + :return: The resource of this BFPermission. # noqa: E501 :rtype: str """ return self._resource @resource.setter def resource(self, resource): - """ - Sets the resource of this BFPermission. - { \"description\" : \"BillForward resource associated with this permission.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the resource of this BFPermission. + - :param resource: The resource of this BFPermission. + :param resource: The resource of this BFPermission. # noqa: E501 :type: str """ - allowed_values = ["All", "Account", "Address", "Amendment", "Analytics", "Audit", "BFAdmin", "BFJS", "Charge", "Client", "Configuration", "CouponBook", "CouponBookDefinition", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "Coupon", "Credit", "CybersourceToken", "Dunning", "Email", "FixedTerm", "Gateway", "Invoice", "Notification", "Organization", "Password", "PaymentMethod", "Payment", "Permission", "PricingComponent", "PricingComponentTier", "PricingComponentValueChange", "PricingComponentValue", "ProductRatePlan", "Product", "ProductResources", "Profile", "Quote", "Receipt", "Refund", "Salesforce", "Search", "Subscription", "Tax", "UnitOfMeasure", "Usage", "Username", "User", "UserResources", "Webhook"] + allowed_values = ["All", "Account", "Address", "Amendment", "Analytics", "Audit", "BFAdmin", "BFJS", "Charge", "CheckoutDefinition", "Client", "Configuration", "CouponBook", "CouponBookDefinition", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "Coupon", "Credit", "CybersourceToken", "Dunning", "Email", "FixedTerm", "Gateway", "Invoice", "InvoiceTemplateConfiguration", "Metadata", "Notification", "Organization", "OrganizationProfile", "Password", "PaymentMethod", "Payment", "Permission", "PricingComponent", "PricingComponentTier", "PricingComponentValueChange", "PricingComponentValue", "ProductRatePlan", "Product", "ProductResources", "Profile", "SubscriptionNotificationConfiguration", "Quote", "Receipt", "Report", "Refund", "Salesforce", "Search", "Subscription", "Tax", "UnitOfMeasure", "Usage", "Username", "User", "UserResources", "Webhook", "Contract", "Xero", "QuickBooks", "ContractPeriod", "HubSpot", "EmailNotifications", "EmailNotificationsConfig", "Shuttle", "RequestLogging"] # noqa: E501 if resource not in allowed_values: raise ValueError( - "Invalid value for `resource` ({0}), must be one of {1}" + "Invalid value for `resource` ({0}), must be one of {1}" # noqa: E501 .format(resource, allowed_values) ) @@ -246,28 +268,26 @@ def resource(self, resource): @property def action(self): - """ - Gets the action of this BFPermission. - { \"description\" : \"Action they may be performed on the associated resource.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the action of this BFPermission. # noqa: E501 + - :return: The action of this BFPermission. + :return: The action of this BFPermission. # noqa: E501 :rtype: str """ return self._action @action.setter def action(self, action): - """ - Sets the action of this BFPermission. - { \"description\" : \"Action they may be performed on the associated resource.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the action of this BFPermission. + - :param action: The action of this BFPermission. + :param action: The action of this BFPermission. # noqa: E501 :type: str """ - allowed_values = ["All", "AddToInvoice", "AddToProductRatePlan", "AddToSubscription", "Advance", "Aggregate", "RemoveFromInvoice", "RemoveFromProductRatePlan", "RemoveFromSubscription", "Cancel", "Create", "Delete", "Edit", "Execute", "Freeze", "Import", "InvoiceCharges", "Issue", "Migrate", "Read", "Recalculate", "Reset", "Resume", "Revive", "Stop", "Tokenize", "Void"] + allowed_values = ["All", "AddToInvoice", "AddToAccount", "AddToProductRatePlan", "AddToSubscription", "Advance", "Aggregate", "RemoveFromInvoice", "RemoveFromProductRatePlan", "RemoveFromSubscription", "Cancel", "Create", "Delete", "Edit", "Execute", "Freeze", "Import", "InvoiceCharges", "Issue", "MetadataCreate", "MetadataEdit", "MetadataDelete", "Migrate", "Read", "Recalculate", "Refund", "Reset", "Resume", "Revive", "Start", "Stop", "Tokenize", "Void"] # noqa: E501 if action not in allowed_values: raise ValueError( - "Invalid value for `action` ({0}), must be one of {1}" + "Invalid value for `action` ({0}), must be one of {1}" # noqa: E501 .format(action, allowed_values) ) @@ -275,22 +295,20 @@ def action(self, action): @property def revoked(self): - """ - Gets the revoked of this BFPermission. - { \"description\" : \"If a permission is deleted it is set as revoked from this date. The role with this permission will no longer have its applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the revoked of this BFPermission. # noqa: E501 - :return: The revoked of this BFPermission. + + :return: The revoked of this BFPermission. # noqa: E501 :rtype: datetime """ return self._revoked @revoked.setter def revoked(self, revoked): - """ - Sets the revoked of this BFPermission. - { \"description\" : \"If a permission is deleted it is set as revoked from this date. The role with this permission will no longer have its applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the revoked of this BFPermission. + - :param revoked: The revoked of this BFPermission. + :param revoked: The revoked of this BFPermission. # noqa: E501 :type: datetime """ @@ -298,34 +316,30 @@ def revoked(self, revoked): @property def deleted(self): - """ - Gets the deleted of this BFPermission. - { \"default\" : \"false\", \"description\" : \"If a permission is deleted the role with this permission will no longer have its applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the deleted of this BFPermission. # noqa: E501 + - :return: The deleted of this BFPermission. + :return: The deleted of this BFPermission. # noqa: E501 :rtype: bool """ return self._deleted @deleted.setter def deleted(self, deleted): - """ - Sets the deleted of this BFPermission. - { \"default\" : \"false\", \"description\" : \"If a permission is deleted the role with this permission will no longer have its applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the deleted of this BFPermission. - :param deleted: The deleted of this BFPermission. + + :param deleted: The deleted of this BFPermission. # noqa: E501 :type: bool """ self._deleted = deleted def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -342,29 +356,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(BFPermission, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, BFPermission): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/bf_permission_paged_metadata.py b/billforward/models/bf_permission_paged_metadata.py deleted file mode 100644 index 8febc40..0000000 --- a/billforward/models/bf_permission_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class BFPermissionPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - BFPermissionPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BFPermission]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this BFPermissionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this BFPermissionPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this BFPermissionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this BFPermissionPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this BFPermissionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this BFPermissionPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this BFPermissionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this BFPermissionPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this BFPermissionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this BFPermissionPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this BFPermissionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this BFPermissionPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this BFPermissionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this BFPermissionPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this BFPermissionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this BFPermissionPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this BFPermissionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this BFPermissionPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this BFPermissionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this BFPermissionPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this BFPermissionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this BFPermissionPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this BFPermissionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this BFPermissionPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this BFPermissionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this BFPermissionPagedMetadata. - :rtype: list[BFPermission] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this BFPermissionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this BFPermissionPagedMetadata. - :type: list[BFPermission] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/billforward_managed_payments_result_paged_metadata.py b/billforward/models/billforward_managed_payments_result_paged_metadata.py deleted file mode 100644 index 1cab79c..0000000 --- a/billforward/models/billforward_managed_payments_result_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class BillforwardManagedPaymentsResultPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - BillforwardManagedPaymentsResultPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this BillforwardManagedPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this BillforwardManagedPaymentsResultPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this BillforwardManagedPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this BillforwardManagedPaymentsResultPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this BillforwardManagedPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this BillforwardManagedPaymentsResultPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this BillforwardManagedPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this BillforwardManagedPaymentsResultPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this BillforwardManagedPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this BillforwardManagedPaymentsResultPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this BillforwardManagedPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this BillforwardManagedPaymentsResultPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this BillforwardManagedPaymentsResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this BillforwardManagedPaymentsResultPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this BillforwardManagedPaymentsResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this BillforwardManagedPaymentsResultPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this BillforwardManagedPaymentsResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this BillforwardManagedPaymentsResultPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this BillforwardManagedPaymentsResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this BillforwardManagedPaymentsResultPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this BillforwardManagedPaymentsResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this BillforwardManagedPaymentsResultPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this BillforwardManagedPaymentsResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this BillforwardManagedPaymentsResultPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this BillforwardManagedPaymentsResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this BillforwardManagedPaymentsResultPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this BillforwardManagedPaymentsResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this BillforwardManagedPaymentsResultPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/billing_entity_base.py b/billforward/models/billing_entity_base.py index c7518cc..e99a323 100644 --- a/billforward/models/billing_entity_base.py +++ b/billforward/models/billing_entity_base.py @@ -1,85 +1,99 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class BillingEntityBase(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None): - """ - BillingEntityBase - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime' - } - - self.attribute_map = { - 'created': 'created' - } - - self._created = created + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, organization_id=None): # noqa: E501 + """BillingEntityBase - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id @property def created(self): - """ - Gets the created of this BillingEntityBase. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this BillingEntityBase. # noqa: E501 - :return: The created of this BillingEntityBase. + + :return: The created of this BillingEntityBase. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this BillingEntityBase. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this BillingEntityBase. - :param created: The created of this BillingEntityBase. + + :param created: The created of this BillingEntityBase. # noqa: E501 :type: datetime """ self._created = created - def to_dict(self): + @property + def organization_id(self): + """Gets the organization_id of this BillingEntityBase. # noqa: E501 + + + :return: The organization_id of this BillingEntityBase. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this BillingEntityBase. + + + :param organization_id: The organization_id of this BillingEntityBase. # noqa: E501 + :type: str """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -96,29 +110,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(BillingEntityBase, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, BillingEntityBase): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/braintree_auth_capture_request.py b/billforward/models/braintree_auth_capture_request.py index 1438db5..463f9ce 100644 --- a/billforward/models/braintree_auth_capture_request.py +++ b/billforward/models/braintree_auth_capture_request.py @@ -1,383 +1,132 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.auth_capture_request import AuthCaptureRequest # noqa: F401,E501 + +class BraintreeAuthCaptureRequest(AuthCaptureRequest): + """NOTE: This class is auto generated by the swagger code generator program. -class BraintreeAuthCaptureRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, type=None, account_id=None, gateway=None, company_name=None, email=None, first_name=None, last_name=None, mobile=None, default_payment_method=False, organization_id=None, payment_method_nonce=None, device_data=None): - """ - BraintreeAuthCaptureRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'type': 'str', - 'account_id': 'str', - 'gateway': 'str', - 'company_name': 'str', - 'email': 'str', - 'first_name': 'str', - 'last_name': 'str', - 'mobile': 'str', - 'default_payment_method': 'bool', - 'organization_id': 'str', - 'payment_method_nonce': 'str', - 'device_data': 'str' - } - - self.attribute_map = { - 'type': '@type', - 'account_id': 'accountID', - 'gateway': 'gateway', - 'company_name': 'companyName', - 'email': 'email', - 'first_name': 'firstName', - 'last_name': 'lastName', - 'mobile': 'mobile', - 'default_payment_method': 'defaultPaymentMethod', - 'organization_id': 'organizationID', - 'payment_method_nonce': 'paymentMethodNonce', - 'device_data': 'deviceData' - } - - self._type = type - self._account_id = account_id - self._gateway = gateway - self._company_name = company_name - self._email = email - self._first_name = first_name - self._last_name = last_name - self._mobile = mobile - self._default_payment_method = default_payment_method - self._organization_id = organization_id - self._payment_method_nonce = payment_method_nonce - self._device_data = device_data - - @property - def type(self): - """ - Gets the type of this BraintreeAuthCaptureRequest. - - - :return: The type of this BraintreeAuthCaptureRequest. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this BraintreeAuthCaptureRequest. - - - :param type: The type of this BraintreeAuthCaptureRequest. - :type: str - """ - allowed_values = ["StripeAuthCaptureRequest"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def account_id(self): - """ - Gets the account_id of this BraintreeAuthCaptureRequest. - {\"description\":\"ID of the BillForward Account with which you would like to associate the created payment method.
If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.\",\"verbs\":[\"POST\"]} - - :return: The account_id of this BraintreeAuthCaptureRequest. - :rtype: str - """ - return self._account_id - - @account_id.setter - def account_id(self, account_id): - """ - Sets the account_id of this BraintreeAuthCaptureRequest. - {\"description\":\"ID of the BillForward Account with which you would like to associate the created payment method.
If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.\",\"verbs\":[\"POST\"]} - - :param account_id: The account_id of this BraintreeAuthCaptureRequest. - :type: str - """ - - self._account_id = account_id + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'payment_method_nonce': 'str', + 'device_data': 'str', + 'merchant_account_id': 'str' + } + if hasattr(AuthCaptureRequest, "swagger_types"): + swagger_types.update(AuthCaptureRequest.swagger_types) + + attribute_map = { + 'payment_method_nonce': 'paymentMethodNonce', + 'device_data': 'deviceData', + 'merchant_account_id': 'merchantAccountId' + } + if hasattr(AuthCaptureRequest, "attribute_map"): + attribute_map.update(AuthCaptureRequest.attribute_map) + + def __init__(self, payment_method_nonce=None, device_data=None, merchant_account_id=None, *args, **kwargs): # noqa: E501 + """BraintreeAuthCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._payment_method_nonce = None + self._device_data = None + self._merchant_account_id = None + self.discriminator = None + self.payment_method_nonce = payment_method_nonce + if device_data is not None: + self.device_data = device_data + if merchant_account_id is not None: + self.merchant_account_id = merchant_account_id + AuthCaptureRequest.__init__(self, *args, **kwargs) @property - def gateway(self): - """ - Gets the gateway of this BraintreeAuthCaptureRequest. - {\"description\":\"The gateway with which your funding instrument has been vaulted.\",\"verbs\":[\"POST\"]} - - :return: The gateway of this BraintreeAuthCaptureRequest. - :rtype: str - """ - return self._gateway - - @gateway.setter - def gateway(self, gateway): - """ - Sets the gateway of this BraintreeAuthCaptureRequest. - {\"description\":\"The gateway with which your funding instrument has been vaulted.\",\"verbs\":[\"POST\"]} - - :param gateway: The gateway of this BraintreeAuthCaptureRequest. - :type: str - """ - allowed_values = ["Balanced", "Braintree", "Cybersource", "Paypal", "Stripe", "AuthorizeNet", "Spreedly", "SagePay", "TrustCommerce", "Payvision", "Kash"] - if gateway not in allowed_values: - raise ValueError( - "Invalid value for `gateway` ({0}), must be one of {1}" - .format(gateway, allowed_values) - ) - - self._gateway = gateway + def payment_method_nonce(self): + """Gets the payment_method_nonce of this BraintreeAuthCaptureRequest. # noqa: E501 - @property - def company_name(self): - """ - Gets the company_name of this BraintreeAuthCaptureRequest. - {\"description\":\"The name of the company of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - :return: The company_name of this BraintreeAuthCaptureRequest. + :return: The payment_method_nonce of this BraintreeAuthCaptureRequest. # noqa: E501 :rtype: str """ - return self._company_name - - @company_name.setter - def company_name(self, company_name): - """ - Sets the company_name of this BraintreeAuthCaptureRequest. - {\"description\":\"The name of the company of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :param company_name: The company_name of this BraintreeAuthCaptureRequest. - :type: str - """ - - self._company_name = company_name - - @property - def email(self): - """ - Gets the email of this BraintreeAuthCaptureRequest. - {\"description\":\"The email address of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} + return self._payment_method_nonce - :return: The email of this BraintreeAuthCaptureRequest. - :rtype: str - """ - return self._email + @payment_method_nonce.setter + def payment_method_nonce(self, payment_method_nonce): + """Sets the payment_method_nonce of this BraintreeAuthCaptureRequest. - @email.setter - def email(self, email): - """ - Sets the email of this BraintreeAuthCaptureRequest. - {\"description\":\"The email address of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - :param email: The email of this BraintreeAuthCaptureRequest. + :param payment_method_nonce: The payment_method_nonce of this BraintreeAuthCaptureRequest. # noqa: E501 :type: str """ + if payment_method_nonce is None: + raise ValueError("Invalid value for `payment_method_nonce`, must not be `None`") # noqa: E501 - self._email = email + self._payment_method_nonce = payment_method_nonce @property - def first_name(self): - """ - Gets the first_name of this BraintreeAuthCaptureRequest. - {\"description\":\"The first name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :return: The first_name of this BraintreeAuthCaptureRequest. - :rtype: str - """ - return self._first_name - - @first_name.setter - def first_name(self, first_name): - """ - Sets the first_name of this BraintreeAuthCaptureRequest. - {\"description\":\"The first name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :param first_name: The first_name of this BraintreeAuthCaptureRequest. - :type: str - """ + def device_data(self): + """Gets the device_data of this BraintreeAuthCaptureRequest. # noqa: E501 - self._first_name = first_name - @property - def last_name(self): - """ - Gets the last_name of this BraintreeAuthCaptureRequest. - {\"description\":\"The last name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :return: The last_name of this BraintreeAuthCaptureRequest. + :return: The device_data of this BraintreeAuthCaptureRequest. # noqa: E501 :rtype: str """ - return self._last_name - - @last_name.setter - def last_name(self, last_name): - """ - Sets the last_name of this BraintreeAuthCaptureRequest. - {\"description\":\"The last name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :param last_name: The last_name of this BraintreeAuthCaptureRequest. - :type: str - """ - - self._last_name = last_name - - @property - def mobile(self): - """ - Gets the mobile of this BraintreeAuthCaptureRequest. - {\"description\":\"The mobile phone number of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} + return self._device_data - :return: The mobile of this BraintreeAuthCaptureRequest. - :rtype: str - """ - return self._mobile + @device_data.setter + def device_data(self, device_data): + """Sets the device_data of this BraintreeAuthCaptureRequest. - @mobile.setter - def mobile(self, mobile): - """ - Sets the mobile of this BraintreeAuthCaptureRequest. - {\"description\":\"The mobile phone number of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - :param mobile: The mobile of this BraintreeAuthCaptureRequest. + :param device_data: The device_data of this BraintreeAuthCaptureRequest. # noqa: E501 :type: str """ - self._mobile = mobile + self._device_data = device_data @property - def default_payment_method(self): - """ - Gets the default_payment_method of this BraintreeAuthCaptureRequest. - {\"default\":false,\"description\":\"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).\",\"verbs\":[\"POST\"]} - - :return: The default_payment_method of this BraintreeAuthCaptureRequest. - :rtype: bool - """ - return self._default_payment_method - - @default_payment_method.setter - def default_payment_method(self, default_payment_method): - """ - Sets the default_payment_method of this BraintreeAuthCaptureRequest. - {\"default\":false,\"description\":\"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).\",\"verbs\":[\"POST\"]} - - :param default_payment_method: The default_payment_method of this BraintreeAuthCaptureRequest. - :type: bool - """ + def merchant_account_id(self): + """Gets the merchant_account_id of this BraintreeAuthCaptureRequest. # noqa: E501 - self._default_payment_method = default_payment_method - @property - def organization_id(self): - """ - Gets the organization_id of this BraintreeAuthCaptureRequest. - {\"description\":\"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} - - :return: The organization_id of this BraintreeAuthCaptureRequest. + :return: The merchant_account_id of this BraintreeAuthCaptureRequest. # noqa: E501 :rtype: str """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this BraintreeAuthCaptureRequest. - {\"description\":\"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} + return self._merchant_account_id - :param organization_id: The organization_id of this BraintreeAuthCaptureRequest. - :type: str - """ + @merchant_account_id.setter + def merchant_account_id(self, merchant_account_id): + """Sets the merchant_account_id of this BraintreeAuthCaptureRequest. - self._organization_id = organization_id - - @property - def payment_method_nonce(self): - """ - Gets the payment_method_nonce of this BraintreeAuthCaptureRequest. - {\"description\":\"One-use cryptographic nonce provided by Braintree's client-side card capture SDK, in response to your capturing a card into the Braintree vault. This nonce will be used by BillForward to find the tokenized card within the Braintree vault — precursory to linking a BillForward PaymentMethod to that tokenized card\",\"verbs\":[\"POST\"]} - :return: The payment_method_nonce of this BraintreeAuthCaptureRequest. - :rtype: str - """ - return self._payment_method_nonce - - @payment_method_nonce.setter - def payment_method_nonce(self, payment_method_nonce): - """ - Sets the payment_method_nonce of this BraintreeAuthCaptureRequest. - {\"description\":\"One-use cryptographic nonce provided by Braintree's client-side card capture SDK, in response to your capturing a card into the Braintree vault. This nonce will be used by BillForward to find the tokenized card within the Braintree vault — precursory to linking a BillForward PaymentMethod to that tokenized card\",\"verbs\":[\"POST\"]} - - :param payment_method_nonce: The payment_method_nonce of this BraintreeAuthCaptureRequest. + :param merchant_account_id: The merchant_account_id of this BraintreeAuthCaptureRequest. # noqa: E501 :type: str """ - self._payment_method_nonce = payment_method_nonce - - @property - def device_data(self): - """ - Gets the device_data of this BraintreeAuthCaptureRequest. - {\"description\":\"(Required when vaulting a PayPal payment method; otherwise optional)
A JSON string providing information about the device your customer used to fill out the card capture form. This information is inserted into your form by braintree-data.js — if and only if you use Braintree's drop-in form integrations. You should ideally provide it if you have one (it aids with fraud detection), but it is only mandatory in the case of PayPal payment method vaulting.\",\"verbs\":[\"POST\"]} - - :return: The device_data of this BraintreeAuthCaptureRequest. - :rtype: str - """ - return self._device_data - - @device_data.setter - def device_data(self, device_data): - """ - Sets the device_data of this BraintreeAuthCaptureRequest. - {\"description\":\"(Required when vaulting a PayPal payment method; otherwise optional)
A JSON string providing information about the device your customer used to fill out the card capture form. This information is inserted into your form by braintree-data.js — if and only if you use Braintree's drop-in form integrations. You should ideally provide it if you have one (it aids with fraud detection), but it is only mandatory in the case of PayPal payment method vaulting.\",\"verbs\":[\"POST\"]} - - :param device_data: The device_data of this BraintreeAuthCaptureRequest. - :type: str - """ - - self._device_data = device_data + self._merchant_account_id = merchant_account_id def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -394,29 +143,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(BraintreeAuthCaptureRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, BraintreeAuthCaptureRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/braintree_capture_request.py b/billforward/models/braintree_capture_request.py index c65c869..b5e9258 100644 --- a/billforward/models/braintree_capture_request.py +++ b/billforward/models/braintree_capture_request.py @@ -1,109 +1,123 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class BraintreeCaptureRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, organization_id=None, account_id=None, default_payment_method=False, cardholder_name=None, card_number=None, expiry_month=None, expiry_year=None, cvv=None, device_data=None, merchant_account_id=None, ip_address=None, ip_address_country=None): - """ - BraintreeCaptureRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'organization_id': 'str', - 'account_id': 'str', - 'default_payment_method': 'bool', - 'cardholder_name': 'str', - 'card_number': 'str', - 'expiry_month': 'str', - 'expiry_year': 'str', - 'cvv': 'str', - 'device_data': 'str', - 'merchant_account_id': 'str', - 'ip_address': 'str', - 'ip_address_country': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'organization_id': 'organizationID', - 'account_id': 'accountID', - 'default_payment_method': 'defaultPaymentMethod', - 'cardholder_name': 'cardholderName', - 'card_number': 'cardNumber', - 'expiry_month': 'expiryMonth', - 'expiry_year': 'expiryYear', - 'cvv': 'cvv', - 'device_data': 'deviceData', - 'merchant_account_id': 'merchantAccountId', - 'ip_address': 'ipAddress', - 'ip_address_country': 'ipAddressCountry' - } - - self._created = created - self._organization_id = organization_id - self._account_id = account_id - self._default_payment_method = default_payment_method - self._cardholder_name = cardholder_name - self._card_number = card_number - self._expiry_month = expiry_month - self._expiry_year = expiry_year - self._cvv = cvv - self._device_data = device_data - self._merchant_account_id = merchant_account_id - self._ip_address = ip_address - self._ip_address_country = ip_address_country + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'account_id': 'str', + 'default_payment_method': 'bool', + 'cardholder_name': 'str', + 'card_number': 'str', + 'expiry_month': 'str', + 'expiry_year': 'str', + 'cvv': 'str', + 'device_data': 'str', + 'merchant_account_id': 'str', + 'ip_address': 'str', + 'ip_address_country': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'default_payment_method': 'defaultPaymentMethod', + 'cardholder_name': 'cardholderName', + 'card_number': 'cardNumber', + 'expiry_month': 'expiryMonth', + 'expiry_year': 'expiryYear', + 'cvv': 'cvv', + 'device_data': 'deviceData', + 'merchant_account_id': 'merchantAccountId', + 'ip_address': 'ipAddress', + 'ip_address_country': 'ipAddressCountry' + } + + def __init__(self, created=None, organization_id=None, account_id=None, default_payment_method=None, cardholder_name=None, card_number=None, expiry_month=None, expiry_year=None, cvv=None, device_data=None, merchant_account_id=None, ip_address=None, ip_address_country=None): # noqa: E501 + """BraintreeCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._account_id = None + self._default_payment_method = None + self._cardholder_name = None + self._card_number = None + self._expiry_month = None + self._expiry_year = None + self._cvv = None + self._device_data = None + self._merchant_account_id = None + self._ip_address = None + self._ip_address_country = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if default_payment_method is not None: + self.default_payment_method = default_payment_method + if cardholder_name is not None: + self.cardholder_name = cardholder_name + if card_number is not None: + self.card_number = card_number + if expiry_month is not None: + self.expiry_month = expiry_month + if expiry_year is not None: + self.expiry_year = expiry_year + if cvv is not None: + self.cvv = cvv + if device_data is not None: + self.device_data = device_data + if merchant_account_id is not None: + self.merchant_account_id = merchant_account_id + if ip_address is not None: + self.ip_address = ip_address + if ip_address_country is not None: + self.ip_address_country = ip_address_country @property def created(self): - """ - Gets the created of this BraintreeCaptureRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this BraintreeCaptureRequest. # noqa: E501 - :return: The created of this BraintreeCaptureRequest. + + :return: The created of this BraintreeCaptureRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this BraintreeCaptureRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this BraintreeCaptureRequest. + - :param created: The created of this BraintreeCaptureRequest. + :param created: The created of this BraintreeCaptureRequest. # noqa: E501 :type: datetime """ @@ -111,22 +125,20 @@ def created(self, created): @property def organization_id(self): - """ - Gets the organization_id of this BraintreeCaptureRequest. - {\"description\":\"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} + """Gets the organization_id of this BraintreeCaptureRequest. # noqa: E501 + - :return: The organization_id of this BraintreeCaptureRequest. + :return: The organization_id of this BraintreeCaptureRequest. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this BraintreeCaptureRequest. - {\"description\":\"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} + """Sets the organization_id of this BraintreeCaptureRequest. - :param organization_id: The organization_id of this BraintreeCaptureRequest. + + :param organization_id: The organization_id of this BraintreeCaptureRequest. # noqa: E501 :type: str """ @@ -134,22 +146,20 @@ def organization_id(self, organization_id): @property def account_id(self): - """ - Gets the account_id of this BraintreeCaptureRequest. - {\"description\":\"ID of the BillForward Account with which you would like to associate the created payment method.
If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.\",\"verbs\":[\"POST\"]} + """Gets the account_id of this BraintreeCaptureRequest. # noqa: E501 - :return: The account_id of this BraintreeCaptureRequest. + + :return: The account_id of this BraintreeCaptureRequest. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this BraintreeCaptureRequest. - {\"description\":\"ID of the BillForward Account with which you would like to associate the created payment method.
If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.\",\"verbs\":[\"POST\"]} + """Sets the account_id of this BraintreeCaptureRequest. + - :param account_id: The account_id of this BraintreeCaptureRequest. + :param account_id: The account_id of this BraintreeCaptureRequest. # noqa: E501 :type: str """ @@ -157,22 +167,20 @@ def account_id(self, account_id): @property def default_payment_method(self): - """ - Gets the default_payment_method of this BraintreeCaptureRequest. - {\"default\":false,\"description\":\"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).\",\"verbs\":[\"POST\"]} + """Gets the default_payment_method of this BraintreeCaptureRequest. # noqa: E501 + - :return: The default_payment_method of this BraintreeCaptureRequest. + :return: The default_payment_method of this BraintreeCaptureRequest. # noqa: E501 :rtype: bool """ return self._default_payment_method @default_payment_method.setter def default_payment_method(self, default_payment_method): - """ - Sets the default_payment_method of this BraintreeCaptureRequest. - {\"default\":false,\"description\":\"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).\",\"verbs\":[\"POST\"]} + """Sets the default_payment_method of this BraintreeCaptureRequest. - :param default_payment_method: The default_payment_method of this BraintreeCaptureRequest. + + :param default_payment_method: The default_payment_method of this BraintreeCaptureRequest. # noqa: E501 :type: bool """ @@ -180,22 +188,20 @@ def default_payment_method(self, default_payment_method): @property def cardholder_name(self): - """ - Gets the cardholder_name of this BraintreeCaptureRequest. - {\"description\":\"Name of the person who holds the credit card being captured.\",\"verbs\":[\"POST\"]} + """Gets the cardholder_name of this BraintreeCaptureRequest. # noqa: E501 + - :return: The cardholder_name of this BraintreeCaptureRequest. + :return: The cardholder_name of this BraintreeCaptureRequest. # noqa: E501 :rtype: str """ return self._cardholder_name @cardholder_name.setter def cardholder_name(self, cardholder_name): - """ - Sets the cardholder_name of this BraintreeCaptureRequest. - {\"description\":\"Name of the person who holds the credit card being captured.\",\"verbs\":[\"POST\"]} + """Sets the cardholder_name of this BraintreeCaptureRequest. + - :param cardholder_name: The cardholder_name of this BraintreeCaptureRequest. + :param cardholder_name: The cardholder_name of this BraintreeCaptureRequest. # noqa: E501 :type: str """ @@ -203,22 +209,20 @@ def cardholder_name(self, cardholder_name): @property def card_number(self): - """ - Gets the card_number of this BraintreeCaptureRequest. - {\"description\":\"Number of the credit card being captured.\",\"verbs\":[\"POST\"]} + """Gets the card_number of this BraintreeCaptureRequest. # noqa: E501 + - :return: The card_number of this BraintreeCaptureRequest. + :return: The card_number of this BraintreeCaptureRequest. # noqa: E501 :rtype: str """ return self._card_number @card_number.setter def card_number(self, card_number): - """ - Sets the card_number of this BraintreeCaptureRequest. - {\"description\":\"Number of the credit card being captured.\",\"verbs\":[\"POST\"]} + """Sets the card_number of this BraintreeCaptureRequest. - :param card_number: The card_number of this BraintreeCaptureRequest. + + :param card_number: The card_number of this BraintreeCaptureRequest. # noqa: E501 :type: str """ @@ -226,22 +230,20 @@ def card_number(self, card_number): @property def expiry_month(self): - """ - Gets the expiry_month of this BraintreeCaptureRequest. - {\"description\":\"Expiration month of the credit card being captured, formatted MM.\",\"verbs\":[\"POST\"]} + """Gets the expiry_month of this BraintreeCaptureRequest. # noqa: E501 + - :return: The expiry_month of this BraintreeCaptureRequest. + :return: The expiry_month of this BraintreeCaptureRequest. # noqa: E501 :rtype: str """ return self._expiry_month @expiry_month.setter def expiry_month(self, expiry_month): - """ - Sets the expiry_month of this BraintreeCaptureRequest. - {\"description\":\"Expiration month of the credit card being captured, formatted MM.\",\"verbs\":[\"POST\"]} + """Sets the expiry_month of this BraintreeCaptureRequest. + - :param expiry_month: The expiry_month of this BraintreeCaptureRequest. + :param expiry_month: The expiry_month of this BraintreeCaptureRequest. # noqa: E501 :type: str """ @@ -249,22 +251,20 @@ def expiry_month(self, expiry_month): @property def expiry_year(self): - """ - Gets the expiry_year of this BraintreeCaptureRequest. - {\"description\":\"Expiration year of the credit card being captured, formatted YYYY or YY.\",\"verbs\":[\"POST\"]} + """Gets the expiry_year of this BraintreeCaptureRequest. # noqa: E501 - :return: The expiry_year of this BraintreeCaptureRequest. + + :return: The expiry_year of this BraintreeCaptureRequest. # noqa: E501 :rtype: str """ return self._expiry_year @expiry_year.setter def expiry_year(self, expiry_year): - """ - Sets the expiry_year of this BraintreeCaptureRequest. - {\"description\":\"Expiration year of the credit card being captured, formatted YYYY or YY.\",\"verbs\":[\"POST\"]} + """Sets the expiry_year of this BraintreeCaptureRequest. - :param expiry_year: The expiry_year of this BraintreeCaptureRequest. + + :param expiry_year: The expiry_year of this BraintreeCaptureRequest. # noqa: E501 :type: str """ @@ -272,22 +272,20 @@ def expiry_year(self, expiry_year): @property def cvv(self): - """ - Gets the cvv of this BraintreeCaptureRequest. - {\"description\":\"3 or 4 digit card verification value assigned to the credit card being captured.\",\"verbs\":[\"POST\"]} + """Gets the cvv of this BraintreeCaptureRequest. # noqa: E501 + - :return: The cvv of this BraintreeCaptureRequest. + :return: The cvv of this BraintreeCaptureRequest. # noqa: E501 :rtype: str """ return self._cvv @cvv.setter def cvv(self, cvv): - """ - Sets the cvv of this BraintreeCaptureRequest. - {\"description\":\"3 or 4 digit card verification value assigned to the credit card being captured.\",\"verbs\":[\"POST\"]} + """Sets the cvv of this BraintreeCaptureRequest. + - :param cvv: The cvv of this BraintreeCaptureRequest. + :param cvv: The cvv of this BraintreeCaptureRequest. # noqa: E501 :type: str """ @@ -295,22 +293,20 @@ def cvv(self, cvv): @property def device_data(self): - """ - Gets the device_data of this BraintreeCaptureRequest. - {\"description\":\"(Required when vaulting a PayPal payment method; otherwise optional)
A JSON string providing information about the device your customer used to fill out the card capture form. This information is inserted into your form by braintree-data.js — if and only if you use Braintree's drop-in form integrations. You should ideally provide it if you have one (it aids with fraud detection), but it is only mandatory in the case of PayPal payment method vaulting.\",\"verbs\":[\"POST\"]} + """Gets the device_data of this BraintreeCaptureRequest. # noqa: E501 - :return: The device_data of this BraintreeCaptureRequest. + + :return: The device_data of this BraintreeCaptureRequest. # noqa: E501 :rtype: str """ return self._device_data @device_data.setter def device_data(self, device_data): - """ - Sets the device_data of this BraintreeCaptureRequest. - {\"description\":\"(Required when vaulting a PayPal payment method; otherwise optional)
A JSON string providing information about the device your customer used to fill out the card capture form. This information is inserted into your form by braintree-data.js — if and only if you use Braintree's drop-in form integrations. You should ideally provide it if you have one (it aids with fraud detection), but it is only mandatory in the case of PayPal payment method vaulting.\",\"verbs\":[\"POST\"]} + """Sets the device_data of this BraintreeCaptureRequest. + - :param device_data: The device_data of this BraintreeCaptureRequest. + :param device_data: The device_data of this BraintreeCaptureRequest. # noqa: E501 :type: str """ @@ -318,22 +314,20 @@ def device_data(self, device_data): @property def merchant_account_id(self): - """ - Gets the merchant_account_id of this BraintreeCaptureRequest. - {\"description\":\"Braintree Merchant account ID with which you wish for the captured funding instrument to transact. Within your Braintree gateway, you can have multiple merchant accounts to process transactions for different businesses or currencies. If you have a single merchant account, it is not necessary to specify a merchant account ID in your API requests. If you have multiple merchant accounts and choose not to specify the merchant account ID, all requests will process through your default merchant account.\",\"verbs\":[\"POST\"]} + """Gets the merchant_account_id of this BraintreeCaptureRequest. # noqa: E501 + - :return: The merchant_account_id of this BraintreeCaptureRequest. + :return: The merchant_account_id of this BraintreeCaptureRequest. # noqa: E501 :rtype: str """ return self._merchant_account_id @merchant_account_id.setter def merchant_account_id(self, merchant_account_id): - """ - Sets the merchant_account_id of this BraintreeCaptureRequest. - {\"description\":\"Braintree Merchant account ID with which you wish for the captured funding instrument to transact. Within your Braintree gateway, you can have multiple merchant accounts to process transactions for different businesses or currencies. If you have a single merchant account, it is not necessary to specify a merchant account ID in your API requests. If you have multiple merchant accounts and choose not to specify the merchant account ID, all requests will process through your default merchant account.\",\"verbs\":[\"POST\"]} + """Sets the merchant_account_id of this BraintreeCaptureRequest. + - :param merchant_account_id: The merchant_account_id of this BraintreeCaptureRequest. + :param merchant_account_id: The merchant_account_id of this BraintreeCaptureRequest. # noqa: E501 :type: str """ @@ -341,22 +335,20 @@ def merchant_account_id(self, merchant_account_id): @property def ip_address(self): - """ - Gets the ip_address of this BraintreeCaptureRequest. - {\"description\":\"IP address of the customer providing the details of the credit card to be captured.\",\"verbs\":[\"POST\"]} + """Gets the ip_address of this BraintreeCaptureRequest. # noqa: E501 - :return: The ip_address of this BraintreeCaptureRequest. + + :return: The ip_address of this BraintreeCaptureRequest. # noqa: E501 :rtype: str """ return self._ip_address @ip_address.setter def ip_address(self, ip_address): - """ - Sets the ip_address of this BraintreeCaptureRequest. - {\"description\":\"IP address of the customer providing the details of the credit card to be captured.\",\"verbs\":[\"POST\"]} + """Sets the ip_address of this BraintreeCaptureRequest. + - :param ip_address: The ip_address of this BraintreeCaptureRequest. + :param ip_address: The ip_address of this BraintreeCaptureRequest. # noqa: E501 :type: str """ @@ -364,34 +356,30 @@ def ip_address(self, ip_address): @property def ip_address_country(self): - """ - Gets the ip_address_country of this BraintreeCaptureRequest. - {\"description\":\"Country of the IP address of the customer providing the details of the credit card to be captured.\",\"verbs\":[\"POST\"]} + """Gets the ip_address_country of this BraintreeCaptureRequest. # noqa: E501 + - :return: The ip_address_country of this BraintreeCaptureRequest. + :return: The ip_address_country of this BraintreeCaptureRequest. # noqa: E501 :rtype: str """ return self._ip_address_country @ip_address_country.setter def ip_address_country(self, ip_address_country): - """ - Sets the ip_address_country of this BraintreeCaptureRequest. - {\"description\":\"Country of the IP address of the customer providing the details of the credit card to be captured.\",\"verbs\":[\"POST\"]} + """Sets the ip_address_country of this BraintreeCaptureRequest. - :param ip_address_country: The ip_address_country of this BraintreeCaptureRequest. + + :param ip_address_country: The ip_address_country of this BraintreeCaptureRequest. # noqa: E501 :type: str """ self._ip_address_country = ip_address_country def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -408,29 +396,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(BraintreeCaptureRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, BraintreeCaptureRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/braintree_configuration.py b/billforward/models/braintree_configuration.py new file mode 100644 index 0000000..aafd667 --- /dev/null +++ b/billforward/models/braintree_configuration.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class BraintreeConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'merchant_accounts': 'list[BraintreeMerchantAccount]' + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + 'merchant_accounts': 'merchantAccounts' + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, merchant_accounts=None, *args, **kwargs): # noqa: E501 + """BraintreeConfiguration - a model defined in Swagger""" # noqa: E501 + self._merchant_accounts = None + self.discriminator = None + if merchant_accounts is not None: + self.merchant_accounts = merchant_accounts + APIConfiguration.__init__(self, *args, **kwargs) + + @property + def merchant_accounts(self): + """Gets the merchant_accounts of this BraintreeConfiguration. # noqa: E501 + + + :return: The merchant_accounts of this BraintreeConfiguration. # noqa: E501 + :rtype: list[BraintreeMerchantAccount] + """ + return self._merchant_accounts + + @merchant_accounts.setter + def merchant_accounts(self, merchant_accounts): + """Sets the merchant_accounts of this BraintreeConfiguration. + + + :param merchant_accounts: The merchant_accounts of this BraintreeConfiguration. # noqa: E501 + :type: list[BraintreeMerchantAccount] + """ + + self._merchant_accounts = merchant_accounts + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(BraintreeConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, BraintreeConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/braintree_merchant_account.py b/billforward/models/braintree_merchant_account.py new file mode 100644 index 0000000..a015676 --- /dev/null +++ b/billforward/models/braintree_merchant_account.py @@ -0,0 +1,293 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class BraintreeMerchantAccount(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'configuration_id': 'str', + 'organization_id': 'str', + 'currency': 'CreditNoteCurrency', + 'merchant_account_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'configuration_id': 'configurationID', + 'organization_id': 'organizationID', + 'currency': 'currency', + 'merchant_account_id': 'merchantAccountID' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, configuration_id=None, organization_id=None, currency=None, merchant_account_id=None): # noqa: E501 + """BraintreeMerchantAccount - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._configuration_id = None + self._organization_id = None + self._currency = None + self._merchant_account_id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if configuration_id is not None: + self.configuration_id = configuration_id + if organization_id is not None: + self.organization_id = organization_id + if currency is not None: + self.currency = currency + self.merchant_account_id = merchant_account_id + + @property + def created(self): + """Gets the created of this BraintreeMerchantAccount. # noqa: E501 + + + :return: The created of this BraintreeMerchantAccount. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this BraintreeMerchantAccount. + + + :param created: The created of this BraintreeMerchantAccount. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this BraintreeMerchantAccount. # noqa: E501 + + + :return: The changed_by of this BraintreeMerchantAccount. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this BraintreeMerchantAccount. + + + :param changed_by: The changed_by of this BraintreeMerchantAccount. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this BraintreeMerchantAccount. # noqa: E501 + + + :return: The updated of this BraintreeMerchantAccount. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this BraintreeMerchantAccount. + + + :param updated: The updated of this BraintreeMerchantAccount. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this BraintreeMerchantAccount. # noqa: E501 + + + :return: The id of this BraintreeMerchantAccount. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this BraintreeMerchantAccount. + + + :param id: The id of this BraintreeMerchantAccount. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def configuration_id(self): + """Gets the configuration_id of this BraintreeMerchantAccount. # noqa: E501 + + + :return: The configuration_id of this BraintreeMerchantAccount. # noqa: E501 + :rtype: str + """ + return self._configuration_id + + @configuration_id.setter + def configuration_id(self, configuration_id): + """Sets the configuration_id of this BraintreeMerchantAccount. + + + :param configuration_id: The configuration_id of this BraintreeMerchantAccount. # noqa: E501 + :type: str + """ + + self._configuration_id = configuration_id + + @property + def organization_id(self): + """Gets the organization_id of this BraintreeMerchantAccount. # noqa: E501 + + + :return: The organization_id of this BraintreeMerchantAccount. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this BraintreeMerchantAccount. + + + :param organization_id: The organization_id of this BraintreeMerchantAccount. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def currency(self): + """Gets the currency of this BraintreeMerchantAccount. # noqa: E501 + + + :return: The currency of this BraintreeMerchantAccount. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this BraintreeMerchantAccount. + + + :param currency: The currency of this BraintreeMerchantAccount. # noqa: E501 + :type: CreditNoteCurrency + """ + + self._currency = currency + + @property + def merchant_account_id(self): + """Gets the merchant_account_id of this BraintreeMerchantAccount. # noqa: E501 + + + :return: The merchant_account_id of this BraintreeMerchantAccount. # noqa: E501 + :rtype: str + """ + return self._merchant_account_id + + @merchant_account_id.setter + def merchant_account_id(self, merchant_account_id): + """Sets the merchant_account_id of this BraintreeMerchantAccount. + + + :param merchant_account_id: The merchant_account_id of this BraintreeMerchantAccount. # noqa: E501 + :type: str + """ + if merchant_account_id is None: + raise ValueError("Invalid value for `merchant_account_id`, must not be `None`") # noqa: E501 + + self._merchant_account_id = merchant_account_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(BraintreeMerchantAccount, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, BraintreeMerchantAccount): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/braintree_payment.py b/billforward/models/braintree_payment.py new file mode 100644 index 0000000..8c2ae67 --- /dev/null +++ b/billforward/models/braintree_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class BraintreePayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """BraintreePayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(BraintreePayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, BraintreePayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/braintree_pre_auth_request.py b/billforward/models/braintree_pre_auth_request.py new file mode 100644 index 0000000..08ea3fb --- /dev/null +++ b/billforward/models/braintree_pre_auth_request.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.tokenization_pre_auth_request import TokenizationPreAuthRequest # noqa: F401,E501 + +class BraintreePreAuthRequest(TokenizationPreAuthRequest): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'account_id': 'str' + } + if hasattr(TokenizationPreAuthRequest, "swagger_types"): + swagger_types.update(TokenizationPreAuthRequest.swagger_types) + + attribute_map = { + 'account_id': 'accountID' + } + if hasattr(TokenizationPreAuthRequest, "attribute_map"): + attribute_map.update(TokenizationPreAuthRequest.attribute_map) + + def __init__(self, account_id=None, *args, **kwargs): # noqa: E501 + """BraintreePreAuthRequest - a model defined in Swagger""" # noqa: E501 + self._account_id = None + self.discriminator = None + if account_id is not None: + self.account_id = account_id + TokenizationPreAuthRequest.__init__(self, *args, **kwargs) + + @property + def account_id(self): + """Gets the account_id of this BraintreePreAuthRequest. # noqa: E501 + + + :return: The account_id of this BraintreePreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this BraintreePreAuthRequest. + + + :param account_id: The account_id of this BraintreePreAuthRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(BraintreePreAuthRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, BraintreePreAuthRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/braintree_token.py b/billforward/models/braintree_token.py new file mode 100644 index 0000000..a7bb40c --- /dev/null +++ b/billforward/models/braintree_token.py @@ -0,0 +1,401 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class BraintreeToken(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'account_id': 'str', + 'card_details_id': 'str', + 'organization_id': 'str', + 'customer_id': 'str', + 'credit_card_id': 'str', + 'device_data': 'str', + 'merchant_account_id': 'str', + 'deleted': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'account_id': 'accountID', + 'card_details_id': 'cardDetailsID', + 'organization_id': 'organizationID', + 'customer_id': 'customerID', + 'credit_card_id': 'creditCardID', + 'device_data': 'deviceData', + 'merchant_account_id': 'merchantAccountId', + 'deleted': 'deleted' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, card_details_id=None, organization_id=None, customer_id=None, credit_card_id=None, device_data=None, merchant_account_id=None, deleted=None): # noqa: E501 + """BraintreeToken - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._account_id = None + self._card_details_id = None + self._organization_id = None + self._customer_id = None + self._credit_card_id = None + self._device_data = None + self._merchant_account_id = None + self._deleted = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.account_id = account_id + if card_details_id is not None: + self.card_details_id = card_details_id + self.organization_id = organization_id + self.customer_id = customer_id + self.credit_card_id = credit_card_id + if device_data is not None: + self.device_data = device_data + if merchant_account_id is not None: + self.merchant_account_id = merchant_account_id + self.deleted = deleted + + @property + def created(self): + """Gets the created of this BraintreeToken. # noqa: E501 + + + :return: The created of this BraintreeToken. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this BraintreeToken. + + + :param created: The created of this BraintreeToken. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this BraintreeToken. # noqa: E501 + + + :return: The changed_by of this BraintreeToken. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this BraintreeToken. + + + :param changed_by: The changed_by of this BraintreeToken. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this BraintreeToken. # noqa: E501 + + + :return: The updated of this BraintreeToken. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this BraintreeToken. + + + :param updated: The updated of this BraintreeToken. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this BraintreeToken. # noqa: E501 + + + :return: The id of this BraintreeToken. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this BraintreeToken. + + + :param id: The id of this BraintreeToken. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def account_id(self): + """Gets the account_id of this BraintreeToken. # noqa: E501 + + + :return: The account_id of this BraintreeToken. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this BraintreeToken. + + + :param account_id: The account_id of this BraintreeToken. # noqa: E501 + :type: str + """ + if account_id is None: + raise ValueError("Invalid value for `account_id`, must not be `None`") # noqa: E501 + + self._account_id = account_id + + @property + def card_details_id(self): + """Gets the card_details_id of this BraintreeToken. # noqa: E501 + + + :return: The card_details_id of this BraintreeToken. # noqa: E501 + :rtype: str + """ + return self._card_details_id + + @card_details_id.setter + def card_details_id(self, card_details_id): + """Sets the card_details_id of this BraintreeToken. + + + :param card_details_id: The card_details_id of this BraintreeToken. # noqa: E501 + :type: str + """ + + self._card_details_id = card_details_id + + @property + def organization_id(self): + """Gets the organization_id of this BraintreeToken. # noqa: E501 + + + :return: The organization_id of this BraintreeToken. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this BraintreeToken. + + + :param organization_id: The organization_id of this BraintreeToken. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def customer_id(self): + """Gets the customer_id of this BraintreeToken. # noqa: E501 + + + :return: The customer_id of this BraintreeToken. # noqa: E501 + :rtype: str + """ + return self._customer_id + + @customer_id.setter + def customer_id(self, customer_id): + """Sets the customer_id of this BraintreeToken. + + + :param customer_id: The customer_id of this BraintreeToken. # noqa: E501 + :type: str + """ + if customer_id is None: + raise ValueError("Invalid value for `customer_id`, must not be `None`") # noqa: E501 + + self._customer_id = customer_id + + @property + def credit_card_id(self): + """Gets the credit_card_id of this BraintreeToken. # noqa: E501 + + + :return: The credit_card_id of this BraintreeToken. # noqa: E501 + :rtype: str + """ + return self._credit_card_id + + @credit_card_id.setter + def credit_card_id(self, credit_card_id): + """Sets the credit_card_id of this BraintreeToken. + + + :param credit_card_id: The credit_card_id of this BraintreeToken. # noqa: E501 + :type: str + """ + if credit_card_id is None: + raise ValueError("Invalid value for `credit_card_id`, must not be `None`") # noqa: E501 + + self._credit_card_id = credit_card_id + + @property + def device_data(self): + """Gets the device_data of this BraintreeToken. # noqa: E501 + + + :return: The device_data of this BraintreeToken. # noqa: E501 + :rtype: str + """ + return self._device_data + + @device_data.setter + def device_data(self, device_data): + """Sets the device_data of this BraintreeToken. + + + :param device_data: The device_data of this BraintreeToken. # noqa: E501 + :type: str + """ + + self._device_data = device_data + + @property + def merchant_account_id(self): + """Gets the merchant_account_id of this BraintreeToken. # noqa: E501 + + + :return: The merchant_account_id of this BraintreeToken. # noqa: E501 + :rtype: str + """ + return self._merchant_account_id + + @merchant_account_id.setter + def merchant_account_id(self, merchant_account_id): + """Sets the merchant_account_id of this BraintreeToken. + + + :param merchant_account_id: The merchant_account_id of this BraintreeToken. # noqa: E501 + :type: str + """ + + self._merchant_account_id = merchant_account_id + + @property + def deleted(self): + """Gets the deleted of this BraintreeToken. # noqa: E501 + + + :return: The deleted of this BraintreeToken. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this BraintreeToken. + + + :param deleted: The deleted of this BraintreeToken. # noqa: E501 + :type: bool + """ + if deleted is None: + raise ValueError("Invalid value for `deleted`, must not be `None`") # noqa: E501 + + self._deleted = deleted + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(BraintreeToken, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, BraintreeToken): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/braintree_token_paged_metadata.py b/billforward/models/braintree_token_paged_metadata.py deleted file mode 100644 index 0785be9..0000000 --- a/billforward/models/braintree_token_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class BraintreeTokenPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - BraintreeTokenPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this BraintreeTokenPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this BraintreeTokenPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this BraintreeTokenPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this BraintreeTokenPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this BraintreeTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this BraintreeTokenPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this BraintreeTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this BraintreeTokenPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this BraintreeTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this BraintreeTokenPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this BraintreeTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this BraintreeTokenPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this BraintreeTokenPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this BraintreeTokenPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this BraintreeTokenPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this BraintreeTokenPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this BraintreeTokenPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this BraintreeTokenPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this BraintreeTokenPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this BraintreeTokenPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this BraintreeTokenPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this BraintreeTokenPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this BraintreeTokenPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this BraintreeTokenPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this BraintreeTokenPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this BraintreeTokenPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this BraintreeTokenPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this BraintreeTokenPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/calculator_result.py b/billforward/models/calculator_result.py new file mode 100644 index 0000000..fe469d1 --- /dev/null +++ b/billforward/models/calculator_result.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CalculatorResult(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'value': 'float', + 'commission_structure': 'CommissionStructure' + } + + attribute_map = { + 'value': 'value', + 'commission_structure': 'commissionStructure' + } + + def __init__(self, value=None, commission_structure=None): # noqa: E501 + """CalculatorResult - a model defined in Swagger""" # noqa: E501 + self._value = None + self._commission_structure = None + self.discriminator = None + if value is not None: + self.value = value + if commission_structure is not None: + self.commission_structure = commission_structure + + @property + def value(self): + """Gets the value of this CalculatorResult. # noqa: E501 + + + :return: The value of this CalculatorResult. # noqa: E501 + :rtype: float + """ + return self._value + + @value.setter + def value(self, value): + """Sets the value of this CalculatorResult. + + + :param value: The value of this CalculatorResult. # noqa: E501 + :type: float + """ + + self._value = value + + @property + def commission_structure(self): + """Gets the commission_structure of this CalculatorResult. # noqa: E501 + + + :return: The commission_structure of this CalculatorResult. # noqa: E501 + :rtype: CommissionStructure + """ + return self._commission_structure + + @commission_structure.setter + def commission_structure(self, commission_structure): + """Sets the commission_structure of this CalculatorResult. + + + :param commission_structure: The commission_structure of this CalculatorResult. # noqa: E501 + :type: CommissionStructure + """ + + self._commission_structure = commission_structure + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CalculatorResult, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CalculatorResult): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/cancel_subscription_request.py b/billforward/models/cancel_subscription_request.py deleted file mode 100644 index df6a984..0000000 --- a/billforward/models/cancel_subscription_request.py +++ /dev/null @@ -1,292 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CancelSubscriptionRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, subscription_id=None, state=None, source=None, service_end=None, cancellation_credit=None, cancel_children=None, cancel_empty_parent=None): - """ - CancelSubscriptionRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'subscription_id': 'str', - 'state': 'str', - 'source': 'str', - 'service_end': 'str', - 'cancellation_credit': 'str', - 'cancel_children': 'bool', - 'cancel_empty_parent': 'bool' - } - - self.attribute_map = { - 'subscription_id': 'subscriptionID', - 'state': 'state', - 'source': 'source', - 'service_end': 'serviceEnd', - 'cancellation_credit': 'cancellationCredit', - 'cancel_children': 'cancelChildren', - 'cancel_empty_parent': 'cancelEmptyParent' - } - - self._subscription_id = subscription_id - self._state = state - self._source = source - self._service_end = service_end - self._cancellation_credit = cancellation_credit - self._cancel_children = cancel_children - self._cancel_empty_parent = cancel_empty_parent - - @property - def subscription_id(self): - """ - Gets the subscription_id of this CancelSubscriptionRequest. - - - :return: The subscription_id of this CancelSubscriptionRequest. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this CancelSubscriptionRequest. - - - :param subscription_id: The subscription_id of this CancelSubscriptionRequest. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def state(self): - """ - Gets the state of this CancelSubscriptionRequest. - - - :return: The state of this CancelSubscriptionRequest. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this CancelSubscriptionRequest. - - - :param state: The state of this CancelSubscriptionRequest. - :type: str - """ - - self._state = state - - @property - def source(self): - """ - Gets the source of this CancelSubscriptionRequest. - - - :return: The source of this CancelSubscriptionRequest. - :rtype: str - """ - return self._source - - @source.setter - def source(self, source): - """ - Sets the source of this CancelSubscriptionRequest. - - - :param source: The source of this CancelSubscriptionRequest. - :type: str - """ - - self._source = source - - @property - def service_end(self): - """ - Gets the service_end of this CancelSubscriptionRequest. - - - :return: The service_end of this CancelSubscriptionRequest. - :rtype: str - """ - return self._service_end - - @service_end.setter - def service_end(self, service_end): - """ - Sets the service_end of this CancelSubscriptionRequest. - - - :param service_end: The service_end of this CancelSubscriptionRequest. - :type: str - """ - allowed_values = ["Immediate", "AtPeriodEnd"] - if service_end not in allowed_values: - raise ValueError( - "Invalid value for `service_end` ({0}), must be one of {1}" - .format(service_end, allowed_values) - ) - - self._service_end = service_end - - @property - def cancellation_credit(self): - """ - Gets the cancellation_credit of this CancelSubscriptionRequest. - Specifies whether the service will end immediately on cancellation or if it will continue until the end of the current period. Default: AtPeriodEnd - - :return: The cancellation_credit of this CancelSubscriptionRequest. - :rtype: str - """ - return self._cancellation_credit - - @cancellation_credit.setter - def cancellation_credit(self, cancellation_credit): - """ - Sets the cancellation_credit of this CancelSubscriptionRequest. - Specifies whether the service will end immediately on cancellation or if it will continue until the end of the current period. Default: AtPeriodEnd - - :param cancellation_credit: The cancellation_credit of this CancelSubscriptionRequest. - :type: str - """ - allowed_values = ["Credit", "None"] - if cancellation_credit not in allowed_values: - raise ValueError( - "Invalid value for `cancellation_credit` ({0}), must be one of {1}" - .format(cancellation_credit, allowed_values) - ) - - self._cancellation_credit = cancellation_credit - - @property - def cancel_children(self): - """ - Gets the cancel_children of this CancelSubscriptionRequest. - - - :return: The cancel_children of this CancelSubscriptionRequest. - :rtype: bool - """ - return self._cancel_children - - @cancel_children.setter - def cancel_children(self, cancel_children): - """ - Sets the cancel_children of this CancelSubscriptionRequest. - - - :param cancel_children: The cancel_children of this CancelSubscriptionRequest. - :type: bool - """ - - self._cancel_children = cancel_children - - @property - def cancel_empty_parent(self): - """ - Gets the cancel_empty_parent of this CancelSubscriptionRequest. - - - :return: The cancel_empty_parent of this CancelSubscriptionRequest. - :rtype: bool - """ - return self._cancel_empty_parent - - @cancel_empty_parent.setter - def cancel_empty_parent(self, cancel_empty_parent): - """ - Sets the cancel_empty_parent of this CancelSubscriptionRequest. - - - :param cancel_empty_parent: The cancel_empty_parent of this CancelSubscriptionRequest. - :type: bool - """ - - self._cancel_empty_parent = cancel_empty_parent - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/cancellation_amendment.py b/billforward/models/cancellation_amendment.py index 6e69f1f..9eaf792 100644 --- a/billforward/models/cancellation_amendment.py +++ b/billforward/models/cancellation_amendment.py @@ -1,438 +1,109 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class CancellationAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class CancellationAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False, source=None, subscription_cancellation_id=None, service_end=None, cancellation_credit=None, subscription_cancellation=None): - """ - CancellationAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool', - 'source': 'str', - 'subscription_cancellation_id': 'str', - 'service_end': 'str', - 'cancellation_credit': 'str', - 'subscription_cancellation': 'MutableBillingEntity' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted', - 'source': 'source', - 'subscription_cancellation_id': 'subscriptionCancellationID', - 'service_end': 'serviceEnd', - 'cancellation_credit': 'cancellationCredit', - 'subscription_cancellation': 'subscriptionCancellation' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - self._source = source - self._subscription_cancellation_id = subscription_cancellation_id - self._service_end = service_end - self._cancellation_credit = cancellation_credit - self._subscription_cancellation = subscription_cancellation - - @property - def created(self): - """ - Gets the created of this CancellationAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this CancellationAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this CancellationAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this CancellationAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this CancellationAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this CancellationAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this CancellationAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this CancellationAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this CancellationAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this CancellationAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this CancellationAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this CancellationAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this CancellationAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this CancellationAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this CancellationAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this CancellationAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def id(self): - """ - Gets the id of this CancellationAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this CancellationAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this CancellationAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this CancellationAmendment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this CancellationAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this CancellationAmendment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this CancellationAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this CancellationAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this CancellationAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this CancellationAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this CancellationAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this CancellationAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this CancellationAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this CancellationAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this CancellationAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this CancellationAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this CancellationAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this CancellationAmendment. - :rtype: datetime - """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this CancellationAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actioning_time: The actioning_time of this CancellationAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this CancellationAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this CancellationAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this CancellationAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :param actioned_time: The actioned_time of this CancellationAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this CancellationAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this CancellationAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this CancellationAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this CancellationAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this CancellationAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this CancellationAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this CancellationAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this CancellationAmendment. - :type: bool - """ - - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'source': 'str', + 'subscription_cancellation_id': 'str', + 'service_end': 'str', + 'cancellation_credit': 'str', + 'subscription_cancellation': 'SubscriptionCancellation' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'source': 'source', + 'subscription_cancellation_id': 'subscriptionCancellationID', + 'service_end': 'serviceEnd', + 'cancellation_credit': 'cancellationCredit', + 'subscription_cancellation': 'subscriptionCancellation' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, source=None, subscription_cancellation_id=None, service_end=None, cancellation_credit=None, subscription_cancellation=None, *args, **kwargs): # noqa: E501 + """CancellationAmendment - a model defined in Swagger""" # noqa: E501 + self._source = None + self._subscription_cancellation_id = None + self._service_end = None + self._cancellation_credit = None + self._subscription_cancellation = None + self.discriminator = None + self.source = source + if subscription_cancellation_id is not None: + self.subscription_cancellation_id = subscription_cancellation_id + self.service_end = service_end + self.cancellation_credit = cancellation_credit + if subscription_cancellation is not None: + self.subscription_cancellation = subscription_cancellation + Amendment.__init__(self, *args, **kwargs) @property def source(self): - """ - Gets the source of this CancellationAmendment. - { \"description\" : \"Explanation for cancellation\", \"default\" : \"API\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the source of this CancellationAmendment. # noqa: E501 + - :return: The source of this CancellationAmendment. + :return: The source of this CancellationAmendment. # noqa: E501 :rtype: str """ return self._source @source.setter def source(self, source): - """ - Sets the source of this CancellationAmendment. - { \"description\" : \"Explanation for cancellation\", \"default\" : \"API\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the source of this CancellationAmendment. - :param source: The source of this CancellationAmendment. + + :param source: The source of this CancellationAmendment. # noqa: E501 :type: str """ + if source is None: + raise ValueError("Invalid value for `source`, must not be `None`") # noqa: E501 self._source = source @property def subscription_cancellation_id(self): - """ - Gets the subscription_cancellation_id of this CancellationAmendment. - { \"description\" : \"\", \"verbs\":[] } + """Gets the subscription_cancellation_id of this CancellationAmendment. # noqa: E501 + - :return: The subscription_cancellation_id of this CancellationAmendment. + :return: The subscription_cancellation_id of this CancellationAmendment. # noqa: E501 :rtype: str """ return self._subscription_cancellation_id @subscription_cancellation_id.setter def subscription_cancellation_id(self, subscription_cancellation_id): - """ - Sets the subscription_cancellation_id of this CancellationAmendment. - { \"description\" : \"\", \"verbs\":[] } + """Sets the subscription_cancellation_id of this CancellationAmendment. + - :param subscription_cancellation_id: The subscription_cancellation_id of this CancellationAmendment. + :param subscription_cancellation_id: The subscription_cancellation_id of this CancellationAmendment. # noqa: E501 :type: str """ @@ -440,28 +111,28 @@ def subscription_cancellation_id(self, subscription_cancellation_id): @property def service_end(self): - """ - Gets the service_end of this CancellationAmendment. - { \"description\" : \"If the serviceEnd parameter is AtPeriodEnd the cancellation will be delayed till the end of the current period.\", \"default\" : \"AtPeriodEnd\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the service_end of this CancellationAmendment. # noqa: E501 + - :return: The service_end of this CancellationAmendment. + :return: The service_end of this CancellationAmendment. # noqa: E501 :rtype: str """ return self._service_end @service_end.setter def service_end(self, service_end): - """ - Sets the service_end of this CancellationAmendment. - { \"description\" : \"If the serviceEnd parameter is AtPeriodEnd the cancellation will be delayed till the end of the current period.\", \"default\" : \"AtPeriodEnd\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the service_end of this CancellationAmendment. - :param service_end: The service_end of this CancellationAmendment. + + :param service_end: The service_end of this CancellationAmendment. # noqa: E501 :type: str """ - allowed_values = ["Immediate", "AtPeriodEnd"] + if service_end is None: + raise ValueError("Invalid value for `service_end`, must not be `None`") # noqa: E501 + allowed_values = ["Immediate", "AtPeriodEnd"] # noqa: E501 if service_end not in allowed_values: raise ValueError( - "Invalid value for `service_end` ({0}), must be one of {1}" + "Invalid value for `service_end` ({0}), must be one of {1}" # noqa: E501 .format(service_end, allowed_values) ) @@ -469,28 +140,28 @@ def service_end(self, service_end): @property def cancellation_credit(self): - """ - Gets the cancellation_credit of this CancellationAmendment. - Specifies whether the service will end immediately on cancellation or if it will continue until the end of the current period. Default: AtPeriodEnd + """Gets the cancellation_credit of this CancellationAmendment. # noqa: E501 + - :return: The cancellation_credit of this CancellationAmendment. + :return: The cancellation_credit of this CancellationAmendment. # noqa: E501 :rtype: str """ return self._cancellation_credit @cancellation_credit.setter def cancellation_credit(self, cancellation_credit): - """ - Sets the cancellation_credit of this CancellationAmendment. - Specifies whether the service will end immediately on cancellation or if it will continue until the end of the current period. Default: AtPeriodEnd + """Sets the cancellation_credit of this CancellationAmendment. + - :param cancellation_credit: The cancellation_credit of this CancellationAmendment. + :param cancellation_credit: The cancellation_credit of this CancellationAmendment. # noqa: E501 :type: str """ - allowed_values = ["Credit", "None"] + if cancellation_credit is None: + raise ValueError("Invalid value for `cancellation_credit`, must not be `None`") # noqa: E501 + allowed_values = ["Refund", "Credit", "None"] # noqa: E501 if cancellation_credit not in allowed_values: raise ValueError( - "Invalid value for `cancellation_credit` ({0}), must be one of {1}" + "Invalid value for `cancellation_credit` ({0}), must be one of {1}" # noqa: E501 .format(cancellation_credit, allowed_values) ) @@ -498,34 +169,30 @@ def cancellation_credit(self, cancellation_credit): @property def subscription_cancellation(self): - """ - Gets the subscription_cancellation of this CancellationAmendment. - { \"description\" : \"\", \"verbs\":[] } + """Gets the subscription_cancellation of this CancellationAmendment. # noqa: E501 - :return: The subscription_cancellation of this CancellationAmendment. - :rtype: MutableBillingEntity + + :return: The subscription_cancellation of this CancellationAmendment. # noqa: E501 + :rtype: SubscriptionCancellation """ return self._subscription_cancellation @subscription_cancellation.setter def subscription_cancellation(self, subscription_cancellation): - """ - Sets the subscription_cancellation of this CancellationAmendment. - { \"description\" : \"\", \"verbs\":[] } + """Sets the subscription_cancellation of this CancellationAmendment. + - :param subscription_cancellation: The subscription_cancellation of this CancellationAmendment. - :type: MutableBillingEntity + :param subscription_cancellation: The subscription_cancellation of this CancellationAmendment. # noqa: E501 + :type: SubscriptionCancellation """ self._subscription_cancellation = subscription_cancellation def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -542,29 +209,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CancellationAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CancellationAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/card_connect_auth_capture_request.py b/billforward/models/card_connect_auth_capture_request.py new file mode 100644 index 0000000..bb2d0ec --- /dev/null +++ b/billforward/models/card_connect_auth_capture_request.py @@ -0,0 +1,142 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.auth_capture_request import AuthCaptureRequest # noqa: F401,E501 + +class CardConnectAuthCaptureRequest(AuthCaptureRequest): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'tokenized_card_number': 'str', + 'expiry': 'str' + } + if hasattr(AuthCaptureRequest, "swagger_types"): + swagger_types.update(AuthCaptureRequest.swagger_types) + + attribute_map = { + 'tokenized_card_number': 'tokenizedCardNumber', + 'expiry': 'expiry' + } + if hasattr(AuthCaptureRequest, "attribute_map"): + attribute_map.update(AuthCaptureRequest.attribute_map) + + def __init__(self, tokenized_card_number=None, expiry=None, *args, **kwargs): # noqa: E501 + """CardConnectAuthCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._tokenized_card_number = None + self._expiry = None + self.discriminator = None + if tokenized_card_number is not None: + self.tokenized_card_number = tokenized_card_number + if expiry is not None: + self.expiry = expiry + AuthCaptureRequest.__init__(self, *args, **kwargs) + + @property + def tokenized_card_number(self): + """Gets the tokenized_card_number of this CardConnectAuthCaptureRequest. # noqa: E501 + + + :return: The tokenized_card_number of this CardConnectAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._tokenized_card_number + + @tokenized_card_number.setter + def tokenized_card_number(self, tokenized_card_number): + """Sets the tokenized_card_number of this CardConnectAuthCaptureRequest. + + + :param tokenized_card_number: The tokenized_card_number of this CardConnectAuthCaptureRequest. # noqa: E501 + :type: str + """ + + self._tokenized_card_number = tokenized_card_number + + @property + def expiry(self): + """Gets the expiry of this CardConnectAuthCaptureRequest. # noqa: E501 + + + :return: The expiry of this CardConnectAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._expiry + + @expiry.setter + def expiry(self, expiry): + """Sets the expiry of this CardConnectAuthCaptureRequest. + + + :param expiry: The expiry of this CardConnectAuthCaptureRequest. # noqa: E501 + :type: str + """ + + self._expiry = expiry + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CardConnectAuthCaptureRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CardConnectAuthCaptureRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/card_connect_configuration.py b/billforward/models/card_connect_configuration.py new file mode 100644 index 0000000..9849a14 --- /dev/null +++ b/billforward/models/card_connect_configuration.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class CardConnectConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """CardConnectConfiguration - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + APIConfiguration.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CardConnectConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CardConnectConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/card_connect_gateway_request.py b/billforward/models/card_connect_gateway_request.py new file mode 100644 index 0000000..ca469ab --- /dev/null +++ b/billforward/models/card_connect_gateway_request.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CardConnectGatewayRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'username': 'str', + 'password': 'str', + 'site': 'str', + 'mid': 'str' + } + + attribute_map = { + 'username': 'username', + 'password': 'password', + 'site': 'site', + 'mid': 'mid' + } + + def __init__(self, username=None, password=None, site=None, mid=None): # noqa: E501 + """CardConnectGatewayRequest - a model defined in Swagger""" # noqa: E501 + self._username = None + self._password = None + self._site = None + self._mid = None + self.discriminator = None + if username is not None: + self.username = username + if password is not None: + self.password = password + if site is not None: + self.site = site + if mid is not None: + self.mid = mid + + @property + def username(self): + """Gets the username of this CardConnectGatewayRequest. # noqa: E501 + + + :return: The username of this CardConnectGatewayRequest. # noqa: E501 + :rtype: str + """ + return self._username + + @username.setter + def username(self, username): + """Sets the username of this CardConnectGatewayRequest. + + + :param username: The username of this CardConnectGatewayRequest. # noqa: E501 + :type: str + """ + + self._username = username + + @property + def password(self): + """Gets the password of this CardConnectGatewayRequest. # noqa: E501 + + + :return: The password of this CardConnectGatewayRequest. # noqa: E501 + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """Sets the password of this CardConnectGatewayRequest. + + + :param password: The password of this CardConnectGatewayRequest. # noqa: E501 + :type: str + """ + + self._password = password + + @property + def site(self): + """Gets the site of this CardConnectGatewayRequest. # noqa: E501 + + + :return: The site of this CardConnectGatewayRequest. # noqa: E501 + :rtype: str + """ + return self._site + + @site.setter + def site(self, site): + """Sets the site of this CardConnectGatewayRequest. + + + :param site: The site of this CardConnectGatewayRequest. # noqa: E501 + :type: str + """ + + self._site = site + + @property + def mid(self): + """Gets the mid of this CardConnectGatewayRequest. # noqa: E501 + + + :return: The mid of this CardConnectGatewayRequest. # noqa: E501 + :rtype: str + """ + return self._mid + + @mid.setter + def mid(self, mid): + """Sets the mid of this CardConnectGatewayRequest. + + + :param mid: The mid of this CardConnectGatewayRequest. # noqa: E501 + :type: str + """ + + self._mid = mid + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CardConnectGatewayRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CardConnectGatewayRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/card_connect_payment.py b/billforward/models/card_connect_payment.py new file mode 100644 index 0000000..443ab99 --- /dev/null +++ b/billforward/models/card_connect_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class CardConnectPayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """CardConnectPayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CardConnectPayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CardConnectPayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/cass_churn_result_paged_metadata.py b/billforward/models/cass_churn_result_paged_metadata.py deleted file mode 100644 index 9d06676..0000000 --- a/billforward/models/cass_churn_result_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CassChurnResultPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - CassChurnResultPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this CassChurnResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this CassChurnResultPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this CassChurnResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this CassChurnResultPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this CassChurnResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this CassChurnResultPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this CassChurnResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this CassChurnResultPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this CassChurnResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this CassChurnResultPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this CassChurnResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this CassChurnResultPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this CassChurnResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this CassChurnResultPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this CassChurnResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this CassChurnResultPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this CassChurnResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this CassChurnResultPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this CassChurnResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this CassChurnResultPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this CassChurnResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this CassChurnResultPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this CassChurnResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this CassChurnResultPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this CassChurnResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this CassChurnResultPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this CassChurnResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this CassChurnResultPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/cass_payment_result_paged_metadata.py b/billforward/models/cass_payment_result_paged_metadata.py deleted file mode 100644 index 8743a0e..0000000 --- a/billforward/models/cass_payment_result_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CassPaymentResultPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - CassPaymentResultPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this CassPaymentResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this CassPaymentResultPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this CassPaymentResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this CassPaymentResultPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this CassPaymentResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this CassPaymentResultPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this CassPaymentResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this CassPaymentResultPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this CassPaymentResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this CassPaymentResultPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this CassPaymentResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this CassPaymentResultPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this CassPaymentResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this CassPaymentResultPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this CassPaymentResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this CassPaymentResultPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this CassPaymentResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this CassPaymentResultPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this CassPaymentResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this CassPaymentResultPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this CassPaymentResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this CassPaymentResultPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this CassPaymentResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this CassPaymentResultPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this CassPaymentResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this CassPaymentResultPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this CassPaymentResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this CassPaymentResultPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/cass_upgrade_result_paged_metadata.py b/billforward/models/cass_upgrade_result_paged_metadata.py deleted file mode 100644 index ada8153..0000000 --- a/billforward/models/cass_upgrade_result_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CassUpgradeResultPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - CassUpgradeResultPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this CassUpgradeResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this CassUpgradeResultPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this CassUpgradeResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this CassUpgradeResultPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this CassUpgradeResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this CassUpgradeResultPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this CassUpgradeResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this CassUpgradeResultPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this CassUpgradeResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this CassUpgradeResultPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this CassUpgradeResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this CassUpgradeResultPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this CassUpgradeResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this CassUpgradeResultPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this CassUpgradeResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this CassUpgradeResultPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this CassUpgradeResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this CassUpgradeResultPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this CassUpgradeResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this CassUpgradeResultPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this CassUpgradeResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this CassUpgradeResultPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this CassUpgradeResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this CassUpgradeResultPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this CassUpgradeResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this CassUpgradeResultPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this CassUpgradeResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this CassUpgradeResultPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/client.py b/billforward/models/client.py deleted file mode 100644 index b6d860a..0000000 --- a/billforward/models/client.py +++ /dev/null @@ -1,462 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class Client(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, client_id=None, client_secret=None, organization_id=None, scope=None, resource_ids=None, authorized_grant_types=None, registered_redirect_uris=None, authorities=None, access_token_validity_seconds=None, refresh_token_validity_seconds=None, deleted=False): - """ - Client - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'client_id': 'str', - 'client_secret': 'str', - 'organization_id': 'str', - 'scope': 'str', - 'resource_ids': 'str', - 'authorized_grant_types': 'str', - 'registered_redirect_uris': 'str', - 'authorities': 'str', - 'access_token_validity_seconds': 'int', - 'refresh_token_validity_seconds': 'int', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'client_id': 'clientId', - 'client_secret': 'clientSecret', - 'organization_id': 'organizationID', - 'scope': 'scope', - 'resource_ids': 'resourceIds', - 'authorized_grant_types': 'authorizedGrantTypes', - 'registered_redirect_uris': 'registeredRedirectUris', - 'authorities': 'authorities', - 'access_token_validity_seconds': 'accessTokenValiditySeconds', - 'refresh_token_validity_seconds': 'refreshTokenValiditySeconds', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._client_id = client_id - self._client_secret = client_secret - self._organization_id = organization_id - self._scope = scope - self._resource_ids = resource_ids - self._authorized_grant_types = authorized_grant_types - self._registered_redirect_uris = registered_redirect_uris - self._authorities = authorities - self._access_token_validity_seconds = access_token_validity_seconds - self._refresh_token_validity_seconds = refresh_token_validity_seconds - self._deleted = deleted - - @property - def created(self): - """ - Gets the created of this Client. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this Client. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this Client. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this Client. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this Client. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this Client. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this Client. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this Client. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this Client. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this Client. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this Client. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this Client. - :type: datetime - """ - - self._updated = updated - - @property - def client_id(self): - """ - Gets the client_id of this Client. - { \"description\" : \"ID of the OAuth2 client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The client_id of this Client. - :rtype: str - """ - return self._client_id - - @client_id.setter - def client_id(self, client_id): - """ - Sets the client_id of this Client. - { \"description\" : \"ID of the OAuth2 client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param client_id: The client_id of this Client. - :type: str - """ - - self._client_id = client_id - - @property - def client_secret(self): - """ - Gets the client_secret of this Client. - { \"description\" : \"Unique Client Secret of the client. This is used as the OAuth2 Client secret\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The client_secret of this Client. - :rtype: str - """ - return self._client_secret - - @client_secret.setter - def client_secret(self, client_secret): - """ - Sets the client_secret of this Client. - { \"description\" : \"Unique Client Secret of the client. This is used as the OAuth2 Client secret\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param client_secret: The client_secret of this Client. - :type: str - """ - - self._client_secret = client_secret - - @property - def organization_id(self): - """ - Gets the organization_id of this Client. - { \"description\" : \"Organization associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this Client. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this Client. - { \"description\" : \"Organization associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this Client. - :type: str - """ - - self._organization_id = organization_id - - @property - def scope(self): - """ - Gets the scope of this Client. - { \"description\" : \"Scopes associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The scope of this Client. - :rtype: str - """ - return self._scope - - @scope.setter - def scope(self, scope): - """ - Sets the scope of this Client. - { \"description\" : \"Scopes associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param scope: The scope of this Client. - :type: str - """ - - self._scope = scope - - @property - def resource_ids(self): - """ - Gets the resource_ids of this Client. - { \"description\" : \"Resources associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The resource_ids of this Client. - :rtype: str - """ - return self._resource_ids - - @resource_ids.setter - def resource_ids(self, resource_ids): - """ - Sets the resource_ids of this Client. - { \"description\" : \"Resources associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param resource_ids: The resource_ids of this Client. - :type: str - """ - - self._resource_ids = resource_ids - - @property - def authorized_grant_types(self): - """ - Gets the authorized_grant_types of this Client. - { \"description\" : \"Oauth2 Grant Types which may be used when authenticating with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The authorized_grant_types of this Client. - :rtype: str - """ - return self._authorized_grant_types - - @authorized_grant_types.setter - def authorized_grant_types(self, authorized_grant_types): - """ - Sets the authorized_grant_types of this Client. - { \"description\" : \"Oauth2 Grant Types which may be used when authenticating with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param authorized_grant_types: The authorized_grant_types of this Client. - :type: str - """ - - self._authorized_grant_types = authorized_grant_types - - @property - def registered_redirect_uris(self): - """ - Gets the registered_redirect_uris of this Client. - { \"description\" : \"Registered Redirect URIs associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The registered_redirect_uris of this Client. - :rtype: str - """ - return self._registered_redirect_uris - - @registered_redirect_uris.setter - def registered_redirect_uris(self, registered_redirect_uris): - """ - Sets the registered_redirect_uris of this Client. - { \"description\" : \"Registered Redirect URIs associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param registered_redirect_uris: The registered_redirect_uris of this Client. - :type: str - """ - - self._registered_redirect_uris = registered_redirect_uris - - @property - def authorities(self): - """ - Gets the authorities of this Client. - { \"description\" : \"Authorities associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The authorities of this Client. - :rtype: str - """ - return self._authorities - - @authorities.setter - def authorities(self, authorities): - """ - Sets the authorities of this Client. - { \"description\" : \"Authorities associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param authorities: The authorities of this Client. - :type: str - """ - - self._authorities = authorities - - @property - def access_token_validity_seconds(self): - """ - Gets the access_token_validity_seconds of this Client. - { \"description\" : \"The amount of time in seconds that an access token for the client is valid.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The access_token_validity_seconds of this Client. - :rtype: int - """ - return self._access_token_validity_seconds - - @access_token_validity_seconds.setter - def access_token_validity_seconds(self, access_token_validity_seconds): - """ - Sets the access_token_validity_seconds of this Client. - { \"description\" : \"The amount of time in seconds that an access token for the client is valid.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param access_token_validity_seconds: The access_token_validity_seconds of this Client. - :type: int - """ - - self._access_token_validity_seconds = access_token_validity_seconds - - @property - def refresh_token_validity_seconds(self): - """ - Gets the refresh_token_validity_seconds of this Client. - { \"description\" : \"The amount of time in seconds that a refresh token for the client is valid.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The refresh_token_validity_seconds of this Client. - :rtype: int - """ - return self._refresh_token_validity_seconds - - @refresh_token_validity_seconds.setter - def refresh_token_validity_seconds(self, refresh_token_validity_seconds): - """ - Sets the refresh_token_validity_seconds of this Client. - { \"description\" : \"The amount of time in seconds that a refresh token for the client is valid.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param refresh_token_validity_seconds: The refresh_token_validity_seconds of this Client. - :type: int - """ - - self._refresh_token_validity_seconds = refresh_token_validity_seconds - - @property - def deleted(self): - """ - Gets the deleted of this Client. - { \"description\" : \"Indicates if a client has been retired. If a client has been retired it can still be retrieved using the appropriate flag on API requests.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The deleted of this Client. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this Client. - { \"description\" : \"Indicates if a client has been retired. If a client has been retired it can still be retrieved using the appropriate flag on API requests.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param deleted: The deleted of this Client. - :type: bool - """ - - self._deleted = deleted - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/client_paged_metadata.py b/billforward/models/client_paged_metadata.py deleted file mode 100644 index 9efb590..0000000 --- a/billforward/models/client_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class ClientPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - ClientPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Client]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this ClientPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this ClientPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this ClientPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this ClientPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this ClientPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this ClientPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this ClientPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this ClientPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this ClientPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this ClientPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this ClientPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this ClientPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this ClientPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this ClientPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this ClientPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this ClientPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this ClientPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this ClientPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this ClientPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this ClientPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this ClientPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this ClientPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this ClientPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this ClientPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this ClientPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this ClientPagedMetadata. - :rtype: list[Client] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this ClientPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this ClientPagedMetadata. - :type: list[Client] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/commission_structure.py b/billforward/models/commission_structure.py new file mode 100644 index 0000000..e549dba --- /dev/null +++ b/billforward/models/commission_structure.py @@ -0,0 +1,324 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CommissionStructure(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'description': 'str', + 'type': 'str', + 'amount': 'float', + 'pricing_component_name': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'description': 'description', + 'type': 'type', + 'amount': 'amount', + 'pricing_component_name': 'pricingComponentName' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, description=None, type=None, amount=None, pricing_component_name=None): # noqa: E501 + """CommissionStructure - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._description = None + self._type = None + self._amount = None + self._pricing_component_name = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if description is not None: + self.description = description + if type is not None: + self.type = type + if amount is not None: + self.amount = amount + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + + @property + def created(self): + """Gets the created of this CommissionStructure. # noqa: E501 + + + :return: The created of this CommissionStructure. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this CommissionStructure. + + + :param created: The created of this CommissionStructure. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this CommissionStructure. # noqa: E501 + + + :return: The changed_by of this CommissionStructure. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this CommissionStructure. + + + :param changed_by: The changed_by of this CommissionStructure. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this CommissionStructure. # noqa: E501 + + + :return: The updated of this CommissionStructure. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this CommissionStructure. + + + :param updated: The updated of this CommissionStructure. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this CommissionStructure. # noqa: E501 + + + :return: The id of this CommissionStructure. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this CommissionStructure. + + + :param id: The id of this CommissionStructure. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this CommissionStructure. # noqa: E501 + + + :return: The organization_id of this CommissionStructure. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CommissionStructure. + + + :param organization_id: The organization_id of this CommissionStructure. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def description(self): + """Gets the description of this CommissionStructure. # noqa: E501 + + + :return: The description of this CommissionStructure. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this CommissionStructure. + + + :param description: The description of this CommissionStructure. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def type(self): + """Gets the type of this CommissionStructure. # noqa: E501 + + + :return: The type of this CommissionStructure. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this CommissionStructure. + + + :param type: The type of this CommissionStructure. # noqa: E501 + :type: str + """ + allowed_values = ["Percentage", "FixedAmount"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def amount(self): + """Gets the amount of this CommissionStructure. # noqa: E501 + + + :return: The amount of this CommissionStructure. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this CommissionStructure. + + + :param amount: The amount of this CommissionStructure. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this CommissionStructure. # noqa: E501 + + + :return: The pricing_component_name of this CommissionStructure. # noqa: E501 + :rtype: str + """ + return self._pricing_component_name + + @pricing_component_name.setter + def pricing_component_name(self, pricing_component_name): + """Sets the pricing_component_name of this CommissionStructure. + + + :param pricing_component_name: The pricing_component_name of this CommissionStructure. # noqa: E501 + :type: str + """ + + self._pricing_component_name = pricing_component_name + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CommissionStructure, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CommissionStructure): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/component_change.py b/billforward/models/component_change.py index 2531f81..91e5ad6 100644 --- a/billforward/models/component_change.py +++ b/billforward/models/component_change.py @@ -1,178 +1,247 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class ComponentChange(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, id=None, organization_id=None, amendment_id=None, update_pricing_component_value_id=None, pricing_component_id=None, pricing_component_name=None, state=None, change_mode=None, new_value=None, created=None, changed_by=None, updated=None, value_effective=None): + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'amendment_id': 'str', + 'update_pricing_component_value_id': 'str', + 'pricing_component_id': 'str', + 'pricing_component_name': 'str', + 'state': 'str', + 'change_mode': 'str', + 'value_effective': 'datetime', + 'new_value': 'int' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'amendment_id': 'amendmentID', + 'update_pricing_component_value_id': 'updatePricingComponentValueID', + 'pricing_component_id': 'pricingComponentID', + 'pricing_component_name': 'pricingComponentName', + 'state': 'state', + 'change_mode': 'changeMode', + 'value_effective': 'valueEffective', + 'new_value': 'newValue' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, amendment_id=None, update_pricing_component_value_id=None, pricing_component_id=None, pricing_component_name=None, state=None, change_mode=None, value_effective=None, new_value=None): # noqa: E501 + """ComponentChange - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._amendment_id = None + self._update_pricing_component_value_id = None + self._pricing_component_id = None + self._pricing_component_name = None + self._state = None + self._change_mode = None + self._value_effective = None + self._new_value = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + self.id = id + self.organization_id = organization_id + self.amendment_id = amendment_id + if update_pricing_component_value_id is not None: + self.update_pricing_component_value_id = update_pricing_component_value_id + self.pricing_component_id = pricing_component_id + self.pricing_component_name = pricing_component_name + self.state = state + self.change_mode = change_mode + if value_effective is not None: + self.value_effective = value_effective + self.new_value = new_value + + @property + def created(self): + """Gets the created of this ComponentChange. # noqa: E501 + + + :return: The created of this ComponentChange. # noqa: E501 + :rtype: datetime """ - ComponentChange - a model defined in Swagger + return self._created + + @created.setter + def created(self, created): + """Sets the created of this ComponentChange. + - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. + :param created: The created of this ComponentChange. # noqa: E501 + :type: datetime """ - self.swagger_types = { - 'id': 'str', - 'organization_id': 'str', - 'amendment_id': 'str', - 'update_pricing_component_value_id': 'str', - 'pricing_component_id': 'str', - 'pricing_component_name': 'str', - 'state': 'str', - 'change_mode': 'str', - 'new_value': 'int', - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'value_effective': 'datetime' - } - - self.attribute_map = { - 'id': 'id', - 'organization_id': 'organizationID', - 'amendment_id': 'amendmentID', - 'update_pricing_component_value_id': 'updatePricingComponentValueID', - 'pricing_component_id': 'pricingComponentID', - 'pricing_component_name': 'pricingComponentName', - 'state': 'state', - 'change_mode': 'changeMode', - 'new_value': 'newValue', - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'value_effective': 'valueEffective' - } - self._id = id - self._organization_id = organization_id - self._amendment_id = amendment_id - self._update_pricing_component_value_id = update_pricing_component_value_id - self._pricing_component_id = pricing_component_id - self._pricing_component_name = pricing_component_name - self._state = state - self._change_mode = change_mode - self._new_value = new_value self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this ComponentChange. # noqa: E501 + + + :return: The changed_by of this ComponentChange. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this ComponentChange. + + + :param changed_by: The changed_by of this ComponentChange. # noqa: E501 + :type: str + """ + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this ComponentChange. # noqa: E501 + + + :return: The updated of this ComponentChange. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this ComponentChange. + + + :param updated: The updated of this ComponentChange. # noqa: E501 + :type: datetime + """ + self._updated = updated - self._value_effective = value_effective @property def id(self): - """ - Gets the id of this ComponentChange. - id + """Gets the id of this ComponentChange. # noqa: E501 + - :return: The id of this ComponentChange. + :return: The id of this ComponentChange. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this ComponentChange. - id + """Sets the id of this ComponentChange. - :param id: The id of this ComponentChange. + + :param id: The id of this ComponentChange. # noqa: E501 :type: str """ + if id is None: + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 self._id = id @property def organization_id(self): - """ - Gets the organization_id of this ComponentChange. - { \"description\" : \"\", \"verbs\":[] } + """Gets the organization_id of this ComponentChange. # noqa: E501 + - :return: The organization_id of this ComponentChange. + :return: The organization_id of this ComponentChange. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this ComponentChange. - { \"description\" : \"\", \"verbs\":[] } + """Sets the organization_id of this ComponentChange. + - :param organization_id: The organization_id of this ComponentChange. + :param organization_id: The organization_id of this ComponentChange. # noqa: E501 :type: str """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 self._organization_id = organization_id @property def amendment_id(self): - """ - Gets the amendment_id of this ComponentChange. - { \"description\" : \"\", \"verbs\":[] } + """Gets the amendment_id of this ComponentChange. # noqa: E501 + - :return: The amendment_id of this ComponentChange. + :return: The amendment_id of this ComponentChange. # noqa: E501 :rtype: str """ return self._amendment_id @amendment_id.setter def amendment_id(self, amendment_id): - """ - Sets the amendment_id of this ComponentChange. - { \"description\" : \"\", \"verbs\":[] } + """Sets the amendment_id of this ComponentChange. - :param amendment_id: The amendment_id of this ComponentChange. + + :param amendment_id: The amendment_id of this ComponentChange. # noqa: E501 :type: str """ + if amendment_id is None: + raise ValueError("Invalid value for `amendment_id`, must not be `None`") # noqa: E501 self._amendment_id = amendment_id @property def update_pricing_component_value_id(self): - """ - Gets the update_pricing_component_value_id of this ComponentChange. - { \"description\" : \"ID of the updateComponentValueAmendment object that is responsible for actioning the change.\", \"verbs\":[\"GET\"] } + """Gets the update_pricing_component_value_id of this ComponentChange. # noqa: E501 + - :return: The update_pricing_component_value_id of this ComponentChange. + :return: The update_pricing_component_value_id of this ComponentChange. # noqa: E501 :rtype: str """ return self._update_pricing_component_value_id @update_pricing_component_value_id.setter def update_pricing_component_value_id(self, update_pricing_component_value_id): - """ - Sets the update_pricing_component_value_id of this ComponentChange. - { \"description\" : \"ID of the updateComponentValueAmendment object that is responsible for actioning the change.\", \"verbs\":[\"GET\"] } + """Sets the update_pricing_component_value_id of this ComponentChange. + - :param update_pricing_component_value_id: The update_pricing_component_value_id of this ComponentChange. + :param update_pricing_component_value_id: The update_pricing_component_value_id of this ComponentChange. # noqa: E501 :type: str """ @@ -180,74 +249,74 @@ def update_pricing_component_value_id(self, update_pricing_component_value_id): @property def pricing_component_id(self): - """ - Gets the pricing_component_id of this ComponentChange. - { \"description\" : \"ID of the pricing component, that will not change with versioning. (Must be provided if pricingComponentName is empty)\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the pricing_component_id of this ComponentChange. # noqa: E501 - :return: The pricing_component_id of this ComponentChange. + + :return: The pricing_component_id of this ComponentChange. # noqa: E501 :rtype: str """ return self._pricing_component_id @pricing_component_id.setter def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this ComponentChange. - { \"description\" : \"ID of the pricing component, that will not change with versioning. (Must be provided if pricingComponentName is empty)\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the pricing_component_id of this ComponentChange. - :param pricing_component_id: The pricing_component_id of this ComponentChange. + + :param pricing_component_id: The pricing_component_id of this ComponentChange. # noqa: E501 :type: str """ + if pricing_component_id is None: + raise ValueError("Invalid value for `pricing_component_id`, must not be `None`") # noqa: E501 self._pricing_component_id = pricing_component_id @property def pricing_component_name(self): - """ - Gets the pricing_component_name of this ComponentChange. - { \"description\" : \"Name of the pricing component. (Must be provided if pricingComponentID is empty)\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the pricing_component_name of this ComponentChange. # noqa: E501 + - :return: The pricing_component_name of this ComponentChange. + :return: The pricing_component_name of this ComponentChange. # noqa: E501 :rtype: str """ return self._pricing_component_name @pricing_component_name.setter def pricing_component_name(self, pricing_component_name): - """ - Sets the pricing_component_name of this ComponentChange. - { \"description\" : \"Name of the pricing component. (Must be provided if pricingComponentID is empty)\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the pricing_component_name of this ComponentChange. + - :param pricing_component_name: The pricing_component_name of this ComponentChange. + :param pricing_component_name: The pricing_component_name of this ComponentChange. # noqa: E501 :type: str """ + if pricing_component_name is None: + raise ValueError("Invalid value for `pricing_component_name`, must not be `None`") # noqa: E501 self._pricing_component_name = pricing_component_name @property def state(self): - """ - Gets the state of this ComponentChange. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the state of this ComponentChange. # noqa: E501 - :return: The state of this ComponentChange. + + :return: The state of this ComponentChange. # noqa: E501 :rtype: str """ return self._state @state.setter def state(self, state): - """ - Sets the state of this ComponentChange. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the state of this ComponentChange. + - :param state: The state of this ComponentChange. + :param state: The state of this ComponentChange. # noqa: E501 :type: str """ - allowed_values = ["Failed", "Pending", "Succeeded"] + if state is None: + raise ValueError("Invalid value for `state`, must not be `None`") # noqa: E501 + allowed_values = ["Failed", "Pending", "Succeeded"] # noqa: E501 if state not in allowed_values: raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 .format(state, allowed_values) ) @@ -255,155 +324,82 @@ def state(self, state): @property def change_mode(self): - """ - Gets the change_mode of this ComponentChange. - { \"description\" : \"immediate applies the changes to the subscription straight away. delayed applies the changes to the subscription at the start of the next billing period\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the change_mode of this ComponentChange. # noqa: E501 + - :return: The change_mode of this ComponentChange. + :return: The change_mode of this ComponentChange. # noqa: E501 :rtype: str """ return self._change_mode @change_mode.setter def change_mode(self, change_mode): - """ - Sets the change_mode of this ComponentChange. - { \"description\" : \"immediate applies the changes to the subscription straight away. delayed applies the changes to the subscription at the start of the next billing period\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the change_mode of this ComponentChange. + - :param change_mode: The change_mode of this ComponentChange. + :param change_mode: The change_mode of this ComponentChange. # noqa: E501 :type: str """ - allowed_values = ["immediate", "delayed"] + if change_mode is None: + raise ValueError("Invalid value for `change_mode`, must not be `None`") # noqa: E501 + allowed_values = ["immediate", "delayed"] # noqa: E501 if change_mode not in allowed_values: raise ValueError( - "Invalid value for `change_mode` ({0}), must be one of {1}" + "Invalid value for `change_mode` ({0}), must be one of {1}" # noqa: E501 .format(change_mode, allowed_values) ) self._change_mode = change_mode @property - def new_value(self): - """ - Gets the new_value of this ComponentChange. - { \"description\" : \"Value of the pricing component that the subscription is moving to\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The new_value of this ComponentChange. - :rtype: int - """ - return self._new_value - - @new_value.setter - def new_value(self, new_value): - """ - Sets the new_value of this ComponentChange. - { \"description\" : \"Value of the pricing component that the subscription is moving to\", \"verbs\":[\"POST\",\"GET\"] } - - :param new_value: The new_value of this ComponentChange. - :type: int - """ + def value_effective(self): + """Gets the value_effective of this ComponentChange. # noqa: E501 - self._new_value = new_value - @property - def created(self): - """ - Gets the created of this ComponentChange. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this ComponentChange. + :return: The value_effective of this ComponentChange. # noqa: E501 :rtype: datetime """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this ComponentChange. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this ComponentChange. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this ComponentChange. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + return self._value_effective - :return: The changed_by of this ComponentChange. - :rtype: str - """ - return self._changed_by + @value_effective.setter + def value_effective(self, value_effective): + """Sets the value_effective of this ComponentChange. - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this ComponentChange. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - :param changed_by: The changed_by of this ComponentChange. - :type: str + :param value_effective: The value_effective of this ComponentChange. # noqa: E501 + :type: datetime """ - self._changed_by = changed_by + self._value_effective = value_effective @property - def updated(self): - """ - Gets the updated of this ComponentChange. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this ComponentChange. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this ComponentChange. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this ComponentChange. - :type: datetime - """ + def new_value(self): + """Gets the new_value of this ComponentChange. # noqa: E501 - self._updated = updated - @property - def value_effective(self): + :return: The new_value of this ComponentChange. # noqa: E501 + :rtype: int """ - Gets the value_effective of this ComponentChange. - { \"description\" : \"Date when the value becomes active. For example when an upgrade will come into effect.\", \"verbs\":[\"GET\"] } + return self._new_value - :return: The value_effective of this ComponentChange. - :rtype: datetime - """ - return self._value_effective + @new_value.setter + def new_value(self, new_value): + """Sets the new_value of this ComponentChange. - @value_effective.setter - def value_effective(self, value_effective): - """ - Sets the value_effective of this ComponentChange. - { \"description\" : \"Date when the value becomes active. For example when an upgrade will come into effect.\", \"verbs\":[\"GET\"] } - :param value_effective: The value_effective of this ComponentChange. - :type: datetime + :param new_value: The new_value of this ComponentChange. # noqa: E501 + :type: int """ + if new_value is None: + raise ValueError("Invalid value for `new_value`, must not be `None`") # noqa: E501 - self._value_effective = value_effective + self._new_value = new_value def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -420,29 +416,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(ComponentChange, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, ComponentChange): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/component_cost.py b/billforward/models/component_cost.py deleted file mode 100644 index 660f8d3..0000000 --- a/billforward/models/component_cost.py +++ /dev/null @@ -1,150 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class ComponentCost(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, cost=None, name=None): - """ - ComponentCost - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'cost': 'float', - 'name': 'str' - } - - self.attribute_map = { - 'cost': 'cost', - 'name': 'name' - } - - self._cost = cost - self._name = name - - @property - def cost(self): - """ - Gets the cost of this ComponentCost. - - - :return: The cost of this ComponentCost. - :rtype: float - """ - return self._cost - - @cost.setter - def cost(self, cost): - """ - Sets the cost of this ComponentCost. - - - :param cost: The cost of this ComponentCost. - :type: float - """ - - self._cost = cost - - @property - def name(self): - """ - Gets the name of this ComponentCost. - - - :return: The name of this ComponentCost. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this ComponentCost. - - - :param name: The name of this ComponentCost. - :type: str - """ - - self._name = name - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/compound_usage.py b/billforward/models/compound_usage.py deleted file mode 100644 index e0bf9a2..0000000 --- a/billforward/models/compound_usage.py +++ /dev/null @@ -1,202 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CompoundUsage(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, usages=None, organization_id=None): - """ - CompoundUsage - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'usages': 'list[Usage]', - 'organization_id': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'usages': 'usages', - 'organization_id': 'organizationID' - } - - self._created = created - self._changed_by = changed_by - self._usages = usages - self._organization_id = organization_id - - @property - def created(self): - """ - Gets the created of this CompoundUsage. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this CompoundUsage. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this CompoundUsage. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this CompoundUsage. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this CompoundUsage. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this CompoundUsage. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this CompoundUsage. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this CompoundUsage. - :type: str - """ - - self._changed_by = changed_by - - @property - def usages(self): - """ - Gets the usages of this CompoundUsage. - { \"description\" : \"Array of Usage objects that you wish to operate on.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The usages of this CompoundUsage. - :rtype: list[Usage] - """ - return self._usages - - @usages.setter - def usages(self, usages): - """ - Sets the usages of this CompoundUsage. - { \"description\" : \"Array of Usage objects that you wish to operate on.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param usages: The usages of this CompoundUsage. - :type: list[Usage] - """ - - self._usages = usages - - @property - def organization_id(self): - """ - Gets the organization_id of this CompoundUsage. - { \"description\" : \"ID of the organization to which these usage instances belong.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this CompoundUsage. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this CompoundUsage. - { \"description\" : \"ID of the organization to which these usage instances belong.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this CompoundUsage. - :type: str - """ - - self._organization_id = organization_id - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/compound_usage_session.py b/billforward/models/compound_usage_session.py deleted file mode 100644 index 2250edb..0000000 --- a/billforward/models/compound_usage_session.py +++ /dev/null @@ -1,202 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CompoundUsageSession(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, usage_sessions=None, organization_id=None): - """ - CompoundUsageSession - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'usage_sessions': 'list[UsageSession]', - 'organization_id': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'usage_sessions': 'usageSessions', - 'organization_id': 'organizationID' - } - - self._created = created - self._changed_by = changed_by - self._usage_sessions = usage_sessions - self._organization_id = organization_id - - @property - def created(self): - """ - Gets the created of this CompoundUsageSession. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this CompoundUsageSession. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this CompoundUsageSession. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this CompoundUsageSession. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this CompoundUsageSession. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this CompoundUsageSession. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this CompoundUsageSession. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this CompoundUsageSession. - :type: str - """ - - self._changed_by = changed_by - - @property - def usage_sessions(self): - """ - Gets the usage_sessions of this CompoundUsageSession. - { \"description\" : \"Array of Usage Sessions that you wish to operate on.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The usage_sessions of this CompoundUsageSession. - :rtype: list[UsageSession] - """ - return self._usage_sessions - - @usage_sessions.setter - def usage_sessions(self, usage_sessions): - """ - Sets the usage_sessions of this CompoundUsageSession. - { \"description\" : \"Array of Usage Sessions that you wish to operate on.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param usage_sessions: The usage_sessions of this CompoundUsageSession. - :type: list[UsageSession] - """ - - self._usage_sessions = usage_sessions - - @property - def organization_id(self): - """ - Gets the organization_id of this CompoundUsageSession. - { \"description\" : \"ID of the organization to which these usage sessions belong.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this CompoundUsageSession. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this CompoundUsageSession. - { \"description\" : \"ID of the organization to which these usage sessions belong.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this CompoundUsageSession. - :type: str - """ - - self._organization_id = organization_id - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/contract.py b/billforward/models/contract.py new file mode 100644 index 0000000..4281800 --- /dev/null +++ b/billforward/models/contract.py @@ -0,0 +1,541 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class Contract(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'account_id': 'str', + 'subscription_id': 'str', + 'name': 'str', + 'description': 'str', + 'state': 'str', + 'start': 'datetime', + 'contract_end_behaviour': 'str', + 'valid_from': 'datetime', + 'valid_till': 'datetime', + 'contract_periods': 'list[ContractPeriod]', + 'current_period': 'ContractPeriod', + 'sorted_contract_periods': 'list[ContractPeriod]' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'subscription_id': 'subscriptionID', + 'name': 'name', + 'description': 'description', + 'state': 'state', + 'start': 'start', + 'contract_end_behaviour': 'contractEndBehaviour', + 'valid_from': 'validFrom', + 'valid_till': 'validTill', + 'contract_periods': 'contractPeriods', + 'current_period': 'currentPeriod', + 'sorted_contract_periods': 'sortedContractPeriods' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, account_id=None, subscription_id=None, name=None, description=None, state=None, start=None, contract_end_behaviour=None, valid_from=None, valid_till=None, contract_periods=None, current_period=None, sorted_contract_periods=None): # noqa: E501 + """Contract - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._account_id = None + self._subscription_id = None + self._name = None + self._description = None + self._state = None + self._start = None + self._contract_end_behaviour = None + self._valid_from = None + self._valid_till = None + self._contract_periods = None + self._current_period = None + self._sorted_contract_periods = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if subscription_id is not None: + self.subscription_id = subscription_id + if name is not None: + self.name = name + if description is not None: + self.description = description + self.state = state + if start is not None: + self.start = start + self.contract_end_behaviour = contract_end_behaviour + self.valid_from = valid_from + if valid_till is not None: + self.valid_till = valid_till + if contract_periods is not None: + self.contract_periods = contract_periods + if current_period is not None: + self.current_period = current_period + if sorted_contract_periods is not None: + self.sorted_contract_periods = sorted_contract_periods + + @property + def created(self): + """Gets the created of this Contract. # noqa: E501 + + + :return: The created of this Contract. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this Contract. + + + :param created: The created of this Contract. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this Contract. # noqa: E501 + + + :return: The changed_by of this Contract. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this Contract. + + + :param changed_by: The changed_by of this Contract. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this Contract. # noqa: E501 + + + :return: The updated of this Contract. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this Contract. + + + :param updated: The updated of this Contract. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this Contract. # noqa: E501 + + + :return: The id of this Contract. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this Contract. + + + :param id: The id of this Contract. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this Contract. # noqa: E501 + + + :return: The organization_id of this Contract. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this Contract. + + + :param organization_id: The organization_id of this Contract. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_id(self): + """Gets the account_id of this Contract. # noqa: E501 + + + :return: The account_id of this Contract. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this Contract. + + + :param account_id: The account_id of this Contract. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def subscription_id(self): + """Gets the subscription_id of this Contract. # noqa: E501 + + + :return: The subscription_id of this Contract. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this Contract. + + + :param subscription_id: The subscription_id of this Contract. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def name(self): + """Gets the name of this Contract. # noqa: E501 + + + :return: The name of this Contract. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this Contract. + + + :param name: The name of this Contract. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this Contract. # noqa: E501 + + + :return: The description of this Contract. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this Contract. + + + :param description: The description of this Contract. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def state(self): + """Gets the state of this Contract. # noqa: E501 + + + :return: The state of this Contract. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this Contract. + + + :param state: The state of this Contract. # noqa: E501 + :type: str + """ + if state is None: + raise ValueError("Invalid value for `state`, must not be `None`") # noqa: E501 + allowed_values = ["Pending", "Active", "Expired", "Voided"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def start(self): + """Gets the start of this Contract. # noqa: E501 + + + :return: The start of this Contract. # noqa: E501 + :rtype: datetime + """ + return self._start + + @start.setter + def start(self, start): + """Sets the start of this Contract. + + + :param start: The start of this Contract. # noqa: E501 + :type: datetime + """ + + self._start = start + + @property + def contract_end_behaviour(self): + """Gets the contract_end_behaviour of this Contract. # noqa: E501 + + + :return: The contract_end_behaviour of this Contract. # noqa: E501 + :rtype: str + """ + return self._contract_end_behaviour + + @contract_end_behaviour.setter + def contract_end_behaviour(self, contract_end_behaviour): + """Sets the contract_end_behaviour of this Contract. + + + :param contract_end_behaviour: The contract_end_behaviour of this Contract. # noqa: E501 + :type: str + """ + if contract_end_behaviour is None: + raise ValueError("Invalid value for `contract_end_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["ExpireSubscription", "EvergreenSubscription"] # noqa: E501 + if contract_end_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `contract_end_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(contract_end_behaviour, allowed_values) + ) + + self._contract_end_behaviour = contract_end_behaviour + + @property + def valid_from(self): + """Gets the valid_from of this Contract. # noqa: E501 + + + :return: The valid_from of this Contract. # noqa: E501 + :rtype: datetime + """ + return self._valid_from + + @valid_from.setter + def valid_from(self, valid_from): + """Sets the valid_from of this Contract. + + + :param valid_from: The valid_from of this Contract. # noqa: E501 + :type: datetime + """ + if valid_from is None: + raise ValueError("Invalid value for `valid_from`, must not be `None`") # noqa: E501 + + self._valid_from = valid_from + + @property + def valid_till(self): + """Gets the valid_till of this Contract. # noqa: E501 + + + :return: The valid_till of this Contract. # noqa: E501 + :rtype: datetime + """ + return self._valid_till + + @valid_till.setter + def valid_till(self, valid_till): + """Sets the valid_till of this Contract. + + + :param valid_till: The valid_till of this Contract. # noqa: E501 + :type: datetime + """ + + self._valid_till = valid_till + + @property + def contract_periods(self): + """Gets the contract_periods of this Contract. # noqa: E501 + + + :return: The contract_periods of this Contract. # noqa: E501 + :rtype: list[ContractPeriod] + """ + return self._contract_periods + + @contract_periods.setter + def contract_periods(self, contract_periods): + """Sets the contract_periods of this Contract. + + + :param contract_periods: The contract_periods of this Contract. # noqa: E501 + :type: list[ContractPeriod] + """ + + self._contract_periods = contract_periods + + @property + def current_period(self): + """Gets the current_period of this Contract. # noqa: E501 + + + :return: The current_period of this Contract. # noqa: E501 + :rtype: ContractPeriod + """ + return self._current_period + + @current_period.setter + def current_period(self, current_period): + """Sets the current_period of this Contract. + + + :param current_period: The current_period of this Contract. # noqa: E501 + :type: ContractPeriod + """ + + self._current_period = current_period + + @property + def sorted_contract_periods(self): + """Gets the sorted_contract_periods of this Contract. # noqa: E501 + + + :return: The sorted_contract_periods of this Contract. # noqa: E501 + :rtype: list[ContractPeriod] + """ + return self._sorted_contract_periods + + @sorted_contract_periods.setter + def sorted_contract_periods(self, sorted_contract_periods): + """Sets the sorted_contract_periods of this Contract. + + + :param sorted_contract_periods: The sorted_contract_periods of this Contract. # noqa: E501 + :type: list[ContractPeriod] + """ + + self._sorted_contract_periods = sorted_contract_periods + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(Contract, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, Contract): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/contract_period.py b/billforward/models/contract_period.py new file mode 100644 index 0000000..95eff3b --- /dev/null +++ b/billforward/models/contract_period.py @@ -0,0 +1,409 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class ContractPeriod(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'subscription_duration_period': 'int', + 'subscription_duration_period_type': 'str', + 'state': 'str', + 'contract_period': 'int', + 'subscription_periods': 'int', + 'purchase_order': 'str', + 'quote': 'ApiQuote' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'subscription_duration_period': 'subscriptionDurationPeriod', + 'subscription_duration_period_type': 'subscriptionDurationPeriodType', + 'state': 'state', + 'contract_period': 'contractPeriod', + 'subscription_periods': 'subscriptionPeriods', + 'purchase_order': 'purchaseOrder', + 'quote': 'quote' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, subscription_duration_period=None, subscription_duration_period_type=None, state=None, contract_period=None, subscription_periods=None, purchase_order=None, quote=None): # noqa: E501 + """ContractPeriod - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._subscription_duration_period = None + self._subscription_duration_period_type = None + self._state = None + self._contract_period = None + self._subscription_periods = None + self._purchase_order = None + self._quote = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if subscription_duration_period is not None: + self.subscription_duration_period = subscription_duration_period + if subscription_duration_period_type is not None: + self.subscription_duration_period_type = subscription_duration_period_type + self.state = state + if contract_period is not None: + self.contract_period = contract_period + if subscription_periods is not None: + self.subscription_periods = subscription_periods + if purchase_order is not None: + self.purchase_order = purchase_order + if quote is not None: + self.quote = quote + + @property + def created(self): + """Gets the created of this ContractPeriod. # noqa: E501 + + + :return: The created of this ContractPeriod. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this ContractPeriod. + + + :param created: The created of this ContractPeriod. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this ContractPeriod. # noqa: E501 + + + :return: The changed_by of this ContractPeriod. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this ContractPeriod. + + + :param changed_by: The changed_by of this ContractPeriod. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this ContractPeriod. # noqa: E501 + + + :return: The updated of this ContractPeriod. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this ContractPeriod. + + + :param updated: The updated of this ContractPeriod. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this ContractPeriod. # noqa: E501 + + + :return: The id of this ContractPeriod. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this ContractPeriod. + + + :param id: The id of this ContractPeriod. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this ContractPeriod. # noqa: E501 + + + :return: The organization_id of this ContractPeriod. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this ContractPeriod. + + + :param organization_id: The organization_id of this ContractPeriod. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def subscription_duration_period(self): + """Gets the subscription_duration_period of this ContractPeriod. # noqa: E501 + + + :return: The subscription_duration_period of this ContractPeriod. # noqa: E501 + :rtype: int + """ + return self._subscription_duration_period + + @subscription_duration_period.setter + def subscription_duration_period(self, subscription_duration_period): + """Sets the subscription_duration_period of this ContractPeriod. + + + :param subscription_duration_period: The subscription_duration_period of this ContractPeriod. # noqa: E501 + :type: int + """ + + self._subscription_duration_period = subscription_duration_period + + @property + def subscription_duration_period_type(self): + """Gets the subscription_duration_period_type of this ContractPeriod. # noqa: E501 + + + :return: The subscription_duration_period_type of this ContractPeriod. # noqa: E501 + :rtype: str + """ + return self._subscription_duration_period_type + + @subscription_duration_period_type.setter + def subscription_duration_period_type(self, subscription_duration_period_type): + """Sets the subscription_duration_period_type of this ContractPeriod. + + + :param subscription_duration_period_type: The subscription_duration_period_type of this ContractPeriod. # noqa: E501 + :type: str + """ + allowed_values = ["minutes", "days", "months", "years"] # noqa: E501 + if subscription_duration_period_type not in allowed_values: + raise ValueError( + "Invalid value for `subscription_duration_period_type` ({0}), must be one of {1}" # noqa: E501 + .format(subscription_duration_period_type, allowed_values) + ) + + self._subscription_duration_period_type = subscription_duration_period_type + + @property + def state(self): + """Gets the state of this ContractPeriod. # noqa: E501 + + + :return: The state of this ContractPeriod. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this ContractPeriod. + + + :param state: The state of this ContractPeriod. # noqa: E501 + :type: str + """ + if state is None: + raise ValueError("Invalid value for `state`, must not be `None`") # noqa: E501 + allowed_values = ["Pending", "Current", "Expired", "Voided"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def contract_period(self): + """Gets the contract_period of this ContractPeriod. # noqa: E501 + + + :return: The contract_period of this ContractPeriod. # noqa: E501 + :rtype: int + """ + return self._contract_period + + @contract_period.setter + def contract_period(self, contract_period): + """Sets the contract_period of this ContractPeriod. + + + :param contract_period: The contract_period of this ContractPeriod. # noqa: E501 + :type: int + """ + + self._contract_period = contract_period + + @property + def subscription_periods(self): + """Gets the subscription_periods of this ContractPeriod. # noqa: E501 + + + :return: The subscription_periods of this ContractPeriod. # noqa: E501 + :rtype: int + """ + return self._subscription_periods + + @subscription_periods.setter + def subscription_periods(self, subscription_periods): + """Sets the subscription_periods of this ContractPeriod. + + + :param subscription_periods: The subscription_periods of this ContractPeriod. # noqa: E501 + :type: int + """ + + self._subscription_periods = subscription_periods + + @property + def purchase_order(self): + """Gets the purchase_order of this ContractPeriod. # noqa: E501 + + + :return: The purchase_order of this ContractPeriod. # noqa: E501 + :rtype: str + """ + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this ContractPeriod. + + + :param purchase_order: The purchase_order of this ContractPeriod. # noqa: E501 + :type: str + """ + + self._purchase_order = purchase_order + + @property + def quote(self): + """Gets the quote of this ContractPeriod. # noqa: E501 + + + :return: The quote of this ContractPeriod. # noqa: E501 + :rtype: ApiQuote + """ + return self._quote + + @quote.setter + def quote(self, quote): + """Sets the quote of this ContractPeriod. + + + :param quote: The quote of this ContractPeriod. # noqa: E501 + :type: ApiQuote + """ + + self._quote = quote + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ContractPeriod, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ContractPeriod): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/coupon.py b/billforward/models/coupon.py index 0d2f696..070dca3 100644 --- a/billforward/models/coupon.py +++ b/billforward/models/coupon.py @@ -1,145 +1,187 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class Coupon(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, name=None, coupon_code=None, coupons=None, uses=None, product=None, product_name=None, product_id=None, product_rate_plan=None, product_rate_plan_name=None, product_rate_plan_id=None, currency=None, parent_coupon_code_redeemable=False, organization_id=None, discounts=None, deleted=False, parent_coupon_code=None, applies_to=None, applies_to_id=None, remaining_uses=None, used=None, discount_value=None, valid_until=None): - """ - Coupon - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'name': 'str', - 'coupon_code': 'str', - 'coupons': 'int', - 'uses': 'int', - 'product': 'str', - 'product_name': 'str', - 'product_id': 'str', - 'product_rate_plan': 'str', - 'product_rate_plan_name': 'str', - 'product_rate_plan_id': 'str', - 'currency': 'str', - 'parent_coupon_code_redeemable': 'bool', - 'organization_id': 'str', - 'discounts': 'list[CouponDiscount]', - 'deleted': 'bool', - 'parent_coupon_code': 'str', - 'applies_to': 'str', - 'applies_to_id': 'str', - 'remaining_uses': 'int', - 'used': 'int', - 'discount_value': 'float', - 'valid_until': 'datetime' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'name': 'name', - 'coupon_code': 'couponCode', - 'coupons': 'coupons', - 'uses': 'uses', - 'product': 'product', - 'product_name': 'productName', - 'product_id': 'productID', - 'product_rate_plan': 'productRatePlan', - 'product_rate_plan_name': 'productRatePlanName', - 'product_rate_plan_id': 'productRatePlanID', - 'currency': 'currency', - 'parent_coupon_code_redeemable': 'parentCouponCodeRedeemable', - 'organization_id': 'organizationID', - 'discounts': 'discounts', - 'deleted': 'deleted', - 'parent_coupon_code': 'parentCouponCode', - 'applies_to': 'appliesTo', - 'applies_to_id': 'appliesToID', - 'remaining_uses': 'remainingUses', - 'used': 'used', - 'discount_value': 'discountValue', - 'valid_until': 'validUntil' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._name = name - self._coupon_code = coupon_code - self._coupons = coupons - self._uses = uses - self._product = product - self._product_name = product_name - self._product_id = product_id - self._product_rate_plan = product_rate_plan - self._product_rate_plan_name = product_rate_plan_name - self._product_rate_plan_id = product_rate_plan_id - self._currency = currency - self._parent_coupon_code_redeemable = parent_coupon_code_redeemable - self._organization_id = organization_id - self._discounts = discounts - self._deleted = deleted - self._parent_coupon_code = parent_coupon_code - self._applies_to = applies_to - self._applies_to_id = applies_to_id - self._remaining_uses = remaining_uses - self._used = used - self._discount_value = discount_value - self._valid_until = valid_until + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'name': 'str', + 'coupon_code': 'str', + 'coupons': 'int', + 'uses': 'int', + 'product': 'str', + 'product_name': 'str', + 'product_id': 'str', + 'product_rate_plan': 'str', + 'product_rate_plan_name': 'str', + 'product_rate_plan_id': 'str', + 'currency': 'CreditNoteCurrency', + 'parent_coupon_code_redeemable': 'bool', + 'organization_id': 'str', + 'discounts': 'list[CouponDiscount]', + 'deleted': 'bool', + 'parent_coupon_code': 'str', + 'applies_to': 'str', + 'applies_to_id': 'str', + 'remaining_uses': 'int', + 'used': 'int', + 'valid_until': 'datetime', + 'instance_details': 'CouponInstance', + 'master_code_redeemable': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'name': 'name', + 'coupon_code': 'couponCode', + 'coupons': 'coupons', + 'uses': 'uses', + 'product': 'product', + 'product_name': 'productName', + 'product_id': 'productID', + 'product_rate_plan': 'productRatePlan', + 'product_rate_plan_name': 'productRatePlanName', + 'product_rate_plan_id': 'productRatePlanID', + 'currency': 'currency', + 'parent_coupon_code_redeemable': 'parentCouponCodeRedeemable', + 'organization_id': 'organizationID', + 'discounts': 'discounts', + 'deleted': 'deleted', + 'parent_coupon_code': 'parentCouponCode', + 'applies_to': 'appliesTo', + 'applies_to_id': 'appliesToID', + 'remaining_uses': 'remainingUses', + 'used': 'used', + 'valid_until': 'validUntil', + 'instance_details': 'instanceDetails', + 'master_code_redeemable': 'masterCodeRedeemable' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, name=None, coupon_code=None, coupons=None, uses=None, product=None, product_name=None, product_id=None, product_rate_plan=None, product_rate_plan_name=None, product_rate_plan_id=None, currency=None, parent_coupon_code_redeemable=None, organization_id=None, discounts=None, deleted=None, parent_coupon_code=None, applies_to=None, applies_to_id=None, remaining_uses=None, used=None, valid_until=None, instance_details=None, master_code_redeemable=None): # noqa: E501 + """Coupon - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._name = None + self._coupon_code = None + self._coupons = None + self._uses = None + self._product = None + self._product_name = None + self._product_id = None + self._product_rate_plan = None + self._product_rate_plan_name = None + self._product_rate_plan_id = None + self._currency = None + self._parent_coupon_code_redeemable = None + self._organization_id = None + self._discounts = None + self._deleted = None + self._parent_coupon_code = None + self._applies_to = None + self._applies_to_id = None + self._remaining_uses = None + self._used = None + self._valid_until = None + self._instance_details = None + self._master_code_redeemable = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.name = name + self.coupon_code = coupon_code + self.coupons = coupons + self.uses = uses + if product is not None: + self.product = product + if product_name is not None: + self.product_name = product_name + if product_id is not None: + self.product_id = product_id + if product_rate_plan is not None: + self.product_rate_plan = product_rate_plan + if product_rate_plan_name is not None: + self.product_rate_plan_name = product_rate_plan_name + if product_rate_plan_id is not None: + self.product_rate_plan_id = product_rate_plan_id + if currency is not None: + self.currency = currency + self.parent_coupon_code_redeemable = parent_coupon_code_redeemable + self.organization_id = organization_id + if discounts is not None: + self.discounts = discounts + if deleted is not None: + self.deleted = deleted + if parent_coupon_code is not None: + self.parent_coupon_code = parent_coupon_code + if applies_to is not None: + self.applies_to = applies_to + if applies_to_id is not None: + self.applies_to_id = applies_to_id + if remaining_uses is not None: + self.remaining_uses = remaining_uses + if used is not None: + self.used = used + if valid_until is not None: + self.valid_until = valid_until + if instance_details is not None: + self.instance_details = instance_details + if master_code_redeemable is not None: + self.master_code_redeemable = master_code_redeemable @property def created(self): - """ - Gets the created of this Coupon. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this Coupon. # noqa: E501 - :return: The created of this Coupon. + + :return: The created of this Coupon. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this Coupon. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this Coupon. + - :param created: The created of this Coupon. + :param created: The created of this Coupon. # noqa: E501 :type: datetime """ @@ -147,22 +189,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this Coupon. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this Coupon. # noqa: E501 + - :return: The changed_by of this Coupon. + :return: The changed_by of this Coupon. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this Coupon. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this Coupon. - :param changed_by: The changed_by of this Coupon. + + :param changed_by: The changed_by of this Coupon. # noqa: E501 :type: str """ @@ -170,137 +210,154 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this Coupon. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this Coupon. # noqa: E501 + - :return: The updated of this Coupon. + :return: The updated of this Coupon. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this Coupon. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this Coupon. + - :param updated: The updated of this Coupon. + :param updated: The updated of this Coupon. # noqa: E501 :type: datetime """ self._updated = updated @property - def name(self): + def id(self): + """Gets the id of this Coupon. # noqa: E501 + + + :return: The id of this Coupon. # noqa: E501 + :rtype: str """ - Gets the name of this Coupon. - { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + return self._id + + @id.setter + def id(self, id): + """Sets the id of this Coupon. + + + :param id: The id of this Coupon. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def name(self): + """Gets the name of this Coupon. # noqa: E501 + - :return: The name of this Coupon. + :return: The name of this Coupon. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this Coupon. - { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the name of this Coupon. + - :param name: The name of this Coupon. + :param name: The name of this Coupon. # noqa: E501 :type: str """ + if name is None: + raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501 self._name = name @property def coupon_code(self): - """ - Gets the coupon_code of this Coupon. - { \"description\" : \"Code used to identify this set of coupons. If unique codes are required this will be used as the prefix to generate individual coupon codes. When a unique code is returned the original couponCode is returned in the parentCouponCode property. For example a single coupon code SUMMER maybe be issued at an event to encourage sign-up, the same code can be redeemed by multiple accounts. In another example you may want to issue unique coupon codes per a customer, for example SUMMER-A4FC, SUMMER-BCQ4, each code can only be calimed once.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the coupon_code of this Coupon. # noqa: E501 - :return: The coupon_code of this Coupon. + + :return: The coupon_code of this Coupon. # noqa: E501 :rtype: str """ return self._coupon_code @coupon_code.setter def coupon_code(self, coupon_code): - """ - Sets the coupon_code of this Coupon. - { \"description\" : \"Code used to identify this set of coupons. If unique codes are required this will be used as the prefix to generate individual coupon codes. When a unique code is returned the original couponCode is returned in the parentCouponCode property. For example a single coupon code SUMMER maybe be issued at an event to encourage sign-up, the same code can be redeemed by multiple accounts. In another example you may want to issue unique coupon codes per a customer, for example SUMMER-A4FC, SUMMER-BCQ4, each code can only be calimed once.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the coupon_code of this Coupon. + - :param coupon_code: The coupon_code of this Coupon. + :param coupon_code: The coupon_code of this Coupon. # noqa: E501 :type: str """ + if coupon_code is None: + raise ValueError("Invalid value for `coupon_code`, must not be `None`") # noqa: E501 self._coupon_code = coupon_code @property def coupons(self): - """ - Gets the coupons of this Coupon. - { \"default\" : \"∞\", \"description\" : \"Number of times the coupon can be claimed. In the case of generating unique coupon codes this is the maximum quantity that can be genereated. For example set this value to 10 if you want to limit the total number of subscriptions that will use this code to 10.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the coupons of this Coupon. # noqa: E501 + - :return: The coupons of this Coupon. + :return: The coupons of this Coupon. # noqa: E501 :rtype: int """ return self._coupons @coupons.setter def coupons(self, coupons): - """ - Sets the coupons of this Coupon. - { \"default\" : \"∞\", \"description\" : \"Number of times the coupon can be claimed. In the case of generating unique coupon codes this is the maximum quantity that can be genereated. For example set this value to 10 if you want to limit the total number of subscriptions that will use this code to 10.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the coupons of this Coupon. + - :param coupons: The coupons of this Coupon. + :param coupons: The coupons of this Coupon. # noqa: E501 :type: int """ + if coupons is None: + raise ValueError("Invalid value for `coupons`, must not be `None`") # noqa: E501 self._coupons = coupons @property def uses(self): - """ - Gets the uses of this Coupon. - { \"default\" : \"∞\", \"description\" : \"This specifies how many times a discount will be added to a subscription once the coupon is added. For example if the uses is set to 3 it will discount 3 times, set this to a large number, for example 9999999, to give infinite applications, .\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the uses of this Coupon. # noqa: E501 - :return: The uses of this Coupon. + + :return: The uses of this Coupon. # noqa: E501 :rtype: int """ return self._uses @uses.setter def uses(self, uses): - """ - Sets the uses of this Coupon. - { \"default\" : \"∞\", \"description\" : \"This specifies how many times a discount will be added to a subscription once the coupon is added. For example if the uses is set to 3 it will discount 3 times, set this to a large number, for example 9999999, to give infinite applications, .\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the uses of this Coupon. + - :param uses: The uses of this Coupon. + :param uses: The uses of this Coupon. # noqa: E501 :type: int """ + if uses is None: + raise ValueError("Invalid value for `uses`, must not be `None`") # noqa: E501 self._uses = uses @property def product(self): - """ - Gets the product of this Coupon. - { \"description\" : \"Name or ID of the product this coupon applies to. Requires a specific rate-plan to be set.\", \"verbs\":[\"POST\"] } + """Gets the product of this Coupon. # noqa: E501 + - :return: The product of this Coupon. + :return: The product of this Coupon. # noqa: E501 :rtype: str """ return self._product @product.setter def product(self, product): - """ - Sets the product of this Coupon. - { \"description\" : \"Name or ID of the product this coupon applies to. Requires a specific rate-plan to be set.\", \"verbs\":[\"POST\"] } + """Sets the product of this Coupon. - :param product: The product of this Coupon. + + :param product: The product of this Coupon. # noqa: E501 :type: str """ @@ -308,22 +365,20 @@ def product(self, product): @property def product_name(self): - """ - Gets the product_name of this Coupon. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the product_name of this Coupon. # noqa: E501 - :return: The product_name of this Coupon. + + :return: The product_name of this Coupon. # noqa: E501 :rtype: str """ return self._product_name @product_name.setter def product_name(self, product_name): - """ - Sets the product_name of this Coupon. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the product_name of this Coupon. + - :param product_name: The product_name of this Coupon. + :param product_name: The product_name of this Coupon. # noqa: E501 :type: str """ @@ -331,22 +386,20 @@ def product_name(self, product_name): @property def product_id(self): - """ - Gets the product_id of this Coupon. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the product_id of this Coupon. # noqa: E501 + - :return: The product_id of this Coupon. + :return: The product_id of this Coupon. # noqa: E501 :rtype: str """ return self._product_id @product_id.setter def product_id(self, product_id): - """ - Sets the product_id of this Coupon. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the product_id of this Coupon. - :param product_id: The product_id of this Coupon. + + :param product_id: The product_id of this Coupon. # noqa: E501 :type: str """ @@ -354,22 +407,20 @@ def product_id(self, product_id): @property def product_rate_plan(self): - """ - Gets the product_rate_plan of this Coupon. - { \"description\" : \"Name or ID of the rate-plan this coupon applies to. \", \"verbs\":[\"POST\"] } + """Gets the product_rate_plan of this Coupon. # noqa: E501 + - :return: The product_rate_plan of this Coupon. + :return: The product_rate_plan of this Coupon. # noqa: E501 :rtype: str """ return self._product_rate_plan @product_rate_plan.setter def product_rate_plan(self, product_rate_plan): - """ - Sets the product_rate_plan of this Coupon. - { \"description\" : \"Name or ID of the rate-plan this coupon applies to. \", \"verbs\":[\"POST\"] } + """Sets the product_rate_plan of this Coupon. + - :param product_rate_plan: The product_rate_plan of this Coupon. + :param product_rate_plan: The product_rate_plan of this Coupon. # noqa: E501 :type: str """ @@ -377,22 +428,20 @@ def product_rate_plan(self, product_rate_plan): @property def product_rate_plan_name(self): - """ - Gets the product_rate_plan_name of this Coupon. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the product_rate_plan_name of this Coupon. # noqa: E501 + - :return: The product_rate_plan_name of this Coupon. + :return: The product_rate_plan_name of this Coupon. # noqa: E501 :rtype: str """ return self._product_rate_plan_name @product_rate_plan_name.setter def product_rate_plan_name(self, product_rate_plan_name): - """ - Sets the product_rate_plan_name of this Coupon. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the product_rate_plan_name of this Coupon. - :param product_rate_plan_name: The product_rate_plan_name of this Coupon. + + :param product_rate_plan_name: The product_rate_plan_name of this Coupon. # noqa: E501 :type: str """ @@ -400,22 +449,20 @@ def product_rate_plan_name(self, product_rate_plan_name): @property def product_rate_plan_id(self): - """ - Gets the product_rate_plan_id of this Coupon. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the product_rate_plan_id of this Coupon. # noqa: E501 + - :return: The product_rate_plan_id of this Coupon. + :return: The product_rate_plan_id of this Coupon. # noqa: E501 :rtype: str """ return self._product_rate_plan_id @product_rate_plan_id.setter def product_rate_plan_id(self, product_rate_plan_id): - """ - Sets the product_rate_plan_id of this Coupon. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the product_rate_plan_id of this Coupon. + - :param product_rate_plan_id: The product_rate_plan_id of this Coupon. + :param product_rate_plan_id: The product_rate_plan_id of this Coupon. # noqa: E501 :type: str """ @@ -423,91 +470,87 @@ def product_rate_plan_id(self, product_rate_plan_id): @property def currency(self): - """ - Gets the currency of this Coupon. - { \"description\" : \"If the coupon is not for a specific rate-plan, and can apply to any subscription, the currency should be provivded. Currency is specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the currency of this Coupon. # noqa: E501 - :return: The currency of this Coupon. - :rtype: str + + :return: The currency of this Coupon. # noqa: E501 + :rtype: CreditNoteCurrency """ return self._currency @currency.setter def currency(self, currency): - """ - Sets the currency of this Coupon. - { \"description\" : \"If the coupon is not for a specific rate-plan, and can apply to any subscription, the currency should be provivded. Currency is specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the currency of this Coupon. - :param currency: The currency of this Coupon. - :type: str + + :param currency: The currency of this Coupon. # noqa: E501 + :type: CreditNoteCurrency """ self._currency = currency @property def parent_coupon_code_redeemable(self): - """ - Gets the parent_coupon_code_redeemable of this Coupon. - { \"default\" : \"true\", \"description\" : \"If true the coupon without postfix can be added to a subscription, for example if parentCouponCodeRedeemable is true and the coupon was created with code SUMMER customers could claim using SUMMER. If parentCouponCodeRedeemable is false then only unique coupon codes can be claimed, for example SUMMER-AB4C, SUMMER-YZB4.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the parent_coupon_code_redeemable of this Coupon. # noqa: E501 + - :return: The parent_coupon_code_redeemable of this Coupon. + :return: The parent_coupon_code_redeemable of this Coupon. # noqa: E501 :rtype: bool """ return self._parent_coupon_code_redeemable @parent_coupon_code_redeemable.setter def parent_coupon_code_redeemable(self, parent_coupon_code_redeemable): - """ - Sets the parent_coupon_code_redeemable of this Coupon. - { \"default\" : \"true\", \"description\" : \"If true the coupon without postfix can be added to a subscription, for example if parentCouponCodeRedeemable is true and the coupon was created with code SUMMER customers could claim using SUMMER. If parentCouponCodeRedeemable is false then only unique coupon codes can be claimed, for example SUMMER-AB4C, SUMMER-YZB4.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the parent_coupon_code_redeemable of this Coupon. - :param parent_coupon_code_redeemable: The parent_coupon_code_redeemable of this Coupon. + + :param parent_coupon_code_redeemable: The parent_coupon_code_redeemable of this Coupon. # noqa: E501 :type: bool """ + if parent_coupon_code_redeemable is None: + raise ValueError("Invalid value for `parent_coupon_code_redeemable`, must not be `None`") # noqa: E501 self._parent_coupon_code_redeemable = parent_coupon_code_redeemable @property def organization_id(self): - """ - Gets the organization_id of this Coupon. + """Gets the organization_id of this Coupon. # noqa: E501 - :return: The organization_id of this Coupon. + :return: The organization_id of this Coupon. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this Coupon. + """Sets the organization_id of this Coupon. - :param organization_id: The organization_id of this Coupon. + :param organization_id: The organization_id of this Coupon. # noqa: E501 :type: str """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 self._organization_id = organization_id @property def discounts(self): - """ - Gets the discounts of this Coupon. - { \"description\" : \"For each discount item on the coupon, only one discount type should be set between cashDiscount, percentageDiscount and unitsFree. cashDiscount gives a fixed monetary discount, for example $10.00. percentageDiscount gives a percentage discount on the overall invoice cost. unitsFree discounts the pricing by the number of units specified for that component. All discounts are applied against the base cost or units. Discounts are not compound. Discounts will never exceed the value of a pricing component of the overall invoice - thus at most the discount will reduce the cost to zero. If no pricing component is specified the discount will apply to the total invoice cost.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the discounts of this Coupon. # noqa: E501 + - :return: The discounts of this Coupon. + :return: The discounts of this Coupon. # noqa: E501 :rtype: list[CouponDiscount] """ return self._discounts @discounts.setter def discounts(self, discounts): - """ - Sets the discounts of this Coupon. - { \"description\" : \"For each discount item on the coupon, only one discount type should be set between cashDiscount, percentageDiscount and unitsFree. cashDiscount gives a fixed monetary discount, for example $10.00. percentageDiscount gives a percentage discount on the overall invoice cost. unitsFree discounts the pricing by the number of units specified for that component. All discounts are applied against the base cost or units. Discounts are not compound. Discounts will never exceed the value of a pricing component of the overall invoice - thus at most the discount will reduce the cost to zero. If no pricing component is specified the discount will apply to the total invoice cost.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the discounts of this Coupon. + - :param discounts: The discounts of this Coupon. + :param discounts: The discounts of this Coupon. # noqa: E501 :type: list[CouponDiscount] """ @@ -515,22 +558,20 @@ def discounts(self, discounts): @property def deleted(self): - """ - Gets the deleted of this Coupon. - { \"description\" : \"If a coupon has been deleted, any subsequent attempts to add it to a subscription will fail. Note: This will not affect existing subscription using the coupon. Please see deleting a coupon for more details\", \"verbs\":[\"GET\"] } + """Gets the deleted of this Coupon. # noqa: E501 - :return: The deleted of this Coupon. + + :return: The deleted of this Coupon. # noqa: E501 :rtype: bool """ return self._deleted @deleted.setter def deleted(self, deleted): - """ - Sets the deleted of this Coupon. - { \"description\" : \"If a coupon has been deleted, any subsequent attempts to add it to a subscription will fail. Note: This will not affect existing subscription using the coupon. Please see deleting a coupon for more details\", \"verbs\":[\"GET\"] } + """Sets the deleted of this Coupon. + - :param deleted: The deleted of this Coupon. + :param deleted: The deleted of this Coupon. # noqa: E501 :type: bool """ @@ -538,22 +579,20 @@ def deleted(self, deleted): @property def parent_coupon_code(self): - """ - Gets the parent_coupon_code of this Coupon. - { \"description\" : \"For unique coupon codes this is the original coupon code, for example SUMMER\", \"verbs\":[\"GET\"] } + """Gets the parent_coupon_code of this Coupon. # noqa: E501 + - :return: The parent_coupon_code of this Coupon. + :return: The parent_coupon_code of this Coupon. # noqa: E501 :rtype: str """ return self._parent_coupon_code @parent_coupon_code.setter def parent_coupon_code(self, parent_coupon_code): - """ - Sets the parent_coupon_code of this Coupon. - { \"description\" : \"For unique coupon codes this is the original coupon code, for example SUMMER\", \"verbs\":[\"GET\"] } + """Sets the parent_coupon_code of this Coupon. - :param parent_coupon_code: The parent_coupon_code of this Coupon. + + :param parent_coupon_code: The parent_coupon_code of this Coupon. # noqa: E501 :type: str """ @@ -561,28 +600,26 @@ def parent_coupon_code(self, parent_coupon_code): @property def applies_to(self): - """ - Gets the applies_to of this Coupon. - { \"description\" : \"For unique coupon codes this is what the coupon applies to, usually subscription.\", \"verbs\":[\"GET\"] } + """Gets the applies_to of this Coupon. # noqa: E501 - :return: The applies_to of this Coupon. + + :return: The applies_to of this Coupon. # noqa: E501 :rtype: str """ return self._applies_to @applies_to.setter def applies_to(self, applies_to): - """ - Sets the applies_to of this Coupon. - { \"description\" : \"For unique coupon codes this is what the coupon applies to, usually subscription.\", \"verbs\":[\"GET\"] } + """Sets the applies_to of this Coupon. + - :param applies_to: The applies_to of this Coupon. + :param applies_to: The applies_to of this Coupon. # noqa: E501 :type: str """ - allowed_values = ["none", "subscription", "account"] + allowed_values = ["none", "subscription", "account"] # noqa: E501 if applies_to not in allowed_values: raise ValueError( - "Invalid value for `applies_to` ({0}), must be one of {1}" + "Invalid value for `applies_to` ({0}), must be one of {1}" # noqa: E501 .format(applies_to, allowed_values) ) @@ -590,22 +627,20 @@ def applies_to(self, applies_to): @property def applies_to_id(self): - """ - Gets the applies_to_id of this Coupon. - { \"description\" : \"For a coupon added to a subscription this is the the ID of the subscription. This can be used to remove the coupon from the target.\", \"verbs\":[\"GET\"] } + """Gets the applies_to_id of this Coupon. # noqa: E501 + - :return: The applies_to_id of this Coupon. + :return: The applies_to_id of this Coupon. # noqa: E501 :rtype: str """ return self._applies_to_id @applies_to_id.setter def applies_to_id(self, applies_to_id): - """ - Sets the applies_to_id of this Coupon. - { \"description\" : \"For a coupon added to a subscription this is the the ID of the subscription. This can be used to remove the coupon from the target.\", \"verbs\":[\"GET\"] } + """Sets the applies_to_id of this Coupon. - :param applies_to_id: The applies_to_id of this Coupon. + + :param applies_to_id: The applies_to_id of this Coupon. # noqa: E501 :type: str """ @@ -613,22 +648,20 @@ def applies_to_id(self, applies_to_id): @property def remaining_uses(self): - """ - Gets the remaining_uses of this Coupon. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the remaining_uses of this Coupon. # noqa: E501 + - :return: The remaining_uses of this Coupon. + :return: The remaining_uses of this Coupon. # noqa: E501 :rtype: int """ return self._remaining_uses @remaining_uses.setter def remaining_uses(self, remaining_uses): - """ - Sets the remaining_uses of this Coupon. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the remaining_uses of this Coupon. + - :param remaining_uses: The remaining_uses of this Coupon. + :param remaining_uses: The remaining_uses of this Coupon. # noqa: E501 :type: int """ @@ -636,80 +669,93 @@ def remaining_uses(self, remaining_uses): @property def used(self): - """ - Gets the used of this Coupon. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the used of this Coupon. # noqa: E501 + - :return: The used of this Coupon. + :return: The used of this Coupon. # noqa: E501 :rtype: int """ return self._used @used.setter def used(self, used): - """ - Sets the used of this Coupon. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the used of this Coupon. - :param used: The used of this Coupon. + + :param used: The used of this Coupon. # noqa: E501 :type: int """ self._used = used @property - def discount_value(self): - """ - Gets the discount_value of this Coupon. + def valid_until(self): + """Gets the valid_until of this Coupon. # noqa: E501 - :return: The discount_value of this Coupon. - :rtype: float + :return: The valid_until of this Coupon. # noqa: E501 + :rtype: datetime """ - return self._discount_value + return self._valid_until - @discount_value.setter - def discount_value(self, discount_value): - """ - Sets the discount_value of this Coupon. + @valid_until.setter + def valid_until(self, valid_until): + """Sets the valid_until of this Coupon. - :param discount_value: The discount_value of this Coupon. - :type: float + :param valid_until: The valid_until of this Coupon. # noqa: E501 + :type: datetime """ - self._discount_value = discount_value + self._valid_until = valid_until @property - def valid_until(self): + def instance_details(self): + """Gets the instance_details of this Coupon. # noqa: E501 + + + :return: The instance_details of this Coupon. # noqa: E501 + :rtype: CouponInstance """ - Gets the valid_until of this Coupon. - { \"description\" : \"If the coupon was removed from the subscription this is the date and time from when it no ceased to be applied.\", \"verbs\":[\"GET\"] } + return self._instance_details - :return: The valid_until of this Coupon. - :rtype: datetime + @instance_details.setter + def instance_details(self, instance_details): + """Sets the instance_details of this Coupon. + + + :param instance_details: The instance_details of this Coupon. # noqa: E501 + :type: CouponInstance """ - return self._valid_until - @valid_until.setter - def valid_until(self, valid_until): + self._instance_details = instance_details + + @property + def master_code_redeemable(self): + """Gets the master_code_redeemable of this Coupon. # noqa: E501 + + + :return: The master_code_redeemable of this Coupon. # noqa: E501 + :rtype: bool """ - Sets the valid_until of this Coupon. - { \"description\" : \"If the coupon was removed from the subscription this is the date and time from when it no ceased to be applied.\", \"verbs\":[\"GET\"] } + return self._master_code_redeemable - :param valid_until: The valid_until of this Coupon. - :type: datetime + @master_code_redeemable.setter + def master_code_redeemable(self, master_code_redeemable): + """Sets the master_code_redeemable of this Coupon. + + + :param master_code_redeemable: The master_code_redeemable of this Coupon. # noqa: E501 + :type: bool """ - self._valid_until = valid_until + self._master_code_redeemable = master_code_redeemable def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -726,29 +772,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Coupon, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Coupon): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/coupon_book.py b/billforward/models/coupon_book.py deleted file mode 100644 index 68e1ea6..0000000 --- a/billforward/models/coupon_book.py +++ /dev/null @@ -1,462 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponBook(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, book_code=None, created=None, changed_by=None, updated=None, id=None, crm_id=None, organization_id=None, coupon_book_definition_id=None, name=None, cost=None, remaining_coupons=None, max_remaining_coupons=None, maximum_coupon_uses=None, deleted=False): - """ - CouponBook - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'book_code': 'str', - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'crm_id': 'str', - 'organization_id': 'str', - 'coupon_book_definition_id': 'str', - 'name': 'str', - 'cost': 'float', - 'remaining_coupons': 'int', - 'max_remaining_coupons': 'int', - 'maximum_coupon_uses': 'int', - 'deleted': 'bool' - } - - self.attribute_map = { - 'book_code': 'bookCode', - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'crm_id': 'crmID', - 'organization_id': 'organizationID', - 'coupon_book_definition_id': 'couponBookDefinitionID', - 'name': 'name', - 'cost': 'cost', - 'remaining_coupons': 'remainingCoupons', - 'max_remaining_coupons': 'maxRemainingCoupons', - 'maximum_coupon_uses': 'maximumCouponUses', - 'deleted': 'deleted' - } - - self._book_code = book_code - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._crm_id = crm_id - self._organization_id = organization_id - self._coupon_book_definition_id = coupon_book_definition_id - self._name = name - self._cost = cost - self._remaining_coupons = remaining_coupons - self._max_remaining_coupons = max_remaining_coupons - self._maximum_coupon_uses = maximum_coupon_uses - self._deleted = deleted - - @property - def book_code(self): - """ - Gets the book_code of this CouponBook. - { \"description\" : \"The book code for the coupon-book. This is used to create coupon-instances which are associated with subscriptions.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The book_code of this CouponBook. - :rtype: str - """ - return self._book_code - - @book_code.setter - def book_code(self, book_code): - """ - Sets the book_code of this CouponBook. - { \"description\" : \"The book code for the coupon-book. This is used to create coupon-instances which are associated with subscriptions.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param book_code: The book_code of this CouponBook. - :type: str - """ - - self._book_code = book_code - - @property - def created(self): - """ - Gets the created of this CouponBook. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this CouponBook. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this CouponBook. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this CouponBook. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this CouponBook. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this CouponBook. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this CouponBook. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this CouponBook. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this CouponBook. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this CouponBook. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this CouponBook. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this CouponBook. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this CouponBook. - { \"description\" : \"ID of the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this CouponBook. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this CouponBook. - { \"description\" : \"ID of the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this CouponBook. - :type: str - """ - - self._id = id - - @property - def crm_id(self): - """ - Gets the crm_id of this CouponBook. - { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The crm_id of this CouponBook. - :rtype: str - """ - return self._crm_id - - @crm_id.setter - def crm_id(self, crm_id): - """ - Sets the crm_id of this CouponBook. - { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param crm_id: The crm_id of this CouponBook. - :type: str - """ - - self._crm_id = crm_id - - @property - def organization_id(self): - """ - Gets the organization_id of this CouponBook. - { \"description\" : \"Organization associated with the the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this CouponBook. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this CouponBook. - { \"description\" : \"Organization associated with the the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this CouponBook. - :type: str - """ - - self._organization_id = organization_id - - @property - def coupon_book_definition_id(self): - """ - Gets the coupon_book_definition_id of this CouponBook. - { \"description\" : \"ID of the coupon-book-definition associated with the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The coupon_book_definition_id of this CouponBook. - :rtype: str - """ - return self._coupon_book_definition_id - - @coupon_book_definition_id.setter - def coupon_book_definition_id(self, coupon_book_definition_id): - """ - Sets the coupon_book_definition_id of this CouponBook. - { \"description\" : \"ID of the coupon-book-definition associated with the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param coupon_book_definition_id: The coupon_book_definition_id of this CouponBook. - :type: str - """ - - self._coupon_book_definition_id = coupon_book_definition_id - - @property - def name(self): - """ - Gets the name of this CouponBook. - { \"description\" : \"The human readable name of the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The name of this CouponBook. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this CouponBook. - { \"description\" : \"The human readable name of the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param name: The name of this CouponBook. - :type: str - """ - - self._name = name - - @property - def cost(self): - """ - Gets the cost of this CouponBook. - { \"description\" : \"The cost of the coupon-book. Can be used to keep track of coupon-book sales.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The cost of this CouponBook. - :rtype: float - """ - return self._cost - - @cost.setter - def cost(self, cost): - """ - Sets the cost of this CouponBook. - { \"description\" : \"The cost of the coupon-book. Can be used to keep track of coupon-book sales.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param cost: The cost of this CouponBook. - :type: float - """ - - self._cost = cost - - @property - def remaining_coupons(self): - """ - Gets the remaining_coupons of this CouponBook. - { \"description\" : \"The number of available coupon-instances left in the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The remaining_coupons of this CouponBook. - :rtype: int - """ - return self._remaining_coupons - - @remaining_coupons.setter - def remaining_coupons(self, remaining_coupons): - """ - Sets the remaining_coupons of this CouponBook. - { \"description\" : \"The number of available coupon-instances left in the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param remaining_coupons: The remaining_coupons of this CouponBook. - :type: int - """ - - self._remaining_coupons = remaining_coupons - - @property - def max_remaining_coupons(self): - """ - Gets the max_remaining_coupons of this CouponBook. - { \"description\" : \"The original number of available coupon-instances that the coupon-book can hold.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The max_remaining_coupons of this CouponBook. - :rtype: int - """ - return self._max_remaining_coupons - - @max_remaining_coupons.setter - def max_remaining_coupons(self, max_remaining_coupons): - """ - Sets the max_remaining_coupons of this CouponBook. - { \"description\" : \"The original number of available coupon-instances that the coupon-book can hold.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param max_remaining_coupons: The max_remaining_coupons of this CouponBook. - :type: int - """ - - self._max_remaining_coupons = max_remaining_coupons - - @property - def maximum_coupon_uses(self): - """ - Gets the maximum_coupon_uses of this CouponBook. - { \"description\" : \"The maximum number of uses each coupon-instance created from this coupon-book can have.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The maximum_coupon_uses of this CouponBook. - :rtype: int - """ - return self._maximum_coupon_uses - - @maximum_coupon_uses.setter - def maximum_coupon_uses(self, maximum_coupon_uses): - """ - Sets the maximum_coupon_uses of this CouponBook. - { \"description\" : \"The maximum number of uses each coupon-instance created from this coupon-book can have.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param maximum_coupon_uses: The maximum_coupon_uses of this CouponBook. - :type: int - """ - - self._maximum_coupon_uses = maximum_coupon_uses - - @property - def deleted(self): - """ - Gets the deleted of this CouponBook. - { \"description\" : \"Has the coupon book been deleted?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The deleted of this CouponBook. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this CouponBook. - { \"description\" : \"Has the coupon book been deleted?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param deleted: The deleted of this CouponBook. - :type: bool - """ - - self._deleted = deleted - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_book_definition.py b/billforward/models/coupon_book_definition.py deleted file mode 100644 index 9b9a925..0000000 --- a/billforward/models/coupon_book_definition.py +++ /dev/null @@ -1,552 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponBookDefinition(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, crm_id=None, organization_id=None, coupon_definition_id=None, name=None, description=None, minimum=None, maximum=None, step=None, definition_valid_from=None, definition_valid_till=None, instance_duration=None, instance_duration_period=None, state=None): - """ - CouponBookDefinition - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'crm_id': 'str', - 'organization_id': 'str', - 'coupon_definition_id': 'str', - 'name': 'str', - 'description': 'str', - 'minimum': 'int', - 'maximum': 'int', - 'step': 'int', - 'definition_valid_from': 'datetime', - 'definition_valid_till': 'datetime', - 'instance_duration': 'int', - 'instance_duration_period': 'str', - 'state': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'crm_id': 'crmID', - 'organization_id': 'organizationID', - 'coupon_definition_id': 'couponDefinitionID', - 'name': 'name', - 'description': 'description', - 'minimum': 'minimum', - 'maximum': 'maximum', - 'step': 'step', - 'definition_valid_from': 'definitionValidFrom', - 'definition_valid_till': 'definitionValidTill', - 'instance_duration': 'instanceDuration', - 'instance_duration_period': 'instanceDurationPeriod', - 'state': 'state' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._crm_id = crm_id - self._organization_id = organization_id - self._coupon_definition_id = coupon_definition_id - self._name = name - self._description = description - self._minimum = minimum - self._maximum = maximum - self._step = step - self._definition_valid_from = definition_valid_from - self._definition_valid_till = definition_valid_till - self._instance_duration = instance_duration - self._instance_duration_period = instance_duration_period - self._state = state - - @property - def created(self): - """ - Gets the created of this CouponBookDefinition. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this CouponBookDefinition. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this CouponBookDefinition. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this CouponBookDefinition. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this CouponBookDefinition. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this CouponBookDefinition. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this CouponBookDefinition. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this CouponBookDefinition. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this CouponBookDefinition. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this CouponBookDefinition. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this CouponBookDefinition. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this CouponBookDefinition. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this CouponBookDefinition. - { \"description\" : \"ID of the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this CouponBookDefinition. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this CouponBookDefinition. - { \"description\" : \"ID of the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this CouponBookDefinition. - :type: str - """ - - self._id = id - - @property - def crm_id(self): - """ - Gets the crm_id of this CouponBookDefinition. - { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The crm_id of this CouponBookDefinition. - :rtype: str - """ - return self._crm_id - - @crm_id.setter - def crm_id(self, crm_id): - """ - Sets the crm_id of this CouponBookDefinition. - { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param crm_id: The crm_id of this CouponBookDefinition. - :type: str - """ - - self._crm_id = crm_id - - @property - def organization_id(self): - """ - Gets the organization_id of this CouponBookDefinition. - { \"description\" : \"Organization associated with the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this CouponBookDefinition. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this CouponBookDefinition. - { \"description\" : \"Organization associated with the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this CouponBookDefinition. - :type: str - """ - - self._organization_id = organization_id - - @property - def coupon_definition_id(self): - """ - Gets the coupon_definition_id of this CouponBookDefinition. - { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The coupon_definition_id of this CouponBookDefinition. - :rtype: str - """ - return self._coupon_definition_id - - @coupon_definition_id.setter - def coupon_definition_id(self, coupon_definition_id): - """ - Sets the coupon_definition_id of this CouponBookDefinition. - { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param coupon_definition_id: The coupon_definition_id of this CouponBookDefinition. - :type: str - """ - - self._coupon_definition_id = coupon_definition_id - - @property - def name(self): - """ - Gets the name of this CouponBookDefinition. - { \"description\" : \"The human readable name of the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The name of this CouponBookDefinition. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this CouponBookDefinition. - { \"description\" : \"The human readable name of the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param name: The name of this CouponBookDefinition. - :type: str - """ - - self._name = name - - @property - def description(self): - """ - Gets the description of this CouponBookDefinition. - { \"description\" : \"The human readable description of the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The description of this CouponBookDefinition. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this CouponBookDefinition. - { \"description\" : \"The human readable description of the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param description: The description of this CouponBookDefinition. - :type: str - """ - - self._description = description - - @property - def minimum(self): - """ - Gets the minimum of this CouponBookDefinition. - { \"description\" : \"The minimum number of coupon-instances a coupon-book can hold.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The minimum of this CouponBookDefinition. - :rtype: int - """ - return self._minimum - - @minimum.setter - def minimum(self, minimum): - """ - Sets the minimum of this CouponBookDefinition. - { \"description\" : \"The minimum number of coupon-instances a coupon-book can hold.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param minimum: The minimum of this CouponBookDefinition. - :type: int - """ - - self._minimum = minimum - - @property - def maximum(self): - """ - Gets the maximum of this CouponBookDefinition. - { \"description\" : \"The maximum number of coupon-instances a coupon-book can hold.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The maximum of this CouponBookDefinition. - :rtype: int - """ - return self._maximum - - @maximum.setter - def maximum(self, maximum): - """ - Sets the maximum of this CouponBookDefinition. - { \"description\" : \"The maximum number of coupon-instances a coupon-book can hold.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param maximum: The maximum of this CouponBookDefinition. - :type: int - """ - - self._maximum = maximum - - @property - def step(self): - """ - Gets the step of this CouponBookDefinition. - { \"description\" : \"The stepping parameter between the minimum and the maximum value. E.g. if the minimum is 100, the maximum is 150, and the step is 10, this means the coupon-books can hold 100, 110, 120, 130, 140 or 150 coupon-instances.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The step of this CouponBookDefinition. - :rtype: int - """ - return self._step - - @step.setter - def step(self, step): - """ - Sets the step of this CouponBookDefinition. - { \"description\" : \"The stepping parameter between the minimum and the maximum value. E.g. if the minimum is 100, the maximum is 150, and the step is 10, this means the coupon-books can hold 100, 110, 120, 130, 140 or 150 coupon-instances.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param step: The step of this CouponBookDefinition. - :type: int - """ - - self._step = step - - @property - def definition_valid_from(self): - """ - Gets the definition_valid_from of this CouponBookDefinition. - { \"description\" : \"The UTC DateTime that the coupon-book-definition is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The definition_valid_from of this CouponBookDefinition. - :rtype: datetime - """ - return self._definition_valid_from - - @definition_valid_from.setter - def definition_valid_from(self, definition_valid_from): - """ - Sets the definition_valid_from of this CouponBookDefinition. - { \"description\" : \"The UTC DateTime that the coupon-book-definition is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param definition_valid_from: The definition_valid_from of this CouponBookDefinition. - :type: datetime - """ - - self._definition_valid_from = definition_valid_from - - @property - def definition_valid_till(self): - """ - Gets the definition_valid_till of this CouponBookDefinition. - { \"description\" : \"The UTC DateTime that the coupon-book-definition is valid until.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The definition_valid_till of this CouponBookDefinition. - :rtype: datetime - """ - return self._definition_valid_till - - @definition_valid_till.setter - def definition_valid_till(self, definition_valid_till): - """ - Sets the definition_valid_till of this CouponBookDefinition. - { \"description\" : \"The UTC DateTime that the coupon-book-definition is valid until.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param definition_valid_till: The definition_valid_till of this CouponBookDefinition. - :type: datetime - """ - - self._definition_valid_till = definition_valid_till - - @property - def instance_duration(self): - """ - Gets the instance_duration of this CouponBookDefinition. - { \"description\" : \"Reserved for future use.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The instance_duration of this CouponBookDefinition. - :rtype: int - """ - return self._instance_duration - - @instance_duration.setter - def instance_duration(self, instance_duration): - """ - Sets the instance_duration of this CouponBookDefinition. - { \"description\" : \"Reserved for future use.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param instance_duration: The instance_duration of this CouponBookDefinition. - :type: int - """ - - self._instance_duration = instance_duration - - @property - def instance_duration_period(self): - """ - Gets the instance_duration_period of this CouponBookDefinition. - { \"description\" : \"Reserved for future use.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The instance_duration_period of this CouponBookDefinition. - :rtype: str - """ - return self._instance_duration_period - - @instance_duration_period.setter - def instance_duration_period(self, instance_duration_period): - """ - Sets the instance_duration_period of this CouponBookDefinition. - { \"description\" : \"Reserved for future use.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param instance_duration_period: The instance_duration_period of this CouponBookDefinition. - :type: str - """ - allowed_values = ["minutes", "hours", "days", "months", "years"] - if instance_duration_period not in allowed_values: - raise ValueError( - "Invalid value for `instance_duration_period` ({0}), must be one of {1}" - .format(instance_duration_period, allowed_values) - ) - - self._instance_duration_period = instance_duration_period - - @property - def state(self): - """ - Gets the state of this CouponBookDefinition. - { \"description\" : \"The current state of the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The state of this CouponBookDefinition. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this CouponBookDefinition. - { \"description\" : \"The current state of the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param state: The state of this CouponBookDefinition. - :type: str - """ - allowed_values = ["development", "production", "deleted"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_book_definition_paged_metadata.py b/billforward/models/coupon_book_definition_paged_metadata.py deleted file mode 100644 index ed845db..0000000 --- a/billforward/models/coupon_book_definition_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponBookDefinitionPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - CouponBookDefinitionPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[CouponBookDefinition]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this CouponBookDefinitionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this CouponBookDefinitionPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this CouponBookDefinitionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this CouponBookDefinitionPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this CouponBookDefinitionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this CouponBookDefinitionPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this CouponBookDefinitionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this CouponBookDefinitionPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this CouponBookDefinitionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this CouponBookDefinitionPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this CouponBookDefinitionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this CouponBookDefinitionPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this CouponBookDefinitionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this CouponBookDefinitionPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this CouponBookDefinitionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this CouponBookDefinitionPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this CouponBookDefinitionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this CouponBookDefinitionPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this CouponBookDefinitionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this CouponBookDefinitionPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this CouponBookDefinitionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this CouponBookDefinitionPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this CouponBookDefinitionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this CouponBookDefinitionPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this CouponBookDefinitionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this CouponBookDefinitionPagedMetadata. - :rtype: list[CouponBookDefinition] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this CouponBookDefinitionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this CouponBookDefinitionPagedMetadata. - :type: list[CouponBookDefinition] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_book_paged_metadata.py b/billforward/models/coupon_book_paged_metadata.py deleted file mode 100644 index 0220187..0000000 --- a/billforward/models/coupon_book_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponBookPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - CouponBookPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[CouponBook]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this CouponBookPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this CouponBookPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this CouponBookPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this CouponBookPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this CouponBookPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this CouponBookPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this CouponBookPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this CouponBookPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this CouponBookPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this CouponBookPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this CouponBookPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this CouponBookPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this CouponBookPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this CouponBookPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this CouponBookPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this CouponBookPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this CouponBookPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this CouponBookPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this CouponBookPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this CouponBookPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this CouponBookPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this CouponBookPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this CouponBookPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this CouponBookPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this CouponBookPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this CouponBookPagedMetadata. - :rtype: list[CouponBook] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this CouponBookPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this CouponBookPagedMetadata. - :type: list[CouponBook] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_charge.py b/billforward/models/coupon_charge.py new file mode 100644 index 0000000..6714df7 --- /dev/null +++ b/billforward/models/coupon_charge.py @@ -0,0 +1,382 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.subscription_charge import SubscriptionCharge # noqa: F401,E501 + +class CouponCharge(SubscriptionCharge): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'pricing_component_id': 'str', + 'public_pricing_component_name': 'str', + 'pricing_component_name': 'str', + 'pricing_component_value': 'int', + 'coupon_definition_id': 'str', + 'coupon_instance_id': 'str', + 'coupon_modifier_id': 'str', + 'originating_charge_id': 'str', + 'coupon_code': 'str', + 'coupon_type': 'str', + 'pricing_component_credit_id': 'str' + } + if hasattr(SubscriptionCharge, "swagger_types"): + swagger_types.update(SubscriptionCharge.swagger_types) + + attribute_map = { + 'pricing_component_id': 'pricingComponentID', + 'public_pricing_component_name': 'publicPricingComponentName', + 'pricing_component_name': 'pricingComponentName', + 'pricing_component_value': 'pricingComponentValue', + 'coupon_definition_id': 'couponDefinitionID', + 'coupon_instance_id': 'couponInstanceID', + 'coupon_modifier_id': 'couponModifierID', + 'originating_charge_id': 'originatingChargeID', + 'coupon_code': 'couponCode', + 'coupon_type': 'couponType', + 'pricing_component_credit_id': 'pricingComponentCreditID' + } + if hasattr(SubscriptionCharge, "attribute_map"): + attribute_map.update(SubscriptionCharge.attribute_map) + + def __init__(self, pricing_component_id=None, public_pricing_component_name=None, pricing_component_name=None, pricing_component_value=None, coupon_definition_id=None, coupon_instance_id=None, coupon_modifier_id=None, originating_charge_id=None, coupon_code=None, coupon_type=None, pricing_component_credit_id=None, *args, **kwargs): # noqa: E501 + """CouponCharge - a model defined in Swagger""" # noqa: E501 + self._pricing_component_id = None + self._public_pricing_component_name = None + self._pricing_component_name = None + self._pricing_component_value = None + self._coupon_definition_id = None + self._coupon_instance_id = None + self._coupon_modifier_id = None + self._originating_charge_id = None + self._coupon_code = None + self._coupon_type = None + self._pricing_component_credit_id = None + self.discriminator = None + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + if public_pricing_component_name is not None: + self.public_pricing_component_name = public_pricing_component_name + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if pricing_component_value is not None: + self.pricing_component_value = pricing_component_value + if coupon_definition_id is not None: + self.coupon_definition_id = coupon_definition_id + if coupon_instance_id is not None: + self.coupon_instance_id = coupon_instance_id + if coupon_modifier_id is not None: + self.coupon_modifier_id = coupon_modifier_id + if originating_charge_id is not None: + self.originating_charge_id = originating_charge_id + if coupon_code is not None: + self.coupon_code = coupon_code + if coupon_type is not None: + self.coupon_type = coupon_type + if pricing_component_credit_id is not None: + self.pricing_component_credit_id = pricing_component_credit_id + SubscriptionCharge.__init__(self, *args, **kwargs) + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this CouponCharge. # noqa: E501 + + + :return: The pricing_component_id of this CouponCharge. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this CouponCharge. + + + :param pricing_component_id: The pricing_component_id of this CouponCharge. # noqa: E501 + :type: str + """ + + self._pricing_component_id = pricing_component_id + + @property + def public_pricing_component_name(self): + """Gets the public_pricing_component_name of this CouponCharge. # noqa: E501 + + + :return: The public_pricing_component_name of this CouponCharge. # noqa: E501 + :rtype: str + """ + return self._public_pricing_component_name + + @public_pricing_component_name.setter + def public_pricing_component_name(self, public_pricing_component_name): + """Sets the public_pricing_component_name of this CouponCharge. + + + :param public_pricing_component_name: The public_pricing_component_name of this CouponCharge. # noqa: E501 + :type: str + """ + + self._public_pricing_component_name = public_pricing_component_name + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this CouponCharge. # noqa: E501 + + + :return: The pricing_component_name of this CouponCharge. # noqa: E501 + :rtype: str + """ + return self._pricing_component_name + + @pricing_component_name.setter + def pricing_component_name(self, pricing_component_name): + """Sets the pricing_component_name of this CouponCharge. + + + :param pricing_component_name: The pricing_component_name of this CouponCharge. # noqa: E501 + :type: str + """ + + self._pricing_component_name = pricing_component_name + + @property + def pricing_component_value(self): + """Gets the pricing_component_value of this CouponCharge. # noqa: E501 + + + :return: The pricing_component_value of this CouponCharge. # noqa: E501 + :rtype: int + """ + return self._pricing_component_value + + @pricing_component_value.setter + def pricing_component_value(self, pricing_component_value): + """Sets the pricing_component_value of this CouponCharge. + + + :param pricing_component_value: The pricing_component_value of this CouponCharge. # noqa: E501 + :type: int + """ + + self._pricing_component_value = pricing_component_value + + @property + def coupon_definition_id(self): + """Gets the coupon_definition_id of this CouponCharge. # noqa: E501 + + + :return: The coupon_definition_id of this CouponCharge. # noqa: E501 + :rtype: str + """ + return self._coupon_definition_id + + @coupon_definition_id.setter + def coupon_definition_id(self, coupon_definition_id): + """Sets the coupon_definition_id of this CouponCharge. + + + :param coupon_definition_id: The coupon_definition_id of this CouponCharge. # noqa: E501 + :type: str + """ + + self._coupon_definition_id = coupon_definition_id + + @property + def coupon_instance_id(self): + """Gets the coupon_instance_id of this CouponCharge. # noqa: E501 + + + :return: The coupon_instance_id of this CouponCharge. # noqa: E501 + :rtype: str + """ + return self._coupon_instance_id + + @coupon_instance_id.setter + def coupon_instance_id(self, coupon_instance_id): + """Sets the coupon_instance_id of this CouponCharge. + + + :param coupon_instance_id: The coupon_instance_id of this CouponCharge. # noqa: E501 + :type: str + """ + + self._coupon_instance_id = coupon_instance_id + + @property + def coupon_modifier_id(self): + """Gets the coupon_modifier_id of this CouponCharge. # noqa: E501 + + + :return: The coupon_modifier_id of this CouponCharge. # noqa: E501 + :rtype: str + """ + return self._coupon_modifier_id + + @coupon_modifier_id.setter + def coupon_modifier_id(self, coupon_modifier_id): + """Sets the coupon_modifier_id of this CouponCharge. + + + :param coupon_modifier_id: The coupon_modifier_id of this CouponCharge. # noqa: E501 + :type: str + """ + + self._coupon_modifier_id = coupon_modifier_id + + @property + def originating_charge_id(self): + """Gets the originating_charge_id of this CouponCharge. # noqa: E501 + + + :return: The originating_charge_id of this CouponCharge. # noqa: E501 + :rtype: str + """ + return self._originating_charge_id + + @originating_charge_id.setter + def originating_charge_id(self, originating_charge_id): + """Sets the originating_charge_id of this CouponCharge. + + + :param originating_charge_id: The originating_charge_id of this CouponCharge. # noqa: E501 + :type: str + """ + + self._originating_charge_id = originating_charge_id + + @property + def coupon_code(self): + """Gets the coupon_code of this CouponCharge. # noqa: E501 + + + :return: The coupon_code of this CouponCharge. # noqa: E501 + :rtype: str + """ + return self._coupon_code + + @coupon_code.setter + def coupon_code(self, coupon_code): + """Sets the coupon_code of this CouponCharge. + + + :param coupon_code: The coupon_code of this CouponCharge. # noqa: E501 + :type: str + """ + + self._coupon_code = coupon_code + + @property + def coupon_type(self): + """Gets the coupon_type of this CouponCharge. # noqa: E501 + + + :return: The coupon_type of this CouponCharge. # noqa: E501 + :rtype: str + """ + return self._coupon_type + + @coupon_type.setter + def coupon_type(self, coupon_type): + """Sets the coupon_type of this CouponCharge. + + + :param coupon_type: The coupon_type of this CouponCharge. # noqa: E501 + :type: str + """ + allowed_values = ["Coupon", "PricingComponentUnitCredit"] # noqa: E501 + if coupon_type not in allowed_values: + raise ValueError( + "Invalid value for `coupon_type` ({0}), must be one of {1}" # noqa: E501 + .format(coupon_type, allowed_values) + ) + + self._coupon_type = coupon_type + + @property + def pricing_component_credit_id(self): + """Gets the pricing_component_credit_id of this CouponCharge. # noqa: E501 + + + :return: The pricing_component_credit_id of this CouponCharge. # noqa: E501 + :rtype: str + """ + return self._pricing_component_credit_id + + @pricing_component_credit_id.setter + def pricing_component_credit_id(self, pricing_component_credit_id): + """Sets the pricing_component_credit_id of this CouponCharge. + + + :param pricing_component_credit_id: The pricing_component_credit_id of this CouponCharge. # noqa: E501 + :type: str + """ + + self._pricing_component_credit_id = pricing_component_credit_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CouponCharge, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CouponCharge): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/coupon_code_response.py b/billforward/models/coupon_code_response.py new file mode 100644 index 0000000..c98cc17 --- /dev/null +++ b/billforward/models/coupon_code_response.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CouponCodeResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'codes_yet_to_be_generated': 'int', + 'organization_id': 'str', + 'codes': 'list[CouponUniqueCodesResponse]' + } + + attribute_map = { + 'created': 'created', + 'codes_yet_to_be_generated': 'codesYetToBeGenerated', + 'organization_id': 'organizationID', + 'codes': 'codes' + } + + def __init__(self, created=None, codes_yet_to_be_generated=None, organization_id=None, codes=None): # noqa: E501 + """CouponCodeResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._codes_yet_to_be_generated = None + self._organization_id = None + self._codes = None + self.discriminator = None + if created is not None: + self.created = created + if codes_yet_to_be_generated is not None: + self.codes_yet_to_be_generated = codes_yet_to_be_generated + if organization_id is not None: + self.organization_id = organization_id + if codes is not None: + self.codes = codes + + @property + def created(self): + """Gets the created of this CouponCodeResponse. # noqa: E501 + + + :return: The created of this CouponCodeResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this CouponCodeResponse. + + + :param created: The created of this CouponCodeResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def codes_yet_to_be_generated(self): + """Gets the codes_yet_to_be_generated of this CouponCodeResponse. # noqa: E501 + + + :return: The codes_yet_to_be_generated of this CouponCodeResponse. # noqa: E501 + :rtype: int + """ + return self._codes_yet_to_be_generated + + @codes_yet_to_be_generated.setter + def codes_yet_to_be_generated(self, codes_yet_to_be_generated): + """Sets the codes_yet_to_be_generated of this CouponCodeResponse. + + + :param codes_yet_to_be_generated: The codes_yet_to_be_generated of this CouponCodeResponse. # noqa: E501 + :type: int + """ + + self._codes_yet_to_be_generated = codes_yet_to_be_generated + + @property + def organization_id(self): + """Gets the organization_id of this CouponCodeResponse. # noqa: E501 + + + :return: The organization_id of this CouponCodeResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CouponCodeResponse. + + + :param organization_id: The organization_id of this CouponCodeResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def codes(self): + """Gets the codes of this CouponCodeResponse. # noqa: E501 + + + :return: The codes of this CouponCodeResponse. # noqa: E501 + :rtype: list[CouponUniqueCodesResponse] + """ + return self._codes + + @codes.setter + def codes(self, codes): + """Sets the codes of this CouponCodeResponse. + + + :param codes: The codes of this CouponCodeResponse. # noqa: E501 + :type: list[CouponUniqueCodesResponse] + """ + + self._codes = codes + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CouponCodeResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CouponCodeResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/coupon_definition.py b/billforward/models/coupon_definition.py deleted file mode 100644 index 237752d..0000000 --- a/billforward/models/coupon_definition.py +++ /dev/null @@ -1,610 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponDefinition(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, crm_id=None, organization_id=None, name=None, description=None, customer_code=None, target=None, currency=None, definition_valid_from=None, definition_valid_till=None, instance_duration_period=None, instance_duration=None, fixed_end_date=None, state=None, modifiers=None, rules=None): - """ - CouponDefinition - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'crm_id': 'str', - 'organization_id': 'str', - 'name': 'str', - 'description': 'str', - 'customer_code': 'str', - 'target': 'str', - 'currency': 'str', - 'definition_valid_from': 'datetime', - 'definition_valid_till': 'datetime', - 'instance_duration_period': 'str', - 'instance_duration': 'int', - 'fixed_end_date': 'datetime', - 'state': 'str', - 'modifiers': 'list[CouponModifierBase]', - 'rules': 'list[CouponRule]' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'crm_id': 'crmID', - 'organization_id': 'organizationID', - 'name': 'name', - 'description': 'description', - 'customer_code': 'customerCode', - 'target': 'target', - 'currency': 'currency', - 'definition_valid_from': 'definitionValidFrom', - 'definition_valid_till': 'definitionValidTill', - 'instance_duration_period': 'instanceDurationPeriod', - 'instance_duration': 'instanceDuration', - 'fixed_end_date': 'fixedEndDate', - 'state': 'state', - 'modifiers': 'modifiers', - 'rules': 'rules' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._crm_id = crm_id - self._organization_id = organization_id - self._name = name - self._description = description - self._customer_code = customer_code - self._target = target - self._currency = currency - self._definition_valid_from = definition_valid_from - self._definition_valid_till = definition_valid_till - self._instance_duration_period = instance_duration_period - self._instance_duration = instance_duration - self._fixed_end_date = fixed_end_date - self._state = state - self._modifiers = modifiers - self._rules = rules - - @property - def created(self): - """ - Gets the created of this CouponDefinition. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this CouponDefinition. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this CouponDefinition. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this CouponDefinition. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this CouponDefinition. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this CouponDefinition. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this CouponDefinition. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this CouponDefinition. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this CouponDefinition. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this CouponDefinition. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this CouponDefinition. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this CouponDefinition. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this CouponDefinition. - { \"description\" : \"ID of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this CouponDefinition. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this CouponDefinition. - { \"description\" : \"ID of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this CouponDefinition. - :type: str - """ - - self._id = id - - @property - def crm_id(self): - """ - Gets the crm_id of this CouponDefinition. - { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The crm_id of this CouponDefinition. - :rtype: str - """ - return self._crm_id - - @crm_id.setter - def crm_id(self, crm_id): - """ - Sets the crm_id of this CouponDefinition. - { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param crm_id: The crm_id of this CouponDefinition. - :type: str - """ - - self._crm_id = crm_id - - @property - def organization_id(self): - """ - Gets the organization_id of this CouponDefinition. - { \"description\" : \"ID of the organization associated with the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this CouponDefinition. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this CouponDefinition. - { \"description\" : \"ID of the organization associated with the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this CouponDefinition. - :type: str - """ - - self._organization_id = organization_id - - @property - def name(self): - """ - Gets the name of this CouponDefinition. - { \"description\" : \"The human readable name of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The name of this CouponDefinition. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this CouponDefinition. - { \"description\" : \"The human readable name of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param name: The name of this CouponDefinition. - :type: str - """ - - self._name = name - - @property - def description(self): - """ - Gets the description of this CouponDefinition. - { \"description\" : \"The human readable description of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The description of this CouponDefinition. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this CouponDefinition. - { \"description\" : \"The human readable description of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param description: The description of this CouponDefinition. - :type: str - """ - - self._description = description - - @property - def customer_code(self): - """ - Gets the customer_code of this CouponDefinition. - { \"description\" : \"The customerCode associated with the organization.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The customer_code of this CouponDefinition. - :rtype: str - """ - return self._customer_code - - @customer_code.setter - def customer_code(self, customer_code): - """ - Sets the customer_code of this CouponDefinition. - { \"description\" : \"The customerCode associated with the organization.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param customer_code: The customer_code of this CouponDefinition. - :type: str - """ - - self._customer_code = customer_code - - @property - def target(self): - """ - Gets the target of this CouponDefinition. - { \"description\" : \"The target of the coupon-definition. Currently coupon-definitions can only target products.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The target of this CouponDefinition. - :rtype: str - """ - return self._target - - @target.setter - def target(self, target): - """ - Sets the target of this CouponDefinition. - { \"description\" : \"The target of the coupon-definition. Currently coupon-definitions can only target products.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param target: The target of this CouponDefinition. - :type: str - """ - allowed_values = ["product", "account"] - if target not in allowed_values: - raise ValueError( - "Invalid value for `target` ({0}), must be one of {1}" - .format(target, allowed_values) - ) - - self._target = target - - @property - def currency(self): - """ - Gets the currency of this CouponDefinition. - { \"description\" : \"The currency of the coupon-definition specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The currency of this CouponDefinition. - :rtype: str - """ - return self._currency - - @currency.setter - def currency(self, currency): - """ - Sets the currency of this CouponDefinition. - { \"description\" : \"The currency of the coupon-definition specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param currency: The currency of this CouponDefinition. - :type: str - """ - - self._currency = currency - - @property - def definition_valid_from(self): - """ - Gets the definition_valid_from of this CouponDefinition. - { \"description\" : \"The UTC DateTime that the coupon-definition is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The definition_valid_from of this CouponDefinition. - :rtype: datetime - """ - return self._definition_valid_from - - @definition_valid_from.setter - def definition_valid_from(self, definition_valid_from): - """ - Sets the definition_valid_from of this CouponDefinition. - { \"description\" : \"The UTC DateTime that the coupon-definition is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param definition_valid_from: The definition_valid_from of this CouponDefinition. - :type: datetime - """ - - self._definition_valid_from = definition_valid_from - - @property - def definition_valid_till(self): - """ - Gets the definition_valid_till of this CouponDefinition. - { \"description\" : \"The UTC DateTime that the coupon-definition is valid until.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The definition_valid_till of this CouponDefinition. - :rtype: datetime - """ - return self._definition_valid_till - - @definition_valid_till.setter - def definition_valid_till(self, definition_valid_till): - """ - Sets the definition_valid_till of this CouponDefinition. - { \"description\" : \"The UTC DateTime that the coupon-definition is valid until.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param definition_valid_till: The definition_valid_till of this CouponDefinition. - :type: datetime - """ - - self._definition_valid_till = definition_valid_till - - @property - def instance_duration_period(self): - """ - Gets the instance_duration_period of this CouponDefinition. - { \"description\" : \"instanceDurationPeriod\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The instance_duration_period of this CouponDefinition. - :rtype: str - """ - return self._instance_duration_period - - @instance_duration_period.setter - def instance_duration_period(self, instance_duration_period): - """ - Sets the instance_duration_period of this CouponDefinition. - { \"description\" : \"instanceDurationPeriod\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param instance_duration_period: The instance_duration_period of this CouponDefinition. - :type: str - """ - allowed_values = ["minutes", "hours", "days", "months", "years", "periods"] - if instance_duration_period not in allowed_values: - raise ValueError( - "Invalid value for `instance_duration_period` ({0}), must be one of {1}" - .format(instance_duration_period, allowed_values) - ) - - self._instance_duration_period = instance_duration_period - - @property - def instance_duration(self): - """ - Gets the instance_duration of this CouponDefinition. - { \"description\" : \"instanceDuration\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The instance_duration of this CouponDefinition. - :rtype: int - """ - return self._instance_duration - - @instance_duration.setter - def instance_duration(self, instance_duration): - """ - Sets the instance_duration of this CouponDefinition. - { \"description\" : \"instanceDuration\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param instance_duration: The instance_duration of this CouponDefinition. - :type: int - """ - - self._instance_duration = instance_duration - - @property - def fixed_end_date(self): - """ - Gets the fixed_end_date of this CouponDefinition. - { \"description\" : \"The UTC DateTime specifying the fixed end date of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The fixed_end_date of this CouponDefinition. - :rtype: datetime - """ - return self._fixed_end_date - - @fixed_end_date.setter - def fixed_end_date(self, fixed_end_date): - """ - Sets the fixed_end_date of this CouponDefinition. - { \"description\" : \"The UTC DateTime specifying the fixed end date of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param fixed_end_date: The fixed_end_date of this CouponDefinition. - :type: datetime - """ - - self._fixed_end_date = fixed_end_date - - @property - def state(self): - """ - Gets the state of this CouponDefinition. - { \"description\" : \"The current state of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The state of this CouponDefinition. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this CouponDefinition. - { \"description\" : \"The current state of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param state: The state of this CouponDefinition. - :type: str - """ - allowed_values = ["development", "production", "deleted"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def modifiers(self): - """ - Gets the modifiers of this CouponDefinition. - { \"description\" : \"The collection of coupon-modifiers associated with the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The modifiers of this CouponDefinition. - :rtype: list[CouponModifierBase] - """ - return self._modifiers - - @modifiers.setter - def modifiers(self, modifiers): - """ - Sets the modifiers of this CouponDefinition. - { \"description\" : \"The collection of coupon-modifiers associated with the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param modifiers: The modifiers of this CouponDefinition. - :type: list[CouponModifierBase] - """ - - self._modifiers = modifiers - - @property - def rules(self): - """ - Gets the rules of this CouponDefinition. - { \"description\" : \"The collection of coupon-rules associated with the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The rules of this CouponDefinition. - :rtype: list[CouponRule] - """ - return self._rules - - @rules.setter - def rules(self, rules): - """ - Sets the rules of this CouponDefinition. - { \"description\" : \"The collection of coupon-rules associated with the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param rules: The rules of this CouponDefinition. - :type: list[CouponRule] - """ - - self._rules = rules - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_definition_paged_metadata.py b/billforward/models/coupon_definition_paged_metadata.py deleted file mode 100644 index c986e77..0000000 --- a/billforward/models/coupon_definition_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponDefinitionPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - CouponDefinitionPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[CouponDefinition]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this CouponDefinitionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this CouponDefinitionPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this CouponDefinitionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this CouponDefinitionPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this CouponDefinitionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this CouponDefinitionPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this CouponDefinitionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this CouponDefinitionPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this CouponDefinitionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this CouponDefinitionPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this CouponDefinitionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this CouponDefinitionPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this CouponDefinitionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this CouponDefinitionPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this CouponDefinitionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this CouponDefinitionPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this CouponDefinitionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this CouponDefinitionPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this CouponDefinitionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this CouponDefinitionPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this CouponDefinitionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this CouponDefinitionPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this CouponDefinitionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this CouponDefinitionPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this CouponDefinitionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this CouponDefinitionPagedMetadata. - :rtype: list[CouponDefinition] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this CouponDefinitionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this CouponDefinitionPagedMetadata. - :type: list[CouponDefinition] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_discount.py b/billforward/models/coupon_discount.py index 46aff96..07e6b98 100644 --- a/billforward/models/coupon_discount.py +++ b/billforward/models/coupon_discount.py @@ -1,103 +1,128 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class CouponDiscount(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, pricing_component=None, pricing_component_name=None, pricing_component_id=None, unit_of_measure_name=None, unit_of_measure_id=None, units_free=None, percentage_discount=None, cash_discount=None): - """ - CouponDiscount - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'pricing_component': 'str', - 'pricing_component_name': 'str', - 'pricing_component_id': 'str', - 'unit_of_measure_name': 'str', - 'unit_of_measure_id': 'str', - 'units_free': 'int', - 'percentage_discount': 'float', - 'cash_discount': 'float' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'pricing_component': 'pricingComponent', - 'pricing_component_name': 'pricingComponentName', - 'pricing_component_id': 'pricingComponentID', - 'unit_of_measure_name': 'unitOfMeasureName', - 'unit_of_measure_id': 'unitOfMeasureID', - 'units_free': 'unitsFree', - 'percentage_discount': 'percentageDiscount', - 'cash_discount': 'cashDiscount' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._pricing_component = pricing_component - self._pricing_component_name = pricing_component_name - self._pricing_component_id = pricing_component_id - self._unit_of_measure_name = unit_of_measure_name - self._unit_of_measure_id = unit_of_measure_id - self._units_free = units_free - self._percentage_discount = percentage_discount - self._cash_discount = cash_discount + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'pricing_component': 'str', + 'pricing_component_name': 'str', + 'pricing_component_id': 'str', + 'unit_of_measure_name': 'str', + 'unit_of_measure_id': 'str', + 'units_free': 'int', + 'percentage_discount': 'float', + 'cash_discount': 'float', + 'tax_code': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'pricing_component': 'pricingComponent', + 'pricing_component_name': 'pricingComponentName', + 'pricing_component_id': 'pricingComponentID', + 'unit_of_measure_name': 'unitOfMeasureName', + 'unit_of_measure_id': 'unitOfMeasureID', + 'units_free': 'unitsFree', + 'percentage_discount': 'percentageDiscount', + 'cash_discount': 'cashDiscount', + 'tax_code': 'taxCode', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, pricing_component=None, pricing_component_name=None, pricing_component_id=None, unit_of_measure_name=None, unit_of_measure_id=None, units_free=None, percentage_discount=None, cash_discount=None, tax_code=None, organization_id=None): # noqa: E501 + """CouponDiscount - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._pricing_component = None + self._pricing_component_name = None + self._pricing_component_id = None + self._unit_of_measure_name = None + self._unit_of_measure_id = None + self._units_free = None + self._percentage_discount = None + self._cash_discount = None + self._tax_code = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if pricing_component is not None: + self.pricing_component = pricing_component + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + if unit_of_measure_name is not None: + self.unit_of_measure_name = unit_of_measure_name + if unit_of_measure_id is not None: + self.unit_of_measure_id = unit_of_measure_id + if units_free is not None: + self.units_free = units_free + if percentage_discount is not None: + self.percentage_discount = percentage_discount + if cash_discount is not None: + self.cash_discount = cash_discount + if tax_code is not None: + self.tax_code = tax_code + if organization_id is not None: + self.organization_id = organization_id @property def created(self): - """ - Gets the created of this CouponDiscount. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this CouponDiscount. # noqa: E501 + - :return: The created of this CouponDiscount. + :return: The created of this CouponDiscount. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this CouponDiscount. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this CouponDiscount. + - :param created: The created of this CouponDiscount. + :param created: The created of this CouponDiscount. # noqa: E501 :type: datetime """ @@ -105,22 +130,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this CouponDiscount. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this CouponDiscount. # noqa: E501 - :return: The changed_by of this CouponDiscount. + + :return: The changed_by of this CouponDiscount. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this CouponDiscount. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this CouponDiscount. - :param changed_by: The changed_by of this CouponDiscount. + + :param changed_by: The changed_by of this CouponDiscount. # noqa: E501 :type: str """ @@ -128,45 +151,62 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this CouponDiscount. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this CouponDiscount. # noqa: E501 - :return: The updated of this CouponDiscount. + + :return: The updated of this CouponDiscount. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this CouponDiscount. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this CouponDiscount. + - :param updated: The updated of this CouponDiscount. + :param updated: The updated of this CouponDiscount. # noqa: E501 :type: datetime """ self._updated = updated @property - def pricing_component(self): + def id(self): + """Gets the id of this CouponDiscount. # noqa: E501 + + + :return: The id of this CouponDiscount. # noqa: E501 + :rtype: str """ - Gets the pricing_component of this CouponDiscount. - { \"description\" : \"Name or ID of the pricing component to apply the discount to. If not set blank discount is applied at the invoice level.\", \"verbs\":[\"POST\"] } + return self._id - :return: The pricing_component of this CouponDiscount. + @id.setter + def id(self, id): + """Sets the id of this CouponDiscount. + + + :param id: The id of this CouponDiscount. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def pricing_component(self): + """Gets the pricing_component of this CouponDiscount. # noqa: E501 + + + :return: The pricing_component of this CouponDiscount. # noqa: E501 :rtype: str """ return self._pricing_component @pricing_component.setter def pricing_component(self, pricing_component): - """ - Sets the pricing_component of this CouponDiscount. - { \"description\" : \"Name or ID of the pricing component to apply the discount to. If not set blank discount is applied at the invoice level.\", \"verbs\":[\"POST\"] } + """Sets the pricing_component of this CouponDiscount. + - :param pricing_component: The pricing_component of this CouponDiscount. + :param pricing_component: The pricing_component of this CouponDiscount. # noqa: E501 :type: str """ @@ -174,22 +214,20 @@ def pricing_component(self, pricing_component): @property def pricing_component_name(self): - """ - Gets the pricing_component_name of this CouponDiscount. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the pricing_component_name of this CouponDiscount. # noqa: E501 - :return: The pricing_component_name of this CouponDiscount. + + :return: The pricing_component_name of this CouponDiscount. # noqa: E501 :rtype: str """ return self._pricing_component_name @pricing_component_name.setter def pricing_component_name(self, pricing_component_name): - """ - Sets the pricing_component_name of this CouponDiscount. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the pricing_component_name of this CouponDiscount. + - :param pricing_component_name: The pricing_component_name of this CouponDiscount. + :param pricing_component_name: The pricing_component_name of this CouponDiscount. # noqa: E501 :type: str """ @@ -197,22 +235,20 @@ def pricing_component_name(self, pricing_component_name): @property def pricing_component_id(self): - """ - Gets the pricing_component_id of this CouponDiscount. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the pricing_component_id of this CouponDiscount. # noqa: E501 + - :return: The pricing_component_id of this CouponDiscount. + :return: The pricing_component_id of this CouponDiscount. # noqa: E501 :rtype: str """ return self._pricing_component_id @pricing_component_id.setter def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this CouponDiscount. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the pricing_component_id of this CouponDiscount. + - :param pricing_component_id: The pricing_component_id of this CouponDiscount. + :param pricing_component_id: The pricing_component_id of this CouponDiscount. # noqa: E501 :type: str """ @@ -220,22 +256,20 @@ def pricing_component_id(self, pricing_component_id): @property def unit_of_measure_name(self): - """ - Gets the unit_of_measure_name of this CouponDiscount. + """Gets the unit_of_measure_name of this CouponDiscount. # noqa: E501 - :return: The unit_of_measure_name of this CouponDiscount. + :return: The unit_of_measure_name of this CouponDiscount. # noqa: E501 :rtype: str """ return self._unit_of_measure_name @unit_of_measure_name.setter def unit_of_measure_name(self, unit_of_measure_name): - """ - Sets the unit_of_measure_name of this CouponDiscount. + """Sets the unit_of_measure_name of this CouponDiscount. - :param unit_of_measure_name: The unit_of_measure_name of this CouponDiscount. + :param unit_of_measure_name: The unit_of_measure_name of this CouponDiscount. # noqa: E501 :type: str """ @@ -243,22 +277,20 @@ def unit_of_measure_name(self, unit_of_measure_name): @property def unit_of_measure_id(self): - """ - Gets the unit_of_measure_id of this CouponDiscount. + """Gets the unit_of_measure_id of this CouponDiscount. # noqa: E501 - :return: The unit_of_measure_id of this CouponDiscount. + :return: The unit_of_measure_id of this CouponDiscount. # noqa: E501 :rtype: str """ return self._unit_of_measure_id @unit_of_measure_id.setter def unit_of_measure_id(self, unit_of_measure_id): - """ - Sets the unit_of_measure_id of this CouponDiscount. + """Sets the unit_of_measure_id of this CouponDiscount. - :param unit_of_measure_id: The unit_of_measure_id of this CouponDiscount. + :param unit_of_measure_id: The unit_of_measure_id of this CouponDiscount. # noqa: E501 :type: str """ @@ -266,22 +298,20 @@ def unit_of_measure_id(self, unit_of_measure_id): @property def units_free(self): - """ - Gets the units_free of this CouponDiscount. - { \"description\" : \"Number of units that are free for a pricing-component.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the units_free of this CouponDiscount. # noqa: E501 - :return: The units_free of this CouponDiscount. + + :return: The units_free of this CouponDiscount. # noqa: E501 :rtype: int """ return self._units_free @units_free.setter def units_free(self, units_free): - """ - Sets the units_free of this CouponDiscount. - { \"description\" : \"Number of units that are free for a pricing-component.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the units_free of this CouponDiscount. - :param units_free: The units_free of this CouponDiscount. + + :param units_free: The units_free of this CouponDiscount. # noqa: E501 :type: int """ @@ -289,22 +319,20 @@ def units_free(self, units_free): @property def percentage_discount(self): - """ - Gets the percentage_discount of this CouponDiscount. - { \"description\" : \"Percentage to be discounted\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the percentage_discount of this CouponDiscount. # noqa: E501 + - :return: The percentage_discount of this CouponDiscount. + :return: The percentage_discount of this CouponDiscount. # noqa: E501 :rtype: float """ return self._percentage_discount @percentage_discount.setter def percentage_discount(self, percentage_discount): - """ - Sets the percentage_discount of this CouponDiscount. - { \"description\" : \"Percentage to be discounted\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the percentage_discount of this CouponDiscount. + - :param percentage_discount: The percentage_discount of this CouponDiscount. + :param percentage_discount: The percentage_discount of this CouponDiscount. # noqa: E501 :type: float """ @@ -312,34 +340,72 @@ def percentage_discount(self, percentage_discount): @property def cash_discount(self): - """ - Gets the cash_discount of this CouponDiscount. - { \"description\" : \"Fixed monetary amount to be discounted\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the cash_discount of this CouponDiscount. # noqa: E501 + - :return: The cash_discount of this CouponDiscount. + :return: The cash_discount of this CouponDiscount. # noqa: E501 :rtype: float """ return self._cash_discount @cash_discount.setter def cash_discount(self, cash_discount): - """ - Sets the cash_discount of this CouponDiscount. - { \"description\" : \"Fixed monetary amount to be discounted\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the cash_discount of this CouponDiscount. + - :param cash_discount: The cash_discount of this CouponDiscount. + :param cash_discount: The cash_discount of this CouponDiscount. # noqa: E501 :type: float """ self._cash_discount = cash_discount - def to_dict(self): + @property + def tax_code(self): + """Gets the tax_code of this CouponDiscount. # noqa: E501 + + + :return: The tax_code of this CouponDiscount. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this CouponDiscount. + + + :param tax_code: The tax_code of this CouponDiscount. # noqa: E501 + :type: str + """ + + self._tax_code = tax_code + + @property + def organization_id(self): + """Gets the organization_id of this CouponDiscount. # noqa: E501 + + + :return: The organization_id of this CouponDiscount. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CouponDiscount. + + + :param organization_id: The organization_id of this CouponDiscount. # noqa: E501 + :type: str """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -356,29 +422,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CouponDiscount, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CouponDiscount): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/coupon_discount_estimate.py b/billforward/models/coupon_discount_estimate.py deleted file mode 100644 index 38d5c82..0000000 --- a/billforward/models/coupon_discount_estimate.py +++ /dev/null @@ -1,254 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponDiscountEstimate(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, unaltered_value=None, discount_value=None, affected_specifier_count=None, discount_start_value=None, discount_end_value=None, unit_discounts=None): - """ - CouponDiscountEstimate - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'unaltered_value': 'float', - 'discount_value': 'float', - 'affected_specifier_count': 'int', - 'discount_start_value': 'int', - 'discount_end_value': 'int', - 'unit_discounts': 'list[UnitDiscount]' - } - - self.attribute_map = { - 'unaltered_value': 'unalteredValue', - 'discount_value': 'discountValue', - 'affected_specifier_count': 'affectedSpecifierCount', - 'discount_start_value': 'discountStartValue', - 'discount_end_value': 'discountEndValue', - 'unit_discounts': 'unitDiscounts' - } - - self._unaltered_value = unaltered_value - self._discount_value = discount_value - self._affected_specifier_count = affected_specifier_count - self._discount_start_value = discount_start_value - self._discount_end_value = discount_end_value - self._unit_discounts = unit_discounts - - @property - def unaltered_value(self): - """ - Gets the unaltered_value of this CouponDiscountEstimate. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The unaltered_value of this CouponDiscountEstimate. - :rtype: float - """ - return self._unaltered_value - - @unaltered_value.setter - def unaltered_value(self, unaltered_value): - """ - Sets the unaltered_value of this CouponDiscountEstimate. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param unaltered_value: The unaltered_value of this CouponDiscountEstimate. - :type: float - """ - - self._unaltered_value = unaltered_value - - @property - def discount_value(self): - """ - Gets the discount_value of this CouponDiscountEstimate. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The discount_value of this CouponDiscountEstimate. - :rtype: float - """ - return self._discount_value - - @discount_value.setter - def discount_value(self, discount_value): - """ - Sets the discount_value of this CouponDiscountEstimate. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param discount_value: The discount_value of this CouponDiscountEstimate. - :type: float - """ - - self._discount_value = discount_value - - @property - def affected_specifier_count(self): - """ - Gets the affected_specifier_count of this CouponDiscountEstimate. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The affected_specifier_count of this CouponDiscountEstimate. - :rtype: int - """ - return self._affected_specifier_count - - @affected_specifier_count.setter - def affected_specifier_count(self, affected_specifier_count): - """ - Sets the affected_specifier_count of this CouponDiscountEstimate. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param affected_specifier_count: The affected_specifier_count of this CouponDiscountEstimate. - :type: int - """ - - self._affected_specifier_count = affected_specifier_count - - @property - def discount_start_value(self): - """ - Gets the discount_start_value of this CouponDiscountEstimate. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The discount_start_value of this CouponDiscountEstimate. - :rtype: int - """ - return self._discount_start_value - - @discount_start_value.setter - def discount_start_value(self, discount_start_value): - """ - Sets the discount_start_value of this CouponDiscountEstimate. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param discount_start_value: The discount_start_value of this CouponDiscountEstimate. - :type: int - """ - - self._discount_start_value = discount_start_value - - @property - def discount_end_value(self): - """ - Gets the discount_end_value of this CouponDiscountEstimate. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The discount_end_value of this CouponDiscountEstimate. - :rtype: int - """ - return self._discount_end_value - - @discount_end_value.setter - def discount_end_value(self, discount_end_value): - """ - Sets the discount_end_value of this CouponDiscountEstimate. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param discount_end_value: The discount_end_value of this CouponDiscountEstimate. - :type: int - """ - - self._discount_end_value = discount_end_value - - @property - def unit_discounts(self): - """ - Gets the unit_discounts of this CouponDiscountEstimate. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The unit_discounts of this CouponDiscountEstimate. - :rtype: list[UnitDiscount] - """ - return self._unit_discounts - - @unit_discounts.setter - def unit_discounts(self, unit_discounts): - """ - Sets the unit_discounts of this CouponDiscountEstimate. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param unit_discounts: The unit_discounts of this CouponDiscountEstimate. - :type: list[UnitDiscount] - """ - - self._unit_discounts = unit_discounts - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_instance.py b/billforward/models/coupon_instance.py index 96cbcd7..674e63f 100644 --- a/billforward/models/coupon_instance.py +++ b/billforward/models/coupon_instance.py @@ -1,219 +1,163 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class CouponInstance(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, target_id=None, coupon_code=None, date_initialised=None, valid_till=None, created=None, changed_by=None, updated=None, id=None, crm_id=None, organization_id=None, book_id=None, coupon_definition_id=None, target=None, periods_valid_for=None, total_periods=None, remaining_uses=None, instance_discount_value=None, max_remaining_uses=None, coupon_instance_existing_values=None): - """ - CouponInstance - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'target_id': 'str', - 'coupon_code': 'str', - 'date_initialised': 'datetime', - 'valid_till': 'datetime', - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'crm_id': 'str', - 'organization_id': 'str', - 'book_id': 'str', - 'coupon_definition_id': 'str', - 'target': 'str', - 'periods_valid_for': 'int', - 'total_periods': 'int', - 'remaining_uses': 'int', - 'instance_discount_value': 'float', - 'max_remaining_uses': 'int', - 'coupon_instance_existing_values': 'list[CouponInstanceExistingValue]' - } - - self.attribute_map = { - 'target_id': 'targetID', - 'coupon_code': 'couponCode', - 'date_initialised': 'dateInitialised', - 'valid_till': 'validTill', - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'crm_id': 'crmID', - 'organization_id': 'organizationID', - 'book_id': 'bookID', - 'coupon_definition_id': 'couponDefinitionID', - 'target': 'target', - 'periods_valid_for': 'periodsValidFor', - 'total_periods': 'totalPeriods', - 'remaining_uses': 'remainingUses', - 'instance_discount_value': 'instanceDiscountValue', - 'max_remaining_uses': 'maxRemainingUses', - 'coupon_instance_existing_values': 'couponInstanceExistingValues' - } - - self._target_id = target_id - self._coupon_code = coupon_code - self._date_initialised = date_initialised - self._valid_till = valid_till - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._crm_id = crm_id - self._organization_id = organization_id - self._book_id = book_id - self._coupon_definition_id = coupon_definition_id - self._target = target - self._periods_valid_for = periods_valid_for - self._total_periods = total_periods - self._remaining_uses = remaining_uses - self._instance_discount_value = instance_discount_value - self._max_remaining_uses = max_remaining_uses - self._coupon_instance_existing_values = coupon_instance_existing_values - - @property - def target_id(self): - """ - Gets the target_id of this CouponInstance. - { \"description\" : \"Target ID of the coupon-instance. If the target is subscription, this is the subscription's ID. If the target is account, this is the account's ID.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The target_id of this CouponInstance. - :rtype: str - """ - return self._target_id - - @target_id.setter - def target_id(self, target_id): - """ - Sets the target_id of this CouponInstance. - { \"description\" : \"Target ID of the coupon-instance. If the target is subscription, this is the subscription's ID. If the target is account, this is the account's ID.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param target_id: The target_id of this CouponInstance. - :type: str - """ - - self._target_id = target_id - - @property - def coupon_code(self): - """ - Gets the coupon_code of this CouponInstance. - { \"description\" : \"Code for the coupon. This code can be used to apply coupon-instances to subscriptions or accounts.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The coupon_code of this CouponInstance. - :rtype: str - """ - return self._coupon_code - - @coupon_code.setter - def coupon_code(self, coupon_code): - """ - Sets the coupon_code of this CouponInstance. - { \"description\" : \"Code for the coupon. This code can be used to apply coupon-instances to subscriptions or accounts.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param coupon_code: The coupon_code of this CouponInstance. - :type: str - """ - - self._coupon_code = coupon_code - - @property - def date_initialised(self): - """ - Gets the date_initialised of this CouponInstance. - { \"description\" : \"The UTC DateTime the coupon was initialised.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The date_initialised of this CouponInstance. - :rtype: datetime - """ - return self._date_initialised - - @date_initialised.setter - def date_initialised(self, date_initialised): - """ - Sets the date_initialised of this CouponInstance. - { \"description\" : \"The UTC DateTime the coupon was initialised.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param date_initialised: The date_initialised of this CouponInstance. - :type: datetime - """ - - self._date_initialised = date_initialised - - @property - def valid_till(self): - """ - Gets the valid_till of this CouponInstance. - { \"description\" : \"The UTC DateTime the coupon-instance is valid until.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The valid_till of this CouponInstance. - :rtype: datetime - """ - return self._valid_till - - @valid_till.setter - def valid_till(self, valid_till): - """ - Sets the valid_till of this CouponInstance. - { \"description\" : \"The UTC DateTime the coupon-instance is valid until.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param valid_till: The valid_till of this CouponInstance. - :type: datetime - """ - - self._valid_till = valid_till + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'crm_id': 'str', + 'organization_id': 'str', + 'book_id': 'str', + 'coupon_definition_id': 'str', + 'target_id': 'str', + 'target': 'str', + 'coupon_code': 'str', + 'issued_by': 'str', + 'periods_valid_for': 'int', + 'total_periods': 'int', + 'date_initialised': 'datetime', + 'valid_till': 'datetime', + 'remaining_uses': 'int', + 'instance_discount_value': 'float', + 'max_remaining_uses': 'int', + 'coupon_instance_existing_values': 'list[CouponInstanceExistingValue]', + 'final_period': 'int', + 'current_period': 'int' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'crm_id': 'crmID', + 'organization_id': 'organizationID', + 'book_id': 'bookID', + 'coupon_definition_id': 'couponDefinitionID', + 'target_id': 'targetID', + 'target': 'target', + 'coupon_code': 'couponCode', + 'issued_by': 'issuedBy', + 'periods_valid_for': 'periodsValidFor', + 'total_periods': 'totalPeriods', + 'date_initialised': 'dateInitialised', + 'valid_till': 'validTill', + 'remaining_uses': 'remainingUses', + 'instance_discount_value': 'instanceDiscountValue', + 'max_remaining_uses': 'maxRemainingUses', + 'coupon_instance_existing_values': 'couponInstanceExistingValues', + 'final_period': 'finalPeriod', + 'current_period': 'currentPeriod' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, crm_id=None, organization_id=None, book_id=None, coupon_definition_id=None, target_id=None, target=None, coupon_code=None, issued_by=None, periods_valid_for=None, total_periods=None, date_initialised=None, valid_till=None, remaining_uses=None, instance_discount_value=None, max_remaining_uses=None, coupon_instance_existing_values=None, final_period=None, current_period=None): # noqa: E501 + """CouponInstance - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._crm_id = None + self._organization_id = None + self._book_id = None + self._coupon_definition_id = None + self._target_id = None + self._target = None + self._coupon_code = None + self._issued_by = None + self._periods_valid_for = None + self._total_periods = None + self._date_initialised = None + self._valid_till = None + self._remaining_uses = None + self._instance_discount_value = None + self._max_remaining_uses = None + self._coupon_instance_existing_values = None + self._final_period = None + self._current_period = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if crm_id is not None: + self.crm_id = crm_id + self.organization_id = organization_id + self.book_id = book_id + self.coupon_definition_id = coupon_definition_id + if target_id is not None: + self.target_id = target_id + self.target = target + if coupon_code is not None: + self.coupon_code = coupon_code + if issued_by is not None: + self.issued_by = issued_by + if periods_valid_for is not None: + self.periods_valid_for = periods_valid_for + if total_periods is not None: + self.total_periods = total_periods + self.date_initialised = date_initialised + if valid_till is not None: + self.valid_till = valid_till + if remaining_uses is not None: + self.remaining_uses = remaining_uses + if instance_discount_value is not None: + self.instance_discount_value = instance_discount_value + if max_remaining_uses is not None: + self.max_remaining_uses = max_remaining_uses + if coupon_instance_existing_values is not None: + self.coupon_instance_existing_values = coupon_instance_existing_values + if final_period is not None: + self.final_period = final_period + if current_period is not None: + self.current_period = current_period @property def created(self): - """ - Gets the created of this CouponInstance. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this CouponInstance. # noqa: E501 + - :return: The created of this CouponInstance. + :return: The created of this CouponInstance. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this CouponInstance. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this CouponInstance. + - :param created: The created of this CouponInstance. + :param created: The created of this CouponInstance. # noqa: E501 :type: datetime """ @@ -221,22 +165,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this CouponInstance. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this CouponInstance. # noqa: E501 + - :return: The changed_by of this CouponInstance. + :return: The changed_by of this CouponInstance. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this CouponInstance. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this CouponInstance. + - :param changed_by: The changed_by of this CouponInstance. + :param changed_by: The changed_by of this CouponInstance. # noqa: E501 :type: str """ @@ -244,22 +186,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this CouponInstance. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this CouponInstance. # noqa: E501 - :return: The updated of this CouponInstance. + + :return: The updated of this CouponInstance. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this CouponInstance. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this CouponInstance. - :param updated: The updated of this CouponInstance. + + :param updated: The updated of this CouponInstance. # noqa: E501 :type: datetime """ @@ -267,22 +207,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this CouponInstance. - { \"description\" : \"ID of the coupon-instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the id of this CouponInstance. # noqa: E501 - :return: The id of this CouponInstance. + + :return: The id of this CouponInstance. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this CouponInstance. - { \"description\" : \"ID of the coupon-instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the id of this CouponInstance. - :param id: The id of this CouponInstance. + + :param id: The id of this CouponInstance. # noqa: E501 :type: str """ @@ -290,22 +228,20 @@ def id(self, id): @property def crm_id(self): - """ - Gets the crm_id of this CouponInstance. - { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the crm_id of this CouponInstance. # noqa: E501 - :return: The crm_id of this CouponInstance. + + :return: The crm_id of this CouponInstance. # noqa: E501 :rtype: str """ return self._crm_id @crm_id.setter def crm_id(self, crm_id): - """ - Sets the crm_id of this CouponInstance. - { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the crm_id of this CouponInstance. - :param crm_id: The crm_id of this CouponInstance. + + :param crm_id: The crm_id of this CouponInstance. # noqa: E501 :type: str """ @@ -313,120 +249,181 @@ def crm_id(self, crm_id): @property def organization_id(self): - """ - Gets the organization_id of this CouponInstance. - { \"description\" : \"Organization associated with the\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the organization_id of this CouponInstance. # noqa: E501 - :return: The organization_id of this CouponInstance. + + :return: The organization_id of this CouponInstance. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this CouponInstance. - { \"description\" : \"Organization associated with the\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the organization_id of this CouponInstance. - :param organization_id: The organization_id of this CouponInstance. + + :param organization_id: The organization_id of this CouponInstance. # noqa: E501 :type: str """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 self._organization_id = organization_id @property def book_id(self): - """ - Gets the book_id of this CouponInstance. - { \"description\" : \"ID of the coupon-book associated with the coupon-instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the book_id of this CouponInstance. # noqa: E501 - :return: The book_id of this CouponInstance. + + :return: The book_id of this CouponInstance. # noqa: E501 :rtype: str """ return self._book_id @book_id.setter def book_id(self, book_id): - """ - Sets the book_id of this CouponInstance. - { \"description\" : \"ID of the coupon-book associated with the coupon-instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the book_id of this CouponInstance. - :param book_id: The book_id of this CouponInstance. + + :param book_id: The book_id of this CouponInstance. # noqa: E501 :type: str """ + if book_id is None: + raise ValueError("Invalid value for `book_id`, must not be `None`") # noqa: E501 self._book_id = book_id @property def coupon_definition_id(self): - """ - Gets the coupon_definition_id of this CouponInstance. - { \"description\" : \"ID of the coupon-definition associated with the coupon-instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the coupon_definition_id of this CouponInstance. # noqa: E501 - :return: The coupon_definition_id of this CouponInstance. + + :return: The coupon_definition_id of this CouponInstance. # noqa: E501 :rtype: str """ return self._coupon_definition_id @coupon_definition_id.setter def coupon_definition_id(self, coupon_definition_id): - """ - Sets the coupon_definition_id of this CouponInstance. - { \"description\" : \"ID of the coupon-definition associated with the coupon-instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the coupon_definition_id of this CouponInstance. - :param coupon_definition_id: The coupon_definition_id of this CouponInstance. + + :param coupon_definition_id: The coupon_definition_id of this CouponInstance. # noqa: E501 :type: str """ + if coupon_definition_id is None: + raise ValueError("Invalid value for `coupon_definition_id`, must not be `None`") # noqa: E501 self._coupon_definition_id = coupon_definition_id @property - def target(self): + def target_id(self): + """Gets the target_id of this CouponInstance. # noqa: E501 + + + :return: The target_id of this CouponInstance. # noqa: E501 + :rtype: str + """ + return self._target_id + + @target_id.setter + def target_id(self, target_id): + """Sets the target_id of this CouponInstance. + + + :param target_id: The target_id of this CouponInstance. # noqa: E501 + :type: str """ - Gets the target of this CouponInstance. - { \"description\" : \"Ttype of the target for the coupon-instance. Used in combination with the targetID.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - :return: The target of this CouponInstance. + self._target_id = target_id + + @property + def target(self): + """Gets the target of this CouponInstance. # noqa: E501 + + + :return: The target of this CouponInstance. # noqa: E501 :rtype: str """ return self._target @target.setter def target(self, target): - """ - Sets the target of this CouponInstance. - { \"description\" : \"Ttype of the target for the coupon-instance. Used in combination with the targetID.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the target of this CouponInstance. - :param target: The target of this CouponInstance. + + :param target: The target of this CouponInstance. # noqa: E501 :type: str """ - allowed_values = ["none", "subscription", "account"] + if target is None: + raise ValueError("Invalid value for `target`, must not be `None`") # noqa: E501 + allowed_values = ["none", "subscription", "account"] # noqa: E501 if target not in allowed_values: raise ValueError( - "Invalid value for `target` ({0}), must be one of {1}" + "Invalid value for `target` ({0}), must be one of {1}" # noqa: E501 .format(target, allowed_values) ) self._target = target @property - def periods_valid_for(self): + def coupon_code(self): + """Gets the coupon_code of this CouponInstance. # noqa: E501 + + + :return: The coupon_code of this CouponInstance. # noqa: E501 + :rtype: str """ - Gets the periods_valid_for of this CouponInstance. - { \"description\" : \"Number of subscription periods the coupon is valid for. Unused.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + return self._coupon_code - :return: The periods_valid_for of this CouponInstance. + @coupon_code.setter + def coupon_code(self, coupon_code): + """Sets the coupon_code of this CouponInstance. + + + :param coupon_code: The coupon_code of this CouponInstance. # noqa: E501 + :type: str + """ + + self._coupon_code = coupon_code + + @property + def issued_by(self): + """Gets the issued_by of this CouponInstance. # noqa: E501 + + + :return: The issued_by of this CouponInstance. # noqa: E501 + :rtype: str + """ + return self._issued_by + + @issued_by.setter + def issued_by(self, issued_by): + """Sets the issued_by of this CouponInstance. + + + :param issued_by: The issued_by of this CouponInstance. # noqa: E501 + :type: str + """ + + self._issued_by = issued_by + + @property + def periods_valid_for(self): + """Gets the periods_valid_for of this CouponInstance. # noqa: E501 + + + :return: The periods_valid_for of this CouponInstance. # noqa: E501 :rtype: int """ return self._periods_valid_for @periods_valid_for.setter def periods_valid_for(self, periods_valid_for): - """ - Sets the periods_valid_for of this CouponInstance. - { \"description\" : \"Number of subscription periods the coupon is valid for. Unused.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the periods_valid_for of this CouponInstance. + - :param periods_valid_for: The periods_valid_for of this CouponInstance. + :param periods_valid_for: The periods_valid_for of this CouponInstance. # noqa: E501 :type: int """ @@ -434,45 +431,85 @@ def periods_valid_for(self, periods_valid_for): @property def total_periods(self): - """ - Gets the total_periods of this CouponInstance. - { \"description\" : \"Unused.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the total_periods of this CouponInstance. # noqa: E501 + - :return: The total_periods of this CouponInstance. + :return: The total_periods of this CouponInstance. # noqa: E501 :rtype: int """ return self._total_periods @total_periods.setter def total_periods(self, total_periods): - """ - Sets the total_periods of this CouponInstance. - { \"description\" : \"Unused.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the total_periods of this CouponInstance. + - :param total_periods: The total_periods of this CouponInstance. + :param total_periods: The total_periods of this CouponInstance. # noqa: E501 :type: int """ self._total_periods = total_periods @property - def remaining_uses(self): + def date_initialised(self): + """Gets the date_initialised of this CouponInstance. # noqa: E501 + + + :return: The date_initialised of this CouponInstance. # noqa: E501 + :rtype: datetime + """ + return self._date_initialised + + @date_initialised.setter + def date_initialised(self, date_initialised): + """Sets the date_initialised of this CouponInstance. + + + :param date_initialised: The date_initialised of this CouponInstance. # noqa: E501 + :type: datetime + """ + if date_initialised is None: + raise ValueError("Invalid value for `date_initialised`, must not be `None`") # noqa: E501 + + self._date_initialised = date_initialised + + @property + def valid_till(self): + """Gets the valid_till of this CouponInstance. # noqa: E501 + + + :return: The valid_till of this CouponInstance. # noqa: E501 + :rtype: datetime """ - Gets the remaining_uses of this CouponInstance. - { \"description\" : \"The number of remaining uses the coupon-instance has left.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + return self._valid_till + + @valid_till.setter + def valid_till(self, valid_till): + """Sets the valid_till of this CouponInstance. + + + :param valid_till: The valid_till of this CouponInstance. # noqa: E501 + :type: datetime + """ + + self._valid_till = valid_till + + @property + def remaining_uses(self): + """Gets the remaining_uses of this CouponInstance. # noqa: E501 + - :return: The remaining_uses of this CouponInstance. + :return: The remaining_uses of this CouponInstance. # noqa: E501 :rtype: int """ return self._remaining_uses @remaining_uses.setter def remaining_uses(self, remaining_uses): - """ - Sets the remaining_uses of this CouponInstance. - { \"description\" : \"The number of remaining uses the coupon-instance has left.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the remaining_uses of this CouponInstance. + - :param remaining_uses: The remaining_uses of this CouponInstance. + :param remaining_uses: The remaining_uses of this CouponInstance. # noqa: E501 :type: int """ @@ -480,22 +517,20 @@ def remaining_uses(self, remaining_uses): @property def instance_discount_value(self): - """ - Gets the instance_discount_value of this CouponInstance. - { \"description\" : \"(Optional) The value to be used for dynamic price calculation, if the coupon definition has an 'instance' or 'instance_percent' coupon modifier. If it is not set, the effect amount of the coupon modifier will be used.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the instance_discount_value of this CouponInstance. # noqa: E501 + - :return: The instance_discount_value of this CouponInstance. + :return: The instance_discount_value of this CouponInstance. # noqa: E501 :rtype: float """ return self._instance_discount_value @instance_discount_value.setter def instance_discount_value(self, instance_discount_value): - """ - Sets the instance_discount_value of this CouponInstance. - { \"description\" : \"(Optional) The value to be used for dynamic price calculation, if the coupon definition has an 'instance' or 'instance_percent' coupon modifier. If it is not set, the effect amount of the coupon modifier will be used.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the instance_discount_value of this CouponInstance. + - :param instance_discount_value: The instance_discount_value of this CouponInstance. + :param instance_discount_value: The instance_discount_value of this CouponInstance. # noqa: E501 :type: float """ @@ -503,22 +538,20 @@ def instance_discount_value(self, instance_discount_value): @property def max_remaining_uses(self): - """ - Gets the max_remaining_uses of this CouponInstance. - { \"description\" : \"The number of remaining uses the coupon-instance had upon initialisation.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the max_remaining_uses of this CouponInstance. # noqa: E501 + - :return: The max_remaining_uses of this CouponInstance. + :return: The max_remaining_uses of this CouponInstance. # noqa: E501 :rtype: int """ return self._max_remaining_uses @max_remaining_uses.setter def max_remaining_uses(self, max_remaining_uses): - """ - Sets the max_remaining_uses of this CouponInstance. - { \"description\" : \"The number of remaining uses the coupon-instance had upon initialisation.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the max_remaining_uses of this CouponInstance. + - :param max_remaining_uses: The max_remaining_uses of this CouponInstance. + :param max_remaining_uses: The max_remaining_uses of this CouponInstance. # noqa: E501 :type: int """ @@ -526,34 +559,72 @@ def max_remaining_uses(self, max_remaining_uses): @property def coupon_instance_existing_values(self): - """ - Gets the coupon_instance_existing_values of this CouponInstance. - { \"description\" : \"The collection of coupon-instance-existing-value objects associated with the coupon-instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the coupon_instance_existing_values of this CouponInstance. # noqa: E501 + - :return: The coupon_instance_existing_values of this CouponInstance. + :return: The coupon_instance_existing_values of this CouponInstance. # noqa: E501 :rtype: list[CouponInstanceExistingValue] """ return self._coupon_instance_existing_values @coupon_instance_existing_values.setter def coupon_instance_existing_values(self, coupon_instance_existing_values): - """ - Sets the coupon_instance_existing_values of this CouponInstance. - { \"description\" : \"The collection of coupon-instance-existing-value objects associated with the coupon-instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the coupon_instance_existing_values of this CouponInstance. + - :param coupon_instance_existing_values: The coupon_instance_existing_values of this CouponInstance. + :param coupon_instance_existing_values: The coupon_instance_existing_values of this CouponInstance. # noqa: E501 :type: list[CouponInstanceExistingValue] """ self._coupon_instance_existing_values = coupon_instance_existing_values - def to_dict(self): + @property + def final_period(self): + """Gets the final_period of this CouponInstance. # noqa: E501 + + + :return: The final_period of this CouponInstance. # noqa: E501 + :rtype: int """ - Returns the model properties as a dict + return self._final_period + + @final_period.setter + def final_period(self, final_period): + """Sets the final_period of this CouponInstance. + + + :param final_period: The final_period of this CouponInstance. # noqa: E501 + :type: int """ + + self._final_period = final_period + + @property + def current_period(self): + """Gets the current_period of this CouponInstance. # noqa: E501 + + + :return: The current_period of this CouponInstance. # noqa: E501 + :rtype: int + """ + return self._current_period + + @current_period.setter + def current_period(self, current_period): + """Sets the current_period of this CouponInstance. + + + :param current_period: The current_period of this CouponInstance. # noqa: E501 + :type: int + """ + + self._current_period = current_period + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -570,29 +641,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CouponInstance, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CouponInstance): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/coupon_instance_existing_value.py b/billforward/models/coupon_instance_existing_value.py index bf841e4..3eb0a52 100644 --- a/billforward/models/coupon_instance_existing_value.py +++ b/billforward/models/coupon_instance_existing_value.py @@ -1,94 +1,101 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class CouponInstanceExistingValue(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, coupon_instance_id=None, logical_component_id=None, existing_value=None): - """ - CouponInstanceExistingValue - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'coupon_instance_id': 'str', - 'logical_component_id': 'str', - 'existing_value': 'int' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'coupon_instance_id': 'couponInstanceID', - 'logical_component_id': 'logicalComponentID', - 'existing_value': 'existingValue' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._coupon_instance_id = coupon_instance_id - self._logical_component_id = logical_component_id - self._existing_value = existing_value + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'coupon_instance_id': 'str', + 'logical_component_id': 'str', + 'existing_value': 'int', + 'pricing_component': 'PricingComponent' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'coupon_instance_id': 'couponInstanceID', + 'logical_component_id': 'logicalComponentID', + 'existing_value': 'existingValue', + 'pricing_component': 'pricingComponent' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, coupon_instance_id=None, logical_component_id=None, existing_value=None, pricing_component=None): # noqa: E501 + """CouponInstanceExistingValue - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._coupon_instance_id = None + self._logical_component_id = None + self._existing_value = None + self._pricing_component = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if coupon_instance_id is not None: + self.coupon_instance_id = coupon_instance_id + self.logical_component_id = logical_component_id + self.existing_value = existing_value + if pricing_component is not None: + self.pricing_component = pricing_component @property def created(self): - """ - Gets the created of this CouponInstanceExistingValue. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this CouponInstanceExistingValue. # noqa: E501 + - :return: The created of this CouponInstanceExistingValue. + :return: The created of this CouponInstanceExistingValue. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this CouponInstanceExistingValue. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this CouponInstanceExistingValue. + - :param created: The created of this CouponInstanceExistingValue. + :param created: The created of this CouponInstanceExistingValue. # noqa: E501 :type: datetime """ @@ -96,22 +103,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this CouponInstanceExistingValue. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this CouponInstanceExistingValue. # noqa: E501 + - :return: The changed_by of this CouponInstanceExistingValue. + :return: The changed_by of this CouponInstanceExistingValue. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this CouponInstanceExistingValue. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this CouponInstanceExistingValue. + - :param changed_by: The changed_by of this CouponInstanceExistingValue. + :param changed_by: The changed_by of this CouponInstanceExistingValue. # noqa: E501 :type: str """ @@ -119,22 +124,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this CouponInstanceExistingValue. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this CouponInstanceExistingValue. # noqa: E501 + - :return: The updated of this CouponInstanceExistingValue. + :return: The updated of this CouponInstanceExistingValue. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this CouponInstanceExistingValue. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this CouponInstanceExistingValue. + - :param updated: The updated of this CouponInstanceExistingValue. + :param updated: The updated of this CouponInstanceExistingValue. # noqa: E501 :type: datetime """ @@ -142,22 +145,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this CouponInstanceExistingValue. - { \"description\" : \"ID of the coupon-instance-existing-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the id of this CouponInstanceExistingValue. # noqa: E501 + - :return: The id of this CouponInstanceExistingValue. + :return: The id of this CouponInstanceExistingValue. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this CouponInstanceExistingValue. - { \"description\" : \"ID of the coupon-instance-existing-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the id of this CouponInstanceExistingValue. + - :param id: The id of this CouponInstanceExistingValue. + :param id: The id of this CouponInstanceExistingValue. # noqa: E501 :type: str """ @@ -165,22 +166,20 @@ def id(self, id): @property def organization_id(self): - """ - Gets the organization_id of this CouponInstanceExistingValue. - { \"description\" : \"ID of the organization associated with the coupon-existing-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the organization_id of this CouponInstanceExistingValue. # noqa: E501 + - :return: The organization_id of this CouponInstanceExistingValue. + :return: The organization_id of this CouponInstanceExistingValue. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this CouponInstanceExistingValue. - { \"description\" : \"ID of the organization associated with the coupon-existing-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the organization_id of this CouponInstanceExistingValue. - :param organization_id: The organization_id of this CouponInstanceExistingValue. + + :param organization_id: The organization_id of this CouponInstanceExistingValue. # noqa: E501 :type: str """ @@ -188,22 +187,20 @@ def organization_id(self, organization_id): @property def coupon_instance_id(self): - """ - Gets the coupon_instance_id of this CouponInstanceExistingValue. - { \"description\" : \"The string ID of the coupon-instance associated with the coupon-instance-existing-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the coupon_instance_id of this CouponInstanceExistingValue. # noqa: E501 - :return: The coupon_instance_id of this CouponInstanceExistingValue. + + :return: The coupon_instance_id of this CouponInstanceExistingValue. # noqa: E501 :rtype: str """ return self._coupon_instance_id @coupon_instance_id.setter def coupon_instance_id(self, coupon_instance_id): - """ - Sets the coupon_instance_id of this CouponInstanceExistingValue. - { \"description\" : \"The string ID of the coupon-instance associated with the coupon-instance-existing-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the coupon_instance_id of this CouponInstanceExistingValue. - :param coupon_instance_id: The coupon_instance_id of this CouponInstanceExistingValue. + + :param coupon_instance_id: The coupon_instance_id of this CouponInstanceExistingValue. # noqa: E501 :type: str """ @@ -211,57 +208,76 @@ def coupon_instance_id(self, coupon_instance_id): @property def logical_component_id(self): - """ - Gets the logical_component_id of this CouponInstanceExistingValue. - { \"description\" : \"The consistent string ID of the pricing-component associated with the coupon-instance-existing-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the logical_component_id of this CouponInstanceExistingValue. # noqa: E501 - :return: The logical_component_id of this CouponInstanceExistingValue. + + :return: The logical_component_id of this CouponInstanceExistingValue. # noqa: E501 :rtype: str """ return self._logical_component_id @logical_component_id.setter def logical_component_id(self, logical_component_id): - """ - Sets the logical_component_id of this CouponInstanceExistingValue. - { \"description\" : \"The consistent string ID of the pricing-component associated with the coupon-instance-existing-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the logical_component_id of this CouponInstanceExistingValue. + - :param logical_component_id: The logical_component_id of this CouponInstanceExistingValue. + :param logical_component_id: The logical_component_id of this CouponInstanceExistingValue. # noqa: E501 :type: str """ + if logical_component_id is None: + raise ValueError("Invalid value for `logical_component_id`, must not be `None`") # noqa: E501 self._logical_component_id = logical_component_id @property def existing_value(self): - """ - Gets the existing_value of this CouponInstanceExistingValue. - { \"description\" : \"The existing value\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the existing_value of this CouponInstanceExistingValue. # noqa: E501 + - :return: The existing_value of this CouponInstanceExistingValue. + :return: The existing_value of this CouponInstanceExistingValue. # noqa: E501 :rtype: int """ return self._existing_value @existing_value.setter def existing_value(self, existing_value): - """ - Sets the existing_value of this CouponInstanceExistingValue. - { \"description\" : \"The existing value\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the existing_value of this CouponInstanceExistingValue. + - :param existing_value: The existing_value of this CouponInstanceExistingValue. + :param existing_value: The existing_value of this CouponInstanceExistingValue. # noqa: E501 :type: int """ + if existing_value is None: + raise ValueError("Invalid value for `existing_value`, must not be `None`") # noqa: E501 self._existing_value = existing_value - def to_dict(self): + @property + def pricing_component(self): + """Gets the pricing_component of this CouponInstanceExistingValue. # noqa: E501 + + + :return: The pricing_component of this CouponInstanceExistingValue. # noqa: E501 + :rtype: PricingComponent """ - Returns the model properties as a dict + return self._pricing_component + + @pricing_component.setter + def pricing_component(self, pricing_component): + """Sets the pricing_component of this CouponInstanceExistingValue. + + + :param pricing_component: The pricing_component of this CouponInstanceExistingValue. # noqa: E501 + :type: PricingComponent """ + + self._pricing_component = pricing_component + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -278,29 +294,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CouponInstanceExistingValue, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CouponInstanceExistingValue): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/coupon_instance_paged_metadata.py b/billforward/models/coupon_instance_paged_metadata.py deleted file mode 100644 index 4da19e2..0000000 --- a/billforward/models/coupon_instance_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponInstancePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - CouponInstancePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[CouponInstance]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this CouponInstancePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this CouponInstancePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this CouponInstancePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this CouponInstancePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this CouponInstancePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this CouponInstancePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this CouponInstancePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this CouponInstancePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this CouponInstancePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this CouponInstancePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this CouponInstancePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this CouponInstancePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this CouponInstancePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this CouponInstancePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this CouponInstancePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this CouponInstancePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this CouponInstancePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this CouponInstancePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this CouponInstancePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this CouponInstancePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this CouponInstancePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this CouponInstancePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this CouponInstancePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this CouponInstancePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this CouponInstancePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this CouponInstancePagedMetadata. - :rtype: list[CouponInstance] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this CouponInstancePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this CouponInstancePagedMetadata. - :type: list[CouponInstance] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_modifier_base.py b/billforward/models/coupon_modifier_base.py deleted file mode 100644 index e4be50b..0000000 --- a/billforward/models/coupon_modifier_base.py +++ /dev/null @@ -1,506 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponModifierBase(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, coupon_definition_id=None, effect_amount=None, operand=None, effect=None, effect_additional=False, specifier_amount=None, domain=None, specifier=None, precedence=None, deleted=False): - """ - CouponModifierBase - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'coupon_definition_id': 'str', - 'effect_amount': 'float', - 'operand': 'str', - 'effect': 'str', - 'effect_additional': 'bool', - 'specifier_amount': 'int', - 'domain': 'str', - 'specifier': 'str', - 'precedence': 'int', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'coupon_definition_id': 'couponDefinitionID', - 'effect_amount': 'effectAmount', - 'operand': 'operand', - 'effect': 'effect', - 'effect_additional': 'effectAdditional', - 'specifier_amount': 'specifierAmount', - 'domain': 'domain', - 'specifier': 'specifier', - 'precedence': 'precedence', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._coupon_definition_id = coupon_definition_id - self._effect_amount = effect_amount - self._operand = operand - self._effect = effect - self._effect_additional = effect_additional - self._specifier_amount = specifier_amount - self._domain = domain - self._specifier = specifier - self._precedence = precedence - self._deleted = deleted - - @property - def created(self): - """ - Gets the created of this CouponModifierBase. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this CouponModifierBase. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this CouponModifierBase. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this CouponModifierBase. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this CouponModifierBase. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this CouponModifierBase. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this CouponModifierBase. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this CouponModifierBase. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this CouponModifierBase. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this CouponModifierBase. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this CouponModifierBase. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this CouponModifierBase. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this CouponModifierBase. - { \"description\" : \"ID of the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this CouponModifierBase. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this CouponModifierBase. - { \"description\" : \"ID of the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this CouponModifierBase. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this CouponModifierBase. - { \"description\" : \"ID of the organization associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this CouponModifierBase. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this CouponModifierBase. - { \"description\" : \"ID of the organization associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this CouponModifierBase. - :type: str - """ - - self._organization_id = organization_id - - @property - def coupon_definition_id(self): - """ - Gets the coupon_definition_id of this CouponModifierBase. - { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The coupon_definition_id of this CouponModifierBase. - :rtype: str - """ - return self._coupon_definition_id - - @coupon_definition_id.setter - def coupon_definition_id(self, coupon_definition_id): - """ - Sets the coupon_definition_id of this CouponModifierBase. - { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param coupon_definition_id: The coupon_definition_id of this CouponModifierBase. - :type: str - """ - - self._coupon_definition_id = coupon_definition_id - - @property - def effect_amount(self): - """ - Gets the effect_amount of this CouponModifierBase. - { \"description\" : \"The effect amount for the coupon-modifier. This is affected by the operand field.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The effect_amount of this CouponModifierBase. - :rtype: float - """ - return self._effect_amount - - @effect_amount.setter - def effect_amount(self, effect_amount): - """ - Sets the effect_amount of this CouponModifierBase. - { \"description\" : \"The effect amount for the coupon-modifier. This is affected by the operand field.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param effect_amount: The effect_amount of this CouponModifierBase. - :type: float - """ - - self._effect_amount = effect_amount - - @property - def operand(self): - """ - Gets the operand of this CouponModifierBase. - { \"description\" : \"The operand field affects the effect amount of the coupon-modifier. If the operand is fixed, it is an exact amount of the currency defined by the coupon-definition. If the operand is percent, this means the coupon will be affecting a percentage of the unaltered cost. E.g. a 25% modifier will apply a 25% discount on a subscription or a pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The operand of this CouponModifierBase. - :rtype: str - """ - return self._operand - - @operand.setter - def operand(self, operand): - """ - Sets the operand of this CouponModifierBase. - { \"description\" : \"The operand field affects the effect amount of the coupon-modifier. If the operand is fixed, it is an exact amount of the currency defined by the coupon-definition. If the operand is percent, this means the coupon will be affecting a percentage of the unaltered cost. E.g. a 25% modifier will apply a 25% discount on a subscription or a pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param operand: The operand of this CouponModifierBase. - :type: str - """ - allowed_values = ["fixed", "percent", "instance_fixed", "instance_percent"] - if operand not in allowed_values: - raise ValueError( - "Invalid value for `operand` ({0}), must be one of {1}" - .format(operand, allowed_values) - ) - - self._operand = operand - - @property - def effect(self): - """ - Gets the effect of this CouponModifierBase. - { \"description\" : \"The effect of the coupon-modifier. The coupon-modifier can affect first, last, and cheapest value of a specific unit-of-measure-id for a subscription. The coupon-modifier can also affect all of the values for a unit-of-measure-id, or can affect all of the subscription cost.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The effect of this CouponModifierBase. - :rtype: str - """ - return self._effect - - @effect.setter - def effect(self, effect): - """ - Sets the effect of this CouponModifierBase. - { \"description\" : \"The effect of the coupon-modifier. The coupon-modifier can affect first, last, and cheapest value of a specific unit-of-measure-id for a subscription. The coupon-modifier can also affect all of the values for a unit-of-measure-id, or can affect all of the subscription cost.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param effect: The effect of this CouponModifierBase. - :type: str - """ - allowed_values = ["discount_first_units", "discount_last_units", "discount_cheapest_units", "discount_all"] - if effect not in allowed_values: - raise ValueError( - "Invalid value for `effect` ({0}), must be one of {1}" - .format(effect, allowed_values) - ) - - self._effect = effect - - @property - def effect_additional(self): - """ - Gets the effect_additional of this CouponModifierBase. - { \"description\" : \"Specifies whether the coupon-modifier will be affecting only additional units. If this field is set, the coupon-instance-existing-values for the coupon-instance are observed, and any units of the unit-of-measure-id defined by the modifier below the coupon-instance-existing-values for that unit-of-measure-id will be ignored.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The effect_additional of this CouponModifierBase. - :rtype: bool - """ - return self._effect_additional - - @effect_additional.setter - def effect_additional(self, effect_additional): - """ - Sets the effect_additional of this CouponModifierBase. - { \"description\" : \"Specifies whether the coupon-modifier will be affecting only additional units. If this field is set, the coupon-instance-existing-values for the coupon-instance are observed, and any units of the unit-of-measure-id defined by the modifier below the coupon-instance-existing-values for that unit-of-measure-id will be ignored.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param effect_additional: The effect_additional of this CouponModifierBase. - :type: bool - """ - - self._effect_additional = effect_additional - - @property - def specifier_amount(self): - """ - Gets the specifier_amount of this CouponModifierBase. - { \"description\" : \"The number of units that will be affected by the coupon-modifier, if the domain is set to uom\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The specifier_amount of this CouponModifierBase. - :rtype: int - """ - return self._specifier_amount - - @specifier_amount.setter - def specifier_amount(self, specifier_amount): - """ - Sets the specifier_amount of this CouponModifierBase. - { \"description\" : \"The number of units that will be affected by the coupon-modifier, if the domain is set to uom\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param specifier_amount: The specifier_amount of this CouponModifierBase. - :type: int - """ - - self._specifier_amount = specifier_amount - - @property - def domain(self): - """ - Gets the domain of this CouponModifierBase. - { \"description\" : \"The domain of the coupon-modifier\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The domain of this CouponModifierBase. - :rtype: str - """ - return self._domain - - @domain.setter - def domain(self, domain): - """ - Sets the domain of this CouponModifierBase. - { \"description\" : \"The domain of the coupon-modifier\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param domain: The domain of this CouponModifierBase. - :type: str - """ - allowed_values = ["product", "uom", "PricingComponent"] - if domain not in allowed_values: - raise ValueError( - "Invalid value for `domain` ({0}), must be one of {1}" - .format(domain, allowed_values) - ) - - self._domain = domain - - @property - def specifier(self): - """ - Gets the specifier of this CouponModifierBase. - { \"description\" : \"The specifier is domain-specific. If the domain is uom, this field is used to limit the coupon-modifier to a specific unit-of-measure-id.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The specifier of this CouponModifierBase. - :rtype: str - """ - return self._specifier - - @specifier.setter - def specifier(self, specifier): - """ - Sets the specifier of this CouponModifierBase. - { \"description\" : \"The specifier is domain-specific. If the domain is uom, this field is used to limit the coupon-modifier to a specific unit-of-measure-id.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param specifier: The specifier of this CouponModifierBase. - :type: str - """ - - self._specifier = specifier - - @property - def precedence(self): - """ - Gets the precedence of this CouponModifierBase. - { \"description\" : \"The precedence of the coupon-modifier. This is used to order application of coupon-modifiers. Higher precedence means the coupon-modifier will be applied before others.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The precedence of this CouponModifierBase. - :rtype: int - """ - return self._precedence - - @precedence.setter - def precedence(self, precedence): - """ - Sets the precedence of this CouponModifierBase. - { \"description\" : \"The precedence of the coupon-modifier. This is used to order application of coupon-modifiers. Higher precedence means the coupon-modifier will be applied before others.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param precedence: The precedence of this CouponModifierBase. - :type: int - """ - - self._precedence = precedence - - @property - def deleted(self): - """ - Gets the deleted of this CouponModifierBase. - { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The deleted of this CouponModifierBase. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this CouponModifierBase. - { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param deleted: The deleted of this CouponModifierBase. - :type: bool - """ - - self._deleted = deleted - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_modifier_base_paged_metadata.py b/billforward/models/coupon_modifier_base_paged_metadata.py deleted file mode 100644 index 4c72a16..0000000 --- a/billforward/models/coupon_modifier_base_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponModifierBasePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - CouponModifierBasePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[CouponModifierBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this CouponModifierBasePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this CouponModifierBasePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this CouponModifierBasePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this CouponModifierBasePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this CouponModifierBasePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this CouponModifierBasePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this CouponModifierBasePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this CouponModifierBasePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this CouponModifierBasePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this CouponModifierBasePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this CouponModifierBasePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this CouponModifierBasePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this CouponModifierBasePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this CouponModifierBasePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this CouponModifierBasePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this CouponModifierBasePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this CouponModifierBasePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this CouponModifierBasePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this CouponModifierBasePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this CouponModifierBasePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this CouponModifierBasePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this CouponModifierBasePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this CouponModifierBasePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this CouponModifierBasePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this CouponModifierBasePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this CouponModifierBasePagedMetadata. - :rtype: list[CouponModifierBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this CouponModifierBasePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this CouponModifierBasePagedMetadata. - :type: list[CouponModifierBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_paged_metadata.py b/billforward/models/coupon_paged_metadata.py deleted file mode 100644 index 136902a..0000000 --- a/billforward/models/coupon_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - CouponPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Coupon]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this CouponPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this CouponPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this CouponPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this CouponPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this CouponPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this CouponPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this CouponPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this CouponPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this CouponPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this CouponPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this CouponPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this CouponPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this CouponPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this CouponPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this CouponPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this CouponPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this CouponPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this CouponPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this CouponPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this CouponPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this CouponPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this CouponPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this CouponPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this CouponPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this CouponPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this CouponPagedMetadata. - :rtype: list[Coupon] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this CouponPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this CouponPagedMetadata. - :type: list[Coupon] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_payment.py b/billforward/models/coupon_payment.py new file mode 100644 index 0000000..7e55816 --- /dev/null +++ b/billforward/models/coupon_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class CouponPayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """CouponPayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CouponPayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CouponPayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/coupon_rule.py b/billforward/models/coupon_rule.py deleted file mode 100644 index ea8afb0..0000000 --- a/billforward/models/coupon_rule.py +++ /dev/null @@ -1,576 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponRule(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, parent_rule_id=None, created=None, changed_by=None, updated=None, id=None, organization_id=None, coupon_definition_id=None, subject=None, polarity=None, verb=None, preposition=None, parameter=None, object=None, rule_validation_strategy=None, specifier=None, deleted=False, child_rules=None): - """ - CouponRule - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'parent_rule_id': 'str', - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'coupon_definition_id': 'str', - 'subject': 'str', - 'polarity': 'str', - 'verb': 'str', - 'preposition': 'str', - 'parameter': 'str', - 'object': 'str', - 'rule_validation_strategy': 'str', - 'specifier': 'str', - 'deleted': 'bool', - 'child_rules': 'list[CouponRule]' - } - - self.attribute_map = { - 'parent_rule_id': 'parentRuleID', - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'coupon_definition_id': 'couponDefinitionID', - 'subject': 'subject', - 'polarity': 'polarity', - 'verb': 'verb', - 'preposition': 'preposition', - 'parameter': 'parameter', - 'object': 'object', - 'rule_validation_strategy': 'ruleValidationStrategy', - 'specifier': 'specifier', - 'deleted': 'deleted', - 'child_rules': 'childRules' - } - - self._parent_rule_id = parent_rule_id - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._coupon_definition_id = coupon_definition_id - self._subject = subject - self._polarity = polarity - self._verb = verb - self._preposition = preposition - self._parameter = parameter - self._object = object - self._rule_validation_strategy = rule_validation_strategy - self._specifier = specifier - self._deleted = deleted - self._child_rules = child_rules - - @property - def parent_rule_id(self): - """ - Gets the parent_rule_id of this CouponRule. - { \"description\" : \"ID of the parent of this coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The parent_rule_id of this CouponRule. - :rtype: str - """ - return self._parent_rule_id - - @parent_rule_id.setter - def parent_rule_id(self, parent_rule_id): - """ - Sets the parent_rule_id of this CouponRule. - { \"description\" : \"ID of the parent of this coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param parent_rule_id: The parent_rule_id of this CouponRule. - :type: str - """ - - self._parent_rule_id = parent_rule_id - - @property - def created(self): - """ - Gets the created of this CouponRule. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this CouponRule. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this CouponRule. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this CouponRule. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this CouponRule. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this CouponRule. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this CouponRule. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this CouponRule. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this CouponRule. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this CouponRule. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this CouponRule. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this CouponRule. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this CouponRule. - { \"description\" : \"ID of the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this CouponRule. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this CouponRule. - { \"description\" : \"ID of the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this CouponRule. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this CouponRule. - { \"description\" : \"ID of the organization associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this CouponRule. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this CouponRule. - { \"description\" : \"ID of the organization associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this CouponRule. - :type: str - """ - - self._organization_id = organization_id - - @property - def coupon_definition_id(self): - """ - Gets the coupon_definition_id of this CouponRule. - { \"description\" : \"ID of the coupon-definition associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The coupon_definition_id of this CouponRule. - :rtype: str - """ - return self._coupon_definition_id - - @coupon_definition_id.setter - def coupon_definition_id(self, coupon_definition_id): - """ - Sets the coupon_definition_id of this CouponRule. - { \"description\" : \"ID of the coupon-definition associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param coupon_definition_id: The coupon_definition_id of this CouponRule. - :type: str - """ - - self._coupon_definition_id = coupon_definition_id - - @property - def subject(self): - """ - Gets the subject of this CouponRule. - { \"description\" : \"The subject of the coupon-rule. The coupon-rule can operate on either the user or subscription that the coupon-instance is associated with.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subject of this CouponRule. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this CouponRule. - { \"description\" : \"The subject of the coupon-rule. The coupon-rule can operate on either the user or subscription that the coupon-instance is associated with.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subject: The subject of this CouponRule. - :type: str - """ - allowed_values = ["user", "current_subscription", "child_rules"] - if subject not in allowed_values: - raise ValueError( - "Invalid value for `subject` ({0}), must be one of {1}" - .format(subject, allowed_values) - ) - - self._subject = subject - - @property - def polarity(self): - """ - Gets the polarity of this CouponRule. - { \"description\" : \"Specifies whether the rule's result will affect the application of the coupon-instance positively or negatively.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The polarity of this CouponRule. - :rtype: str - """ - return self._polarity - - @polarity.setter - def polarity(self, polarity): - """ - Sets the polarity of this CouponRule. - { \"description\" : \"Specifies whether the rule's result will affect the application of the coupon-instance positively or negatively.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param polarity: The polarity of this CouponRule. - :type: str - """ - allowed_values = ["does", "does_not"] - if polarity not in allowed_values: - raise ValueError( - "Invalid value for `polarity` ({0}), must be one of {1}" - .format(polarity, allowed_values) - ) - - self._polarity = polarity - - @property - def verb(self): - """ - Gets the verb of this CouponRule. - { \"description\" : \"The verb of the coupon-rule. coupon-rules can check whether the user or subscription has a certain property.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The verb of this CouponRule. - :rtype: str - """ - return self._verb - - @verb.setter - def verb(self, verb): - """ - Sets the verb of this CouponRule. - { \"description\" : \"The verb of the coupon-rule. coupon-rules can check whether the user or subscription has a certain property.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param verb: The verb of this CouponRule. - :type: str - """ - allowed_values = ["have"] - if verb not in allowed_values: - raise ValueError( - "Invalid value for `verb` ({0}), must be one of {1}" - .format(verb, allowed_values) - ) - - self._verb = verb - - @property - def preposition(self): - """ - Gets the preposition of this CouponRule. - { \"description\" : \"This is the comparison operator of the coupon-rule's parameter and the subject's object.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The preposition of this CouponRule. - :rtype: str - """ - return self._preposition - - @preposition.setter - def preposition(self, preposition): - """ - Sets the preposition of this CouponRule. - { \"description\" : \"This is the comparison operator of the coupon-rule's parameter and the subject's object.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param preposition: The preposition of this CouponRule. - :type: str - """ - allowed_values = ["less_than", "less_than_or_equal_to", "greater_than", "greater_than_or_equal_to", "equal_to"] - if preposition not in allowed_values: - raise ValueError( - "Invalid value for `preposition` ({0}), must be one of {1}" - .format(preposition, allowed_values) - ) - - self._preposition = preposition - - @property - def parameter(self): - """ - Gets the parameter of this CouponRule. - { \"description\" : \"The parameter for the coupon-rule. This specifies the ID or the quantity for the object of the subject.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The parameter of this CouponRule. - :rtype: str - """ - return self._parameter - - @parameter.setter - def parameter(self, parameter): - """ - Sets the parameter of this CouponRule. - { \"description\" : \"The parameter for the coupon-rule. This specifies the ID or the quantity for the object of the subject.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param parameter: The parameter of this CouponRule. - :type: str - """ - - self._parameter = parameter - - @property - def object(self): - """ - Gets the object of this CouponRule. - { \"description\" : \"The property of the subject of the coupon-rule. e.g. When the subject is 'subscription' and the object is 'product-ID', the coupon-rule will observe the product-ID for that subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The object of this CouponRule. - :rtype: str - """ - return self._object - - @object.setter - def object(self, object): - """ - Sets the object of this CouponRule. - { \"description\" : \"The property of the subject of the coupon-rule. e.g. When the subject is 'subscription' and the object is 'product-ID', the coupon-rule will observe the product-ID for that subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param object: The object of this CouponRule. - :type: str - """ - allowed_values = ["subscription", "unit_of_measure", "satisfaction", "product_rate_plan_id", "product_id"] - if object not in allowed_values: - raise ValueError( - "Invalid value for `object` ({0}), must be one of {1}" - .format(object, allowed_values) - ) - - self._object = object - - @property - def rule_validation_strategy(self): - """ - Gets the rule_validation_strategy of this CouponRule. - { \"description\" : \"The rule-validation-strategy object associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The rule_validation_strategy of this CouponRule. - :rtype: str - """ - return self._rule_validation_strategy - - @rule_validation_strategy.setter - def rule_validation_strategy(self, rule_validation_strategy): - """ - Sets the rule_validation_strategy of this CouponRule. - { \"description\" : \"The rule-validation-strategy object associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param rule_validation_strategy: The rule_validation_strategy of this CouponRule. - :type: str - """ - allowed_values = ["only_at_initialisation", "while_recurring_or_initialisation", "only_while_recurring"] - if rule_validation_strategy not in allowed_values: - raise ValueError( - "Invalid value for `rule_validation_strategy` ({0}), must be one of {1}" - .format(rule_validation_strategy, allowed_values) - ) - - self._rule_validation_strategy = rule_validation_strategy - - @property - def specifier(self): - """ - Gets the specifier of this CouponRule. - { \"description\" : \"When the subject is subscription, the specifier is used to define which unit of measure the coupon rule will operate on. When the subject is user, the specifier defines which property of the user's account it will operate on.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The specifier of this CouponRule. - :rtype: str - """ - return self._specifier - - @specifier.setter - def specifier(self, specifier): - """ - Sets the specifier of this CouponRule. - { \"description\" : \"When the subject is subscription, the specifier is used to define which unit of measure the coupon rule will operate on. When the subject is user, the specifier defines which property of the user's account it will operate on.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param specifier: The specifier of this CouponRule. - :type: str - """ - - self._specifier = specifier - - @property - def deleted(self): - """ - Gets the deleted of this CouponRule. - { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The deleted of this CouponRule. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this CouponRule. - { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param deleted: The deleted of this CouponRule. - :type: bool - """ - - self._deleted = deleted - - @property - def child_rules(self): - """ - Gets the child_rules of this CouponRule. - { \"description\" : \"The collection of child coupon-rules associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The child_rules of this CouponRule. - :rtype: list[CouponRule] - """ - return self._child_rules - - @child_rules.setter - def child_rules(self, child_rules): - """ - Sets the child_rules of this CouponRule. - { \"description\" : \"The collection of child coupon-rules associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param child_rules: The child_rules of this CouponRule. - :type: list[CouponRule] - """ - - self._child_rules = child_rules - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_rule_paged_metadata.py b/billforward/models/coupon_rule_paged_metadata.py deleted file mode 100644 index 8aa6654..0000000 --- a/billforward/models/coupon_rule_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponRulePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - CouponRulePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[CouponRule]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this CouponRulePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this CouponRulePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this CouponRulePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this CouponRulePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this CouponRulePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this CouponRulePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this CouponRulePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this CouponRulePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this CouponRulePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this CouponRulePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this CouponRulePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this CouponRulePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this CouponRulePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this CouponRulePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this CouponRulePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this CouponRulePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this CouponRulePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this CouponRulePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this CouponRulePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this CouponRulePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this CouponRulePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this CouponRulePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this CouponRulePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this CouponRulePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this CouponRulePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this CouponRulePagedMetadata. - :rtype: list[CouponRule] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this CouponRulePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this CouponRulePagedMetadata. - :type: list[CouponRule] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_unique_codes_request.py b/billforward/models/coupon_unique_codes_request.py index db3142e..05a3b3d 100644 --- a/billforward/models/coupon_unique_codes_request.py +++ b/billforward/models/coupon_unique_codes_request.py @@ -1,82 +1,93 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class CouponUniqueCodesRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, organization_id=None, quantity=None): - """ - CouponUniqueCodesRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'organization_id': 'str', - 'quantity': 'int' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'organization_id': 'organizationID', - 'quantity': 'quantity' - } - - self._created = created - self._changed_by = changed_by - self._organization_id = organization_id - self._quantity = quantity + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'organization_id': 'str', + 'quantity': 'int', + 'issued_by': 'str', + 'short_code': 'bool', + 'id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'organization_id': 'organizationID', + 'quantity': 'quantity', + 'issued_by': 'issuedBy', + 'short_code': 'shortCode', + 'id': 'id' + } + + def __init__(self, created=None, changed_by=None, organization_id=None, quantity=None, issued_by=None, short_code=None, id=None): # noqa: E501 + """CouponUniqueCodesRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._organization_id = None + self._quantity = None + self._issued_by = None + self._short_code = None + self._id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if organization_id is not None: + self.organization_id = organization_id + if quantity is not None: + self.quantity = quantity + if issued_by is not None: + self.issued_by = issued_by + if short_code is not None: + self.short_code = short_code + if id is not None: + self.id = id @property def created(self): - """ - Gets the created of this CouponUniqueCodesRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this CouponUniqueCodesRequest. # noqa: E501 + - :return: The created of this CouponUniqueCodesRequest. + :return: The created of this CouponUniqueCodesRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this CouponUniqueCodesRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this CouponUniqueCodesRequest. + - :param created: The created of this CouponUniqueCodesRequest. + :param created: The created of this CouponUniqueCodesRequest. # noqa: E501 :type: datetime """ @@ -84,22 +95,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this CouponUniqueCodesRequest. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this CouponUniqueCodesRequest. # noqa: E501 + - :return: The changed_by of this CouponUniqueCodesRequest. + :return: The changed_by of this CouponUniqueCodesRequest. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this CouponUniqueCodesRequest. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this CouponUniqueCodesRequest. - :param changed_by: The changed_by of this CouponUniqueCodesRequest. + + :param changed_by: The changed_by of this CouponUniqueCodesRequest. # noqa: E501 :type: str """ @@ -107,22 +116,20 @@ def changed_by(self, changed_by): @property def organization_id(self): - """ - Gets the organization_id of this CouponUniqueCodesRequest. - { \"description\" : \"\", \"verbs\":[\"POST\"] } + """Gets the organization_id of this CouponUniqueCodesRequest. # noqa: E501 - :return: The organization_id of this CouponUniqueCodesRequest. + + :return: The organization_id of this CouponUniqueCodesRequest. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this CouponUniqueCodesRequest. - { \"description\" : \"\", \"verbs\":[\"POST\"] } + """Sets the organization_id of this CouponUniqueCodesRequest. - :param organization_id: The organization_id of this CouponUniqueCodesRequest. + + :param organization_id: The organization_id of this CouponUniqueCodesRequest. # noqa: E501 :type: str """ @@ -130,34 +137,93 @@ def organization_id(self, organization_id): @property def quantity(self): - """ - Gets the quantity of this CouponUniqueCodesRequest. - { \"description\" : \"The number of unique codes that will be returned.\", \"verbs\":[\"POST\"] } + """Gets the quantity of this CouponUniqueCodesRequest. # noqa: E501 - :return: The quantity of this CouponUniqueCodesRequest. + + :return: The quantity of this CouponUniqueCodesRequest. # noqa: E501 :rtype: int """ return self._quantity @quantity.setter def quantity(self, quantity): - """ - Sets the quantity of this CouponUniqueCodesRequest. - { \"description\" : \"The number of unique codes that will be returned.\", \"verbs\":[\"POST\"] } + """Sets the quantity of this CouponUniqueCodesRequest. + - :param quantity: The quantity of this CouponUniqueCodesRequest. + :param quantity: The quantity of this CouponUniqueCodesRequest. # noqa: E501 :type: int """ self._quantity = quantity - def to_dict(self): + @property + def issued_by(self): + """Gets the issued_by of this CouponUniqueCodesRequest. # noqa: E501 + + + :return: The issued_by of this CouponUniqueCodesRequest. # noqa: E501 + :rtype: str + """ + return self._issued_by + + @issued_by.setter + def issued_by(self, issued_by): + """Sets the issued_by of this CouponUniqueCodesRequest. + + + :param issued_by: The issued_by of this CouponUniqueCodesRequest. # noqa: E501 + :type: str """ - Returns the model properties as a dict + + self._issued_by = issued_by + + @property + def short_code(self): + """Gets the short_code of this CouponUniqueCodesRequest. # noqa: E501 + + + :return: The short_code of this CouponUniqueCodesRequest. # noqa: E501 + :rtype: bool """ + return self._short_code + + @short_code.setter + def short_code(self, short_code): + """Sets the short_code of this CouponUniqueCodesRequest. + + + :param short_code: The short_code of this CouponUniqueCodesRequest. # noqa: E501 + :type: bool + """ + + self._short_code = short_code + + @property + def id(self): + """Gets the id of this CouponUniqueCodesRequest. # noqa: E501 + + + :return: The id of this CouponUniqueCodesRequest. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this CouponUniqueCodesRequest. + + + :param id: The id of this CouponUniqueCodesRequest. # noqa: E501 + :type: str + """ + + self._id = id + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -174,29 +240,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CouponUniqueCodesRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CouponUniqueCodesRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/coupon_unique_codes_response.py b/billforward/models/coupon_unique_codes_response.py index b52854d..56cd992 100644 --- a/billforward/models/coupon_unique_codes_response.py +++ b/billforward/models/coupon_unique_codes_response.py @@ -1,79 +1,73 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class CouponUniqueCodesResponse(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, coupon_code=None, organization_id=None): - """ - CouponUniqueCodesResponse - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'coupon_code': 'str', - 'organization_id': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'coupon_code': 'couponCode', - 'organization_id': 'organizationID' - } - - self._created = created - self._coupon_code = coupon_code - self._organization_id = organization_id + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'coupon_code': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'coupon_code': 'couponCode', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, coupon_code=None, organization_id=None): # noqa: E501 + """CouponUniqueCodesResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._coupon_code = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if coupon_code is not None: + self.coupon_code = coupon_code + if organization_id is not None: + self.organization_id = organization_id @property def created(self): - """ - Gets the created of this CouponUniqueCodesResponse. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this CouponUniqueCodesResponse. # noqa: E501 + - :return: The created of this CouponUniqueCodesResponse. + :return: The created of this CouponUniqueCodesResponse. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this CouponUniqueCodesResponse. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this CouponUniqueCodesResponse. + - :param created: The created of this CouponUniqueCodesResponse. + :param created: The created of this CouponUniqueCodesResponse. # noqa: E501 :type: datetime """ @@ -81,22 +75,20 @@ def created(self, created): @property def coupon_code(self): - """ - Gets the coupon_code of this CouponUniqueCodesResponse. - { \"description\" : \"A unique code that can be applied to a subscription.\", \"verbs\":[\"POST\"] } + """Gets the coupon_code of this CouponUniqueCodesResponse. # noqa: E501 + - :return: The coupon_code of this CouponUniqueCodesResponse. + :return: The coupon_code of this CouponUniqueCodesResponse. # noqa: E501 :rtype: str """ return self._coupon_code @coupon_code.setter def coupon_code(self, coupon_code): - """ - Sets the coupon_code of this CouponUniqueCodesResponse. - { \"description\" : \"A unique code that can be applied to a subscription.\", \"verbs\":[\"POST\"] } + """Sets the coupon_code of this CouponUniqueCodesResponse. - :param coupon_code: The coupon_code of this CouponUniqueCodesResponse. + + :param coupon_code: The coupon_code of this CouponUniqueCodesResponse. # noqa: E501 :type: str """ @@ -104,34 +96,30 @@ def coupon_code(self, coupon_code): @property def organization_id(self): - """ - Gets the organization_id of this CouponUniqueCodesResponse. + """Gets the organization_id of this CouponUniqueCodesResponse. # noqa: E501 - :return: The organization_id of this CouponUniqueCodesResponse. + :return: The organization_id of this CouponUniqueCodesResponse. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this CouponUniqueCodesResponse. + """Sets the organization_id of this CouponUniqueCodesResponse. - :param organization_id: The organization_id of this CouponUniqueCodesResponse. + :param organization_id: The organization_id of this CouponUniqueCodesResponse. # noqa: E501 :type: str """ self._organization_id = organization_id def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -148,29 +136,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CouponUniqueCodesResponse, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CouponUniqueCodesResponse): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/coupon_unique_codes_response_paged_metadata.py b/billforward/models/coupon_unique_codes_response_paged_metadata.py deleted file mode 100644 index 8c966c7..0000000 --- a/billforward/models/coupon_unique_codes_response_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CouponUniqueCodesResponsePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - CouponUniqueCodesResponsePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[CouponUniqueCodesResponse]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this CouponUniqueCodesResponsePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this CouponUniqueCodesResponsePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this CouponUniqueCodesResponsePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this CouponUniqueCodesResponsePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this CouponUniqueCodesResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this CouponUniqueCodesResponsePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this CouponUniqueCodesResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this CouponUniqueCodesResponsePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this CouponUniqueCodesResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this CouponUniqueCodesResponsePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this CouponUniqueCodesResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this CouponUniqueCodesResponsePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this CouponUniqueCodesResponsePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this CouponUniqueCodesResponsePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this CouponUniqueCodesResponsePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this CouponUniqueCodesResponsePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this CouponUniqueCodesResponsePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this CouponUniqueCodesResponsePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this CouponUniqueCodesResponsePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this CouponUniqueCodesResponsePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this CouponUniqueCodesResponsePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this CouponUniqueCodesResponsePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this CouponUniqueCodesResponsePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this CouponUniqueCodesResponsePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this CouponUniqueCodesResponsePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this CouponUniqueCodesResponsePagedMetadata. - :rtype: list[CouponUniqueCodesResponse] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this CouponUniqueCodesResponsePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this CouponUniqueCodesResponsePagedMetadata. - :type: list[CouponUniqueCodesResponse] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/coupon_wrapper_response.py b/billforward/models/coupon_wrapper_response.py index e313702..733aed5 100644 --- a/billforward/models/coupon_wrapper_response.py +++ b/billforward/models/coupon_wrapper_response.py @@ -1,88 +1,218 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class CouponWrapperResponse(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, coupon_code=None, discount=None, discount_excluding_tax=None, calculation=None, pricing_component_name=None, pricing_component_id=None): - """ - CouponWrapperResponse - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'coupon_code': 'str', - 'discount': 'float', - 'discount_excluding_tax': 'float', - 'calculation': 'str', - 'pricing_component_name': 'str', - 'pricing_component_id': 'str' - } - - self.attribute_map = { - 'coupon_code': 'couponCode', - 'discount': 'discount', - 'discount_excluding_tax': 'discountExcludingTax', - 'calculation': 'calculation', - 'pricing_component_name': 'pricingComponentName', - 'pricing_component_id': 'pricingComponentID' - } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'coupon_code': 'str', + 'discount': 'float', + 'discount_excluding_tax': 'float', + 'calculation': 'str', + 'pricing_component_name': 'str', + 'pricing_component_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'coupon_code': 'couponCode', + 'discount': 'discount', + 'discount_excluding_tax': 'discountExcludingTax', + 'calculation': 'calculation', + 'pricing_component_name': 'pricingComponentName', + 'pricing_component_id': 'pricingComponentID' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, coupon_code=None, discount=None, discount_excluding_tax=None, calculation=None, pricing_component_name=None, pricing_component_id=None): # noqa: E501 + """CouponWrapperResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._coupon_code = None + self._discount = None + self._discount_excluding_tax = None + self._calculation = None + self._pricing_component_name = None + self._pricing_component_id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if coupon_code is not None: + self.coupon_code = coupon_code + if discount is not None: + self.discount = discount + if discount_excluding_tax is not None: + self.discount_excluding_tax = discount_excluding_tax + if calculation is not None: + self.calculation = calculation + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id - self._coupon_code = coupon_code - self._discount = discount - self._discount_excluding_tax = discount_excluding_tax - self._calculation = calculation - self._pricing_component_name = pricing_component_name - self._pricing_component_id = pricing_component_id + @property + def created(self): + """Gets the created of this CouponWrapperResponse. # noqa: E501 + + + :return: The created of this CouponWrapperResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this CouponWrapperResponse. + + + :param created: The created of this CouponWrapperResponse. # noqa: E501 + :type: datetime + """ + + self._created = created @property - def coupon_code(self): + def changed_by(self): + """Gets the changed_by of this CouponWrapperResponse. # noqa: E501 + + + :return: The changed_by of this CouponWrapperResponse. # noqa: E501 + :rtype: str """ - Gets the coupon_code of this CouponWrapperResponse. - {\"description\":\"Code of the coupon applied.\",\"verbs\":[\"POST\",\"GET\"]} + return self._changed_by - :return: The coupon_code of this CouponWrapperResponse. + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this CouponWrapperResponse. + + + :param changed_by: The changed_by of this CouponWrapperResponse. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this CouponWrapperResponse. # noqa: E501 + + + :return: The updated of this CouponWrapperResponse. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this CouponWrapperResponse. + + + :param updated: The updated of this CouponWrapperResponse. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this CouponWrapperResponse. # noqa: E501 + + + :return: The id of this CouponWrapperResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this CouponWrapperResponse. + + + :param id: The id of this CouponWrapperResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this CouponWrapperResponse. # noqa: E501 + + + :return: The organization_id of this CouponWrapperResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CouponWrapperResponse. + + + :param organization_id: The organization_id of this CouponWrapperResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def coupon_code(self): + """Gets the coupon_code of this CouponWrapperResponse. # noqa: E501 + + + :return: The coupon_code of this CouponWrapperResponse. # noqa: E501 :rtype: str """ return self._coupon_code @coupon_code.setter def coupon_code(self, coupon_code): - """ - Sets the coupon_code of this CouponWrapperResponse. - {\"description\":\"Code of the coupon applied.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the coupon_code of this CouponWrapperResponse. + - :param coupon_code: The coupon_code of this CouponWrapperResponse. + :param coupon_code: The coupon_code of this CouponWrapperResponse. # noqa: E501 :type: str """ @@ -90,22 +220,20 @@ def coupon_code(self, coupon_code): @property def discount(self): - """ - Gets the discount of this CouponWrapperResponse. - {\"description\":\"Discount — including tax — contributed to the cost of the pricing component, due to application of coupon.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the discount of this CouponWrapperResponse. # noqa: E501 + - :return: The discount of this CouponWrapperResponse. + :return: The discount of this CouponWrapperResponse. # noqa: E501 :rtype: float """ return self._discount @discount.setter def discount(self, discount): - """ - Sets the discount of this CouponWrapperResponse. - {\"description\":\"Discount — including tax — contributed to the cost of the pricing component, due to application of coupon.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the discount of this CouponWrapperResponse. - :param discount: The discount of this CouponWrapperResponse. + + :param discount: The discount of this CouponWrapperResponse. # noqa: E501 :type: float """ @@ -113,22 +241,20 @@ def discount(self, discount): @property def discount_excluding_tax(self): - """ - Gets the discount_excluding_tax of this CouponWrapperResponse. - {\"description\":\"Discount — excluding tax — contributed to the cost of the pricing component, due to application of coupon.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the discount_excluding_tax of this CouponWrapperResponse. # noqa: E501 + - :return: The discount_excluding_tax of this CouponWrapperResponse. + :return: The discount_excluding_tax of this CouponWrapperResponse. # noqa: E501 :rtype: float """ return self._discount_excluding_tax @discount_excluding_tax.setter def discount_excluding_tax(self, discount_excluding_tax): - """ - Sets the discount_excluding_tax of this CouponWrapperResponse. - {\"description\":\"Discount — excluding tax — contributed to the cost of the pricing component, due to application of coupon.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the discount_excluding_tax of this CouponWrapperResponse. + - :param discount_excluding_tax: The discount_excluding_tax of this CouponWrapperResponse. + :param discount_excluding_tax: The discount_excluding_tax of this CouponWrapperResponse. # noqa: E501 :type: float """ @@ -136,22 +262,20 @@ def discount_excluding_tax(self, discount_excluding_tax): @property def calculation(self): - """ - Gets the calculation of this CouponWrapperResponse. - {\"description\":\"Friendly text describing the calculation performed in applying the coupon.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the calculation of this CouponWrapperResponse. # noqa: E501 + - :return: The calculation of this CouponWrapperResponse. + :return: The calculation of this CouponWrapperResponse. # noqa: E501 :rtype: str """ return self._calculation @calculation.setter def calculation(self, calculation): - """ - Sets the calculation of this CouponWrapperResponse. - {\"description\":\"Friendly text describing the calculation performed in applying the coupon.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the calculation of this CouponWrapperResponse. + - :param calculation: The calculation of this CouponWrapperResponse. + :param calculation: The calculation of this CouponWrapperResponse. # noqa: E501 :type: str """ @@ -159,22 +283,20 @@ def calculation(self, calculation): @property def pricing_component_name(self): - """ - Gets the pricing_component_name of this CouponWrapperResponse. - {\"description\":\"Name of the pricing component to whom the coupon was applied.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the pricing_component_name of this CouponWrapperResponse. # noqa: E501 - :return: The pricing_component_name of this CouponWrapperResponse. + + :return: The pricing_component_name of this CouponWrapperResponse. # noqa: E501 :rtype: str """ return self._pricing_component_name @pricing_component_name.setter def pricing_component_name(self, pricing_component_name): - """ - Sets the pricing_component_name of this CouponWrapperResponse. - {\"description\":\"Name of the pricing component to whom the coupon was applied.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the pricing_component_name of this CouponWrapperResponse. + - :param pricing_component_name: The pricing_component_name of this CouponWrapperResponse. + :param pricing_component_name: The pricing_component_name of this CouponWrapperResponse. # noqa: E501 :type: str """ @@ -182,34 +304,30 @@ def pricing_component_name(self, pricing_component_name): @property def pricing_component_id(self): - """ - Gets the pricing_component_id of this CouponWrapperResponse. - {\"description\":\"ID of the pricing component to whom the coupon was applied.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the pricing_component_id of this CouponWrapperResponse. # noqa: E501 + - :return: The pricing_component_id of this CouponWrapperResponse. + :return: The pricing_component_id of this CouponWrapperResponse. # noqa: E501 :rtype: str """ return self._pricing_component_id @pricing_component_id.setter def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this CouponWrapperResponse. - {\"description\":\"ID of the pricing component to whom the coupon was applied.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the pricing_component_id of this CouponWrapperResponse. - :param pricing_component_id: The pricing_component_id of this CouponWrapperResponse. + + :param pricing_component_id: The pricing_component_id of this CouponWrapperResponse. # noqa: E501 :type: str """ self._pricing_component_id = pricing_component_id def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -226,29 +344,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CouponWrapperResponse, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CouponWrapperResponse): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/create_account_profile_request.py b/billforward/models/create_account_profile_request.py deleted file mode 100644 index 011a342..0000000 --- a/billforward/models/create_account_profile_request.py +++ /dev/null @@ -1,436 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CreateAccountProfileRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, account_id=None, email=None, first_name=None, last_name=None, company_name=None, logo_url=None, addresses=None, mobile=None, landline=None, fax=None, dob=None, vat_number=None, additional_information=None): - """ - CreateAccountProfileRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'account_id': 'str', - 'email': 'str', - 'first_name': 'str', - 'last_name': 'str', - 'company_name': 'str', - 'logo_url': 'str', - 'addresses': 'list[CreateProfileAddressRequest]', - 'mobile': 'str', - 'landline': 'str', - 'fax': 'str', - 'dob': 'datetime', - 'vat_number': 'str', - 'additional_information': 'str' - } - - self.attribute_map = { - 'account_id': 'accountID', - 'email': 'email', - 'first_name': 'firstName', - 'last_name': 'lastName', - 'company_name': 'companyName', - 'logo_url': 'logoURL', - 'addresses': 'addresses', - 'mobile': 'mobile', - 'landline': 'landline', - 'fax': 'fax', - 'dob': 'dob', - 'vat_number': 'vatNumber', - 'additional_information': 'additionalInformation' - } - - self._account_id = account_id - self._email = email - self._first_name = first_name - self._last_name = last_name - self._company_name = company_name - self._logo_url = logo_url - self._addresses = addresses - self._mobile = mobile - self._landline = landline - self._fax = fax - self._dob = dob - self._vat_number = vat_number - self._additional_information = additional_information - - @property - def account_id(self): - """ - Gets the account_id of this CreateAccountProfileRequest. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The account_id of this CreateAccountProfileRequest. - :rtype: str - """ - return self._account_id - - @account_id.setter - def account_id(self, account_id): - """ - Sets the account_id of this CreateAccountProfileRequest. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param account_id: The account_id of this CreateAccountProfileRequest. - :type: str - """ - - self._account_id = account_id - - @property - def email(self): - """ - Gets the email of this CreateAccountProfileRequest. - { \"description\" : \"E-mail address\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The email of this CreateAccountProfileRequest. - :rtype: str - """ - return self._email - - @email.setter - def email(self, email): - """ - Sets the email of this CreateAccountProfileRequest. - { \"description\" : \"E-mail address\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param email: The email of this CreateAccountProfileRequest. - :type: str - """ - - self._email = email - - @property - def first_name(self): - """ - Gets the first_name of this CreateAccountProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The first_name of this CreateAccountProfileRequest. - :rtype: str - """ - return self._first_name - - @first_name.setter - def first_name(self, first_name): - """ - Sets the first_name of this CreateAccountProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param first_name: The first_name of this CreateAccountProfileRequest. - :type: str - """ - - self._first_name = first_name - - @property - def last_name(self): - """ - Gets the last_name of this CreateAccountProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The last_name of this CreateAccountProfileRequest. - :rtype: str - """ - return self._last_name - - @last_name.setter - def last_name(self, last_name): - """ - Sets the last_name of this CreateAccountProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param last_name: The last_name of this CreateAccountProfileRequest. - :type: str - """ - - self._last_name = last_name - - @property - def company_name(self): - """ - Gets the company_name of this CreateAccountProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The company_name of this CreateAccountProfileRequest. - :rtype: str - """ - return self._company_name - - @company_name.setter - def company_name(self, company_name): - """ - Sets the company_name of this CreateAccountProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param company_name: The company_name of this CreateAccountProfileRequest. - :type: str - """ - - self._company_name = company_name - - @property - def logo_url(self): - """ - Gets the logo_url of this CreateAccountProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The logo_url of this CreateAccountProfileRequest. - :rtype: str - """ - return self._logo_url - - @logo_url.setter - def logo_url(self, logo_url): - """ - Sets the logo_url of this CreateAccountProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param logo_url: The logo_url of this CreateAccountProfileRequest. - :type: str - """ - - self._logo_url = logo_url - - @property - def addresses(self): - """ - Gets the addresses of this CreateAccountProfileRequest. - { \"description\" : \"Address associated with the profile\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The addresses of this CreateAccountProfileRequest. - :rtype: list[CreateProfileAddressRequest] - """ - return self._addresses - - @addresses.setter - def addresses(self, addresses): - """ - Sets the addresses of this CreateAccountProfileRequest. - { \"description\" : \"Address associated with the profile\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param addresses: The addresses of this CreateAccountProfileRequest. - :type: list[CreateProfileAddressRequest] - """ - - self._addresses = addresses - - @property - def mobile(self): - """ - Gets the mobile of this CreateAccountProfileRequest. - { \"description\" : \"Mobile telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The mobile of this CreateAccountProfileRequest. - :rtype: str - """ - return self._mobile - - @mobile.setter - def mobile(self, mobile): - """ - Sets the mobile of this CreateAccountProfileRequest. - { \"description\" : \"Mobile telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param mobile: The mobile of this CreateAccountProfileRequest. - :type: str - """ - - self._mobile = mobile - - @property - def landline(self): - """ - Gets the landline of this CreateAccountProfileRequest. - { \"description\" : \"Home telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The landline of this CreateAccountProfileRequest. - :rtype: str - """ - return self._landline - - @landline.setter - def landline(self, landline): - """ - Sets the landline of this CreateAccountProfileRequest. - { \"description\" : \"Home telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param landline: The landline of this CreateAccountProfileRequest. - :type: str - """ - - self._landline = landline - - @property - def fax(self): - """ - Gets the fax of this CreateAccountProfileRequest. - { \"description\" : \"Fax number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The fax of this CreateAccountProfileRequest. - :rtype: str - """ - return self._fax - - @fax.setter - def fax(self, fax): - """ - Sets the fax of this CreateAccountProfileRequest. - { \"description\" : \"Fax number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param fax: The fax of this CreateAccountProfileRequest. - :type: str - """ - - self._fax = fax - - @property - def dob(self): - """ - Gets the dob of this CreateAccountProfileRequest. - { \"description\" : \"Date of birth in YYYY-MM-DD format\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The dob of this CreateAccountProfileRequest. - :rtype: datetime - """ - return self._dob - - @dob.setter - def dob(self, dob): - """ - Sets the dob of this CreateAccountProfileRequest. - { \"description\" : \"Date of birth in YYYY-MM-DD format\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param dob: The dob of this CreateAccountProfileRequest. - :type: datetime - """ - - self._dob = dob - - @property - def vat_number(self): - """ - Gets the vat_number of this CreateAccountProfileRequest. - { \"description\" : \"VAT number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The vat_number of this CreateAccountProfileRequest. - :rtype: str - """ - return self._vat_number - - @vat_number.setter - def vat_number(self, vat_number): - """ - Sets the vat_number of this CreateAccountProfileRequest. - { \"description\" : \"VAT number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param vat_number: The vat_number of this CreateAccountProfileRequest. - :type: str - """ - - self._vat_number = vat_number - - @property - def additional_information(self): - """ - Gets the additional_information of this CreateAccountProfileRequest. - { \"description\" : \"Any additional information\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The additional_information of this CreateAccountProfileRequest. - :rtype: str - """ - return self._additional_information - - @additional_information.setter - def additional_information(self, additional_information): - """ - Sets the additional_information of this CreateAccountProfileRequest. - { \"description\" : \"Any additional information\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param additional_information: The additional_information of this CreateAccountProfileRequest. - :type: str - """ - - self._additional_information = additional_information - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/create_account_request.py b/billforward/models/create_account_request.py deleted file mode 100644 index c43b790..0000000 --- a/billforward/models/create_account_request.py +++ /dev/null @@ -1,254 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CreateAccountRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, profile=None, organization_id=None, user_id=None, aggregating_product_rate_plan_id=None, aggregating_subscription_id=None, metadata=None): - """ - CreateAccountRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'profile': 'CreateAccountProfileRequest', - 'organization_id': 'str', - 'user_id': 'str', - 'aggregating_product_rate_plan_id': 'str', - 'aggregating_subscription_id': 'str', - 'metadata': 'DynamicMetadata' - } - - self.attribute_map = { - 'profile': 'profile', - 'organization_id': 'organizationID', - 'user_id': 'userID', - 'aggregating_product_rate_plan_id': 'aggregatingProductRatePlanID', - 'aggregating_subscription_id': 'aggregatingSubscriptionID', - 'metadata': 'metadata' - } - - self._profile = profile - self._organization_id = organization_id - self._user_id = user_id - self._aggregating_product_rate_plan_id = aggregating_product_rate_plan_id - self._aggregating_subscription_id = aggregating_subscription_id - self._metadata = metadata - - @property - def profile(self): - """ - Gets the profile of this CreateAccountRequest. - - - :return: The profile of this CreateAccountRequest. - :rtype: CreateAccountProfileRequest - """ - return self._profile - - @profile.setter - def profile(self, profile): - """ - Sets the profile of this CreateAccountRequest. - - - :param profile: The profile of this CreateAccountRequest. - :type: CreateAccountProfileRequest - """ - - self._profile = profile - - @property - def organization_id(self): - """ - Gets the organization_id of this CreateAccountRequest. - { \"description\" : \"Organization associated with the account.\", \"verbs\":[] } - - :return: The organization_id of this CreateAccountRequest. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this CreateAccountRequest. - { \"description\" : \"Organization associated with the account.\", \"verbs\":[] } - - :param organization_id: The organization_id of this CreateAccountRequest. - :type: str - """ - - self._organization_id = organization_id - - @property - def user_id(self): - """ - Gets the user_id of this CreateAccountRequest. - { \"description\" : \"User associated with the account. If this is null, no user is currently assocaited with the account. A user is only set when an account is associated with a user account.\", \"verbs\":[] } - - :return: The user_id of this CreateAccountRequest. - :rtype: str - """ - return self._user_id - - @user_id.setter - def user_id(self, user_id): - """ - Sets the user_id of this CreateAccountRequest. - { \"description\" : \"User associated with the account. If this is null, no user is currently assocaited with the account. A user is only set when an account is associated with a user account.\", \"verbs\":[] } - - :param user_id: The user_id of this CreateAccountRequest. - :type: str - """ - - self._user_id = user_id - - @property - def aggregating_product_rate_plan_id(self): - """ - Gets the aggregating_product_rate_plan_id of this CreateAccountRequest. - { \"description\" : \"If present, this will be the product rate plan to use when creating an aggregating subscription. An account level aggregating subscription will be created when the first subscription is created against the account.\", \"verbs\":[] } - - :return: The aggregating_product_rate_plan_id of this CreateAccountRequest. - :rtype: str - """ - return self._aggregating_product_rate_plan_id - - @aggregating_product_rate_plan_id.setter - def aggregating_product_rate_plan_id(self, aggregating_product_rate_plan_id): - """ - Sets the aggregating_product_rate_plan_id of this CreateAccountRequest. - { \"description\" : \"If present, this will be the product rate plan to use when creating an aggregating subscription. An account level aggregating subscription will be created when the first subscription is created against the account.\", \"verbs\":[] } - - :param aggregating_product_rate_plan_id: The aggregating_product_rate_plan_id of this CreateAccountRequest. - :type: str - """ - - self._aggregating_product_rate_plan_id = aggregating_product_rate_plan_id - - @property - def aggregating_subscription_id(self): - """ - Gets the aggregating_subscription_id of this CreateAccountRequest. - { \"description\" : \"The consistent ID of the account level aggregating subscription, if one exists.\", \"verbs\":[] } - - :return: The aggregating_subscription_id of this CreateAccountRequest. - :rtype: str - """ - return self._aggregating_subscription_id - - @aggregating_subscription_id.setter - def aggregating_subscription_id(self, aggregating_subscription_id): - """ - Sets the aggregating_subscription_id of this CreateAccountRequest. - { \"description\" : \"The consistent ID of the account level aggregating subscription, if one exists.\", \"verbs\":[] } - - :param aggregating_subscription_id: The aggregating_subscription_id of this CreateAccountRequest. - :type: str - """ - - self._aggregating_subscription_id = aggregating_subscription_id - - @property - def metadata(self): - """ - Gets the metadata of this CreateAccountRequest. - - - :return: The metadata of this CreateAccountRequest. - :rtype: DynamicMetadata - """ - return self._metadata - - @metadata.setter - def metadata(self, metadata): - """ - Sets the metadata of this CreateAccountRequest. - - - :param metadata: The metadata of this CreateAccountRequest. - :type: DynamicMetadata - """ - - self._metadata = metadata - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/create_address_request.py b/billforward/models/create_address_request.py deleted file mode 100644 index 7cfb052..0000000 --- a/billforward/models/create_address_request.py +++ /dev/null @@ -1,358 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CreateAddressRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, profile_id=None, address_line1=None, address_line2=None, address_line3=None, city=None, province=None, country=None, postcode=None, landline=None, primary_address=False): - """ - CreateAddressRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'profile_id': 'str', - 'address_line1': 'str', - 'address_line2': 'str', - 'address_line3': 'str', - 'city': 'str', - 'province': 'str', - 'country': 'str', - 'postcode': 'str', - 'landline': 'str', - 'primary_address': 'bool' - } - - self.attribute_map = { - 'profile_id': 'profileID', - 'address_line1': 'addressLine1', - 'address_line2': 'addressLine2', - 'address_line3': 'addressLine3', - 'city': 'city', - 'province': 'province', - 'country': 'country', - 'postcode': 'postcode', - 'landline': 'landline', - 'primary_address': 'primaryAddress' - } - - self._profile_id = profile_id - self._address_line1 = address_line1 - self._address_line2 = address_line2 - self._address_line3 = address_line3 - self._city = city - self._province = province - self._country = country - self._postcode = postcode - self._landline = landline - self._primary_address = primary_address - - @property - def profile_id(self): - """ - Gets the profile_id of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The profile_id of this CreateAddressRequest. - :rtype: str - """ - return self._profile_id - - @profile_id.setter - def profile_id(self, profile_id): - """ - Sets the profile_id of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param profile_id: The profile_id of this CreateAddressRequest. - :type: str - """ - - self._profile_id = profile_id - - @property - def address_line1(self): - """ - Gets the address_line1 of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The address_line1 of this CreateAddressRequest. - :rtype: str - """ - return self._address_line1 - - @address_line1.setter - def address_line1(self, address_line1): - """ - Sets the address_line1 of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param address_line1: The address_line1 of this CreateAddressRequest. - :type: str - """ - - self._address_line1 = address_line1 - - @property - def address_line2(self): - """ - Gets the address_line2 of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The address_line2 of this CreateAddressRequest. - :rtype: str - """ - return self._address_line2 - - @address_line2.setter - def address_line2(self, address_line2): - """ - Sets the address_line2 of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param address_line2: The address_line2 of this CreateAddressRequest. - :type: str - """ - - self._address_line2 = address_line2 - - @property - def address_line3(self): - """ - Gets the address_line3 of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The address_line3 of this CreateAddressRequest. - :rtype: str - """ - return self._address_line3 - - @address_line3.setter - def address_line3(self, address_line3): - """ - Sets the address_line3 of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param address_line3: The address_line3 of this CreateAddressRequest. - :type: str - """ - - self._address_line3 = address_line3 - - @property - def city(self): - """ - Gets the city of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The city of this CreateAddressRequest. - :rtype: str - """ - return self._city - - @city.setter - def city(self, city): - """ - Sets the city of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param city: The city of this CreateAddressRequest. - :type: str - """ - - self._city = city - - @property - def province(self): - """ - Gets the province of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The province of this CreateAddressRequest. - :rtype: str - """ - return self._province - - @province.setter - def province(self, province): - """ - Sets the province of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param province: The province of this CreateAddressRequest. - :type: str - """ - - self._province = province - - @property - def country(self): - """ - Gets the country of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The country of this CreateAddressRequest. - :rtype: str - """ - return self._country - - @country.setter - def country(self, country): - """ - Sets the country of this CreateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param country: The country of this CreateAddressRequest. - :type: str - """ - - self._country = country - - @property - def postcode(self): - """ - Gets the postcode of this CreateAddressRequest. - { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The postcode of this CreateAddressRequest. - :rtype: str - """ - return self._postcode - - @postcode.setter - def postcode(self, postcode): - """ - Sets the postcode of this CreateAddressRequest. - { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param postcode: The postcode of this CreateAddressRequest. - :type: str - """ - - self._postcode = postcode - - @property - def landline(self): - """ - Gets the landline of this CreateAddressRequest. - { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The landline of this CreateAddressRequest. - :rtype: str - """ - return self._landline - - @landline.setter - def landline(self, landline): - """ - Sets the landline of this CreateAddressRequest. - { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param landline: The landline of this CreateAddressRequest. - :type: str - """ - - self._landline = landline - - @property - def primary_address(self): - """ - Gets the primary_address of this CreateAddressRequest. - { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The primary_address of this CreateAddressRequest. - :rtype: bool - """ - return self._primary_address - - @primary_address.setter - def primary_address(self, primary_address): - """ - Sets the primary_address of this CreateAddressRequest. - { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param primary_address: The primary_address of this CreateAddressRequest. - :type: bool - """ - - self._primary_address = primary_address - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/create_aggregating_component_request.py b/billforward/models/create_aggregating_component_request.py index 12e7c9e..f1fc078 100644 --- a/billforward/models/create_aggregating_component_request.py +++ b/billforward/models/create_aggregating_component_request.py @@ -1,79 +1,73 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class CreateAggregatingComponentRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, pricing_component=None, organization_id=None): - """ - CreateAggregatingComponentRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'pricing_component': 'str', - 'organization_id': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'pricing_component': 'pricingComponent', - 'organization_id': 'organizationID' - } - - self._created = created - self._pricing_component = pricing_component - self._organization_id = organization_id + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'pricing_component': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'pricing_component': 'pricingComponent', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, pricing_component=None, organization_id=None): # noqa: E501 + """CreateAggregatingComponentRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._pricing_component = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if pricing_component is not None: + self.pricing_component = pricing_component + if organization_id is not None: + self.organization_id = organization_id @property def created(self): - """ - Gets the created of this CreateAggregatingComponentRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this CreateAggregatingComponentRequest. # noqa: E501 - :return: The created of this CreateAggregatingComponentRequest. + + :return: The created of this CreateAggregatingComponentRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this CreateAggregatingComponentRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this CreateAggregatingComponentRequest. - :param created: The created of this CreateAggregatingComponentRequest. + + :param created: The created of this CreateAggregatingComponentRequest. # noqa: E501 :type: datetime """ @@ -81,22 +75,20 @@ def created(self, created): @property def pricing_component(self): - """ - Gets the pricing_component of this CreateAggregatingComponentRequest. - {\"description\":\"Name of the pricing component upon which to aggregate. The subscriber to the aggregating rate plan (which contains the AggregatingComponent specified here), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches the ID of the component identified here. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge — to account for the more favourable price tiering that emerges when aggregating.\",\"verbs\":[\"POST\"]} + """Gets the pricing_component of this CreateAggregatingComponentRequest. # noqa: E501 - :return: The pricing_component of this CreateAggregatingComponentRequest. + + :return: The pricing_component of this CreateAggregatingComponentRequest. # noqa: E501 :rtype: str """ return self._pricing_component @pricing_component.setter def pricing_component(self, pricing_component): - """ - Sets the pricing_component of this CreateAggregatingComponentRequest. - {\"description\":\"Name of the pricing component upon which to aggregate. The subscriber to the aggregating rate plan (which contains the AggregatingComponent specified here), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches the ID of the component identified here. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge — to account for the more favourable price tiering that emerges when aggregating.\",\"verbs\":[\"POST\"]} + """Sets the pricing_component of this CreateAggregatingComponentRequest. + - :param pricing_component: The pricing_component of this CreateAggregatingComponentRequest. + :param pricing_component: The pricing_component of this CreateAggregatingComponentRequest. # noqa: E501 :type: str """ @@ -104,34 +96,30 @@ def pricing_component(self, pricing_component): @property def organization_id(self): - """ - Gets the organization_id of this CreateAggregatingComponentRequest. - {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} + """Gets the organization_id of this CreateAggregatingComponentRequest. # noqa: E501 + - :return: The organization_id of this CreateAggregatingComponentRequest. + :return: The organization_id of this CreateAggregatingComponentRequest. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this CreateAggregatingComponentRequest. - {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} + """Sets the organization_id of this CreateAggregatingComponentRequest. + - :param organization_id: The organization_id of this CreateAggregatingComponentRequest. + :param organization_id: The organization_id of this CreateAggregatingComponentRequest. # noqa: E501 :type: str """ self._organization_id = organization_id def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -148,29 +136,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CreateAggregatingComponentRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CreateAggregatingComponentRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/create_aggregating_subscription_request.py b/billforward/models/create_aggregating_subscription_request.py index cf092dd..c9d9890 100644 --- a/billforward/models/create_aggregating_subscription_request.py +++ b/billforward/models/create_aggregating_subscription_request.py @@ -1,112 +1,153 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class CreateAggregatingSubscriptionRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, account_id=None, organization_id=None, name=None, description=None, start=None, state=None, product_rate_plan=None, duration=None, duration_period=None, product_type=None, aggregating_components=None, aggregate_all_subscriptions_on_account=False, currency=None): - """ - CreateAggregatingSubscriptionRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'account_id': 'str', - 'organization_id': 'str', - 'name': 'str', - 'description': 'str', - 'start': 'datetime', - 'state': 'str', - 'product_rate_plan': 'str', - 'duration': 'int', - 'duration_period': 'str', - 'product_type': 'str', - 'aggregating_components': 'list[CreateAggregatingComponentRequest]', - 'aggregate_all_subscriptions_on_account': 'bool', - 'currency': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'account_id': 'accountID', - 'organization_id': 'organizationID', - 'name': 'name', - 'description': 'description', - 'start': 'start', - 'state': 'state', - 'product_rate_plan': 'productRatePlan', - 'duration': 'duration', - 'duration_period': 'durationPeriod', - 'product_type': 'productType', - 'aggregating_components': 'aggregatingComponents', - 'aggregate_all_subscriptions_on_account': 'aggregateAllSubscriptionsOnAccount', - 'currency': 'currency' - } - - self._created = created - self._account_id = account_id - self._organization_id = organization_id - self._name = name - self._description = description - self._start = start - self._state = state - self._product_rate_plan = product_rate_plan - self._duration = duration - self._duration_period = duration_period - self._product_type = product_type - self._aggregating_components = aggregating_components - self._aggregate_all_subscriptions_on_account = aggregate_all_subscriptions_on_account - self._currency = currency + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'account_id': 'str', + 'organization_id': 'str', + 'name': 'str', + 'description': 'str', + 'start': 'datetime', + 'end': 'datetime', + 'state': 'str', + 'product_rate_plan': 'str', + 'duration': 'int', + 'duration_period': 'str', + 'product_type': 'str', + 'aggregating_components': 'list[CreateAggregatingComponentRequest]', + 'aggregate_all_subscriptions_on_account': 'bool', + 'currency': 'CreditNoteCurrency', + 'failed_payment_behaviour': 'str', + 'payment_terms': 'int', + 'purchase_order': 'str', + 'align_period_with_aggregating_subscription': 'bool' + } + + attribute_map = { + 'created': 'created', + 'account_id': 'accountID', + 'organization_id': 'organizationID', + 'name': 'name', + 'description': 'description', + 'start': 'start', + 'end': 'end', + 'state': 'state', + 'product_rate_plan': 'productRatePlan', + 'duration': 'duration', + 'duration_period': 'durationPeriod', + 'product_type': 'productType', + 'aggregating_components': 'aggregatingComponents', + 'aggregate_all_subscriptions_on_account': 'aggregateAllSubscriptionsOnAccount', + 'currency': 'currency', + 'failed_payment_behaviour': 'failedPaymentBehaviour', + 'payment_terms': 'paymentTerms', + 'purchase_order': 'purchaseOrder', + 'align_period_with_aggregating_subscription': 'alignPeriodWithAggregatingSubscription' + } + + def __init__(self, created=None, account_id=None, organization_id=None, name=None, description=None, start=None, end=None, state=None, product_rate_plan=None, duration=None, duration_period=None, product_type=None, aggregating_components=None, aggregate_all_subscriptions_on_account=None, currency=None, failed_payment_behaviour=None, payment_terms=None, purchase_order=None, align_period_with_aggregating_subscription=None): # noqa: E501 + """CreateAggregatingSubscriptionRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._account_id = None + self._organization_id = None + self._name = None + self._description = None + self._start = None + self._end = None + self._state = None + self._product_rate_plan = None + self._duration = None + self._duration_period = None + self._product_type = None + self._aggregating_components = None + self._aggregate_all_subscriptions_on_account = None + self._currency = None + self._failed_payment_behaviour = None + self._payment_terms = None + self._purchase_order = None + self._align_period_with_aggregating_subscription = None + self.discriminator = None + if created is not None: + self.created = created + if account_id is not None: + self.account_id = account_id + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if description is not None: + self.description = description + if start is not None: + self.start = start + if end is not None: + self.end = end + if state is not None: + self.state = state + if product_rate_plan is not None: + self.product_rate_plan = product_rate_plan + if duration is not None: + self.duration = duration + if duration_period is not None: + self.duration_period = duration_period + if product_type is not None: + self.product_type = product_type + if aggregating_components is not None: + self.aggregating_components = aggregating_components + if aggregate_all_subscriptions_on_account is not None: + self.aggregate_all_subscriptions_on_account = aggregate_all_subscriptions_on_account + if currency is not None: + self.currency = currency + if failed_payment_behaviour is not None: + self.failed_payment_behaviour = failed_payment_behaviour + if payment_terms is not None: + self.payment_terms = payment_terms + if purchase_order is not None: + self.purchase_order = purchase_order + if align_period_with_aggregating_subscription is not None: + self.align_period_with_aggregating_subscription = align_period_with_aggregating_subscription @property def created(self): - """ - Gets the created of this CreateAggregatingSubscriptionRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this CreateAggregatingSubscriptionRequest. # noqa: E501 + - :return: The created of this CreateAggregatingSubscriptionRequest. + :return: The created of this CreateAggregatingSubscriptionRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this CreateAggregatingSubscriptionRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this CreateAggregatingSubscriptionRequest. + - :param created: The created of this CreateAggregatingSubscriptionRequest. + :param created: The created of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: datetime """ @@ -114,22 +155,20 @@ def created(self, created): @property def account_id(self): - """ - Gets the account_id of this CreateAggregatingSubscriptionRequest. - {\"description\":\"ID of the BillForward Account who will own this aggregating subscription. You should ensure beforehand that the customer has had a BillForward Account created for them.\",\"verbs\":[\"POST\"]} + """Gets the account_id of this CreateAggregatingSubscriptionRequest. # noqa: E501 - :return: The account_id of this CreateAggregatingSubscriptionRequest. + + :return: The account_id of this CreateAggregatingSubscriptionRequest. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this CreateAggregatingSubscriptionRequest. - {\"description\":\"ID of the BillForward Account who will own this aggregating subscription. You should ensure beforehand that the customer has had a BillForward Account created for them.\",\"verbs\":[\"POST\"]} + """Sets the account_id of this CreateAggregatingSubscriptionRequest. - :param account_id: The account_id of this CreateAggregatingSubscriptionRequest. + + :param account_id: The account_id of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: str """ @@ -137,22 +176,20 @@ def account_id(self, account_id): @property def organization_id(self): - """ - Gets the organization_id of this CreateAggregatingSubscriptionRequest. - {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested Subscription should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} + """Gets the organization_id of this CreateAggregatingSubscriptionRequest. # noqa: E501 + - :return: The organization_id of this CreateAggregatingSubscriptionRequest. + :return: The organization_id of this CreateAggregatingSubscriptionRequest. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this CreateAggregatingSubscriptionRequest. - {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested Subscription should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} + """Sets the organization_id of this CreateAggregatingSubscriptionRequest. + - :param organization_id: The organization_id of this CreateAggregatingSubscriptionRequest. + :param organization_id: The organization_id of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: str """ @@ -160,22 +197,20 @@ def organization_id(self, organization_id): @property def name(self): - """ - Gets the name of this CreateAggregatingSubscriptionRequest. - {\"default\":\"(Subscription will be named after the rate plan to which the subscription subscribes)\",\"description\":\"Name of the created subscription. This is primarily for your benefit — for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'BusinessCorp subscriptions, care of Mr Business (mr@busy.com)').\",\"verbs\":[\"POST\"]} + """Gets the name of this CreateAggregatingSubscriptionRequest. # noqa: E501 + - :return: The name of this CreateAggregatingSubscriptionRequest. + :return: The name of this CreateAggregatingSubscriptionRequest. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this CreateAggregatingSubscriptionRequest. - {\"default\":\"(Subscription will be named after the rate plan to which the subscription subscribes)\",\"description\":\"Name of the created subscription. This is primarily for your benefit — for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'BusinessCorp subscriptions, care of Mr Business (mr@busy.com)').\",\"verbs\":[\"POST\"]} + """Sets the name of this CreateAggregatingSubscriptionRequest. + - :param name: The name of this CreateAggregatingSubscriptionRequest. + :param name: The name of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: str """ @@ -183,22 +218,20 @@ def name(self, name): @property def description(self): - """ - Gets the description of this CreateAggregatingSubscriptionRequest. - {\"default\":\"(null)\",\"description\":\"Description of the created subscription. This is primarily for your benefit — for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Business signed up using BUSYGUYS coupon, at management trade show').\",\"verbs\":[\"POST\"]} + """Gets the description of this CreateAggregatingSubscriptionRequest. # noqa: E501 + - :return: The description of this CreateAggregatingSubscriptionRequest. + :return: The description of this CreateAggregatingSubscriptionRequest. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this CreateAggregatingSubscriptionRequest. - {\"default\":\"(null)\",\"description\":\"Description of the created subscription. This is primarily for your benefit — for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Business signed up using BUSYGUYS coupon, at management trade show').\",\"verbs\":[\"POST\"]} + """Sets the description of this CreateAggregatingSubscriptionRequest. - :param description: The description of this CreateAggregatingSubscriptionRequest. + + :param description: The description of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: str """ @@ -206,51 +239,68 @@ def description(self, description): @property def start(self): - """ - Gets the start of this CreateAggregatingSubscriptionRequest. - {\"default\":\"(ServerNow upon receiving request)\",\"description\":\"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.\",\"verbs\":[\"POST\"]} + """Gets the start of this CreateAggregatingSubscriptionRequest. # noqa: E501 - :return: The start of this CreateAggregatingSubscriptionRequest. + + :return: The start of this CreateAggregatingSubscriptionRequest. # noqa: E501 :rtype: datetime """ return self._start @start.setter def start(self, start): - """ - Sets the start of this CreateAggregatingSubscriptionRequest. - {\"default\":\"(ServerNow upon receiving request)\",\"description\":\"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.\",\"verbs\":[\"POST\"]} + """Sets the start of this CreateAggregatingSubscriptionRequest. + - :param start: The start of this CreateAggregatingSubscriptionRequest. + :param start: The start of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: datetime """ self._start = start @property - def state(self): + def end(self): + """Gets the end of this CreateAggregatingSubscriptionRequest. # noqa: E501 + + + :return: The end of this CreateAggregatingSubscriptionRequest. # noqa: E501 + :rtype: datetime """ - Gets the state of this CreateAggregatingSubscriptionRequest. - {\"default\":\"Provisioned\",\"description\":\"The state in which the created subscription will begin.
Provisioned — The subscription will wait (without raising any invoices or beginning its service) until explicit action is taken to change its state.
AwaitingPayment — The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.\",\"verbs\":[\"POST\"]} + return self._end + + @end.setter + def end(self, end): + """Sets the end of this CreateAggregatingSubscriptionRequest. - :return: The state of this CreateAggregatingSubscriptionRequest. + + :param end: The end of this CreateAggregatingSubscriptionRequest. # noqa: E501 + :type: datetime + """ + + self._end = end + + @property + def state(self): + """Gets the state of this CreateAggregatingSubscriptionRequest. # noqa: E501 + + + :return: The state of this CreateAggregatingSubscriptionRequest. # noqa: E501 :rtype: str """ return self._state @state.setter def state(self, state): - """ - Sets the state of this CreateAggregatingSubscriptionRequest. - {\"default\":\"Provisioned\",\"description\":\"The state in which the created subscription will begin.
Provisioned — The subscription will wait (without raising any invoices or beginning its service) until explicit action is taken to change its state.
AwaitingPayment — The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.\",\"verbs\":[\"POST\"]} + """Sets the state of this CreateAggregatingSubscriptionRequest. + - :param state: The state of this CreateAggregatingSubscriptionRequest. + :param state: The state of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: str """ - allowed_values = ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"] + allowed_values = ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"] # noqa: E501 if state not in allowed_values: raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 .format(state, allowed_values) ) @@ -258,22 +308,20 @@ def state(self, state): @property def product_rate_plan(self): - """ - Gets the product_rate_plan of this CreateAggregatingSubscriptionRequest. - {\"description\":\"ID of the rate plan to which the subscription will be subscribing. If omitted: it will be assumed you wish to create a new rate plan as part of this request — this subscription will subscribe to that newly-created rate plan.\",\"verbs\":[\"POST\"]} + """Gets the product_rate_plan of this CreateAggregatingSubscriptionRequest. # noqa: E501 + - :return: The product_rate_plan of this CreateAggregatingSubscriptionRequest. + :return: The product_rate_plan of this CreateAggregatingSubscriptionRequest. # noqa: E501 :rtype: str """ return self._product_rate_plan @product_rate_plan.setter def product_rate_plan(self, product_rate_plan): - """ - Sets the product_rate_plan of this CreateAggregatingSubscriptionRequest. - {\"description\":\"ID of the rate plan to which the subscription will be subscribing. If omitted: it will be assumed you wish to create a new rate plan as part of this request — this subscription will subscribe to that newly-created rate plan.\",\"verbs\":[\"POST\"]} + """Sets the product_rate_plan of this CreateAggregatingSubscriptionRequest. + - :param product_rate_plan: The product_rate_plan of this CreateAggregatingSubscriptionRequest. + :param product_rate_plan: The product_rate_plan of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: str """ @@ -281,22 +329,20 @@ def product_rate_plan(self, product_rate_plan): @property def duration(self): - """ - Gets the duration of this CreateAggregatingSubscriptionRequest. - {\"description\":\"[Required if and only if `productRatePlan` is omitted] Number of length-measures which constitute the rate plan's period.\",\"verbs\":[\"POST\"]} + """Gets the duration of this CreateAggregatingSubscriptionRequest. # noqa: E501 + - :return: The duration of this CreateAggregatingSubscriptionRequest. + :return: The duration of this CreateAggregatingSubscriptionRequest. # noqa: E501 :rtype: int """ return self._duration @duration.setter def duration(self, duration): - """ - Sets the duration of this CreateAggregatingSubscriptionRequest. - {\"description\":\"[Required if and only if `productRatePlan` is omitted] Number of length-measures which constitute the rate plan's period.\",\"verbs\":[\"POST\"]} + """Sets the duration of this CreateAggregatingSubscriptionRequest. - :param duration: The duration of this CreateAggregatingSubscriptionRequest. + + :param duration: The duration of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: int """ @@ -304,28 +350,26 @@ def duration(self, duration): @property def duration_period(self): - """ - Gets the duration_period of this CreateAggregatingSubscriptionRequest. - {\"description\":\"[Required if and only if `productRatePlan` is omitted] Measure describing the magnitude of the rate plan's period.\",\"verbs\":[\"POST\"]} + """Gets the duration_period of this CreateAggregatingSubscriptionRequest. # noqa: E501 - :return: The duration_period of this CreateAggregatingSubscriptionRequest. + + :return: The duration_period of this CreateAggregatingSubscriptionRequest. # noqa: E501 :rtype: str """ return self._duration_period @duration_period.setter def duration_period(self, duration_period): - """ - Sets the duration_period of this CreateAggregatingSubscriptionRequest. - {\"description\":\"[Required if and only if `productRatePlan` is omitted] Measure describing the magnitude of the rate plan's period.\",\"verbs\":[\"POST\"]} + """Sets the duration_period of this CreateAggregatingSubscriptionRequest. - :param duration_period: The duration_period of this CreateAggregatingSubscriptionRequest. + + :param duration_period: The duration_period of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: str """ - allowed_values = ["minutes", "days", "months", "years"] + allowed_values = ["minutes", "days", "months", "years"] # noqa: E501 if duration_period not in allowed_values: raise ValueError( - "Invalid value for `duration_period` ({0}), must be one of {1}" + "Invalid value for `duration_period` ({0}), must be one of {1}" # noqa: E501 .format(duration_period, allowed_values) ) @@ -333,28 +377,26 @@ def duration_period(self, duration_period): @property def product_type(self): - """ - Gets the product_type of this CreateAggregatingSubscriptionRequest. - {\"description\":\"[Required if and only if `productRatePlan` is omitted] The frequency of the rate plan — either recurring or non-recurring.\",\"verbs\":[\"POST\"]} + """Gets the product_type of this CreateAggregatingSubscriptionRequest. # noqa: E501 - :return: The product_type of this CreateAggregatingSubscriptionRequest. + + :return: The product_type of this CreateAggregatingSubscriptionRequest. # noqa: E501 :rtype: str """ return self._product_type @product_type.setter def product_type(self, product_type): - """ - Sets the product_type of this CreateAggregatingSubscriptionRequest. - {\"description\":\"[Required if and only if `productRatePlan` is omitted] The frequency of the rate plan — either recurring or non-recurring.\",\"verbs\":[\"POST\"]} + """Sets the product_type of this CreateAggregatingSubscriptionRequest. + - :param product_type: The product_type of this CreateAggregatingSubscriptionRequest. + :param product_type: The product_type of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: str """ - allowed_values = ["nonrecurring", "recurring"] + allowed_values = ["non-recurring", "recurring"] # noqa: E501 if product_type not in allowed_values: raise ValueError( - "Invalid value for `product_type` ({0}), must be one of {1}" + "Invalid value for `product_type` ({0}), must be one of {1}" # noqa: E501 .format(product_type, allowed_values) ) @@ -362,22 +404,20 @@ def product_type(self, product_type): @property def aggregating_components(self): - """ - Gets the aggregating_components of this CreateAggregatingSubscriptionRequest. - {\"default\":\"(empty list)\",\"description\":\"[Required if and only if `productRatePlan` is omitted] List of components whose prices should be recalculated upon invoice aggregation. For example: two subscriptions' individual consumptions may neither of them be large enough to achieve bulk buy discounts. When aggregated, though, the same two subscriptions' consumption may add up to a quantity which does merit a bulk buy discount within your tiering system.\",\"verbs\":[\"POST\"]} + """Gets the aggregating_components of this CreateAggregatingSubscriptionRequest. # noqa: E501 + - :return: The aggregating_components of this CreateAggregatingSubscriptionRequest. + :return: The aggregating_components of this CreateAggregatingSubscriptionRequest. # noqa: E501 :rtype: list[CreateAggregatingComponentRequest] """ return self._aggregating_components @aggregating_components.setter def aggregating_components(self, aggregating_components): - """ - Sets the aggregating_components of this CreateAggregatingSubscriptionRequest. - {\"default\":\"(empty list)\",\"description\":\"[Required if and only if `productRatePlan` is omitted] List of components whose prices should be recalculated upon invoice aggregation. For example: two subscriptions' individual consumptions may neither of them be large enough to achieve bulk buy discounts. When aggregated, though, the same two subscriptions' consumption may add up to a quantity which does merit a bulk buy discount within your tiering system.\",\"verbs\":[\"POST\"]} + """Sets the aggregating_components of this CreateAggregatingSubscriptionRequest. + - :param aggregating_components: The aggregating_components of this CreateAggregatingSubscriptionRequest. + :param aggregating_components: The aggregating_components of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: list[CreateAggregatingComponentRequest] """ @@ -385,22 +425,20 @@ def aggregating_components(self, aggregating_components): @property def aggregate_all_subscriptions_on_account(self): - """ - Gets the aggregate_all_subscriptions_on_account of this CreateAggregatingSubscriptionRequest. - {\"default\":false,\"description\":\"Whether this 'aggregating subscription' should collect charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.\",\"verbs\":[\"POST\"]} + """Gets the aggregate_all_subscriptions_on_account of this CreateAggregatingSubscriptionRequest. # noqa: E501 - :return: The aggregate_all_subscriptions_on_account of this CreateAggregatingSubscriptionRequest. + + :return: The aggregate_all_subscriptions_on_account of this CreateAggregatingSubscriptionRequest. # noqa: E501 :rtype: bool """ return self._aggregate_all_subscriptions_on_account @aggregate_all_subscriptions_on_account.setter def aggregate_all_subscriptions_on_account(self, aggregate_all_subscriptions_on_account): - """ - Sets the aggregate_all_subscriptions_on_account of this CreateAggregatingSubscriptionRequest. - {\"default\":false,\"description\":\"Whether this 'aggregating subscription' should collect charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.\",\"verbs\":[\"POST\"]} + """Sets the aggregate_all_subscriptions_on_account of this CreateAggregatingSubscriptionRequest. - :param aggregate_all_subscriptions_on_account: The aggregate_all_subscriptions_on_account of this CreateAggregatingSubscriptionRequest. + + :param aggregate_all_subscriptions_on_account: The aggregate_all_subscriptions_on_account of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: bool """ @@ -408,34 +446,120 @@ def aggregate_all_subscriptions_on_account(self, aggregate_all_subscriptions_on_ @property def currency(self): - """ - Gets the currency of this CreateAggregatingSubscriptionRequest. - {\"description\":\"[Required if and only if `productRatePlan` is omitted] The currency of the product-rate-plan — as specified by a three-character ISO 4217 currency code (i.e. USD).\",\"verbs\":[\"POST\"]} + """Gets the currency of this CreateAggregatingSubscriptionRequest. # noqa: E501 - :return: The currency of this CreateAggregatingSubscriptionRequest. - :rtype: str + + :return: The currency of this CreateAggregatingSubscriptionRequest. # noqa: E501 + :rtype: CreditNoteCurrency """ return self._currency @currency.setter def currency(self, currency): + """Sets the currency of this CreateAggregatingSubscriptionRequest. + + + :param currency: The currency of this CreateAggregatingSubscriptionRequest. # noqa: E501 + :type: CreditNoteCurrency """ - Sets the currency of this CreateAggregatingSubscriptionRequest. - {\"description\":\"[Required if and only if `productRatePlan` is omitted] The currency of the product-rate-plan — as specified by a three-character ISO 4217 currency code (i.e. USD).\",\"verbs\":[\"POST\"]} - :param currency: The currency of this CreateAggregatingSubscriptionRequest. + self._currency = currency + + @property + def failed_payment_behaviour(self): + """Gets the failed_payment_behaviour of this CreateAggregatingSubscriptionRequest. # noqa: E501 + + + :return: The failed_payment_behaviour of this CreateAggregatingSubscriptionRequest. # noqa: E501 + :rtype: str + """ + return self._failed_payment_behaviour + + @failed_payment_behaviour.setter + def failed_payment_behaviour(self, failed_payment_behaviour): + """Sets the failed_payment_behaviour of this CreateAggregatingSubscriptionRequest. + + + :param failed_payment_behaviour: The failed_payment_behaviour of this CreateAggregatingSubscriptionRequest. # noqa: E501 :type: str """ + allowed_values = ["CancelSubscription", "None"] # noqa: E501 + if failed_payment_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `failed_payment_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(failed_payment_behaviour, allowed_values) + ) + + self._failed_payment_behaviour = failed_payment_behaviour + + @property + def payment_terms(self): + """Gets the payment_terms of this CreateAggregatingSubscriptionRequest. # noqa: E501 + + + :return: The payment_terms of this CreateAggregatingSubscriptionRequest. # noqa: E501 + :rtype: int + """ + return self._payment_terms - self._currency = currency + @payment_terms.setter + def payment_terms(self, payment_terms): + """Sets the payment_terms of this CreateAggregatingSubscriptionRequest. - def to_dict(self): + + :param payment_terms: The payment_terms of this CreateAggregatingSubscriptionRequest. # noqa: E501 + :type: int """ - Returns the model properties as a dict + + self._payment_terms = payment_terms + + @property + def purchase_order(self): + """Gets the purchase_order of this CreateAggregatingSubscriptionRequest. # noqa: E501 + + + :return: The purchase_order of this CreateAggregatingSubscriptionRequest. # noqa: E501 + :rtype: str """ + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this CreateAggregatingSubscriptionRequest. + + + :param purchase_order: The purchase_order of this CreateAggregatingSubscriptionRequest. # noqa: E501 + :type: str + """ + + self._purchase_order = purchase_order + + @property + def align_period_with_aggregating_subscription(self): + """Gets the align_period_with_aggregating_subscription of this CreateAggregatingSubscriptionRequest. # noqa: E501 + + + :return: The align_period_with_aggregating_subscription of this CreateAggregatingSubscriptionRequest. # noqa: E501 + :rtype: bool + """ + return self._align_period_with_aggregating_subscription + + @align_period_with_aggregating_subscription.setter + def align_period_with_aggregating_subscription(self, align_period_with_aggregating_subscription): + """Sets the align_period_with_aggregating_subscription of this CreateAggregatingSubscriptionRequest. + + + :param align_period_with_aggregating_subscription: The align_period_with_aggregating_subscription of this CreateAggregatingSubscriptionRequest. # noqa: E501 + :type: bool + """ + + self._align_period_with_aggregating_subscription = align_period_with_aggregating_subscription + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -452,29 +576,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CreateAggregatingSubscriptionRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CreateAggregatingSubscriptionRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/create_commission_invoice_request.py b/billforward/models/create_commission_invoice_request.py new file mode 100644 index 0000000..df171a8 --- /dev/null +++ b/billforward/models/create_commission_invoice_request.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreateCommissionInvoiceRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'currencies': 'list[str]' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'currencies': 'currencies' + } + + def __init__(self, organization_id=None, currencies=None): # noqa: E501 + """CreateCommissionInvoiceRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._currencies = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if currencies is not None: + self.currencies = currencies + + @property + def organization_id(self): + """Gets the organization_id of this CreateCommissionInvoiceRequest. # noqa: E501 + + + :return: The organization_id of this CreateCommissionInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CreateCommissionInvoiceRequest. + + + :param organization_id: The organization_id of this CreateCommissionInvoiceRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def currencies(self): + """Gets the currencies of this CreateCommissionInvoiceRequest. # noqa: E501 + + + :return: The currencies of this CreateCommissionInvoiceRequest. # noqa: E501 + :rtype: list[str] + """ + return self._currencies + + @currencies.setter + def currencies(self, currencies): + """Sets the currencies of this CreateCommissionInvoiceRequest. + + + :param currencies: The currencies of this CreateCommissionInvoiceRequest. # noqa: E501 + :type: list[str] + """ + + self._currencies = currencies + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreateCommissionInvoiceRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreateCommissionInvoiceRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_contract_period_request.py b/billforward/models/create_contract_period_request.py new file mode 100644 index 0000000..0229ab8 --- /dev/null +++ b/billforward/models/create_contract_period_request.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreateContractPeriodRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'contract_period': 'int', + 'subscription_periods': 'int', + 'quote_id': 'str', + 'purchase_order': 'str' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'contract_period': 'contractPeriod', + 'subscription_periods': 'subscriptionPeriods', + 'quote_id': 'quoteID', + 'purchase_order': 'purchaseOrder' + } + + def __init__(self, organization_id=None, contract_period=None, subscription_periods=None, quote_id=None, purchase_order=None): # noqa: E501 + """CreateContractPeriodRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._contract_period = None + self._subscription_periods = None + self._quote_id = None + self._purchase_order = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if contract_period is not None: + self.contract_period = contract_period + if subscription_periods is not None: + self.subscription_periods = subscription_periods + if quote_id is not None: + self.quote_id = quote_id + if purchase_order is not None: + self.purchase_order = purchase_order + + @property + def organization_id(self): + """Gets the organization_id of this CreateContractPeriodRequest. # noqa: E501 + + + :return: The organization_id of this CreateContractPeriodRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CreateContractPeriodRequest. + + + :param organization_id: The organization_id of this CreateContractPeriodRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def contract_period(self): + """Gets the contract_period of this CreateContractPeriodRequest. # noqa: E501 + + + :return: The contract_period of this CreateContractPeriodRequest. # noqa: E501 + :rtype: int + """ + return self._contract_period + + @contract_period.setter + def contract_period(self, contract_period): + """Sets the contract_period of this CreateContractPeriodRequest. + + + :param contract_period: The contract_period of this CreateContractPeriodRequest. # noqa: E501 + :type: int + """ + + self._contract_period = contract_period + + @property + def subscription_periods(self): + """Gets the subscription_periods of this CreateContractPeriodRequest. # noqa: E501 + + + :return: The subscription_periods of this CreateContractPeriodRequest. # noqa: E501 + :rtype: int + """ + return self._subscription_periods + + @subscription_periods.setter + def subscription_periods(self, subscription_periods): + """Sets the subscription_periods of this CreateContractPeriodRequest. + + + :param subscription_periods: The subscription_periods of this CreateContractPeriodRequest. # noqa: E501 + :type: int + """ + + self._subscription_periods = subscription_periods + + @property + def quote_id(self): + """Gets the quote_id of this CreateContractPeriodRequest. # noqa: E501 + + + :return: The quote_id of this CreateContractPeriodRequest. # noqa: E501 + :rtype: str + """ + return self._quote_id + + @quote_id.setter + def quote_id(self, quote_id): + """Sets the quote_id of this CreateContractPeriodRequest. + + + :param quote_id: The quote_id of this CreateContractPeriodRequest. # noqa: E501 + :type: str + """ + + self._quote_id = quote_id + + @property + def purchase_order(self): + """Gets the purchase_order of this CreateContractPeriodRequest. # noqa: E501 + + + :return: The purchase_order of this CreateContractPeriodRequest. # noqa: E501 + :rtype: str + """ + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this CreateContractPeriodRequest. + + + :param purchase_order: The purchase_order of this CreateContractPeriodRequest. # noqa: E501 + :type: str + """ + + self._purchase_order = purchase_order + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreateContractPeriodRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreateContractPeriodRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_contract_request.py b/billforward/models/create_contract_request.py new file mode 100644 index 0000000..1b593d2 --- /dev/null +++ b/billforward/models/create_contract_request.py @@ -0,0 +1,352 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreateContractRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'account_id': 'str', + 'name': 'str', + 'description': 'str', + 'start': 'datetime', + 'contract_end_behaviour': 'str', + 'valid_from': 'datetime', + 'valid_till': 'datetime', + 'contract_periods': 'list[CreateContractPeriodRequest]' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'name': 'name', + 'description': 'description', + 'start': 'start', + 'contract_end_behaviour': 'contractEndBehaviour', + 'valid_from': 'validFrom', + 'valid_till': 'validTill', + 'contract_periods': 'contractPeriods' + } + + def __init__(self, created=None, organization_id=None, account_id=None, name=None, description=None, start=None, contract_end_behaviour=None, valid_from=None, valid_till=None, contract_periods=None): # noqa: E501 + """CreateContractRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._account_id = None + self._name = None + self._description = None + self._start = None + self._contract_end_behaviour = None + self._valid_from = None + self._valid_till = None + self._contract_periods = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if name is not None: + self.name = name + if description is not None: + self.description = description + if start is not None: + self.start = start + self.contract_end_behaviour = contract_end_behaviour + self.valid_from = valid_from + if valid_till is not None: + self.valid_till = valid_till + if contract_periods is not None: + self.contract_periods = contract_periods + + @property + def created(self): + """Gets the created of this CreateContractRequest. # noqa: E501 + + + :return: The created of this CreateContractRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this CreateContractRequest. + + + :param created: The created of this CreateContractRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this CreateContractRequest. # noqa: E501 + + + :return: The organization_id of this CreateContractRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CreateContractRequest. + + + :param organization_id: The organization_id of this CreateContractRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_id(self): + """Gets the account_id of this CreateContractRequest. # noqa: E501 + + + :return: The account_id of this CreateContractRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this CreateContractRequest. + + + :param account_id: The account_id of this CreateContractRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def name(self): + """Gets the name of this CreateContractRequest. # noqa: E501 + + + :return: The name of this CreateContractRequest. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this CreateContractRequest. + + + :param name: The name of this CreateContractRequest. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this CreateContractRequest. # noqa: E501 + + + :return: The description of this CreateContractRequest. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this CreateContractRequest. + + + :param description: The description of this CreateContractRequest. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def start(self): + """Gets the start of this CreateContractRequest. # noqa: E501 + + + :return: The start of this CreateContractRequest. # noqa: E501 + :rtype: datetime + """ + return self._start + + @start.setter + def start(self, start): + """Sets the start of this CreateContractRequest. + + + :param start: The start of this CreateContractRequest. # noqa: E501 + :type: datetime + """ + + self._start = start + + @property + def contract_end_behaviour(self): + """Gets the contract_end_behaviour of this CreateContractRequest. # noqa: E501 + + + :return: The contract_end_behaviour of this CreateContractRequest. # noqa: E501 + :rtype: str + """ + return self._contract_end_behaviour + + @contract_end_behaviour.setter + def contract_end_behaviour(self, contract_end_behaviour): + """Sets the contract_end_behaviour of this CreateContractRequest. + + + :param contract_end_behaviour: The contract_end_behaviour of this CreateContractRequest. # noqa: E501 + :type: str + """ + if contract_end_behaviour is None: + raise ValueError("Invalid value for `contract_end_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["ExpireSubscription", "EvergreenSubscription"] # noqa: E501 + if contract_end_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `contract_end_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(contract_end_behaviour, allowed_values) + ) + + self._contract_end_behaviour = contract_end_behaviour + + @property + def valid_from(self): + """Gets the valid_from of this CreateContractRequest. # noqa: E501 + + + :return: The valid_from of this CreateContractRequest. # noqa: E501 + :rtype: datetime + """ + return self._valid_from + + @valid_from.setter + def valid_from(self, valid_from): + """Sets the valid_from of this CreateContractRequest. + + + :param valid_from: The valid_from of this CreateContractRequest. # noqa: E501 + :type: datetime + """ + if valid_from is None: + raise ValueError("Invalid value for `valid_from`, must not be `None`") # noqa: E501 + + self._valid_from = valid_from + + @property + def valid_till(self): + """Gets the valid_till of this CreateContractRequest. # noqa: E501 + + + :return: The valid_till of this CreateContractRequest. # noqa: E501 + :rtype: datetime + """ + return self._valid_till + + @valid_till.setter + def valid_till(self, valid_till): + """Sets the valid_till of this CreateContractRequest. + + + :param valid_till: The valid_till of this CreateContractRequest. # noqa: E501 + :type: datetime + """ + + self._valid_till = valid_till + + @property + def contract_periods(self): + """Gets the contract_periods of this CreateContractRequest. # noqa: E501 + + + :return: The contract_periods of this CreateContractRequest. # noqa: E501 + :rtype: list[CreateContractPeriodRequest] + """ + return self._contract_periods + + @contract_periods.setter + def contract_periods(self, contract_periods): + """Sets the contract_periods of this CreateContractRequest. + + + :param contract_periods: The contract_periods of this CreateContractRequest. # noqa: E501 + :type: list[CreateContractPeriodRequest] + """ + + self._contract_periods = contract_periods + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreateContractRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreateContractRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_coupon_discount_request.py b/billforward/models/create_coupon_discount_request.py new file mode 100644 index 0000000..e3964b7 --- /dev/null +++ b/billforward/models/create_coupon_discount_request.py @@ -0,0 +1,266 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreateCouponDiscountRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'pricing_component': 'str', + 'unit_of_measure': 'str', + 'units_free': 'int', + 'percentage_discount': 'float', + 'cash_discount': 'float', + 'tax_code': 'str' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'pricing_component': 'pricingComponent', + 'unit_of_measure': 'unitOfMeasure', + 'units_free': 'unitsFree', + 'percentage_discount': 'percentageDiscount', + 'cash_discount': 'cashDiscount', + 'tax_code': 'taxCode' + } + + def __init__(self, organization_id=None, pricing_component=None, unit_of_measure=None, units_free=None, percentage_discount=None, cash_discount=None, tax_code=None): # noqa: E501 + """CreateCouponDiscountRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._pricing_component = None + self._unit_of_measure = None + self._units_free = None + self._percentage_discount = None + self._cash_discount = None + self._tax_code = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if pricing_component is not None: + self.pricing_component = pricing_component + if unit_of_measure is not None: + self.unit_of_measure = unit_of_measure + if units_free is not None: + self.units_free = units_free + if percentage_discount is not None: + self.percentage_discount = percentage_discount + if cash_discount is not None: + self.cash_discount = cash_discount + if tax_code is not None: + self.tax_code = tax_code + + @property + def organization_id(self): + """Gets the organization_id of this CreateCouponDiscountRequest. # noqa: E501 + + + :return: The organization_id of this CreateCouponDiscountRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CreateCouponDiscountRequest. + + + :param organization_id: The organization_id of this CreateCouponDiscountRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def pricing_component(self): + """Gets the pricing_component of this CreateCouponDiscountRequest. # noqa: E501 + + + :return: The pricing_component of this CreateCouponDiscountRequest. # noqa: E501 + :rtype: str + """ + return self._pricing_component + + @pricing_component.setter + def pricing_component(self, pricing_component): + """Sets the pricing_component of this CreateCouponDiscountRequest. + + + :param pricing_component: The pricing_component of this CreateCouponDiscountRequest. # noqa: E501 + :type: str + """ + + self._pricing_component = pricing_component + + @property + def unit_of_measure(self): + """Gets the unit_of_measure of this CreateCouponDiscountRequest. # noqa: E501 + + + :return: The unit_of_measure of this CreateCouponDiscountRequest. # noqa: E501 + :rtype: str + """ + return self._unit_of_measure + + @unit_of_measure.setter + def unit_of_measure(self, unit_of_measure): + """Sets the unit_of_measure of this CreateCouponDiscountRequest. + + + :param unit_of_measure: The unit_of_measure of this CreateCouponDiscountRequest. # noqa: E501 + :type: str + """ + + self._unit_of_measure = unit_of_measure + + @property + def units_free(self): + """Gets the units_free of this CreateCouponDiscountRequest. # noqa: E501 + + + :return: The units_free of this CreateCouponDiscountRequest. # noqa: E501 + :rtype: int + """ + return self._units_free + + @units_free.setter + def units_free(self, units_free): + """Sets the units_free of this CreateCouponDiscountRequest. + + + :param units_free: The units_free of this CreateCouponDiscountRequest. # noqa: E501 + :type: int + """ + + self._units_free = units_free + + @property + def percentage_discount(self): + """Gets the percentage_discount of this CreateCouponDiscountRequest. # noqa: E501 + + + :return: The percentage_discount of this CreateCouponDiscountRequest. # noqa: E501 + :rtype: float + """ + return self._percentage_discount + + @percentage_discount.setter + def percentage_discount(self, percentage_discount): + """Sets the percentage_discount of this CreateCouponDiscountRequest. + + + :param percentage_discount: The percentage_discount of this CreateCouponDiscountRequest. # noqa: E501 + :type: float + """ + + self._percentage_discount = percentage_discount + + @property + def cash_discount(self): + """Gets the cash_discount of this CreateCouponDiscountRequest. # noqa: E501 + + + :return: The cash_discount of this CreateCouponDiscountRequest. # noqa: E501 + :rtype: float + """ + return self._cash_discount + + @cash_discount.setter + def cash_discount(self, cash_discount): + """Sets the cash_discount of this CreateCouponDiscountRequest. + + + :param cash_discount: The cash_discount of this CreateCouponDiscountRequest. # noqa: E501 + :type: float + """ + + self._cash_discount = cash_discount + + @property + def tax_code(self): + """Gets the tax_code of this CreateCouponDiscountRequest. # noqa: E501 + + + :return: The tax_code of this CreateCouponDiscountRequest. # noqa: E501 + :rtype: str + """ + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this CreateCouponDiscountRequest. + + + :param tax_code: The tax_code of this CreateCouponDiscountRequest. # noqa: E501 + :type: str + """ + + self._tax_code = tax_code + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreateCouponDiscountRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreateCouponDiscountRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_coupon_request.py b/billforward/models/create_coupon_request.py new file mode 100644 index 0000000..0e0383b --- /dev/null +++ b/billforward/models/create_coupon_request.py @@ -0,0 +1,344 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreateCouponRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'name': 'str', + 'coupon_code': 'str', + 'product': 'str', + 'product_rate_plan': 'str', + 'currency': 'CreditNoteCurrency', + 'coupons': 'int', + 'uses': 'int', + 'parent_coupon_code_redeemable': 'bool', + 'discounts': 'list[CreateCouponDiscountRequest]' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'name': 'name', + 'coupon_code': 'couponCode', + 'product': 'product', + 'product_rate_plan': 'productRatePlan', + 'currency': 'currency', + 'coupons': 'coupons', + 'uses': 'uses', + 'parent_coupon_code_redeemable': 'parentCouponCodeRedeemable', + 'discounts': 'discounts' + } + + def __init__(self, organization_id=None, name=None, coupon_code=None, product=None, product_rate_plan=None, currency=None, coupons=None, uses=None, parent_coupon_code_redeemable=None, discounts=None): # noqa: E501 + """CreateCouponRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._name = None + self._coupon_code = None + self._product = None + self._product_rate_plan = None + self._currency = None + self._coupons = None + self._uses = None + self._parent_coupon_code_redeemable = None + self._discounts = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if coupon_code is not None: + self.coupon_code = coupon_code + if product is not None: + self.product = product + if product_rate_plan is not None: + self.product_rate_plan = product_rate_plan + if currency is not None: + self.currency = currency + if coupons is not None: + self.coupons = coupons + if uses is not None: + self.uses = uses + if parent_coupon_code_redeemable is not None: + self.parent_coupon_code_redeemable = parent_coupon_code_redeemable + if discounts is not None: + self.discounts = discounts + + @property + def organization_id(self): + """Gets the organization_id of this CreateCouponRequest. # noqa: E501 + + + :return: The organization_id of this CreateCouponRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CreateCouponRequest. + + + :param organization_id: The organization_id of this CreateCouponRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def name(self): + """Gets the name of this CreateCouponRequest. # noqa: E501 + + + :return: The name of this CreateCouponRequest. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this CreateCouponRequest. + + + :param name: The name of this CreateCouponRequest. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def coupon_code(self): + """Gets the coupon_code of this CreateCouponRequest. # noqa: E501 + + + :return: The coupon_code of this CreateCouponRequest. # noqa: E501 + :rtype: str + """ + return self._coupon_code + + @coupon_code.setter + def coupon_code(self, coupon_code): + """Sets the coupon_code of this CreateCouponRequest. + + + :param coupon_code: The coupon_code of this CreateCouponRequest. # noqa: E501 + :type: str + """ + + self._coupon_code = coupon_code + + @property + def product(self): + """Gets the product of this CreateCouponRequest. # noqa: E501 + + + :return: The product of this CreateCouponRequest. # noqa: E501 + :rtype: str + """ + return self._product + + @product.setter + def product(self, product): + """Sets the product of this CreateCouponRequest. + + + :param product: The product of this CreateCouponRequest. # noqa: E501 + :type: str + """ + + self._product = product + + @property + def product_rate_plan(self): + """Gets the product_rate_plan of this CreateCouponRequest. # noqa: E501 + + + :return: The product_rate_plan of this CreateCouponRequest. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan + + @product_rate_plan.setter + def product_rate_plan(self, product_rate_plan): + """Sets the product_rate_plan of this CreateCouponRequest. + + + :param product_rate_plan: The product_rate_plan of this CreateCouponRequest. # noqa: E501 + :type: str + """ + + self._product_rate_plan = product_rate_plan + + @property + def currency(self): + """Gets the currency of this CreateCouponRequest. # noqa: E501 + + + :return: The currency of this CreateCouponRequest. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this CreateCouponRequest. + + + :param currency: The currency of this CreateCouponRequest. # noqa: E501 + :type: CreditNoteCurrency + """ + + self._currency = currency + + @property + def coupons(self): + """Gets the coupons of this CreateCouponRequest. # noqa: E501 + + + :return: The coupons of this CreateCouponRequest. # noqa: E501 + :rtype: int + """ + return self._coupons + + @coupons.setter + def coupons(self, coupons): + """Sets the coupons of this CreateCouponRequest. + + + :param coupons: The coupons of this CreateCouponRequest. # noqa: E501 + :type: int + """ + + self._coupons = coupons + + @property + def uses(self): + """Gets the uses of this CreateCouponRequest. # noqa: E501 + + + :return: The uses of this CreateCouponRequest. # noqa: E501 + :rtype: int + """ + return self._uses + + @uses.setter + def uses(self, uses): + """Sets the uses of this CreateCouponRequest. + + + :param uses: The uses of this CreateCouponRequest. # noqa: E501 + :type: int + """ + + self._uses = uses + + @property + def parent_coupon_code_redeemable(self): + """Gets the parent_coupon_code_redeemable of this CreateCouponRequest. # noqa: E501 + + + :return: The parent_coupon_code_redeemable of this CreateCouponRequest. # noqa: E501 + :rtype: bool + """ + return self._parent_coupon_code_redeemable + + @parent_coupon_code_redeemable.setter + def parent_coupon_code_redeemable(self, parent_coupon_code_redeemable): + """Sets the parent_coupon_code_redeemable of this CreateCouponRequest. + + + :param parent_coupon_code_redeemable: The parent_coupon_code_redeemable of this CreateCouponRequest. # noqa: E501 + :type: bool + """ + + self._parent_coupon_code_redeemable = parent_coupon_code_redeemable + + @property + def discounts(self): + """Gets the discounts of this CreateCouponRequest. # noqa: E501 + + + :return: The discounts of this CreateCouponRequest. # noqa: E501 + :rtype: list[CreateCouponDiscountRequest] + """ + return self._discounts + + @discounts.setter + def discounts(self, discounts): + """Sets the discounts of this CreateCouponRequest. + + + :param discounts: The discounts of this CreateCouponRequest. # noqa: E501 + :type: list[CreateCouponDiscountRequest] + """ + + self._discounts = discounts + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreateCouponRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreateCouponRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_offline_payment_request.py b/billforward/models/create_offline_payment_request.py new file mode 100644 index 0000000..803e251 --- /dev/null +++ b/billforward/models/create_offline_payment_request.py @@ -0,0 +1,402 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreateOfflinePaymentRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'amount': 'float', + 'name': 'str', + 'description': 'str', + 'payment_reference': 'str', + 'type': 'str', + 'currency': 'CreditNoteCurrency', + 'payment_received': 'datetime', + 'invoice_id': 'str', + 'account_id': 'str', + 'subscription_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'amount': 'amount', + 'name': 'name', + 'description': 'description', + 'payment_reference': 'paymentReference', + 'type': 'type', + 'currency': 'currency', + 'payment_received': 'paymentReceived', + 'invoice_id': 'invoiceID', + 'account_id': 'accountID', + 'subscription_id': 'subscriptionID' + } + + def __init__(self, created=None, organization_id=None, amount=None, name=None, description=None, payment_reference=None, type=None, currency=None, payment_received=None, invoice_id=None, account_id=None, subscription_id=None): # noqa: E501 + """CreateOfflinePaymentRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._amount = None + self._name = None + self._description = None + self._payment_reference = None + self._type = None + self._currency = None + self._payment_received = None + self._invoice_id = None + self._account_id = None + self._subscription_id = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if amount is not None: + self.amount = amount + if name is not None: + self.name = name + if description is not None: + self.description = description + if payment_reference is not None: + self.payment_reference = payment_reference + if type is not None: + self.type = type + if currency is not None: + self.currency = currency + if payment_received is not None: + self.payment_received = payment_received + if invoice_id is not None: + self.invoice_id = invoice_id + if account_id is not None: + self.account_id = account_id + if subscription_id is not None: + self.subscription_id = subscription_id + + @property + def created(self): + """Gets the created of this CreateOfflinePaymentRequest. # noqa: E501 + + + :return: The created of this CreateOfflinePaymentRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this CreateOfflinePaymentRequest. + + + :param created: The created of this CreateOfflinePaymentRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this CreateOfflinePaymentRequest. # noqa: E501 + + + :return: The organization_id of this CreateOfflinePaymentRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CreateOfflinePaymentRequest. + + + :param organization_id: The organization_id of this CreateOfflinePaymentRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def amount(self): + """Gets the amount of this CreateOfflinePaymentRequest. # noqa: E501 + + + :return: The amount of this CreateOfflinePaymentRequest. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this CreateOfflinePaymentRequest. + + + :param amount: The amount of this CreateOfflinePaymentRequest. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def name(self): + """Gets the name of this CreateOfflinePaymentRequest. # noqa: E501 + + + :return: The name of this CreateOfflinePaymentRequest. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this CreateOfflinePaymentRequest. + + + :param name: The name of this CreateOfflinePaymentRequest. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this CreateOfflinePaymentRequest. # noqa: E501 + + + :return: The description of this CreateOfflinePaymentRequest. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this CreateOfflinePaymentRequest. + + + :param description: The description of this CreateOfflinePaymentRequest. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def payment_reference(self): + """Gets the payment_reference of this CreateOfflinePaymentRequest. # noqa: E501 + + + :return: The payment_reference of this CreateOfflinePaymentRequest. # noqa: E501 + :rtype: str + """ + return self._payment_reference + + @payment_reference.setter + def payment_reference(self, payment_reference): + """Sets the payment_reference of this CreateOfflinePaymentRequest. + + + :param payment_reference: The payment_reference of this CreateOfflinePaymentRequest. # noqa: E501 + :type: str + """ + + self._payment_reference = payment_reference + + @property + def type(self): + """Gets the type of this CreateOfflinePaymentRequest. # noqa: E501 + + + :return: The type of this CreateOfflinePaymentRequest. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this CreateOfflinePaymentRequest. + + + :param type: The type of this CreateOfflinePaymentRequest. # noqa: E501 + :type: str + """ + allowed_values = ["WireTransfer", "Check", "Cash", "Other", "Prepayment"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def currency(self): + """Gets the currency of this CreateOfflinePaymentRequest. # noqa: E501 + + + :return: The currency of this CreateOfflinePaymentRequest. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this CreateOfflinePaymentRequest. + + + :param currency: The currency of this CreateOfflinePaymentRequest. # noqa: E501 + :type: CreditNoteCurrency + """ + + self._currency = currency + + @property + def payment_received(self): + """Gets the payment_received of this CreateOfflinePaymentRequest. # noqa: E501 + + + :return: The payment_received of this CreateOfflinePaymentRequest. # noqa: E501 + :rtype: datetime + """ + return self._payment_received + + @payment_received.setter + def payment_received(self, payment_received): + """Sets the payment_received of this CreateOfflinePaymentRequest. + + + :param payment_received: The payment_received of this CreateOfflinePaymentRequest. # noqa: E501 + :type: datetime + """ + + self._payment_received = payment_received + + @property + def invoice_id(self): + """Gets the invoice_id of this CreateOfflinePaymentRequest. # noqa: E501 + + + :return: The invoice_id of this CreateOfflinePaymentRequest. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this CreateOfflinePaymentRequest. + + + :param invoice_id: The invoice_id of this CreateOfflinePaymentRequest. # noqa: E501 + :type: str + """ + + self._invoice_id = invoice_id + + @property + def account_id(self): + """Gets the account_id of this CreateOfflinePaymentRequest. # noqa: E501 + + + :return: The account_id of this CreateOfflinePaymentRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this CreateOfflinePaymentRequest. + + + :param account_id: The account_id of this CreateOfflinePaymentRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def subscription_id(self): + """Gets the subscription_id of this CreateOfflinePaymentRequest. # noqa: E501 + + + :return: The subscription_id of this CreateOfflinePaymentRequest. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this CreateOfflinePaymentRequest. + + + :param subscription_id: The subscription_id of this CreateOfflinePaymentRequest. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreateOfflinePaymentRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreateOfflinePaymentRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_permission_on_role_request.py b/billforward/models/create_permission_on_role_request.py new file mode 100644 index 0000000..8bbd498 --- /dev/null +++ b/billforward/models/create_permission_on_role_request.py @@ -0,0 +1,202 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreatePermissionOnRoleRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'resource': 'str', + 'action': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'resource': 'resource', + 'action': 'action' + } + + def __init__(self, created=None, organization_id=None, resource=None, action=None): # noqa: E501 + """CreatePermissionOnRoleRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._resource = None + self._action = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + self.resource = resource + self.action = action + + @property + def created(self): + """Gets the created of this CreatePermissionOnRoleRequest. # noqa: E501 + + + :return: The created of this CreatePermissionOnRoleRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this CreatePermissionOnRoleRequest. + + + :param created: The created of this CreatePermissionOnRoleRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this CreatePermissionOnRoleRequest. # noqa: E501 + + + :return: The organization_id of this CreatePermissionOnRoleRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CreatePermissionOnRoleRequest. + + + :param organization_id: The organization_id of this CreatePermissionOnRoleRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def resource(self): + """Gets the resource of this CreatePermissionOnRoleRequest. # noqa: E501 + + + :return: The resource of this CreatePermissionOnRoleRequest. # noqa: E501 + :rtype: str + """ + return self._resource + + @resource.setter + def resource(self, resource): + """Sets the resource of this CreatePermissionOnRoleRequest. + + + :param resource: The resource of this CreatePermissionOnRoleRequest. # noqa: E501 + :type: str + """ + if resource is None: + raise ValueError("Invalid value for `resource`, must not be `None`") # noqa: E501 + allowed_values = ["All", "Account", "Address", "Amendment", "Analytics", "Audit", "BFAdmin", "BFJS", "Charge", "CheckoutDefinition", "Client", "Configuration", "CouponBook", "CouponBookDefinition", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "Coupon", "Credit", "CybersourceToken", "Dunning", "Email", "FixedTerm", "Gateway", "Invoice", "InvoiceTemplateConfiguration", "Metadata", "Notification", "Organization", "OrganizationProfile", "Password", "PaymentMethod", "Payment", "Permission", "PricingComponent", "PricingComponentTier", "PricingComponentValueChange", "PricingComponentValue", "ProductRatePlan", "Product", "ProductResources", "Profile", "SubscriptionNotificationConfiguration", "Quote", "Receipt", "Report", "Refund", "Salesforce", "Search", "Subscription", "Tax", "UnitOfMeasure", "Usage", "Username", "User", "UserResources", "Webhook", "Contract", "Xero", "QuickBooks", "ContractPeriod", "HubSpot", "EmailNotifications", "EmailNotificationsConfig", "Shuttle", "RequestLogging"] # noqa: E501 + if resource not in allowed_values: + raise ValueError( + "Invalid value for `resource` ({0}), must be one of {1}" # noqa: E501 + .format(resource, allowed_values) + ) + + self._resource = resource + + @property + def action(self): + """Gets the action of this CreatePermissionOnRoleRequest. # noqa: E501 + + + :return: The action of this CreatePermissionOnRoleRequest. # noqa: E501 + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """Sets the action of this CreatePermissionOnRoleRequest. + + + :param action: The action of this CreatePermissionOnRoleRequest. # noqa: E501 + :type: str + """ + if action is None: + raise ValueError("Invalid value for `action`, must not be `None`") # noqa: E501 + allowed_values = ["All", "AddToInvoice", "AddToAccount", "AddToProductRatePlan", "AddToSubscription", "Advance", "Aggregate", "RemoveFromInvoice", "RemoveFromProductRatePlan", "RemoveFromSubscription", "Cancel", "Create", "Delete", "Edit", "Execute", "Freeze", "Import", "InvoiceCharges", "Issue", "MetadataCreate", "MetadataEdit", "MetadataDelete", "Migrate", "Read", "Recalculate", "Refund", "Reset", "Resume", "Revive", "Start", "Stop", "Tokenize", "Void"] # noqa: E501 + if action not in allowed_values: + raise ValueError( + "Invalid value for `action` ({0}), must be one of {1}" # noqa: E501 + .format(action, allowed_values) + ) + + self._action = action + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreatePermissionOnRoleRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreatePermissionOnRoleRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_permission_request.py b/billforward/models/create_permission_request.py new file mode 100644 index 0000000..b42b8ba --- /dev/null +++ b/billforward/models/create_permission_request.py @@ -0,0 +1,254 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreatePermissionRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'resource': 'str', + 'action': 'str', + 'role': 'str', + 'role_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'resource': 'resource', + 'action': 'action', + 'role': 'role', + 'role_id': 'roleID' + } + + def __init__(self, created=None, organization_id=None, resource=None, action=None, role=None, role_id=None): # noqa: E501 + """CreatePermissionRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._resource = None + self._action = None + self._role = None + self._role_id = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + self.resource = resource + self.action = action + if role is not None: + self.role = role + if role_id is not None: + self.role_id = role_id + + @property + def created(self): + """Gets the created of this CreatePermissionRequest. # noqa: E501 + + + :return: The created of this CreatePermissionRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this CreatePermissionRequest. + + + :param created: The created of this CreatePermissionRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this CreatePermissionRequest. # noqa: E501 + + + :return: The organization_id of this CreatePermissionRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CreatePermissionRequest. + + + :param organization_id: The organization_id of this CreatePermissionRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def resource(self): + """Gets the resource of this CreatePermissionRequest. # noqa: E501 + + + :return: The resource of this CreatePermissionRequest. # noqa: E501 + :rtype: str + """ + return self._resource + + @resource.setter + def resource(self, resource): + """Sets the resource of this CreatePermissionRequest. + + + :param resource: The resource of this CreatePermissionRequest. # noqa: E501 + :type: str + """ + if resource is None: + raise ValueError("Invalid value for `resource`, must not be `None`") # noqa: E501 + allowed_values = ["All", "Account", "Address", "Amendment", "Analytics", "Audit", "BFAdmin", "BFJS", "Charge", "CheckoutDefinition", "Client", "Configuration", "CouponBook", "CouponBookDefinition", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "Coupon", "Credit", "CybersourceToken", "Dunning", "Email", "FixedTerm", "Gateway", "Invoice", "InvoiceTemplateConfiguration", "Metadata", "Notification", "Organization", "OrganizationProfile", "Password", "PaymentMethod", "Payment", "Permission", "PricingComponent", "PricingComponentTier", "PricingComponentValueChange", "PricingComponentValue", "ProductRatePlan", "Product", "ProductResources", "Profile", "SubscriptionNotificationConfiguration", "Quote", "Receipt", "Report", "Refund", "Salesforce", "Search", "Subscription", "Tax", "UnitOfMeasure", "Usage", "Username", "User", "UserResources", "Webhook", "Contract", "Xero", "QuickBooks", "ContractPeriod", "HubSpot", "EmailNotifications", "EmailNotificationsConfig", "Shuttle", "RequestLogging"] # noqa: E501 + if resource not in allowed_values: + raise ValueError( + "Invalid value for `resource` ({0}), must be one of {1}" # noqa: E501 + .format(resource, allowed_values) + ) + + self._resource = resource + + @property + def action(self): + """Gets the action of this CreatePermissionRequest. # noqa: E501 + + + :return: The action of this CreatePermissionRequest. # noqa: E501 + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """Sets the action of this CreatePermissionRequest. + + + :param action: The action of this CreatePermissionRequest. # noqa: E501 + :type: str + """ + if action is None: + raise ValueError("Invalid value for `action`, must not be `None`") # noqa: E501 + allowed_values = ["All", "AddToInvoice", "AddToAccount", "AddToProductRatePlan", "AddToSubscription", "Advance", "Aggregate", "RemoveFromInvoice", "RemoveFromProductRatePlan", "RemoveFromSubscription", "Cancel", "Create", "Delete", "Edit", "Execute", "Freeze", "Import", "InvoiceCharges", "Issue", "MetadataCreate", "MetadataEdit", "MetadataDelete", "Migrate", "Read", "Recalculate", "Refund", "Reset", "Resume", "Revive", "Start", "Stop", "Tokenize", "Void"] # noqa: E501 + if action not in allowed_values: + raise ValueError( + "Invalid value for `action` ({0}), must be one of {1}" # noqa: E501 + .format(action, allowed_values) + ) + + self._action = action + + @property + def role(self): + """Gets the role of this CreatePermissionRequest. # noqa: E501 + + + :return: The role of this CreatePermissionRequest. # noqa: E501 + :rtype: str + """ + return self._role + + @role.setter + def role(self, role): + """Sets the role of this CreatePermissionRequest. + + + :param role: The role of this CreatePermissionRequest. # noqa: E501 + :type: str + """ + + self._role = role + + @property + def role_id(self): + """Gets the role_id of this CreatePermissionRequest. # noqa: E501 + + + :return: The role_id of this CreatePermissionRequest. # noqa: E501 + :rtype: str + """ + return self._role_id + + @role_id.setter + def role_id(self, role_id): + """Sets the role_id of this CreatePermissionRequest. + + + :param role_id: The role_id of this CreatePermissionRequest. # noqa: E501 + :type: str + """ + + self._role_id = role_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreatePermissionRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreatePermissionRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_pricing_component_quantity_request.py b/billforward/models/create_pricing_component_quantity_request.py new file mode 100644 index 0000000..9c06497 --- /dev/null +++ b/billforward/models/create_pricing_component_quantity_request.py @@ -0,0 +1,266 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreatePricingComponentQuantityRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'pricing_component': 'str', + 'pricing_component_id': 'str', + 'pricing_component_name': 'str', + 'quantity': 'int', + 'percentage_discount': 'float' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'pricing_component': 'pricingComponent', + 'pricing_component_id': 'pricingComponentID', + 'pricing_component_name': 'pricingComponentName', + 'quantity': 'quantity', + 'percentage_discount': 'percentageDiscount' + } + + def __init__(self, created=None, organization_id=None, pricing_component=None, pricing_component_id=None, pricing_component_name=None, quantity=None, percentage_discount=None): # noqa: E501 + """CreatePricingComponentQuantityRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._pricing_component = None + self._pricing_component_id = None + self._pricing_component_name = None + self._quantity = None + self._percentage_discount = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if pricing_component is not None: + self.pricing_component = pricing_component + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if quantity is not None: + self.quantity = quantity + if percentage_discount is not None: + self.percentage_discount = percentage_discount + + @property + def created(self): + """Gets the created of this CreatePricingComponentQuantityRequest. # noqa: E501 + + + :return: The created of this CreatePricingComponentQuantityRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this CreatePricingComponentQuantityRequest. + + + :param created: The created of this CreatePricingComponentQuantityRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this CreatePricingComponentQuantityRequest. # noqa: E501 + + + :return: The organization_id of this CreatePricingComponentQuantityRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CreatePricingComponentQuantityRequest. + + + :param organization_id: The organization_id of this CreatePricingComponentQuantityRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def pricing_component(self): + """Gets the pricing_component of this CreatePricingComponentQuantityRequest. # noqa: E501 + + + :return: The pricing_component of this CreatePricingComponentQuantityRequest. # noqa: E501 + :rtype: str + """ + return self._pricing_component + + @pricing_component.setter + def pricing_component(self, pricing_component): + """Sets the pricing_component of this CreatePricingComponentQuantityRequest. + + + :param pricing_component: The pricing_component of this CreatePricingComponentQuantityRequest. # noqa: E501 + :type: str + """ + + self._pricing_component = pricing_component + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this CreatePricingComponentQuantityRequest. # noqa: E501 + + + :return: The pricing_component_id of this CreatePricingComponentQuantityRequest. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this CreatePricingComponentQuantityRequest. + + + :param pricing_component_id: The pricing_component_id of this CreatePricingComponentQuantityRequest. # noqa: E501 + :type: str + """ + + self._pricing_component_id = pricing_component_id + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this CreatePricingComponentQuantityRequest. # noqa: E501 + + + :return: The pricing_component_name of this CreatePricingComponentQuantityRequest. # noqa: E501 + :rtype: str + """ + return self._pricing_component_name + + @pricing_component_name.setter + def pricing_component_name(self, pricing_component_name): + """Sets the pricing_component_name of this CreatePricingComponentQuantityRequest. + + + :param pricing_component_name: The pricing_component_name of this CreatePricingComponentQuantityRequest. # noqa: E501 + :type: str + """ + + self._pricing_component_name = pricing_component_name + + @property + def quantity(self): + """Gets the quantity of this CreatePricingComponentQuantityRequest. # noqa: E501 + + + :return: The quantity of this CreatePricingComponentQuantityRequest. # noqa: E501 + :rtype: int + """ + return self._quantity + + @quantity.setter + def quantity(self, quantity): + """Sets the quantity of this CreatePricingComponentQuantityRequest. + + + :param quantity: The quantity of this CreatePricingComponentQuantityRequest. # noqa: E501 + :type: int + """ + + self._quantity = quantity + + @property + def percentage_discount(self): + """Gets the percentage_discount of this CreatePricingComponentQuantityRequest. # noqa: E501 + + + :return: The percentage_discount of this CreatePricingComponentQuantityRequest. # noqa: E501 + :rtype: float + """ + return self._percentage_discount + + @percentage_discount.setter + def percentage_discount(self, percentage_discount): + """Sets the percentage_discount of this CreatePricingComponentQuantityRequest. + + + :param percentage_discount: The percentage_discount of this CreatePricingComponentQuantityRequest. # noqa: E501 + :type: float + """ + + self._percentage_discount = percentage_discount + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreatePricingComponentQuantityRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreatePricingComponentQuantityRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_profile_address_request.py b/billforward/models/create_profile_address_request.py deleted file mode 100644 index 1309057..0000000 --- a/billforward/models/create_profile_address_request.py +++ /dev/null @@ -1,332 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CreateProfileAddressRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, address_line1=None, address_line2=None, address_line3=None, city=None, province=None, country=None, postcode=None, landline=None, primary_address=False): - """ - CreateProfileAddressRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'address_line1': 'str', - 'address_line2': 'str', - 'address_line3': 'str', - 'city': 'str', - 'province': 'str', - 'country': 'str', - 'postcode': 'str', - 'landline': 'str', - 'primary_address': 'bool' - } - - self.attribute_map = { - 'address_line1': 'addressLine1', - 'address_line2': 'addressLine2', - 'address_line3': 'addressLine3', - 'city': 'city', - 'province': 'province', - 'country': 'country', - 'postcode': 'postcode', - 'landline': 'landline', - 'primary_address': 'primaryAddress' - } - - self._address_line1 = address_line1 - self._address_line2 = address_line2 - self._address_line3 = address_line3 - self._city = city - self._province = province - self._country = country - self._postcode = postcode - self._landline = landline - self._primary_address = primary_address - - @property - def address_line1(self): - """ - Gets the address_line1 of this CreateProfileAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The address_line1 of this CreateProfileAddressRequest. - :rtype: str - """ - return self._address_line1 - - @address_line1.setter - def address_line1(self, address_line1): - """ - Sets the address_line1 of this CreateProfileAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param address_line1: The address_line1 of this CreateProfileAddressRequest. - :type: str - """ - - self._address_line1 = address_line1 - - @property - def address_line2(self): - """ - Gets the address_line2 of this CreateProfileAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The address_line2 of this CreateProfileAddressRequest. - :rtype: str - """ - return self._address_line2 - - @address_line2.setter - def address_line2(self, address_line2): - """ - Sets the address_line2 of this CreateProfileAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param address_line2: The address_line2 of this CreateProfileAddressRequest. - :type: str - """ - - self._address_line2 = address_line2 - - @property - def address_line3(self): - """ - Gets the address_line3 of this CreateProfileAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The address_line3 of this CreateProfileAddressRequest. - :rtype: str - """ - return self._address_line3 - - @address_line3.setter - def address_line3(self, address_line3): - """ - Sets the address_line3 of this CreateProfileAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param address_line3: The address_line3 of this CreateProfileAddressRequest. - :type: str - """ - - self._address_line3 = address_line3 - - @property - def city(self): - """ - Gets the city of this CreateProfileAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The city of this CreateProfileAddressRequest. - :rtype: str - """ - return self._city - - @city.setter - def city(self, city): - """ - Sets the city of this CreateProfileAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param city: The city of this CreateProfileAddressRequest. - :type: str - """ - - self._city = city - - @property - def province(self): - """ - Gets the province of this CreateProfileAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The province of this CreateProfileAddressRequest. - :rtype: str - """ - return self._province - - @province.setter - def province(self, province): - """ - Sets the province of this CreateProfileAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param province: The province of this CreateProfileAddressRequest. - :type: str - """ - - self._province = province - - @property - def country(self): - """ - Gets the country of this CreateProfileAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The country of this CreateProfileAddressRequest. - :rtype: str - """ - return self._country - - @country.setter - def country(self, country): - """ - Sets the country of this CreateProfileAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param country: The country of this CreateProfileAddressRequest. - :type: str - """ - - self._country = country - - @property - def postcode(self): - """ - Gets the postcode of this CreateProfileAddressRequest. - { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The postcode of this CreateProfileAddressRequest. - :rtype: str - """ - return self._postcode - - @postcode.setter - def postcode(self, postcode): - """ - Sets the postcode of this CreateProfileAddressRequest. - { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param postcode: The postcode of this CreateProfileAddressRequest. - :type: str - """ - - self._postcode = postcode - - @property - def landline(self): - """ - Gets the landline of this CreateProfileAddressRequest. - { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The landline of this CreateProfileAddressRequest. - :rtype: str - """ - return self._landline - - @landline.setter - def landline(self, landline): - """ - Sets the landline of this CreateProfileAddressRequest. - { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param landline: The landline of this CreateProfileAddressRequest. - :type: str - """ - - self._landline = landline - - @property - def primary_address(self): - """ - Gets the primary_address of this CreateProfileAddressRequest. - { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The primary_address of this CreateProfileAddressRequest. - :rtype: bool - """ - return self._primary_address - - @primary_address.setter - def primary_address(self, primary_address): - """ - Sets the primary_address of this CreateProfileAddressRequest. - { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param primary_address: The primary_address of this CreateProfileAddressRequest. - :type: bool - """ - - self._primary_address = primary_address - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/create_profile_request.py b/billforward/models/create_profile_request.py new file mode 100644 index 0000000..ecd2fa9 --- /dev/null +++ b/billforward/models/create_profile_request.py @@ -0,0 +1,84 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreateProfileRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + + attribute_map = { + } + + def __init__(self): # noqa: E501 + """CreateProfileRequest - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreateProfileRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreateProfileRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_role_request.py b/billforward/models/create_role_request.py new file mode 100644 index 0000000..9b0073c --- /dev/null +++ b/billforward/models/create_role_request.py @@ -0,0 +1,240 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreateRoleRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'name': 'str', + 'description': 'str', + 'default_role': 'bool', + 'permissions': 'list[CreatePermissionOnRoleRequest]' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'name': 'name', + 'description': 'description', + 'default_role': 'defaultRole', + 'permissions': 'permissions' + } + + def __init__(self, created=None, organization_id=None, name=None, description=None, default_role=None, permissions=None): # noqa: E501 + """CreateRoleRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._name = None + self._description = None + self._default_role = None + self._permissions = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if description is not None: + self.description = description + if default_role is not None: + self.default_role = default_role + if permissions is not None: + self.permissions = permissions + + @property + def created(self): + """Gets the created of this CreateRoleRequest. # noqa: E501 + + + :return: The created of this CreateRoleRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this CreateRoleRequest. + + + :param created: The created of this CreateRoleRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this CreateRoleRequest. # noqa: E501 + + + :return: The organization_id of this CreateRoleRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CreateRoleRequest. + + + :param organization_id: The organization_id of this CreateRoleRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def name(self): + """Gets the name of this CreateRoleRequest. # noqa: E501 + + + :return: The name of this CreateRoleRequest. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this CreateRoleRequest. + + + :param name: The name of this CreateRoleRequest. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this CreateRoleRequest. # noqa: E501 + + + :return: The description of this CreateRoleRequest. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this CreateRoleRequest. + + + :param description: The description of this CreateRoleRequest. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def default_role(self): + """Gets the default_role of this CreateRoleRequest. # noqa: E501 + + + :return: The default_role of this CreateRoleRequest. # noqa: E501 + :rtype: bool + """ + return self._default_role + + @default_role.setter + def default_role(self, default_role): + """Sets the default_role of this CreateRoleRequest. + + + :param default_role: The default_role of this CreateRoleRequest. # noqa: E501 + :type: bool + """ + + self._default_role = default_role + + @property + def permissions(self): + """Gets the permissions of this CreateRoleRequest. # noqa: E501 + + + :return: The permissions of this CreateRoleRequest. # noqa: E501 + :rtype: list[CreatePermissionOnRoleRequest] + """ + return self._permissions + + @permissions.setter + def permissions(self, permissions): + """Sets the permissions of this CreateRoleRequest. + + + :param permissions: The permissions of this CreateRoleRequest. # noqa: E501 + :type: list[CreatePermissionOnRoleRequest] + """ + + self._permissions = permissions + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreateRoleRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreateRoleRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_salesforce_configuration_request.py b/billforward/models/create_salesforce_configuration_request.py new file mode 100644 index 0000000..ecc6f56 --- /dev/null +++ b/billforward/models/create_salesforce_configuration_request.py @@ -0,0 +1,240 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreateSalesforceConfigurationRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'user_role': 'str', + 'notification_email_addresses': 'str', + 'respond_with_redirect': 'bool', + 'base_uri': 'str', + 'use_test_environment': 'bool' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'user_role': 'userRole', + 'notification_email_addresses': 'notificationEmailAddresses', + 'respond_with_redirect': 'respondWithRedirect', + 'base_uri': 'baseUri', + 'use_test_environment': 'useTestEnvironment' + } + + def __init__(self, organization_id=None, user_role=None, notification_email_addresses=None, respond_with_redirect=None, base_uri=None, use_test_environment=None): # noqa: E501 + """CreateSalesforceConfigurationRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._user_role = None + self._notification_email_addresses = None + self._respond_with_redirect = None + self._base_uri = None + self._use_test_environment = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if user_role is not None: + self.user_role = user_role + if notification_email_addresses is not None: + self.notification_email_addresses = notification_email_addresses + if respond_with_redirect is not None: + self.respond_with_redirect = respond_with_redirect + if base_uri is not None: + self.base_uri = base_uri + if use_test_environment is not None: + self.use_test_environment = use_test_environment + + @property + def organization_id(self): + """Gets the organization_id of this CreateSalesforceConfigurationRequest. # noqa: E501 + + + :return: The organization_id of this CreateSalesforceConfigurationRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CreateSalesforceConfigurationRequest. + + + :param organization_id: The organization_id of this CreateSalesforceConfigurationRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def user_role(self): + """Gets the user_role of this CreateSalesforceConfigurationRequest. # noqa: E501 + + + :return: The user_role of this CreateSalesforceConfigurationRequest. # noqa: E501 + :rtype: str + """ + return self._user_role + + @user_role.setter + def user_role(self, user_role): + """Sets the user_role of this CreateSalesforceConfigurationRequest. + + + :param user_role: The user_role of this CreateSalesforceConfigurationRequest. # noqa: E501 + :type: str + """ + + self._user_role = user_role + + @property + def notification_email_addresses(self): + """Gets the notification_email_addresses of this CreateSalesforceConfigurationRequest. # noqa: E501 + + + :return: The notification_email_addresses of this CreateSalesforceConfigurationRequest. # noqa: E501 + :rtype: str + """ + return self._notification_email_addresses + + @notification_email_addresses.setter + def notification_email_addresses(self, notification_email_addresses): + """Sets the notification_email_addresses of this CreateSalesforceConfigurationRequest. + + + :param notification_email_addresses: The notification_email_addresses of this CreateSalesforceConfigurationRequest. # noqa: E501 + :type: str + """ + + self._notification_email_addresses = notification_email_addresses + + @property + def respond_with_redirect(self): + """Gets the respond_with_redirect of this CreateSalesforceConfigurationRequest. # noqa: E501 + + + :return: The respond_with_redirect of this CreateSalesforceConfigurationRequest. # noqa: E501 + :rtype: bool + """ + return self._respond_with_redirect + + @respond_with_redirect.setter + def respond_with_redirect(self, respond_with_redirect): + """Sets the respond_with_redirect of this CreateSalesforceConfigurationRequest. + + + :param respond_with_redirect: The respond_with_redirect of this CreateSalesforceConfigurationRequest. # noqa: E501 + :type: bool + """ + + self._respond_with_redirect = respond_with_redirect + + @property + def base_uri(self): + """Gets the base_uri of this CreateSalesforceConfigurationRequest. # noqa: E501 + + + :return: The base_uri of this CreateSalesforceConfigurationRequest. # noqa: E501 + :rtype: str + """ + return self._base_uri + + @base_uri.setter + def base_uri(self, base_uri): + """Sets the base_uri of this CreateSalesforceConfigurationRequest. + + + :param base_uri: The base_uri of this CreateSalesforceConfigurationRequest. # noqa: E501 + :type: str + """ + + self._base_uri = base_uri + + @property + def use_test_environment(self): + """Gets the use_test_environment of this CreateSalesforceConfigurationRequest. # noqa: E501 + + + :return: The use_test_environment of this CreateSalesforceConfigurationRequest. # noqa: E501 + :rtype: bool + """ + return self._use_test_environment + + @use_test_environment.setter + def use_test_environment(self, use_test_environment): + """Sets the use_test_environment of this CreateSalesforceConfigurationRequest. + + + :param use_test_environment: The use_test_environment of this CreateSalesforceConfigurationRequest. # noqa: E501 + :type: bool + """ + + self._use_test_environment = use_test_environment + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreateSalesforceConfigurationRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreateSalesforceConfigurationRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_subscription_batch_request.py b/billforward/models/create_subscription_batch_request.py index 47a1d20..a1567f0 100644 --- a/billforward/models/create_subscription_batch_request.py +++ b/billforward/models/create_subscription_batch_request.py @@ -1,79 +1,73 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class CreateSubscriptionBatchRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, organization_id=None, subscriptions=None): - """ - CreateSubscriptionBatchRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'organization_id': 'str', - 'subscriptions': 'list[CreateSubscriptionRequest]' - } - - self.attribute_map = { - 'created': 'created', - 'organization_id': 'organizationID', - 'subscriptions': 'subscriptions' - } - - self._created = created - self._organization_id = organization_id - self._subscriptions = subscriptions + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'subscriptions': 'list[CreateSubscriptionRequest]' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'subscriptions': 'subscriptions' + } + + def __init__(self, created=None, organization_id=None, subscriptions=None): # noqa: E501 + """CreateSubscriptionBatchRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._subscriptions = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if subscriptions is not None: + self.subscriptions = subscriptions @property def created(self): - """ - Gets the created of this CreateSubscriptionBatchRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this CreateSubscriptionBatchRequest. # noqa: E501 - :return: The created of this CreateSubscriptionBatchRequest. + + :return: The created of this CreateSubscriptionBatchRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this CreateSubscriptionBatchRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this CreateSubscriptionBatchRequest. - :param created: The created of this CreateSubscriptionBatchRequest. + + :param created: The created of this CreateSubscriptionBatchRequest. # noqa: E501 :type: datetime """ @@ -81,22 +75,20 @@ def created(self, created): @property def organization_id(self): - """ - Gets the organization_id of this CreateSubscriptionBatchRequest. - {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested Subscriptions should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} + """Gets the organization_id of this CreateSubscriptionBatchRequest. # noqa: E501 - :return: The organization_id of this CreateSubscriptionBatchRequest. + + :return: The organization_id of this CreateSubscriptionBatchRequest. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this CreateSubscriptionBatchRequest. - {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested Subscriptions should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} + """Sets the organization_id of this CreateSubscriptionBatchRequest. + - :param organization_id: The organization_id of this CreateSubscriptionBatchRequest. + :param organization_id: The organization_id of this CreateSubscriptionBatchRequest. # noqa: E501 :type: str """ @@ -104,34 +96,30 @@ def organization_id(self, organization_id): @property def subscriptions(self): - """ - Gets the subscriptions of this CreateSubscriptionBatchRequest. - {\"default\":\"(Empty list)\",\"description\":\"List of entities for requesting that subscriptions be created.\",\"verbs\":[\"POST\"]} + """Gets the subscriptions of this CreateSubscriptionBatchRequest. # noqa: E501 + - :return: The subscriptions of this CreateSubscriptionBatchRequest. + :return: The subscriptions of this CreateSubscriptionBatchRequest. # noqa: E501 :rtype: list[CreateSubscriptionRequest] """ return self._subscriptions @subscriptions.setter def subscriptions(self, subscriptions): - """ - Sets the subscriptions of this CreateSubscriptionBatchRequest. - {\"default\":\"(Empty list)\",\"description\":\"List of entities for requesting that subscriptions be created.\",\"verbs\":[\"POST\"]} + """Sets the subscriptions of this CreateSubscriptionBatchRequest. + - :param subscriptions: The subscriptions of this CreateSubscriptionBatchRequest. + :param subscriptions: The subscriptions of this CreateSubscriptionBatchRequest. # noqa: E501 :type: list[CreateSubscriptionRequest] """ self._subscriptions = subscriptions def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -148,29 +136,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CreateSubscriptionBatchRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CreateSubscriptionBatchRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/create_subscription_charge_amendment.py b/billforward/models/create_subscription_charge_amendment.py index a095c06..0f75788 100644 --- a/billforward/models/create_subscription_charge_amendment.py +++ b/billforward/models/create_subscription_charge_amendment.py @@ -1,525 +1,207 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class CreateSubscriptionChargeAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class CreateSubscriptionChargeAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False, subscription_charge_id=None, description=None, amount=None, discount=None, invoicing_type=None, tax_status=None, subscription_charge=None, pricing_component_value_change=None, pricing_component_id=None): - """ - CreateSubscriptionChargeAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool', - 'subscription_charge_id': 'str', - 'description': 'str', - 'amount': 'float', - 'discount': 'float', - 'invoicing_type': 'str', - 'tax_status': 'str', - 'subscription_charge': 'SubscriptionCharge', - 'pricing_component_value_change': 'InsertableBillingEntity', - 'pricing_component_id': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted', - 'subscription_charge_id': 'subscriptionChargeID', - 'description': 'description', - 'amount': 'amount', - 'discount': 'discount', - 'invoicing_type': 'invoicingType', - 'tax_status': 'taxStatus', - 'subscription_charge': 'subscriptionCharge', - 'pricing_component_value_change': 'pricingComponentValueChange', - 'pricing_component_id': 'pricingComponentID' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - self._subscription_charge_id = subscription_charge_id - self._description = description - self._amount = amount - self._discount = discount - self._invoicing_type = invoicing_type - self._tax_status = tax_status - self._subscription_charge = subscription_charge - self._pricing_component_value_change = pricing_component_value_change - self._pricing_component_id = pricing_component_id - - @property - def created(self): - """ - Gets the created of this CreateSubscriptionChargeAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this CreateSubscriptionChargeAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this CreateSubscriptionChargeAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this CreateSubscriptionChargeAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this CreateSubscriptionChargeAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this CreateSubscriptionChargeAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this CreateSubscriptionChargeAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this CreateSubscriptionChargeAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this CreateSubscriptionChargeAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this CreateSubscriptionChargeAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this CreateSubscriptionChargeAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this CreateSubscriptionChargeAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this CreateSubscriptionChargeAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this CreateSubscriptionChargeAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def id(self): - """ - Gets the id of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this CreateSubscriptionChargeAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this CreateSubscriptionChargeAmendment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this CreateSubscriptionChargeAmendment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this CreateSubscriptionChargeAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this CreateSubscriptionChargeAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this CreateSubscriptionChargeAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this CreateSubscriptionChargeAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this CreateSubscriptionChargeAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this CreateSubscriptionChargeAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this CreateSubscriptionChargeAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this CreateSubscriptionChargeAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this CreateSubscriptionChargeAmendment. - :rtype: datetime - """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this CreateSubscriptionChargeAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actioning_time: The actioning_time of this CreateSubscriptionChargeAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this CreateSubscriptionChargeAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this CreateSubscriptionChargeAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this CreateSubscriptionChargeAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :param actioned_time: The actioned_time of this CreateSubscriptionChargeAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this CreateSubscriptionChargeAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this CreateSubscriptionChargeAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this CreateSubscriptionChargeAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this CreateSubscriptionChargeAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this CreateSubscriptionChargeAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this CreateSubscriptionChargeAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this CreateSubscriptionChargeAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this CreateSubscriptionChargeAmendment. - :type: bool - """ - - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'subscription_charge_id': 'str', + 'amount': 'float', + 'discount': 'float', + 'type': 'str', + 'invoicing_type': 'str', + 'tax_status': 'str', + 'subscription_charge': 'SubscriptionCharge', + 'pricing_component_value_change': 'PricingComponentValueChange', + 'pricing_component_id': 'str' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'subscription_charge_id': 'subscriptionChargeID', + 'amount': 'amount', + 'discount': 'discount', + 'type': 'type', + 'invoicing_type': 'invoicingType', + 'tax_status': 'taxStatus', + 'subscription_charge': 'subscriptionCharge', + 'pricing_component_value_change': 'pricingComponentValueChange', + 'pricing_component_id': 'pricingComponentID' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, subscription_charge_id=None, amount=None, discount=None, type=None, invoicing_type=None, tax_status=None, subscription_charge=None, pricing_component_value_change=None, pricing_component_id=None, *args, **kwargs): # noqa: E501 + """CreateSubscriptionChargeAmendment - a model defined in Swagger""" # noqa: E501 + self._subscription_charge_id = None + self._amount = None + self._discount = None + self._type = None + self._invoicing_type = None + self._tax_status = None + self._subscription_charge = None + self._pricing_component_value_change = None + self._pricing_component_id = None + self.discriminator = None + if subscription_charge_id is not None: + self.subscription_charge_id = subscription_charge_id + self.amount = amount + if discount is not None: + self.discount = discount + self.type = type + self.invoicing_type = invoicing_type + self.tax_status = tax_status + if subscription_charge is not None: + self.subscription_charge = subscription_charge + if pricing_component_value_change is not None: + self.pricing_component_value_change = pricing_component_value_change + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + Amendment.__init__(self, *args, **kwargs) @property def subscription_charge_id(self): - """ - Gets the subscription_charge_id of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the subscription_charge_id of this CreateSubscriptionChargeAmendment. # noqa: E501 - :return: The subscription_charge_id of this CreateSubscriptionChargeAmendment. + + :return: The subscription_charge_id of this CreateSubscriptionChargeAmendment. # noqa: E501 :rtype: str """ return self._subscription_charge_id @subscription_charge_id.setter def subscription_charge_id(self, subscription_charge_id): - """ - Sets the subscription_charge_id of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param subscription_charge_id: The subscription_charge_id of this CreateSubscriptionChargeAmendment. - :type: str - """ + """Sets the subscription_charge_id of this CreateSubscriptionChargeAmendment. - self._subscription_charge_id = subscription_charge_id - @property - def description(self): - """ - Gets the description of this CreateSubscriptionChargeAmendment. - { \"description\" : \".\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The description of this CreateSubscriptionChargeAmendment. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this CreateSubscriptionChargeAmendment. - { \"description\" : \".\", \"verbs\":[\"POST\",\"GET\"] } - - :param description: The description of this CreateSubscriptionChargeAmendment. + :param subscription_charge_id: The subscription_charge_id of this CreateSubscriptionChargeAmendment. # noqa: E501 :type: str """ - self._description = description + self._subscription_charge_id = subscription_charge_id @property def amount(self): - """ - Gets the amount of this CreateSubscriptionChargeAmendment. - { \"description\" : \"Monetary value to charge in the same currency as the subscription.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the amount of this CreateSubscriptionChargeAmendment. # noqa: E501 + - :return: The amount of this CreateSubscriptionChargeAmendment. + :return: The amount of this CreateSubscriptionChargeAmendment. # noqa: E501 :rtype: float """ return self._amount @amount.setter def amount(self, amount): - """ - Sets the amount of this CreateSubscriptionChargeAmendment. - { \"description\" : \"Monetary value to charge in the same currency as the subscription.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the amount of this CreateSubscriptionChargeAmendment. + - :param amount: The amount of this CreateSubscriptionChargeAmendment. + :param amount: The amount of this CreateSubscriptionChargeAmendment. # noqa: E501 :type: float """ + if amount is None: + raise ValueError("Invalid value for `amount`, must not be `None`") # noqa: E501 self._amount = amount @property def discount(self): - """ - Gets the discount of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[] } + """Gets the discount of this CreateSubscriptionChargeAmendment. # noqa: E501 + - :return: The discount of this CreateSubscriptionChargeAmendment. + :return: The discount of this CreateSubscriptionChargeAmendment. # noqa: E501 :rtype: float """ return self._discount @discount.setter def discount(self, discount): - """ - Sets the discount of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[] } + """Sets the discount of this CreateSubscriptionChargeAmendment. + - :param discount: The discount of this CreateSubscriptionChargeAmendment. + :param discount: The discount of this CreateSubscriptionChargeAmendment. # noqa: E501 :type: float """ self._discount = discount @property - def invoicing_type(self): + def type(self): + """Gets the type of this CreateSubscriptionChargeAmendment. # noqa: E501 + + + :return: The type of this CreateSubscriptionChargeAmendment. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this CreateSubscriptionChargeAmendment. + + + :param type: The type of this CreateSubscriptionChargeAmendment. # noqa: E501 + :type: str """ - Gets the invoicing_type of this CreateSubscriptionChargeAmendment. - { \"description\" : \"Immediate invoicing will result in an invoice being issued immediately for the charge. Aggregated invoicing will generate a charge to be added to the next issued invoice, for example at the current billing period end.\", \"default\" : \"Aggregated\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + allowed_values = ["Setup", "Upgrade", "Manual", "ProductRatePlanMigration", "Arrears", "Advance", "Coupon", "Usage", "PricingComponent", "Prepayment", "AffiliateCommission"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def invoicing_type(self): + """Gets the invoicing_type of this CreateSubscriptionChargeAmendment. # noqa: E501 - :return: The invoicing_type of this CreateSubscriptionChargeAmendment. + + :return: The invoicing_type of this CreateSubscriptionChargeAmendment. # noqa: E501 :rtype: str """ return self._invoicing_type @invoicing_type.setter def invoicing_type(self, invoicing_type): - """ - Sets the invoicing_type of this CreateSubscriptionChargeAmendment. - { \"description\" : \"Immediate invoicing will result in an invoice being issued immediately for the charge. Aggregated invoicing will generate a charge to be added to the next issued invoice, for example at the current billing period end.\", \"default\" : \"Aggregated\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the invoicing_type of this CreateSubscriptionChargeAmendment. - :param invoicing_type: The invoicing_type of this CreateSubscriptionChargeAmendment. + + :param invoicing_type: The invoicing_type of this CreateSubscriptionChargeAmendment. # noqa: E501 :type: str """ - allowed_values = ["Immediate", "Aggregated"] + if invoicing_type is None: + raise ValueError("Invalid value for `invoicing_type`, must not be `None`") # noqa: E501 + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 if invoicing_type not in allowed_values: raise ValueError( - "Invalid value for `invoicing_type` ({0}), must be one of {1}" + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 .format(invoicing_type, allowed_values) ) @@ -527,28 +209,28 @@ def invoicing_type(self, invoicing_type): @property def tax_status(self): - """ - Gets the tax_status of this CreateSubscriptionChargeAmendment. - { \"description\" : \"Whether the amount specified is inclusive or exclusive of tax\", \"default\" : \"inclusive\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the tax_status of this CreateSubscriptionChargeAmendment. # noqa: E501 - :return: The tax_status of this CreateSubscriptionChargeAmendment. + + :return: The tax_status of this CreateSubscriptionChargeAmendment. # noqa: E501 :rtype: str """ return self._tax_status @tax_status.setter def tax_status(self, tax_status): - """ - Sets the tax_status of this CreateSubscriptionChargeAmendment. - { \"description\" : \"Whether the amount specified is inclusive or exclusive of tax\", \"default\" : \"inclusive\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the tax_status of this CreateSubscriptionChargeAmendment. - :param tax_status: The tax_status of this CreateSubscriptionChargeAmendment. + + :param tax_status: The tax_status of this CreateSubscriptionChargeAmendment. # noqa: E501 :type: str """ - allowed_values = ["inclusive", "exclusive"] + if tax_status is None: + raise ValueError("Invalid value for `tax_status`, must not be `None`") # noqa: E501 + allowed_values = ["inclusive", "exclusive"] # noqa: E501 if tax_status not in allowed_values: raise ValueError( - "Invalid value for `tax_status` ({0}), must be one of {1}" + "Invalid value for `tax_status` ({0}), must be one of {1}" # noqa: E501 .format(tax_status, allowed_values) ) @@ -556,22 +238,20 @@ def tax_status(self, tax_status): @property def subscription_charge(self): - """ - Gets the subscription_charge of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the subscription_charge of this CreateSubscriptionChargeAmendment. # noqa: E501 - :return: The subscription_charge of this CreateSubscriptionChargeAmendment. + + :return: The subscription_charge of this CreateSubscriptionChargeAmendment. # noqa: E501 :rtype: SubscriptionCharge """ return self._subscription_charge @subscription_charge.setter def subscription_charge(self, subscription_charge): - """ - Sets the subscription_charge of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the subscription_charge of this CreateSubscriptionChargeAmendment. - :param subscription_charge: The subscription_charge of this CreateSubscriptionChargeAmendment. + + :param subscription_charge: The subscription_charge of this CreateSubscriptionChargeAmendment. # noqa: E501 :type: SubscriptionCharge """ @@ -579,57 +259,51 @@ def subscription_charge(self, subscription_charge): @property def pricing_component_value_change(self): - """ - Gets the pricing_component_value_change of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[] } + """Gets the pricing_component_value_change of this CreateSubscriptionChargeAmendment. # noqa: E501 - :return: The pricing_component_value_change of this CreateSubscriptionChargeAmendment. - :rtype: InsertableBillingEntity + + :return: The pricing_component_value_change of this CreateSubscriptionChargeAmendment. # noqa: E501 + :rtype: PricingComponentValueChange """ return self._pricing_component_value_change @pricing_component_value_change.setter def pricing_component_value_change(self, pricing_component_value_change): - """ - Sets the pricing_component_value_change of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[] } + """Sets the pricing_component_value_change of this CreateSubscriptionChargeAmendment. + - :param pricing_component_value_change: The pricing_component_value_change of this CreateSubscriptionChargeAmendment. - :type: InsertableBillingEntity + :param pricing_component_value_change: The pricing_component_value_change of this CreateSubscriptionChargeAmendment. # noqa: E501 + :type: PricingComponentValueChange """ self._pricing_component_value_change = pricing_component_value_change @property def pricing_component_id(self): - """ - Gets the pricing_component_id of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[] } + """Gets the pricing_component_id of this CreateSubscriptionChargeAmendment. # noqa: E501 + - :return: The pricing_component_id of this CreateSubscriptionChargeAmendment. + :return: The pricing_component_id of this CreateSubscriptionChargeAmendment. # noqa: E501 :rtype: str """ return self._pricing_component_id @pricing_component_id.setter def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this CreateSubscriptionChargeAmendment. - { \"description\" : \"\", \"verbs\":[] } + """Sets the pricing_component_id of this CreateSubscriptionChargeAmendment. + - :param pricing_component_id: The pricing_component_id of this CreateSubscriptionChargeAmendment. + :param pricing_component_id: The pricing_component_id of this CreateSubscriptionChargeAmendment. # noqa: E501 :type: str """ self._pricing_component_id = pricing_component_id def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -646,29 +320,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CreateSubscriptionChargeAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CreateSubscriptionChargeAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/create_subscription_checkout_definition_request.py b/billforward/models/create_subscription_checkout_definition_request.py new file mode 100644 index 0000000..37b010f --- /dev/null +++ b/billforward/models/create_subscription_checkout_definition_request.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreateSubscriptionCheckoutDefinitionRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'plan': 'str', + 'path': 'str' + } + + attribute_map = { + 'plan': 'plan', + 'path': 'path' + } + + def __init__(self, plan=None, path=None): # noqa: E501 + """CreateSubscriptionCheckoutDefinitionRequest - a model defined in Swagger""" # noqa: E501 + self._plan = None + self._path = None + self.discriminator = None + if plan is not None: + self.plan = plan + if path is not None: + self.path = path + + @property + def plan(self): + """Gets the plan of this CreateSubscriptionCheckoutDefinitionRequest. # noqa: E501 + + + :return: The plan of this CreateSubscriptionCheckoutDefinitionRequest. # noqa: E501 + :rtype: str + """ + return self._plan + + @plan.setter + def plan(self, plan): + """Sets the plan of this CreateSubscriptionCheckoutDefinitionRequest. + + + :param plan: The plan of this CreateSubscriptionCheckoutDefinitionRequest. # noqa: E501 + :type: str + """ + + self._plan = plan + + @property + def path(self): + """Gets the path of this CreateSubscriptionCheckoutDefinitionRequest. # noqa: E501 + + + :return: The path of this CreateSubscriptionCheckoutDefinitionRequest. # noqa: E501 + :rtype: str + """ + return self._path + + @path.setter + def path(self, path): + """Sets the path of this CreateSubscriptionCheckoutDefinitionRequest. + + + :param path: The path of this CreateSubscriptionCheckoutDefinitionRequest. # noqa: E501 + :type: str + """ + + self._path = path + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreateSubscriptionCheckoutDefinitionRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreateSubscriptionCheckoutDefinitionRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_subscription_request.py b/billforward/models/create_subscription_request.py index 91cda19..5309c21 100644 --- a/billforward/models/create_subscription_request.py +++ b/billforward/models/create_subscription_request.py @@ -1,127 +1,244 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class CreateSubscriptionRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, account_id=None, product=None, product_rate_plan=None, organization_id=None, name=None, description=None, start=None, end=None, state=None, trial_end=None, type=None, parent_id=None, aggregate_all_subscriptions_on_account=False, align_period_with_aggregating_subscription=False, pricing_component_quantities=None, metadata=None, payment_terms=None, contract_start=None, failed_payment_behaviour=None): - """ - CreateSubscriptionRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'account_id': 'str', - 'product': 'str', - 'product_rate_plan': 'str', - 'organization_id': 'str', - 'name': 'str', - 'description': 'str', - 'start': 'datetime', - 'end': 'datetime', - 'state': 'str', - 'trial_end': 'datetime', - 'type': 'str', - 'parent_id': 'str', - 'aggregate_all_subscriptions_on_account': 'bool', - 'align_period_with_aggregating_subscription': 'bool', - 'pricing_component_quantities': 'list[PricingComponentQuantityRequest]', - 'metadata': 'DynamicMetadata', - 'payment_terms': 'int', - 'contract_start': 'datetime', - 'failed_payment_behaviour': 'str' - } - - self.attribute_map = { - 'account_id': 'accountID', - 'product': 'product', - 'product_rate_plan': 'productRatePlan', - 'organization_id': 'organizationID', - 'name': 'name', - 'description': 'description', - 'start': 'start', - 'end': 'end', - 'state': 'state', - 'trial_end': 'trialEnd', - 'type': 'type', - 'parent_id': 'parentID', - 'aggregate_all_subscriptions_on_account': 'aggregateAllSubscriptionsOnAccount', - 'align_period_with_aggregating_subscription': 'alignPeriodWithAggregatingSubscription', - 'pricing_component_quantities': 'pricingComponentQuantities', - 'metadata': 'metadata', - 'payment_terms': 'paymentTerms', - 'contract_start': 'contractStart', - 'failed_payment_behaviour': 'failedPaymentBehaviour' - } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'account_id': 'str', + 'product': 'str', + 'product_rate_plan': 'str', + 'organization_id': 'str', + 'name': 'str', + 'description': 'str', + 'contract_start': 'datetime', + 'start': 'datetime', + 'end': 'datetime', + 'state': 'str', + 'trial_end': 'datetime', + 'type': 'str', + 'failed_payment_behaviour': 'str', + 'parent_id': 'str', + 'exclude_from_auto_aggregation': 'bool', + 'aggregate_all_subscriptions_on_account': 'bool', + 'allow_subscription_wihtout_rate_plan': 'bool', + 'dont_create_default_fixed_term': 'bool', + 'align_period_with_aggregating_subscription': 'bool', + 'parent_should_copy_child_period_end': 'bool', + 'pricing_component_quantities': 'list[CreatePricingComponentQuantityRequest]', + 'payment_terms': 'int', + 'purchase_order': 'str', + 'coupon_codes': 'list[str]', + 'prepayment_amount': 'float', + 'extras': 'Extras', + 'termed_subscription': 'bool', + 'term_periods': 'int', + 'term_expiry_behaviour': 'str', + 'subsequent_product_rate_plan': 'str', + 'metadata': 'dict(str, object)', + 'ignore_first_period_usage': 'bool' + } + + attribute_map = { + 'created': 'created', + 'account_id': 'accountID', + 'product': 'product', + 'product_rate_plan': 'productRatePlan', + 'organization_id': 'organizationID', + 'name': 'name', + 'description': 'description', + 'contract_start': 'contractStart', + 'start': 'start', + 'end': 'end', + 'state': 'state', + 'trial_end': 'trialEnd', + 'type': 'type', + 'failed_payment_behaviour': 'failedPaymentBehaviour', + 'parent_id': 'parentID', + 'exclude_from_auto_aggregation': 'excludeFromAutoAggregation', + 'aggregate_all_subscriptions_on_account': 'aggregateAllSubscriptionsOnAccount', + 'allow_subscription_wihtout_rate_plan': 'allowSubscriptionWihtoutRatePlan', + 'dont_create_default_fixed_term': 'dontCreateDefaultFixedTerm', + 'align_period_with_aggregating_subscription': 'alignPeriodWithAggregatingSubscription', + 'parent_should_copy_child_period_end': 'parentShouldCopyChildPeriodEnd', + 'pricing_component_quantities': 'pricingComponentQuantities', + 'payment_terms': 'paymentTerms', + 'purchase_order': 'purchaseOrder', + 'coupon_codes': 'couponCodes', + 'prepayment_amount': 'prepaymentAmount', + 'extras': 'extras', + 'termed_subscription': 'termedSubscription', + 'term_periods': 'termPeriods', + 'term_expiry_behaviour': 'termExpiryBehaviour', + 'subsequent_product_rate_plan': 'subsequentProductRatePlan', + 'metadata': 'metadata', + 'ignore_first_period_usage': 'ignoreFirstPeriodUsage' + } + + def __init__(self, created=None, account_id=None, product=None, product_rate_plan=None, organization_id=None, name=None, description=None, contract_start=None, start=None, end=None, state=None, trial_end=None, type=None, failed_payment_behaviour=None, parent_id=None, exclude_from_auto_aggregation=None, aggregate_all_subscriptions_on_account=None, allow_subscription_wihtout_rate_plan=None, dont_create_default_fixed_term=None, align_period_with_aggregating_subscription=None, parent_should_copy_child_period_end=None, pricing_component_quantities=None, payment_terms=None, purchase_order=None, coupon_codes=None, prepayment_amount=None, extras=None, termed_subscription=None, term_periods=None, term_expiry_behaviour=None, subsequent_product_rate_plan=None, metadata=None, ignore_first_period_usage=None): # noqa: E501 + """CreateSubscriptionRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._account_id = None + self._product = None + self._product_rate_plan = None + self._organization_id = None + self._name = None + self._description = None + self._contract_start = None + self._start = None + self._end = None + self._state = None + self._trial_end = None + self._type = None + self._failed_payment_behaviour = None + self._parent_id = None + self._exclude_from_auto_aggregation = None + self._aggregate_all_subscriptions_on_account = None + self._allow_subscription_wihtout_rate_plan = None + self._dont_create_default_fixed_term = None + self._align_period_with_aggregating_subscription = None + self._parent_should_copy_child_period_end = None + self._pricing_component_quantities = None + self._payment_terms = None + self._purchase_order = None + self._coupon_codes = None + self._prepayment_amount = None + self._extras = None + self._termed_subscription = None + self._term_periods = None + self._term_expiry_behaviour = None + self._subsequent_product_rate_plan = None + self._metadata = None + self._ignore_first_period_usage = None + self.discriminator = None + if created is not None: + self.created = created + if account_id is not None: + self.account_id = account_id + if product is not None: + self.product = product + if product_rate_plan is not None: + self.product_rate_plan = product_rate_plan + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if description is not None: + self.description = description + if contract_start is not None: + self.contract_start = contract_start + if start is not None: + self.start = start + if end is not None: + self.end = end + if state is not None: + self.state = state + if trial_end is not None: + self.trial_end = trial_end + if type is not None: + self.type = type + if failed_payment_behaviour is not None: + self.failed_payment_behaviour = failed_payment_behaviour + if parent_id is not None: + self.parent_id = parent_id + if exclude_from_auto_aggregation is not None: + self.exclude_from_auto_aggregation = exclude_from_auto_aggregation + if aggregate_all_subscriptions_on_account is not None: + self.aggregate_all_subscriptions_on_account = aggregate_all_subscriptions_on_account + if allow_subscription_wihtout_rate_plan is not None: + self.allow_subscription_wihtout_rate_plan = allow_subscription_wihtout_rate_plan + if dont_create_default_fixed_term is not None: + self.dont_create_default_fixed_term = dont_create_default_fixed_term + if align_period_with_aggregating_subscription is not None: + self.align_period_with_aggregating_subscription = align_period_with_aggregating_subscription + if parent_should_copy_child_period_end is not None: + self.parent_should_copy_child_period_end = parent_should_copy_child_period_end + if pricing_component_quantities is not None: + self.pricing_component_quantities = pricing_component_quantities + if payment_terms is not None: + self.payment_terms = payment_terms + if purchase_order is not None: + self.purchase_order = purchase_order + if coupon_codes is not None: + self.coupon_codes = coupon_codes + if prepayment_amount is not None: + self.prepayment_amount = prepayment_amount + if extras is not None: + self.extras = extras + if termed_subscription is not None: + self.termed_subscription = termed_subscription + if term_periods is not None: + self.term_periods = term_periods + if term_expiry_behaviour is not None: + self.term_expiry_behaviour = term_expiry_behaviour + if subsequent_product_rate_plan is not None: + self.subsequent_product_rate_plan = subsequent_product_rate_plan + if metadata is not None: + self.metadata = metadata + if ignore_first_period_usage is not None: + self.ignore_first_period_usage = ignore_first_period_usage + + @property + def created(self): + """Gets the created of this CreateSubscriptionRequest. # noqa: E501 - self._account_id = account_id - self._product = product - self._product_rate_plan = product_rate_plan - self._organization_id = organization_id - self._name = name - self._description = description - self._start = start - self._end = end - self._state = state - self._trial_end = trial_end - self._type = type - self._parent_id = parent_id - self._aggregate_all_subscriptions_on_account = aggregate_all_subscriptions_on_account - self._align_period_with_aggregating_subscription = align_period_with_aggregating_subscription - self._pricing_component_quantities = pricing_component_quantities - self._metadata = metadata - self._payment_terms = payment_terms - self._contract_start = contract_start - self._failed_payment_behaviour = failed_payment_behaviour + + :return: The created of this CreateSubscriptionRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this CreateSubscriptionRequest. + + + :param created: The created of this CreateSubscriptionRequest. # noqa: E501 + :type: datetime + """ + + self._created = created @property def account_id(self): - """ - Gets the account_id of this CreateSubscriptionRequest. - {\"description\":\"ID of the BillForward Account who will own this subscription. You should ensure beforehand that the customer has had a BillForward Account created for them.\",\"verbs\":[\"POST\"]} + """Gets the account_id of this CreateSubscriptionRequest. # noqa: E501 + - :return: The account_id of this CreateSubscriptionRequest. + :return: The account_id of this CreateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this CreateSubscriptionRequest. - {\"description\":\"ID of the BillForward Account who will own this subscription. You should ensure beforehand that the customer has had a BillForward Account created for them.\",\"verbs\":[\"POST\"]} + """Sets the account_id of this CreateSubscriptionRequest. + - :param account_id: The account_id of this CreateSubscriptionRequest. + :param account_id: The account_id of this CreateSubscriptionRequest. # noqa: E501 :type: str """ @@ -129,22 +246,20 @@ def account_id(self, account_id): @property def product(self): - """ - Gets the product of this CreateSubscriptionRequest. - {\"description\":\"Name or ID of the product.\",\"verbs\":[\"POST\"]} + """Gets the product of this CreateSubscriptionRequest. # noqa: E501 - :return: The product of this CreateSubscriptionRequest. + + :return: The product of this CreateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._product @product.setter def product(self, product): - """ - Sets the product of this CreateSubscriptionRequest. - {\"description\":\"Name or ID of the product.\",\"verbs\":[\"POST\"]} + """Sets the product of this CreateSubscriptionRequest. - :param product: The product of this CreateSubscriptionRequest. + + :param product: The product of this CreateSubscriptionRequest. # noqa: E501 :type: str """ @@ -152,22 +267,20 @@ def product(self, product): @property def product_rate_plan(self): - """ - Gets the product_rate_plan of this CreateSubscriptionRequest. - {\"description\":\"ID or name of the rate plan to which the subscription will be subscribing. Lookup by name is only possible if a `productID` is specified.\",\"verbs\":[\"POST\"]} + """Gets the product_rate_plan of this CreateSubscriptionRequest. # noqa: E501 + - :return: The product_rate_plan of this CreateSubscriptionRequest. + :return: The product_rate_plan of this CreateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._product_rate_plan @product_rate_plan.setter def product_rate_plan(self, product_rate_plan): - """ - Sets the product_rate_plan of this CreateSubscriptionRequest. - {\"description\":\"ID or name of the rate plan to which the subscription will be subscribing. Lookup by name is only possible if a `productID` is specified.\",\"verbs\":[\"POST\"]} + """Sets the product_rate_plan of this CreateSubscriptionRequest. + - :param product_rate_plan: The product_rate_plan of this CreateSubscriptionRequest. + :param product_rate_plan: The product_rate_plan of this CreateSubscriptionRequest. # noqa: E501 :type: str """ @@ -175,22 +288,20 @@ def product_rate_plan(self, product_rate_plan): @property def organization_id(self): - """ - Gets the organization_id of this CreateSubscriptionRequest. - {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested Subscription should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} + """Gets the organization_id of this CreateSubscriptionRequest. # noqa: E501 + - :return: The organization_id of this CreateSubscriptionRequest. + :return: The organization_id of this CreateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this CreateSubscriptionRequest. - {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested Subscription should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} + """Sets the organization_id of this CreateSubscriptionRequest. - :param organization_id: The organization_id of this CreateSubscriptionRequest. + + :param organization_id: The organization_id of this CreateSubscriptionRequest. # noqa: E501 :type: str """ @@ -198,22 +309,20 @@ def organization_id(self, organization_id): @property def name(self): - """ - Gets the name of this CreateSubscriptionRequest. - {\"default\":\"(Subscription will be named after the rate plan to which the subscription subscribes)\",\"description\":\"Name of the created subscription. This is primarily for your benefit — for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'Customer 1425, guy@mail.com, Premium membership').\",\"verbs\":[\"POST\"]} + """Gets the name of this CreateSubscriptionRequest. # noqa: E501 - :return: The name of this CreateSubscriptionRequest. + + :return: The name of this CreateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this CreateSubscriptionRequest. - {\"default\":\"(Subscription will be named after the rate plan to which the subscription subscribes)\",\"description\":\"Name of the created subscription. This is primarily for your benefit — for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'Customer 1425, guy@mail.com, Premium membership').\",\"verbs\":[\"POST\"]} + """Sets the name of this CreateSubscriptionRequest. - :param name: The name of this CreateSubscriptionRequest. + + :param name: The name of this CreateSubscriptionRequest. # noqa: E501 :type: str """ @@ -221,45 +330,62 @@ def name(self, name): @property def description(self): - """ - Gets the description of this CreateSubscriptionRequest. - {\"default\":\"(null)\",\"description\":\"Description of the created subscription. This is primarily for your benefit — for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Customer obtained through Lazy Wednesdays promotion').\",\"verbs\":[\"POST\"]} + """Gets the description of this CreateSubscriptionRequest. # noqa: E501 - :return: The description of this CreateSubscriptionRequest. + + :return: The description of this CreateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this CreateSubscriptionRequest. - {\"default\":\"(null)\",\"description\":\"Description of the created subscription. This is primarily for your benefit — for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Customer obtained through Lazy Wednesdays promotion').\",\"verbs\":[\"POST\"]} + """Sets the description of this CreateSubscriptionRequest. + - :param description: The description of this CreateSubscriptionRequest. + :param description: The description of this CreateSubscriptionRequest. # noqa: E501 :type: str """ self._description = description @property - def start(self): + def contract_start(self): + """Gets the contract_start of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The contract_start of this CreateSubscriptionRequest. # noqa: E501 + :rtype: datetime """ - Gets the start of this CreateSubscriptionRequest. - {\"default\":\"(ServerNow upon receiving request)\",\"description\":\"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.\",\"verbs\":[\"POST\"]} + return self._contract_start + + @contract_start.setter + def contract_start(self, contract_start): + """Sets the contract_start of this CreateSubscriptionRequest. + + + :param contract_start: The contract_start of this CreateSubscriptionRequest. # noqa: E501 + :type: datetime + """ + + self._contract_start = contract_start + + @property + def start(self): + """Gets the start of this CreateSubscriptionRequest. # noqa: E501 + - :return: The start of this CreateSubscriptionRequest. + :return: The start of this CreateSubscriptionRequest. # noqa: E501 :rtype: datetime """ return self._start @start.setter def start(self, start): - """ - Sets the start of this CreateSubscriptionRequest. - {\"default\":\"(ServerNow upon receiving request)\",\"description\":\"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.\",\"verbs\":[\"POST\"]} + """Sets the start of this CreateSubscriptionRequest. + - :param start: The start of this CreateSubscriptionRequest. + :param start: The start of this CreateSubscriptionRequest. # noqa: E501 :type: datetime """ @@ -267,22 +393,20 @@ def start(self, start): @property def end(self): - """ - Gets the end of this CreateSubscriptionRequest. - {\"default\":\"(1 period ahead of the `start` time)\",\"description\":\"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should finish its first service period.\",\"verbs\":[\"POST\"]} + """Gets the end of this CreateSubscriptionRequest. # noqa: E501 + - :return: The end of this CreateSubscriptionRequest. + :return: The end of this CreateSubscriptionRequest. # noqa: E501 :rtype: datetime """ return self._end @end.setter def end(self, end): - """ - Sets the end of this CreateSubscriptionRequest. - {\"default\":\"(1 period ahead of the `start` time)\",\"description\":\"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should finish its first service period.\",\"verbs\":[\"POST\"]} + """Sets the end of this CreateSubscriptionRequest. - :param end: The end of this CreateSubscriptionRequest. + + :param end: The end of this CreateSubscriptionRequest. # noqa: E501 :type: datetime """ @@ -290,28 +414,26 @@ def end(self, end): @property def state(self): - """ - Gets the state of this CreateSubscriptionRequest. - {\"default\":\"Provisioned\",\"description\":\"The state in which the created subscription will begin.
Provisioned — The subscription will wait (without raising any invoices or beginning its service) until explicit action is taken to change its state.
AwaitingPayment — The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.\",\"verbs\":[\"POST\"]} + """Gets the state of this CreateSubscriptionRequest. # noqa: E501 - :return: The state of this CreateSubscriptionRequest. + + :return: The state of this CreateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._state @state.setter def state(self, state): - """ - Sets the state of this CreateSubscriptionRequest. - {\"default\":\"Provisioned\",\"description\":\"The state in which the created subscription will begin.
Provisioned — The subscription will wait (without raising any invoices or beginning its service) until explicit action is taken to change its state.
AwaitingPayment — The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.\",\"verbs\":[\"POST\"]} + """Sets the state of this CreateSubscriptionRequest. + - :param state: The state of this CreateSubscriptionRequest. + :param state: The state of this CreateSubscriptionRequest. # noqa: E501 :type: str """ - allowed_values = ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"] + allowed_values = ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"] # noqa: E501 if state not in allowed_values: raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 .format(state, allowed_values) ) @@ -319,22 +441,20 @@ def state(self, state): @property def trial_end(self): - """ - Gets the trial_end of this CreateSubscriptionRequest. - {\"default\":\"(null)\",\"description\":\"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should leave the trial period.\",\"verbs\":[\"POST\"]} + """Gets the trial_end of this CreateSubscriptionRequest. # noqa: E501 + - :return: The trial_end of this CreateSubscriptionRequest. + :return: The trial_end of this CreateSubscriptionRequest. # noqa: E501 :rtype: datetime """ return self._trial_end @trial_end.setter def trial_end(self, trial_end): - """ - Sets the trial_end of this CreateSubscriptionRequest. - {\"default\":\"(null)\",\"description\":\"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should leave the trial period.\",\"verbs\":[\"POST\"]} + """Sets the trial_end of this CreateSubscriptionRequest. + - :param trial_end: The trial_end of this CreateSubscriptionRequest. + :param trial_end: The trial_end of this CreateSubscriptionRequest. # noqa: E501 :type: datetime """ @@ -342,230 +462,468 @@ def trial_end(self, trial_end): @property def type(self): - """ - Gets the type of this CreateSubscriptionRequest. + """Gets the type of this CreateSubscriptionRequest. # noqa: E501 - :return: The type of this CreateSubscriptionRequest. + :return: The type of this CreateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._type @type.setter def type(self, type): - """ - Sets the type of this CreateSubscriptionRequest. + """Sets the type of this CreateSubscriptionRequest. - :param type: The type of this CreateSubscriptionRequest. + :param type: The type of this CreateSubscriptionRequest. # noqa: E501 :type: str """ - allowed_values = ["Subscription", "FixedTerm", "Trial"] + allowed_values = ["Subscription", "Trial", "FixedTerm"] # noqa: E501 if type not in allowed_values: raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 .format(type, allowed_values) ) self._type = type @property - def parent_id(self): + def failed_payment_behaviour(self): + """Gets the failed_payment_behaviour of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The failed_payment_behaviour of this CreateSubscriptionRequest. # noqa: E501 + :rtype: str """ - Gets the parent_id of this CreateSubscriptionRequest. - {\"default\":\"(If a subscription exists which 'aggregates all subscriptions belonging to this BillForward Account', refer to the ID of that subscription. Otherwise: null)\",\"description\":\"ID of a parent subscription which will collect the charges raised by this subscription. The parent becomes responsible for paying those charges. If a subscription exists which 'aggregates all subscriptions belonging to this BillForward Account', then that parent will override any parent specified here.\",\"verbs\":[\"POST\"]} + return self._failed_payment_behaviour - :return: The parent_id of this CreateSubscriptionRequest. + @failed_payment_behaviour.setter + def failed_payment_behaviour(self, failed_payment_behaviour): + """Sets the failed_payment_behaviour of this CreateSubscriptionRequest. + + + :param failed_payment_behaviour: The failed_payment_behaviour of this CreateSubscriptionRequest. # noqa: E501 + :type: str + """ + allowed_values = ["CancelSubscription", "None"] # noqa: E501 + if failed_payment_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `failed_payment_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(failed_payment_behaviour, allowed_values) + ) + + self._failed_payment_behaviour = failed_payment_behaviour + + @property + def parent_id(self): + """Gets the parent_id of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The parent_id of this CreateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._parent_id @parent_id.setter def parent_id(self, parent_id): - """ - Sets the parent_id of this CreateSubscriptionRequest. - {\"default\":\"(If a subscription exists which 'aggregates all subscriptions belonging to this BillForward Account', refer to the ID of that subscription. Otherwise: null)\",\"description\":\"ID of a parent subscription which will collect the charges raised by this subscription. The parent becomes responsible for paying those charges. If a subscription exists which 'aggregates all subscriptions belonging to this BillForward Account', then that parent will override any parent specified here.\",\"verbs\":[\"POST\"]} + """Sets the parent_id of this CreateSubscriptionRequest. + - :param parent_id: The parent_id of this CreateSubscriptionRequest. + :param parent_id: The parent_id of this CreateSubscriptionRequest. # noqa: E501 :type: str """ self._parent_id = parent_id @property - def aggregate_all_subscriptions_on_account(self): + def exclude_from_auto_aggregation(self): + """Gets the exclude_from_auto_aggregation of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The exclude_from_auto_aggregation of this CreateSubscriptionRequest. # noqa: E501 + :rtype: bool """ - Gets the aggregate_all_subscriptions_on_account of this CreateSubscriptionRequest. - {\"default\":false,\"description\":\"Whether this subscription should become an 'aggregating subscription', collecting charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.\",\"verbs\":[\"POST\"]} + return self._exclude_from_auto_aggregation + + @exclude_from_auto_aggregation.setter + def exclude_from_auto_aggregation(self, exclude_from_auto_aggregation): + """Sets the exclude_from_auto_aggregation of this CreateSubscriptionRequest. + + + :param exclude_from_auto_aggregation: The exclude_from_auto_aggregation of this CreateSubscriptionRequest. # noqa: E501 + :type: bool + """ + + self._exclude_from_auto_aggregation = exclude_from_auto_aggregation + + @property + def aggregate_all_subscriptions_on_account(self): + """Gets the aggregate_all_subscriptions_on_account of this CreateSubscriptionRequest. # noqa: E501 + - :return: The aggregate_all_subscriptions_on_account of this CreateSubscriptionRequest. + :return: The aggregate_all_subscriptions_on_account of this CreateSubscriptionRequest. # noqa: E501 :rtype: bool """ return self._aggregate_all_subscriptions_on_account @aggregate_all_subscriptions_on_account.setter def aggregate_all_subscriptions_on_account(self, aggregate_all_subscriptions_on_account): - """ - Sets the aggregate_all_subscriptions_on_account of this CreateSubscriptionRequest. - {\"default\":false,\"description\":\"Whether this subscription should become an 'aggregating subscription', collecting charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.\",\"verbs\":[\"POST\"]} + """Sets the aggregate_all_subscriptions_on_account of this CreateSubscriptionRequest. + - :param aggregate_all_subscriptions_on_account: The aggregate_all_subscriptions_on_account of this CreateSubscriptionRequest. + :param aggregate_all_subscriptions_on_account: The aggregate_all_subscriptions_on_account of this CreateSubscriptionRequest. # noqa: E501 :type: bool """ self._aggregate_all_subscriptions_on_account = aggregate_all_subscriptions_on_account @property - def align_period_with_aggregating_subscription(self): + def allow_subscription_wihtout_rate_plan(self): + """Gets the allow_subscription_wihtout_rate_plan of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The allow_subscription_wihtout_rate_plan of this CreateSubscriptionRequest. # noqa: E501 + :rtype: bool + """ + return self._allow_subscription_wihtout_rate_plan + + @allow_subscription_wihtout_rate_plan.setter + def allow_subscription_wihtout_rate_plan(self, allow_subscription_wihtout_rate_plan): + """Sets the allow_subscription_wihtout_rate_plan of this CreateSubscriptionRequest. + + + :param allow_subscription_wihtout_rate_plan: The allow_subscription_wihtout_rate_plan of this CreateSubscriptionRequest. # noqa: E501 + :type: bool + """ + + self._allow_subscription_wihtout_rate_plan = allow_subscription_wihtout_rate_plan + + @property + def dont_create_default_fixed_term(self): + """Gets the dont_create_default_fixed_term of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The dont_create_default_fixed_term of this CreateSubscriptionRequest. # noqa: E501 + :rtype: bool + """ + return self._dont_create_default_fixed_term + + @dont_create_default_fixed_term.setter + def dont_create_default_fixed_term(self, dont_create_default_fixed_term): + """Sets the dont_create_default_fixed_term of this CreateSubscriptionRequest. + + + :param dont_create_default_fixed_term: The dont_create_default_fixed_term of this CreateSubscriptionRequest. # noqa: E501 + :type: bool """ - Gets the align_period_with_aggregating_subscription of this CreateSubscriptionRequest. - {\"default\":true,\"description\":\"Whether to override the `end` date to line up with the current period end of the 'aggregating subscription' to which this subscription belongs.\",\"verbs\":[\"POST\"]} - :return: The align_period_with_aggregating_subscription of this CreateSubscriptionRequest. + self._dont_create_default_fixed_term = dont_create_default_fixed_term + + @property + def align_period_with_aggregating_subscription(self): + """Gets the align_period_with_aggregating_subscription of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The align_period_with_aggregating_subscription of this CreateSubscriptionRequest. # noqa: E501 :rtype: bool """ return self._align_period_with_aggregating_subscription @align_period_with_aggregating_subscription.setter def align_period_with_aggregating_subscription(self, align_period_with_aggregating_subscription): - """ - Sets the align_period_with_aggregating_subscription of this CreateSubscriptionRequest. - {\"default\":true,\"description\":\"Whether to override the `end` date to line up with the current period end of the 'aggregating subscription' to which this subscription belongs.\",\"verbs\":[\"POST\"]} + """Sets the align_period_with_aggregating_subscription of this CreateSubscriptionRequest. - :param align_period_with_aggregating_subscription: The align_period_with_aggregating_subscription of this CreateSubscriptionRequest. + + :param align_period_with_aggregating_subscription: The align_period_with_aggregating_subscription of this CreateSubscriptionRequest. # noqa: E501 :type: bool """ self._align_period_with_aggregating_subscription = align_period_with_aggregating_subscription @property - def pricing_component_quantities(self): + def parent_should_copy_child_period_end(self): + """Gets the parent_should_copy_child_period_end of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The parent_should_copy_child_period_end of this CreateSubscriptionRequest. # noqa: E501 + :rtype: bool """ - Gets the pricing_component_quantities of this CreateSubscriptionRequest. - {\"default\":\"(empty list)\",\"description\":\"Quantities that this subscription possesses (upon beginning service), of pricing components upon the subscription's rate plan. For example: you can set the subscription to begin its service with '5 widgets' consumed. Otherwise the 'default quantity' will be observed instead, for each pricing component upon the rate plan.\",\"verbs\":[\"POST\"]} + return self._parent_should_copy_child_period_end - :return: The pricing_component_quantities of this CreateSubscriptionRequest. - :rtype: list[PricingComponentQuantityRequest] + @parent_should_copy_child_period_end.setter + def parent_should_copy_child_period_end(self, parent_should_copy_child_period_end): + """Sets the parent_should_copy_child_period_end of this CreateSubscriptionRequest. + + + :param parent_should_copy_child_period_end: The parent_should_copy_child_period_end of this CreateSubscriptionRequest. # noqa: E501 + :type: bool + """ + + self._parent_should_copy_child_period_end = parent_should_copy_child_period_end + + @property + def pricing_component_quantities(self): + """Gets the pricing_component_quantities of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The pricing_component_quantities of this CreateSubscriptionRequest. # noqa: E501 + :rtype: list[CreatePricingComponentQuantityRequest] """ return self._pricing_component_quantities @pricing_component_quantities.setter def pricing_component_quantities(self, pricing_component_quantities): - """ - Sets the pricing_component_quantities of this CreateSubscriptionRequest. - {\"default\":\"(empty list)\",\"description\":\"Quantities that this subscription possesses (upon beginning service), of pricing components upon the subscription's rate plan. For example: you can set the subscription to begin its service with '5 widgets' consumed. Otherwise the 'default quantity' will be observed instead, for each pricing component upon the rate plan.\",\"verbs\":[\"POST\"]} + """Sets the pricing_component_quantities of this CreateSubscriptionRequest. + - :param pricing_component_quantities: The pricing_component_quantities of this CreateSubscriptionRequest. - :type: list[PricingComponentQuantityRequest] + :param pricing_component_quantities: The pricing_component_quantities of this CreateSubscriptionRequest. # noqa: E501 + :type: list[CreatePricingComponentQuantityRequest] """ self._pricing_component_quantities = pricing_component_quantities @property - def metadata(self): + def payment_terms(self): + """Gets the payment_terms of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The payment_terms of this CreateSubscriptionRequest. # noqa: E501 + :rtype: int """ - Gets the metadata of this CreateSubscriptionRequest. - { \"description\" : \"Add metadata.\", \"verbs\":[\"POST\"] } + return self._payment_terms - :return: The metadata of this CreateSubscriptionRequest. - :rtype: DynamicMetadata + @payment_terms.setter + def payment_terms(self, payment_terms): + """Sets the payment_terms of this CreateSubscriptionRequest. + + + :param payment_terms: The payment_terms of this CreateSubscriptionRequest. # noqa: E501 + :type: int """ - return self._metadata - @metadata.setter - def metadata(self, metadata): + self._payment_terms = payment_terms + + @property + def purchase_order(self): + """Gets the purchase_order of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The purchase_order of this CreateSubscriptionRequest. # noqa: E501 + :rtype: str """ - Sets the metadata of this CreateSubscriptionRequest. - { \"description\" : \"Add metadata.\", \"verbs\":[\"POST\"] } + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this CreateSubscriptionRequest. + - :param metadata: The metadata of this CreateSubscriptionRequest. - :type: DynamicMetadata + :param purchase_order: The purchase_order of this CreateSubscriptionRequest. # noqa: E501 + :type: str """ - self._metadata = metadata + self._purchase_order = purchase_order @property - def payment_terms(self): + def coupon_codes(self): + """Gets the coupon_codes of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The coupon_codes of this CreateSubscriptionRequest. # noqa: E501 + :rtype: list[str] """ - Gets the payment_terms of this CreateSubscriptionRequest. + return self._coupon_codes + @coupon_codes.setter + def coupon_codes(self, coupon_codes): + """Sets the coupon_codes of this CreateSubscriptionRequest. - :return: The payment_terms of this CreateSubscriptionRequest. - :rtype: int + + :param coupon_codes: The coupon_codes of this CreateSubscriptionRequest. # noqa: E501 + :type: list[str] """ - return self._payment_terms - @payment_terms.setter - def payment_terms(self, payment_terms): + self._coupon_codes = coupon_codes + + @property + def prepayment_amount(self): + """Gets the prepayment_amount of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The prepayment_amount of this CreateSubscriptionRequest. # noqa: E501 + :rtype: float """ - Sets the payment_terms of this CreateSubscriptionRequest. + return self._prepayment_amount + @prepayment_amount.setter + def prepayment_amount(self, prepayment_amount): + """Sets the prepayment_amount of this CreateSubscriptionRequest. - :param payment_terms: The payment_terms of this CreateSubscriptionRequest. - :type: int + + :param prepayment_amount: The prepayment_amount of this CreateSubscriptionRequest. # noqa: E501 + :type: float """ - self._payment_terms = payment_terms + self._prepayment_amount = prepayment_amount @property - def contract_start(self): + def extras(self): + """Gets the extras of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The extras of this CreateSubscriptionRequest. # noqa: E501 + :rtype: Extras """ - Gets the contract_start of this CreateSubscriptionRequest. - {\"description\":\"start of the contracted period. This will be after a trial, if one exists\",\"verbs\":[\"GET\"]} + return self._extras - :return: The contract_start of this CreateSubscriptionRequest. - :rtype: datetime + @extras.setter + def extras(self, extras): + """Sets the extras of this CreateSubscriptionRequest. + + + :param extras: The extras of this CreateSubscriptionRequest. # noqa: E501 + :type: Extras """ - return self._contract_start - @contract_start.setter - def contract_start(self, contract_start): + self._extras = extras + + @property + def termed_subscription(self): + """Gets the termed_subscription of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The termed_subscription of this CreateSubscriptionRequest. # noqa: E501 + :rtype: bool """ - Sets the contract_start of this CreateSubscriptionRequest. - {\"description\":\"start of the contracted period. This will be after a trial, if one exists\",\"verbs\":[\"GET\"]} + return self._termed_subscription - :param contract_start: The contract_start of this CreateSubscriptionRequest. - :type: datetime + @termed_subscription.setter + def termed_subscription(self, termed_subscription): + """Sets the termed_subscription of this CreateSubscriptionRequest. + + + :param termed_subscription: The termed_subscription of this CreateSubscriptionRequest. # noqa: E501 + :type: bool """ - self._contract_start = contract_start + self._termed_subscription = termed_subscription @property - def failed_payment_behaviour(self): + def term_periods(self): + """Gets the term_periods of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The term_periods of this CreateSubscriptionRequest. # noqa: E501 + :rtype: int """ - Gets the failed_payment_behaviour of this CreateSubscriptionRequest. - {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.
CancelSubscription — Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.
None — The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles — or when manual invoice remediation is common — None is recommended.
In a heavily-automated SaaS environment, automatic cancellation via CancelSubscription is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + return self._term_periods - :return: The failed_payment_behaviour of this CreateSubscriptionRequest. - :rtype: str + @term_periods.setter + def term_periods(self, term_periods): + """Sets the term_periods of this CreateSubscriptionRequest. + + + :param term_periods: The term_periods of this CreateSubscriptionRequest. # noqa: E501 + :type: int """ - return self._failed_payment_behaviour - @failed_payment_behaviour.setter - def failed_payment_behaviour(self, failed_payment_behaviour): + self._term_periods = term_periods + + @property + def term_expiry_behaviour(self): + """Gets the term_expiry_behaviour of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The term_expiry_behaviour of this CreateSubscriptionRequest. # noqa: E501 + :rtype: str """ - Sets the failed_payment_behaviour of this CreateSubscriptionRequest. - {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.
CancelSubscription — Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.
None — The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles — or when manual invoice remediation is common — None is recommended.
In a heavily-automated SaaS environment, automatic cancellation via CancelSubscription is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + return self._term_expiry_behaviour + + @term_expiry_behaviour.setter + def term_expiry_behaviour(self, term_expiry_behaviour): + """Sets the term_expiry_behaviour of this CreateSubscriptionRequest. - :param failed_payment_behaviour: The failed_payment_behaviour of this CreateSubscriptionRequest. + + :param term_expiry_behaviour: The term_expiry_behaviour of this CreateSubscriptionRequest. # noqa: E501 :type: str """ - allowed_values = ["CancelSubscription", "None"] - if failed_payment_behaviour not in allowed_values: + allowed_values = ["ExpireSubscription", "EvergreenSubscription", "RecurLatestPricing", "ChangePlan"] # noqa: E501 + if term_expiry_behaviour not in allowed_values: raise ValueError( - "Invalid value for `failed_payment_behaviour` ({0}), must be one of {1}" - .format(failed_payment_behaviour, allowed_values) + "Invalid value for `term_expiry_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(term_expiry_behaviour, allowed_values) ) - self._failed_payment_behaviour = failed_payment_behaviour + self._term_expiry_behaviour = term_expiry_behaviour - def to_dict(self): + @property + def subsequent_product_rate_plan(self): + """Gets the subsequent_product_rate_plan of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The subsequent_product_rate_plan of this CreateSubscriptionRequest. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._subsequent_product_rate_plan + + @subsequent_product_rate_plan.setter + def subsequent_product_rate_plan(self, subsequent_product_rate_plan): + """Sets the subsequent_product_rate_plan of this CreateSubscriptionRequest. + + + :param subsequent_product_rate_plan: The subsequent_product_rate_plan of this CreateSubscriptionRequest. # noqa: E501 + :type: str """ + + self._subsequent_product_rate_plan = subsequent_product_rate_plan + + @property + def metadata(self): + """Gets the metadata of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The metadata of this CreateSubscriptionRequest. # noqa: E501 + :rtype: dict(str, object) + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """Sets the metadata of this CreateSubscriptionRequest. + + + :param metadata: The metadata of this CreateSubscriptionRequest. # noqa: E501 + :type: dict(str, object) + """ + + self._metadata = metadata + + @property + def ignore_first_period_usage(self): + """Gets the ignore_first_period_usage of this CreateSubscriptionRequest. # noqa: E501 + + + :return: The ignore_first_period_usage of this CreateSubscriptionRequest. # noqa: E501 + :rtype: bool + """ + return self._ignore_first_period_usage + + @ignore_first_period_usage.setter + def ignore_first_period_usage(self, ignore_first_period_usage): + """Sets the ignore_first_period_usage of this CreateSubscriptionRequest. + + + :param ignore_first_period_usage: The ignore_first_period_usage of this CreateSubscriptionRequest. # noqa: E501 + :type: bool + """ + + self._ignore_first_period_usage = ignore_first_period_usage + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -582,29 +940,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CreateSubscriptionRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CreateSubscriptionRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/create_subscription_timer_request.py b/billforward/models/create_subscription_timer_request.py new file mode 100644 index 0000000..8df6f6a --- /dev/null +++ b/billforward/models/create_subscription_timer_request.py @@ -0,0 +1,258 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreateSubscriptionTimerRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'period': 'str', + 'duration': 'int', + 'direction': 'str', + 'event': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'period': 'period', + 'duration': 'duration', + 'direction': 'direction', + 'event': 'event' + } + + def __init__(self, created=None, organization_id=None, period=None, duration=None, direction=None, event=None): # noqa: E501 + """CreateSubscriptionTimerRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._period = None + self._duration = None + self._direction = None + self._event = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if period is not None: + self.period = period + if duration is not None: + self.duration = duration + if direction is not None: + self.direction = direction + if event is not None: + self.event = event + + @property + def created(self): + """Gets the created of this CreateSubscriptionTimerRequest. # noqa: E501 + + + :return: The created of this CreateSubscriptionTimerRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this CreateSubscriptionTimerRequest. + + + :param created: The created of this CreateSubscriptionTimerRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this CreateSubscriptionTimerRequest. # noqa: E501 + + + :return: The organization_id of this CreateSubscriptionTimerRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CreateSubscriptionTimerRequest. + + + :param organization_id: The organization_id of this CreateSubscriptionTimerRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def period(self): + """Gets the period of this CreateSubscriptionTimerRequest. # noqa: E501 + + + :return: The period of this CreateSubscriptionTimerRequest. # noqa: E501 + :rtype: str + """ + return self._period + + @period.setter + def period(self, period): + """Sets the period of this CreateSubscriptionTimerRequest. + + + :param period: The period of this CreateSubscriptionTimerRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Minutes", "Hours", "Days"] # noqa: E501 + if period not in allowed_values: + raise ValueError( + "Invalid value for `period` ({0}), must be one of {1}" # noqa: E501 + .format(period, allowed_values) + ) + + self._period = period + + @property + def duration(self): + """Gets the duration of this CreateSubscriptionTimerRequest. # noqa: E501 + + + :return: The duration of this CreateSubscriptionTimerRequest. # noqa: E501 + :rtype: int + """ + return self._duration + + @duration.setter + def duration(self, duration): + """Sets the duration of this CreateSubscriptionTimerRequest. + + + :param duration: The duration of this CreateSubscriptionTimerRequest. # noqa: E501 + :type: int + """ + + self._duration = duration + + @property + def direction(self): + """Gets the direction of this CreateSubscriptionTimerRequest. # noqa: E501 + + + :return: The direction of this CreateSubscriptionTimerRequest. # noqa: E501 + :rtype: str + """ + return self._direction + + @direction.setter + def direction(self, direction): + """Sets the direction of this CreateSubscriptionTimerRequest. + + + :param direction: The direction of this CreateSubscriptionTimerRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Before", "After"] # noqa: E501 + if direction not in allowed_values: + raise ValueError( + "Invalid value for `direction` ({0}), must be one of {1}" # noqa: E501 + .format(direction, allowed_values) + ) + + self._direction = direction + + @property + def event(self): + """Gets the event of this CreateSubscriptionTimerRequest. # noqa: E501 + + + :return: The event of this CreateSubscriptionTimerRequest. # noqa: E501 + :rtype: str + """ + return self._event + + @event.setter + def event(self, event): + """Sets the event of this CreateSubscriptionTimerRequest. + + + :param event: The event of this CreateSubscriptionTimerRequest. # noqa: E501 + :type: str + """ + allowed_values = ["TrialExpiry", "SubscriptionExpiry", "PeriodEnd"] # noqa: E501 + if event not in allowed_values: + raise ValueError( + "Invalid value for `event` ({0}), must be one of {1}" # noqa: E501 + .format(event, allowed_values) + ) + + self._event = event + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreateSubscriptionTimerRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreateSubscriptionTimerRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/create_totp_request.py b/billforward/models/create_totp_request.py new file mode 100644 index 0000000..5544733 --- /dev/null +++ b/billforward/models/create_totp_request.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreateTOTPRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'password': 'str', + 'include_billforward_logo': 'bool', + 'code': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'password': 'password', + 'include_billforward_logo': 'includeBillforwardLogo', + 'code': 'code', + 'organization_id': 'organizationID' + } + + def __init__(self, password=None, include_billforward_logo=None, code=None, organization_id=None): # noqa: E501 + """CreateTOTPRequest - a model defined in Swagger""" # noqa: E501 + self._password = None + self._include_billforward_logo = None + self._code = None + self._organization_id = None + self.discriminator = None + if password is not None: + self.password = password + if include_billforward_logo is not None: + self.include_billforward_logo = include_billforward_logo + if code is not None: + self.code = code + if organization_id is not None: + self.organization_id = organization_id + + @property + def password(self): + """Gets the password of this CreateTOTPRequest. # noqa: E501 + + + :return: The password of this CreateTOTPRequest. # noqa: E501 + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """Sets the password of this CreateTOTPRequest. + + + :param password: The password of this CreateTOTPRequest. # noqa: E501 + :type: str + """ + + self._password = password + + @property + def include_billforward_logo(self): + """Gets the include_billforward_logo of this CreateTOTPRequest. # noqa: E501 + + + :return: The include_billforward_logo of this CreateTOTPRequest. # noqa: E501 + :rtype: bool + """ + return self._include_billforward_logo + + @include_billforward_logo.setter + def include_billforward_logo(self, include_billforward_logo): + """Sets the include_billforward_logo of this CreateTOTPRequest. + + + :param include_billforward_logo: The include_billforward_logo of this CreateTOTPRequest. # noqa: E501 + :type: bool + """ + + self._include_billforward_logo = include_billforward_logo + + @property + def code(self): + """Gets the code of this CreateTOTPRequest. # noqa: E501 + + + :return: The code of this CreateTOTPRequest. # noqa: E501 + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """Sets the code of this CreateTOTPRequest. + + + :param code: The code of this CreateTOTPRequest. # noqa: E501 + :type: str + """ + + self._code = code + + @property + def organization_id(self): + """Gets the organization_id of this CreateTOTPRequest. # noqa: E501 + + + :return: The organization_id of this CreateTOTPRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this CreateTOTPRequest. + + + :param organization_id: The organization_id of this CreateTOTPRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreateTOTPRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreateTOTPRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/credit_account_request.py b/billforward/models/credit_account_request.py index 0e31843..8ccf85c 100644 --- a/billforward/models/credit_account_request.py +++ b/billforward/models/credit_account_request.py @@ -1,88 +1,93 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class CreditAccountRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, organization_id=None, value=None, currency=None, invoice_id=None, description=None): - """ - CreditAccountRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'organization_id': 'str', - 'value': 'float', - 'currency': 'str', - 'invoice_id': 'str', - 'description': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'organization_id': 'organizationID', - 'value': 'value', - 'currency': 'currency', - 'invoice_id': 'invoiceID', - 'description': 'description' - } - - self._created = created - self._organization_id = organization_id - self._value = value - self._currency = currency - self._invoice_id = invoice_id - self._description = description + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'value': 'float', + 'expires': 'datetime', + 'currency': 'CreditNoteCurrency', + 'invoice_id': 'str', + 'description': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'value': 'value', + 'expires': 'expires', + 'currency': 'currency', + 'invoice_id': 'invoiceID', + 'description': 'description' + } + + def __init__(self, created=None, organization_id=None, value=None, expires=None, currency=None, invoice_id=None, description=None): # noqa: E501 + """CreditAccountRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._value = None + self._expires = None + self._currency = None + self._invoice_id = None + self._description = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if value is not None: + self.value = value + if expires is not None: + self.expires = expires + if currency is not None: + self.currency = currency + if invoice_id is not None: + self.invoice_id = invoice_id + if description is not None: + self.description = description @property def created(self): - """ - Gets the created of this CreditAccountRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this CreditAccountRequest. # noqa: E501 + - :return: The created of this CreditAccountRequest. + :return: The created of this CreditAccountRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this CreditAccountRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this CreditAccountRequest. + - :param created: The created of this CreditAccountRequest. + :param created: The created of this CreditAccountRequest. # noqa: E501 :type: datetime """ @@ -90,22 +95,20 @@ def created(self, created): @property def organization_id(self): - """ - Gets the organization_id of this CreditAccountRequest. - { \"description\" : \"\", \"verbs\":[] } + """Gets the organization_id of this CreditAccountRequest. # noqa: E501 + - :return: The organization_id of this CreditAccountRequest. + :return: The organization_id of this CreditAccountRequest. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this CreditAccountRequest. - { \"description\" : \"\", \"verbs\":[] } + """Sets the organization_id of this CreditAccountRequest. + - :param organization_id: The organization_id of this CreditAccountRequest. + :param organization_id: The organization_id of this CreditAccountRequest. # noqa: E501 :type: str """ @@ -113,68 +116,83 @@ def organization_id(self, organization_id): @property def value(self): - """ - Gets the value of this CreditAccountRequest. - { \"description\" : \" Monetary value of the credit\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the value of this CreditAccountRequest. # noqa: E501 + - :return: The value of this CreditAccountRequest. + :return: The value of this CreditAccountRequest. # noqa: E501 :rtype: float """ return self._value @value.setter def value(self, value): - """ - Sets the value of this CreditAccountRequest. - { \"description\" : \" Monetary value of the credit\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the value of this CreditAccountRequest. + - :param value: The value of this CreditAccountRequest. + :param value: The value of this CreditAccountRequest. # noqa: E501 :type: float """ self._value = value @property - def currency(self): + def expires(self): + """Gets the expires of this CreditAccountRequest. # noqa: E501 + + + :return: The expires of this CreditAccountRequest. # noqa: E501 + :rtype: datetime """ - Gets the currency of this CreditAccountRequest. - { \"description\" : \"Currency of the credit\", \"verbs\":[\"POST\",\"GET\"] } + return self._expires - :return: The currency of this CreditAccountRequest. - :rtype: str + @expires.setter + def expires(self, expires): + """Sets the expires of this CreditAccountRequest. + + + :param expires: The expires of this CreditAccountRequest. # noqa: E501 + :type: datetime + """ + + self._expires = expires + + @property + def currency(self): + """Gets the currency of this CreditAccountRequest. # noqa: E501 + + + :return: The currency of this CreditAccountRequest. # noqa: E501 + :rtype: CreditNoteCurrency """ return self._currency @currency.setter def currency(self, currency): - """ - Sets the currency of this CreditAccountRequest. - { \"description\" : \"Currency of the credit\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the currency of this CreditAccountRequest. - :param currency: The currency of this CreditAccountRequest. - :type: str + + :param currency: The currency of this CreditAccountRequest. # noqa: E501 + :type: CreditNoteCurrency """ self._currency = currency @property def invoice_id(self): - """ - Gets the invoice_id of this CreditAccountRequest. - { \"description\" : \"Reference an invoice\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the invoice_id of this CreditAccountRequest. # noqa: E501 - :return: The invoice_id of this CreditAccountRequest. + + :return: The invoice_id of this CreditAccountRequest. # noqa: E501 :rtype: str """ return self._invoice_id @invoice_id.setter def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this CreditAccountRequest. - { \"description\" : \"Reference an invoice\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the invoice_id of this CreditAccountRequest. - :param invoice_id: The invoice_id of this CreditAccountRequest. + + :param invoice_id: The invoice_id of this CreditAccountRequest. # noqa: E501 :type: str """ @@ -182,34 +200,30 @@ def invoice_id(self, invoice_id): @property def description(self): - """ - Gets the description of this CreditAccountRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the description of this CreditAccountRequest. # noqa: E501 - :return: The description of this CreditAccountRequest. + + :return: The description of this CreditAccountRequest. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this CreditAccountRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the description of this CreditAccountRequest. - :param description: The description of this CreditAccountRequest. + + :param description: The description of this CreditAccountRequest. # noqa: E501 :type: str """ self._description = description def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -226,29 +240,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CreditAccountRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CreditAccountRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/credit_note.py b/billforward/models/credit_note.py index 4191184..778a89d 100644 --- a/billforward/models/credit_note.py +++ b/billforward/models/credit_note.py @@ -1,112 +1,145 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class CreditNote(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, invoice_id=None, subscription_id=None, organization_id=None, type=None, currency=None, description=None, value=None, remaining_value=None, created_by=None): - """ - CreditNote - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'account_id': 'str', - 'invoice_id': 'str', - 'subscription_id': 'str', - 'organization_id': 'str', - 'type': 'str', - 'currency': 'str', - 'description': 'str', - 'value': 'float', - 'remaining_value': 'float', - 'created_by': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'account_id': 'accountID', - 'invoice_id': 'invoiceID', - 'subscription_id': 'subscriptionID', - 'organization_id': 'organizationID', - 'type': 'type', - 'currency': 'currency', - 'description': 'description', - 'value': 'value', - 'remaining_value': 'remainingValue', - 'created_by': 'createdBy' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._account_id = account_id - self._invoice_id = invoice_id - self._subscription_id = subscription_id - self._organization_id = organization_id - self._type = type - self._currency = currency - self._description = description - self._value = value - self._remaining_value = remaining_value - self._created_by = created_by + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'account_id': 'str', + 'invoice_id': 'str', + 'subscription_id': 'str', + 'organization_id': 'str', + 'linked_credit_note_id': 'str', + 'type': 'str', + 'currency': 'CreditNoteCurrency', + 'description': 'str', + 'value': 'float', + 'nominal_value': 'float', + 'actual_value': 'float', + 'remaining_value': 'float', + 'expires': 'datetime', + 'created_by': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'account_id': 'accountID', + 'invoice_id': 'invoiceID', + 'subscription_id': 'subscriptionID', + 'organization_id': 'organizationID', + 'linked_credit_note_id': 'linkedCreditNoteID', + 'type': 'type', + 'currency': 'currency', + 'description': 'description', + 'value': 'value', + 'nominal_value': 'nominalValue', + 'actual_value': 'actualValue', + 'remaining_value': 'remainingValue', + 'expires': 'expires', + 'created_by': 'createdBy' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, invoice_id=None, subscription_id=None, organization_id=None, linked_credit_note_id=None, type=None, currency=None, description=None, value=None, nominal_value=None, actual_value=None, remaining_value=None, expires=None, created_by=None): # noqa: E501 + """CreditNote - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._account_id = None + self._invoice_id = None + self._subscription_id = None + self._organization_id = None + self._linked_credit_note_id = None + self._type = None + self._currency = None + self._description = None + self._value = None + self._nominal_value = None + self._actual_value = None + self._remaining_value = None + self._expires = None + self._created_by = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if account_id is not None: + self.account_id = account_id + if invoice_id is not None: + self.invoice_id = invoice_id + if subscription_id is not None: + self.subscription_id = subscription_id + if organization_id is not None: + self.organization_id = organization_id + if linked_credit_note_id is not None: + self.linked_credit_note_id = linked_credit_note_id + self.type = type + self.currency = currency + if description is not None: + self.description = description + if value is not None: + self.value = value + if nominal_value is not None: + self.nominal_value = nominal_value + if actual_value is not None: + self.actual_value = actual_value + self.remaining_value = remaining_value + if expires is not None: + self.expires = expires + if created_by is not None: + self.created_by = created_by @property def created(self): - """ - Gets the created of this CreditNote. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this CreditNote. # noqa: E501 - :return: The created of this CreditNote. + + :return: The created of this CreditNote. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this CreditNote. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this CreditNote. - :param created: The created of this CreditNote. + + :param created: The created of this CreditNote. # noqa: E501 :type: datetime """ @@ -114,22 +147,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this CreditNote. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this CreditNote. # noqa: E501 - :return: The changed_by of this CreditNote. + + :return: The changed_by of this CreditNote. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this CreditNote. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this CreditNote. - :param changed_by: The changed_by of this CreditNote. + + :param changed_by: The changed_by of this CreditNote. # noqa: E501 :type: str """ @@ -137,22 +168,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this CreditNote. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this CreditNote. # noqa: E501 - :return: The updated of this CreditNote. + + :return: The updated of this CreditNote. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this CreditNote. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this CreditNote. - :param updated: The updated of this CreditNote. + + :param updated: The updated of this CreditNote. # noqa: E501 :type: datetime """ @@ -160,22 +189,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this CreditNote. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the id of this CreditNote. # noqa: E501 - :return: The id of this CreditNote. + + :return: The id of this CreditNote. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this CreditNote. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the id of this CreditNote. + - :param id: The id of this CreditNote. + :param id: The id of this CreditNote. # noqa: E501 :type: str """ @@ -183,22 +210,20 @@ def id(self, id): @property def account_id(self): - """ - Gets the account_id of this CreditNote. - { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the account_id of this CreditNote. # noqa: E501 + - :return: The account_id of this CreditNote. + :return: The account_id of this CreditNote. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this CreditNote. - { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the account_id of this CreditNote. + - :param account_id: The account_id of this CreditNote. + :param account_id: The account_id of this CreditNote. # noqa: E501 :type: str """ @@ -206,22 +231,20 @@ def account_id(self, account_id): @property def invoice_id(self): - """ - Gets the invoice_id of this CreditNote. - { \"description\" : \"References an invoice from this credit note. This has no side-effects, such as limited scope of credit note.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the invoice_id of this CreditNote. # noqa: E501 + - :return: The invoice_id of this CreditNote. + :return: The invoice_id of this CreditNote. # noqa: E501 :rtype: str """ return self._invoice_id @invoice_id.setter def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this CreditNote. - { \"description\" : \"References an invoice from this credit note. This has no side-effects, such as limited scope of credit note.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the invoice_id of this CreditNote. + - :param invoice_id: The invoice_id of this CreditNote. + :param invoice_id: The invoice_id of this CreditNote. # noqa: E501 :type: str """ @@ -229,22 +252,20 @@ def invoice_id(self, invoice_id): @property def subscription_id(self): - """ - Gets the subscription_id of this CreditNote. - { \"description\" : \"Subscription to apply the credit note to. By default credit notes are owned by the account an can be used on any subscription. Providing this value limits the credit-note to only being used on the specified subscription.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the subscription_id of this CreditNote. # noqa: E501 - :return: The subscription_id of this CreditNote. + + :return: The subscription_id of this CreditNote. # noqa: E501 :rtype: str """ return self._subscription_id @subscription_id.setter def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this CreditNote. - { \"description\" : \"Subscription to apply the credit note to. By default credit notes are owned by the account an can be used on any subscription. Providing this value limits the credit-note to only being used on the specified subscription.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the subscription_id of this CreditNote. - :param subscription_id: The subscription_id of this CreditNote. + + :param subscription_id: The subscription_id of this CreditNote. # noqa: E501 :type: str """ @@ -252,51 +273,70 @@ def subscription_id(self, subscription_id): @property def organization_id(self): - """ - Gets the organization_id of this CreditNote. - { \"description\" : \"\", \"verbs\":[] } + """Gets the organization_id of this CreditNote. # noqa: E501 - :return: The organization_id of this CreditNote. + + :return: The organization_id of this CreditNote. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this CreditNote. - { \"description\" : \"\", \"verbs\":[] } + """Sets the organization_id of this CreditNote. - :param organization_id: The organization_id of this CreditNote. + + :param organization_id: The organization_id of this CreditNote. # noqa: E501 :type: str """ self._organization_id = organization_id @property - def type(self): + def linked_credit_note_id(self): + """Gets the linked_credit_note_id of this CreditNote. # noqa: E501 + + + :return: The linked_credit_note_id of this CreditNote. # noqa: E501 + :rtype: str """ - Gets the type of this CreditNote. - { \"description\" : \"\", \"verbs\":[] } + return self._linked_credit_note_id - :return: The type of this CreditNote. + @linked_credit_note_id.setter + def linked_credit_note_id(self, linked_credit_note_id): + """Sets the linked_credit_note_id of this CreditNote. + + + :param linked_credit_note_id: The linked_credit_note_id of this CreditNote. # noqa: E501 + :type: str + """ + + self._linked_credit_note_id = linked_credit_note_id + + @property + def type(self): + """Gets the type of this CreditNote. # noqa: E501 + + + :return: The type of this CreditNote. # noqa: E501 :rtype: str """ return self._type @type.setter def type(self, type): - """ - Sets the type of this CreditNote. - { \"description\" : \"\", \"verbs\":[] } + """Sets the type of this CreditNote. + - :param type: The type of this CreditNote. + :param type: The type of this CreditNote. # noqa: E501 :type: str """ - allowed_values = ["invoice", "manual"] + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + allowed_values = ["invoice", "manual"] # noqa: E501 if type not in allowed_values: raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 .format(type, allowed_values) ) @@ -304,45 +344,43 @@ def type(self, type): @property def currency(self): - """ - Gets the currency of this CreditNote. - { \"description\" : \"Currency of the credit-note specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the currency of this CreditNote. # noqa: E501 - :return: The currency of this CreditNote. - :rtype: str + + :return: The currency of this CreditNote. # noqa: E501 + :rtype: CreditNoteCurrency """ return self._currency @currency.setter def currency(self, currency): - """ - Sets the currency of this CreditNote. - { \"description\" : \"Currency of the credit-note specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the currency of this CreditNote. - :param currency: The currency of this CreditNote. - :type: str + + :param currency: The currency of this CreditNote. # noqa: E501 + :type: CreditNoteCurrency """ + if currency is None: + raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501 self._currency = currency @property def description(self): - """ - Gets the description of this CreditNote. - { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the description of this CreditNote. # noqa: E501 - :return: The description of this CreditNote. + + :return: The description of this CreditNote. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this CreditNote. - { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the description of this CreditNote. - :param description: The description of this CreditNote. + + :param description: The description of this CreditNote. # noqa: E501 :type: str """ @@ -350,80 +388,137 @@ def description(self, description): @property def value(self): - """ - Gets the value of this CreditNote. - { \"description\" : \" Monetary value of the credit-note\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the value of this CreditNote. # noqa: E501 + - :return: The value of this CreditNote. + :return: The value of this CreditNote. # noqa: E501 :rtype: float """ return self._value @value.setter def value(self, value): - """ - Sets the value of this CreditNote. - { \"description\" : \" Monetary value of the credit-note\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the value of this CreditNote. + - :param value: The value of this CreditNote. + :param value: The value of this CreditNote. # noqa: E501 :type: float """ self._value = value @property - def remaining_value(self): + def nominal_value(self): + """Gets the nominal_value of this CreditNote. # noqa: E501 + + + :return: The nominal_value of this CreditNote. # noqa: E501 + :rtype: float """ - Gets the remaining_value of this CreditNote. - { \"description\" : \"Remaining value of the payment not used. In the case when a credit-note is used across a range of invoices, each use reducing the available blance of the credit note.\", \"verbs\":[\"GET\"] } + return self._nominal_value - :return: The remaining_value of this CreditNote. + @nominal_value.setter + def nominal_value(self, nominal_value): + """Sets the nominal_value of this CreditNote. + + + :param nominal_value: The nominal_value of this CreditNote. # noqa: E501 + :type: float + """ + + self._nominal_value = nominal_value + + @property + def actual_value(self): + """Gets the actual_value of this CreditNote. # noqa: E501 + + + :return: The actual_value of this CreditNote. # noqa: E501 + :rtype: float + """ + return self._actual_value + + @actual_value.setter + def actual_value(self, actual_value): + """Sets the actual_value of this CreditNote. + + + :param actual_value: The actual_value of this CreditNote. # noqa: E501 + :type: float + """ + + self._actual_value = actual_value + + @property + def remaining_value(self): + """Gets the remaining_value of this CreditNote. # noqa: E501 + + + :return: The remaining_value of this CreditNote. # noqa: E501 :rtype: float """ return self._remaining_value @remaining_value.setter def remaining_value(self, remaining_value): - """ - Sets the remaining_value of this CreditNote. - { \"description\" : \"Remaining value of the payment not used. In the case when a credit-note is used across a range of invoices, each use reducing the available blance of the credit note.\", \"verbs\":[\"GET\"] } + """Sets the remaining_value of this CreditNote. + - :param remaining_value: The remaining_value of this CreditNote. + :param remaining_value: The remaining_value of this CreditNote. # noqa: E501 :type: float """ + if remaining_value is None: + raise ValueError("Invalid value for `remaining_value`, must not be `None`") # noqa: E501 self._remaining_value = remaining_value @property - def created_by(self): + def expires(self): + """Gets the expires of this CreditNote. # noqa: E501 + + + :return: The expires of this CreditNote. # noqa: E501 + :rtype: datetime + """ + return self._expires + + @expires.setter + def expires(self, expires): + """Sets the expires of this CreditNote. + + + :param expires: The expires of this CreditNote. # noqa: E501 + :type: datetime """ - Gets the created_by of this CreditNote. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - :return: The created_by of this CreditNote. + self._expires = expires + + @property + def created_by(self): + """Gets the created_by of this CreditNote. # noqa: E501 + + + :return: The created_by of this CreditNote. # noqa: E501 :rtype: str """ return self._created_by @created_by.setter def created_by(self, created_by): - """ - Sets the created_by of this CreditNote. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the created_by of this CreditNote. - :param created_by: The created_by of this CreditNote. + + :param created_by: The created_by of this CreditNote. # noqa: E501 :type: str """ self._created_by = created_by def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -440,29 +535,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CreditNote, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CreditNote): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/credit_note_currency.py b/billforward/models/credit_note_currency.py new file mode 100644 index 0000000..fc0d581 --- /dev/null +++ b/billforward/models/credit_note_currency.py @@ -0,0 +1,240 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class CreditNoteCurrency(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'currency_code': 'str', + 'default_fraction_digits': 'int', + 'numeric_code': 'int', + 'display_name': 'str', + 'symbol': 'str', + 'numeric_code_as_string': 'str' + } + + attribute_map = { + 'currency_code': 'currencyCode', + 'default_fraction_digits': 'defaultFractionDigits', + 'numeric_code': 'numericCode', + 'display_name': 'displayName', + 'symbol': 'symbol', + 'numeric_code_as_string': 'numericCodeAsString' + } + + def __init__(self, currency_code=None, default_fraction_digits=None, numeric_code=None, display_name=None, symbol=None, numeric_code_as_string=None): # noqa: E501 + """CreditNoteCurrency - a model defined in Swagger""" # noqa: E501 + self._currency_code = None + self._default_fraction_digits = None + self._numeric_code = None + self._display_name = None + self._symbol = None + self._numeric_code_as_string = None + self.discriminator = None + if currency_code is not None: + self.currency_code = currency_code + if default_fraction_digits is not None: + self.default_fraction_digits = default_fraction_digits + if numeric_code is not None: + self.numeric_code = numeric_code + if display_name is not None: + self.display_name = display_name + if symbol is not None: + self.symbol = symbol + if numeric_code_as_string is not None: + self.numeric_code_as_string = numeric_code_as_string + + @property + def currency_code(self): + """Gets the currency_code of this CreditNoteCurrency. # noqa: E501 + + + :return: The currency_code of this CreditNoteCurrency. # noqa: E501 + :rtype: str + """ + return self._currency_code + + @currency_code.setter + def currency_code(self, currency_code): + """Sets the currency_code of this CreditNoteCurrency. + + + :param currency_code: The currency_code of this CreditNoteCurrency. # noqa: E501 + :type: str + """ + + self._currency_code = currency_code + + @property + def default_fraction_digits(self): + """Gets the default_fraction_digits of this CreditNoteCurrency. # noqa: E501 + + + :return: The default_fraction_digits of this CreditNoteCurrency. # noqa: E501 + :rtype: int + """ + return self._default_fraction_digits + + @default_fraction_digits.setter + def default_fraction_digits(self, default_fraction_digits): + """Sets the default_fraction_digits of this CreditNoteCurrency. + + + :param default_fraction_digits: The default_fraction_digits of this CreditNoteCurrency. # noqa: E501 + :type: int + """ + + self._default_fraction_digits = default_fraction_digits + + @property + def numeric_code(self): + """Gets the numeric_code of this CreditNoteCurrency. # noqa: E501 + + + :return: The numeric_code of this CreditNoteCurrency. # noqa: E501 + :rtype: int + """ + return self._numeric_code + + @numeric_code.setter + def numeric_code(self, numeric_code): + """Sets the numeric_code of this CreditNoteCurrency. + + + :param numeric_code: The numeric_code of this CreditNoteCurrency. # noqa: E501 + :type: int + """ + + self._numeric_code = numeric_code + + @property + def display_name(self): + """Gets the display_name of this CreditNoteCurrency. # noqa: E501 + + + :return: The display_name of this CreditNoteCurrency. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this CreditNoteCurrency. + + + :param display_name: The display_name of this CreditNoteCurrency. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def symbol(self): + """Gets the symbol of this CreditNoteCurrency. # noqa: E501 + + + :return: The symbol of this CreditNoteCurrency. # noqa: E501 + :rtype: str + """ + return self._symbol + + @symbol.setter + def symbol(self, symbol): + """Sets the symbol of this CreditNoteCurrency. + + + :param symbol: The symbol of this CreditNoteCurrency. # noqa: E501 + :type: str + """ + + self._symbol = symbol + + @property + def numeric_code_as_string(self): + """Gets the numeric_code_as_string of this CreditNoteCurrency. # noqa: E501 + + + :return: The numeric_code_as_string of this CreditNoteCurrency. # noqa: E501 + :rtype: str + """ + return self._numeric_code_as_string + + @numeric_code_as_string.setter + def numeric_code_as_string(self, numeric_code_as_string): + """Sets the numeric_code_as_string of this CreditNoteCurrency. + + + :param numeric_code_as_string: The numeric_code_as_string of this CreditNoteCurrency. # noqa: E501 + :type: str + """ + + self._numeric_code_as_string = numeric_code_as_string + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreditNoteCurrency, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreditNoteCurrency): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/credit_note_paged_metadata.py b/billforward/models/credit_note_paged_metadata.py deleted file mode 100644 index d34785e..0000000 --- a/billforward/models/credit_note_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CreditNotePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - CreditNotePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[CreditNote]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this CreditNotePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this CreditNotePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this CreditNotePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this CreditNotePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this CreditNotePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this CreditNotePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this CreditNotePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this CreditNotePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this CreditNotePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this CreditNotePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this CreditNotePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this CreditNotePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this CreditNotePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this CreditNotePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this CreditNotePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this CreditNotePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this CreditNotePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this CreditNotePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this CreditNotePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this CreditNotePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this CreditNotePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this CreditNotePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this CreditNotePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this CreditNotePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this CreditNotePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this CreditNotePagedMetadata. - :rtype: list[CreditNote] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this CreditNotePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this CreditNotePagedMetadata. - :type: list[CreditNote] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/credit_note_payment.py b/billforward/models/credit_note_payment.py new file mode 100644 index 0000000..739c2e5 --- /dev/null +++ b/billforward/models/credit_note_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class CreditNotePayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """CreditNotePayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CreditNotePayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CreditNotePayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/credit_subscription_request.py b/billforward/models/credit_subscription_request.py index edc7a9b..e9d760e 100644 --- a/billforward/models/credit_subscription_request.py +++ b/billforward/models/credit_subscription_request.py @@ -1,85 +1,88 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class CreditSubscriptionRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, organization_id=None, value=None, invoice_id=None, description=None): - """ - CreditSubscriptionRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'organization_id': 'str', - 'value': 'float', - 'invoice_id': 'str', - 'description': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'organization_id': 'organizationID', - 'value': 'value', - 'invoice_id': 'invoiceID', - 'description': 'description' - } - - self._created = created - self._organization_id = organization_id - self._value = value - self._invoice_id = invoice_id - self._description = description + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'value': 'float', + 'expires': 'datetime', + 'invoice_id': 'str', + 'description': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'value': 'value', + 'expires': 'expires', + 'invoice_id': 'invoiceID', + 'description': 'description' + } + + def __init__(self, created=None, organization_id=None, value=None, expires=None, invoice_id=None, description=None): # noqa: E501 + """CreditSubscriptionRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._value = None + self._expires = None + self._invoice_id = None + self._description = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if value is not None: + self.value = value + if expires is not None: + self.expires = expires + if invoice_id is not None: + self.invoice_id = invoice_id + if description is not None: + self.description = description @property def created(self): - """ - Gets the created of this CreditSubscriptionRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this CreditSubscriptionRequest. # noqa: E501 - :return: The created of this CreditSubscriptionRequest. + + :return: The created of this CreditSubscriptionRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this CreditSubscriptionRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this CreditSubscriptionRequest. - :param created: The created of this CreditSubscriptionRequest. + + :param created: The created of this CreditSubscriptionRequest. # noqa: E501 :type: datetime """ @@ -87,22 +90,20 @@ def created(self, created): @property def organization_id(self): - """ - Gets the organization_id of this CreditSubscriptionRequest. - { \"description\" : \"\", \"verbs\":[] } + """Gets the organization_id of this CreditSubscriptionRequest. # noqa: E501 - :return: The organization_id of this CreditSubscriptionRequest. + + :return: The organization_id of this CreditSubscriptionRequest. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this CreditSubscriptionRequest. - { \"description\" : \"\", \"verbs\":[] } + """Sets the organization_id of this CreditSubscriptionRequest. - :param organization_id: The organization_id of this CreditSubscriptionRequest. + + :param organization_id: The organization_id of this CreditSubscriptionRequest. # noqa: E501 :type: str """ @@ -110,45 +111,62 @@ def organization_id(self, organization_id): @property def value(self): - """ - Gets the value of this CreditSubscriptionRequest. - { \"description\" : \" Monetary value of the credit-note\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the value of this CreditSubscriptionRequest. # noqa: E501 - :return: The value of this CreditSubscriptionRequest. + + :return: The value of this CreditSubscriptionRequest. # noqa: E501 :rtype: float """ return self._value @value.setter def value(self, value): - """ - Sets the value of this CreditSubscriptionRequest. - { \"description\" : \" Monetary value of the credit-note\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the value of this CreditSubscriptionRequest. - :param value: The value of this CreditSubscriptionRequest. + + :param value: The value of this CreditSubscriptionRequest. # noqa: E501 :type: float """ self._value = value @property - def invoice_id(self): + def expires(self): + """Gets the expires of this CreditSubscriptionRequest. # noqa: E501 + + + :return: The expires of this CreditSubscriptionRequest. # noqa: E501 + :rtype: datetime + """ + return self._expires + + @expires.setter + def expires(self, expires): + """Sets the expires of this CreditSubscriptionRequest. + + + :param expires: The expires of this CreditSubscriptionRequest. # noqa: E501 + :type: datetime """ - Gets the invoice_id of this CreditSubscriptionRequest. - { \"description\" : \"Reference an invoice\", \"verbs\":[\"POST\",\"GET\"] } - :return: The invoice_id of this CreditSubscriptionRequest. + self._expires = expires + + @property + def invoice_id(self): + """Gets the invoice_id of this CreditSubscriptionRequest. # noqa: E501 + + + :return: The invoice_id of this CreditSubscriptionRequest. # noqa: E501 :rtype: str """ return self._invoice_id @invoice_id.setter def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this CreditSubscriptionRequest. - { \"description\" : \"Reference an invoice\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the invoice_id of this CreditSubscriptionRequest. + - :param invoice_id: The invoice_id of this CreditSubscriptionRequest. + :param invoice_id: The invoice_id of this CreditSubscriptionRequest. # noqa: E501 :type: str """ @@ -156,34 +174,30 @@ def invoice_id(self, invoice_id): @property def description(self): - """ - Gets the description of this CreditSubscriptionRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the description of this CreditSubscriptionRequest. # noqa: E501 - :return: The description of this CreditSubscriptionRequest. + + :return: The description of this CreditSubscriptionRequest. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this CreditSubscriptionRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the description of this CreditSubscriptionRequest. - :param description: The description of this CreditSubscriptionRequest. + + :param description: The description of this CreditSubscriptionRequest. # noqa: E501 :type: str """ self._description = description def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -200,29 +214,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(CreditSubscriptionRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, CreditSubscriptionRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/cybersource_configuration.py b/billforward/models/cybersource_configuration.py new file mode 100644 index 0000000..3ee925d --- /dev/null +++ b/billforward/models/cybersource_configuration.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class CybersourceConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'key_filename': 'str' + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + 'key_filename': 'keyFilename' + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, key_filename=None, *args, **kwargs): # noqa: E501 + """CybersourceConfiguration - a model defined in Swagger""" # noqa: E501 + self._key_filename = None + self.discriminator = None + if key_filename is not None: + self.key_filename = key_filename + APIConfiguration.__init__(self, *args, **kwargs) + + @property + def key_filename(self): + """Gets the key_filename of this CybersourceConfiguration. # noqa: E501 + + + :return: The key_filename of this CybersourceConfiguration. # noqa: E501 + :rtype: str + """ + return self._key_filename + + @key_filename.setter + def key_filename(self, key_filename): + """Sets the key_filename of this CybersourceConfiguration. + + + :param key_filename: The key_filename of this CybersourceConfiguration. # noqa: E501 + :type: str + """ + + self._key_filename = key_filename + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CybersourceConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CybersourceConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/cybersource_payment.py b/billforward/models/cybersource_payment.py new file mode 100644 index 0000000..f3940e4 --- /dev/null +++ b/billforward/models/cybersource_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class CybersourcePayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """CybersourcePayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(CybersourcePayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, CybersourcePayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/cybersource_token_paged_metadata.py b/billforward/models/cybersource_token_paged_metadata.py deleted file mode 100644 index 47a1df1..0000000 --- a/billforward/models/cybersource_token_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class CybersourceTokenPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - CybersourceTokenPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this CybersourceTokenPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this CybersourceTokenPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this CybersourceTokenPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this CybersourceTokenPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this CybersourceTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this CybersourceTokenPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this CybersourceTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this CybersourceTokenPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this CybersourceTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this CybersourceTokenPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this CybersourceTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this CybersourceTokenPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this CybersourceTokenPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this CybersourceTokenPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this CybersourceTokenPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this CybersourceTokenPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this CybersourceTokenPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this CybersourceTokenPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this CybersourceTokenPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this CybersourceTokenPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this CybersourceTokenPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this CybersourceTokenPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this CybersourceTokenPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this CybersourceTokenPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this CybersourceTokenPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this CybersourceTokenPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this CybersourceTokenPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this CybersourceTokenPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/data_sync_job_error_response.py b/billforward/models/data_sync_job_error_response.py new file mode 100644 index 0000000..aabf7c4 --- /dev/null +++ b/billforward/models/data_sync_job_error_response.py @@ -0,0 +1,272 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class DataSyncJobErrorResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'record_type': 'str', + 'record_id': 'str', + 'description': 'str', + 'raw_internal_error': 'str', + 'encountered': 'datetime', + 'run_number': 'int' + } + + attribute_map = { + 'id': 'id', + 'record_type': 'recordType', + 'record_id': 'recordId', + 'description': 'description', + 'raw_internal_error': 'rawInternalError', + 'encountered': 'encountered', + 'run_number': 'runNumber' + } + + def __init__(self, id=None, record_type=None, record_id=None, description=None, raw_internal_error=None, encountered=None, run_number=None): # noqa: E501 + """DataSyncJobErrorResponse - a model defined in Swagger""" # noqa: E501 + self._id = None + self._record_type = None + self._record_id = None + self._description = None + self._raw_internal_error = None + self._encountered = None + self._run_number = None + self.discriminator = None + if id is not None: + self.id = id + if record_type is not None: + self.record_type = record_type + if record_id is not None: + self.record_id = record_id + if description is not None: + self.description = description + if raw_internal_error is not None: + self.raw_internal_error = raw_internal_error + if encountered is not None: + self.encountered = encountered + if run_number is not None: + self.run_number = run_number + + @property + def id(self): + """Gets the id of this DataSyncJobErrorResponse. # noqa: E501 + + + :return: The id of this DataSyncJobErrorResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this DataSyncJobErrorResponse. + + + :param id: The id of this DataSyncJobErrorResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def record_type(self): + """Gets the record_type of this DataSyncJobErrorResponse. # noqa: E501 + + + :return: The record_type of this DataSyncJobErrorResponse. # noqa: E501 + :rtype: str + """ + return self._record_type + + @record_type.setter + def record_type(self, record_type): + """Sets the record_type of this DataSyncJobErrorResponse. + + + :param record_type: The record_type of this DataSyncJobErrorResponse. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if record_type not in allowed_values: + raise ValueError( + "Invalid value for `record_type` ({0}), must be one of {1}" # noqa: E501 + .format(record_type, allowed_values) + ) + + self._record_type = record_type + + @property + def record_id(self): + """Gets the record_id of this DataSyncJobErrorResponse. # noqa: E501 + + + :return: The record_id of this DataSyncJobErrorResponse. # noqa: E501 + :rtype: str + """ + return self._record_id + + @record_id.setter + def record_id(self, record_id): + """Sets the record_id of this DataSyncJobErrorResponse. + + + :param record_id: The record_id of this DataSyncJobErrorResponse. # noqa: E501 + :type: str + """ + + self._record_id = record_id + + @property + def description(self): + """Gets the description of this DataSyncJobErrorResponse. # noqa: E501 + + + :return: The description of this DataSyncJobErrorResponse. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this DataSyncJobErrorResponse. + + + :param description: The description of this DataSyncJobErrorResponse. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def raw_internal_error(self): + """Gets the raw_internal_error of this DataSyncJobErrorResponse. # noqa: E501 + + + :return: The raw_internal_error of this DataSyncJobErrorResponse. # noqa: E501 + :rtype: str + """ + return self._raw_internal_error + + @raw_internal_error.setter + def raw_internal_error(self, raw_internal_error): + """Sets the raw_internal_error of this DataSyncJobErrorResponse. + + + :param raw_internal_error: The raw_internal_error of this DataSyncJobErrorResponse. # noqa: E501 + :type: str + """ + + self._raw_internal_error = raw_internal_error + + @property + def encountered(self): + """Gets the encountered of this DataSyncJobErrorResponse. # noqa: E501 + + + :return: The encountered of this DataSyncJobErrorResponse. # noqa: E501 + :rtype: datetime + """ + return self._encountered + + @encountered.setter + def encountered(self, encountered): + """Sets the encountered of this DataSyncJobErrorResponse. + + + :param encountered: The encountered of this DataSyncJobErrorResponse. # noqa: E501 + :type: datetime + """ + + self._encountered = encountered + + @property + def run_number(self): + """Gets the run_number of this DataSyncJobErrorResponse. # noqa: E501 + + + :return: The run_number of this DataSyncJobErrorResponse. # noqa: E501 + :rtype: int + """ + return self._run_number + + @run_number.setter + def run_number(self, run_number): + """Sets the run_number of this DataSyncJobErrorResponse. + + + :param run_number: The run_number of this DataSyncJobErrorResponse. # noqa: E501 + :type: int + """ + + self._run_number = run_number + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(DataSyncJobErrorResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, DataSyncJobErrorResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/data_sync_job_response.py b/billforward/models/data_sync_job_response.py new file mode 100644 index 0000000..2db6b88 --- /dev/null +++ b/billforward/models/data_sync_job_response.py @@ -0,0 +1,628 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class DataSyncJobResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'id': 'str', + 'config_id': 'str', + 'state': 'str', + 'type': 'str', + 'scope': 'str', + 'target': 'str', + 'name': 'str', + 'description': 'str', + 'data_from': 'datetime', + 'data_till': 'datetime', + 'started': 'datetime', + 'stopped': 'datetime', + 'created_by': 'str', + 'max_retry_times': 'int', + 'retry_attempted': 'int', + 'deleted': 'bool', + 'latest_run_number': 'int', + 'errors': 'list[DataSyncJobErrorResponse]' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'id': 'id', + 'config_id': 'configID', + 'state': 'state', + 'type': 'type', + 'scope': 'scope', + 'target': 'target', + 'name': 'name', + 'description': 'description', + 'data_from': 'dataFrom', + 'data_till': 'dataTill', + 'started': 'started', + 'stopped': 'stopped', + 'created_by': 'createdBy', + 'max_retry_times': 'maxRetryTimes', + 'retry_attempted': 'retryAttempted', + 'deleted': 'deleted', + 'latest_run_number': 'latestRunNumber', + 'errors': 'errors' + } + + def __init__(self, created=None, organization_id=None, id=None, config_id=None, state=None, type=None, scope=None, target=None, name=None, description=None, data_from=None, data_till=None, started=None, stopped=None, created_by=None, max_retry_times=None, retry_attempted=None, deleted=None, latest_run_number=None, errors=None): # noqa: E501 + """DataSyncJobResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._id = None + self._config_id = None + self._state = None + self._type = None + self._scope = None + self._target = None + self._name = None + self._description = None + self._data_from = None + self._data_till = None + self._started = None + self._stopped = None + self._created_by = None + self._max_retry_times = None + self._retry_attempted = None + self._deleted = None + self._latest_run_number = None + self._errors = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if id is not None: + self.id = id + if config_id is not None: + self.config_id = config_id + if state is not None: + self.state = state + if type is not None: + self.type = type + if scope is not None: + self.scope = scope + if target is not None: + self.target = target + if name is not None: + self.name = name + if description is not None: + self.description = description + if data_from is not None: + self.data_from = data_from + if data_till is not None: + self.data_till = data_till + if started is not None: + self.started = started + if stopped is not None: + self.stopped = stopped + if created_by is not None: + self.created_by = created_by + if max_retry_times is not None: + self.max_retry_times = max_retry_times + if retry_attempted is not None: + self.retry_attempted = retry_attempted + if deleted is not None: + self.deleted = deleted + if latest_run_number is not None: + self.latest_run_number = latest_run_number + if errors is not None: + self.errors = errors + + @property + def created(self): + """Gets the created of this DataSyncJobResponse. # noqa: E501 + + + :return: The created of this DataSyncJobResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this DataSyncJobResponse. + + + :param created: The created of this DataSyncJobResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this DataSyncJobResponse. # noqa: E501 + + + :return: The organization_id of this DataSyncJobResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this DataSyncJobResponse. + + + :param organization_id: The organization_id of this DataSyncJobResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def id(self): + """Gets the id of this DataSyncJobResponse. # noqa: E501 + + + :return: The id of this DataSyncJobResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this DataSyncJobResponse. + + + :param id: The id of this DataSyncJobResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def config_id(self): + """Gets the config_id of this DataSyncJobResponse. # noqa: E501 + + + :return: The config_id of this DataSyncJobResponse. # noqa: E501 + :rtype: str + """ + return self._config_id + + @config_id.setter + def config_id(self, config_id): + """Sets the config_id of this DataSyncJobResponse. + + + :param config_id: The config_id of this DataSyncJobResponse. # noqa: E501 + :type: str + """ + + self._config_id = config_id + + @property + def state(self): + """Gets the state of this DataSyncJobResponse. # noqa: E501 + + + :return: The state of this DataSyncJobResponse. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this DataSyncJobResponse. + + + :param state: The state of this DataSyncJobResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Pending", "Complete", "Failed", "Cancelled", "Processing"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def type(self): + """Gets the type of this DataSyncJobResponse. # noqa: E501 + + + :return: The type of this DataSyncJobResponse. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this DataSyncJobResponse. + + + :param type: The type of this DataSyncJobResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Incremental", "Full"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def scope(self): + """Gets the scope of this DataSyncJobResponse. # noqa: E501 + + + :return: The scope of this DataSyncJobResponse. # noqa: E501 + :rtype: str + """ + return self._scope + + @scope.setter + def scope(self, scope): + """Sets the scope of this DataSyncJobResponse. + + + :param scope: The scope of this DataSyncJobResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Manual", "Scheduled"] # noqa: E501 + if scope not in allowed_values: + raise ValueError( + "Invalid value for `scope` ({0}), must be one of {1}" # noqa: E501 + .format(scope, allowed_values) + ) + + self._scope = scope + + @property + def target(self): + """Gets the target of this DataSyncJobResponse. # noqa: E501 + + + :return: The target of this DataSyncJobResponse. # noqa: E501 + :rtype: str + """ + return self._target + + @target.setter + def target(self, target): + """Sets the target of this DataSyncJobResponse. + + + :param target: The target of this DataSyncJobResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Salesforce", "Quickbooks"] # noqa: E501 + if target not in allowed_values: + raise ValueError( + "Invalid value for `target` ({0}), must be one of {1}" # noqa: E501 + .format(target, allowed_values) + ) + + self._target = target + + @property + def name(self): + """Gets the name of this DataSyncJobResponse. # noqa: E501 + + + :return: The name of this DataSyncJobResponse. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this DataSyncJobResponse. + + + :param name: The name of this DataSyncJobResponse. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this DataSyncJobResponse. # noqa: E501 + + + :return: The description of this DataSyncJobResponse. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this DataSyncJobResponse. + + + :param description: The description of this DataSyncJobResponse. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def data_from(self): + """Gets the data_from of this DataSyncJobResponse. # noqa: E501 + + + :return: The data_from of this DataSyncJobResponse. # noqa: E501 + :rtype: datetime + """ + return self._data_from + + @data_from.setter + def data_from(self, data_from): + """Sets the data_from of this DataSyncJobResponse. + + + :param data_from: The data_from of this DataSyncJobResponse. # noqa: E501 + :type: datetime + """ + + self._data_from = data_from + + @property + def data_till(self): + """Gets the data_till of this DataSyncJobResponse. # noqa: E501 + + + :return: The data_till of this DataSyncJobResponse. # noqa: E501 + :rtype: datetime + """ + return self._data_till + + @data_till.setter + def data_till(self, data_till): + """Sets the data_till of this DataSyncJobResponse. + + + :param data_till: The data_till of this DataSyncJobResponse. # noqa: E501 + :type: datetime + """ + + self._data_till = data_till + + @property + def started(self): + """Gets the started of this DataSyncJobResponse. # noqa: E501 + + + :return: The started of this DataSyncJobResponse. # noqa: E501 + :rtype: datetime + """ + return self._started + + @started.setter + def started(self, started): + """Sets the started of this DataSyncJobResponse. + + + :param started: The started of this DataSyncJobResponse. # noqa: E501 + :type: datetime + """ + + self._started = started + + @property + def stopped(self): + """Gets the stopped of this DataSyncJobResponse. # noqa: E501 + + + :return: The stopped of this DataSyncJobResponse. # noqa: E501 + :rtype: datetime + """ + return self._stopped + + @stopped.setter + def stopped(self, stopped): + """Sets the stopped of this DataSyncJobResponse. + + + :param stopped: The stopped of this DataSyncJobResponse. # noqa: E501 + :type: datetime + """ + + self._stopped = stopped + + @property + def created_by(self): + """Gets the created_by of this DataSyncJobResponse. # noqa: E501 + + + :return: The created_by of this DataSyncJobResponse. # noqa: E501 + :rtype: str + """ + return self._created_by + + @created_by.setter + def created_by(self, created_by): + """Sets the created_by of this DataSyncJobResponse. + + + :param created_by: The created_by of this DataSyncJobResponse. # noqa: E501 + :type: str + """ + + self._created_by = created_by + + @property + def max_retry_times(self): + """Gets the max_retry_times of this DataSyncJobResponse. # noqa: E501 + + + :return: The max_retry_times of this DataSyncJobResponse. # noqa: E501 + :rtype: int + """ + return self._max_retry_times + + @max_retry_times.setter + def max_retry_times(self, max_retry_times): + """Sets the max_retry_times of this DataSyncJobResponse. + + + :param max_retry_times: The max_retry_times of this DataSyncJobResponse. # noqa: E501 + :type: int + """ + + self._max_retry_times = max_retry_times + + @property + def retry_attempted(self): + """Gets the retry_attempted of this DataSyncJobResponse. # noqa: E501 + + + :return: The retry_attempted of this DataSyncJobResponse. # noqa: E501 + :rtype: int + """ + return self._retry_attempted + + @retry_attempted.setter + def retry_attempted(self, retry_attempted): + """Sets the retry_attempted of this DataSyncJobResponse. + + + :param retry_attempted: The retry_attempted of this DataSyncJobResponse. # noqa: E501 + :type: int + """ + + self._retry_attempted = retry_attempted + + @property + def deleted(self): + """Gets the deleted of this DataSyncJobResponse. # noqa: E501 + + + :return: The deleted of this DataSyncJobResponse. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this DataSyncJobResponse. + + + :param deleted: The deleted of this DataSyncJobResponse. # noqa: E501 + :type: bool + """ + + self._deleted = deleted + + @property + def latest_run_number(self): + """Gets the latest_run_number of this DataSyncJobResponse. # noqa: E501 + + + :return: The latest_run_number of this DataSyncJobResponse. # noqa: E501 + :rtype: int + """ + return self._latest_run_number + + @latest_run_number.setter + def latest_run_number(self, latest_run_number): + """Sets the latest_run_number of this DataSyncJobResponse. + + + :param latest_run_number: The latest_run_number of this DataSyncJobResponse. # noqa: E501 + :type: int + """ + + self._latest_run_number = latest_run_number + + @property + def errors(self): + """Gets the errors of this DataSyncJobResponse. # noqa: E501 + + + :return: The errors of this DataSyncJobResponse. # noqa: E501 + :rtype: list[DataSyncJobErrorResponse] + """ + return self._errors + + @errors.setter + def errors(self, errors): + """Sets the errors of this DataSyncJobResponse. + + + :param errors: The errors of this DataSyncJobResponse. # noqa: E501 + :type: list[DataSyncJobErrorResponse] + """ + + self._errors = errors + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(DataSyncJobResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, DataSyncJobResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/data_synchronisation_app_configuration_paged_metadata.py b/billforward/models/data_synchronisation_app_configuration_paged_metadata.py deleted file mode 100644 index c03f547..0000000 --- a/billforward/models/data_synchronisation_app_configuration_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class DataSynchronisationAppConfigurationPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - DataSynchronisationAppConfigurationPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this DataSynchronisationAppConfigurationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this DataSynchronisationAppConfigurationPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this DataSynchronisationAppConfigurationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this DataSynchronisationAppConfigurationPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this DataSynchronisationAppConfigurationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this DataSynchronisationAppConfigurationPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this DataSynchronisationAppConfigurationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this DataSynchronisationAppConfigurationPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this DataSynchronisationAppConfigurationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this DataSynchronisationAppConfigurationPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this DataSynchronisationAppConfigurationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this DataSynchronisationAppConfigurationPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this DataSynchronisationAppConfigurationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this DataSynchronisationAppConfigurationPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this DataSynchronisationAppConfigurationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this DataSynchronisationAppConfigurationPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this DataSynchronisationAppConfigurationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this DataSynchronisationAppConfigurationPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this DataSynchronisationAppConfigurationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this DataSynchronisationAppConfigurationPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this DataSynchronisationAppConfigurationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this DataSynchronisationAppConfigurationPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this DataSynchronisationAppConfigurationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this DataSynchronisationAppConfigurationPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this DataSynchronisationAppConfigurationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this DataSynchronisationAppConfigurationPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this DataSynchronisationAppConfigurationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this DataSynchronisationAppConfigurationPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/data_synchronisation_configuration.py b/billforward/models/data_synchronisation_configuration.py deleted file mode 100644 index d3f22e2..0000000 --- a/billforward/models/data_synchronisation_configuration.py +++ /dev/null @@ -1,442 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class DataSynchronisationConfiguration(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, username=None, access_token=None, refresh_token=None, instance_url=None, platform=None, max_failed_retry=None, synch_interval=None, deleted=False): - """ - DataSynchronisationConfiguration - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'username': 'str', - 'access_token': 'str', - 'refresh_token': 'str', - 'instance_url': 'str', - 'platform': 'str', - 'max_failed_retry': 'int', - 'synch_interval': 'int', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'username': 'username', - 'access_token': 'accessToken', - 'refresh_token': 'refreshToken', - 'instance_url': 'instanceUrl', - 'platform': 'platform', - 'max_failed_retry': 'maxFailedRetry', - 'synch_interval': 'synchInterval', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._username = username - self._access_token = access_token - self._refresh_token = refresh_token - self._instance_url = instance_url - self._platform = platform - self._max_failed_retry = max_failed_retry - self._synch_interval = synch_interval - self._deleted = deleted - - @property - def created(self): - """ - Gets the created of this DataSynchronisationConfiguration. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this DataSynchronisationConfiguration. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this DataSynchronisationConfiguration. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this DataSynchronisationConfiguration. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this DataSynchronisationConfiguration. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this DataSynchronisationConfiguration. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this DataSynchronisationConfiguration. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this DataSynchronisationConfiguration. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this DataSynchronisationConfiguration. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this DataSynchronisationConfiguration. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this DataSynchronisationConfiguration. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this DataSynchronisationConfiguration. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this DataSynchronisationConfiguration. - ID of the Synchronization Configuration. - - :return: The id of this DataSynchronisationConfiguration. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this DataSynchronisationConfiguration. - ID of the Synchronization Configuration. - - :param id: The id of this DataSynchronisationConfiguration. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this DataSynchronisationConfiguration. - Organization associated with Synchronization Configuration. - - :return: The organization_id of this DataSynchronisationConfiguration. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this DataSynchronisationConfiguration. - Organization associated with Synchronization Configuration. - - :param organization_id: The organization_id of this DataSynchronisationConfiguration. - :type: str - """ - - self._organization_id = organization_id - - @property - def username(self): - """ - Gets the username of this DataSynchronisationConfiguration. - This is the username for the platform. - - :return: The username of this DataSynchronisationConfiguration. - :rtype: str - """ - return self._username - - @username.setter - def username(self, username): - """ - Sets the username of this DataSynchronisationConfiguration. - This is the username for the platform. - - :param username: The username of this DataSynchronisationConfiguration. - :type: str - """ - - self._username = username - - @property - def access_token(self): - """ - Gets the access_token of this DataSynchronisationConfiguration. - This is the token for the platform. - - :return: The access_token of this DataSynchronisationConfiguration. - :rtype: str - """ - return self._access_token - - @access_token.setter - def access_token(self, access_token): - """ - Sets the access_token of this DataSynchronisationConfiguration. - This is the token for the platform. - - :param access_token: The access_token of this DataSynchronisationConfiguration. - :type: str - """ - - self._access_token = access_token - - @property - def refresh_token(self): - """ - Gets the refresh_token of this DataSynchronisationConfiguration. - This is the refresh token for the platform. - - :return: The refresh_token of this DataSynchronisationConfiguration. - :rtype: str - """ - return self._refresh_token - - @refresh_token.setter - def refresh_token(self, refresh_token): - """ - Sets the refresh_token of this DataSynchronisationConfiguration. - This is the refresh token for the platform. - - :param refresh_token: The refresh_token of this DataSynchronisationConfiguration. - :type: str - """ - - self._refresh_token = refresh_token - - @property - def instance_url(self): - """ - Gets the instance_url of this DataSynchronisationConfiguration. - This is the instance url for client's salesforce instance. - - :return: The instance_url of this DataSynchronisationConfiguration. - :rtype: str - """ - return self._instance_url - - @instance_url.setter - def instance_url(self, instance_url): - """ - Sets the instance_url of this DataSynchronisationConfiguration. - This is the instance url for client's salesforce instance. - - :param instance_url: The instance_url of this DataSynchronisationConfiguration. - :type: str - """ - - self._instance_url = instance_url - - @property - def platform(self): - """ - Gets the platform of this DataSynchronisationConfiguration. - This is the platform of the job. - - :return: The platform of this DataSynchronisationConfiguration. - :rtype: str - """ - return self._platform - - @platform.setter - def platform(self, platform): - """ - Sets the platform of this DataSynchronisationConfiguration. - This is the platform of the job. - - :param platform: The platform of this DataSynchronisationConfiguration. - :type: str - """ - allowed_values = ["Salesforce"] - if platform not in allowed_values: - raise ValueError( - "Invalid value for `platform` ({0}), must be one of {1}" - .format(platform, allowed_values) - ) - - self._platform = platform - - @property - def max_failed_retry(self): - """ - Gets the max_failed_retry of this DataSynchronisationConfiguration. - This is maximum of the retry attempts when a synch is failed. - - :return: The max_failed_retry of this DataSynchronisationConfiguration. - :rtype: int - """ - return self._max_failed_retry - - @max_failed_retry.setter - def max_failed_retry(self, max_failed_retry): - """ - Sets the max_failed_retry of this DataSynchronisationConfiguration. - This is maximum of the retry attempts when a synch is failed. - - :param max_failed_retry: The max_failed_retry of this DataSynchronisationConfiguration. - :type: int - """ - - self._max_failed_retry = max_failed_retry - - @property - def synch_interval(self): - """ - Gets the synch_interval of this DataSynchronisationConfiguration. - This is interval between each sync. - - :return: The synch_interval of this DataSynchronisationConfiguration. - :rtype: int - """ - return self._synch_interval - - @synch_interval.setter - def synch_interval(self, synch_interval): - """ - Sets the synch_interval of this DataSynchronisationConfiguration. - This is interval between each sync. - - :param synch_interval: The synch_interval of this DataSynchronisationConfiguration. - :type: int - """ - - self._synch_interval = synch_interval - - @property - def deleted(self): - """ - Gets the deleted of this DataSynchronisationConfiguration. - Is the sync job deleted. - - :return: The deleted of this DataSynchronisationConfiguration. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this DataSynchronisationConfiguration. - Is the sync job deleted. - - :param deleted: The deleted of this DataSynchronisationConfiguration. - :type: bool - """ - - self._deleted = deleted - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/data_synchronisation_configuration_paged_metadata.py b/billforward/models/data_synchronisation_configuration_paged_metadata.py deleted file mode 100644 index ef04022..0000000 --- a/billforward/models/data_synchronisation_configuration_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class DataSynchronisationConfigurationPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - DataSynchronisationConfigurationPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[DataSynchronisationConfiguration]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this DataSynchronisationConfigurationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this DataSynchronisationConfigurationPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this DataSynchronisationConfigurationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this DataSynchronisationConfigurationPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this DataSynchronisationConfigurationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this DataSynchronisationConfigurationPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this DataSynchronisationConfigurationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this DataSynchronisationConfigurationPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this DataSynchronisationConfigurationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this DataSynchronisationConfigurationPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this DataSynchronisationConfigurationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this DataSynchronisationConfigurationPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this DataSynchronisationConfigurationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this DataSynchronisationConfigurationPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this DataSynchronisationConfigurationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this DataSynchronisationConfigurationPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this DataSynchronisationConfigurationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this DataSynchronisationConfigurationPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this DataSynchronisationConfigurationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this DataSynchronisationConfigurationPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this DataSynchronisationConfigurationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this DataSynchronisationConfigurationPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this DataSynchronisationConfigurationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this DataSynchronisationConfigurationPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this DataSynchronisationConfigurationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this DataSynchronisationConfigurationPagedMetadata. - :rtype: list[DataSynchronisationConfiguration] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this DataSynchronisationConfigurationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this DataSynchronisationConfigurationPagedMetadata. - :type: list[DataSynchronisationConfiguration] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/data_synchronization_job_paged_metadata.py b/billforward/models/data_synchronization_job_paged_metadata.py deleted file mode 100644 index f730b66..0000000 --- a/billforward/models/data_synchronization_job_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class DataSynchronizationJobPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - DataSynchronizationJobPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this DataSynchronizationJobPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this DataSynchronizationJobPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this DataSynchronizationJobPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this DataSynchronizationJobPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this DataSynchronizationJobPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this DataSynchronizationJobPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this DataSynchronizationJobPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this DataSynchronizationJobPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this DataSynchronizationJobPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this DataSynchronizationJobPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this DataSynchronizationJobPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this DataSynchronizationJobPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this DataSynchronizationJobPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this DataSynchronizationJobPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this DataSynchronizationJobPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this DataSynchronizationJobPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this DataSynchronizationJobPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this DataSynchronizationJobPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this DataSynchronizationJobPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this DataSynchronizationJobPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this DataSynchronizationJobPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this DataSynchronizationJobPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this DataSynchronizationJobPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this DataSynchronizationJobPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this DataSynchronizationJobPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this DataSynchronizationJobPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this DataSynchronizationJobPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this DataSynchronizationJobPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/debts_result_paged_metadata.py b/billforward/models/debts_result_paged_metadata.py deleted file mode 100644 index 5d75349..0000000 --- a/billforward/models/debts_result_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class DebtsResultPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - DebtsResultPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this DebtsResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this DebtsResultPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this DebtsResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this DebtsResultPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this DebtsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this DebtsResultPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this DebtsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this DebtsResultPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this DebtsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this DebtsResultPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this DebtsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this DebtsResultPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this DebtsResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this DebtsResultPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this DebtsResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this DebtsResultPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this DebtsResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this DebtsResultPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this DebtsResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this DebtsResultPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this DebtsResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this DebtsResultPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this DebtsResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this DebtsResultPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this DebtsResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this DebtsResultPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this DebtsResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this DebtsResultPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/dunning_line.py b/billforward/models/dunning_line.py index c3c5ecd..339af2f 100644 --- a/billforward/models/dunning_line.py +++ b/billforward/models/dunning_line.py @@ -1,103 +1,104 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class DunningLine(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, type=None, attempt_ix=None, minutes_delay=None, gateway=None, deleted=False, organization=None): - """ - DunningLine - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'type': 'str', - 'attempt_ix': 'int', - 'minutes_delay': 'int', - 'gateway': 'str', - 'deleted': 'bool', - 'organization': 'Organization' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'type': 'type', - 'attempt_ix': 'attemptIx', - 'minutes_delay': 'minutesDelay', - 'gateway': 'gateway', - 'deleted': 'deleted', - 'organization': 'organization' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._type = type - self._attempt_ix = attempt_ix - self._minutes_delay = minutes_delay - self._gateway = gateway - self._deleted = deleted - self._organization = organization + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'type': 'str', + 'attempt_ix': 'int', + 'minutes_delay': 'int', + 'gateway': 'str', + 'deleted': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'type': 'type', + 'attempt_ix': 'attemptIx', + 'minutes_delay': 'minutesDelay', + 'gateway': 'gateway', + 'deleted': 'deleted' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, type=None, attempt_ix=None, minutes_delay=None, gateway=None, deleted=None): # noqa: E501 + """DunningLine - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._type = None + self._attempt_ix = None + self._minutes_delay = None + self._gateway = None + self._deleted = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.organization_id = organization_id + self.type = type + self.attempt_ix = attempt_ix + self.minutes_delay = minutes_delay + if gateway is not None: + self.gateway = gateway + if deleted is not None: + self.deleted = deleted @property def created(self): - """ - Gets the created of this DunningLine. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this DunningLine. # noqa: E501 + - :return: The created of this DunningLine. + :return: The created of this DunningLine. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this DunningLine. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this DunningLine. - :param created: The created of this DunningLine. + + :param created: The created of this DunningLine. # noqa: E501 :type: datetime """ @@ -105,22 +106,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this DunningLine. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this DunningLine. # noqa: E501 - :return: The changed_by of this DunningLine. + + :return: The changed_by of this DunningLine. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this DunningLine. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this DunningLine. + - :param changed_by: The changed_by of this DunningLine. + :param changed_by: The changed_by of this DunningLine. # noqa: E501 :type: str """ @@ -128,22 +127,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this DunningLine. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this DunningLine. # noqa: E501 + - :return: The updated of this DunningLine. + :return: The updated of this DunningLine. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this DunningLine. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this DunningLine. + - :param updated: The updated of this DunningLine. + :param updated: The updated of this DunningLine. # noqa: E501 :type: datetime """ @@ -151,22 +148,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this DunningLine. - { \"description\" : \"ID of the dunning-line.\", \"verbs\":[\"GET\"] } + """Gets the id of this DunningLine. # noqa: E501 - :return: The id of this DunningLine. + + :return: The id of this DunningLine. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this DunningLine. - { \"description\" : \"ID of the dunning-line.\", \"verbs\":[\"GET\"] } + """Sets the id of this DunningLine. - :param id: The id of this DunningLine. + + :param id: The id of this DunningLine. # noqa: E501 :type: str """ @@ -174,51 +169,51 @@ def id(self, id): @property def organization_id(self): - """ - Gets the organization_id of this DunningLine. - { \"description\" : \"ID of the organization associated with the dunning-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the organization_id of this DunningLine. # noqa: E501 + - :return: The organization_id of this DunningLine. + :return: The organization_id of this DunningLine. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this DunningLine. - { \"description\" : \"ID of the organization associated with the dunning-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the organization_id of this DunningLine. + - :param organization_id: The organization_id of this DunningLine. + :param organization_id: The organization_id of this DunningLine. # noqa: E501 :type: str """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 self._organization_id = organization_id @property def type(self): - """ - Gets the type of this DunningLine. - { \"description\" : \"ID of the organization associated with the dunning-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the type of this DunningLine. # noqa: E501 + - :return: The type of this DunningLine. + :return: The type of this DunningLine. # noqa: E501 :rtype: str """ return self._type @type.setter def type(self, type): - """ - Sets the type of this DunningLine. - { \"description\" : \"ID of the organization associated with the dunning-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the type of this DunningLine. - :param type: The type of this DunningLine. + + :param type: The type of this DunningLine. # noqa: E501 :type: str """ - allowed_values = ["Invoice", "Notification"] + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + allowed_values = ["Invoice", "Notification"] # noqa: E501 if type not in allowed_values: raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 .format(type, allowed_values) ) @@ -226,74 +221,72 @@ def type(self, type): @property def attempt_ix(self): - """ - Gets the attempt_ix of this DunningLine. - { \"description\" : \"The payment attempt this dunning line applies to, specified as a positive integer. Dunning lines are ZERO indexed.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the attempt_ix of this DunningLine. # noqa: E501 + - :return: The attempt_ix of this DunningLine. + :return: The attempt_ix of this DunningLine. # noqa: E501 :rtype: int """ return self._attempt_ix @attempt_ix.setter def attempt_ix(self, attempt_ix): - """ - Sets the attempt_ix of this DunningLine. - { \"description\" : \"The payment attempt this dunning line applies to, specified as a positive integer. Dunning lines are ZERO indexed.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the attempt_ix of this DunningLine. + - :param attempt_ix: The attempt_ix of this DunningLine. + :param attempt_ix: The attempt_ix of this DunningLine. # noqa: E501 :type: int """ + if attempt_ix is None: + raise ValueError("Invalid value for `attempt_ix`, must not be `None`") # noqa: E501 self._attempt_ix = attempt_ix @property def minutes_delay(self): - """ - Gets the minutes_delay of this DunningLine. - { \"description\" : \"The time before the next payment attempt in minutes.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the minutes_delay of this DunningLine. # noqa: E501 - :return: The minutes_delay of this DunningLine. + + :return: The minutes_delay of this DunningLine. # noqa: E501 :rtype: int """ return self._minutes_delay @minutes_delay.setter def minutes_delay(self, minutes_delay): - """ - Sets the minutes_delay of this DunningLine. - { \"description\" : \"The time before the next payment attempt in minutes.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the minutes_delay of this DunningLine. - :param minutes_delay: The minutes_delay of this DunningLine. + + :param minutes_delay: The minutes_delay of this DunningLine. # noqa: E501 :type: int """ + if minutes_delay is None: + raise ValueError("Invalid value for `minutes_delay`, must not be `None`") # noqa: E501 self._minutes_delay = minutes_delay @property def gateway(self): - """ - Gets the gateway of this DunningLine. - { \"description\" : \"The payment gateway to use for this payment attempt.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the gateway of this DunningLine. # noqa: E501 + - :return: The gateway of this DunningLine. + :return: The gateway of this DunningLine. # noqa: E501 :rtype: str """ return self._gateway @gateway.setter def gateway(self, gateway): - """ - Sets the gateway of this DunningLine. - { \"description\" : \"The payment gateway to use for this payment attempt.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the gateway of this DunningLine. + - :param gateway: The gateway of this DunningLine. + :param gateway: The gateway of this DunningLine. # noqa: E501 :type: str """ - allowed_values = ["cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash"] + allowed_values = ["VOID", "cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "zooz", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "goCardless", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash", "epx", "shuttle", "square", "billforwardRandomizer", "cardConnect", "ebanx"] # noqa: E501 if gateway not in allowed_values: raise ValueError( - "Invalid value for `gateway` ({0}), must be one of {1}" + "Invalid value for `gateway` ({0}), must be one of {1}" # noqa: E501 .format(gateway, allowed_values) ) @@ -301,57 +294,30 @@ def gateway(self, gateway): @property def deleted(self): - """ - Gets the deleted of this DunningLine. - { \"description\" : \"Has the dunning-line been deleted?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the deleted of this DunningLine. # noqa: E501 + - :return: The deleted of this DunningLine. + :return: The deleted of this DunningLine. # noqa: E501 :rtype: bool """ return self._deleted @deleted.setter def deleted(self, deleted): - """ - Sets the deleted of this DunningLine. - { \"description\" : \"Has the dunning-line been deleted?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the deleted of this DunningLine. - :param deleted: The deleted of this DunningLine. + + :param deleted: The deleted of this DunningLine. # noqa: E501 :type: bool """ self._deleted = deleted - @property - def organization(self): - """ - Gets the organization of this DunningLine. - { \"description\" : \"organization associated with the dunning-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization of this DunningLine. - :rtype: Organization - """ - return self._organization - - @organization.setter - def organization(self, organization): - """ - Sets the organization of this DunningLine. - { \"description\" : \"organization associated with the dunning-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization: The organization of this DunningLine. - :type: Organization - """ - - self._organization = organization - def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -368,29 +334,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(DunningLine, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, DunningLine): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/dunning_line_paged_metadata.py b/billforward/models/dunning_line_paged_metadata.py deleted file mode 100644 index b3f4e3d..0000000 --- a/billforward/models/dunning_line_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class DunningLinePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - DunningLinePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[DunningLine]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this DunningLinePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this DunningLinePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this DunningLinePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this DunningLinePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this DunningLinePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this DunningLinePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this DunningLinePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this DunningLinePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this DunningLinePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this DunningLinePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this DunningLinePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this DunningLinePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this DunningLinePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this DunningLinePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this DunningLinePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this DunningLinePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this DunningLinePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this DunningLinePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this DunningLinePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this DunningLinePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this DunningLinePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this DunningLinePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this DunningLinePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this DunningLinePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this DunningLinePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this DunningLinePagedMetadata. - :rtype: list[DunningLine] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this DunningLinePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this DunningLinePagedMetadata. - :type: list[DunningLine] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/dynamic_metadata.py b/billforward/models/dynamic_metadata.py deleted file mode 100644 index ca834a7..0000000 --- a/billforward/models/dynamic_metadata.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class DynamicMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self): - """ - DynamicMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - - } - - self.attribute_map = { - - } - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/ebanx_auth_capture_request.py b/billforward/models/ebanx_auth_capture_request.py new file mode 100644 index 0000000..439fc6e --- /dev/null +++ b/billforward/models/ebanx_auth_capture_request.py @@ -0,0 +1,220 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.auth_capture_request import AuthCaptureRequest # noqa: F401,E501 + +class EBANXAuthCaptureRequest(AuthCaptureRequest): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'token': 'str', + 'expiry': 'str', + 'eft_code': 'str', + 'payment_type_code': 'str', + 'masked_card_number': 'str' + } + if hasattr(AuthCaptureRequest, "swagger_types"): + swagger_types.update(AuthCaptureRequest.swagger_types) + + attribute_map = { + 'token': 'token', + 'expiry': 'expiry', + 'eft_code': 'eftCode', + 'payment_type_code': 'paymentTypeCode', + 'masked_card_number': 'maskedCardNumber' + } + if hasattr(AuthCaptureRequest, "attribute_map"): + attribute_map.update(AuthCaptureRequest.attribute_map) + + def __init__(self, token=None, expiry=None, eft_code=None, payment_type_code=None, masked_card_number=None, *args, **kwargs): # noqa: E501 + """EBANXAuthCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._token = None + self._expiry = None + self._eft_code = None + self._payment_type_code = None + self._masked_card_number = None + self.discriminator = None + if token is not None: + self.token = token + if expiry is not None: + self.expiry = expiry + if eft_code is not None: + self.eft_code = eft_code + if payment_type_code is not None: + self.payment_type_code = payment_type_code + if masked_card_number is not None: + self.masked_card_number = masked_card_number + AuthCaptureRequest.__init__(self, *args, **kwargs) + + @property + def token(self): + """Gets the token of this EBANXAuthCaptureRequest. # noqa: E501 + + + :return: The token of this EBANXAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._token + + @token.setter + def token(self, token): + """Sets the token of this EBANXAuthCaptureRequest. + + + :param token: The token of this EBANXAuthCaptureRequest. # noqa: E501 + :type: str + """ + + self._token = token + + @property + def expiry(self): + """Gets the expiry of this EBANXAuthCaptureRequest. # noqa: E501 + + + :return: The expiry of this EBANXAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._expiry + + @expiry.setter + def expiry(self, expiry): + """Sets the expiry of this EBANXAuthCaptureRequest. + + + :param expiry: The expiry of this EBANXAuthCaptureRequest. # noqa: E501 + :type: str + """ + + self._expiry = expiry + + @property + def eft_code(self): + """Gets the eft_code of this EBANXAuthCaptureRequest. # noqa: E501 + + + :return: The eft_code of this EBANXAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._eft_code + + @eft_code.setter + def eft_code(self, eft_code): + """Sets the eft_code of this EBANXAuthCaptureRequest. + + + :param eft_code: The eft_code of this EBANXAuthCaptureRequest. # noqa: E501 + :type: str + """ + + self._eft_code = eft_code + + @property + def payment_type_code(self): + """Gets the payment_type_code of this EBANXAuthCaptureRequest. # noqa: E501 + + + :return: The payment_type_code of this EBANXAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._payment_type_code + + @payment_type_code.setter + def payment_type_code(self, payment_type_code): + """Sets the payment_type_code of this EBANXAuthCaptureRequest. + + + :param payment_type_code: The payment_type_code of this EBANXAuthCaptureRequest. # noqa: E501 + :type: str + """ + + self._payment_type_code = payment_type_code + + @property + def masked_card_number(self): + """Gets the masked_card_number of this EBANXAuthCaptureRequest. # noqa: E501 + + + :return: The masked_card_number of this EBANXAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._masked_card_number + + @masked_card_number.setter + def masked_card_number(self, masked_card_number): + """Sets the masked_card_number of this EBANXAuthCaptureRequest. + + + :param masked_card_number: The masked_card_number of this EBANXAuthCaptureRequest. # noqa: E501 + :type: str + """ + + self._masked_card_number = masked_card_number + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EBANXAuthCaptureRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EBANXAuthCaptureRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/ebanx_configuration.py b/billforward/models/ebanx_configuration.py new file mode 100644 index 0000000..0a05a68 --- /dev/null +++ b/billforward/models/ebanx_configuration.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class EBANXConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """EBANXConfiguration - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + APIConfiguration.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EBANXConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EBANXConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/ebanx_gateway_request.py b/billforward/models/ebanx_gateway_request.py new file mode 100644 index 0000000..28b50b0 --- /dev/null +++ b/billforward/models/ebanx_gateway_request.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class EBANXGatewayRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'integration_key': 'str', + 'public_integration_key': 'str', + 'production': 'bool' + } + + attribute_map = { + 'integration_key': 'integrationKey', + 'public_integration_key': 'publicIntegrationKey', + 'production': 'production' + } + + def __init__(self, integration_key=None, public_integration_key=None, production=None): # noqa: E501 + """EBANXGatewayRequest - a model defined in Swagger""" # noqa: E501 + self._integration_key = None + self._public_integration_key = None + self._production = None + self.discriminator = None + if integration_key is not None: + self.integration_key = integration_key + if public_integration_key is not None: + self.public_integration_key = public_integration_key + if production is not None: + self.production = production + + @property + def integration_key(self): + """Gets the integration_key of this EBANXGatewayRequest. # noqa: E501 + + + :return: The integration_key of this EBANXGatewayRequest. # noqa: E501 + :rtype: str + """ + return self._integration_key + + @integration_key.setter + def integration_key(self, integration_key): + """Sets the integration_key of this EBANXGatewayRequest. + + + :param integration_key: The integration_key of this EBANXGatewayRequest. # noqa: E501 + :type: str + """ + + self._integration_key = integration_key + + @property + def public_integration_key(self): + """Gets the public_integration_key of this EBANXGatewayRequest. # noqa: E501 + + + :return: The public_integration_key of this EBANXGatewayRequest. # noqa: E501 + :rtype: str + """ + return self._public_integration_key + + @public_integration_key.setter + def public_integration_key(self, public_integration_key): + """Sets the public_integration_key of this EBANXGatewayRequest. + + + :param public_integration_key: The public_integration_key of this EBANXGatewayRequest. # noqa: E501 + :type: str + """ + + self._public_integration_key = public_integration_key + + @property + def production(self): + """Gets the production of this EBANXGatewayRequest. # noqa: E501 + + + :return: The production of this EBANXGatewayRequest. # noqa: E501 + :rtype: bool + """ + return self._production + + @production.setter + def production(self, production): + """Sets the production of this EBANXGatewayRequest. + + + :param production: The production of this EBANXGatewayRequest. # noqa: E501 + :type: bool + """ + + self._production = production + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EBANXGatewayRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EBANXGatewayRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/ebanx_payment.py b/billforward/models/ebanx_payment.py new file mode 100644 index 0000000..a9a991e --- /dev/null +++ b/billforward/models/ebanx_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class EBANXPayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """EBANXPayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EBANXPayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EBANXPayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/ebanx_webhook.py b/billforward/models/ebanx_webhook.py new file mode 100644 index 0000000..89e1de8 --- /dev/null +++ b/billforward/models/ebanx_webhook.py @@ -0,0 +1,200 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class EBANXWebhook(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'operation': 'str', + 'organisation_id': 'str', + 'notification_type': 'str', + 'hash_codes': 'list[str]' + } + + attribute_map = { + 'operation': 'operation', + 'organisation_id': 'organisationId', + 'notification_type': 'notification_type', + 'hash_codes': 'hash_codes' + } + + def __init__(self, operation=None, organisation_id=None, notification_type=None, hash_codes=None): # noqa: E501 + """EBANXWebhook - a model defined in Swagger""" # noqa: E501 + self._operation = None + self._organisation_id = None + self._notification_type = None + self._hash_codes = None + self.discriminator = None + if operation is not None: + self.operation = operation + if organisation_id is not None: + self.organisation_id = organisation_id + if notification_type is not None: + self.notification_type = notification_type + if hash_codes is not None: + self.hash_codes = hash_codes + + @property + def operation(self): + """Gets the operation of this EBANXWebhook. # noqa: E501 + + + :return: The operation of this EBANXWebhook. # noqa: E501 + :rtype: str + """ + return self._operation + + @operation.setter + def operation(self, operation): + """Sets the operation of this EBANXWebhook. + + + :param operation: The operation of this EBANXWebhook. # noqa: E501 + :type: str + """ + allowed_values = ["payment_status_change"] # noqa: E501 + if operation not in allowed_values: + raise ValueError( + "Invalid value for `operation` ({0}), must be one of {1}" # noqa: E501 + .format(operation, allowed_values) + ) + + self._operation = operation + + @property + def organisation_id(self): + """Gets the organisation_id of this EBANXWebhook. # noqa: E501 + + + :return: The organisation_id of this EBANXWebhook. # noqa: E501 + :rtype: str + """ + return self._organisation_id + + @organisation_id.setter + def organisation_id(self, organisation_id): + """Sets the organisation_id of this EBANXWebhook. + + + :param organisation_id: The organisation_id of this EBANXWebhook. # noqa: E501 + :type: str + """ + + self._organisation_id = organisation_id + + @property + def notification_type(self): + """Gets the notification_type of this EBANXWebhook. # noqa: E501 + + + :return: The notification_type of this EBANXWebhook. # noqa: E501 + :rtype: str + """ + return self._notification_type + + @notification_type.setter + def notification_type(self, notification_type): + """Sets the notification_type of this EBANXWebhook. + + + :param notification_type: The notification_type of this EBANXWebhook. # noqa: E501 + :type: str + """ + allowed_values = ["update", "chargeback", "refund", "chargeback_credit"] # noqa: E501 + if notification_type not in allowed_values: + raise ValueError( + "Invalid value for `notification_type` ({0}), must be one of {1}" # noqa: E501 + .format(notification_type, allowed_values) + ) + + self._notification_type = notification_type + + @property + def hash_codes(self): + """Gets the hash_codes of this EBANXWebhook. # noqa: E501 + + + :return: The hash_codes of this EBANXWebhook. # noqa: E501 + :rtype: list[str] + """ + return self._hash_codes + + @hash_codes.setter + def hash_codes(self, hash_codes): + """Sets the hash_codes of this EBANXWebhook. + + + :param hash_codes: The hash_codes of this EBANXWebhook. # noqa: E501 + :type: list[str] + """ + + self._hash_codes = hash_codes + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EBANXWebhook, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EBANXWebhook): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/email.py b/billforward/models/email.py deleted file mode 100644 index e7de125..0000000 --- a/billforward/models/email.py +++ /dev/null @@ -1,838 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class Email(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, subscription_id=None, invoice_id=None, _from=None, to=None, cc=None, bcc=None, subject=None, html=None, attachment_filename=None, attachment_html=None, plain=None, sent=None, state=None, deleted=False, header_url=None, salutation=None, paragraph1=None, paragraph2=None, footer_information=None, signoff=None, emai_subscription_type=None, notification_id=None, organization_id=None): - """ - Email - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'account_id': 'str', - 'subscription_id': 'str', - 'invoice_id': 'str', - '_from': 'str', - 'to': 'str', - 'cc': 'str', - 'bcc': 'str', - 'subject': 'str', - 'html': 'str', - 'attachment_filename': 'str', - 'attachment_html': 'str', - 'plain': 'str', - 'sent': 'datetime', - 'state': 'str', - 'deleted': 'bool', - 'header_url': 'str', - 'salutation': 'str', - 'paragraph1': 'str', - 'paragraph2': 'str', - 'footer_information': 'str', - 'signoff': 'str', - 'emai_subscription_type': 'str', - 'notification_id': 'str', - 'organization_id': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'account_id': 'accountID', - 'subscription_id': 'subscriptionID', - 'invoice_id': 'invoiceID', - '_from': 'from', - 'to': 'to', - 'cc': 'cc', - 'bcc': 'bcc', - 'subject': 'subject', - 'html': 'html', - 'attachment_filename': 'attachmentFilename', - 'attachment_html': 'attachmentHtml', - 'plain': 'plain', - 'sent': 'sent', - 'state': 'state', - 'deleted': 'deleted', - 'header_url': 'headerURL', - 'salutation': 'salutation', - 'paragraph1': 'paragraph1', - 'paragraph2': 'paragraph2', - 'footer_information': 'footerInformation', - 'signoff': 'signoff', - 'emai_subscription_type': 'emaiSubscriptionType', - 'notification_id': 'notificationID', - 'organization_id': 'organizationID' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._account_id = account_id - self._subscription_id = subscription_id - self._invoice_id = invoice_id - self.__from = _from - self._to = to - self._cc = cc - self._bcc = bcc - self._subject = subject - self._html = html - self._attachment_filename = attachment_filename - self._attachment_html = attachment_html - self._plain = plain - self._sent = sent - self._state = state - self._deleted = deleted - self._header_url = header_url - self._salutation = salutation - self._paragraph1 = paragraph1 - self._paragraph2 = paragraph2 - self._footer_information = footer_information - self._signoff = signoff - self._emai_subscription_type = emai_subscription_type - self._notification_id = notification_id - self._organization_id = organization_id - - @property - def created(self): - """ - Gets the created of this Email. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this Email. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this Email. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this Email. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this Email. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this Email. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this Email. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this Email. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this Email. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this Email. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this Email. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this Email. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this Email. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this Email. - :type: str - """ - - self._id = id - - @property - def account_id(self): - """ - Gets the account_id of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The account_id of this Email. - :rtype: str - """ - return self._account_id - - @account_id.setter - def account_id(self, account_id): - """ - Sets the account_id of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param account_id: The account_id of this Email. - :type: str - """ - - self._account_id = account_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The subscription_id of this Email. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param subscription_id: The subscription_id of this Email. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def invoice_id(self): - """ - Gets the invoice_id of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The invoice_id of this Email. - :rtype: str - """ - return self._invoice_id - - @invoice_id.setter - def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param invoice_id: The invoice_id of this Email. - :type: str - """ - - self._invoice_id = invoice_id - - @property - def _from(self): - """ - Gets the _from of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The _from of this Email. - :rtype: str - """ - return self.__from - - @_from.setter - def _from(self, _from): - """ - Sets the _from of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param _from: The _from of this Email. - :type: str - """ - - self.__from = _from - - @property - def to(self): - """ - Gets the to of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The to of this Email. - :rtype: str - """ - return self._to - - @to.setter - def to(self, to): - """ - Sets the to of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param to: The to of this Email. - :type: str - """ - - self._to = to - - @property - def cc(self): - """ - Gets the cc of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The cc of this Email. - :rtype: str - """ - return self._cc - - @cc.setter - def cc(self, cc): - """ - Sets the cc of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param cc: The cc of this Email. - :type: str - """ - - self._cc = cc - - @property - def bcc(self): - """ - Gets the bcc of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The bcc of this Email. - :rtype: str - """ - return self._bcc - - @bcc.setter - def bcc(self, bcc): - """ - Sets the bcc of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param bcc: The bcc of this Email. - :type: str - """ - - self._bcc = bcc - - @property - def subject(self): - """ - Gets the subject of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The subject of this Email. - :rtype: str - """ - return self._subject - - @subject.setter - def subject(self, subject): - """ - Sets the subject of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param subject: The subject of this Email. - :type: str - """ - - self._subject = subject - - @property - def html(self): - """ - Gets the html of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The html of this Email. - :rtype: str - """ - return self._html - - @html.setter - def html(self, html): - """ - Sets the html of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param html: The html of this Email. - :type: str - """ - - self._html = html - - @property - def attachment_filename(self): - """ - Gets the attachment_filename of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The attachment_filename of this Email. - :rtype: str - """ - return self._attachment_filename - - @attachment_filename.setter - def attachment_filename(self, attachment_filename): - """ - Sets the attachment_filename of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param attachment_filename: The attachment_filename of this Email. - :type: str - """ - - self._attachment_filename = attachment_filename - - @property - def attachment_html(self): - """ - Gets the attachment_html of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The attachment_html of this Email. - :rtype: str - """ - return self._attachment_html - - @attachment_html.setter - def attachment_html(self, attachment_html): - """ - Sets the attachment_html of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param attachment_html: The attachment_html of this Email. - :type: str - """ - - self._attachment_html = attachment_html - - @property - def plain(self): - """ - Gets the plain of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The plain of this Email. - :rtype: str - """ - return self._plain - - @plain.setter - def plain(self, plain): - """ - Sets the plain of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param plain: The plain of this Email. - :type: str - """ - - self._plain = plain - - @property - def sent(self): - """ - Gets the sent of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The sent of this Email. - :rtype: datetime - """ - return self._sent - - @sent.setter - def sent(self, sent): - """ - Sets the sent of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param sent: The sent of this Email. - :type: datetime - """ - - self._sent = sent - - @property - def state(self): - """ - Gets the state of this Email. - { \"description\" : \".\", \"verbs\":[\"GET\"] } - - :return: The state of this Email. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this Email. - { \"description\" : \".\", \"verbs\":[\"GET\"] } - - :param state: The state of this Email. - :type: str - """ - allowed_values = ["Pending", "Unsent", "Sent"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The deleted of this Email. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this Email. - :type: bool - """ - - self._deleted = deleted - - @property - def header_url(self): - """ - Gets the header_url of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The header_url of this Email. - :rtype: str - """ - return self._header_url - - @header_url.setter - def header_url(self, header_url): - """ - Sets the header_url of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param header_url: The header_url of this Email. - :type: str - """ - - self._header_url = header_url - - @property - def salutation(self): - """ - Gets the salutation of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The salutation of this Email. - :rtype: str - """ - return self._salutation - - @salutation.setter - def salutation(self, salutation): - """ - Sets the salutation of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param salutation: The salutation of this Email. - :type: str - """ - - self._salutation = salutation - - @property - def paragraph1(self): - """ - Gets the paragraph1 of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The paragraph1 of this Email. - :rtype: str - """ - return self._paragraph1 - - @paragraph1.setter - def paragraph1(self, paragraph1): - """ - Sets the paragraph1 of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param paragraph1: The paragraph1 of this Email. - :type: str - """ - - self._paragraph1 = paragraph1 - - @property - def paragraph2(self): - """ - Gets the paragraph2 of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The paragraph2 of this Email. - :rtype: str - """ - return self._paragraph2 - - @paragraph2.setter - def paragraph2(self, paragraph2): - """ - Sets the paragraph2 of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param paragraph2: The paragraph2 of this Email. - :type: str - """ - - self._paragraph2 = paragraph2 - - @property - def footer_information(self): - """ - Gets the footer_information of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The footer_information of this Email. - :rtype: str - """ - return self._footer_information - - @footer_information.setter - def footer_information(self, footer_information): - """ - Sets the footer_information of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param footer_information: The footer_information of this Email. - :type: str - """ - - self._footer_information = footer_information - - @property - def signoff(self): - """ - Gets the signoff of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The signoff of this Email. - :rtype: str - """ - return self._signoff - - @signoff.setter - def signoff(self, signoff): - """ - Sets the signoff of this Email. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param signoff: The signoff of this Email. - :type: str - """ - - self._signoff = signoff - - @property - def emai_subscription_type(self): - """ - Gets the emai_subscription_type of this Email. - - - :return: The emai_subscription_type of this Email. - :rtype: str - """ - return self._emai_subscription_type - - @emai_subscription_type.setter - def emai_subscription_type(self, emai_subscription_type): - """ - Sets the emai_subscription_type of this Email. - - - :param emai_subscription_type: The emai_subscription_type of this Email. - :type: str - """ - allowed_values = ["FailedPayment", "InvoicePaid", "SubscriptionCancellation", "SubscriptionCancelled", "SubscriptionPlanMigrated", "SubscriptionPlanMigrating", "CardExpired", "CardExpiring"] - if emai_subscription_type not in allowed_values: - raise ValueError( - "Invalid value for `emai_subscription_type` ({0}), must be one of {1}" - .format(emai_subscription_type, allowed_values) - ) - - self._emai_subscription_type = emai_subscription_type - - @property - def notification_id(self): - """ - Gets the notification_id of this Email. - { \"description\" : \"\", \"verbs\":[] } - - :return: The notification_id of this Email. - :rtype: str - """ - return self._notification_id - - @notification_id.setter - def notification_id(self, notification_id): - """ - Sets the notification_id of this Email. - { \"description\" : \"\", \"verbs\":[] } - - :param notification_id: The notification_id of this Email. - :type: str - """ - - self._notification_id = notification_id - - @property - def organization_id(self): - """ - Gets the organization_id of this Email. - { \"description\" : \"\", \"verbs\":[] } - - :return: The organization_id of this Email. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this Email. - { \"description\" : \"\", \"verbs\":[] } - - :param organization_id: The organization_id of this Email. - :type: str - """ - - self._organization_id = organization_id - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/email_paged_metadata.py b/billforward/models/email_paged_metadata.py deleted file mode 100644 index 36bc837..0000000 --- a/billforward/models/email_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class EmailPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - EmailPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Email]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this EmailPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this EmailPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this EmailPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this EmailPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this EmailPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this EmailPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this EmailPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this EmailPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this EmailPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this EmailPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this EmailPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this EmailPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this EmailPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this EmailPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this EmailPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this EmailPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this EmailPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this EmailPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this EmailPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this EmailPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this EmailPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this EmailPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this EmailPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this EmailPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this EmailPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this EmailPagedMetadata. - :rtype: list[Email] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this EmailPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this EmailPagedMetadata. - :type: list[Email] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/email_provider.py b/billforward/models/email_provider.py deleted file mode 100644 index b246495..0000000 --- a/billforward/models/email_provider.py +++ /dev/null @@ -1,384 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class EmailProvider(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, name=None, host=None, port=None, username=None, password=None, deleted=False): - """ - EmailProvider - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'name': 'str', - 'host': 'str', - 'port': 'int', - 'username': 'str', - 'password': 'str', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'name': 'name', - 'host': 'host', - 'port': 'port', - 'username': 'username', - 'password': 'password', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._name = name - self._host = host - self._port = port - self._username = username - self._password = password - self._deleted = deleted - - @property - def created(self): - """ - Gets the created of this EmailProvider. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this EmailProvider. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this EmailProvider. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this EmailProvider. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this EmailProvider. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this EmailProvider. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this EmailProvider. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this EmailProvider. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this EmailProvider. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this EmailProvider. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this EmailProvider. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this EmailProvider. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this EmailProvider. - { \"description\" : \"ID of the email provider.\", \"verbs\":[\"GET\"] } - - :return: The id of this EmailProvider. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this EmailProvider. - { \"description\" : \"ID of the email provider.\", \"verbs\":[\"GET\"] } - - :param id: The id of this EmailProvider. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this EmailProvider. - { \"description\" : \"ID of the organization associated with the email provider.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this EmailProvider. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this EmailProvider. - { \"description\" : \"ID of the organization associated with the email provider.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this EmailProvider. - :type: str - """ - - self._organization_id = organization_id - - @property - def name(self): - """ - Gets the name of this EmailProvider. - - - :return: The name of this EmailProvider. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this EmailProvider. - - - :param name: The name of this EmailProvider. - :type: str - """ - - self._name = name - - @property - def host(self): - """ - Gets the host of this EmailProvider. - - - :return: The host of this EmailProvider. - :rtype: str - """ - return self._host - - @host.setter - def host(self, host): - """ - Sets the host of this EmailProvider. - - - :param host: The host of this EmailProvider. - :type: str - """ - - self._host = host - - @property - def port(self): - """ - Gets the port of this EmailProvider. - - - :return: The port of this EmailProvider. - :rtype: int - """ - return self._port - - @port.setter - def port(self, port): - """ - Sets the port of this EmailProvider. - - - :param port: The port of this EmailProvider. - :type: int - """ - - self._port = port - - @property - def username(self): - """ - Gets the username of this EmailProvider. - - - :return: The username of this EmailProvider. - :rtype: str - """ - return self._username - - @username.setter - def username(self, username): - """ - Sets the username of this EmailProvider. - - - :param username: The username of this EmailProvider. - :type: str - """ - - self._username = username - - @property - def password(self): - """ - Gets the password of this EmailProvider. - - - :return: The password of this EmailProvider. - :rtype: str - """ - return self._password - - @password.setter - def password(self, password): - """ - Sets the password of this EmailProvider. - - - :param password: The password of this EmailProvider. - :type: str - """ - - self._password = password - - @property - def deleted(self): - """ - Gets the deleted of this EmailProvider. - { \"description\" : \"Has the dunning-line been deleted?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The deleted of this EmailProvider. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this EmailProvider. - { \"description\" : \"Has the dunning-line been deleted?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param deleted: The deleted of this EmailProvider. - :type: bool - """ - - self._deleted = deleted - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/email_provider_paged_metadata.py b/billforward/models/email_provider_paged_metadata.py deleted file mode 100644 index ca7ac6b..0000000 --- a/billforward/models/email_provider_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class EmailProviderPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - EmailProviderPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[EmailProvider]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this EmailProviderPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this EmailProviderPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this EmailProviderPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this EmailProviderPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this EmailProviderPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this EmailProviderPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this EmailProviderPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this EmailProviderPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this EmailProviderPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this EmailProviderPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this EmailProviderPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this EmailProviderPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this EmailProviderPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this EmailProviderPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this EmailProviderPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this EmailProviderPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this EmailProviderPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this EmailProviderPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this EmailProviderPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this EmailProviderPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this EmailProviderPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this EmailProviderPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this EmailProviderPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this EmailProviderPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this EmailProviderPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this EmailProviderPagedMetadata. - :rtype: list[EmailProvider] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this EmailProviderPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this EmailProviderPagedMetadata. - :type: list[EmailProvider] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/email_subscription.py b/billforward/models/email_subscription.py deleted file mode 100644 index 7779455..0000000 --- a/billforward/models/email_subscription.py +++ /dev/null @@ -1,448 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class EmailSubscription(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, type=None, state=None, _from=None, bcc=None, cc=None, subject_template=None, send_to_customer=False, attach_invoice=False): - """ - EmailSubscription - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'type': 'str', - 'state': 'str', - '_from': 'str', - 'bcc': 'str', - 'cc': 'str', - 'subject_template': 'str', - 'send_to_customer': 'bool', - 'attach_invoice': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'type': 'type', - 'state': 'state', - '_from': 'from', - 'bcc': 'bcc', - 'cc': 'cc', - 'subject_template': 'subjectTemplate', - 'send_to_customer': 'sendToCustomer', - 'attach_invoice': 'attachInvoice' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._type = type - self._state = state - self.__from = _from - self._bcc = bcc - self._cc = cc - self._subject_template = subject_template - self._send_to_customer = send_to_customer - self._attach_invoice = attach_invoice - - @property - def created(self): - """ - Gets the created of this EmailSubscription. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this EmailSubscription. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this EmailSubscription. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this EmailSubscription. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this EmailSubscription. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this EmailSubscription. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this EmailSubscription. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this EmailSubscription. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this EmailSubscription. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this EmailSubscription. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this EmailSubscription. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this EmailSubscription. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this EmailSubscription. - { \"description\" : \"ID of the email provider.\", \"verbs\":[\"GET\"] } - - :return: The id of this EmailSubscription. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this EmailSubscription. - { \"description\" : \"ID of the email provider.\", \"verbs\":[\"GET\"] } - - :param id: The id of this EmailSubscription. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this EmailSubscription. - { \"description\" : \"ID of the organization associated with the email provider.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this EmailSubscription. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this EmailSubscription. - { \"description\" : \"ID of the organization associated with the email provider.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this EmailSubscription. - :type: str - """ - - self._organization_id = organization_id - - @property - def type(self): - """ - Gets the type of this EmailSubscription. - - - :return: The type of this EmailSubscription. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this EmailSubscription. - - - :param type: The type of this EmailSubscription. - :type: str - """ - allowed_values = ["FailedPayment", "InvoicePaid", "SubscriptionCancellation", "SubscriptionCancelled", "SubscriptionPlanMigrated", "SubscriptionPlanMigrating", "CardExpired", "CardExpiring"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def state(self): - """ - Gets the state of this EmailSubscription. - - - :return: The state of this EmailSubscription. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this EmailSubscription. - - - :param state: The state of this EmailSubscription. - :type: str - """ - allowed_values = ["Active", "Disabled"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def _from(self): - """ - Gets the _from of this EmailSubscription. - - - :return: The _from of this EmailSubscription. - :rtype: str - """ - return self.__from - - @_from.setter - def _from(self, _from): - """ - Sets the _from of this EmailSubscription. - - - :param _from: The _from of this EmailSubscription. - :type: str - """ - - self.__from = _from - - @property - def bcc(self): - """ - Gets the bcc of this EmailSubscription. - - - :return: The bcc of this EmailSubscription. - :rtype: str - """ - return self._bcc - - @bcc.setter - def bcc(self, bcc): - """ - Sets the bcc of this EmailSubscription. - - - :param bcc: The bcc of this EmailSubscription. - :type: str - """ - - self._bcc = bcc - - @property - def cc(self): - """ - Gets the cc of this EmailSubscription. - - - :return: The cc of this EmailSubscription. - :rtype: str - """ - return self._cc - - @cc.setter - def cc(self, cc): - """ - Sets the cc of this EmailSubscription. - - - :param cc: The cc of this EmailSubscription. - :type: str - """ - - self._cc = cc - - @property - def subject_template(self): - """ - Gets the subject_template of this EmailSubscription. - - - :return: The subject_template of this EmailSubscription. - :rtype: str - """ - return self._subject_template - - @subject_template.setter - def subject_template(self, subject_template): - """ - Sets the subject_template of this EmailSubscription. - - - :param subject_template: The subject_template of this EmailSubscription. - :type: str - """ - - self._subject_template = subject_template - - @property - def send_to_customer(self): - """ - Gets the send_to_customer of this EmailSubscription. - - - :return: The send_to_customer of this EmailSubscription. - :rtype: bool - """ - return self._send_to_customer - - @send_to_customer.setter - def send_to_customer(self, send_to_customer): - """ - Sets the send_to_customer of this EmailSubscription. - - - :param send_to_customer: The send_to_customer of this EmailSubscription. - :type: bool - """ - - self._send_to_customer = send_to_customer - - @property - def attach_invoice(self): - """ - Gets the attach_invoice of this EmailSubscription. - - - :return: The attach_invoice of this EmailSubscription. - :rtype: bool - """ - return self._attach_invoice - - @attach_invoice.setter - def attach_invoice(self, attach_invoice): - """ - Sets the attach_invoice of this EmailSubscription. - - - :param attach_invoice: The attach_invoice of this EmailSubscription. - :type: bool - """ - - self._attach_invoice = attach_invoice - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/email_subscription_paged_metadata.py b/billforward/models/email_subscription_paged_metadata.py deleted file mode 100644 index 4374eaa..0000000 --- a/billforward/models/email_subscription_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class EmailSubscriptionPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - EmailSubscriptionPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[EmailSubscription]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this EmailSubscriptionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this EmailSubscriptionPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this EmailSubscriptionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this EmailSubscriptionPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this EmailSubscriptionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this EmailSubscriptionPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this EmailSubscriptionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this EmailSubscriptionPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this EmailSubscriptionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this EmailSubscriptionPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this EmailSubscriptionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this EmailSubscriptionPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this EmailSubscriptionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this EmailSubscriptionPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this EmailSubscriptionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this EmailSubscriptionPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this EmailSubscriptionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this EmailSubscriptionPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this EmailSubscriptionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this EmailSubscriptionPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this EmailSubscriptionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this EmailSubscriptionPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this EmailSubscriptionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this EmailSubscriptionPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this EmailSubscriptionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this EmailSubscriptionPagedMetadata. - :rtype: list[EmailSubscription] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this EmailSubscriptionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this EmailSubscriptionPagedMetadata. - :type: list[EmailSubscription] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/email_tokenization.py b/billforward/models/email_tokenization.py new file mode 100644 index 0000000..b474648 --- /dev/null +++ b/billforward/models/email_tokenization.py @@ -0,0 +1,832 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class EmailTokenization(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'request_token': 'str', + 'type': 'str', + 'verification_state': 'str', + 'email_id': 'str', + 'public_token': 'str', + 'account': 'Account', + 'account_full_name': 'str', + 'subscription_id': 'str', + 'subscription_name': 'str', + 'product_rate_plan_name': 'str', + 'invoice_id': 'str', + 'invoice_version_id': 'str', + 'logo_url': 'str', + 'currency': 'CreditNoteCurrency', + 'amount': 'float', + 'last_sent': 'datetime', + 'valid_till': 'datetime', + 'payment_method_id': 'str', + 'make_default': 'bool', + 'charge_immediately': 'bool', + 'capture_profile': 'bool', + 'capture_billing_address': 'bool', + 'capture_shipping_address': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'request_token': 'requestToken', + 'type': 'type', + 'verification_state': 'verificationState', + 'email_id': 'emailID', + 'public_token': 'publicToken', + 'account': 'account', + 'account_full_name': 'accountFullName', + 'subscription_id': 'subscriptionID', + 'subscription_name': 'subscriptionName', + 'product_rate_plan_name': 'productRatePlanName', + 'invoice_id': 'invoiceID', + 'invoice_version_id': 'invoiceVersionID', + 'logo_url': 'logoUrl', + 'currency': 'currency', + 'amount': 'amount', + 'last_sent': 'lastSent', + 'valid_till': 'validTill', + 'payment_method_id': 'paymentMethodID', + 'make_default': 'makeDefault', + 'charge_immediately': 'chargeImmediately', + 'capture_profile': 'captureProfile', + 'capture_billing_address': 'captureBillingAddress', + 'capture_shipping_address': 'captureShippingAddress' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, request_token=None, type=None, verification_state=None, email_id=None, public_token=None, account=None, account_full_name=None, subscription_id=None, subscription_name=None, product_rate_plan_name=None, invoice_id=None, invoice_version_id=None, logo_url=None, currency=None, amount=None, last_sent=None, valid_till=None, payment_method_id=None, make_default=None, charge_immediately=None, capture_profile=None, capture_billing_address=None, capture_shipping_address=None): # noqa: E501 + """EmailTokenization - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._request_token = None + self._type = None + self._verification_state = None + self._email_id = None + self._public_token = None + self._account = None + self._account_full_name = None + self._subscription_id = None + self._subscription_name = None + self._product_rate_plan_name = None + self._invoice_id = None + self._invoice_version_id = None + self._logo_url = None + self._currency = None + self._amount = None + self._last_sent = None + self._valid_till = None + self._payment_method_id = None + self._make_default = None + self._charge_immediately = None + self._capture_profile = None + self._capture_billing_address = None + self._capture_shipping_address = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.organization_id = organization_id + self.request_token = request_token + self.type = type + if verification_state is not None: + self.verification_state = verification_state + self.email_id = email_id + self.public_token = public_token + self.account = account + self.account_full_name = account_full_name + if subscription_id is not None: + self.subscription_id = subscription_id + if subscription_name is not None: + self.subscription_name = subscription_name + if product_rate_plan_name is not None: + self.product_rate_plan_name = product_rate_plan_name + if invoice_id is not None: + self.invoice_id = invoice_id + if invoice_version_id is not None: + self.invoice_version_id = invoice_version_id + if logo_url is not None: + self.logo_url = logo_url + if currency is not None: + self.currency = currency + if amount is not None: + self.amount = amount + if last_sent is not None: + self.last_sent = last_sent + self.valid_till = valid_till + if payment_method_id is not None: + self.payment_method_id = payment_method_id + if make_default is not None: + self.make_default = make_default + if charge_immediately is not None: + self.charge_immediately = charge_immediately + if capture_profile is not None: + self.capture_profile = capture_profile + if capture_billing_address is not None: + self.capture_billing_address = capture_billing_address + if capture_shipping_address is not None: + self.capture_shipping_address = capture_shipping_address + + @property + def created(self): + """Gets the created of this EmailTokenization. # noqa: E501 + + + :return: The created of this EmailTokenization. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this EmailTokenization. + + + :param created: The created of this EmailTokenization. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this EmailTokenization. # noqa: E501 + + + :return: The changed_by of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this EmailTokenization. + + + :param changed_by: The changed_by of this EmailTokenization. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this EmailTokenization. # noqa: E501 + + + :return: The updated of this EmailTokenization. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this EmailTokenization. + + + :param updated: The updated of this EmailTokenization. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this EmailTokenization. # noqa: E501 + + + :return: The id of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this EmailTokenization. + + + :param id: The id of this EmailTokenization. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this EmailTokenization. # noqa: E501 + + + :return: The organization_id of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this EmailTokenization. + + + :param organization_id: The organization_id of this EmailTokenization. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def request_token(self): + """Gets the request_token of this EmailTokenization. # noqa: E501 + + + :return: The request_token of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._request_token + + @request_token.setter + def request_token(self, request_token): + """Sets the request_token of this EmailTokenization. + + + :param request_token: The request_token of this EmailTokenization. # noqa: E501 + :type: str + """ + if request_token is None: + raise ValueError("Invalid value for `request_token`, must not be `None`") # noqa: E501 + + self._request_token = request_token + + @property + def type(self): + """Gets the type of this EmailTokenization. # noqa: E501 + + + :return: The type of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this EmailTokenization. + + + :param type: The type of this EmailTokenization. # noqa: E501 + :type: str + """ + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + allowed_values = ["Stripe", "StripeACH", "GoCardless", "Shuttle", "CardConnect", "EBANX"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def verification_state(self): + """Gets the verification_state of this EmailTokenization. # noqa: E501 + + + :return: The verification_state of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._verification_state + + @verification_state.setter + def verification_state(self, verification_state): + """Sets the verification_state of this EmailTokenization. + + + :param verification_state: The verification_state of this EmailTokenization. # noqa: E501 + :type: str + """ + allowed_values = ["Verified", "NotVerified"] # noqa: E501 + if verification_state not in allowed_values: + raise ValueError( + "Invalid value for `verification_state` ({0}), must be one of {1}" # noqa: E501 + .format(verification_state, allowed_values) + ) + + self._verification_state = verification_state + + @property + def email_id(self): + """Gets the email_id of this EmailTokenization. # noqa: E501 + + + :return: The email_id of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._email_id + + @email_id.setter + def email_id(self, email_id): + """Sets the email_id of this EmailTokenization. + + + :param email_id: The email_id of this EmailTokenization. # noqa: E501 + :type: str + """ + if email_id is None: + raise ValueError("Invalid value for `email_id`, must not be `None`") # noqa: E501 + + self._email_id = email_id + + @property + def public_token(self): + """Gets the public_token of this EmailTokenization. # noqa: E501 + + + :return: The public_token of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._public_token + + @public_token.setter + def public_token(self, public_token): + """Sets the public_token of this EmailTokenization. + + + :param public_token: The public_token of this EmailTokenization. # noqa: E501 + :type: str + """ + if public_token is None: + raise ValueError("Invalid value for `public_token`, must not be `None`") # noqa: E501 + + self._public_token = public_token + + @property + def account(self): + """Gets the account of this EmailTokenization. # noqa: E501 + + + :return: The account of this EmailTokenization. # noqa: E501 + :rtype: Account + """ + return self._account + + @account.setter + def account(self, account): + """Sets the account of this EmailTokenization. + + + :param account: The account of this EmailTokenization. # noqa: E501 + :type: Account + """ + if account is None: + raise ValueError("Invalid value for `account`, must not be `None`") # noqa: E501 + + self._account = account + + @property + def account_full_name(self): + """Gets the account_full_name of this EmailTokenization. # noqa: E501 + + + :return: The account_full_name of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._account_full_name + + @account_full_name.setter + def account_full_name(self, account_full_name): + """Sets the account_full_name of this EmailTokenization. + + + :param account_full_name: The account_full_name of this EmailTokenization. # noqa: E501 + :type: str + """ + if account_full_name is None: + raise ValueError("Invalid value for `account_full_name`, must not be `None`") # noqa: E501 + + self._account_full_name = account_full_name + + @property + def subscription_id(self): + """Gets the subscription_id of this EmailTokenization. # noqa: E501 + + + :return: The subscription_id of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this EmailTokenization. + + + :param subscription_id: The subscription_id of this EmailTokenization. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def subscription_name(self): + """Gets the subscription_name of this EmailTokenization. # noqa: E501 + + + :return: The subscription_name of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._subscription_name + + @subscription_name.setter + def subscription_name(self, subscription_name): + """Sets the subscription_name of this EmailTokenization. + + + :param subscription_name: The subscription_name of this EmailTokenization. # noqa: E501 + :type: str + """ + + self._subscription_name = subscription_name + + @property + def product_rate_plan_name(self): + """Gets the product_rate_plan_name of this EmailTokenization. # noqa: E501 + + + :return: The product_rate_plan_name of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_name + + @product_rate_plan_name.setter + def product_rate_plan_name(self, product_rate_plan_name): + """Sets the product_rate_plan_name of this EmailTokenization. + + + :param product_rate_plan_name: The product_rate_plan_name of this EmailTokenization. # noqa: E501 + :type: str + """ + + self._product_rate_plan_name = product_rate_plan_name + + @property + def invoice_id(self): + """Gets the invoice_id of this EmailTokenization. # noqa: E501 + + + :return: The invoice_id of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this EmailTokenization. + + + :param invoice_id: The invoice_id of this EmailTokenization. # noqa: E501 + :type: str + """ + + self._invoice_id = invoice_id + + @property + def invoice_version_id(self): + """Gets the invoice_version_id of this EmailTokenization. # noqa: E501 + + + :return: The invoice_version_id of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._invoice_version_id + + @invoice_version_id.setter + def invoice_version_id(self, invoice_version_id): + """Sets the invoice_version_id of this EmailTokenization. + + + :param invoice_version_id: The invoice_version_id of this EmailTokenization. # noqa: E501 + :type: str + """ + + self._invoice_version_id = invoice_version_id + + @property + def logo_url(self): + """Gets the logo_url of this EmailTokenization. # noqa: E501 + + + :return: The logo_url of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._logo_url + + @logo_url.setter + def logo_url(self, logo_url): + """Sets the logo_url of this EmailTokenization. + + + :param logo_url: The logo_url of this EmailTokenization. # noqa: E501 + :type: str + """ + + self._logo_url = logo_url + + @property + def currency(self): + """Gets the currency of this EmailTokenization. # noqa: E501 + + + :return: The currency of this EmailTokenization. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this EmailTokenization. + + + :param currency: The currency of this EmailTokenization. # noqa: E501 + :type: CreditNoteCurrency + """ + + self._currency = currency + + @property + def amount(self): + """Gets the amount of this EmailTokenization. # noqa: E501 + + + :return: The amount of this EmailTokenization. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this EmailTokenization. + + + :param amount: The amount of this EmailTokenization. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def last_sent(self): + """Gets the last_sent of this EmailTokenization. # noqa: E501 + + + :return: The last_sent of this EmailTokenization. # noqa: E501 + :rtype: datetime + """ + return self._last_sent + + @last_sent.setter + def last_sent(self, last_sent): + """Sets the last_sent of this EmailTokenization. + + + :param last_sent: The last_sent of this EmailTokenization. # noqa: E501 + :type: datetime + """ + + self._last_sent = last_sent + + @property + def valid_till(self): + """Gets the valid_till of this EmailTokenization. # noqa: E501 + + + :return: The valid_till of this EmailTokenization. # noqa: E501 + :rtype: datetime + """ + return self._valid_till + + @valid_till.setter + def valid_till(self, valid_till): + """Sets the valid_till of this EmailTokenization. + + + :param valid_till: The valid_till of this EmailTokenization. # noqa: E501 + :type: datetime + """ + if valid_till is None: + raise ValueError("Invalid value for `valid_till`, must not be `None`") # noqa: E501 + + self._valid_till = valid_till + + @property + def payment_method_id(self): + """Gets the payment_method_id of this EmailTokenization. # noqa: E501 + + + :return: The payment_method_id of this EmailTokenization. # noqa: E501 + :rtype: str + """ + return self._payment_method_id + + @payment_method_id.setter + def payment_method_id(self, payment_method_id): + """Sets the payment_method_id of this EmailTokenization. + + + :param payment_method_id: The payment_method_id of this EmailTokenization. # noqa: E501 + :type: str + """ + + self._payment_method_id = payment_method_id + + @property + def make_default(self): + """Gets the make_default of this EmailTokenization. # noqa: E501 + + + :return: The make_default of this EmailTokenization. # noqa: E501 + :rtype: bool + """ + return self._make_default + + @make_default.setter + def make_default(self, make_default): + """Sets the make_default of this EmailTokenization. + + + :param make_default: The make_default of this EmailTokenization. # noqa: E501 + :type: bool + """ + + self._make_default = make_default + + @property + def charge_immediately(self): + """Gets the charge_immediately of this EmailTokenization. # noqa: E501 + + + :return: The charge_immediately of this EmailTokenization. # noqa: E501 + :rtype: bool + """ + return self._charge_immediately + + @charge_immediately.setter + def charge_immediately(self, charge_immediately): + """Sets the charge_immediately of this EmailTokenization. + + + :param charge_immediately: The charge_immediately of this EmailTokenization. # noqa: E501 + :type: bool + """ + + self._charge_immediately = charge_immediately + + @property + def capture_profile(self): + """Gets the capture_profile of this EmailTokenization. # noqa: E501 + + + :return: The capture_profile of this EmailTokenization. # noqa: E501 + :rtype: bool + """ + return self._capture_profile + + @capture_profile.setter + def capture_profile(self, capture_profile): + """Sets the capture_profile of this EmailTokenization. + + + :param capture_profile: The capture_profile of this EmailTokenization. # noqa: E501 + :type: bool + """ + + self._capture_profile = capture_profile + + @property + def capture_billing_address(self): + """Gets the capture_billing_address of this EmailTokenization. # noqa: E501 + + + :return: The capture_billing_address of this EmailTokenization. # noqa: E501 + :rtype: bool + """ + return self._capture_billing_address + + @capture_billing_address.setter + def capture_billing_address(self, capture_billing_address): + """Sets the capture_billing_address of this EmailTokenization. + + + :param capture_billing_address: The capture_billing_address of this EmailTokenization. # noqa: E501 + :type: bool + """ + + self._capture_billing_address = capture_billing_address + + @property + def capture_shipping_address(self): + """Gets the capture_shipping_address of this EmailTokenization. # noqa: E501 + + + :return: The capture_shipping_address of this EmailTokenization. # noqa: E501 + :rtype: bool + """ + return self._capture_shipping_address + + @capture_shipping_address.setter + def capture_shipping_address(self, capture_shipping_address): + """Sets the capture_shipping_address of this EmailTokenization. + + + :param capture_shipping_address: The capture_shipping_address of this EmailTokenization. # noqa: E501 + :type: bool + """ + + self._capture_shipping_address = capture_shipping_address + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EmailTokenization, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EmailTokenization): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/email_tokenization_create_api_request.py b/billforward/models/email_tokenization_create_api_request.py new file mode 100644 index 0000000..99d38f9 --- /dev/null +++ b/billforward/models/email_tokenization_create_api_request.py @@ -0,0 +1,324 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class EmailTokenizationCreateAPIRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'account_id': 'str', + 'invoice_id': 'str', + 'gateway_type': 'str', + 'make_default': 'bool', + 'charge_immediately': 'bool', + 'capture_profile': 'bool', + 'capture_billing_address': 'bool', + 'capture_shipping_address': 'bool' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'invoice_id': 'invoiceID', + 'gateway_type': 'gatewayType', + 'make_default': 'makeDefault', + 'charge_immediately': 'chargeImmediately', + 'capture_profile': 'captureProfile', + 'capture_billing_address': 'captureBillingAddress', + 'capture_shipping_address': 'captureShippingAddress' + } + + def __init__(self, organization_id=None, account_id=None, invoice_id=None, gateway_type=None, make_default=None, charge_immediately=None, capture_profile=None, capture_billing_address=None, capture_shipping_address=None): # noqa: E501 + """EmailTokenizationCreateAPIRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._account_id = None + self._invoice_id = None + self._gateway_type = None + self._make_default = None + self._charge_immediately = None + self._capture_profile = None + self._capture_billing_address = None + self._capture_shipping_address = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if invoice_id is not None: + self.invoice_id = invoice_id + if gateway_type is not None: + self.gateway_type = gateway_type + if make_default is not None: + self.make_default = make_default + if charge_immediately is not None: + self.charge_immediately = charge_immediately + if capture_profile is not None: + self.capture_profile = capture_profile + if capture_billing_address is not None: + self.capture_billing_address = capture_billing_address + if capture_shipping_address is not None: + self.capture_shipping_address = capture_shipping_address + + @property + def organization_id(self): + """Gets the organization_id of this EmailTokenizationCreateAPIRequest. # noqa: E501 + + + :return: The organization_id of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this EmailTokenizationCreateAPIRequest. + + + :param organization_id: The organization_id of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_id(self): + """Gets the account_id of this EmailTokenizationCreateAPIRequest. # noqa: E501 + + + :return: The account_id of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this EmailTokenizationCreateAPIRequest. + + + :param account_id: The account_id of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def invoice_id(self): + """Gets the invoice_id of this EmailTokenizationCreateAPIRequest. # noqa: E501 + + + :return: The invoice_id of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this EmailTokenizationCreateAPIRequest. + + + :param invoice_id: The invoice_id of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :type: str + """ + + self._invoice_id = invoice_id + + @property + def gateway_type(self): + """Gets the gateway_type of this EmailTokenizationCreateAPIRequest. # noqa: E501 + + + :return: The gateway_type of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :rtype: str + """ + return self._gateway_type + + @gateway_type.setter + def gateway_type(self, gateway_type): + """Sets the gateway_type of this EmailTokenizationCreateAPIRequest. + + + :param gateway_type: The gateway_type of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Stripe", "StripeACH", "GoCardless", "Shuttle", "CardConnect", "EBANX"] # noqa: E501 + if gateway_type not in allowed_values: + raise ValueError( + "Invalid value for `gateway_type` ({0}), must be one of {1}" # noqa: E501 + .format(gateway_type, allowed_values) + ) + + self._gateway_type = gateway_type + + @property + def make_default(self): + """Gets the make_default of this EmailTokenizationCreateAPIRequest. # noqa: E501 + + + :return: The make_default of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :rtype: bool + """ + return self._make_default + + @make_default.setter + def make_default(self, make_default): + """Sets the make_default of this EmailTokenizationCreateAPIRequest. + + + :param make_default: The make_default of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :type: bool + """ + + self._make_default = make_default + + @property + def charge_immediately(self): + """Gets the charge_immediately of this EmailTokenizationCreateAPIRequest. # noqa: E501 + + + :return: The charge_immediately of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :rtype: bool + """ + return self._charge_immediately + + @charge_immediately.setter + def charge_immediately(self, charge_immediately): + """Sets the charge_immediately of this EmailTokenizationCreateAPIRequest. + + + :param charge_immediately: The charge_immediately of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :type: bool + """ + + self._charge_immediately = charge_immediately + + @property + def capture_profile(self): + """Gets the capture_profile of this EmailTokenizationCreateAPIRequest. # noqa: E501 + + + :return: The capture_profile of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :rtype: bool + """ + return self._capture_profile + + @capture_profile.setter + def capture_profile(self, capture_profile): + """Sets the capture_profile of this EmailTokenizationCreateAPIRequest. + + + :param capture_profile: The capture_profile of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :type: bool + """ + + self._capture_profile = capture_profile + + @property + def capture_billing_address(self): + """Gets the capture_billing_address of this EmailTokenizationCreateAPIRequest. # noqa: E501 + + + :return: The capture_billing_address of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :rtype: bool + """ + return self._capture_billing_address + + @capture_billing_address.setter + def capture_billing_address(self, capture_billing_address): + """Sets the capture_billing_address of this EmailTokenizationCreateAPIRequest. + + + :param capture_billing_address: The capture_billing_address of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :type: bool + """ + + self._capture_billing_address = capture_billing_address + + @property + def capture_shipping_address(self): + """Gets the capture_shipping_address of this EmailTokenizationCreateAPIRequest. # noqa: E501 + + + :return: The capture_shipping_address of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :rtype: bool + """ + return self._capture_shipping_address + + @capture_shipping_address.setter + def capture_shipping_address(self, capture_shipping_address): + """Sets the capture_shipping_address of this EmailTokenizationCreateAPIRequest. + + + :param capture_shipping_address: The capture_shipping_address of this EmailTokenizationCreateAPIRequest. # noqa: E501 + :type: bool + """ + + self._capture_shipping_address = capture_shipping_address + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EmailTokenizationCreateAPIRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EmailTokenizationCreateAPIRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/email_tokenization_send_api_request.py b/billforward/models/email_tokenization_send_api_request.py new file mode 100644 index 0000000..70d23f8 --- /dev/null +++ b/billforward/models/email_tokenization_send_api_request.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class EmailTokenizationSendAPIRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str' + } + + attribute_map = { + 'organization_id': 'organizationID' + } + + def __init__(self, organization_id=None): # noqa: E501 + """EmailTokenizationSendAPIRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + + @property + def organization_id(self): + """Gets the organization_id of this EmailTokenizationSendAPIRequest. # noqa: E501 + + + :return: The organization_id of this EmailTokenizationSendAPIRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this EmailTokenizationSendAPIRequest. + + + :param organization_id: The organization_id of this EmailTokenizationSendAPIRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EmailTokenizationSendAPIRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EmailTokenizationSendAPIRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/email_tokenization_update_api_request.py b/billforward/models/email_tokenization_update_api_request.py new file mode 100644 index 0000000..82a4823 --- /dev/null +++ b/billforward/models/email_tokenization_update_api_request.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class EmailTokenizationUpdateAPIRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'valid_till': 'datetime' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'valid_till': 'validTill' + } + + def __init__(self, organization_id=None, valid_till=None): # noqa: E501 + """EmailTokenizationUpdateAPIRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._valid_till = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if valid_till is not None: + self.valid_till = valid_till + + @property + def organization_id(self): + """Gets the organization_id of this EmailTokenizationUpdateAPIRequest. # noqa: E501 + + + :return: The organization_id of this EmailTokenizationUpdateAPIRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this EmailTokenizationUpdateAPIRequest. + + + :param organization_id: The organization_id of this EmailTokenizationUpdateAPIRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def valid_till(self): + """Gets the valid_till of this EmailTokenizationUpdateAPIRequest. # noqa: E501 + + + :return: The valid_till of this EmailTokenizationUpdateAPIRequest. # noqa: E501 + :rtype: datetime + """ + return self._valid_till + + @valid_till.setter + def valid_till(self, valid_till): + """Sets the valid_till of this EmailTokenizationUpdateAPIRequest. + + + :param valid_till: The valid_till of this EmailTokenizationUpdateAPIRequest. # noqa: E501 + :type: datetime + """ + + self._valid_till = valid_till + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EmailTokenizationUpdateAPIRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EmailTokenizationUpdateAPIRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/end_trial_amendment.py b/billforward/models/end_trial_amendment.py index e874334..cb203e7 100644 --- a/billforward/models/end_trial_amendment.py +++ b/billforward/models/end_trial_amendment.py @@ -1,389 +1,53 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class EndTrialAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class EndTrialAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False): - """ - EndTrialAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - - @property - def created(self): - """ - Gets the created of this EndTrialAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this EndTrialAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this EndTrialAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this EndTrialAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this EndTrialAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this EndTrialAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this EndTrialAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this EndTrialAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this EndTrialAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this EndTrialAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this EndTrialAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this EndTrialAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this EndTrialAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this EndTrialAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this EndTrialAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this EndTrialAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def id(self): - """ - Gets the id of this EndTrialAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this EndTrialAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this EndTrialAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this EndTrialAmendment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this EndTrialAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this EndTrialAmendment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this EndTrialAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this EndTrialAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this EndTrialAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this EndTrialAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this EndTrialAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this EndTrialAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this EndTrialAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this EndTrialAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this EndTrialAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this EndTrialAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this EndTrialAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this EndTrialAmendment. - :rtype: datetime - """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this EndTrialAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actioning_time: The actioning_time of this EndTrialAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this EndTrialAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this EndTrialAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this EndTrialAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :param actioned_time: The actioned_time of this EndTrialAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this EndTrialAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this EndTrialAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this EndTrialAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this EndTrialAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this EndTrialAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this EndTrialAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this EndTrialAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) - :param deleted: The deleted of this EndTrialAmendment. - :type: bool - """ + attribute_map = { + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) - self._deleted = deleted + def __init__(self, *args, **kwargs): # noqa: E501 + """EndTrialAmendment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Amendment.__init__(self, *args, **kwargs) def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -400,29 +64,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(EndTrialAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, EndTrialAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/epx_capture_request.py b/billforward/models/epx_capture_request.py new file mode 100644 index 0000000..466f3ec --- /dev/null +++ b/billforward/models/epx_capture_request.py @@ -0,0 +1,786 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class EpxCaptureRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'account_id': 'str', + 'tran_type': 'str', + 'auth_guid': 'str', + 'auth_resp': 'str', + 'auth_code': 'str', + 'auth_resp_text': 'str', + 'auth_card_type': 'str', + 'auth_amount_requested': 'str', + 'auth_amount': 'str', + 'auth_currency_code': 'str', + 'auth_masked_account_nbr': 'str', + 'first_name': 'str', + 'last_name': 'str', + 'exp_date': 'str', + 'bp_resp_code': 'str', + 'bp_resp_text': 'str', + 'bp_fields_errors': 'str', + 'network_response': 'str', + 'cust_nbr': 'str', + 'merch_nbr': 'str', + 'dba_nbr': 'str', + 'terminal_nbr': 'str', + 'created': 'datetime', + 'organization_id': 'str', + 'account_id': 'str', + 'default_payment_method': 'bool', + 'formatted_error_message': 'str' + } + + attribute_map = { + 'account_id': 'accountId', + 'tran_type': 'tranType', + 'auth_guid': 'authGuid', + 'auth_resp': 'authResp', + 'auth_code': 'authCode', + 'auth_resp_text': 'authRespText', + 'auth_card_type': 'authCardType', + 'auth_amount_requested': 'authAmountRequested', + 'auth_amount': 'authAmount', + 'auth_currency_code': 'authCurrencyCode', + 'auth_masked_account_nbr': 'authMaskedAccountNbr', + 'first_name': 'firstName', + 'last_name': 'lastName', + 'exp_date': 'expDate', + 'bp_resp_code': 'bpRespCode', + 'bp_resp_text': 'bpRespText', + 'bp_fields_errors': 'bpFieldsErrors', + 'network_response': 'networkResponse', + 'cust_nbr': 'custNbr', + 'merch_nbr': 'merchNbr', + 'dba_nbr': 'dbaNbr', + 'terminal_nbr': 'terminalNbr', + 'created': 'created', + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'default_payment_method': 'defaultPaymentMethod', + 'formatted_error_message': 'formattedErrorMessage' + } + + def __init__(self, account_id=None, tran_type=None, auth_guid=None, auth_resp=None, auth_code=None, auth_resp_text=None, auth_card_type=None, auth_amount_requested=None, auth_amount=None, auth_currency_code=None, auth_masked_account_nbr=None, first_name=None, last_name=None, exp_date=None, bp_resp_code=None, bp_resp_text=None, bp_fields_errors=None, network_response=None, cust_nbr=None, merch_nbr=None, dba_nbr=None, terminal_nbr=None, created=None, organization_id=None, account_id=None, default_payment_method=None, formatted_error_message=None): # noqa: E501 + """EpxCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._account_id = None + self._tran_type = None + self._auth_guid = None + self._auth_resp = None + self._auth_code = None + self._auth_resp_text = None + self._auth_card_type = None + self._auth_amount_requested = None + self._auth_amount = None + self._auth_currency_code = None + self._auth_masked_account_nbr = None + self._first_name = None + self._last_name = None + self._exp_date = None + self._bp_resp_code = None + self._bp_resp_text = None + self._bp_fields_errors = None + self._network_response = None + self._cust_nbr = None + self._merch_nbr = None + self._dba_nbr = None + self._terminal_nbr = None + self._created = None + self._organization_id = None + self._account_id = None + self._default_payment_method = None + self._formatted_error_message = None + self.discriminator = None + if account_id is not None: + self.account_id = account_id + if tran_type is not None: + self.tran_type = tran_type + if auth_guid is not None: + self.auth_guid = auth_guid + if auth_resp is not None: + self.auth_resp = auth_resp + if auth_code is not None: + self.auth_code = auth_code + if auth_resp_text is not None: + self.auth_resp_text = auth_resp_text + if auth_card_type is not None: + self.auth_card_type = auth_card_type + if auth_amount_requested is not None: + self.auth_amount_requested = auth_amount_requested + if auth_amount is not None: + self.auth_amount = auth_amount + if auth_currency_code is not None: + self.auth_currency_code = auth_currency_code + if auth_masked_account_nbr is not None: + self.auth_masked_account_nbr = auth_masked_account_nbr + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if exp_date is not None: + self.exp_date = exp_date + if bp_resp_code is not None: + self.bp_resp_code = bp_resp_code + if bp_resp_text is not None: + self.bp_resp_text = bp_resp_text + if bp_fields_errors is not None: + self.bp_fields_errors = bp_fields_errors + if network_response is not None: + self.network_response = network_response + if cust_nbr is not None: + self.cust_nbr = cust_nbr + if merch_nbr is not None: + self.merch_nbr = merch_nbr + if dba_nbr is not None: + self.dba_nbr = dba_nbr + if terminal_nbr is not None: + self.terminal_nbr = terminal_nbr + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if default_payment_method is not None: + self.default_payment_method = default_payment_method + if formatted_error_message is not None: + self.formatted_error_message = formatted_error_message + + @property + def account_id(self): + """Gets the account_id of this EpxCaptureRequest. # noqa: E501 + + + :return: The account_id of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this EpxCaptureRequest. + + + :param account_id: The account_id of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def tran_type(self): + """Gets the tran_type of this EpxCaptureRequest. # noqa: E501 + + + :return: The tran_type of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._tran_type + + @tran_type.setter + def tran_type(self, tran_type): + """Sets the tran_type of this EpxCaptureRequest. + + + :param tran_type: The tran_type of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._tran_type = tran_type + + @property + def auth_guid(self): + """Gets the auth_guid of this EpxCaptureRequest. # noqa: E501 + + + :return: The auth_guid of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._auth_guid + + @auth_guid.setter + def auth_guid(self, auth_guid): + """Sets the auth_guid of this EpxCaptureRequest. + + + :param auth_guid: The auth_guid of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._auth_guid = auth_guid + + @property + def auth_resp(self): + """Gets the auth_resp of this EpxCaptureRequest. # noqa: E501 + + + :return: The auth_resp of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._auth_resp + + @auth_resp.setter + def auth_resp(self, auth_resp): + """Sets the auth_resp of this EpxCaptureRequest. + + + :param auth_resp: The auth_resp of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._auth_resp = auth_resp + + @property + def auth_code(self): + """Gets the auth_code of this EpxCaptureRequest. # noqa: E501 + + + :return: The auth_code of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._auth_code + + @auth_code.setter + def auth_code(self, auth_code): + """Sets the auth_code of this EpxCaptureRequest. + + + :param auth_code: The auth_code of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._auth_code = auth_code + + @property + def auth_resp_text(self): + """Gets the auth_resp_text of this EpxCaptureRequest. # noqa: E501 + + + :return: The auth_resp_text of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._auth_resp_text + + @auth_resp_text.setter + def auth_resp_text(self, auth_resp_text): + """Sets the auth_resp_text of this EpxCaptureRequest. + + + :param auth_resp_text: The auth_resp_text of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._auth_resp_text = auth_resp_text + + @property + def auth_card_type(self): + """Gets the auth_card_type of this EpxCaptureRequest. # noqa: E501 + + + :return: The auth_card_type of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._auth_card_type + + @auth_card_type.setter + def auth_card_type(self, auth_card_type): + """Sets the auth_card_type of this EpxCaptureRequest. + + + :param auth_card_type: The auth_card_type of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._auth_card_type = auth_card_type + + @property + def auth_amount_requested(self): + """Gets the auth_amount_requested of this EpxCaptureRequest. # noqa: E501 + + + :return: The auth_amount_requested of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._auth_amount_requested + + @auth_amount_requested.setter + def auth_amount_requested(self, auth_amount_requested): + """Sets the auth_amount_requested of this EpxCaptureRequest. + + + :param auth_amount_requested: The auth_amount_requested of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._auth_amount_requested = auth_amount_requested + + @property + def auth_amount(self): + """Gets the auth_amount of this EpxCaptureRequest. # noqa: E501 + + + :return: The auth_amount of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._auth_amount + + @auth_amount.setter + def auth_amount(self, auth_amount): + """Sets the auth_amount of this EpxCaptureRequest. + + + :param auth_amount: The auth_amount of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._auth_amount = auth_amount + + @property + def auth_currency_code(self): + """Gets the auth_currency_code of this EpxCaptureRequest. # noqa: E501 + + + :return: The auth_currency_code of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._auth_currency_code + + @auth_currency_code.setter + def auth_currency_code(self, auth_currency_code): + """Sets the auth_currency_code of this EpxCaptureRequest. + + + :param auth_currency_code: The auth_currency_code of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._auth_currency_code = auth_currency_code + + @property + def auth_masked_account_nbr(self): + """Gets the auth_masked_account_nbr of this EpxCaptureRequest. # noqa: E501 + + + :return: The auth_masked_account_nbr of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._auth_masked_account_nbr + + @auth_masked_account_nbr.setter + def auth_masked_account_nbr(self, auth_masked_account_nbr): + """Sets the auth_masked_account_nbr of this EpxCaptureRequest. + + + :param auth_masked_account_nbr: The auth_masked_account_nbr of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._auth_masked_account_nbr = auth_masked_account_nbr + + @property + def first_name(self): + """Gets the first_name of this EpxCaptureRequest. # noqa: E501 + + + :return: The first_name of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """Sets the first_name of this EpxCaptureRequest. + + + :param first_name: The first_name of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._first_name = first_name + + @property + def last_name(self): + """Gets the last_name of this EpxCaptureRequest. # noqa: E501 + + + :return: The last_name of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """Sets the last_name of this EpxCaptureRequest. + + + :param last_name: The last_name of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._last_name = last_name + + @property + def exp_date(self): + """Gets the exp_date of this EpxCaptureRequest. # noqa: E501 + + + :return: The exp_date of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._exp_date + + @exp_date.setter + def exp_date(self, exp_date): + """Sets the exp_date of this EpxCaptureRequest. + + + :param exp_date: The exp_date of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._exp_date = exp_date + + @property + def bp_resp_code(self): + """Gets the bp_resp_code of this EpxCaptureRequest. # noqa: E501 + + + :return: The bp_resp_code of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._bp_resp_code + + @bp_resp_code.setter + def bp_resp_code(self, bp_resp_code): + """Sets the bp_resp_code of this EpxCaptureRequest. + + + :param bp_resp_code: The bp_resp_code of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._bp_resp_code = bp_resp_code + + @property + def bp_resp_text(self): + """Gets the bp_resp_text of this EpxCaptureRequest. # noqa: E501 + + + :return: The bp_resp_text of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._bp_resp_text + + @bp_resp_text.setter + def bp_resp_text(self, bp_resp_text): + """Sets the bp_resp_text of this EpxCaptureRequest. + + + :param bp_resp_text: The bp_resp_text of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._bp_resp_text = bp_resp_text + + @property + def bp_fields_errors(self): + """Gets the bp_fields_errors of this EpxCaptureRequest. # noqa: E501 + + + :return: The bp_fields_errors of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._bp_fields_errors + + @bp_fields_errors.setter + def bp_fields_errors(self, bp_fields_errors): + """Sets the bp_fields_errors of this EpxCaptureRequest. + + + :param bp_fields_errors: The bp_fields_errors of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._bp_fields_errors = bp_fields_errors + + @property + def network_response(self): + """Gets the network_response of this EpxCaptureRequest. # noqa: E501 + + + :return: The network_response of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._network_response + + @network_response.setter + def network_response(self, network_response): + """Sets the network_response of this EpxCaptureRequest. + + + :param network_response: The network_response of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._network_response = network_response + + @property + def cust_nbr(self): + """Gets the cust_nbr of this EpxCaptureRequest. # noqa: E501 + + + :return: The cust_nbr of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._cust_nbr + + @cust_nbr.setter + def cust_nbr(self, cust_nbr): + """Sets the cust_nbr of this EpxCaptureRequest. + + + :param cust_nbr: The cust_nbr of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._cust_nbr = cust_nbr + + @property + def merch_nbr(self): + """Gets the merch_nbr of this EpxCaptureRequest. # noqa: E501 + + + :return: The merch_nbr of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._merch_nbr + + @merch_nbr.setter + def merch_nbr(self, merch_nbr): + """Sets the merch_nbr of this EpxCaptureRequest. + + + :param merch_nbr: The merch_nbr of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._merch_nbr = merch_nbr + + @property + def dba_nbr(self): + """Gets the dba_nbr of this EpxCaptureRequest. # noqa: E501 + + + :return: The dba_nbr of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._dba_nbr + + @dba_nbr.setter + def dba_nbr(self, dba_nbr): + """Sets the dba_nbr of this EpxCaptureRequest. + + + :param dba_nbr: The dba_nbr of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._dba_nbr = dba_nbr + + @property + def terminal_nbr(self): + """Gets the terminal_nbr of this EpxCaptureRequest. # noqa: E501 + + + :return: The terminal_nbr of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._terminal_nbr + + @terminal_nbr.setter + def terminal_nbr(self, terminal_nbr): + """Sets the terminal_nbr of this EpxCaptureRequest. + + + :param terminal_nbr: The terminal_nbr of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._terminal_nbr = terminal_nbr + + @property + def created(self): + """Gets the created of this EpxCaptureRequest. # noqa: E501 + + + :return: The created of this EpxCaptureRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this EpxCaptureRequest. + + + :param created: The created of this EpxCaptureRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this EpxCaptureRequest. # noqa: E501 + + + :return: The organization_id of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this EpxCaptureRequest. + + + :param organization_id: The organization_id of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_id(self): + """Gets the account_id of this EpxCaptureRequest. # noqa: E501 + + + :return: The account_id of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this EpxCaptureRequest. + + + :param account_id: The account_id of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def default_payment_method(self): + """Gets the default_payment_method of this EpxCaptureRequest. # noqa: E501 + + + :return: The default_payment_method of this EpxCaptureRequest. # noqa: E501 + :rtype: bool + """ + return self._default_payment_method + + @default_payment_method.setter + def default_payment_method(self, default_payment_method): + """Sets the default_payment_method of this EpxCaptureRequest. + + + :param default_payment_method: The default_payment_method of this EpxCaptureRequest. # noqa: E501 + :type: bool + """ + + self._default_payment_method = default_payment_method + + @property + def formatted_error_message(self): + """Gets the formatted_error_message of this EpxCaptureRequest. # noqa: E501 + + + :return: The formatted_error_message of this EpxCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._formatted_error_message + + @formatted_error_message.setter + def formatted_error_message(self, formatted_error_message): + """Sets the formatted_error_message of this EpxCaptureRequest. + + + :param formatted_error_message: The formatted_error_message of this EpxCaptureRequest. # noqa: E501 + :type: str + """ + + self._formatted_error_message = formatted_error_message + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EpxCaptureRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EpxCaptureRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/epx_configuration.py b/billforward/models/epx_configuration.py new file mode 100644 index 0000000..f54387f --- /dev/null +++ b/billforward/models/epx_configuration.py @@ -0,0 +1,220 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class EpxConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'terminal_nbr': 'str', + 'merch_nbr': 'str', + 'cust_nbr': 'str', + 'mac': 'str', + 'dba_nbr': 'str' + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + 'terminal_nbr': 'terminalNbr', + 'merch_nbr': 'merchNbr', + 'cust_nbr': 'custNbr', + 'mac': 'mac', + 'dba_nbr': 'dbaNbr' + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, terminal_nbr=None, merch_nbr=None, cust_nbr=None, mac=None, dba_nbr=None, *args, **kwargs): # noqa: E501 + """EpxConfiguration - a model defined in Swagger""" # noqa: E501 + self._terminal_nbr = None + self._merch_nbr = None + self._cust_nbr = None + self._mac = None + self._dba_nbr = None + self.discriminator = None + if terminal_nbr is not None: + self.terminal_nbr = terminal_nbr + if merch_nbr is not None: + self.merch_nbr = merch_nbr + if cust_nbr is not None: + self.cust_nbr = cust_nbr + if mac is not None: + self.mac = mac + if dba_nbr is not None: + self.dba_nbr = dba_nbr + APIConfiguration.__init__(self, *args, **kwargs) + + @property + def terminal_nbr(self): + """Gets the terminal_nbr of this EpxConfiguration. # noqa: E501 + + + :return: The terminal_nbr of this EpxConfiguration. # noqa: E501 + :rtype: str + """ + return self._terminal_nbr + + @terminal_nbr.setter + def terminal_nbr(self, terminal_nbr): + """Sets the terminal_nbr of this EpxConfiguration. + + + :param terminal_nbr: The terminal_nbr of this EpxConfiguration. # noqa: E501 + :type: str + """ + + self._terminal_nbr = terminal_nbr + + @property + def merch_nbr(self): + """Gets the merch_nbr of this EpxConfiguration. # noqa: E501 + + + :return: The merch_nbr of this EpxConfiguration. # noqa: E501 + :rtype: str + """ + return self._merch_nbr + + @merch_nbr.setter + def merch_nbr(self, merch_nbr): + """Sets the merch_nbr of this EpxConfiguration. + + + :param merch_nbr: The merch_nbr of this EpxConfiguration. # noqa: E501 + :type: str + """ + + self._merch_nbr = merch_nbr + + @property + def cust_nbr(self): + """Gets the cust_nbr of this EpxConfiguration. # noqa: E501 + + + :return: The cust_nbr of this EpxConfiguration. # noqa: E501 + :rtype: str + """ + return self._cust_nbr + + @cust_nbr.setter + def cust_nbr(self, cust_nbr): + """Sets the cust_nbr of this EpxConfiguration. + + + :param cust_nbr: The cust_nbr of this EpxConfiguration. # noqa: E501 + :type: str + """ + + self._cust_nbr = cust_nbr + + @property + def mac(self): + """Gets the mac of this EpxConfiguration. # noqa: E501 + + + :return: The mac of this EpxConfiguration. # noqa: E501 + :rtype: str + """ + return self._mac + + @mac.setter + def mac(self, mac): + """Sets the mac of this EpxConfiguration. + + + :param mac: The mac of this EpxConfiguration. # noqa: E501 + :type: str + """ + + self._mac = mac + + @property + def dba_nbr(self): + """Gets the dba_nbr of this EpxConfiguration. # noqa: E501 + + + :return: The dba_nbr of this EpxConfiguration. # noqa: E501 + :rtype: str + """ + return self._dba_nbr + + @dba_nbr.setter + def dba_nbr(self, dba_nbr): + """Sets the dba_nbr of this EpxConfiguration. + + + :param dba_nbr: The dba_nbr of this EpxConfiguration. # noqa: E501 + :type: str + """ + + self._dba_nbr = dba_nbr + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EpxConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EpxConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/epx_payment.py b/billforward/models/epx_payment.py new file mode 100644 index 0000000..f2926d8 --- /dev/null +++ b/billforward/models/epx_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class EpxPayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """EpxPayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EpxPayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EpxPayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/epx_pre_auth_request.py b/billforward/models/epx_pre_auth_request.py new file mode 100644 index 0000000..f17bdb8 --- /dev/null +++ b/billforward/models/epx_pre_auth_request.py @@ -0,0 +1,266 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class EpxPreAuthRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'account_id': 'str', + 'default_payment_method': 'bool', + 'location_code': 'str', + 'capture_method': 'str', + 'amount': 'float' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'default_payment_method': 'defaultPaymentMethod', + 'location_code': 'locationCode', + 'capture_method': 'captureMethod', + 'amount': 'amount' + } + + def __init__(self, created=None, organization_id=None, account_id=None, default_payment_method=None, location_code=None, capture_method=None, amount=None): # noqa: E501 + """EpxPreAuthRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._account_id = None + self._default_payment_method = None + self._location_code = None + self._capture_method = None + self._amount = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if default_payment_method is not None: + self.default_payment_method = default_payment_method + if location_code is not None: + self.location_code = location_code + if capture_method is not None: + self.capture_method = capture_method + if amount is not None: + self.amount = amount + + @property + def created(self): + """Gets the created of this EpxPreAuthRequest. # noqa: E501 + + + :return: The created of this EpxPreAuthRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this EpxPreAuthRequest. + + + :param created: The created of this EpxPreAuthRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this EpxPreAuthRequest. # noqa: E501 + + + :return: The organization_id of this EpxPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this EpxPreAuthRequest. + + + :param organization_id: The organization_id of this EpxPreAuthRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_id(self): + """Gets the account_id of this EpxPreAuthRequest. # noqa: E501 + + + :return: The account_id of this EpxPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this EpxPreAuthRequest. + + + :param account_id: The account_id of this EpxPreAuthRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def default_payment_method(self): + """Gets the default_payment_method of this EpxPreAuthRequest. # noqa: E501 + + + :return: The default_payment_method of this EpxPreAuthRequest. # noqa: E501 + :rtype: bool + """ + return self._default_payment_method + + @default_payment_method.setter + def default_payment_method(self, default_payment_method): + """Sets the default_payment_method of this EpxPreAuthRequest. + + + :param default_payment_method: The default_payment_method of this EpxPreAuthRequest. # noqa: E501 + :type: bool + """ + + self._default_payment_method = default_payment_method + + @property + def location_code(self): + """Gets the location_code of this EpxPreAuthRequest. # noqa: E501 + + + :return: The location_code of this EpxPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._location_code + + @location_code.setter + def location_code(self, location_code): + """Sets the location_code of this EpxPreAuthRequest. + + + :param location_code: The location_code of this EpxPreAuthRequest. # noqa: E501 + :type: str + """ + + self._location_code = location_code + + @property + def capture_method(self): + """Gets the capture_method of this EpxPreAuthRequest. # noqa: E501 + + + :return: The capture_method of this EpxPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._capture_method + + @capture_method.setter + def capture_method(self, capture_method): + """Sets the capture_method of this EpxPreAuthRequest. + + + :param capture_method: The capture_method of this EpxPreAuthRequest. # noqa: E501 + :type: str + """ + + self._capture_method = capture_method + + @property + def amount(self): + """Gets the amount of this EpxPreAuthRequest. # noqa: E501 + + + :return: The amount of this EpxPreAuthRequest. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this EpxPreAuthRequest. + + + :param amount: The amount of this EpxPreAuthRequest. # noqa: E501 + :type: float + """ + + self._amount = amount + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EpxPreAuthRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EpxPreAuthRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/epx_pre_auth_response.py b/billforward/models/epx_pre_auth_response.py new file mode 100644 index 0000000..edf6bc0 --- /dev/null +++ b/billforward/models/epx_pre_auth_response.py @@ -0,0 +1,370 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class EpxPreAuthResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'tac': 'str', + 'cust_nbr': 'str', + 'merch_nbr': 'str', + 'dba_nbr': 'str', + 'terminal_nbr': 'str', + 'batch_id': 'str', + 'tran_code': 'str', + 'amount': 'str', + 'currency_code': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'tac': 'tac', + 'cust_nbr': 'custNbr', + 'merch_nbr': 'merchNbr', + 'dba_nbr': 'dbaNbr', + 'terminal_nbr': 'terminalNbr', + 'batch_id': 'batchId', + 'tran_code': 'tranCode', + 'amount': 'amount', + 'currency_code': 'currencyCode' + } + + def __init__(self, created=None, organization_id=None, tac=None, cust_nbr=None, merch_nbr=None, dba_nbr=None, terminal_nbr=None, batch_id=None, tran_code=None, amount=None, currency_code=None): # noqa: E501 + """EpxPreAuthResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._tac = None + self._cust_nbr = None + self._merch_nbr = None + self._dba_nbr = None + self._terminal_nbr = None + self._batch_id = None + self._tran_code = None + self._amount = None + self._currency_code = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if tac is not None: + self.tac = tac + if cust_nbr is not None: + self.cust_nbr = cust_nbr + if merch_nbr is not None: + self.merch_nbr = merch_nbr + if dba_nbr is not None: + self.dba_nbr = dba_nbr + if terminal_nbr is not None: + self.terminal_nbr = terminal_nbr + if batch_id is not None: + self.batch_id = batch_id + if tran_code is not None: + self.tran_code = tran_code + if amount is not None: + self.amount = amount + if currency_code is not None: + self.currency_code = currency_code + + @property + def created(self): + """Gets the created of this EpxPreAuthResponse. # noqa: E501 + + + :return: The created of this EpxPreAuthResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this EpxPreAuthResponse. + + + :param created: The created of this EpxPreAuthResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this EpxPreAuthResponse. # noqa: E501 + + + :return: The organization_id of this EpxPreAuthResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this EpxPreAuthResponse. + + + :param organization_id: The organization_id of this EpxPreAuthResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def tac(self): + """Gets the tac of this EpxPreAuthResponse. # noqa: E501 + + + :return: The tac of this EpxPreAuthResponse. # noqa: E501 + :rtype: str + """ + return self._tac + + @tac.setter + def tac(self, tac): + """Sets the tac of this EpxPreAuthResponse. + + + :param tac: The tac of this EpxPreAuthResponse. # noqa: E501 + :type: str + """ + + self._tac = tac + + @property + def cust_nbr(self): + """Gets the cust_nbr of this EpxPreAuthResponse. # noqa: E501 + + + :return: The cust_nbr of this EpxPreAuthResponse. # noqa: E501 + :rtype: str + """ + return self._cust_nbr + + @cust_nbr.setter + def cust_nbr(self, cust_nbr): + """Sets the cust_nbr of this EpxPreAuthResponse. + + + :param cust_nbr: The cust_nbr of this EpxPreAuthResponse. # noqa: E501 + :type: str + """ + + self._cust_nbr = cust_nbr + + @property + def merch_nbr(self): + """Gets the merch_nbr of this EpxPreAuthResponse. # noqa: E501 + + + :return: The merch_nbr of this EpxPreAuthResponse. # noqa: E501 + :rtype: str + """ + return self._merch_nbr + + @merch_nbr.setter + def merch_nbr(self, merch_nbr): + """Sets the merch_nbr of this EpxPreAuthResponse. + + + :param merch_nbr: The merch_nbr of this EpxPreAuthResponse. # noqa: E501 + :type: str + """ + + self._merch_nbr = merch_nbr + + @property + def dba_nbr(self): + """Gets the dba_nbr of this EpxPreAuthResponse. # noqa: E501 + + + :return: The dba_nbr of this EpxPreAuthResponse. # noqa: E501 + :rtype: str + """ + return self._dba_nbr + + @dba_nbr.setter + def dba_nbr(self, dba_nbr): + """Sets the dba_nbr of this EpxPreAuthResponse. + + + :param dba_nbr: The dba_nbr of this EpxPreAuthResponse. # noqa: E501 + :type: str + """ + + self._dba_nbr = dba_nbr + + @property + def terminal_nbr(self): + """Gets the terminal_nbr of this EpxPreAuthResponse. # noqa: E501 + + + :return: The terminal_nbr of this EpxPreAuthResponse. # noqa: E501 + :rtype: str + """ + return self._terminal_nbr + + @terminal_nbr.setter + def terminal_nbr(self, terminal_nbr): + """Sets the terminal_nbr of this EpxPreAuthResponse. + + + :param terminal_nbr: The terminal_nbr of this EpxPreAuthResponse. # noqa: E501 + :type: str + """ + + self._terminal_nbr = terminal_nbr + + @property + def batch_id(self): + """Gets the batch_id of this EpxPreAuthResponse. # noqa: E501 + + + :return: The batch_id of this EpxPreAuthResponse. # noqa: E501 + :rtype: str + """ + return self._batch_id + + @batch_id.setter + def batch_id(self, batch_id): + """Sets the batch_id of this EpxPreAuthResponse. + + + :param batch_id: The batch_id of this EpxPreAuthResponse. # noqa: E501 + :type: str + """ + + self._batch_id = batch_id + + @property + def tran_code(self): + """Gets the tran_code of this EpxPreAuthResponse. # noqa: E501 + + + :return: The tran_code of this EpxPreAuthResponse. # noqa: E501 + :rtype: str + """ + return self._tran_code + + @tran_code.setter + def tran_code(self, tran_code): + """Sets the tran_code of this EpxPreAuthResponse. + + + :param tran_code: The tran_code of this EpxPreAuthResponse. # noqa: E501 + :type: str + """ + + self._tran_code = tran_code + + @property + def amount(self): + """Gets the amount of this EpxPreAuthResponse. # noqa: E501 + + + :return: The amount of this EpxPreAuthResponse. # noqa: E501 + :rtype: str + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this EpxPreAuthResponse. + + + :param amount: The amount of this EpxPreAuthResponse. # noqa: E501 + :type: str + """ + + self._amount = amount + + @property + def currency_code(self): + """Gets the currency_code of this EpxPreAuthResponse. # noqa: E501 + + + :return: The currency_code of this EpxPreAuthResponse. # noqa: E501 + :rtype: str + """ + return self._currency_code + + @currency_code.setter + def currency_code(self, currency_code): + """Sets the currency_code of this EpxPreAuthResponse. + + + :param currency_code: The currency_code of this EpxPreAuthResponse. # noqa: E501 + :type: str + """ + + self._currency_code = currency_code + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(EpxPreAuthResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, EpxPreAuthResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/event.py b/billforward/models/event.py deleted file mode 100644 index 2a0a2ab..0000000 --- a/billforward/models/event.py +++ /dev/null @@ -1,306 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class Event(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, id=None, type=None, livemode=False, created=None, data=None, request=None, user_id=None, pending_webhooks=None): - """ - Event - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'id': 'str', - 'type': 'str', - 'livemode': 'bool', - 'created': 'int', - 'data': 'EventData', - 'request': 'str', - 'user_id': 'str', - 'pending_webhooks': 'int' - } - - self.attribute_map = { - 'id': 'id', - 'type': 'type', - 'livemode': 'livemode', - 'created': 'created', - 'data': 'data', - 'request': 'request', - 'user_id': 'user_id', - 'pending_webhooks': 'pending_webhooks' - } - - self._id = id - self._type = type - self._livemode = livemode - self._created = created - self._data = data - self._request = request - self._user_id = user_id - self._pending_webhooks = pending_webhooks - - @property - def id(self): - """ - Gets the id of this Event. - - - :return: The id of this Event. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this Event. - - - :param id: The id of this Event. - :type: str - """ - - self._id = id - - @property - def type(self): - """ - Gets the type of this Event. - - - :return: The type of this Event. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this Event. - - - :param type: The type of this Event. - :type: str - """ - - self._type = type - - @property - def livemode(self): - """ - Gets the livemode of this Event. - - - :return: The livemode of this Event. - :rtype: bool - """ - return self._livemode - - @livemode.setter - def livemode(self, livemode): - """ - Sets the livemode of this Event. - - - :param livemode: The livemode of this Event. - :type: bool - """ - - self._livemode = livemode - - @property - def created(self): - """ - Gets the created of this Event. - - - :return: The created of this Event. - :rtype: int - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this Event. - - - :param created: The created of this Event. - :type: int - """ - - self._created = created - - @property - def data(self): - """ - Gets the data of this Event. - - - :return: The data of this Event. - :rtype: EventData - """ - return self._data - - @data.setter - def data(self, data): - """ - Sets the data of this Event. - - - :param data: The data of this Event. - :type: EventData - """ - - self._data = data - - @property - def request(self): - """ - Gets the request of this Event. - - - :return: The request of this Event. - :rtype: str - """ - return self._request - - @request.setter - def request(self, request): - """ - Sets the request of this Event. - - - :param request: The request of this Event. - :type: str - """ - - self._request = request - - @property - def user_id(self): - """ - Gets the user_id of this Event. - - - :return: The user_id of this Event. - :rtype: str - """ - return self._user_id - - @user_id.setter - def user_id(self, user_id): - """ - Sets the user_id of this Event. - - - :param user_id: The user_id of this Event. - :type: str - """ - - self._user_id = user_id - - @property - def pending_webhooks(self): - """ - Gets the pending_webhooks of this Event. - - - :return: The pending_webhooks of this Event. - :rtype: int - """ - return self._pending_webhooks - - @pending_webhooks.setter - def pending_webhooks(self, pending_webhooks): - """ - Sets the pending_webhooks of this Event. - - - :param pending_webhooks: The pending_webhooks of this Event. - :type: int - """ - - self._pending_webhooks = pending_webhooks - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/event_data.py b/billforward/models/event_data.py deleted file mode 100644 index 4e3f14e..0000000 --- a/billforward/models/event_data.py +++ /dev/null @@ -1,150 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class EventData(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, previous_attributes=None, object=None): - """ - EventData - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'previous_attributes': 'dict(str, object)', - 'object': 'StripeObject' - } - - self.attribute_map = { - 'previous_attributes': 'previousAttributes', - 'object': 'object' - } - - self._previous_attributes = previous_attributes - self._object = object - - @property - def previous_attributes(self): - """ - Gets the previous_attributes of this EventData. - - - :return: The previous_attributes of this EventData. - :rtype: dict(str, object) - """ - return self._previous_attributes - - @previous_attributes.setter - def previous_attributes(self, previous_attributes): - """ - Sets the previous_attributes of this EventData. - - - :param previous_attributes: The previous_attributes of this EventData. - :type: dict(str, object) - """ - - self._previous_attributes = previous_attributes - - @property - def object(self): - """ - Gets the object of this EventData. - - - :return: The object of this EventData. - :rtype: StripeObject - """ - return self._object - - @object.setter - def object(self, object): - """ - Sets the object of this EventData. - - - :param object: The object of this EventData. - :type: StripeObject - """ - - self._object = object - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/execution_receipt_response.py b/billforward/models/execution_receipt_response.py new file mode 100644 index 0000000..f4257ba --- /dev/null +++ b/billforward/models/execution_receipt_response.py @@ -0,0 +1,278 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class ExecutionReceiptResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'receipt_id': 'str', + 'gateway_reference_id': 'str', + 'payment_id': 'str', + 'payment_gateway': 'str', + 'decision': 'str', + 'gateway_execution_details': 'str', + 'amount': 'float' + } + + attribute_map = { + 'receipt_id': 'receiptID', + 'gateway_reference_id': 'gatewayReferenceID', + 'payment_id': 'paymentID', + 'payment_gateway': 'paymentGateway', + 'decision': 'decision', + 'gateway_execution_details': 'gatewayExecutionDetails', + 'amount': 'amount' + } + + def __init__(self, receipt_id=None, gateway_reference_id=None, payment_id=None, payment_gateway=None, decision=None, gateway_execution_details=None, amount=None): # noqa: E501 + """ExecutionReceiptResponse - a model defined in Swagger""" # noqa: E501 + self._receipt_id = None + self._gateway_reference_id = None + self._payment_id = None + self._payment_gateway = None + self._decision = None + self._gateway_execution_details = None + self._amount = None + self.discriminator = None + if receipt_id is not None: + self.receipt_id = receipt_id + if gateway_reference_id is not None: + self.gateway_reference_id = gateway_reference_id + if payment_id is not None: + self.payment_id = payment_id + if payment_gateway is not None: + self.payment_gateway = payment_gateway + if decision is not None: + self.decision = decision + if gateway_execution_details is not None: + self.gateway_execution_details = gateway_execution_details + if amount is not None: + self.amount = amount + + @property + def receipt_id(self): + """Gets the receipt_id of this ExecutionReceiptResponse. # noqa: E501 + + + :return: The receipt_id of this ExecutionReceiptResponse. # noqa: E501 + :rtype: str + """ + return self._receipt_id + + @receipt_id.setter + def receipt_id(self, receipt_id): + """Sets the receipt_id of this ExecutionReceiptResponse. + + + :param receipt_id: The receipt_id of this ExecutionReceiptResponse. # noqa: E501 + :type: str + """ + + self._receipt_id = receipt_id + + @property + def gateway_reference_id(self): + """Gets the gateway_reference_id of this ExecutionReceiptResponse. # noqa: E501 + + + :return: The gateway_reference_id of this ExecutionReceiptResponse. # noqa: E501 + :rtype: str + """ + return self._gateway_reference_id + + @gateway_reference_id.setter + def gateway_reference_id(self, gateway_reference_id): + """Sets the gateway_reference_id of this ExecutionReceiptResponse. + + + :param gateway_reference_id: The gateway_reference_id of this ExecutionReceiptResponse. # noqa: E501 + :type: str + """ + + self._gateway_reference_id = gateway_reference_id + + @property + def payment_id(self): + """Gets the payment_id of this ExecutionReceiptResponse. # noqa: E501 + + + :return: The payment_id of this ExecutionReceiptResponse. # noqa: E501 + :rtype: str + """ + return self._payment_id + + @payment_id.setter + def payment_id(self, payment_id): + """Sets the payment_id of this ExecutionReceiptResponse. + + + :param payment_id: The payment_id of this ExecutionReceiptResponse. # noqa: E501 + :type: str + """ + + self._payment_id = payment_id + + @property + def payment_gateway(self): + """Gets the payment_gateway of this ExecutionReceiptResponse. # noqa: E501 + + + :return: The payment_gateway of this ExecutionReceiptResponse. # noqa: E501 + :rtype: str + """ + return self._payment_gateway + + @payment_gateway.setter + def payment_gateway(self, payment_gateway): + """Sets the payment_gateway of this ExecutionReceiptResponse. + + + :param payment_gateway: The payment_gateway of this ExecutionReceiptResponse. # noqa: E501 + :type: str + """ + allowed_values = ["VOID", "cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "zooz", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "goCardless", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash", "epx", "shuttle", "square", "billforwardRandomizer", "cardConnect", "ebanx"] # noqa: E501 + if payment_gateway not in allowed_values: + raise ValueError( + "Invalid value for `payment_gateway` ({0}), must be one of {1}" # noqa: E501 + .format(payment_gateway, allowed_values) + ) + + self._payment_gateway = payment_gateway + + @property + def decision(self): + """Gets the decision of this ExecutionReceiptResponse. # noqa: E501 + + + :return: The decision of this ExecutionReceiptResponse. # noqa: E501 + :rtype: str + """ + return self._decision + + @decision.setter + def decision(self, decision): + """Sets the decision of this ExecutionReceiptResponse. + + + :param decision: The decision of this ExecutionReceiptResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Accept", "Reject", "Pending", "Error"] # noqa: E501 + if decision not in allowed_values: + raise ValueError( + "Invalid value for `decision` ({0}), must be one of {1}" # noqa: E501 + .format(decision, allowed_values) + ) + + self._decision = decision + + @property + def gateway_execution_details(self): + """Gets the gateway_execution_details of this ExecutionReceiptResponse. # noqa: E501 + + + :return: The gateway_execution_details of this ExecutionReceiptResponse. # noqa: E501 + :rtype: str + """ + return self._gateway_execution_details + + @gateway_execution_details.setter + def gateway_execution_details(self, gateway_execution_details): + """Sets the gateway_execution_details of this ExecutionReceiptResponse. + + + :param gateway_execution_details: The gateway_execution_details of this ExecutionReceiptResponse. # noqa: E501 + :type: str + """ + + self._gateway_execution_details = gateway_execution_details + + @property + def amount(self): + """Gets the amount of this ExecutionReceiptResponse. # noqa: E501 + + + :return: The amount of this ExecutionReceiptResponse. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this ExecutionReceiptResponse. + + + :param amount: The amount of this ExecutionReceiptResponse. # noqa: E501 + :type: float + """ + + self._amount = amount + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ExecutionReceiptResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ExecutionReceiptResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/execution_response.py b/billforward/models/execution_response.py new file mode 100644 index 0000000..c394517 --- /dev/null +++ b/billforward/models/execution_response.py @@ -0,0 +1,220 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class ExecutionResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'invoice_id': 'str', + 'invoice_type': 'str', + 'currency': 'CreditNoteCurrency', + 'outstanding_amount': 'float', + 'executions': 'list[ExecutionReceiptResponse]' + } + + attribute_map = { + 'invoice_id': 'invoiceID', + 'invoice_type': 'invoiceType', + 'currency': 'currency', + 'outstanding_amount': 'outstandingAmount', + 'executions': 'executions' + } + + def __init__(self, invoice_id=None, invoice_type=None, currency=None, outstanding_amount=None, executions=None): # noqa: E501 + """ExecutionResponse - a model defined in Swagger""" # noqa: E501 + self._invoice_id = None + self._invoice_type = None + self._currency = None + self._outstanding_amount = None + self._executions = None + self.discriminator = None + if invoice_id is not None: + self.invoice_id = invoice_id + if invoice_type is not None: + self.invoice_type = invoice_type + if currency is not None: + self.currency = currency + if outstanding_amount is not None: + self.outstanding_amount = outstanding_amount + if executions is not None: + self.executions = executions + + @property + def invoice_id(self): + """Gets the invoice_id of this ExecutionResponse. # noqa: E501 + + + :return: The invoice_id of this ExecutionResponse. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this ExecutionResponse. + + + :param invoice_id: The invoice_id of this ExecutionResponse. # noqa: E501 + :type: str + """ + + self._invoice_id = invoice_id + + @property + def invoice_type(self): + """Gets the invoice_type of this ExecutionResponse. # noqa: E501 + + + :return: The invoice_type of this ExecutionResponse. # noqa: E501 + :rtype: str + """ + return self._invoice_type + + @invoice_type.setter + def invoice_type(self, invoice_type): + """Sets the invoice_type of this ExecutionResponse. + + + :param invoice_type: The invoice_type of this ExecutionResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Subscription", "Trial", "Charge", "FinalArrears", "Amendment", "Aggregated", "AffiliateCommission"] # noqa: E501 + if invoice_type not in allowed_values: + raise ValueError( + "Invalid value for `invoice_type` ({0}), must be one of {1}" # noqa: E501 + .format(invoice_type, allowed_values) + ) + + self._invoice_type = invoice_type + + @property + def currency(self): + """Gets the currency of this ExecutionResponse. # noqa: E501 + + + :return: The currency of this ExecutionResponse. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this ExecutionResponse. + + + :param currency: The currency of this ExecutionResponse. # noqa: E501 + :type: CreditNoteCurrency + """ + + self._currency = currency + + @property + def outstanding_amount(self): + """Gets the outstanding_amount of this ExecutionResponse. # noqa: E501 + + + :return: The outstanding_amount of this ExecutionResponse. # noqa: E501 + :rtype: float + """ + return self._outstanding_amount + + @outstanding_amount.setter + def outstanding_amount(self, outstanding_amount): + """Sets the outstanding_amount of this ExecutionResponse. + + + :param outstanding_amount: The outstanding_amount of this ExecutionResponse. # noqa: E501 + :type: float + """ + + self._outstanding_amount = outstanding_amount + + @property + def executions(self): + """Gets the executions of this ExecutionResponse. # noqa: E501 + + + :return: The executions of this ExecutionResponse. # noqa: E501 + :rtype: list[ExecutionReceiptResponse] + """ + return self._executions + + @executions.setter + def executions(self, executions): + """Sets the executions of this ExecutionResponse. + + + :param executions: The executions of this ExecutionResponse. # noqa: E501 + :type: list[ExecutionReceiptResponse] + """ + + self._executions = executions + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ExecutionResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ExecutionResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/extras.py b/billforward/models/extras.py new file mode 100644 index 0000000..d24427d --- /dev/null +++ b/billforward/models/extras.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class Extras(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'square_data': 'SquareData' + } + + attribute_map = { + 'square_data': 'squareData' + } + + def __init__(self, square_data=None): # noqa: E501 + """Extras - a model defined in Swagger""" # noqa: E501 + self._square_data = None + self.discriminator = None + if square_data is not None: + self.square_data = square_data + + @property + def square_data(self): + """Gets the square_data of this Extras. # noqa: E501 + + + :return: The square_data of this Extras. # noqa: E501 + :rtype: SquareData + """ + return self._square_data + + @square_data.setter + def square_data(self, square_data): + """Sets the square_data of this Extras. + + + :param square_data: The square_data of this Extras. # noqa: E501 + :type: SquareData + """ + + self._square_data = square_data + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(Extras, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, Extras): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/file_sham.py b/billforward/models/file_sham.py deleted file mode 100644 index 0703ffd..0000000 --- a/billforward/models/file_sham.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class FileSham(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self): - """ - FileSham - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - - } - - self.attribute_map = { - - } - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/fixed_term.py b/billforward/models/fixed_term.py index f497cfa..cce9bb8 100644 --- a/billforward/models/fixed_term.py +++ b/billforward/models/fixed_term.py @@ -1,121 +1,122 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class FixedTerm(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, subscription_id=None, organization_id=None, fixed_term_definition_id=None, fixed_term_definition=None, expiry_behaviour=None, state=None, product_rate_plan_as_of_time=None, compound_uplift=None, start_time=None, expiry_time=None, periods=None, fixed_term_number=None, deleted=False): - """ - FixedTerm - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'subscription_id': 'str', - 'organization_id': 'str', - 'fixed_term_definition_id': 'str', - 'fixed_term_definition': 'MutableBillingEntity', - 'expiry_behaviour': 'str', - 'state': 'str', - 'product_rate_plan_as_of_time': 'datetime', - 'compound_uplift': 'float', - 'start_time': 'datetime', - 'expiry_time': 'datetime', - 'periods': 'int', - 'fixed_term_number': 'int', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'subscription_id': 'subscriptionID', - 'organization_id': 'organizationID', - 'fixed_term_definition_id': 'fixedTermDefinitionID', - 'fixed_term_definition': 'fixedTermDefinition', - 'expiry_behaviour': 'expiryBehaviour', - 'state': 'state', - 'product_rate_plan_as_of_time': 'productRatePlanAsOfTime', - 'compound_uplift': 'compoundUplift', - 'start_time': 'startTime', - 'expiry_time': 'expiryTime', - 'periods': 'periods', - 'fixed_term_number': 'fixedTermNumber', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._subscription_id = subscription_id - self._organization_id = organization_id - self._fixed_term_definition_id = fixed_term_definition_id - self._fixed_term_definition = fixed_term_definition - self._expiry_behaviour = expiry_behaviour - self._state = state - self._product_rate_plan_as_of_time = product_rate_plan_as_of_time - self._compound_uplift = compound_uplift - self._start_time = start_time - self._expiry_time = expiry_time - self._periods = periods - self._fixed_term_number = fixed_term_number - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'subscription_id': 'str', + 'subscription_version_id': 'str', + 'organization_id': 'str', + 'fixed_term_definition_id': 'str', + 'fixed_term_definition': 'FixedTermDefinition', + 'expiry_behaviour': 'str', + 'periods': 'int', + 'next_product_rate_plan_id': 'str', + 'deleted': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'subscription_id': 'subscriptionID', + 'subscription_version_id': 'subscriptionVersionID', + 'organization_id': 'organizationID', + 'fixed_term_definition_id': 'fixedTermDefinitionID', + 'fixed_term_definition': 'fixedTermDefinition', + 'expiry_behaviour': 'expiryBehaviour', + 'periods': 'periods', + 'next_product_rate_plan_id': 'nextProductRatePlanID', + 'deleted': 'deleted' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, subscription_id=None, subscription_version_id=None, organization_id=None, fixed_term_definition_id=None, fixed_term_definition=None, expiry_behaviour=None, periods=None, next_product_rate_plan_id=None, deleted=None): # noqa: E501 + """FixedTerm - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._subscription_id = None + self._subscription_version_id = None + self._organization_id = None + self._fixed_term_definition_id = None + self._fixed_term_definition = None + self._expiry_behaviour = None + self._periods = None + self._next_product_rate_plan_id = None + self._deleted = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if subscription_id is not None: + self.subscription_id = subscription_id + if subscription_version_id is not None: + self.subscription_version_id = subscription_version_id + if organization_id is not None: + self.organization_id = organization_id + if fixed_term_definition_id is not None: + self.fixed_term_definition_id = fixed_term_definition_id + if fixed_term_definition is not None: + self.fixed_term_definition = fixed_term_definition + self.expiry_behaviour = expiry_behaviour + if periods is not None: + self.periods = periods + if next_product_rate_plan_id is not None: + self.next_product_rate_plan_id = next_product_rate_plan_id + if deleted is not None: + self.deleted = deleted @property def created(self): - """ - Gets the created of this FixedTerm. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this FixedTerm. # noqa: E501 - :return: The created of this FixedTerm. + + :return: The created of this FixedTerm. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this FixedTerm. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this FixedTerm. - :param created: The created of this FixedTerm. + + :param created: The created of this FixedTerm. # noqa: E501 :type: datetime """ @@ -123,22 +124,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this FixedTerm. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this FixedTerm. # noqa: E501 + - :return: The changed_by of this FixedTerm. + :return: The changed_by of this FixedTerm. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this FixedTerm. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this FixedTerm. + - :param changed_by: The changed_by of this FixedTerm. + :param changed_by: The changed_by of this FixedTerm. # noqa: E501 :type: str """ @@ -146,22 +145,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this FixedTerm. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this FixedTerm. # noqa: E501 + - :return: The updated of this FixedTerm. + :return: The updated of this FixedTerm. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this FixedTerm. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this FixedTerm. - :param updated: The updated of this FixedTerm. + + :param updated: The updated of this FixedTerm. # noqa: E501 :type: datetime """ @@ -169,22 +166,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this FixedTerm. - id + """Gets the id of this FixedTerm. # noqa: E501 - :return: The id of this FixedTerm. + + :return: The id of this FixedTerm. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this FixedTerm. - id + """Sets the id of this FixedTerm. - :param id: The id of this FixedTerm. + + :param id: The id of this FixedTerm. # noqa: E501 :type: str """ @@ -192,45 +187,62 @@ def id(self, id): @property def subscription_id(self): - """ - Gets the subscription_id of this FixedTerm. - { \"description\" : \"subscriptionID\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the subscription_id of this FixedTerm. # noqa: E501 - :return: The subscription_id of this FixedTerm. + + :return: The subscription_id of this FixedTerm. # noqa: E501 :rtype: str """ return self._subscription_id @subscription_id.setter def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this FixedTerm. - { \"description\" : \"subscriptionID\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the subscription_id of this FixedTerm. + - :param subscription_id: The subscription_id of this FixedTerm. + :param subscription_id: The subscription_id of this FixedTerm. # noqa: E501 :type: str """ self._subscription_id = subscription_id @property - def organization_id(self): + def subscription_version_id(self): + """Gets the subscription_version_id of this FixedTerm. # noqa: E501 + + + :return: The subscription_version_id of this FixedTerm. # noqa: E501 + :rtype: str + """ + return self._subscription_version_id + + @subscription_version_id.setter + def subscription_version_id(self, subscription_version_id): + """Sets the subscription_version_id of this FixedTerm. + + + :param subscription_version_id: The subscription_version_id of this FixedTerm. # noqa: E501 + :type: str """ - Gets the organization_id of this FixedTerm. - { \"description\" : \"The ID of the organization associated with the amendment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - :return: The organization_id of this FixedTerm. + self._subscription_version_id = subscription_version_id + + @property + def organization_id(self): + """Gets the organization_id of this FixedTerm. # noqa: E501 + + + :return: The organization_id of this FixedTerm. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this FixedTerm. - { \"description\" : \"The ID of the organization associated with the amendment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the organization_id of this FixedTerm. - :param organization_id: The organization_id of this FixedTerm. + + :param organization_id: The organization_id of this FixedTerm. # noqa: E501 :type: str """ @@ -238,22 +250,20 @@ def organization_id(self, organization_id): @property def fixed_term_definition_id(self): - """ - Gets the fixed_term_definition_id of this FixedTerm. - { \"description\" : \"fixedTermDefinitionID\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the fixed_term_definition_id of this FixedTerm. # noqa: E501 - :return: The fixed_term_definition_id of this FixedTerm. + + :return: The fixed_term_definition_id of this FixedTerm. # noqa: E501 :rtype: str """ return self._fixed_term_definition_id @fixed_term_definition_id.setter def fixed_term_definition_id(self, fixed_term_definition_id): - """ - Sets the fixed_term_definition_id of this FixedTerm. - { \"description\" : \"fixedTermDefinitionID\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the fixed_term_definition_id of this FixedTerm. + - :param fixed_term_definition_id: The fixed_term_definition_id of this FixedTerm. + :param fixed_term_definition_id: The fixed_term_definition_id of this FixedTerm. # noqa: E501 :type: str """ @@ -261,253 +271,122 @@ def fixed_term_definition_id(self, fixed_term_definition_id): @property def fixed_term_definition(self): - """ - Gets the fixed_term_definition of this FixedTerm. + """Gets the fixed_term_definition of this FixedTerm. # noqa: E501 - :return: The fixed_term_definition of this FixedTerm. - :rtype: MutableBillingEntity + :return: The fixed_term_definition of this FixedTerm. # noqa: E501 + :rtype: FixedTermDefinition """ return self._fixed_term_definition @fixed_term_definition.setter def fixed_term_definition(self, fixed_term_definition): - """ - Sets the fixed_term_definition of this FixedTerm. + """Sets the fixed_term_definition of this FixedTerm. - :param fixed_term_definition: The fixed_term_definition of this FixedTerm. - :type: MutableBillingEntity + :param fixed_term_definition: The fixed_term_definition of this FixedTerm. # noqa: E501 + :type: FixedTermDefinition """ self._fixed_term_definition = fixed_term_definition @property def expiry_behaviour(self): - """ - Gets the expiry_behaviour of this FixedTerm. - fixedTermExpiryBehaviour + """Gets the expiry_behaviour of this FixedTerm. # noqa: E501 + - :return: The expiry_behaviour of this FixedTerm. + :return: The expiry_behaviour of this FixedTerm. # noqa: E501 :rtype: str """ return self._expiry_behaviour @expiry_behaviour.setter def expiry_behaviour(self, expiry_behaviour): - """ - Sets the expiry_behaviour of this FixedTerm. - fixedTermExpiryBehaviour + """Sets the expiry_behaviour of this FixedTerm. - :param expiry_behaviour: The expiry_behaviour of this FixedTerm. + + :param expiry_behaviour: The expiry_behaviour of this FixedTerm. # noqa: E501 :type: str """ - allowed_values = ["ExpireSubscription", "EvergreenSubscription", "RecurUplift", "RecurLatestPricing"] + if expiry_behaviour is None: + raise ValueError("Invalid value for `expiry_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["ExpireSubscription", "EvergreenSubscription", "RecurLatestPricing", "ChangePlan"] # noqa: E501 if expiry_behaviour not in allowed_values: raise ValueError( - "Invalid value for `expiry_behaviour` ({0}), must be one of {1}" + "Invalid value for `expiry_behaviour` ({0}), must be one of {1}" # noqa: E501 .format(expiry_behaviour, allowed_values) ) self._expiry_behaviour = expiry_behaviour - @property - def state(self): - """ - Gets the state of this FixedTerm. - state - - :return: The state of this FixedTerm. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this FixedTerm. - state - - :param state: The state of this FixedTerm. - :type: str - """ - allowed_values = ["NeedsAmendments", "Active", "Expired"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def product_rate_plan_as_of_time(self): - """ - Gets the product_rate_plan_as_of_time of this FixedTerm. - productRatePlanAsOfTime - - :return: The product_rate_plan_as_of_time of this FixedTerm. - :rtype: datetime - """ - return self._product_rate_plan_as_of_time - - @product_rate_plan_as_of_time.setter - def product_rate_plan_as_of_time(self, product_rate_plan_as_of_time): - """ - Sets the product_rate_plan_as_of_time of this FixedTerm. - productRatePlanAsOfTime - - :param product_rate_plan_as_of_time: The product_rate_plan_as_of_time of this FixedTerm. - :type: datetime - """ - - self._product_rate_plan_as_of_time = product_rate_plan_as_of_time - - @property - def compound_uplift(self): - """ - Gets the compound_uplift of this FixedTerm. - { \"description\" : \"compoundUplift\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] }The proportional INCREASE in price applied every time the fixed terms recur. e.g. 0.03 is a 3% increase. -0.5 is a 50% decrease. 3 is a 300% increase - - :return: The compound_uplift of this FixedTerm. - :rtype: float - """ - return self._compound_uplift - - @compound_uplift.setter - def compound_uplift(self, compound_uplift): - """ - Sets the compound_uplift of this FixedTerm. - { \"description\" : \"compoundUplift\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] }The proportional INCREASE in price applied every time the fixed terms recur. e.g. 0.03 is a 3% increase. -0.5 is a 50% decrease. 3 is a 300% increase - - :param compound_uplift: The compound_uplift of this FixedTerm. - :type: float - """ - - self._compound_uplift = compound_uplift - - @property - def start_time(self): - """ - Gets the start_time of this FixedTerm. - start_time - - :return: The start_time of this FixedTerm. - :rtype: datetime - """ - return self._start_time - - @start_time.setter - def start_time(self, start_time): - """ - Sets the start_time of this FixedTerm. - start_time - - :param start_time: The start_time of this FixedTerm. - :type: datetime - """ - - self._start_time = start_time - - @property - def expiry_time(self): - """ - Gets the expiry_time of this FixedTerm. - expiry_time - - :return: The expiry_time of this FixedTerm. - :rtype: datetime - """ - return self._expiry_time - - @expiry_time.setter - def expiry_time(self, expiry_time): - """ - Sets the expiry_time of this FixedTerm. - expiry_time - - :param expiry_time: The expiry_time of this FixedTerm. - :type: datetime - """ - - self._expiry_time = expiry_time - @property def periods(self): - """ - Gets the periods of this FixedTerm. - { \"description\" : \"The number of billing periods that this fixed term lasts for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the periods of this FixedTerm. # noqa: E501 + - :return: The periods of this FixedTerm. + :return: The periods of this FixedTerm. # noqa: E501 :rtype: int """ return self._periods @periods.setter def periods(self, periods): - """ - Sets the periods of this FixedTerm. - { \"description\" : \"The number of billing periods that this fixed term lasts for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the periods of this FixedTerm. + - :param periods: The periods of this FixedTerm. + :param periods: The periods of this FixedTerm. # noqa: E501 :type: int """ self._periods = periods @property - def fixed_term_number(self): - """ - Gets the fixed_term_number of this FixedTerm. - { \"description\" : \"The number of sequential fixed terms previous to this one for the subscription (i.e. zero indexed 'fixedTermCount').\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + def next_product_rate_plan_id(self): + """Gets the next_product_rate_plan_id of this FixedTerm. # noqa: E501 - :return: The fixed_term_number of this FixedTerm. - :rtype: int - """ - return self._fixed_term_number - @fixed_term_number.setter - def fixed_term_number(self, fixed_term_number): + :return: The next_product_rate_plan_id of this FixedTerm. # noqa: E501 + :rtype: str """ - Sets the fixed_term_number of this FixedTerm. - { \"description\" : \"The number of sequential fixed terms previous to this one for the subscription (i.e. zero indexed 'fixedTermCount').\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + return self._next_product_rate_plan_id - :param fixed_term_number: The fixed_term_number of this FixedTerm. - :type: int + @next_product_rate_plan_id.setter + def next_product_rate_plan_id(self, next_product_rate_plan_id): + """Sets the next_product_rate_plan_id of this FixedTerm. + + + :param next_product_rate_plan_id: The next_product_rate_plan_id of this FixedTerm. # noqa: E501 + :type: str """ - self._fixed_term_number = fixed_term_number + self._next_product_rate_plan_id = next_product_rate_plan_id @property def deleted(self): - """ - Gets the deleted of this FixedTerm. - { \"description\" : \"Is the fixedTerm deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the deleted of this FixedTerm. # noqa: E501 - :return: The deleted of this FixedTerm. + + :return: The deleted of this FixedTerm. # noqa: E501 :rtype: bool """ return self._deleted @deleted.setter def deleted(self, deleted): - """ - Sets the deleted of this FixedTerm. - { \"description\" : \"Is the fixedTerm deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the deleted of this FixedTerm. + - :param deleted: The deleted of this FixedTerm. + :param deleted: The deleted of this FixedTerm. # noqa: E501 :type: bool """ self._deleted = deleted def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -524,29 +403,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(FixedTerm, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, FixedTerm): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/fixed_term_definition.py b/billforward/models/fixed_term_definition.py new file mode 100644 index 0000000..dab72f4 --- /dev/null +++ b/billforward/models/fixed_term_definition.py @@ -0,0 +1,377 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class FixedTermDefinition(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'product_rate_plan_id': 'str', + 'expiry_behaviour': 'str', + 'next_product_rate_plan_id': 'str', + 'first_term_periods': 'int', + 'subsequent_term_periods': 'int', + 'deleted': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'product_rate_plan_id': 'productRatePlanID', + 'expiry_behaviour': 'expiryBehaviour', + 'next_product_rate_plan_id': 'nextProductRatePlanID', + 'first_term_periods': 'firstTermPeriods', + 'subsequent_term_periods': 'subsequentTermPeriods', + 'deleted': 'deleted' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, product_rate_plan_id=None, expiry_behaviour=None, next_product_rate_plan_id=None, first_term_periods=None, subsequent_term_periods=None, deleted=None): # noqa: E501 + """FixedTermDefinition - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._product_rate_plan_id = None + self._expiry_behaviour = None + self._next_product_rate_plan_id = None + self._first_term_periods = None + self._subsequent_term_periods = None + self._deleted = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if product_rate_plan_id is not None: + self.product_rate_plan_id = product_rate_plan_id + self.expiry_behaviour = expiry_behaviour + if next_product_rate_plan_id is not None: + self.next_product_rate_plan_id = next_product_rate_plan_id + if first_term_periods is not None: + self.first_term_periods = first_term_periods + if subsequent_term_periods is not None: + self.subsequent_term_periods = subsequent_term_periods + if deleted is not None: + self.deleted = deleted + + @property + def created(self): + """Gets the created of this FixedTermDefinition. # noqa: E501 + + + :return: The created of this FixedTermDefinition. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this FixedTermDefinition. + + + :param created: The created of this FixedTermDefinition. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this FixedTermDefinition. # noqa: E501 + + + :return: The changed_by of this FixedTermDefinition. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this FixedTermDefinition. + + + :param changed_by: The changed_by of this FixedTermDefinition. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this FixedTermDefinition. # noqa: E501 + + + :return: The updated of this FixedTermDefinition. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this FixedTermDefinition. + + + :param updated: The updated of this FixedTermDefinition. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this FixedTermDefinition. # noqa: E501 + + + :return: The id of this FixedTermDefinition. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this FixedTermDefinition. + + + :param id: The id of this FixedTermDefinition. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this FixedTermDefinition. # noqa: E501 + + + :return: The organization_id of this FixedTermDefinition. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this FixedTermDefinition. + + + :param organization_id: The organization_id of this FixedTermDefinition. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def product_rate_plan_id(self): + """Gets the product_rate_plan_id of this FixedTermDefinition. # noqa: E501 + + + :return: The product_rate_plan_id of this FixedTermDefinition. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_id + + @product_rate_plan_id.setter + def product_rate_plan_id(self, product_rate_plan_id): + """Sets the product_rate_plan_id of this FixedTermDefinition. + + + :param product_rate_plan_id: The product_rate_plan_id of this FixedTermDefinition. # noqa: E501 + :type: str + """ + + self._product_rate_plan_id = product_rate_plan_id + + @property + def expiry_behaviour(self): + """Gets the expiry_behaviour of this FixedTermDefinition. # noqa: E501 + + + :return: The expiry_behaviour of this FixedTermDefinition. # noqa: E501 + :rtype: str + """ + return self._expiry_behaviour + + @expiry_behaviour.setter + def expiry_behaviour(self, expiry_behaviour): + """Sets the expiry_behaviour of this FixedTermDefinition. + + + :param expiry_behaviour: The expiry_behaviour of this FixedTermDefinition. # noqa: E501 + :type: str + """ + if expiry_behaviour is None: + raise ValueError("Invalid value for `expiry_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["ExpireSubscription", "EvergreenSubscription", "RecurLatestPricing", "ChangePlan"] # noqa: E501 + if expiry_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `expiry_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(expiry_behaviour, allowed_values) + ) + + self._expiry_behaviour = expiry_behaviour + + @property + def next_product_rate_plan_id(self): + """Gets the next_product_rate_plan_id of this FixedTermDefinition. # noqa: E501 + + + :return: The next_product_rate_plan_id of this FixedTermDefinition. # noqa: E501 + :rtype: str + """ + return self._next_product_rate_plan_id + + @next_product_rate_plan_id.setter + def next_product_rate_plan_id(self, next_product_rate_plan_id): + """Sets the next_product_rate_plan_id of this FixedTermDefinition. + + + :param next_product_rate_plan_id: The next_product_rate_plan_id of this FixedTermDefinition. # noqa: E501 + :type: str + """ + + self._next_product_rate_plan_id = next_product_rate_plan_id + + @property + def first_term_periods(self): + """Gets the first_term_periods of this FixedTermDefinition. # noqa: E501 + + + :return: The first_term_periods of this FixedTermDefinition. # noqa: E501 + :rtype: int + """ + return self._first_term_periods + + @first_term_periods.setter + def first_term_periods(self, first_term_periods): + """Sets the first_term_periods of this FixedTermDefinition. + + + :param first_term_periods: The first_term_periods of this FixedTermDefinition. # noqa: E501 + :type: int + """ + + self._first_term_periods = first_term_periods + + @property + def subsequent_term_periods(self): + """Gets the subsequent_term_periods of this FixedTermDefinition. # noqa: E501 + + + :return: The subsequent_term_periods of this FixedTermDefinition. # noqa: E501 + :rtype: int + """ + return self._subsequent_term_periods + + @subsequent_term_periods.setter + def subsequent_term_periods(self, subsequent_term_periods): + """Sets the subsequent_term_periods of this FixedTermDefinition. + + + :param subsequent_term_periods: The subsequent_term_periods of this FixedTermDefinition. # noqa: E501 + :type: int + """ + + self._subsequent_term_periods = subsequent_term_periods + + @property + def deleted(self): + """Gets the deleted of this FixedTermDefinition. # noqa: E501 + + + :return: The deleted of this FixedTermDefinition. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this FixedTermDefinition. + + + :param deleted: The deleted of this FixedTermDefinition. # noqa: E501 + :type: bool + """ + + self._deleted = deleted + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(FixedTermDefinition, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, FixedTermDefinition): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/fixed_term_definition_paged_metadata.py b/billforward/models/fixed_term_definition_paged_metadata.py deleted file mode 100644 index b84aa63..0000000 --- a/billforward/models/fixed_term_definition_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class FixedTermDefinitionPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - FixedTermDefinitionPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this FixedTermDefinitionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this FixedTermDefinitionPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this FixedTermDefinitionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this FixedTermDefinitionPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this FixedTermDefinitionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this FixedTermDefinitionPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this FixedTermDefinitionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this FixedTermDefinitionPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this FixedTermDefinitionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this FixedTermDefinitionPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this FixedTermDefinitionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this FixedTermDefinitionPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this FixedTermDefinitionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this FixedTermDefinitionPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this FixedTermDefinitionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this FixedTermDefinitionPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this FixedTermDefinitionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this FixedTermDefinitionPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this FixedTermDefinitionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this FixedTermDefinitionPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this FixedTermDefinitionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this FixedTermDefinitionPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this FixedTermDefinitionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this FixedTermDefinitionPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this FixedTermDefinitionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this FixedTermDefinitionPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this FixedTermDefinitionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this FixedTermDefinitionPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/fixed_term_expiry_amendment.py b/billforward/models/fixed_term_expiry_amendment.py index 5dd0fc2..1f66ff3 100644 --- a/billforward/models/fixed_term_expiry_amendment.py +++ b/billforward/models/fixed_term_expiry_amendment.py @@ -1,415 +1,79 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class FixedTermExpiryAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class FixedTermExpiryAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False, fixed_term_id=None): - """ - FixedTermExpiryAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool', - 'fixed_term_id': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted', - 'fixed_term_id': 'fixedTermID' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - self._fixed_term_id = fixed_term_id - - @property - def created(self): - """ - Gets the created of this FixedTermExpiryAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this FixedTermExpiryAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this FixedTermExpiryAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this FixedTermExpiryAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this FixedTermExpiryAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this FixedTermExpiryAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this FixedTermExpiryAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this FixedTermExpiryAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this FixedTermExpiryAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this FixedTermExpiryAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this FixedTermExpiryAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this FixedTermExpiryAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this FixedTermExpiryAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this FixedTermExpiryAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this FixedTermExpiryAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this FixedTermExpiryAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def id(self): - """ - Gets the id of this FixedTermExpiryAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this FixedTermExpiryAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this FixedTermExpiryAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this FixedTermExpiryAmendment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this FixedTermExpiryAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this FixedTermExpiryAmendment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this FixedTermExpiryAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this FixedTermExpiryAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this FixedTermExpiryAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this FixedTermExpiryAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this FixedTermExpiryAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this FixedTermExpiryAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this FixedTermExpiryAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this FixedTermExpiryAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this FixedTermExpiryAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this FixedTermExpiryAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this FixedTermExpiryAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this FixedTermExpiryAmendment. - :rtype: datetime - """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this FixedTermExpiryAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actioning_time: The actioning_time of this FixedTermExpiryAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this FixedTermExpiryAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this FixedTermExpiryAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this FixedTermExpiryAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :param actioned_time: The actioned_time of this FixedTermExpiryAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this FixedTermExpiryAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this FixedTermExpiryAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this FixedTermExpiryAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this FixedTermExpiryAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this FixedTermExpiryAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this FixedTermExpiryAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this FixedTermExpiryAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this FixedTermExpiryAmendment. - :type: bool - """ - - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'fixed_term_id': 'str' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'fixed_term_id': 'fixedTermID' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, fixed_term_id=None, *args, **kwargs): # noqa: E501 + """FixedTermExpiryAmendment - a model defined in Swagger""" # noqa: E501 + self._fixed_term_id = None + self.discriminator = None + if fixed_term_id is not None: + self.fixed_term_id = fixed_term_id + Amendment.__init__(self, *args, **kwargs) @property def fixed_term_id(self): - """ - Gets the fixed_term_id of this FixedTermExpiryAmendment. - { \"description\" : \"ID of the fixed term to be expired by the amendment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the fixed_term_id of this FixedTermExpiryAmendment. # noqa: E501 + - :return: The fixed_term_id of this FixedTermExpiryAmendment. + :return: The fixed_term_id of this FixedTermExpiryAmendment. # noqa: E501 :rtype: str """ return self._fixed_term_id @fixed_term_id.setter def fixed_term_id(self, fixed_term_id): - """ - Sets the fixed_term_id of this FixedTermExpiryAmendment. - { \"description\" : \"ID of the fixed term to be expired by the amendment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the fixed_term_id of this FixedTermExpiryAmendment. - :param fixed_term_id: The fixed_term_id of this FixedTermExpiryAmendment. + + :param fixed_term_id: The fixed_term_id of this FixedTermExpiryAmendment. # noqa: E501 :type: str """ self._fixed_term_id = fixed_term_id def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -426,29 +90,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(FixedTermExpiryAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, FixedTermExpiryAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/fixed_term_paged_metadata.py b/billforward/models/fixed_term_paged_metadata.py deleted file mode 100644 index 56ddb98..0000000 --- a/billforward/models/fixed_term_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class FixedTermPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - FixedTermPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[FixedTerm]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this FixedTermPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this FixedTermPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this FixedTermPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this FixedTermPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this FixedTermPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this FixedTermPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this FixedTermPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this FixedTermPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this FixedTermPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this FixedTermPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this FixedTermPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this FixedTermPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this FixedTermPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this FixedTermPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this FixedTermPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this FixedTermPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this FixedTermPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this FixedTermPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this FixedTermPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this FixedTermPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this FixedTermPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this FixedTermPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this FixedTermPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this FixedTermPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this FixedTermPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this FixedTermPagedMetadata. - :rtype: list[FixedTerm] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this FixedTermPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this FixedTermPagedMetadata. - :type: list[FixedTerm] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/flat_advance_pricing_component.py b/billforward/models/flat_advance_pricing_component.py new file mode 100644 index 0000000..36ea863 --- /dev/null +++ b/billforward/models/flat_advance_pricing_component.py @@ -0,0 +1,330 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class FlatAdvancePricingComponent(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'display_name': 'str', + 'upgrade_mode': 'str', + 'downgrade_mode': 'str', + 'unit': 'str', + 'price': 'float', + 'default_quantity': 'int', + 'tax_code': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'display_name': 'displayName', + 'upgrade_mode': 'upgradeMode', + 'downgrade_mode': 'downgradeMode', + 'unit': 'unit', + 'price': 'price', + 'default_quantity': 'defaultQuantity', + 'tax_code': 'taxCode' + } + + def __init__(self, name=None, description=None, display_name=None, upgrade_mode=None, downgrade_mode=None, unit=None, price=None, default_quantity=None, tax_code=None): # noqa: E501 + """FlatAdvancePricingComponent - a model defined in Swagger""" # noqa: E501 + self._name = None + self._description = None + self._display_name = None + self._upgrade_mode = None + self._downgrade_mode = None + self._unit = None + self._price = None + self._default_quantity = None + self._tax_code = None + self.discriminator = None + if name is not None: + self.name = name + if description is not None: + self.description = description + if display_name is not None: + self.display_name = display_name + if upgrade_mode is not None: + self.upgrade_mode = upgrade_mode + if downgrade_mode is not None: + self.downgrade_mode = downgrade_mode + if unit is not None: + self.unit = unit + if price is not None: + self.price = price + if default_quantity is not None: + self.default_quantity = default_quantity + if tax_code is not None: + self.tax_code = tax_code + + @property + def name(self): + """Gets the name of this FlatAdvancePricingComponent. # noqa: E501 + + + :return: The name of this FlatAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this FlatAdvancePricingComponent. + + + :param name: The name of this FlatAdvancePricingComponent. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this FlatAdvancePricingComponent. # noqa: E501 + + + :return: The description of this FlatAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this FlatAdvancePricingComponent. + + + :param description: The description of this FlatAdvancePricingComponent. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def display_name(self): + """Gets the display_name of this FlatAdvancePricingComponent. # noqa: E501 + + + :return: The display_name of this FlatAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this FlatAdvancePricingComponent. + + + :param display_name: The display_name of this FlatAdvancePricingComponent. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def upgrade_mode(self): + """Gets the upgrade_mode of this FlatAdvancePricingComponent. # noqa: E501 + + + :return: The upgrade_mode of this FlatAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._upgrade_mode + + @upgrade_mode.setter + def upgrade_mode(self, upgrade_mode): + """Sets the upgrade_mode of this FlatAdvancePricingComponent. + + + :param upgrade_mode: The upgrade_mode of this FlatAdvancePricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["immediate", "delayed"] # noqa: E501 + if upgrade_mode not in allowed_values: + raise ValueError( + "Invalid value for `upgrade_mode` ({0}), must be one of {1}" # noqa: E501 + .format(upgrade_mode, allowed_values) + ) + + self._upgrade_mode = upgrade_mode + + @property + def downgrade_mode(self): + """Gets the downgrade_mode of this FlatAdvancePricingComponent. # noqa: E501 + + + :return: The downgrade_mode of this FlatAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._downgrade_mode + + @downgrade_mode.setter + def downgrade_mode(self, downgrade_mode): + """Sets the downgrade_mode of this FlatAdvancePricingComponent. + + + :param downgrade_mode: The downgrade_mode of this FlatAdvancePricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["immediate", "delayed"] # noqa: E501 + if downgrade_mode not in allowed_values: + raise ValueError( + "Invalid value for `downgrade_mode` ({0}), must be one of {1}" # noqa: E501 + .format(downgrade_mode, allowed_values) + ) + + self._downgrade_mode = downgrade_mode + + @property + def unit(self): + """Gets the unit of this FlatAdvancePricingComponent. # noqa: E501 + + + :return: The unit of this FlatAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._unit + + @unit.setter + def unit(self, unit): + """Sets the unit of this FlatAdvancePricingComponent. + + + :param unit: The unit of this FlatAdvancePricingComponent. # noqa: E501 + :type: str + """ + + self._unit = unit + + @property + def price(self): + """Gets the price of this FlatAdvancePricingComponent. # noqa: E501 + + + :return: The price of this FlatAdvancePricingComponent. # noqa: E501 + :rtype: float + """ + return self._price + + @price.setter + def price(self, price): + """Sets the price of this FlatAdvancePricingComponent. + + + :param price: The price of this FlatAdvancePricingComponent. # noqa: E501 + :type: float + """ + + self._price = price + + @property + def default_quantity(self): + """Gets the default_quantity of this FlatAdvancePricingComponent. # noqa: E501 + + + :return: The default_quantity of this FlatAdvancePricingComponent. # noqa: E501 + :rtype: int + """ + return self._default_quantity + + @default_quantity.setter + def default_quantity(self, default_quantity): + """Sets the default_quantity of this FlatAdvancePricingComponent. + + + :param default_quantity: The default_quantity of this FlatAdvancePricingComponent. # noqa: E501 + :type: int + """ + + self._default_quantity = default_quantity + + @property + def tax_code(self): + """Gets the tax_code of this FlatAdvancePricingComponent. # noqa: E501 + + + :return: The tax_code of this FlatAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this FlatAdvancePricingComponent. + + + :param tax_code: The tax_code of this FlatAdvancePricingComponent. # noqa: E501 + :type: str + """ + + self._tax_code = tax_code + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(FlatAdvancePricingComponent, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, FlatAdvancePricingComponent): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/flat_arrears_pricing_component.py b/billforward/models/flat_arrears_pricing_component.py new file mode 100644 index 0000000..4828476 --- /dev/null +++ b/billforward/models/flat_arrears_pricing_component.py @@ -0,0 +1,330 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class FlatArrearsPricingComponent(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'display_name': 'str', + 'upgrade_mode': 'str', + 'downgrade_mode': 'str', + 'unit': 'str', + 'price': 'float', + 'default_quantity': 'int', + 'tax_code': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'display_name': 'displayName', + 'upgrade_mode': 'upgradeMode', + 'downgrade_mode': 'downgradeMode', + 'unit': 'unit', + 'price': 'price', + 'default_quantity': 'defaultQuantity', + 'tax_code': 'taxCode' + } + + def __init__(self, name=None, description=None, display_name=None, upgrade_mode=None, downgrade_mode=None, unit=None, price=None, default_quantity=None, tax_code=None): # noqa: E501 + """FlatArrearsPricingComponent - a model defined in Swagger""" # noqa: E501 + self._name = None + self._description = None + self._display_name = None + self._upgrade_mode = None + self._downgrade_mode = None + self._unit = None + self._price = None + self._default_quantity = None + self._tax_code = None + self.discriminator = None + if name is not None: + self.name = name + if description is not None: + self.description = description + if display_name is not None: + self.display_name = display_name + if upgrade_mode is not None: + self.upgrade_mode = upgrade_mode + if downgrade_mode is not None: + self.downgrade_mode = downgrade_mode + if unit is not None: + self.unit = unit + if price is not None: + self.price = price + if default_quantity is not None: + self.default_quantity = default_quantity + if tax_code is not None: + self.tax_code = tax_code + + @property + def name(self): + """Gets the name of this FlatArrearsPricingComponent. # noqa: E501 + + + :return: The name of this FlatArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this FlatArrearsPricingComponent. + + + :param name: The name of this FlatArrearsPricingComponent. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this FlatArrearsPricingComponent. # noqa: E501 + + + :return: The description of this FlatArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this FlatArrearsPricingComponent. + + + :param description: The description of this FlatArrearsPricingComponent. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def display_name(self): + """Gets the display_name of this FlatArrearsPricingComponent. # noqa: E501 + + + :return: The display_name of this FlatArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this FlatArrearsPricingComponent. + + + :param display_name: The display_name of this FlatArrearsPricingComponent. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def upgrade_mode(self): + """Gets the upgrade_mode of this FlatArrearsPricingComponent. # noqa: E501 + + + :return: The upgrade_mode of this FlatArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._upgrade_mode + + @upgrade_mode.setter + def upgrade_mode(self, upgrade_mode): + """Sets the upgrade_mode of this FlatArrearsPricingComponent. + + + :param upgrade_mode: The upgrade_mode of this FlatArrearsPricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["immediate", "delayed"] # noqa: E501 + if upgrade_mode not in allowed_values: + raise ValueError( + "Invalid value for `upgrade_mode` ({0}), must be one of {1}" # noqa: E501 + .format(upgrade_mode, allowed_values) + ) + + self._upgrade_mode = upgrade_mode + + @property + def downgrade_mode(self): + """Gets the downgrade_mode of this FlatArrearsPricingComponent. # noqa: E501 + + + :return: The downgrade_mode of this FlatArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._downgrade_mode + + @downgrade_mode.setter + def downgrade_mode(self, downgrade_mode): + """Sets the downgrade_mode of this FlatArrearsPricingComponent. + + + :param downgrade_mode: The downgrade_mode of this FlatArrearsPricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["immediate", "delayed"] # noqa: E501 + if downgrade_mode not in allowed_values: + raise ValueError( + "Invalid value for `downgrade_mode` ({0}), must be one of {1}" # noqa: E501 + .format(downgrade_mode, allowed_values) + ) + + self._downgrade_mode = downgrade_mode + + @property + def unit(self): + """Gets the unit of this FlatArrearsPricingComponent. # noqa: E501 + + + :return: The unit of this FlatArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._unit + + @unit.setter + def unit(self, unit): + """Sets the unit of this FlatArrearsPricingComponent. + + + :param unit: The unit of this FlatArrearsPricingComponent. # noqa: E501 + :type: str + """ + + self._unit = unit + + @property + def price(self): + """Gets the price of this FlatArrearsPricingComponent. # noqa: E501 + + + :return: The price of this FlatArrearsPricingComponent. # noqa: E501 + :rtype: float + """ + return self._price + + @price.setter + def price(self, price): + """Sets the price of this FlatArrearsPricingComponent. + + + :param price: The price of this FlatArrearsPricingComponent. # noqa: E501 + :type: float + """ + + self._price = price + + @property + def default_quantity(self): + """Gets the default_quantity of this FlatArrearsPricingComponent. # noqa: E501 + + + :return: The default_quantity of this FlatArrearsPricingComponent. # noqa: E501 + :rtype: int + """ + return self._default_quantity + + @default_quantity.setter + def default_quantity(self, default_quantity): + """Sets the default_quantity of this FlatArrearsPricingComponent. + + + :param default_quantity: The default_quantity of this FlatArrearsPricingComponent. # noqa: E501 + :type: int + """ + + self._default_quantity = default_quantity + + @property + def tax_code(self): + """Gets the tax_code of this FlatArrearsPricingComponent. # noqa: E501 + + + :return: The tax_code of this FlatArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this FlatArrearsPricingComponent. + + + :param tax_code: The tax_code of this FlatArrearsPricingComponent. # noqa: E501 + :type: str + """ + + self._tax_code = tax_code + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(FlatArrearsPricingComponent, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, FlatArrearsPricingComponent): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/flat_pricing_component.py b/billforward/models/flat_pricing_component.py index d7fa74b..e585aee 100644 --- a/billforward/models/flat_pricing_component.py +++ b/billforward/models/flat_pricing_component.py @@ -1,745 +1,53 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.pricing_component import PricingComponent # noqa: F401,E501 + +class FlatPricingComponent(PricingComponent): + """NOTE: This class is auto generated by the swagger code generator program. -class FlatPricingComponent(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, version_id=None, crm_id=None, id=None, product_rate_plan_id=None, unit_of_measure_id=None, organization_id=None, name=None, public_name=None, description=None, charge_type=None, invoicing_type=None, charge_model=None, upgrade_mode=None, downgrade_mode=None, default_quantity=None, min_quantity=None, max_quantity=None, valid_from=None, valid_till=None, tiers=None, unit_of_measure=None): - """ - FlatPricingComponent - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'version_id': 'str', - 'crm_id': 'str', - 'id': 'str', - 'product_rate_plan_id': 'str', - 'unit_of_measure_id': 'str', - 'organization_id': 'str', - 'name': 'str', - 'public_name': 'str', - 'description': 'str', - 'charge_type': 'str', - 'invoicing_type': 'str', - 'charge_model': 'str', - 'upgrade_mode': 'str', - 'downgrade_mode': 'str', - 'default_quantity': 'int', - 'min_quantity': 'int', - 'max_quantity': 'int', - 'valid_from': 'datetime', - 'valid_till': 'datetime', - 'tiers': 'list[PricingComponentTier]', - 'unit_of_measure': 'UnitOfMeasure' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'version_id': 'versionID', - 'crm_id': 'crmID', - 'id': 'id', - 'product_rate_plan_id': 'productRatePlanID', - 'unit_of_measure_id': 'unitOfMeasureID', - 'organization_id': 'organizationID', - 'name': 'name', - 'public_name': 'publicName', - 'description': 'description', - 'charge_type': 'chargeType', - 'invoicing_type': 'invoicingType', - 'charge_model': 'chargeModel', - 'upgrade_mode': 'upgradeMode', - 'downgrade_mode': 'downgradeMode', - 'default_quantity': 'defaultQuantity', - 'min_quantity': 'minQuantity', - 'max_quantity': 'maxQuantity', - 'valid_from': 'validFrom', - 'valid_till': 'validTill', - 'tiers': 'tiers', - 'unit_of_measure': 'unitOfMeasure' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._version_id = version_id - self._crm_id = crm_id - self._id = id - self._product_rate_plan_id = product_rate_plan_id - self._unit_of_measure_id = unit_of_measure_id - self._organization_id = organization_id - self._name = name - self._public_name = public_name - self._description = description - self._charge_type = charge_type - self._invoicing_type = invoicing_type - self._charge_model = charge_model - self._upgrade_mode = upgrade_mode - self._downgrade_mode = downgrade_mode - self._default_quantity = default_quantity - self._min_quantity = min_quantity - self._max_quantity = max_quantity - self._valid_from = valid_from - self._valid_till = valid_till - self._tiers = tiers - self._unit_of_measure = unit_of_measure - - @property - def created(self): - """ - Gets the created of this FlatPricingComponent. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this FlatPricingComponent. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this FlatPricingComponent. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this FlatPricingComponent. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this FlatPricingComponent. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this FlatPricingComponent. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this FlatPricingComponent. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this FlatPricingComponent. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this FlatPricingComponent. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this FlatPricingComponent. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this FlatPricingComponent. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this FlatPricingComponent. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this FlatPricingComponent. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this FlatPricingComponent. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this FlatPricingComponent. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this FlatPricingComponent. - :type: str - """ - allowed_values = ["tieredPricingComponent", "flatPricingComponent", "tieredVolumePricingComponent"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def version_id(self): - """ - Gets the version_id of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The version_id of this FlatPricingComponent. - :rtype: str - """ - return self._version_id - - @version_id.setter - def version_id(self, version_id): - """ - Sets the version_id of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param version_id: The version_id of this FlatPricingComponent. - :type: str - """ - - self._version_id = version_id - - @property - def crm_id(self): - """ - Gets the crm_id of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The crm_id of this FlatPricingComponent. - :rtype: str - """ - return self._crm_id - - @crm_id.setter - def crm_id(self, crm_id): - """ - Sets the crm_id of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param crm_id: The crm_id of this FlatPricingComponent. - :type: str - """ - - self._crm_id = crm_id - - @property - def id(self): - """ - Gets the id of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } When associating a pricing component with a product rate plan, this ID should be used. - - :return: The id of this FlatPricingComponent. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } When associating a pricing component with a product rate plan, this ID should be used. - - :param id: The id of this FlatPricingComponent. - :type: str - """ - - self._id = id - - @property - def product_rate_plan_id(self): - """ - Gets the product_rate_plan_id of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The product_rate_plan_id of this FlatPricingComponent. - :rtype: str - """ - return self._product_rate_plan_id - - @product_rate_plan_id.setter - def product_rate_plan_id(self, product_rate_plan_id): - """ - Sets the product_rate_plan_id of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param product_rate_plan_id: The product_rate_plan_id of this FlatPricingComponent. - :type: str - """ - - self._product_rate_plan_id = product_rate_plan_id - - @property - def unit_of_measure_id(self): - """ - Gets the unit_of_measure_id of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The unit_of_measure_id of this FlatPricingComponent. - :rtype: str - """ - return self._unit_of_measure_id - - @unit_of_measure_id.setter - def unit_of_measure_id(self, unit_of_measure_id): - """ - Sets the unit_of_measure_id of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param unit_of_measure_id: The unit_of_measure_id of this FlatPricingComponent. - :type: str - """ - - self._unit_of_measure_id = unit_of_measure_id - - @property - def organization_id(self): - """ - Gets the organization_id of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[] } - - :return: The organization_id of this FlatPricingComponent. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[] } - - :param organization_id: The organization_id of this FlatPricingComponent. - :type: str - """ - - self._organization_id = organization_id - - @property - def name(self): - """ - Gets the name of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The name of this FlatPricingComponent. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param name: The name of this FlatPricingComponent. - :type: str - """ - - self._name = name - - @property - def public_name(self): - """ - Gets the public_name of this FlatPricingComponent. - {\"description\":\"A friendly non-unique name used to identify this pricing-component\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The public_name of this FlatPricingComponent. - :rtype: str - """ - return self._public_name - - @public_name.setter - def public_name(self, public_name): - """ - Sets the public_name of this FlatPricingComponent. - {\"description\":\"A friendly non-unique name used to identify this pricing-component\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param public_name: The public_name of this FlatPricingComponent. - :type: str - """ - - self._public_name = public_name - - @property - def description(self): - """ - Gets the description of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The description of this FlatPricingComponent. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this FlatPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param description: The description of this FlatPricingComponent. - :type: str - """ - - self._description = description - - @property - def charge_type(self): - """ - Gets the charge_type of this FlatPricingComponent. - { \"description\" : \"The charge type of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The charge_type of this FlatPricingComponent. - :rtype: str - """ - return self._charge_type - - @charge_type.setter - def charge_type(self, charge_type): - """ - Sets the charge_type of this FlatPricingComponent. - { \"description\" : \"The charge type of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param charge_type: The charge_type of this FlatPricingComponent. - :type: str - """ - allowed_values = ["setup", "subscription", "arrears", "usage"] - if charge_type not in allowed_values: - raise ValueError( - "Invalid value for `charge_type` ({0}), must be one of {1}" - .format(charge_type, allowed_values) - ) - - self._charge_type = charge_type - - @property - def invoicing_type(self): - """ - Gets the invoicing_type of this FlatPricingComponent. - { \"default\" : \"Aggregated\", \"description\" : \"For setup pricing components Immediate invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. Aggregated invoicing will add a charge to the first invoice of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The invoicing_type of this FlatPricingComponent. - :rtype: str - """ - return self._invoicing_type - - @invoicing_type.setter - def invoicing_type(self, invoicing_type): - """ - Sets the invoicing_type of this FlatPricingComponent. - { \"default\" : \"Aggregated\", \"description\" : \"For setup pricing components Immediate invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. Aggregated invoicing will add a charge to the first invoice of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param invoicing_type: The invoicing_type of this FlatPricingComponent. - :type: str - """ - allowed_values = ["Immediate", "Aggregated"] - if invoicing_type not in allowed_values: - raise ValueError( - "Invalid value for `invoicing_type` ({0}), must be one of {1}" - .format(invoicing_type, allowed_values) - ) - - self._invoicing_type = invoicing_type - - @property - def charge_model(self): - """ - Gets the charge_model of this FlatPricingComponent. - { \"description\" : \"The charge model of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The charge_model of this FlatPricingComponent. - :rtype: str - """ - return self._charge_model - - @charge_model.setter - def charge_model(self, charge_model): - """ - Sets the charge_model of this FlatPricingComponent. - { \"description\" : \"The charge model of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param charge_model: The charge_model of this FlatPricingComponent. - :type: str - """ - allowed_values = ["flat", "tiered", "tiered_volume"] - if charge_model not in allowed_values: - raise ValueError( - "Invalid value for `charge_model` ({0}), must be one of {1}" - .format(charge_model, allowed_values) - ) - - self._charge_model = charge_model - - @property - def upgrade_mode(self): - """ - Gets the upgrade_mode of this FlatPricingComponent. - {\"default\":\"immediate\",\"description\":\"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Upgrade will apply at the time the request is made.
delayed — Upgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The upgrade_mode of this FlatPricingComponent. - :rtype: str - """ - return self._upgrade_mode - - @upgrade_mode.setter - def upgrade_mode(self, upgrade_mode): - """ - Sets the upgrade_mode of this FlatPricingComponent. - {\"default\":\"immediate\",\"description\":\"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Upgrade will apply at the time the request is made.
delayed — Upgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} - - :param upgrade_mode: The upgrade_mode of this FlatPricingComponent. - :type: str - """ - allowed_values = ["immediate", "delayed"] - if upgrade_mode not in allowed_values: - raise ValueError( - "Invalid value for `upgrade_mode` ({0}), must be one of {1}" - .format(upgrade_mode, allowed_values) - ) - - self._upgrade_mode = upgrade_mode - - @property - def downgrade_mode(self): - """ - Gets the downgrade_mode of this FlatPricingComponent. - {\"default\":\"delayed\",\"description\":\"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Downgrade will apply at the time the request is made.
delayed — Downgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The downgrade_mode of this FlatPricingComponent. - :rtype: str - """ - return self._downgrade_mode - - @downgrade_mode.setter - def downgrade_mode(self, downgrade_mode): - """ - Sets the downgrade_mode of this FlatPricingComponent. - {\"default\":\"delayed\",\"description\":\"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Downgrade will apply at the time the request is made.
delayed — Downgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} - - :param downgrade_mode: The downgrade_mode of this FlatPricingComponent. - :type: str - """ - allowed_values = ["immediate", "delayed"] - if downgrade_mode not in allowed_values: - raise ValueError( - "Invalid value for `downgrade_mode` ({0}), must be one of {1}" - .format(downgrade_mode, allowed_values) - ) - - self._downgrade_mode = downgrade_mode - - @property - def default_quantity(self): - """ - Gets the default_quantity of this FlatPricingComponent. - { \"description\" : \"The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The default_quantity of this FlatPricingComponent. - :rtype: int - """ - return self._default_quantity - - @default_quantity.setter - def default_quantity(self, default_quantity): - """ - Sets the default_quantity of this FlatPricingComponent. - { \"description\" : \"The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param default_quantity: The default_quantity of this FlatPricingComponent. - :type: int - """ - - self._default_quantity = default_quantity - - @property - def min_quantity(self): - """ - Gets the min_quantity of this FlatPricingComponent. - { \"default\" : \"0\", \"description\" : \"The minimum quantity of the pricing-component.\", \"verbs\":[] } - - :return: The min_quantity of this FlatPricingComponent. - :rtype: int - """ - return self._min_quantity - - @min_quantity.setter - def min_quantity(self, min_quantity): - """ - Sets the min_quantity of this FlatPricingComponent. - { \"default\" : \"0\", \"description\" : \"The minimum quantity of the pricing-component.\", \"verbs\":[] } - - :param min_quantity: The min_quantity of this FlatPricingComponent. - :type: int - """ - - self._min_quantity = min_quantity - - @property - def max_quantity(self): - """ - Gets the max_quantity of this FlatPricingComponent. - { \"description\" : \"The maximum quantity of the pricing-component.\", \"verbs\":[] } - - :return: The max_quantity of this FlatPricingComponent. - :rtype: int - """ - return self._max_quantity - - @max_quantity.setter - def max_quantity(self, max_quantity): - """ - Sets the max_quantity of this FlatPricingComponent. - { \"description\" : \"The maximum quantity of the pricing-component.\", \"verbs\":[] } - - :param max_quantity: The max_quantity of this FlatPricingComponent. - :type: int - """ - - self._max_quantity = max_quantity - - @property - def valid_from(self): - """ - Gets the valid_from of this FlatPricingComponent. - { \"default\" : \"current time\", \"description\" : \"The DateTime specifying when the pricing-component is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The valid_from of this FlatPricingComponent. - :rtype: datetime - """ - return self._valid_from - - @valid_from.setter - def valid_from(self, valid_from): - """ - Sets the valid_from of this FlatPricingComponent. - { \"default\" : \"current time\", \"description\" : \"The DateTime specifying when the pricing-component is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param valid_from: The valid_from of this FlatPricingComponent. - :type: datetime - """ - - self._valid_from = valid_from - - @property - def valid_till(self): - """ - Gets the valid_till of this FlatPricingComponent. - { \"default\" : \"null\", \"description\" : \"The UTC DateTime specifying when the pricing-component is valid till.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The valid_till of this FlatPricingComponent. - :rtype: datetime - """ - return self._valid_till - - @valid_till.setter - def valid_till(self, valid_till): - """ - Sets the valid_till of this FlatPricingComponent. - { \"default\" : \"null\", \"description\" : \"The UTC DateTime specifying when the pricing-component is valid till.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param valid_till: The valid_till of this FlatPricingComponent. - :type: datetime - """ - - self._valid_till = valid_till - - @property - def tiers(self): - """ - Gets the tiers of this FlatPricingComponent. - { \"default\" : \"[]\", \"description\" : \"The pricing-component-tiers associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The tiers of this FlatPricingComponent. - :rtype: list[PricingComponentTier] - """ - return self._tiers - - @tiers.setter - def tiers(self, tiers): - """ - Sets the tiers of this FlatPricingComponent. - { \"default\" : \"[]\", \"description\" : \"The pricing-component-tiers associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param tiers: The tiers of this FlatPricingComponent. - :type: list[PricingComponentTier] - """ - - self._tiers = tiers - - @property - def unit_of_measure(self): - """ - Gets the unit_of_measure of this FlatPricingComponent. - { \"description\" : \"The unit-of-measure associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The unit_of_measure of this FlatPricingComponent. - :rtype: UnitOfMeasure - """ - return self._unit_of_measure - - @unit_of_measure.setter - def unit_of_measure(self, unit_of_measure): - """ - Sets the unit_of_measure of this FlatPricingComponent. - { \"description\" : \"The unit-of-measure associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(PricingComponent, "swagger_types"): + swagger_types.update(PricingComponent.swagger_types) - :param unit_of_measure: The unit_of_measure of this FlatPricingComponent. - :type: UnitOfMeasure - """ + attribute_map = { + } + if hasattr(PricingComponent, "attribute_map"): + attribute_map.update(PricingComponent.attribute_map) - self._unit_of_measure = unit_of_measure + def __init__(self, *args, **kwargs): # noqa: E501 + """FlatPricingComponent - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + PricingComponent.__init__(self, *args, **kwargs) def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -756,29 +64,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(FlatPricingComponent, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, FlatPricingComponent): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/flat_setup_pricing_component.py b/billforward/models/flat_setup_pricing_component.py new file mode 100644 index 0000000..a7537b2 --- /dev/null +++ b/billforward/models/flat_setup_pricing_component.py @@ -0,0 +1,298 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class FlatSetupPricingComponent(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'display_name': 'str', + 'unit': 'str', + 'invoicing_type': 'str', + 'price': 'float', + 'default_quantity': 'int', + 'tax_code': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'display_name': 'displayName', + 'unit': 'unit', + 'invoicing_type': 'invoicingType', + 'price': 'price', + 'default_quantity': 'defaultQuantity', + 'tax_code': 'taxCode' + } + + def __init__(self, name=None, description=None, display_name=None, unit=None, invoicing_type=None, price=None, default_quantity=None, tax_code=None): # noqa: E501 + """FlatSetupPricingComponent - a model defined in Swagger""" # noqa: E501 + self._name = None + self._description = None + self._display_name = None + self._unit = None + self._invoicing_type = None + self._price = None + self._default_quantity = None + self._tax_code = None + self.discriminator = None + if name is not None: + self.name = name + if description is not None: + self.description = description + if display_name is not None: + self.display_name = display_name + if unit is not None: + self.unit = unit + if invoicing_type is not None: + self.invoicing_type = invoicing_type + if price is not None: + self.price = price + if default_quantity is not None: + self.default_quantity = default_quantity + if tax_code is not None: + self.tax_code = tax_code + + @property + def name(self): + """Gets the name of this FlatSetupPricingComponent. # noqa: E501 + + + :return: The name of this FlatSetupPricingComponent. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this FlatSetupPricingComponent. + + + :param name: The name of this FlatSetupPricingComponent. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this FlatSetupPricingComponent. # noqa: E501 + + + :return: The description of this FlatSetupPricingComponent. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this FlatSetupPricingComponent. + + + :param description: The description of this FlatSetupPricingComponent. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def display_name(self): + """Gets the display_name of this FlatSetupPricingComponent. # noqa: E501 + + + :return: The display_name of this FlatSetupPricingComponent. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this FlatSetupPricingComponent. + + + :param display_name: The display_name of this FlatSetupPricingComponent. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def unit(self): + """Gets the unit of this FlatSetupPricingComponent. # noqa: E501 + + + :return: The unit of this FlatSetupPricingComponent. # noqa: E501 + :rtype: str + """ + return self._unit + + @unit.setter + def unit(self, unit): + """Sets the unit of this FlatSetupPricingComponent. + + + :param unit: The unit of this FlatSetupPricingComponent. # noqa: E501 + :type: str + """ + + self._unit = unit + + @property + def invoicing_type(self): + """Gets the invoicing_type of this FlatSetupPricingComponent. # noqa: E501 + + + :return: The invoicing_type of this FlatSetupPricingComponent. # noqa: E501 + :rtype: str + """ + return self._invoicing_type + + @invoicing_type.setter + def invoicing_type(self, invoicing_type): + """Sets the invoicing_type of this FlatSetupPricingComponent. + + + :param invoicing_type: The invoicing_type of this FlatSetupPricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 + if invoicing_type not in allowed_values: + raise ValueError( + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 + .format(invoicing_type, allowed_values) + ) + + self._invoicing_type = invoicing_type + + @property + def price(self): + """Gets the price of this FlatSetupPricingComponent. # noqa: E501 + + + :return: The price of this FlatSetupPricingComponent. # noqa: E501 + :rtype: float + """ + return self._price + + @price.setter + def price(self, price): + """Sets the price of this FlatSetupPricingComponent. + + + :param price: The price of this FlatSetupPricingComponent. # noqa: E501 + :type: float + """ + + self._price = price + + @property + def default_quantity(self): + """Gets the default_quantity of this FlatSetupPricingComponent. # noqa: E501 + + + :return: The default_quantity of this FlatSetupPricingComponent. # noqa: E501 + :rtype: int + """ + return self._default_quantity + + @default_quantity.setter + def default_quantity(self, default_quantity): + """Sets the default_quantity of this FlatSetupPricingComponent. + + + :param default_quantity: The default_quantity of this FlatSetupPricingComponent. # noqa: E501 + :type: int + """ + + self._default_quantity = default_quantity + + @property + def tax_code(self): + """Gets the tax_code of this FlatSetupPricingComponent. # noqa: E501 + + + :return: The tax_code of this FlatSetupPricingComponent. # noqa: E501 + :rtype: str + """ + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this FlatSetupPricingComponent. + + + :param tax_code: The tax_code of this FlatSetupPricingComponent. # noqa: E501 + :type: str + """ + + self._tax_code = tax_code + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(FlatSetupPricingComponent, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, FlatSetupPricingComponent): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/flat_usage_pricing_component.py b/billforward/models/flat_usage_pricing_component.py new file mode 100644 index 0000000..7b733d4 --- /dev/null +++ b/billforward/models/flat_usage_pricing_component.py @@ -0,0 +1,304 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class FlatUsagePricingComponent(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'display_name': 'str', + 'upgrade_mode': 'str', + 'downgrade_mode': 'str', + 'unit': 'str', + 'price': 'float', + 'tax_code': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'display_name': 'displayName', + 'upgrade_mode': 'upgradeMode', + 'downgrade_mode': 'downgradeMode', + 'unit': 'unit', + 'price': 'price', + 'tax_code': 'taxCode' + } + + def __init__(self, name=None, description=None, display_name=None, upgrade_mode=None, downgrade_mode=None, unit=None, price=None, tax_code=None): # noqa: E501 + """FlatUsagePricingComponent - a model defined in Swagger""" # noqa: E501 + self._name = None + self._description = None + self._display_name = None + self._upgrade_mode = None + self._downgrade_mode = None + self._unit = None + self._price = None + self._tax_code = None + self.discriminator = None + if name is not None: + self.name = name + if description is not None: + self.description = description + if display_name is not None: + self.display_name = display_name + if upgrade_mode is not None: + self.upgrade_mode = upgrade_mode + if downgrade_mode is not None: + self.downgrade_mode = downgrade_mode + if unit is not None: + self.unit = unit + if price is not None: + self.price = price + if tax_code is not None: + self.tax_code = tax_code + + @property + def name(self): + """Gets the name of this FlatUsagePricingComponent. # noqa: E501 + + + :return: The name of this FlatUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this FlatUsagePricingComponent. + + + :param name: The name of this FlatUsagePricingComponent. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this FlatUsagePricingComponent. # noqa: E501 + + + :return: The description of this FlatUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this FlatUsagePricingComponent. + + + :param description: The description of this FlatUsagePricingComponent. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def display_name(self): + """Gets the display_name of this FlatUsagePricingComponent. # noqa: E501 + + + :return: The display_name of this FlatUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this FlatUsagePricingComponent. + + + :param display_name: The display_name of this FlatUsagePricingComponent. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def upgrade_mode(self): + """Gets the upgrade_mode of this FlatUsagePricingComponent. # noqa: E501 + + + :return: The upgrade_mode of this FlatUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._upgrade_mode + + @upgrade_mode.setter + def upgrade_mode(self, upgrade_mode): + """Sets the upgrade_mode of this FlatUsagePricingComponent. + + + :param upgrade_mode: The upgrade_mode of this FlatUsagePricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["immediate", "delayed"] # noqa: E501 + if upgrade_mode not in allowed_values: + raise ValueError( + "Invalid value for `upgrade_mode` ({0}), must be one of {1}" # noqa: E501 + .format(upgrade_mode, allowed_values) + ) + + self._upgrade_mode = upgrade_mode + + @property + def downgrade_mode(self): + """Gets the downgrade_mode of this FlatUsagePricingComponent. # noqa: E501 + + + :return: The downgrade_mode of this FlatUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._downgrade_mode + + @downgrade_mode.setter + def downgrade_mode(self, downgrade_mode): + """Sets the downgrade_mode of this FlatUsagePricingComponent. + + + :param downgrade_mode: The downgrade_mode of this FlatUsagePricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["immediate", "delayed"] # noqa: E501 + if downgrade_mode not in allowed_values: + raise ValueError( + "Invalid value for `downgrade_mode` ({0}), must be one of {1}" # noqa: E501 + .format(downgrade_mode, allowed_values) + ) + + self._downgrade_mode = downgrade_mode + + @property + def unit(self): + """Gets the unit of this FlatUsagePricingComponent. # noqa: E501 + + + :return: The unit of this FlatUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._unit + + @unit.setter + def unit(self, unit): + """Sets the unit of this FlatUsagePricingComponent. + + + :param unit: The unit of this FlatUsagePricingComponent. # noqa: E501 + :type: str + """ + + self._unit = unit + + @property + def price(self): + """Gets the price of this FlatUsagePricingComponent. # noqa: E501 + + + :return: The price of this FlatUsagePricingComponent. # noqa: E501 + :rtype: float + """ + return self._price + + @price.setter + def price(self, price): + """Sets the price of this FlatUsagePricingComponent. + + + :param price: The price of this FlatUsagePricingComponent. # noqa: E501 + :type: float + """ + + self._price = price + + @property + def tax_code(self): + """Gets the tax_code of this FlatUsagePricingComponent. # noqa: E501 + + + :return: The tax_code of this FlatUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this FlatUsagePricingComponent. + + + :param tax_code: The tax_code of this FlatUsagePricingComponent. # noqa: E501 + :type: str + """ + + self._tax_code = tax_code + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(FlatUsagePricingComponent, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, FlatUsagePricingComponent): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/get_rate_plan_affiliate_response.py b/billforward/models/get_rate_plan_affiliate_response.py new file mode 100644 index 0000000..624872c --- /dev/null +++ b/billforward/models/get_rate_plan_affiliate_response.py @@ -0,0 +1,292 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class GetRatePlanAffiliateResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'id': 'str', + 'product_rate_plan_id': 'str', + 'account_id': 'str', + 'start_date': 'datetime', + 'end_date': 'datetime', + 'commission_structure': 'CommissionStructure' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'id': 'id', + 'product_rate_plan_id': 'productRatePlanID', + 'account_id': 'accountID', + 'start_date': 'startDate', + 'end_date': 'endDate', + 'commission_structure': 'commissionStructure' + } + + def __init__(self, created=None, organization_id=None, id=None, product_rate_plan_id=None, account_id=None, start_date=None, end_date=None, commission_structure=None): # noqa: E501 + """GetRatePlanAffiliateResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._id = None + self._product_rate_plan_id = None + self._account_id = None + self._start_date = None + self._end_date = None + self._commission_structure = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if id is not None: + self.id = id + if product_rate_plan_id is not None: + self.product_rate_plan_id = product_rate_plan_id + if account_id is not None: + self.account_id = account_id + if start_date is not None: + self.start_date = start_date + if end_date is not None: + self.end_date = end_date + if commission_structure is not None: + self.commission_structure = commission_structure + + @property + def created(self): + """Gets the created of this GetRatePlanAffiliateResponse. # noqa: E501 + + + :return: The created of this GetRatePlanAffiliateResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this GetRatePlanAffiliateResponse. + + + :param created: The created of this GetRatePlanAffiliateResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this GetRatePlanAffiliateResponse. # noqa: E501 + + + :return: The organization_id of this GetRatePlanAffiliateResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this GetRatePlanAffiliateResponse. + + + :param organization_id: The organization_id of this GetRatePlanAffiliateResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def id(self): + """Gets the id of this GetRatePlanAffiliateResponse. # noqa: E501 + + + :return: The id of this GetRatePlanAffiliateResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this GetRatePlanAffiliateResponse. + + + :param id: The id of this GetRatePlanAffiliateResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def product_rate_plan_id(self): + """Gets the product_rate_plan_id of this GetRatePlanAffiliateResponse. # noqa: E501 + + + :return: The product_rate_plan_id of this GetRatePlanAffiliateResponse. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_id + + @product_rate_plan_id.setter + def product_rate_plan_id(self, product_rate_plan_id): + """Sets the product_rate_plan_id of this GetRatePlanAffiliateResponse. + + + :param product_rate_plan_id: The product_rate_plan_id of this GetRatePlanAffiliateResponse. # noqa: E501 + :type: str + """ + + self._product_rate_plan_id = product_rate_plan_id + + @property + def account_id(self): + """Gets the account_id of this GetRatePlanAffiliateResponse. # noqa: E501 + + + :return: The account_id of this GetRatePlanAffiliateResponse. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this GetRatePlanAffiliateResponse. + + + :param account_id: The account_id of this GetRatePlanAffiliateResponse. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def start_date(self): + """Gets the start_date of this GetRatePlanAffiliateResponse. # noqa: E501 + + + :return: The start_date of this GetRatePlanAffiliateResponse. # noqa: E501 + :rtype: datetime + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this GetRatePlanAffiliateResponse. + + + :param start_date: The start_date of this GetRatePlanAffiliateResponse. # noqa: E501 + :type: datetime + """ + + self._start_date = start_date + + @property + def end_date(self): + """Gets the end_date of this GetRatePlanAffiliateResponse. # noqa: E501 + + + :return: The end_date of this GetRatePlanAffiliateResponse. # noqa: E501 + :rtype: datetime + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this GetRatePlanAffiliateResponse. + + + :param end_date: The end_date of this GetRatePlanAffiliateResponse. # noqa: E501 + :type: datetime + """ + + self._end_date = end_date + + @property + def commission_structure(self): + """Gets the commission_structure of this GetRatePlanAffiliateResponse. # noqa: E501 + + + :return: The commission_structure of this GetRatePlanAffiliateResponse. # noqa: E501 + :rtype: CommissionStructure + """ + return self._commission_structure + + @commission_structure.setter + def commission_structure(self, commission_structure): + """Sets the commission_structure of this GetRatePlanAffiliateResponse. + + + :param commission_structure: The commission_structure of this GetRatePlanAffiliateResponse. # noqa: E501 + :type: CommissionStructure + """ + + self._commission_structure = commission_structure + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(GetRatePlanAffiliateResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, GetRatePlanAffiliateResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/get_subscription_affiliate_response.py b/billforward/models/get_subscription_affiliate_response.py new file mode 100644 index 0000000..66803db --- /dev/null +++ b/billforward/models/get_subscription_affiliate_response.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class GetSubscriptionAffiliateResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'subscription_id': 'str', + 'organization_id': 'str', + 'account_id': 'str', + 'commission_structure': 'CommissionStructure' + } + + attribute_map = { + 'created': 'created', + 'subscription_id': 'subscriptionID', + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'commission_structure': 'commissionStructure' + } + + def __init__(self, created=None, subscription_id=None, organization_id=None, account_id=None, commission_structure=None): # noqa: E501 + """GetSubscriptionAffiliateResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._subscription_id = None + self._organization_id = None + self._account_id = None + self._commission_structure = None + self.discriminator = None + if created is not None: + self.created = created + if subscription_id is not None: + self.subscription_id = subscription_id + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if commission_structure is not None: + self.commission_structure = commission_structure + + @property + def created(self): + """Gets the created of this GetSubscriptionAffiliateResponse. # noqa: E501 + + + :return: The created of this GetSubscriptionAffiliateResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this GetSubscriptionAffiliateResponse. + + + :param created: The created of this GetSubscriptionAffiliateResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def subscription_id(self): + """Gets the subscription_id of this GetSubscriptionAffiliateResponse. # noqa: E501 + + + :return: The subscription_id of this GetSubscriptionAffiliateResponse. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this GetSubscriptionAffiliateResponse. + + + :param subscription_id: The subscription_id of this GetSubscriptionAffiliateResponse. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def organization_id(self): + """Gets the organization_id of this GetSubscriptionAffiliateResponse. # noqa: E501 + + + :return: The organization_id of this GetSubscriptionAffiliateResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this GetSubscriptionAffiliateResponse. + + + :param organization_id: The organization_id of this GetSubscriptionAffiliateResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_id(self): + """Gets the account_id of this GetSubscriptionAffiliateResponse. # noqa: E501 + + + :return: The account_id of this GetSubscriptionAffiliateResponse. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this GetSubscriptionAffiliateResponse. + + + :param account_id: The account_id of this GetSubscriptionAffiliateResponse. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def commission_structure(self): + """Gets the commission_structure of this GetSubscriptionAffiliateResponse. # noqa: E501 + + + :return: The commission_structure of this GetSubscriptionAffiliateResponse. # noqa: E501 + :rtype: CommissionStructure + """ + return self._commission_structure + + @commission_structure.setter + def commission_structure(self, commission_structure): + """Sets the commission_structure of this GetSubscriptionAffiliateResponse. + + + :param commission_structure: The commission_structure of this GetSubscriptionAffiliateResponse. # noqa: E501 + :type: CommissionStructure + """ + + self._commission_structure = commission_structure + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(GetSubscriptionAffiliateResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, GetSubscriptionAffiliateResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/go_cardless_configuration.py b/billforward/models/go_cardless_configuration.py new file mode 100644 index 0000000..d34440e --- /dev/null +++ b/billforward/models/go_cardless_configuration.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class GoCardlessConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """GoCardlessConfiguration - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + APIConfiguration.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(GoCardlessConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, GoCardlessConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/go_cardless_tokenization_request.py b/billforward/models/go_cardless_tokenization_request.py new file mode 100644 index 0000000..bafda8b --- /dev/null +++ b/billforward/models/go_cardless_tokenization_request.py @@ -0,0 +1,448 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class GoCardlessTokenizationRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'account_id': 'str', + 'default_payment_method': 'bool', + 'account_holder_name': 'str', + 'sort_code': 'str', + 'account_number': 'str', + 'iban': 'str', + 'country': 'str', + 'currency': 'str', + 'holder_type': 'str', + 'customer_id': 'str', + 'name': 'str', + 'email_tokenization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'default_payment_method': 'defaultPaymentMethod', + 'account_holder_name': 'accountHolderName', + 'sort_code': 'sortCode', + 'account_number': 'accountNumber', + 'iban': 'iban', + 'country': 'country', + 'currency': 'currency', + 'holder_type': 'holderType', + 'customer_id': 'customerID', + 'name': 'name', + 'email_tokenization_id': 'emailTokenizationID' + } + + def __init__(self, created=None, organization_id=None, account_id=None, default_payment_method=None, account_holder_name=None, sort_code=None, account_number=None, iban=None, country=None, currency=None, holder_type=None, customer_id=None, name=None, email_tokenization_id=None): # noqa: E501 + """GoCardlessTokenizationRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._account_id = None + self._default_payment_method = None + self._account_holder_name = None + self._sort_code = None + self._account_number = None + self._iban = None + self._country = None + self._currency = None + self._holder_type = None + self._customer_id = None + self._name = None + self._email_tokenization_id = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if default_payment_method is not None: + self.default_payment_method = default_payment_method + if account_holder_name is not None: + self.account_holder_name = account_holder_name + if sort_code is not None: + self.sort_code = sort_code + if account_number is not None: + self.account_number = account_number + if iban is not None: + self.iban = iban + if country is not None: + self.country = country + if currency is not None: + self.currency = currency + if holder_type is not None: + self.holder_type = holder_type + if customer_id is not None: + self.customer_id = customer_id + if name is not None: + self.name = name + if email_tokenization_id is not None: + self.email_tokenization_id = email_tokenization_id + + @property + def created(self): + """Gets the created of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The created of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this GoCardlessTokenizationRequest. + + + :param created: The created of this GoCardlessTokenizationRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The organization_id of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this GoCardlessTokenizationRequest. + + + :param organization_id: The organization_id of this GoCardlessTokenizationRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_id(self): + """Gets the account_id of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The account_id of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this GoCardlessTokenizationRequest. + + + :param account_id: The account_id of this GoCardlessTokenizationRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def default_payment_method(self): + """Gets the default_payment_method of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The default_payment_method of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: bool + """ + return self._default_payment_method + + @default_payment_method.setter + def default_payment_method(self, default_payment_method): + """Sets the default_payment_method of this GoCardlessTokenizationRequest. + + + :param default_payment_method: The default_payment_method of this GoCardlessTokenizationRequest. # noqa: E501 + :type: bool + """ + + self._default_payment_method = default_payment_method + + @property + def account_holder_name(self): + """Gets the account_holder_name of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The account_holder_name of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: str + """ + return self._account_holder_name + + @account_holder_name.setter + def account_holder_name(self, account_holder_name): + """Sets the account_holder_name of this GoCardlessTokenizationRequest. + + + :param account_holder_name: The account_holder_name of this GoCardlessTokenizationRequest. # noqa: E501 + :type: str + """ + + self._account_holder_name = account_holder_name + + @property + def sort_code(self): + """Gets the sort_code of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The sort_code of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: str + """ + return self._sort_code + + @sort_code.setter + def sort_code(self, sort_code): + """Sets the sort_code of this GoCardlessTokenizationRequest. + + + :param sort_code: The sort_code of this GoCardlessTokenizationRequest. # noqa: E501 + :type: str + """ + + self._sort_code = sort_code + + @property + def account_number(self): + """Gets the account_number of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The account_number of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: str + """ + return self._account_number + + @account_number.setter + def account_number(self, account_number): + """Sets the account_number of this GoCardlessTokenizationRequest. + + + :param account_number: The account_number of this GoCardlessTokenizationRequest. # noqa: E501 + :type: str + """ + + self._account_number = account_number + + @property + def iban(self): + """Gets the iban of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The iban of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: str + """ + return self._iban + + @iban.setter + def iban(self, iban): + """Sets the iban of this GoCardlessTokenizationRequest. + + + :param iban: The iban of this GoCardlessTokenizationRequest. # noqa: E501 + :type: str + """ + + self._iban = iban + + @property + def country(self): + """Gets the country of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The country of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: str + """ + return self._country + + @country.setter + def country(self, country): + """Sets the country of this GoCardlessTokenizationRequest. + + + :param country: The country of this GoCardlessTokenizationRequest. # noqa: E501 + :type: str + """ + + self._country = country + + @property + def currency(self): + """Gets the currency of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The currency of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: str + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this GoCardlessTokenizationRequest. + + + :param currency: The currency of this GoCardlessTokenizationRequest. # noqa: E501 + :type: str + """ + + self._currency = currency + + @property + def holder_type(self): + """Gets the holder_type of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The holder_type of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: str + """ + return self._holder_type + + @holder_type.setter + def holder_type(self, holder_type): + """Sets the holder_type of this GoCardlessTokenizationRequest. + + + :param holder_type: The holder_type of this GoCardlessTokenizationRequest. # noqa: E501 + :type: str + """ + + self._holder_type = holder_type + + @property + def customer_id(self): + """Gets the customer_id of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The customer_id of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: str + """ + return self._customer_id + + @customer_id.setter + def customer_id(self, customer_id): + """Sets the customer_id of this GoCardlessTokenizationRequest. + + + :param customer_id: The customer_id of this GoCardlessTokenizationRequest. # noqa: E501 + :type: str + """ + + self._customer_id = customer_id + + @property + def name(self): + """Gets the name of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The name of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this GoCardlessTokenizationRequest. + + + :param name: The name of this GoCardlessTokenizationRequest. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def email_tokenization_id(self): + """Gets the email_tokenization_id of this GoCardlessTokenizationRequest. # noqa: E501 + + + :return: The email_tokenization_id of this GoCardlessTokenizationRequest. # noqa: E501 + :rtype: str + """ + return self._email_tokenization_id + + @email_tokenization_id.setter + def email_tokenization_id(self, email_tokenization_id): + """Sets the email_tokenization_id of this GoCardlessTokenizationRequest. + + + :param email_tokenization_id: The email_tokenization_id of this GoCardlessTokenizationRequest. # noqa: E501 + :type: str + """ + + self._email_tokenization_id = email_tokenization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(GoCardlessTokenizationRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, GoCardlessTokenizationRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/halt_aggregation_request.py b/billforward/models/halt_aggregation_request.py new file mode 100644 index 0000000..b98c593 --- /dev/null +++ b/billforward/models/halt_aggregation_request.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class HaltAggregationRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str' + } + + attribute_map = { + 'organization_id': 'organizationID' + } + + def __init__(self, organization_id=None): # noqa: E501 + """HaltAggregationRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + + @property + def organization_id(self): + """Gets the organization_id of this HaltAggregationRequest. # noqa: E501 + + + :return: The organization_id of this HaltAggregationRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this HaltAggregationRequest. + + + :param organization_id: The organization_id of this HaltAggregationRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(HaltAggregationRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, HaltAggregationRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/halt_aggregation_response.py b/billforward/models/halt_aggregation_response.py new file mode 100644 index 0000000..3b99eac --- /dev/null +++ b/billforward/models/halt_aggregation_response.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class HaltAggregationResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'parent': 'Subscription', + 'children': 'list[Subscription]', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'parent': 'parent', + 'children': 'children', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, parent=None, children=None, organization_id=None): # noqa: E501 + """HaltAggregationResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._parent = None + self._children = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if parent is not None: + self.parent = parent + if children is not None: + self.children = children + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this HaltAggregationResponse. # noqa: E501 + + + :return: The created of this HaltAggregationResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this HaltAggregationResponse. + + + :param created: The created of this HaltAggregationResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def parent(self): + """Gets the parent of this HaltAggregationResponse. # noqa: E501 + + + :return: The parent of this HaltAggregationResponse. # noqa: E501 + :rtype: Subscription + """ + return self._parent + + @parent.setter + def parent(self, parent): + """Sets the parent of this HaltAggregationResponse. + + + :param parent: The parent of this HaltAggregationResponse. # noqa: E501 + :type: Subscription + """ + + self._parent = parent + + @property + def children(self): + """Gets the children of this HaltAggregationResponse. # noqa: E501 + + + :return: The children of this HaltAggregationResponse. # noqa: E501 + :rtype: list[Subscription] + """ + return self._children + + @children.setter + def children(self, children): + """Sets the children of this HaltAggregationResponse. + + + :param children: The children of this HaltAggregationResponse. # noqa: E501 + :type: list[Subscription] + """ + + self._children = children + + @property + def organization_id(self): + """Gets the organization_id of this HaltAggregationResponse. # noqa: E501 + + + :return: The organization_id of this HaltAggregationResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this HaltAggregationResponse. + + + :param organization_id: The organization_id of this HaltAggregationResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(HaltAggregationResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, HaltAggregationResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/hosted_payment.py b/billforward/models/hosted_payment.py new file mode 100644 index 0000000..a416771 --- /dev/null +++ b/billforward/models/hosted_payment.py @@ -0,0 +1,220 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class HostedPayment(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'gateway': 'str', + 'payment_url': 'str', + 'invoice_id': 'str', + 'account_id': 'str' + } + + attribute_map = { + 'id': 'id', + 'gateway': 'gateway', + 'payment_url': 'paymentUrl', + 'invoice_id': 'invoiceId', + 'account_id': 'accountId' + } + + def __init__(self, id=None, gateway=None, payment_url=None, invoice_id=None, account_id=None): # noqa: E501 + """HostedPayment - a model defined in Swagger""" # noqa: E501 + self._id = None + self._gateway = None + self._payment_url = None + self._invoice_id = None + self._account_id = None + self.discriminator = None + if id is not None: + self.id = id + if gateway is not None: + self.gateway = gateway + if payment_url is not None: + self.payment_url = payment_url + if invoice_id is not None: + self.invoice_id = invoice_id + if account_id is not None: + self.account_id = account_id + + @property + def id(self): + """Gets the id of this HostedPayment. # noqa: E501 + + + :return: The id of this HostedPayment. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this HostedPayment. + + + :param id: The id of this HostedPayment. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def gateway(self): + """Gets the gateway of this HostedPayment. # noqa: E501 + + + :return: The gateway of this HostedPayment. # noqa: E501 + :rtype: str + """ + return self._gateway + + @gateway.setter + def gateway(self, gateway): + """Sets the gateway of this HostedPayment. + + + :param gateway: The gateway of this HostedPayment. # noqa: E501 + :type: str + """ + allowed_values = ["VOID", "cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "zooz", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "goCardless", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash", "epx", "shuttle", "square", "billforwardRandomizer", "cardConnect", "ebanx"] # noqa: E501 + if gateway not in allowed_values: + raise ValueError( + "Invalid value for `gateway` ({0}), must be one of {1}" # noqa: E501 + .format(gateway, allowed_values) + ) + + self._gateway = gateway + + @property + def payment_url(self): + """Gets the payment_url of this HostedPayment. # noqa: E501 + + + :return: The payment_url of this HostedPayment. # noqa: E501 + :rtype: str + """ + return self._payment_url + + @payment_url.setter + def payment_url(self, payment_url): + """Sets the payment_url of this HostedPayment. + + + :param payment_url: The payment_url of this HostedPayment. # noqa: E501 + :type: str + """ + + self._payment_url = payment_url + + @property + def invoice_id(self): + """Gets the invoice_id of this HostedPayment. # noqa: E501 + + + :return: The invoice_id of this HostedPayment. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this HostedPayment. + + + :param invoice_id: The invoice_id of this HostedPayment. # noqa: E501 + :type: str + """ + + self._invoice_id = invoice_id + + @property + def account_id(self): + """Gets the account_id of this HostedPayment. # noqa: E501 + + + :return: The account_id of this HostedPayment. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this HostedPayment. + + + :param account_id: The account_id of this HostedPayment. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(HostedPayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, HostedPayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/hosted_payment_config.py b/billforward/models/hosted_payment_config.py new file mode 100644 index 0000000..f41dbc3 --- /dev/null +++ b/billforward/models/hosted_payment_config.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class HostedPaymentConfig(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'enabled': 'bool', + 'success_url': 'str' + } + + attribute_map = { + 'enabled': 'enabled', + 'success_url': 'successUrl' + } + + def __init__(self, enabled=None, success_url=None): # noqa: E501 + """HostedPaymentConfig - a model defined in Swagger""" # noqa: E501 + self._enabled = None + self._success_url = None + self.discriminator = None + if enabled is not None: + self.enabled = enabled + if success_url is not None: + self.success_url = success_url + + @property + def enabled(self): + """Gets the enabled of this HostedPaymentConfig. # noqa: E501 + + + :return: The enabled of this HostedPaymentConfig. # noqa: E501 + :rtype: bool + """ + return self._enabled + + @enabled.setter + def enabled(self, enabled): + """Sets the enabled of this HostedPaymentConfig. + + + :param enabled: The enabled of this HostedPaymentConfig. # noqa: E501 + :type: bool + """ + + self._enabled = enabled + + @property + def success_url(self): + """Gets the success_url of this HostedPaymentConfig. # noqa: E501 + + + :return: The success_url of this HostedPaymentConfig. # noqa: E501 + :rtype: str + """ + return self._success_url + + @success_url.setter + def success_url(self, success_url): + """Sets the success_url of this HostedPaymentConfig. + + + :param success_url: The success_url of this HostedPaymentConfig. # noqa: E501 + :type: str + """ + + self._success_url = success_url + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(HostedPaymentConfig, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, HostedPaymentConfig): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/i_discardable.py b/billforward/models/i_discardable.py new file mode 100644 index 0000000..d7b7373 --- /dev/null +++ b/billforward/models/i_discardable.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class IDiscardable(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'discardable': 'bool' + } + + attribute_map = { + 'discardable': 'discardable' + } + + def __init__(self, discardable=None): # noqa: E501 + """IDiscardable - a model defined in Swagger""" # noqa: E501 + self._discardable = None + self.discriminator = None + if discardable is not None: + self.discardable = discardable + + @property + def discardable(self): + """Gets the discardable of this IDiscardable. # noqa: E501 + + + :return: The discardable of this IDiscardable. # noqa: E501 + :rtype: bool + """ + return self._discardable + + @discardable.setter + def discardable(self, discardable): + """Sets the discardable of this IDiscardable. + + + :param discardable: The discardable of this IDiscardable. # noqa: E501 + :type: bool + """ + + self._discardable = discardable + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(IDiscardable, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, IDiscardable): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/import_invoice_line.py b/billforward/models/import_invoice_line.py index cd9c227..aa6a661 100644 --- a/billforward/models/import_invoice_line.py +++ b/billforward/models/import_invoice_line.py @@ -1,97 +1,103 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class ImportInvoiceLine(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, name=None, description=None, calculation=None, pricing_component=None, organization_id=None, cost=None, tax=None, period_start=None, period_end=None): - """ - ImportInvoiceLine - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'name': 'str', - 'description': 'str', - 'calculation': 'str', - 'pricing_component': 'str', - 'organization_id': 'str', - 'cost': 'float', - 'tax': 'float', - 'period_start': 'datetime', - 'period_end': 'datetime' - } - - self.attribute_map = { - 'name': 'name', - 'description': 'description', - 'calculation': 'calculation', - 'pricing_component': 'pricingComponent', - 'organization_id': 'organizationID', - 'cost': 'cost', - 'tax': 'tax', - 'period_start': 'periodStart', - 'period_end': 'periodEnd' - } - - self._name = name - self._description = description - self._calculation = calculation - self._pricing_component = pricing_component - self._organization_id = organization_id - self._cost = cost - self._tax = tax - self._period_start = period_start - self._period_end = period_end + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'calculation': 'str', + 'pricing_component': 'str', + 'organization_id': 'str', + 'cost': 'float', + 'tax': 'float', + 'period_start': 'datetime', + 'period_end': 'datetime' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'calculation': 'calculation', + 'pricing_component': 'pricingComponent', + 'organization_id': 'organizationID', + 'cost': 'cost', + 'tax': 'tax', + 'period_start': 'periodStart', + 'period_end': 'periodEnd' + } + + def __init__(self, name=None, description=None, calculation=None, pricing_component=None, organization_id=None, cost=None, tax=None, period_start=None, period_end=None): # noqa: E501 + """ImportInvoiceLine - a model defined in Swagger""" # noqa: E501 + self._name = None + self._description = None + self._calculation = None + self._pricing_component = None + self._organization_id = None + self._cost = None + self._tax = None + self._period_start = None + self._period_end = None + self.discriminator = None + if name is not None: + self.name = name + if description is not None: + self.description = description + if calculation is not None: + self.calculation = calculation + if pricing_component is not None: + self.pricing_component = pricing_component + if organization_id is not None: + self.organization_id = organization_id + if cost is not None: + self.cost = cost + if tax is not None: + self.tax = tax + if period_start is not None: + self.period_start = period_start + if period_end is not None: + self.period_end = period_end @property def name(self): - """ - Gets the name of this ImportInvoiceLine. + """Gets the name of this ImportInvoiceLine. # noqa: E501 - :return: The name of this ImportInvoiceLine. + :return: The name of this ImportInvoiceLine. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this ImportInvoiceLine. + """Sets the name of this ImportInvoiceLine. - :param name: The name of this ImportInvoiceLine. + :param name: The name of this ImportInvoiceLine. # noqa: E501 :type: str """ @@ -99,22 +105,20 @@ def name(self, name): @property def description(self): - """ - Gets the description of this ImportInvoiceLine. + """Gets the description of this ImportInvoiceLine. # noqa: E501 - :return: The description of this ImportInvoiceLine. + :return: The description of this ImportInvoiceLine. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this ImportInvoiceLine. + """Sets the description of this ImportInvoiceLine. - :param description: The description of this ImportInvoiceLine. + :param description: The description of this ImportInvoiceLine. # noqa: E501 :type: str """ @@ -122,22 +126,20 @@ def description(self, description): @property def calculation(self): - """ - Gets the calculation of this ImportInvoiceLine. + """Gets the calculation of this ImportInvoiceLine. # noqa: E501 - :return: The calculation of this ImportInvoiceLine. + :return: The calculation of this ImportInvoiceLine. # noqa: E501 :rtype: str """ return self._calculation @calculation.setter def calculation(self, calculation): - """ - Sets the calculation of this ImportInvoiceLine. + """Sets the calculation of this ImportInvoiceLine. - :param calculation: The calculation of this ImportInvoiceLine. + :param calculation: The calculation of this ImportInvoiceLine. # noqa: E501 :type: str """ @@ -145,22 +147,20 @@ def calculation(self, calculation): @property def pricing_component(self): - """ - Gets the pricing_component of this ImportInvoiceLine. + """Gets the pricing_component of this ImportInvoiceLine. # noqa: E501 - :return: The pricing_component of this ImportInvoiceLine. + :return: The pricing_component of this ImportInvoiceLine. # noqa: E501 :rtype: str """ return self._pricing_component @pricing_component.setter def pricing_component(self, pricing_component): - """ - Sets the pricing_component of this ImportInvoiceLine. + """Sets the pricing_component of this ImportInvoiceLine. - :param pricing_component: The pricing_component of this ImportInvoiceLine. + :param pricing_component: The pricing_component of this ImportInvoiceLine. # noqa: E501 :type: str """ @@ -168,22 +168,20 @@ def pricing_component(self, pricing_component): @property def organization_id(self): - """ - Gets the organization_id of this ImportInvoiceLine. + """Gets the organization_id of this ImportInvoiceLine. # noqa: E501 - :return: The organization_id of this ImportInvoiceLine. + :return: The organization_id of this ImportInvoiceLine. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this ImportInvoiceLine. + """Sets the organization_id of this ImportInvoiceLine. - :param organization_id: The organization_id of this ImportInvoiceLine. + :param organization_id: The organization_id of this ImportInvoiceLine. # noqa: E501 :type: str """ @@ -191,22 +189,20 @@ def organization_id(self, organization_id): @property def cost(self): - """ - Gets the cost of this ImportInvoiceLine. + """Gets the cost of this ImportInvoiceLine. # noqa: E501 - :return: The cost of this ImportInvoiceLine. + :return: The cost of this ImportInvoiceLine. # noqa: E501 :rtype: float """ return self._cost @cost.setter def cost(self, cost): - """ - Sets the cost of this ImportInvoiceLine. + """Sets the cost of this ImportInvoiceLine. - :param cost: The cost of this ImportInvoiceLine. + :param cost: The cost of this ImportInvoiceLine. # noqa: E501 :type: float """ @@ -214,22 +210,20 @@ def cost(self, cost): @property def tax(self): - """ - Gets the tax of this ImportInvoiceLine. + """Gets the tax of this ImportInvoiceLine. # noqa: E501 - :return: The tax of this ImportInvoiceLine. + :return: The tax of this ImportInvoiceLine. # noqa: E501 :rtype: float """ return self._tax @tax.setter def tax(self, tax): - """ - Sets the tax of this ImportInvoiceLine. + """Sets the tax of this ImportInvoiceLine. - :param tax: The tax of this ImportInvoiceLine. + :param tax: The tax of this ImportInvoiceLine. # noqa: E501 :type: float """ @@ -237,22 +231,20 @@ def tax(self, tax): @property def period_start(self): - """ - Gets the period_start of this ImportInvoiceLine. + """Gets the period_start of this ImportInvoiceLine. # noqa: E501 - :return: The period_start of this ImportInvoiceLine. + :return: The period_start of this ImportInvoiceLine. # noqa: E501 :rtype: datetime """ return self._period_start @period_start.setter def period_start(self, period_start): - """ - Sets the period_start of this ImportInvoiceLine. + """Sets the period_start of this ImportInvoiceLine. - :param period_start: The period_start of this ImportInvoiceLine. + :param period_start: The period_start of this ImportInvoiceLine. # noqa: E501 :type: datetime """ @@ -260,34 +252,30 @@ def period_start(self, period_start): @property def period_end(self): - """ - Gets the period_end of this ImportInvoiceLine. + """Gets the period_end of this ImportInvoiceLine. # noqa: E501 - :return: The period_end of this ImportInvoiceLine. + :return: The period_end of this ImportInvoiceLine. # noqa: E501 :rtype: datetime """ return self._period_end @period_end.setter def period_end(self, period_end): - """ - Sets the period_end of this ImportInvoiceLine. + """Sets the period_end of this ImportInvoiceLine. - :param period_end: The period_end of this ImportInvoiceLine. + :param period_end: The period_end of this ImportInvoiceLine. # noqa: E501 :type: datetime """ self._period_end = period_end def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -304,29 +292,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(ImportInvoiceLine, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, ImportInvoiceLine): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/import_invoice_request.py b/billforward/models/import_invoice_request.py new file mode 100644 index 0000000..87a4eaa --- /dev/null +++ b/billforward/models/import_invoice_request.py @@ -0,0 +1,590 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class ImportInvoiceRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'subscription_id': 'str', + 'organization_id': 'str', + 'cost': 'float', + 'discount': 'float', + 'refunded': 'float', + 'paid': 'float', + 'payment_received': 'datetime', + 'period_start': 'datetime', + 'period_end': 'datetime', + 'state': 'str', + 'payment_type': 'str', + 'payment_name': 'str', + 'payment_description': 'str', + 'payment_reference': 'str', + 'invoice_lines': 'list[ImportInvoiceLine]', + 'dry_run': 'bool', + 'due': 'datetime', + 'purchase_order': 'str' + } + + attribute_map = { + 'created': 'created', + 'subscription_id': 'subscriptionID', + 'organization_id': 'organizationID', + 'cost': 'cost', + 'discount': 'discount', + 'refunded': 'refunded', + 'paid': 'paid', + 'payment_received': 'paymentReceived', + 'period_start': 'periodStart', + 'period_end': 'periodEnd', + 'state': 'state', + 'payment_type': 'paymentType', + 'payment_name': 'paymentName', + 'payment_description': 'paymentDescription', + 'payment_reference': 'paymentReference', + 'invoice_lines': 'invoiceLines', + 'dry_run': 'dryRun', + 'due': 'due', + 'purchase_order': 'purchaseOrder' + } + + def __init__(self, created=None, subscription_id=None, organization_id=None, cost=None, discount=None, refunded=None, paid=None, payment_received=None, period_start=None, period_end=None, state=None, payment_type=None, payment_name=None, payment_description=None, payment_reference=None, invoice_lines=None, dry_run=None, due=None, purchase_order=None): # noqa: E501 + """ImportInvoiceRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._subscription_id = None + self._organization_id = None + self._cost = None + self._discount = None + self._refunded = None + self._paid = None + self._payment_received = None + self._period_start = None + self._period_end = None + self._state = None + self._payment_type = None + self._payment_name = None + self._payment_description = None + self._payment_reference = None + self._invoice_lines = None + self._dry_run = None + self._due = None + self._purchase_order = None + self.discriminator = None + if created is not None: + self.created = created + if subscription_id is not None: + self.subscription_id = subscription_id + if organization_id is not None: + self.organization_id = organization_id + if cost is not None: + self.cost = cost + if discount is not None: + self.discount = discount + if refunded is not None: + self.refunded = refunded + if paid is not None: + self.paid = paid + if payment_received is not None: + self.payment_received = payment_received + if period_start is not None: + self.period_start = period_start + if period_end is not None: + self.period_end = period_end + if state is not None: + self.state = state + if payment_type is not None: + self.payment_type = payment_type + if payment_name is not None: + self.payment_name = payment_name + if payment_description is not None: + self.payment_description = payment_description + if payment_reference is not None: + self.payment_reference = payment_reference + if invoice_lines is not None: + self.invoice_lines = invoice_lines + if dry_run is not None: + self.dry_run = dry_run + if due is not None: + self.due = due + if purchase_order is not None: + self.purchase_order = purchase_order + + @property + def created(self): + """Gets the created of this ImportInvoiceRequest. # noqa: E501 + + + :return: The created of this ImportInvoiceRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this ImportInvoiceRequest. + + + :param created: The created of this ImportInvoiceRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def subscription_id(self): + """Gets the subscription_id of this ImportInvoiceRequest. # noqa: E501 + + + :return: The subscription_id of this ImportInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this ImportInvoiceRequest. + + + :param subscription_id: The subscription_id of this ImportInvoiceRequest. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def organization_id(self): + """Gets the organization_id of this ImportInvoiceRequest. # noqa: E501 + + + :return: The organization_id of this ImportInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this ImportInvoiceRequest. + + + :param organization_id: The organization_id of this ImportInvoiceRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def cost(self): + """Gets the cost of this ImportInvoiceRequest. # noqa: E501 + + + :return: The cost of this ImportInvoiceRequest. # noqa: E501 + :rtype: float + """ + return self._cost + + @cost.setter + def cost(self, cost): + """Sets the cost of this ImportInvoiceRequest. + + + :param cost: The cost of this ImportInvoiceRequest. # noqa: E501 + :type: float + """ + + self._cost = cost + + @property + def discount(self): + """Gets the discount of this ImportInvoiceRequest. # noqa: E501 + + + :return: The discount of this ImportInvoiceRequest. # noqa: E501 + :rtype: float + """ + return self._discount + + @discount.setter + def discount(self, discount): + """Sets the discount of this ImportInvoiceRequest. + + + :param discount: The discount of this ImportInvoiceRequest. # noqa: E501 + :type: float + """ + + self._discount = discount + + @property + def refunded(self): + """Gets the refunded of this ImportInvoiceRequest. # noqa: E501 + + + :return: The refunded of this ImportInvoiceRequest. # noqa: E501 + :rtype: float + """ + return self._refunded + + @refunded.setter + def refunded(self, refunded): + """Sets the refunded of this ImportInvoiceRequest. + + + :param refunded: The refunded of this ImportInvoiceRequest. # noqa: E501 + :type: float + """ + + self._refunded = refunded + + @property + def paid(self): + """Gets the paid of this ImportInvoiceRequest. # noqa: E501 + + + :return: The paid of this ImportInvoiceRequest. # noqa: E501 + :rtype: float + """ + return self._paid + + @paid.setter + def paid(self, paid): + """Sets the paid of this ImportInvoiceRequest. + + + :param paid: The paid of this ImportInvoiceRequest. # noqa: E501 + :type: float + """ + + self._paid = paid + + @property + def payment_received(self): + """Gets the payment_received of this ImportInvoiceRequest. # noqa: E501 + + + :return: The payment_received of this ImportInvoiceRequest. # noqa: E501 + :rtype: datetime + """ + return self._payment_received + + @payment_received.setter + def payment_received(self, payment_received): + """Sets the payment_received of this ImportInvoiceRequest. + + + :param payment_received: The payment_received of this ImportInvoiceRequest. # noqa: E501 + :type: datetime + """ + + self._payment_received = payment_received + + @property + def period_start(self): + """Gets the period_start of this ImportInvoiceRequest. # noqa: E501 + + + :return: The period_start of this ImportInvoiceRequest. # noqa: E501 + :rtype: datetime + """ + return self._period_start + + @period_start.setter + def period_start(self, period_start): + """Sets the period_start of this ImportInvoiceRequest. + + + :param period_start: The period_start of this ImportInvoiceRequest. # noqa: E501 + :type: datetime + """ + + self._period_start = period_start + + @property + def period_end(self): + """Gets the period_end of this ImportInvoiceRequest. # noqa: E501 + + + :return: The period_end of this ImportInvoiceRequest. # noqa: E501 + :rtype: datetime + """ + return self._period_end + + @period_end.setter + def period_end(self, period_end): + """Sets the period_end of this ImportInvoiceRequest. + + + :param period_end: The period_end of this ImportInvoiceRequest. # noqa: E501 + :type: datetime + """ + + self._period_end = period_end + + @property + def state(self): + """Gets the state of this ImportInvoiceRequest. # noqa: E501 + + + :return: The state of this ImportInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this ImportInvoiceRequest. + + + :param state: The state of this ImportInvoiceRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Paid", "Unpaid", "Pending", "Voided"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def payment_type(self): + """Gets the payment_type of this ImportInvoiceRequest. # noqa: E501 + + + :return: The payment_type of this ImportInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._payment_type + + @payment_type.setter + def payment_type(self, payment_type): + """Sets the payment_type of this ImportInvoiceRequest. + + + :param payment_type: The payment_type of this ImportInvoiceRequest. # noqa: E501 + :type: str + """ + allowed_values = ["WireTransfer", "Check", "Cash", "Other", "Prepayment"] # noqa: E501 + if payment_type not in allowed_values: + raise ValueError( + "Invalid value for `payment_type` ({0}), must be one of {1}" # noqa: E501 + .format(payment_type, allowed_values) + ) + + self._payment_type = payment_type + + @property + def payment_name(self): + """Gets the payment_name of this ImportInvoiceRequest. # noqa: E501 + + + :return: The payment_name of this ImportInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._payment_name + + @payment_name.setter + def payment_name(self, payment_name): + """Sets the payment_name of this ImportInvoiceRequest. + + + :param payment_name: The payment_name of this ImportInvoiceRequest. # noqa: E501 + :type: str + """ + + self._payment_name = payment_name + + @property + def payment_description(self): + """Gets the payment_description of this ImportInvoiceRequest. # noqa: E501 + + + :return: The payment_description of this ImportInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._payment_description + + @payment_description.setter + def payment_description(self, payment_description): + """Sets the payment_description of this ImportInvoiceRequest. + + + :param payment_description: The payment_description of this ImportInvoiceRequest. # noqa: E501 + :type: str + """ + + self._payment_description = payment_description + + @property + def payment_reference(self): + """Gets the payment_reference of this ImportInvoiceRequest. # noqa: E501 + + + :return: The payment_reference of this ImportInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._payment_reference + + @payment_reference.setter + def payment_reference(self, payment_reference): + """Sets the payment_reference of this ImportInvoiceRequest. + + + :param payment_reference: The payment_reference of this ImportInvoiceRequest. # noqa: E501 + :type: str + """ + + self._payment_reference = payment_reference + + @property + def invoice_lines(self): + """Gets the invoice_lines of this ImportInvoiceRequest. # noqa: E501 + + + :return: The invoice_lines of this ImportInvoiceRequest. # noqa: E501 + :rtype: list[ImportInvoiceLine] + """ + return self._invoice_lines + + @invoice_lines.setter + def invoice_lines(self, invoice_lines): + """Sets the invoice_lines of this ImportInvoiceRequest. + + + :param invoice_lines: The invoice_lines of this ImportInvoiceRequest. # noqa: E501 + :type: list[ImportInvoiceLine] + """ + + self._invoice_lines = invoice_lines + + @property + def dry_run(self): + """Gets the dry_run of this ImportInvoiceRequest. # noqa: E501 + + + :return: The dry_run of this ImportInvoiceRequest. # noqa: E501 + :rtype: bool + """ + return self._dry_run + + @dry_run.setter + def dry_run(self, dry_run): + """Sets the dry_run of this ImportInvoiceRequest. + + + :param dry_run: The dry_run of this ImportInvoiceRequest. # noqa: E501 + :type: bool + """ + + self._dry_run = dry_run + + @property + def due(self): + """Gets the due of this ImportInvoiceRequest. # noqa: E501 + + + :return: The due of this ImportInvoiceRequest. # noqa: E501 + :rtype: datetime + """ + return self._due + + @due.setter + def due(self, due): + """Sets the due of this ImportInvoiceRequest. + + + :param due: The due of this ImportInvoiceRequest. # noqa: E501 + :type: datetime + """ + + self._due = due + + @property + def purchase_order(self): + """Gets the purchase_order of this ImportInvoiceRequest. # noqa: E501 + + + :return: The purchase_order of this ImportInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this ImportInvoiceRequest. + + + :param purchase_order: The purchase_order of this ImportInvoiceRequest. # noqa: E501 + :type: str + """ + + self._purchase_order = purchase_order + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ImportInvoiceRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ImportInvoiceRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/import_subscription_request.py b/billforward/models/import_subscription_request.py new file mode 100644 index 0000000..00b07f3 --- /dev/null +++ b/billforward/models/import_subscription_request.py @@ -0,0 +1,480 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class ImportSubscriptionRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'product': 'str', + 'product_rate_plan': 'str', + 'account_id': 'str', + 'organization_id': 'str', + 'period_start': 'datetime', + 'period_end': 'datetime', + 'trial_end': 'datetime', + 'state': 'str', + 'name': 'str', + 'description': 'str', + 'subscription_end': 'datetime', + 'periods': 'int', + 'dry_run': 'bool', + 'purchase_order': 'str' + } + + attribute_map = { + 'created': 'created', + 'product': 'product', + 'product_rate_plan': 'productRatePlan', + 'account_id': 'accountID', + 'organization_id': 'organizationID', + 'period_start': 'periodStart', + 'period_end': 'periodEnd', + 'trial_end': 'trialEnd', + 'state': 'state', + 'name': 'name', + 'description': 'description', + 'subscription_end': 'subscriptionEnd', + 'periods': 'periods', + 'dry_run': 'dryRun', + 'purchase_order': 'purchaseOrder' + } + + def __init__(self, created=None, product=None, product_rate_plan=None, account_id=None, organization_id=None, period_start=None, period_end=None, trial_end=None, state=None, name=None, description=None, subscription_end=None, periods=None, dry_run=None, purchase_order=None): # noqa: E501 + """ImportSubscriptionRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._product = None + self._product_rate_plan = None + self._account_id = None + self._organization_id = None + self._period_start = None + self._period_end = None + self._trial_end = None + self._state = None + self._name = None + self._description = None + self._subscription_end = None + self._periods = None + self._dry_run = None + self._purchase_order = None + self.discriminator = None + if created is not None: + self.created = created + if product is not None: + self.product = product + if product_rate_plan is not None: + self.product_rate_plan = product_rate_plan + if account_id is not None: + self.account_id = account_id + if organization_id is not None: + self.organization_id = organization_id + if period_start is not None: + self.period_start = period_start + if period_end is not None: + self.period_end = period_end + if trial_end is not None: + self.trial_end = trial_end + if state is not None: + self.state = state + if name is not None: + self.name = name + if description is not None: + self.description = description + if subscription_end is not None: + self.subscription_end = subscription_end + if periods is not None: + self.periods = periods + if dry_run is not None: + self.dry_run = dry_run + if purchase_order is not None: + self.purchase_order = purchase_order + + @property + def created(self): + """Gets the created of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The created of this ImportSubscriptionRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this ImportSubscriptionRequest. + + + :param created: The created of this ImportSubscriptionRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def product(self): + """Gets the product of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The product of this ImportSubscriptionRequest. # noqa: E501 + :rtype: str + """ + return self._product + + @product.setter + def product(self, product): + """Sets the product of this ImportSubscriptionRequest. + + + :param product: The product of this ImportSubscriptionRequest. # noqa: E501 + :type: str + """ + + self._product = product + + @property + def product_rate_plan(self): + """Gets the product_rate_plan of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The product_rate_plan of this ImportSubscriptionRequest. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan + + @product_rate_plan.setter + def product_rate_plan(self, product_rate_plan): + """Sets the product_rate_plan of this ImportSubscriptionRequest. + + + :param product_rate_plan: The product_rate_plan of this ImportSubscriptionRequest. # noqa: E501 + :type: str + """ + + self._product_rate_plan = product_rate_plan + + @property + def account_id(self): + """Gets the account_id of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The account_id of this ImportSubscriptionRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this ImportSubscriptionRequest. + + + :param account_id: The account_id of this ImportSubscriptionRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def organization_id(self): + """Gets the organization_id of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The organization_id of this ImportSubscriptionRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this ImportSubscriptionRequest. + + + :param organization_id: The organization_id of this ImportSubscriptionRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def period_start(self): + """Gets the period_start of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The period_start of this ImportSubscriptionRequest. # noqa: E501 + :rtype: datetime + """ + return self._period_start + + @period_start.setter + def period_start(self, period_start): + """Sets the period_start of this ImportSubscriptionRequest. + + + :param period_start: The period_start of this ImportSubscriptionRequest. # noqa: E501 + :type: datetime + """ + + self._period_start = period_start + + @property + def period_end(self): + """Gets the period_end of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The period_end of this ImportSubscriptionRequest. # noqa: E501 + :rtype: datetime + """ + return self._period_end + + @period_end.setter + def period_end(self, period_end): + """Sets the period_end of this ImportSubscriptionRequest. + + + :param period_end: The period_end of this ImportSubscriptionRequest. # noqa: E501 + :type: datetime + """ + + self._period_end = period_end + + @property + def trial_end(self): + """Gets the trial_end of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The trial_end of this ImportSubscriptionRequest. # noqa: E501 + :rtype: datetime + """ + return self._trial_end + + @trial_end.setter + def trial_end(self, trial_end): + """Sets the trial_end of this ImportSubscriptionRequest. + + + :param trial_end: The trial_end of this ImportSubscriptionRequest. # noqa: E501 + :type: datetime + """ + + self._trial_end = trial_end + + @property + def state(self): + """Gets the state of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The state of this ImportSubscriptionRequest. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this ImportSubscriptionRequest. + + + :param state: The state of this ImportSubscriptionRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def name(self): + """Gets the name of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The name of this ImportSubscriptionRequest. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this ImportSubscriptionRequest. + + + :param name: The name of this ImportSubscriptionRequest. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The description of this ImportSubscriptionRequest. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this ImportSubscriptionRequest. + + + :param description: The description of this ImportSubscriptionRequest. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def subscription_end(self): + """Gets the subscription_end of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The subscription_end of this ImportSubscriptionRequest. # noqa: E501 + :rtype: datetime + """ + return self._subscription_end + + @subscription_end.setter + def subscription_end(self, subscription_end): + """Sets the subscription_end of this ImportSubscriptionRequest. + + + :param subscription_end: The subscription_end of this ImportSubscriptionRequest. # noqa: E501 + :type: datetime + """ + + self._subscription_end = subscription_end + + @property + def periods(self): + """Gets the periods of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The periods of this ImportSubscriptionRequest. # noqa: E501 + :rtype: int + """ + return self._periods + + @periods.setter + def periods(self, periods): + """Sets the periods of this ImportSubscriptionRequest. + + + :param periods: The periods of this ImportSubscriptionRequest. # noqa: E501 + :type: int + """ + + self._periods = periods + + @property + def dry_run(self): + """Gets the dry_run of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The dry_run of this ImportSubscriptionRequest. # noqa: E501 + :rtype: bool + """ + return self._dry_run + + @dry_run.setter + def dry_run(self, dry_run): + """Sets the dry_run of this ImportSubscriptionRequest. + + + :param dry_run: The dry_run of this ImportSubscriptionRequest. # noqa: E501 + :type: bool + """ + + self._dry_run = dry_run + + @property + def purchase_order(self): + """Gets the purchase_order of this ImportSubscriptionRequest. # noqa: E501 + + + :return: The purchase_order of this ImportSubscriptionRequest. # noqa: E501 + :rtype: str + """ + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this ImportSubscriptionRequest. + + + :param purchase_order: The purchase_order of this ImportSubscriptionRequest. # noqa: E501 + :type: str + """ + + self._purchase_order = purchase_order + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ImportSubscriptionRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ImportSubscriptionRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default.py b/billforward/models/inline_response_default.py new file mode 100644 index 0000000..8e20180 --- /dev/null +++ b/billforward/models/inline_response_default.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[DunningLine]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault. + + + :param next_page: The next_page of this InlineResponseDefault. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault. + + + :param current_page: The current_page of this InlineResponseDefault. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault. + + + :param current_offset: The current_offset of this InlineResponseDefault. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault. + + + :param records_requested: The records_requested of this InlineResponseDefault. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault. + + + :param records_returned: The records_returned of this InlineResponseDefault. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault. + + + :param total_records: The total_records of this InlineResponseDefault. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault. + + + :param execution_time: The execution_time of this InlineResponseDefault. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault. # noqa: E501 + + + :return: The results of this InlineResponseDefault. # noqa: E501 + :rtype: list[DunningLine] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault. + + + :param results: The results of this InlineResponseDefault. # noqa: E501 + :type: list[DunningLine] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default1.py b/billforward/models/inline_response_default1.py new file mode 100644 index 0000000..c55c090 --- /dev/null +++ b/billforward/models/inline_response_default1.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault1(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[DunningLine]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault1 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault1. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault1. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault1. + + + :param execution_time: The execution_time of this InlineResponseDefault1. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault1. # noqa: E501 + + + :return: The results of this InlineResponseDefault1. # noqa: E501 + :rtype: list[DunningLine] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault1. + + + :param results: The results of this InlineResponseDefault1. # noqa: E501 + :type: list[DunningLine] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault1, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault1): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default10.py b/billforward/models/inline_response_default10.py new file mode 100644 index 0000000..9ac3429 --- /dev/null +++ b/billforward/models/inline_response_default10.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault10(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[SubscriptionCharge]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault10 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault10. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault10. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault10. + + + :param next_page: The next_page of this InlineResponseDefault10. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault10. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault10. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault10. + + + :param current_page: The current_page of this InlineResponseDefault10. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault10. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault10. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault10. + + + :param current_offset: The current_offset of this InlineResponseDefault10. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault10. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault10. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault10. + + + :param records_requested: The records_requested of this InlineResponseDefault10. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault10. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault10. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault10. + + + :param records_returned: The records_returned of this InlineResponseDefault10. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault10. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault10. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault10. + + + :param total_records: The total_records of this InlineResponseDefault10. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault10. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault10. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault10. + + + :param execution_time: The execution_time of this InlineResponseDefault10. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault10. # noqa: E501 + + + :return: The results of this InlineResponseDefault10. # noqa: E501 + :rtype: list[SubscriptionCharge] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault10. + + + :param results: The results of this InlineResponseDefault10. # noqa: E501 + :type: list[SubscriptionCharge] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault10, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault10): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default100.py b/billforward/models/inline_response_default100.py new file mode 100644 index 0000000..bc2bf66 --- /dev/null +++ b/billforward/models/inline_response_default100.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault100(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[StripeAchToken]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault100 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault100. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault100. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault100. + + + :param next_page: The next_page of this InlineResponseDefault100. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault100. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault100. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault100. + + + :param current_page: The current_page of this InlineResponseDefault100. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault100. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault100. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault100. + + + :param current_offset: The current_offset of this InlineResponseDefault100. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault100. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault100. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault100. + + + :param records_requested: The records_requested of this InlineResponseDefault100. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault100. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault100. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault100. + + + :param records_returned: The records_returned of this InlineResponseDefault100. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault100. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault100. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault100. + + + :param total_records: The total_records of this InlineResponseDefault100. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault100. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault100. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault100. + + + :param execution_time: The execution_time of this InlineResponseDefault100. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault100. # noqa: E501 + + + :return: The results of this InlineResponseDefault100. # noqa: E501 + :rtype: list[StripeAchToken] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault100. + + + :param results: The results of this InlineResponseDefault100. # noqa: E501 + :type: list[StripeAchToken] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault100, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault100): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default101.py b/billforward/models/inline_response_default101.py new file mode 100644 index 0000000..17400c3 --- /dev/null +++ b/billforward/models/inline_response_default101.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault101(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[Webhook]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault101 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault101. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault101. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault101. + + + :param next_page: The next_page of this InlineResponseDefault101. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault101. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault101. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault101. + + + :param current_page: The current_page of this InlineResponseDefault101. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault101. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault101. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault101. + + + :param current_offset: The current_offset of this InlineResponseDefault101. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault101. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault101. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault101. + + + :param records_requested: The records_requested of this InlineResponseDefault101. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault101. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault101. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault101. + + + :param records_returned: The records_returned of this InlineResponseDefault101. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault101. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault101. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault101. + + + :param total_records: The total_records of this InlineResponseDefault101. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault101. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault101. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault101. + + + :param execution_time: The execution_time of this InlineResponseDefault101. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault101. # noqa: E501 + + + :return: The results of this InlineResponseDefault101. # noqa: E501 + :rtype: list[Webhook] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault101. + + + :param results: The results of this InlineResponseDefault101. # noqa: E501 + :type: list[Webhook] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault101, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault101): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default102.py b/billforward/models/inline_response_default102.py new file mode 100644 index 0000000..452aece --- /dev/null +++ b/billforward/models/inline_response_default102.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault102(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Webhook]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault102 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault102. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault102. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault102. + + + :param execution_time: The execution_time of this InlineResponseDefault102. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault102. # noqa: E501 + + + :return: The results of this InlineResponseDefault102. # noqa: E501 + :rtype: list[Webhook] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault102. + + + :param results: The results of this InlineResponseDefault102. # noqa: E501 + :type: list[Webhook] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault102, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault102): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default103.py b/billforward/models/inline_response_default103.py new file mode 100644 index 0000000..09aaa66 --- /dev/null +++ b/billforward/models/inline_response_default103.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault103(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[AllowedWebhookSubscriptionValues]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault103 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault103. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault103. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault103. + + + :param execution_time: The execution_time of this InlineResponseDefault103. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault103. # noqa: E501 + + + :return: The results of this InlineResponseDefault103. # noqa: E501 + :rtype: list[AllowedWebhookSubscriptionValues] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault103. + + + :param results: The results of this InlineResponseDefault103. # noqa: E501 + :type: list[AllowedWebhookSubscriptionValues] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault103, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault103): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default11.py b/billforward/models/inline_response_default11.py new file mode 100644 index 0000000..f6cffde --- /dev/null +++ b/billforward/models/inline_response_default11.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault11(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[HaltAggregationResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault11 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault11. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault11. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault11. + + + :param execution_time: The execution_time of this InlineResponseDefault11. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault11. # noqa: E501 + + + :return: The results of this InlineResponseDefault11. # noqa: E501 + :rtype: list[HaltAggregationResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault11. + + + :param results: The results of this InlineResponseDefault11. # noqa: E501 + :type: list[HaltAggregationResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault11, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault11): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default12.py b/billforward/models/inline_response_default12.py new file mode 100644 index 0000000..8264dec --- /dev/null +++ b/billforward/models/inline_response_default12.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault12(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[Address]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault12 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault12. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault12. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault12. + + + :param next_page: The next_page of this InlineResponseDefault12. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault12. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault12. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault12. + + + :param current_page: The current_page of this InlineResponseDefault12. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault12. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault12. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault12. + + + :param current_offset: The current_offset of this InlineResponseDefault12. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault12. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault12. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault12. + + + :param records_requested: The records_requested of this InlineResponseDefault12. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault12. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault12. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault12. + + + :param records_returned: The records_returned of this InlineResponseDefault12. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault12. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault12. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault12. + + + :param total_records: The total_records of this InlineResponseDefault12. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault12. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault12. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault12. + + + :param execution_time: The execution_time of this InlineResponseDefault12. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault12. # noqa: E501 + + + :return: The results of this InlineResponseDefault12. # noqa: E501 + :rtype: list[Address] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault12. + + + :param results: The results of this InlineResponseDefault12. # noqa: E501 + :type: list[Address] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault12, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault12): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default13.py b/billforward/models/inline_response_default13.py new file mode 100644 index 0000000..6e0b0ec --- /dev/null +++ b/billforward/models/inline_response_default13.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault13(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[MarketplaceQuote]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault13 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault13. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault13. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault13. + + + :param execution_time: The execution_time of this InlineResponseDefault13. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault13. # noqa: E501 + + + :return: The results of this InlineResponseDefault13. # noqa: E501 + :rtype: list[MarketplaceQuote] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault13. + + + :param results: The results of this InlineResponseDefault13. # noqa: E501 + :type: list[MarketplaceQuote] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault13, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault13): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default14.py b/billforward/models/inline_response_default14.py new file mode 100644 index 0000000..0aca500 --- /dev/null +++ b/billforward/models/inline_response_default14.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault14(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[APIConfiguration]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault14 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault14. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault14. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault14. + + + :param execution_time: The execution_time of this InlineResponseDefault14. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault14. # noqa: E501 + + + :return: The results of this InlineResponseDefault14. # noqa: E501 + :rtype: list[APIConfiguration] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault14. + + + :param results: The results of this InlineResponseDefault14. # noqa: E501 + :type: list[APIConfiguration] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault14, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault14): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default15.py b/billforward/models/inline_response_default15.py new file mode 100644 index 0000000..593b480 --- /dev/null +++ b/billforward/models/inline_response_default15.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault15(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[RecalculateChargeBatchResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault15 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault15. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault15. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault15. + + + :param execution_time: The execution_time of this InlineResponseDefault15. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault15. # noqa: E501 + + + :return: The results of this InlineResponseDefault15. # noqa: E501 + :rtype: list[RecalculateChargeBatchResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault15. + + + :param results: The results of this InlineResponseDefault15. # noqa: E501 + :type: list[RecalculateChargeBatchResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault15, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault15): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default16.py b/billforward/models/inline_response_default16.py new file mode 100644 index 0000000..8fa5dd4 --- /dev/null +++ b/billforward/models/inline_response_default16.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault16(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[SubscriptionCharge]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault16 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault16. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault16. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault16. + + + :param execution_time: The execution_time of this InlineResponseDefault16. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault16. # noqa: E501 + + + :return: The results of this InlineResponseDefault16. # noqa: E501 + :rtype: list[SubscriptionCharge] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault16. + + + :param results: The results of this InlineResponseDefault16. # noqa: E501 + :type: list[SubscriptionCharge] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault16, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault16): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default17.py b/billforward/models/inline_response_default17.py new file mode 100644 index 0000000..6ffd066 --- /dev/null +++ b/billforward/models/inline_response_default17.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault17(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[SubscriptionCheckoutDefinitionDescription]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault17 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault17. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault17. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault17. + + + :param execution_time: The execution_time of this InlineResponseDefault17. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault17. # noqa: E501 + + + :return: The results of this InlineResponseDefault17. # noqa: E501 + :rtype: list[SubscriptionCheckoutDefinitionDescription] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault17. + + + :param results: The results of this InlineResponseDefault17. # noqa: E501 + :type: list[SubscriptionCheckoutDefinitionDescription] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault17, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault17): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default18.py b/billforward/models/inline_response_default18.py new file mode 100644 index 0000000..298b20b --- /dev/null +++ b/billforward/models/inline_response_default18.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault18(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[APIConfiguration]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault18 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault18. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault18. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault18. + + + :param next_page: The next_page of this InlineResponseDefault18. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault18. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault18. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault18. + + + :param current_page: The current_page of this InlineResponseDefault18. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault18. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault18. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault18. + + + :param current_offset: The current_offset of this InlineResponseDefault18. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault18. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault18. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault18. + + + :param records_requested: The records_requested of this InlineResponseDefault18. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault18. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault18. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault18. + + + :param records_returned: The records_returned of this InlineResponseDefault18. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault18. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault18. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault18. + + + :param total_records: The total_records of this InlineResponseDefault18. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault18. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault18. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault18. + + + :param execution_time: The execution_time of this InlineResponseDefault18. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault18. # noqa: E501 + + + :return: The results of this InlineResponseDefault18. # noqa: E501 + :rtype: list[APIConfiguration] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault18. + + + :param results: The results of this InlineResponseDefault18. # noqa: E501 + :type: list[APIConfiguration] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault18, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault18): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default19.py b/billforward/models/inline_response_default19.py new file mode 100644 index 0000000..393d6f3 --- /dev/null +++ b/billforward/models/inline_response_default19.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault19(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Contract]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault19 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault19. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault19. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault19. + + + :param execution_time: The execution_time of this InlineResponseDefault19. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault19. # noqa: E501 + + + :return: The results of this InlineResponseDefault19. # noqa: E501 + :rtype: list[Contract] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault19. + + + :param results: The results of this InlineResponseDefault19. # noqa: E501 + :type: list[Contract] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault19, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault19): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default2.py b/billforward/models/inline_response_default2.py new file mode 100644 index 0000000..980ef56 --- /dev/null +++ b/billforward/models/inline_response_default2.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault2(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[AddChargeToAccountResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault2 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault2. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault2. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault2. + + + :param execution_time: The execution_time of this InlineResponseDefault2. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault2. # noqa: E501 + + + :return: The results of this InlineResponseDefault2. # noqa: E501 + :rtype: list[AddChargeToAccountResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault2. + + + :param results: The results of this InlineResponseDefault2. # noqa: E501 + :type: list[AddChargeToAccountResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault2, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault2): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default20.py b/billforward/models/inline_response_default20.py new file mode 100644 index 0000000..e149f1c --- /dev/null +++ b/billforward/models/inline_response_default20.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault20(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[Contract]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault20 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault20. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault20. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault20. + + + :param next_page: The next_page of this InlineResponseDefault20. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault20. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault20. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault20. + + + :param current_page: The current_page of this InlineResponseDefault20. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault20. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault20. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault20. + + + :param current_offset: The current_offset of this InlineResponseDefault20. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault20. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault20. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault20. + + + :param records_requested: The records_requested of this InlineResponseDefault20. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault20. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault20. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault20. + + + :param records_returned: The records_returned of this InlineResponseDefault20. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault20. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault20. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault20. + + + :param total_records: The total_records of this InlineResponseDefault20. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault20. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault20. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault20. + + + :param execution_time: The execution_time of this InlineResponseDefault20. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault20. # noqa: E501 + + + :return: The results of this InlineResponseDefault20. # noqa: E501 + :rtype: list[Contract] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault20. + + + :param results: The results of this InlineResponseDefault20. # noqa: E501 + :type: list[Contract] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault20, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault20): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default21.py b/billforward/models/inline_response_default21.py new file mode 100644 index 0000000..33e67a4 --- /dev/null +++ b/billforward/models/inline_response_default21.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault21(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[StartContractResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault21 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault21. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault21. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault21. + + + :param execution_time: The execution_time of this InlineResponseDefault21. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault21. # noqa: E501 + + + :return: The results of this InlineResponseDefault21. # noqa: E501 + :rtype: list[StartContractResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault21. + + + :param results: The results of this InlineResponseDefault21. # noqa: E501 + :type: list[StartContractResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault21, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault21): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default22.py b/billforward/models/inline_response_default22.py new file mode 100644 index 0000000..3e26e38 --- /dev/null +++ b/billforward/models/inline_response_default22.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault22(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[Coupon]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault22 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault22. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault22. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault22. + + + :param next_page: The next_page of this InlineResponseDefault22. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault22. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault22. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault22. + + + :param current_page: The current_page of this InlineResponseDefault22. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault22. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault22. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault22. + + + :param current_offset: The current_offset of this InlineResponseDefault22. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault22. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault22. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault22. + + + :param records_requested: The records_requested of this InlineResponseDefault22. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault22. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault22. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault22. + + + :param records_returned: The records_returned of this InlineResponseDefault22. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault22. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault22. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault22. + + + :param total_records: The total_records of this InlineResponseDefault22. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault22. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault22. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault22. + + + :param execution_time: The execution_time of this InlineResponseDefault22. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault22. # noqa: E501 + + + :return: The results of this InlineResponseDefault22. # noqa: E501 + :rtype: list[Coupon] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault22. + + + :param results: The results of this InlineResponseDefault22. # noqa: E501 + :type: list[Coupon] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault22, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault22): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default23.py b/billforward/models/inline_response_default23.py new file mode 100644 index 0000000..9b73cdf --- /dev/null +++ b/billforward/models/inline_response_default23.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault23(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Coupon]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault23 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault23. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault23. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault23. + + + :param execution_time: The execution_time of this InlineResponseDefault23. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault23. # noqa: E501 + + + :return: The results of this InlineResponseDefault23. # noqa: E501 + :rtype: list[Coupon] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault23. + + + :param results: The results of this InlineResponseDefault23. # noqa: E501 + :type: list[Coupon] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault23, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault23): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default24.py b/billforward/models/inline_response_default24.py new file mode 100644 index 0000000..dccd0c5 --- /dev/null +++ b/billforward/models/inline_response_default24.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault24(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[CouponCodeResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault24 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault24. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault24. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault24. + + + :param execution_time: The execution_time of this InlineResponseDefault24. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault24. # noqa: E501 + + + :return: The results of this InlineResponseDefault24. # noqa: E501 + :rtype: list[CouponCodeResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault24. + + + :param results: The results of this InlineResponseDefault24. # noqa: E501 + :type: list[CouponCodeResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault24, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault24): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default25.py b/billforward/models/inline_response_default25.py new file mode 100644 index 0000000..407da63 --- /dev/null +++ b/billforward/models/inline_response_default25.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault25(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[PlanResponse]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault25 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault25. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault25. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault25. + + + :param next_page: The next_page of this InlineResponseDefault25. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault25. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault25. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault25. + + + :param current_page: The current_page of this InlineResponseDefault25. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault25. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault25. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault25. + + + :param current_offset: The current_offset of this InlineResponseDefault25. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault25. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault25. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault25. + + + :param records_requested: The records_requested of this InlineResponseDefault25. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault25. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault25. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault25. + + + :param records_returned: The records_returned of this InlineResponseDefault25. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault25. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault25. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault25. + + + :param total_records: The total_records of this InlineResponseDefault25. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault25. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault25. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault25. + + + :param execution_time: The execution_time of this InlineResponseDefault25. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault25. # noqa: E501 + + + :return: The results of this InlineResponseDefault25. # noqa: E501 + :rtype: list[PlanResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault25. + + + :param results: The results of this InlineResponseDefault25. # noqa: E501 + :type: list[PlanResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault25, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault25): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default26.py b/billforward/models/inline_response_default26.py new file mode 100644 index 0000000..05ccb17 --- /dev/null +++ b/billforward/models/inline_response_default26.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault26(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[Subscription]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault26 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault26. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault26. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault26. + + + :param next_page: The next_page of this InlineResponseDefault26. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault26. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault26. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault26. + + + :param current_page: The current_page of this InlineResponseDefault26. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault26. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault26. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault26. + + + :param current_offset: The current_offset of this InlineResponseDefault26. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault26. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault26. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault26. + + + :param records_requested: The records_requested of this InlineResponseDefault26. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault26. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault26. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault26. + + + :param records_returned: The records_returned of this InlineResponseDefault26. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault26. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault26. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault26. + + + :param total_records: The total_records of this InlineResponseDefault26. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault26. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault26. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault26. + + + :param execution_time: The execution_time of this InlineResponseDefault26. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault26. # noqa: E501 + + + :return: The results of this InlineResponseDefault26. # noqa: E501 + :rtype: list[Subscription] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault26. + + + :param results: The results of this InlineResponseDefault26. # noqa: E501 + :type: list[Subscription] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault26, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault26): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default27.py b/billforward/models/inline_response_default27.py new file mode 100644 index 0000000..07a78f6 --- /dev/null +++ b/billforward/models/inline_response_default27.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault27(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[object]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault27 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault27. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault27. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault27. + + + :param execution_time: The execution_time of this InlineResponseDefault27. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault27. # noqa: E501 + + + :return: The results of this InlineResponseDefault27. # noqa: E501 + :rtype: list[object] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault27. + + + :param results: The results of this InlineResponseDefault27. # noqa: E501 + :type: list[object] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault27, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault27): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default28.py b/billforward/models/inline_response_default28.py new file mode 100644 index 0000000..afcbd38 --- /dev/null +++ b/billforward/models/inline_response_default28.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault28(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[AddChargeResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault28 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault28. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault28. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault28. + + + :param execution_time: The execution_time of this InlineResponseDefault28. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault28. # noqa: E501 + + + :return: The results of this InlineResponseDefault28. # noqa: E501 + :rtype: list[AddChargeResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault28. + + + :param results: The results of this InlineResponseDefault28. # noqa: E501 + :type: list[AddChargeResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault28, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault28): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default29.py b/billforward/models/inline_response_default29.py new file mode 100644 index 0000000..a0f1638 --- /dev/null +++ b/billforward/models/inline_response_default29.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault29(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Invoice]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault29 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault29. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault29. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault29. + + + :param execution_time: The execution_time of this InlineResponseDefault29. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault29. # noqa: E501 + + + :return: The results of this InlineResponseDefault29. # noqa: E501 + :rtype: list[Invoice] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault29. + + + :param results: The results of this InlineResponseDefault29. # noqa: E501 + :type: list[Invoice] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault29, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault29): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default3.py b/billforward/models/inline_response_default3.py new file mode 100644 index 0000000..e7a0b9d --- /dev/null +++ b/billforward/models/inline_response_default3.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault3(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[CreditNote]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault3 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault3. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault3. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault3. + + + :param next_page: The next_page of this InlineResponseDefault3. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault3. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault3. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault3. + + + :param current_page: The current_page of this InlineResponseDefault3. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault3. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault3. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault3. + + + :param current_offset: The current_offset of this InlineResponseDefault3. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault3. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault3. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault3. + + + :param records_requested: The records_requested of this InlineResponseDefault3. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault3. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault3. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault3. + + + :param records_returned: The records_returned of this InlineResponseDefault3. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault3. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault3. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault3. + + + :param total_records: The total_records of this InlineResponseDefault3. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault3. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault3. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault3. + + + :param execution_time: The execution_time of this InlineResponseDefault3. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault3. # noqa: E501 + + + :return: The results of this InlineResponseDefault3. # noqa: E501 + :rtype: list[CreditNote] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault3. + + + :param results: The results of this InlineResponseDefault3. # noqa: E501 + :type: list[CreditNote] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault3, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault3): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default30.py b/billforward/models/inline_response_default30.py new file mode 100644 index 0000000..d23101e --- /dev/null +++ b/billforward/models/inline_response_default30.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault30(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[InvoiceTemplateConfigResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault30 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault30. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault30. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault30. + + + :param execution_time: The execution_time of this InlineResponseDefault30. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault30. # noqa: E501 + + + :return: The results of this InlineResponseDefault30. # noqa: E501 + :rtype: list[InvoiceTemplateConfigResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault30. + + + :param results: The results of this InlineResponseDefault30. # noqa: E501 + :type: list[InvoiceTemplateConfigResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault30, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault30): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default31.py b/billforward/models/inline_response_default31.py new file mode 100644 index 0000000..b5de302 --- /dev/null +++ b/billforward/models/inline_response_default31.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault31(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[InvoiceLinePayments]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault31 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault31. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault31. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault31. + + + :param next_page: The next_page of this InlineResponseDefault31. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault31. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault31. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault31. + + + :param current_page: The current_page of this InlineResponseDefault31. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault31. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault31. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault31. + + + :param current_offset: The current_offset of this InlineResponseDefault31. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault31. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault31. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault31. + + + :param records_requested: The records_requested of this InlineResponseDefault31. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault31. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault31. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault31. + + + :param records_returned: The records_returned of this InlineResponseDefault31. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault31. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault31. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault31. + + + :param total_records: The total_records of this InlineResponseDefault31. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault31. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault31. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault31. + + + :param execution_time: The execution_time of this InlineResponseDefault31. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault31. # noqa: E501 + + + :return: The results of this InlineResponseDefault31. # noqa: E501 + :rtype: list[InvoiceLinePayments] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault31. + + + :param results: The results of this InlineResponseDefault31. # noqa: E501 + :type: list[InvoiceLinePayments] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault31, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault31): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default32.py b/billforward/models/inline_response_default32.py new file mode 100644 index 0000000..21ac95a --- /dev/null +++ b/billforward/models/inline_response_default32.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault32(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[Refund]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault32 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault32. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault32. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault32. + + + :param next_page: The next_page of this InlineResponseDefault32. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault32. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault32. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault32. + + + :param current_page: The current_page of this InlineResponseDefault32. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault32. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault32. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault32. + + + :param current_offset: The current_offset of this InlineResponseDefault32. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault32. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault32. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault32. + + + :param records_requested: The records_requested of this InlineResponseDefault32. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault32. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault32. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault32. + + + :param records_returned: The records_returned of this InlineResponseDefault32. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault32. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault32. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault32. + + + :param total_records: The total_records of this InlineResponseDefault32. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault32. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault32. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault32. + + + :param execution_time: The execution_time of this InlineResponseDefault32. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault32. # noqa: E501 + + + :return: The results of this InlineResponseDefault32. # noqa: E501 + :rtype: list[Refund] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault32. + + + :param results: The results of this InlineResponseDefault32. # noqa: E501 + :type: list[Refund] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault32, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault32): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default33.py b/billforward/models/inline_response_default33.py new file mode 100644 index 0000000..cadf634 --- /dev/null +++ b/billforward/models/inline_response_default33.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault33(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[RevenueAttributions]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault33 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault33. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault33. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault33. + + + :param next_page: The next_page of this InlineResponseDefault33. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault33. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault33. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault33. + + + :param current_page: The current_page of this InlineResponseDefault33. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault33. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault33. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault33. + + + :param current_offset: The current_offset of this InlineResponseDefault33. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault33. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault33. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault33. + + + :param records_requested: The records_requested of this InlineResponseDefault33. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault33. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault33. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault33. + + + :param records_returned: The records_returned of this InlineResponseDefault33. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault33. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault33. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault33. + + + :param total_records: The total_records of this InlineResponseDefault33. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault33. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault33. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault33. + + + :param execution_time: The execution_time of this InlineResponseDefault33. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault33. # noqa: E501 + + + :return: The results of this InlineResponseDefault33. # noqa: E501 + :rtype: list[RevenueAttributions] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault33. + + + :param results: The results of this InlineResponseDefault33. # noqa: E501 + :type: list[RevenueAttributions] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault33, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault33): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default34.py b/billforward/models/inline_response_default34.py new file mode 100644 index 0000000..9d06cab --- /dev/null +++ b/billforward/models/inline_response_default34.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault34(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[SwaggerTypeListInv]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault34 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault34. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault34. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault34. + + + :param execution_time: The execution_time of this InlineResponseDefault34. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault34. # noqa: E501 + + + :return: The results of this InlineResponseDefault34. # noqa: E501 + :rtype: list[SwaggerTypeListInv] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault34. + + + :param results: The results of this InlineResponseDefault34. # noqa: E501 + :type: list[SwaggerTypeListInv] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault34, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault34): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default35.py b/billforward/models/inline_response_default35.py new file mode 100644 index 0000000..cc1947e --- /dev/null +++ b/billforward/models/inline_response_default35.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault35(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[IssueInvoiceResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault35 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault35. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault35. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault35. + + + :param execution_time: The execution_time of this InlineResponseDefault35. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault35. # noqa: E501 + + + :return: The results of this InlineResponseDefault35. # noqa: E501 + :rtype: list[IssueInvoiceResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault35. + + + :param results: The results of this InlineResponseDefault35. # noqa: E501 + :type: list[IssueInvoiceResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault35, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault35): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default36.py b/billforward/models/inline_response_default36.py new file mode 100644 index 0000000..907a2c2 --- /dev/null +++ b/billforward/models/inline_response_default36.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault36(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[InvoiceRefundResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault36 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault36. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault36. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault36. + + + :param execution_time: The execution_time of this InlineResponseDefault36. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault36. # noqa: E501 + + + :return: The results of this InlineResponseDefault36. # noqa: E501 + :rtype: list[InvoiceRefundResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault36. + + + :param results: The results of this InlineResponseDefault36. # noqa: E501 + :type: list[InvoiceRefundResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault36, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault36): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default37.py b/billforward/models/inline_response_default37.py new file mode 100644 index 0000000..98c9889 --- /dev/null +++ b/billforward/models/inline_response_default37.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault37(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[Notifications]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault37 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault37. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault37. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault37. + + + :param next_page: The next_page of this InlineResponseDefault37. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault37. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault37. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault37. + + + :param current_page: The current_page of this InlineResponseDefault37. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault37. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault37. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault37. + + + :param current_offset: The current_offset of this InlineResponseDefault37. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault37. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault37. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault37. + + + :param records_requested: The records_requested of this InlineResponseDefault37. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault37. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault37. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault37. + + + :param records_returned: The records_returned of this InlineResponseDefault37. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault37. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault37. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault37. + + + :param total_records: The total_records of this InlineResponseDefault37. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault37. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault37. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault37. + + + :param execution_time: The execution_time of this InlineResponseDefault37. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault37. # noqa: E501 + + + :return: The results of this InlineResponseDefault37. # noqa: E501 + :rtype: list[Notifications] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault37. + + + :param results: The results of this InlineResponseDefault37. # noqa: E501 + :type: list[Notifications] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault37, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault37): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default38.py b/billforward/models/inline_response_default38.py new file mode 100644 index 0000000..23a17e4 --- /dev/null +++ b/billforward/models/inline_response_default38.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault38(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Notifications]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault38 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault38. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault38. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault38. + + + :param execution_time: The execution_time of this InlineResponseDefault38. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault38. # noqa: E501 + + + :return: The results of this InlineResponseDefault38. # noqa: E501 + :rtype: list[Notifications] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault38. + + + :param results: The results of this InlineResponseDefault38. # noqa: E501 + :type: list[Notifications] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault38, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault38): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default39.py b/billforward/models/inline_response_default39.py new file mode 100644 index 0000000..87469f0 --- /dev/null +++ b/billforward/models/inline_response_default39.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault39(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[NotificationSendResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault39 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault39. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault39. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault39. + + + :param execution_time: The execution_time of this InlineResponseDefault39. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault39. # noqa: E501 + + + :return: The results of this InlineResponseDefault39. # noqa: E501 + :rtype: list[NotificationSendResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault39. + + + :param results: The results of this InlineResponseDefault39. # noqa: E501 + :type: list[NotificationSendResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault39, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault39): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default4.py b/billforward/models/inline_response_default4.py new file mode 100644 index 0000000..9770852 --- /dev/null +++ b/billforward/models/inline_response_default4.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault4(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[CreditNote]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault4 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault4. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault4. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault4. + + + :param execution_time: The execution_time of this InlineResponseDefault4. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault4. # noqa: E501 + + + :return: The results of this InlineResponseDefault4. # noqa: E501 + :rtype: list[CreditNote] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault4. + + + :param results: The results of this InlineResponseDefault4. # noqa: E501 + :type: list[CreditNote] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault4, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault4): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default40.py b/billforward/models/inline_response_default40.py new file mode 100644 index 0000000..b61c50b --- /dev/null +++ b/billforward/models/inline_response_default40.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault40(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[PaymentMethod]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault40 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault40. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault40. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault40. + + + :param execution_time: The execution_time of this InlineResponseDefault40. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault40. # noqa: E501 + + + :return: The results of this InlineResponseDefault40. # noqa: E501 + :rtype: list[PaymentMethod] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault40. + + + :param results: The results of this InlineResponseDefault40. # noqa: E501 + :type: list[PaymentMethod] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault40, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault40): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default41.py b/billforward/models/inline_response_default41.py new file mode 100644 index 0000000..076a426 --- /dev/null +++ b/billforward/models/inline_response_default41.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault41(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Payment]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault41 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault41. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault41. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault41. + + + :param execution_time: The execution_time of this InlineResponseDefault41. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault41. # noqa: E501 + + + :return: The results of this InlineResponseDefault41. # noqa: E501 + :rtype: list[Payment] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault41. + + + :param results: The results of this InlineResponseDefault41. # noqa: E501 + :type: list[Payment] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault41, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault41): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default42.py b/billforward/models/inline_response_default42.py new file mode 100644 index 0000000..4d24136 --- /dev/null +++ b/billforward/models/inline_response_default42.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault42(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[Payment]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault42 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault42. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault42. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault42. + + + :param next_page: The next_page of this InlineResponseDefault42. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault42. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault42. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault42. + + + :param current_page: The current_page of this InlineResponseDefault42. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault42. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault42. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault42. + + + :param current_offset: The current_offset of this InlineResponseDefault42. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault42. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault42. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault42. + + + :param records_requested: The records_requested of this InlineResponseDefault42. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault42. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault42. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault42. + + + :param records_returned: The records_returned of this InlineResponseDefault42. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault42. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault42. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault42. + + + :param total_records: The total_records of this InlineResponseDefault42. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault42. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault42. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault42. + + + :param execution_time: The execution_time of this InlineResponseDefault42. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault42. # noqa: E501 + + + :return: The results of this InlineResponseDefault42. # noqa: E501 + :rtype: list[Payment] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault42. + + + :param results: The results of this InlineResponseDefault42. # noqa: E501 + :type: list[Payment] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault42, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault42): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default43.py b/billforward/models/inline_response_default43.py new file mode 100644 index 0000000..1f09a6c --- /dev/null +++ b/billforward/models/inline_response_default43.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault43(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[PaymentRefundResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault43 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault43. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault43. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault43. + + + :param execution_time: The execution_time of this InlineResponseDefault43. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault43. # noqa: E501 + + + :return: The results of this InlineResponseDefault43. # noqa: E501 + :rtype: list[PaymentRefundResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault43. + + + :param results: The results of this InlineResponseDefault43. # noqa: E501 + :type: list[PaymentRefundResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault43, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault43): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default44.py b/billforward/models/inline_response_default44.py new file mode 100644 index 0000000..22cedf7 --- /dev/null +++ b/billforward/models/inline_response_default44.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault44(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[BFPermission]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault44 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault44. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault44. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault44. + + + :param next_page: The next_page of this InlineResponseDefault44. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault44. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault44. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault44. + + + :param current_page: The current_page of this InlineResponseDefault44. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault44. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault44. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault44. + + + :param current_offset: The current_offset of this InlineResponseDefault44. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault44. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault44. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault44. + + + :param records_requested: The records_requested of this InlineResponseDefault44. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault44. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault44. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault44. + + + :param records_returned: The records_returned of this InlineResponseDefault44. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault44. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault44. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault44. + + + :param total_records: The total_records of this InlineResponseDefault44. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault44. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault44. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault44. + + + :param execution_time: The execution_time of this InlineResponseDefault44. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault44. # noqa: E501 + + + :return: The results of this InlineResponseDefault44. # noqa: E501 + :rtype: list[BFPermission] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault44. + + + :param results: The results of this InlineResponseDefault44. # noqa: E501 + :type: list[BFPermission] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault44, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault44): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default45.py b/billforward/models/inline_response_default45.py new file mode 100644 index 0000000..e310b42 --- /dev/null +++ b/billforward/models/inline_response_default45.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault45(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[BFPermission]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault45 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault45. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault45. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault45. + + + :param execution_time: The execution_time of this InlineResponseDefault45. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault45. # noqa: E501 + + + :return: The results of this InlineResponseDefault45. # noqa: E501 + :rtype: list[BFPermission] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault45. + + + :param results: The results of this InlineResponseDefault45. # noqa: E501 + :type: list[BFPermission] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault45, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault45): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default46.py b/billforward/models/inline_response_default46.py new file mode 100644 index 0000000..4555563 --- /dev/null +++ b/billforward/models/inline_response_default46.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault46(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[PermissionActionEntity]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault46 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault46. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault46. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault46. + + + :param execution_time: The execution_time of this InlineResponseDefault46. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault46. # noqa: E501 + + + :return: The results of this InlineResponseDefault46. # noqa: E501 + :rtype: list[PermissionActionEntity] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault46. + + + :param results: The results of this InlineResponseDefault46. # noqa: E501 + :type: list[PermissionActionEntity] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault46, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault46): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default47.py b/billforward/models/inline_response_default47.py new file mode 100644 index 0000000..b5a8919 --- /dev/null +++ b/billforward/models/inline_response_default47.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault47(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[PermissionResourceEntity]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault47 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault47. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault47. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault47. + + + :param execution_time: The execution_time of this InlineResponseDefault47. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault47. # noqa: E501 + + + :return: The results of this InlineResponseDefault47. # noqa: E501 + :rtype: list[PermissionResourceEntity] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault47. + + + :param results: The results of this InlineResponseDefault47. # noqa: E501 + :type: list[PermissionResourceEntity] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault47, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault47): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default48.py b/billforward/models/inline_response_default48.py new file mode 100644 index 0000000..80029d7 --- /dev/null +++ b/billforward/models/inline_response_default48.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault48(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[GetRatePlanAffiliateResponse]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault48 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault48. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault48. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault48. + + + :param next_page: The next_page of this InlineResponseDefault48. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault48. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault48. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault48. + + + :param current_page: The current_page of this InlineResponseDefault48. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault48. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault48. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault48. + + + :param current_offset: The current_offset of this InlineResponseDefault48. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault48. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault48. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault48. + + + :param records_requested: The records_requested of this InlineResponseDefault48. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault48. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault48. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault48. + + + :param records_returned: The records_returned of this InlineResponseDefault48. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault48. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault48. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault48. + + + :param total_records: The total_records of this InlineResponseDefault48. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault48. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault48. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault48. + + + :param execution_time: The execution_time of this InlineResponseDefault48. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault48. # noqa: E501 + + + :return: The results of this InlineResponseDefault48. # noqa: E501 + :rtype: list[GetRatePlanAffiliateResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault48. + + + :param results: The results of this InlineResponseDefault48. # noqa: E501 + :type: list[GetRatePlanAffiliateResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault48, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault48): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default49.py b/billforward/models/inline_response_default49.py new file mode 100644 index 0000000..94041e5 --- /dev/null +++ b/billforward/models/inline_response_default49.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault49(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[GetRatePlanAffiliateResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault49 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault49. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault49. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault49. + + + :param execution_time: The execution_time of this InlineResponseDefault49. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault49. # noqa: E501 + + + :return: The results of this InlineResponseDefault49. # noqa: E501 + :rtype: list[GetRatePlanAffiliateResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault49. + + + :param results: The results of this InlineResponseDefault49. # noqa: E501 + :type: list[GetRatePlanAffiliateResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault49, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault49): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default5.py b/billforward/models/inline_response_default5.py new file mode 100644 index 0000000..f5bba7d --- /dev/null +++ b/billforward/models/inline_response_default5.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault5(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[Account]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault5 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault5. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault5. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault5. + + + :param next_page: The next_page of this InlineResponseDefault5. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault5. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault5. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault5. + + + :param current_page: The current_page of this InlineResponseDefault5. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault5. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault5. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault5. + + + :param current_offset: The current_offset of this InlineResponseDefault5. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault5. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault5. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault5. + + + :param records_requested: The records_requested of this InlineResponseDefault5. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault5. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault5. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault5. + + + :param records_returned: The records_returned of this InlineResponseDefault5. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault5. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault5. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault5. + + + :param total_records: The total_records of this InlineResponseDefault5. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault5. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault5. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault5. + + + :param execution_time: The execution_time of this InlineResponseDefault5. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault5. # noqa: E501 + + + :return: The results of this InlineResponseDefault5. # noqa: E501 + :rtype: list[Account] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault5. + + + :param results: The results of this InlineResponseDefault5. # noqa: E501 + :type: list[Account] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault5, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault5): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default50.py b/billforward/models/inline_response_default50.py new file mode 100644 index 0000000..d69a90e --- /dev/null +++ b/billforward/models/inline_response_default50.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault50(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[SubscriptionCheckoutResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault50 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault50. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault50. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault50. + + + :param execution_time: The execution_time of this InlineResponseDefault50. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault50. # noqa: E501 + + + :return: The results of this InlineResponseDefault50. # noqa: E501 + :rtype: list[SubscriptionCheckoutResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault50. + + + :param results: The results of this InlineResponseDefault50. # noqa: E501 + :type: list[SubscriptionCheckoutResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault50, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault50): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default51.py b/billforward/models/inline_response_default51.py new file mode 100644 index 0000000..5565687 --- /dev/null +++ b/billforward/models/inline_response_default51.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault51(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Subscription]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault51 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault51. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault51. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault51. + + + :param execution_time: The execution_time of this InlineResponseDefault51. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault51. # noqa: E501 + + + :return: The results of this InlineResponseDefault51. # noqa: E501 + :rtype: list[Subscription] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault51. + + + :param results: The results of this InlineResponseDefault51. # noqa: E501 + :type: list[Subscription] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault51, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault51): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default52.py b/billforward/models/inline_response_default52.py new file mode 100644 index 0000000..a8aaa53 --- /dev/null +++ b/billforward/models/inline_response_default52.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault52(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[ApiQuote]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault52 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault52. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault52. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault52. + + + :param next_page: The next_page of this InlineResponseDefault52. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault52. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault52. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault52. + + + :param current_page: The current_page of this InlineResponseDefault52. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault52. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault52. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault52. + + + :param current_offset: The current_offset of this InlineResponseDefault52. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault52. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault52. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault52. + + + :param records_requested: The records_requested of this InlineResponseDefault52. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault52. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault52. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault52. + + + :param records_returned: The records_returned of this InlineResponseDefault52. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault52. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault52. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault52. + + + :param total_records: The total_records of this InlineResponseDefault52. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault52. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault52. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault52. + + + :param execution_time: The execution_time of this InlineResponseDefault52. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault52. # noqa: E501 + + + :return: The results of this InlineResponseDefault52. # noqa: E501 + :rtype: list[ApiQuote] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault52. + + + :param results: The results of this InlineResponseDefault52. # noqa: E501 + :type: list[ApiQuote] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault52, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault52): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default53.py b/billforward/models/inline_response_default53.py new file mode 100644 index 0000000..fa2d61e --- /dev/null +++ b/billforward/models/inline_response_default53.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault53(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[ApiQuote]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault53 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault53. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault53. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault53. + + + :param execution_time: The execution_time of this InlineResponseDefault53. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault53. # noqa: E501 + + + :return: The results of this InlineResponseDefault53. # noqa: E501 + :rtype: list[ApiQuote] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault53. + + + :param results: The results of this InlineResponseDefault53. # noqa: E501 + :type: list[ApiQuote] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault53, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault53): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default54.py b/billforward/models/inline_response_default54.py new file mode 100644 index 0000000..6cd215b --- /dev/null +++ b/billforward/models/inline_response_default54.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault54(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[Receipt]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault54 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault54. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault54. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault54. + + + :param next_page: The next_page of this InlineResponseDefault54. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault54. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault54. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault54. + + + :param current_page: The current_page of this InlineResponseDefault54. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault54. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault54. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault54. + + + :param current_offset: The current_offset of this InlineResponseDefault54. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault54. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault54. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault54. + + + :param records_requested: The records_requested of this InlineResponseDefault54. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault54. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault54. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault54. + + + :param records_returned: The records_returned of this InlineResponseDefault54. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault54. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault54. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault54. + + + :param total_records: The total_records of this InlineResponseDefault54. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault54. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault54. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault54. + + + :param execution_time: The execution_time of this InlineResponseDefault54. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault54. # noqa: E501 + + + :return: The results of this InlineResponseDefault54. # noqa: E501 + :rtype: list[Receipt] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault54. + + + :param results: The results of this InlineResponseDefault54. # noqa: E501 + :type: list[Receipt] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault54, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault54): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default55.py b/billforward/models/inline_response_default55.py new file mode 100644 index 0000000..e33b3e9 --- /dev/null +++ b/billforward/models/inline_response_default55.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault55(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Receipt]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault55 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault55. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault55. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault55. + + + :param execution_time: The execution_time of this InlineResponseDefault55. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault55. # noqa: E501 + + + :return: The results of this InlineResponseDefault55. # noqa: E501 + :rtype: list[Receipt] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault55. + + + :param results: The results of this InlineResponseDefault55. # noqa: E501 + :type: list[Receipt] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault55, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault55): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default56.py b/billforward/models/inline_response_default56.py new file mode 100644 index 0000000..05ea538 --- /dev/null +++ b/billforward/models/inline_response_default56.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault56(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[Role]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault56 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault56. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault56. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault56. + + + :param next_page: The next_page of this InlineResponseDefault56. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault56. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault56. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault56. + + + :param current_page: The current_page of this InlineResponseDefault56. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault56. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault56. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault56. + + + :param current_offset: The current_offset of this InlineResponseDefault56. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault56. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault56. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault56. + + + :param records_requested: The records_requested of this InlineResponseDefault56. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault56. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault56. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault56. + + + :param records_returned: The records_returned of this InlineResponseDefault56. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault56. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault56. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault56. + + + :param total_records: The total_records of this InlineResponseDefault56. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault56. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault56. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault56. + + + :param execution_time: The execution_time of this InlineResponseDefault56. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault56. # noqa: E501 + + + :return: The results of this InlineResponseDefault56. # noqa: E501 + :rtype: list[Role] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault56. + + + :param results: The results of this InlineResponseDefault56. # noqa: E501 + :type: list[Role] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault56, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault56): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default57.py b/billforward/models/inline_response_default57.py new file mode 100644 index 0000000..2d694ce --- /dev/null +++ b/billforward/models/inline_response_default57.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault57(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Role]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault57 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault57. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault57. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault57. + + + :param execution_time: The execution_time of this InlineResponseDefault57. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault57. # noqa: E501 + + + :return: The results of this InlineResponseDefault57. # noqa: E501 + :rtype: list[Role] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault57. + + + :param results: The results of this InlineResponseDefault57. # noqa: E501 + :type: list[Role] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault57, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault57): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default58.py b/billforward/models/inline_response_default58.py new file mode 100644 index 0000000..446b222 --- /dev/null +++ b/billforward/models/inline_response_default58.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault58(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[DataSyncJobResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault58 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault58. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault58. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault58. + + + :param execution_time: The execution_time of this InlineResponseDefault58. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault58. # noqa: E501 + + + :return: The results of this InlineResponseDefault58. # noqa: E501 + :rtype: list[DataSyncJobResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault58. + + + :param results: The results of this InlineResponseDefault58. # noqa: E501 + :type: list[DataSyncJobResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault58, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault58): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default59.py b/billforward/models/inline_response_default59.py new file mode 100644 index 0000000..d0d6a35 --- /dev/null +++ b/billforward/models/inline_response_default59.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault59(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[DataSyncJobResponse]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault59 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault59. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault59. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault59. + + + :param next_page: The next_page of this InlineResponseDefault59. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault59. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault59. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault59. + + + :param current_page: The current_page of this InlineResponseDefault59. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault59. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault59. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault59. + + + :param current_offset: The current_offset of this InlineResponseDefault59. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault59. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault59. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault59. + + + :param records_requested: The records_requested of this InlineResponseDefault59. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault59. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault59. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault59. + + + :param records_returned: The records_returned of this InlineResponseDefault59. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault59. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault59. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault59. + + + :param total_records: The total_records of this InlineResponseDefault59. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault59. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault59. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault59. + + + :param execution_time: The execution_time of this InlineResponseDefault59. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault59. # noqa: E501 + + + :return: The results of this InlineResponseDefault59. # noqa: E501 + :rtype: list[DataSyncJobResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault59. + + + :param results: The results of this InlineResponseDefault59. # noqa: E501 + :type: list[DataSyncJobResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault59, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault59): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default6.py b/billforward/models/inline_response_default6.py new file mode 100644 index 0000000..1a088df --- /dev/null +++ b/billforward/models/inline_response_default6.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault6(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Account]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault6 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault6. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault6. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault6. + + + :param execution_time: The execution_time of this InlineResponseDefault6. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault6. # noqa: E501 + + + :return: The results of this InlineResponseDefault6. # noqa: E501 + :rtype: list[Account] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault6. + + + :param results: The results of this InlineResponseDefault6. # noqa: E501 + :type: list[Account] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault6, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault6): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default60.py b/billforward/models/inline_response_default60.py new file mode 100644 index 0000000..245985c --- /dev/null +++ b/billforward/models/inline_response_default60.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault60(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[SalesforceConfigurationResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault60 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault60. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault60. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault60. + + + :param execution_time: The execution_time of this InlineResponseDefault60. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault60. # noqa: E501 + + + :return: The results of this InlineResponseDefault60. # noqa: E501 + :rtype: list[SalesforceConfigurationResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault60. + + + :param results: The results of this InlineResponseDefault60. # noqa: E501 + :type: list[SalesforceConfigurationResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault60, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault60): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default61.py b/billforward/models/inline_response_default61.py new file mode 100644 index 0000000..5111107 --- /dev/null +++ b/billforward/models/inline_response_default61.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault61(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[TimeResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault61 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault61. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault61. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault61. + + + :param execution_time: The execution_time of this InlineResponseDefault61. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault61. # noqa: E501 + + + :return: The results of this InlineResponseDefault61. # noqa: E501 + :rtype: list[TimeResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault61. + + + :param results: The results of this InlineResponseDefault61. # noqa: E501 + :type: list[TimeResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault61, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault61): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default62.py b/billforward/models/inline_response_default62.py new file mode 100644 index 0000000..e1c6e44 --- /dev/null +++ b/billforward/models/inline_response_default62.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault62(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[UpdatePricingComponentValueResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault62 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault62. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault62. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault62. + + + :param execution_time: The execution_time of this InlineResponseDefault62. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault62. # noqa: E501 + + + :return: The results of this InlineResponseDefault62. # noqa: E501 + :rtype: list[UpdatePricingComponentValueResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault62. + + + :param results: The results of this InlineResponseDefault62. # noqa: E501 + :type: list[UpdatePricingComponentValueResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault62, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault62): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default63.py b/billforward/models/inline_response_default63.py new file mode 100644 index 0000000..dfe90dd --- /dev/null +++ b/billforward/models/inline_response_default63.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault63(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[SubscriptionCancellation]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault63 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault63. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault63. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault63. + + + :param execution_time: The execution_time of this InlineResponseDefault63. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault63. # noqa: E501 + + + :return: The results of this InlineResponseDefault63. # noqa: E501 + :rtype: list[SubscriptionCancellation] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault63. + + + :param results: The results of this InlineResponseDefault63. # noqa: E501 + :type: list[SubscriptionCancellation] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault63, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault63): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default64.py b/billforward/models/inline_response_default64.py new file mode 100644 index 0000000..992bb8d --- /dev/null +++ b/billforward/models/inline_response_default64.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault64(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[Amendment]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault64 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault64. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault64. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault64. + + + :param next_page: The next_page of this InlineResponseDefault64. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault64. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault64. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault64. + + + :param current_page: The current_page of this InlineResponseDefault64. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault64. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault64. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault64. + + + :param current_offset: The current_offset of this InlineResponseDefault64. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault64. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault64. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault64. + + + :param records_requested: The records_requested of this InlineResponseDefault64. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault64. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault64. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault64. + + + :param records_returned: The records_returned of this InlineResponseDefault64. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault64. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault64. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault64. + + + :param total_records: The total_records of this InlineResponseDefault64. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault64. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault64. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault64. + + + :param execution_time: The execution_time of this InlineResponseDefault64. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault64. # noqa: E501 + + + :return: The results of this InlineResponseDefault64. # noqa: E501 + :rtype: list[Amendment] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault64. + + + :param results: The results of this InlineResponseDefault64. # noqa: E501 + :type: list[Amendment] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault64, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault64): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default65.py b/billforward/models/inline_response_default65.py new file mode 100644 index 0000000..10c4f13 --- /dev/null +++ b/billforward/models/inline_response_default65.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault65(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Amendment]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault65 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault65. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault65. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault65. + + + :param execution_time: The execution_time of this InlineResponseDefault65. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault65. # noqa: E501 + + + :return: The results of this InlineResponseDefault65. # noqa: E501 + :rtype: list[Amendment] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault65. + + + :param results: The results of this InlineResponseDefault65. # noqa: E501 + :type: list[Amendment] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault65, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault65): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default66.py b/billforward/models/inline_response_default66.py new file mode 100644 index 0000000..9941b8a --- /dev/null +++ b/billforward/models/inline_response_default66.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault66(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[GetSubscriptionAffiliateResponse]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault66 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault66. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault66. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault66. + + + :param next_page: The next_page of this InlineResponseDefault66. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault66. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault66. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault66. + + + :param current_page: The current_page of this InlineResponseDefault66. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault66. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault66. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault66. + + + :param current_offset: The current_offset of this InlineResponseDefault66. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault66. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault66. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault66. + + + :param records_requested: The records_requested of this InlineResponseDefault66. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault66. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault66. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault66. + + + :param records_returned: The records_returned of this InlineResponseDefault66. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault66. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault66. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault66. + + + :param total_records: The total_records of this InlineResponseDefault66. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault66. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault66. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault66. + + + :param execution_time: The execution_time of this InlineResponseDefault66. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault66. # noqa: E501 + + + :return: The results of this InlineResponseDefault66. # noqa: E501 + :rtype: list[GetSubscriptionAffiliateResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault66. + + + :param results: The results of this InlineResponseDefault66. # noqa: E501 + :type: list[GetSubscriptionAffiliateResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault66, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault66): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default67.py b/billforward/models/inline_response_default67.py new file mode 100644 index 0000000..9e35dcf --- /dev/null +++ b/billforward/models/inline_response_default67.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault67(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[GetSubscriptionAffiliateResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault67 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault67. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault67. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault67. + + + :param execution_time: The execution_time of this InlineResponseDefault67. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault67. # noqa: E501 + + + :return: The results of this InlineResponseDefault67. # noqa: E501 + :rtype: list[GetSubscriptionAffiliateResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault67. + + + :param results: The results of this InlineResponseDefault67. # noqa: E501 + :type: list[GetSubscriptionAffiliateResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault67, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault67): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default68.py b/billforward/models/inline_response_default68.py new file mode 100644 index 0000000..2d74e08 --- /dev/null +++ b/billforward/models/inline_response_default68.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault68(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[PricingComponentValue]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault68 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault68. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault68. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault68. + + + :param next_page: The next_page of this InlineResponseDefault68. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault68. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault68. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault68. + + + :param current_page: The current_page of this InlineResponseDefault68. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault68. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault68. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault68. + + + :param current_offset: The current_offset of this InlineResponseDefault68. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault68. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault68. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault68. + + + :param records_requested: The records_requested of this InlineResponseDefault68. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault68. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault68. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault68. + + + :param records_returned: The records_returned of this InlineResponseDefault68. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault68. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault68. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault68. + + + :param total_records: The total_records of this InlineResponseDefault68. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault68. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault68. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault68. + + + :param execution_time: The execution_time of this InlineResponseDefault68. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault68. # noqa: E501 + + + :return: The results of this InlineResponseDefault68. # noqa: E501 + :rtype: list[PricingComponentValue] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault68. + + + :param results: The results of this InlineResponseDefault68. # noqa: E501 + :type: list[PricingComponentValue] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault68, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault68): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default69.py b/billforward/models/inline_response_default69.py new file mode 100644 index 0000000..48ea014 --- /dev/null +++ b/billforward/models/inline_response_default69.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault69(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[SwaggerTypeListSubs]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault69 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault69. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault69. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault69. + + + :param execution_time: The execution_time of this InlineResponseDefault69. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault69. # noqa: E501 + + + :return: The results of this InlineResponseDefault69. # noqa: E501 + :rtype: list[SwaggerTypeListSubs] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault69. + + + :param results: The results of this InlineResponseDefault69. # noqa: E501 + :type: list[SwaggerTypeListSubs] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault69, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault69): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default7.py b/billforward/models/inline_response_default7.py new file mode 100644 index 0000000..8925359 --- /dev/null +++ b/billforward/models/inline_response_default7.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault7(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[MetadataKeyValues]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault7 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault7. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault7. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault7. + + + :param execution_time: The execution_time of this InlineResponseDefault7. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault7. # noqa: E501 + + + :return: The results of this InlineResponseDefault7. # noqa: E501 + :rtype: list[MetadataKeyValues] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault7. + + + :param results: The results of this InlineResponseDefault7. # noqa: E501 + :type: list[MetadataKeyValues] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault7, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault7): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default70.py b/billforward/models/inline_response_default70.py new file mode 100644 index 0000000..1ce2418 --- /dev/null +++ b/billforward/models/inline_response_default70.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault70(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[MigrationResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault70 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault70. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault70. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault70. + + + :param execution_time: The execution_time of this InlineResponseDefault70. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault70. # noqa: E501 + + + :return: The results of this InlineResponseDefault70. # noqa: E501 + :rtype: list[MigrationResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault70. + + + :param results: The results of this InlineResponseDefault70. # noqa: E501 + :type: list[MigrationResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault70, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault70): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default71.py b/billforward/models/inline_response_default71.py new file mode 100644 index 0000000..c7b1e39 --- /dev/null +++ b/billforward/models/inline_response_default71.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault71(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[PricingComponentValueResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault71 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault71. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault71. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault71. + + + :param execution_time: The execution_time of this InlineResponseDefault71. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault71. # noqa: E501 + + + :return: The results of this InlineResponseDefault71. # noqa: E501 + :rtype: list[PricingComponentValueResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault71. + + + :param results: The results of this InlineResponseDefault71. # noqa: E501 + :type: list[PricingComponentValueResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault71, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault71): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default72.py b/billforward/models/inline_response_default72.py new file mode 100644 index 0000000..91a4aff --- /dev/null +++ b/billforward/models/inline_response_default72.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault72(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[PricingComponentValue]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault72 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault72. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault72. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault72. + + + :param execution_time: The execution_time of this InlineResponseDefault72. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault72. # noqa: E501 + + + :return: The results of this InlineResponseDefault72. # noqa: E501 + :rtype: list[PricingComponentValue] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault72. + + + :param results: The results of this InlineResponseDefault72. # noqa: E501 + :type: list[PricingComponentValue] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault72, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault72): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default73.py b/billforward/models/inline_response_default73.py new file mode 100644 index 0000000..5fef3fa --- /dev/null +++ b/billforward/models/inline_response_default73.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault73(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[StartAllSubscriptionsResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault73 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault73. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault73. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault73. + + + :param execution_time: The execution_time of this InlineResponseDefault73. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault73. # noqa: E501 + + + :return: The results of this InlineResponseDefault73. # noqa: E501 + :rtype: list[StartAllSubscriptionsResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault73. + + + :param results: The results of this InlineResponseDefault73. # noqa: E501 + :type: list[StartAllSubscriptionsResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault73, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault73): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default74.py b/billforward/models/inline_response_default74.py new file mode 100644 index 0000000..e4659ad --- /dev/null +++ b/billforward/models/inline_response_default74.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault74(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[AvataxConfiguration]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault74 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault74. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault74. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault74. + + + :param next_page: The next_page of this InlineResponseDefault74. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault74. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault74. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault74. + + + :param current_page: The current_page of this InlineResponseDefault74. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault74. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault74. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault74. + + + :param current_offset: The current_offset of this InlineResponseDefault74. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault74. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault74. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault74. + + + :param records_requested: The records_requested of this InlineResponseDefault74. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault74. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault74. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault74. + + + :param records_returned: The records_returned of this InlineResponseDefault74. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault74. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault74. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault74. + + + :param total_records: The total_records of this InlineResponseDefault74. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault74. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault74. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault74. + + + :param execution_time: The execution_time of this InlineResponseDefault74. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault74. # noqa: E501 + + + :return: The results of this InlineResponseDefault74. # noqa: E501 + :rtype: list[AvataxConfiguration] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault74. + + + :param results: The results of this InlineResponseDefault74. # noqa: E501 + :type: list[AvataxConfiguration] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault74, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault74): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default75.py b/billforward/models/inline_response_default75.py new file mode 100644 index 0000000..0efc178 --- /dev/null +++ b/billforward/models/inline_response_default75.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault75(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[AvataxConfiguration]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault75 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault75. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault75. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault75. + + + :param execution_time: The execution_time of this InlineResponseDefault75. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault75. # noqa: E501 + + + :return: The results of this InlineResponseDefault75. # noqa: E501 + :rtype: list[AvataxConfiguration] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault75. + + + :param results: The results of this InlineResponseDefault75. # noqa: E501 + :type: list[AvataxConfiguration] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault75, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault75): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default76.py b/billforward/models/inline_response_default76.py new file mode 100644 index 0000000..e026611 --- /dev/null +++ b/billforward/models/inline_response_default76.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault76(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[AvataxPingResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault76 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault76. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault76. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault76. + + + :param execution_time: The execution_time of this InlineResponseDefault76. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault76. # noqa: E501 + + + :return: The results of this InlineResponseDefault76. # noqa: E501 + :rtype: list[AvataxPingResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault76. + + + :param results: The results of this InlineResponseDefault76. # noqa: E501 + :type: list[AvataxPingResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault76, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault76): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default77.py b/billforward/models/inline_response_default77.py new file mode 100644 index 0000000..cacd430 --- /dev/null +++ b/billforward/models/inline_response_default77.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault77(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[TaxationStrategy]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault77 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault77. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault77. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault77. + + + :param next_page: The next_page of this InlineResponseDefault77. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault77. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault77. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault77. + + + :param current_page: The current_page of this InlineResponseDefault77. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault77. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault77. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault77. + + + :param current_offset: The current_offset of this InlineResponseDefault77. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault77. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault77. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault77. + + + :param records_requested: The records_requested of this InlineResponseDefault77. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault77. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault77. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault77. + + + :param records_returned: The records_returned of this InlineResponseDefault77. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault77. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault77. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault77. + + + :param total_records: The total_records of this InlineResponseDefault77. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault77. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault77. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault77. + + + :param execution_time: The execution_time of this InlineResponseDefault77. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault77. # noqa: E501 + + + :return: The results of this InlineResponseDefault77. # noqa: E501 + :rtype: list[TaxationStrategy] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault77. + + + :param results: The results of this InlineResponseDefault77. # noqa: E501 + :type: list[TaxationStrategy] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault77, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault77): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default78.py b/billforward/models/inline_response_default78.py new file mode 100644 index 0000000..23b00f9 --- /dev/null +++ b/billforward/models/inline_response_default78.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault78(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[TaxationStrategy]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault78 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault78. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault78. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault78. + + + :param execution_time: The execution_time of this InlineResponseDefault78. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault78. # noqa: E501 + + + :return: The results of this InlineResponseDefault78. # noqa: E501 + :rtype: list[TaxationStrategy] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault78. + + + :param results: The results of this InlineResponseDefault78. # noqa: E501 + :type: list[TaxationStrategy] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault78, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault78): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default79.py b/billforward/models/inline_response_default79.py new file mode 100644 index 0000000..fd08855 --- /dev/null +++ b/billforward/models/inline_response_default79.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault79(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[EpxPreAuthResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault79 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault79. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault79. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault79. + + + :param execution_time: The execution_time of this InlineResponseDefault79. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault79. # noqa: E501 + + + :return: The results of this InlineResponseDefault79. # noqa: E501 + :rtype: list[EpxPreAuthResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault79. + + + :param results: The results of this InlineResponseDefault79. # noqa: E501 + :type: list[EpxPreAuthResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault79, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault79): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default8.py b/billforward/models/inline_response_default8.py new file mode 100644 index 0000000..5dfaacb --- /dev/null +++ b/billforward/models/inline_response_default8.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault8(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[Invoice]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault8 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault8. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault8. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault8. + + + :param next_page: The next_page of this InlineResponseDefault8. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault8. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault8. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault8. + + + :param current_page: The current_page of this InlineResponseDefault8. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault8. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault8. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault8. + + + :param current_offset: The current_offset of this InlineResponseDefault8. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault8. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault8. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault8. + + + :param records_requested: The records_requested of this InlineResponseDefault8. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault8. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault8. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault8. + + + :param records_returned: The records_returned of this InlineResponseDefault8. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault8. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault8. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault8. + + + :param total_records: The total_records of this InlineResponseDefault8. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault8. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault8. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault8. + + + :param execution_time: The execution_time of this InlineResponseDefault8. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault8. # noqa: E501 + + + :return: The results of this InlineResponseDefault8. # noqa: E501 + :rtype: list[Invoice] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault8. + + + :param results: The results of this InlineResponseDefault8. # noqa: E501 + :type: list[Invoice] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault8, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault8): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default80.py b/billforward/models/inline_response_default80.py new file mode 100644 index 0000000..4492d34 --- /dev/null +++ b/billforward/models/inline_response_default80.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault80(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[EmailTokenization]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault80 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault80. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault80. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault80. + + + :param execution_time: The execution_time of this InlineResponseDefault80. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault80. # noqa: E501 + + + :return: The results of this InlineResponseDefault80. # noqa: E501 + :rtype: list[EmailTokenization] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault80. + + + :param results: The results of this InlineResponseDefault80. # noqa: E501 + :type: list[EmailTokenization] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault80, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault80): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default81.py b/billforward/models/inline_response_default81.py new file mode 100644 index 0000000..340e22f --- /dev/null +++ b/billforward/models/inline_response_default81.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault81(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[EmailTokenization]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault81 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault81. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault81. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault81. + + + :param next_page: The next_page of this InlineResponseDefault81. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault81. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault81. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault81. + + + :param current_page: The current_page of this InlineResponseDefault81. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault81. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault81. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault81. + + + :param current_offset: The current_offset of this InlineResponseDefault81. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault81. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault81. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault81. + + + :param records_requested: The records_requested of this InlineResponseDefault81. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault81. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault81. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault81. + + + :param records_returned: The records_returned of this InlineResponseDefault81. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault81. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault81. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault81. + + + :param total_records: The total_records of this InlineResponseDefault81. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault81. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault81. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault81. + + + :param execution_time: The execution_time of this InlineResponseDefault81. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault81. # noqa: E501 + + + :return: The results of this InlineResponseDefault81. # noqa: E501 + :rtype: list[EmailTokenization] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault81. + + + :param results: The results of this InlineResponseDefault81. # noqa: E501 + :type: list[EmailTokenization] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault81, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault81): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default82.py b/billforward/models/inline_response_default82.py new file mode 100644 index 0000000..29a8ab9 --- /dev/null +++ b/billforward/models/inline_response_default82.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault82(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[TokenizationPreAuth]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault82 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault82. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault82. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault82. + + + :param execution_time: The execution_time of this InlineResponseDefault82. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault82. # noqa: E501 + + + :return: The results of this InlineResponseDefault82. # noqa: E501 + :rtype: list[TokenizationPreAuth] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault82. + + + :param results: The results of this InlineResponseDefault82. # noqa: E501 + :type: list[TokenizationPreAuth] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault82, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault82): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default83.py b/billforward/models/inline_response_default83.py new file mode 100644 index 0000000..afe7c2d --- /dev/null +++ b/billforward/models/inline_response_default83.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault83(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Profile]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault83 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault83. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault83. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault83. + + + :param execution_time: The execution_time of this InlineResponseDefault83. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault83. # noqa: E501 + + + :return: The results of this InlineResponseDefault83. # noqa: E501 + :rtype: list[Profile] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault83. + + + :param results: The results of this InlineResponseDefault83. # noqa: E501 + :type: list[Profile] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault83, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault83): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default84.py b/billforward/models/inline_response_default84.py new file mode 100644 index 0000000..cfb0369 --- /dev/null +++ b/billforward/models/inline_response_default84.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault84(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[UserCreationResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault84 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault84. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault84. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault84. + + + :param execution_time: The execution_time of this InlineResponseDefault84. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault84. # noqa: E501 + + + :return: The results of this InlineResponseDefault84. # noqa: E501 + :rtype: list[UserCreationResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault84. + + + :param results: The results of this InlineResponseDefault84. # noqa: E501 + :type: list[UserCreationResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault84, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault84): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default85.py b/billforward/models/inline_response_default85.py new file mode 100644 index 0000000..6a4dd32 --- /dev/null +++ b/billforward/models/inline_response_default85.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault85(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[SimpleUser]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault85 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault85. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault85. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault85. + + + :param next_page: The next_page of this InlineResponseDefault85. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault85. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault85. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault85. + + + :param current_page: The current_page of this InlineResponseDefault85. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault85. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault85. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault85. + + + :param current_offset: The current_offset of this InlineResponseDefault85. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault85. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault85. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault85. + + + :param records_requested: The records_requested of this InlineResponseDefault85. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault85. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault85. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault85. + + + :param records_returned: The records_returned of this InlineResponseDefault85. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault85. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault85. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault85. + + + :param total_records: The total_records of this InlineResponseDefault85. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault85. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault85. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault85. + + + :param execution_time: The execution_time of this InlineResponseDefault85. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault85. # noqa: E501 + + + :return: The results of this InlineResponseDefault85. # noqa: E501 + :rtype: list[SimpleUser] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault85. + + + :param results: The results of this InlineResponseDefault85. # noqa: E501 + :type: list[SimpleUser] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault85, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault85): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default86.py b/billforward/models/inline_response_default86.py new file mode 100644 index 0000000..aed3fd4 --- /dev/null +++ b/billforward/models/inline_response_default86.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault86(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[UserResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault86 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault86. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault86. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault86. + + + :param execution_time: The execution_time of this InlineResponseDefault86. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault86. # noqa: E501 + + + :return: The results of this InlineResponseDefault86. # noqa: E501 + :rtype: list[UserResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault86. + + + :param results: The results of this InlineResponseDefault86. # noqa: E501 + :type: list[UserResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault86, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault86): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default87.py b/billforward/models/inline_response_default87.py new file mode 100644 index 0000000..d28a33a --- /dev/null +++ b/billforward/models/inline_response_default87.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault87(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[OrganizationLiteView]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault87 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault87. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault87. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault87. + + + :param next_page: The next_page of this InlineResponseDefault87. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault87. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault87. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault87. + + + :param current_page: The current_page of this InlineResponseDefault87. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault87. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault87. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault87. + + + :param current_offset: The current_offset of this InlineResponseDefault87. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault87. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault87. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault87. + + + :param records_requested: The records_requested of this InlineResponseDefault87. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault87. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault87. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault87. + + + :param records_returned: The records_returned of this InlineResponseDefault87. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault87. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault87. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault87. + + + :param total_records: The total_records of this InlineResponseDefault87. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault87. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault87. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault87. + + + :param execution_time: The execution_time of this InlineResponseDefault87. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault87. # noqa: E501 + + + :return: The results of this InlineResponseDefault87. # noqa: E501 + :rtype: list[OrganizationLiteView] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault87. + + + :param results: The results of this InlineResponseDefault87. # noqa: E501 + :type: list[OrganizationLiteView] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault87, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault87): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default88.py b/billforward/models/inline_response_default88.py new file mode 100644 index 0000000..8b5e407 --- /dev/null +++ b/billforward/models/inline_response_default88.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault88(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[UserResponse]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault88 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault88. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault88. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault88. + + + :param next_page: The next_page of this InlineResponseDefault88. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault88. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault88. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault88. + + + :param current_page: The current_page of this InlineResponseDefault88. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault88. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault88. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault88. + + + :param current_offset: The current_offset of this InlineResponseDefault88. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault88. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault88. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault88. + + + :param records_requested: The records_requested of this InlineResponseDefault88. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault88. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault88. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault88. + + + :param records_returned: The records_returned of this InlineResponseDefault88. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault88. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault88. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault88. + + + :param total_records: The total_records of this InlineResponseDefault88. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault88. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault88. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault88. + + + :param execution_time: The execution_time of this InlineResponseDefault88. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault88. # noqa: E501 + + + :return: The results of this InlineResponseDefault88. # noqa: E501 + :rtype: list[UserResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault88. + + + :param results: The results of this InlineResponseDefault88. # noqa: E501 + :type: list[UserResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault88, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault88): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default89.py b/billforward/models/inline_response_default89.py new file mode 100644 index 0000000..459528b --- /dev/null +++ b/billforward/models/inline_response_default89.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault89(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[OpenIDRegistrationResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault89 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault89. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault89. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault89. + + + :param execution_time: The execution_time of this InlineResponseDefault89. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault89. # noqa: E501 + + + :return: The results of this InlineResponseDefault89. # noqa: E501 + :rtype: list[OpenIDRegistrationResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault89. + + + :param results: The results of this InlineResponseDefault89. # noqa: E501 + :type: list[OpenIDRegistrationResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault89, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault89): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default9.py b/billforward/models/inline_response_default9.py new file mode 100644 index 0000000..5ad7a04 --- /dev/null +++ b/billforward/models/inline_response_default9.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault9(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[PaymentMethod]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault9 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault9. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault9. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault9. + + + :param next_page: The next_page of this InlineResponseDefault9. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault9. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault9. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault9. + + + :param current_page: The current_page of this InlineResponseDefault9. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault9. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault9. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault9. + + + :param current_offset: The current_offset of this InlineResponseDefault9. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault9. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault9. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault9. + + + :param records_requested: The records_requested of this InlineResponseDefault9. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault9. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault9. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault9. + + + :param records_returned: The records_returned of this InlineResponseDefault9. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault9. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault9. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault9. + + + :param total_records: The total_records of this InlineResponseDefault9. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault9. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault9. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault9. + + + :param execution_time: The execution_time of this InlineResponseDefault9. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault9. # noqa: E501 + + + :return: The results of this InlineResponseDefault9. # noqa: E501 + :rtype: list[PaymentMethod] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault9. + + + :param results: The results of this InlineResponseDefault9. # noqa: E501 + :type: list[PaymentMethod] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault9, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault9): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default90.py b/billforward/models/inline_response_default90.py new file mode 100644 index 0000000..22d8ccd --- /dev/null +++ b/billforward/models/inline_response_default90.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault90(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[PasswordResetResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault90 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault90. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault90. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault90. + + + :param execution_time: The execution_time of this InlineResponseDefault90. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault90. # noqa: E501 + + + :return: The results of this InlineResponseDefault90. # noqa: E501 + :rtype: list[PasswordResetResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault90. + + + :param results: The results of this InlineResponseDefault90. # noqa: E501 + :type: list[PasswordResetResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault90, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault90): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default91.py b/billforward/models/inline_response_default91.py new file mode 100644 index 0000000..70145a8 --- /dev/null +++ b/billforward/models/inline_response_default91.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault91(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Username]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault91 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault91. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault91. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault91. + + + :param execution_time: The execution_time of this InlineResponseDefault91. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault91. # noqa: E501 + + + :return: The results of this InlineResponseDefault91. # noqa: E501 + :rtype: list[Username] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault91. + + + :param results: The results of this InlineResponseDefault91. # noqa: E501 + :type: list[Username] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault91, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault91): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default92.py b/billforward/models/inline_response_default92.py new file mode 100644 index 0000000..8cb9895 --- /dev/null +++ b/billforward/models/inline_response_default92.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault92(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[UpdatePasswordResponse]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault92 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault92. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault92. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault92. + + + :param execution_time: The execution_time of this InlineResponseDefault92. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault92. # noqa: E501 + + + :return: The results of this InlineResponseDefault92. # noqa: E501 + :rtype: list[UpdatePasswordResponse] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault92. + + + :param results: The results of this InlineResponseDefault92. # noqa: E501 + :type: list[UpdatePasswordResponse] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault92, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault92): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default93.py b/billforward/models/inline_response_default93.py new file mode 100644 index 0000000..b7064a0 --- /dev/null +++ b/billforward/models/inline_response_default93.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault93(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[AuthorizeNetToken]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault93 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault93. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault93. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault93. + + + :param execution_time: The execution_time of this InlineResponseDefault93. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault93. # noqa: E501 + + + :return: The results of this InlineResponseDefault93. # noqa: E501 + :rtype: list[AuthorizeNetToken] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault93. + + + :param results: The results of this InlineResponseDefault93. # noqa: E501 + :type: list[AuthorizeNetToken] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault93, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault93): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default94.py b/billforward/models/inline_response_default94.py new file mode 100644 index 0000000..e099d45 --- /dev/null +++ b/billforward/models/inline_response_default94.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault94(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[BraintreeToken]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault94 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault94. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault94. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault94. + + + :param execution_time: The execution_time of this InlineResponseDefault94. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault94. # noqa: E501 + + + :return: The results of this InlineResponseDefault94. # noqa: E501 + :rtype: list[BraintreeToken] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault94. + + + :param results: The results of this InlineResponseDefault94. # noqa: E501 + :type: list[BraintreeToken] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault94, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault94): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default95.py b/billforward/models/inline_response_default95.py new file mode 100644 index 0000000..2190627 --- /dev/null +++ b/billforward/models/inline_response_default95.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault95(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[StripeAchToken]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault95 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault95. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault95. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault95. + + + :param execution_time: The execution_time of this InlineResponseDefault95. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault95. # noqa: E501 + + + :return: The results of this InlineResponseDefault95. # noqa: E501 + :rtype: list[StripeAchToken] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault95. + + + :param results: The results of this InlineResponseDefault95. # noqa: E501 + :type: list[StripeAchToken] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault95, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault95): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default96.py b/billforward/models/inline_response_default96.py new file mode 100644 index 0000000..c7aab73 --- /dev/null +++ b/billforward/models/inline_response_default96.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault96(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[StripeToken]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault96 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault96. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault96. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault96. + + + :param execution_time: The execution_time of this InlineResponseDefault96. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault96. # noqa: E501 + + + :return: The results of this InlineResponseDefault96. # noqa: E501 + :rtype: list[StripeToken] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault96. + + + :param results: The results of this InlineResponseDefault96. # noqa: E501 + :type: list[StripeToken] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault96, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault96): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default97.py b/billforward/models/inline_response_default97.py new file mode 100644 index 0000000..143aa4a --- /dev/null +++ b/billforward/models/inline_response_default97.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault97(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[TrustCommerceToken]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault97 - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault97. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault97. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault97. + + + :param execution_time: The execution_time of this InlineResponseDefault97. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault97. # noqa: E501 + + + :return: The results of this InlineResponseDefault97. # noqa: E501 + :rtype: list[TrustCommerceToken] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault97. + + + :param results: The results of this InlineResponseDefault97. # noqa: E501 + :type: list[TrustCommerceToken] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault97, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault97): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default98.py b/billforward/models/inline_response_default98.py new file mode 100644 index 0000000..0c39ceb --- /dev/null +++ b/billforward/models/inline_response_default98.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault98(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[BraintreeToken]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault98 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault98. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault98. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault98. + + + :param next_page: The next_page of this InlineResponseDefault98. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault98. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault98. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault98. + + + :param current_page: The current_page of this InlineResponseDefault98. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault98. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault98. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault98. + + + :param current_offset: The current_offset of this InlineResponseDefault98. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault98. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault98. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault98. + + + :param records_requested: The records_requested of this InlineResponseDefault98. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault98. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault98. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault98. + + + :param records_returned: The records_returned of this InlineResponseDefault98. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault98. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault98. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault98. + + + :param total_records: The total_records of this InlineResponseDefault98. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault98. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault98. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault98. + + + :param execution_time: The execution_time of this InlineResponseDefault98. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault98. # noqa: E501 + + + :return: The results of this InlineResponseDefault98. # noqa: E501 + :rtype: list[BraintreeToken] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault98. + + + :param results: The results of this InlineResponseDefault98. # noqa: E501 + :type: list[BraintreeToken] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault98, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault98): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/inline_response_default99.py b/billforward/models/inline_response_default99.py new file mode 100644 index 0000000..2f8d092 --- /dev/null +++ b/billforward/models/inline_response_default99.py @@ -0,0 +1,294 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InlineResponseDefault99(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', + 'execution_time': 'int', + 'results': 'list[StripeToken]' + } + + attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + """InlineResponseDefault99 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None + self._execution_time = None + self._results = None + self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records + self.execution_time = execution_time + self.results = results + + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault99. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault99. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault99. + + + :param next_page: The next_page of this InlineResponseDefault99. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault99. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault99. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault99. + + + :param current_page: The current_page of this InlineResponseDefault99. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault99. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault99. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault99. + + + :param current_offset: The current_offset of this InlineResponseDefault99. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault99. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault99. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault99. + + + :param records_requested: The records_requested of this InlineResponseDefault99. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault99. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault99. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault99. + + + :param records_returned: The records_returned of this InlineResponseDefault99. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault99. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault99. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault99. + + + :param total_records: The total_records of this InlineResponseDefault99. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def execution_time(self): + """Gets the execution_time of this InlineResponseDefault99. # noqa: E501 + + + :return: The execution_time of this InlineResponseDefault99. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this InlineResponseDefault99. + + + :param execution_time: The execution_time of this InlineResponseDefault99. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this InlineResponseDefault99. # noqa: E501 + + + :return: The results of this InlineResponseDefault99. # noqa: E501 + :rtype: list[StripeToken] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this InlineResponseDefault99. + + + :param results: The results of this InlineResponseDefault99. # noqa: E501 + :type: list[StripeToken] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InlineResponseDefault99, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InlineResponseDefault99): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/insertable_billing_entity.py b/billforward/models/insertable_billing_entity.py deleted file mode 100644 index 2a9cce6..0000000 --- a/billforward/models/insertable_billing_entity.py +++ /dev/null @@ -1,474 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class InsertableBillingEntity(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, applied=None, created=None, changed_by=None, id=None, pricing_component_id=None, unit_of_measure_id=None, subscription_id=None, invoice_id=None, organization_id=None, new_value=None, old_value=None, mode=None, state=None, as_of=None): - """ - InsertableBillingEntity - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'applied': 'datetime', - 'created': 'datetime', - 'changed_by': 'str', - 'id': 'str', - 'pricing_component_id': 'str', - 'unit_of_measure_id': 'str', - 'subscription_id': 'str', - 'invoice_id': 'str', - 'organization_id': 'str', - 'new_value': 'int', - 'old_value': 'int', - 'mode': 'str', - 'state': 'str', - 'as_of': 'datetime' - } - - self.attribute_map = { - 'applied': 'applied', - 'created': 'created', - 'changed_by': 'changedBy', - 'id': 'id', - 'pricing_component_id': 'pricingComponentID', - 'unit_of_measure_id': 'unitOfMeasureID', - 'subscription_id': 'subscriptionID', - 'invoice_id': 'invoiceID', - 'organization_id': 'organizationID', - 'new_value': 'newValue', - 'old_value': 'oldValue', - 'mode': 'mode', - 'state': 'state', - 'as_of': 'asOf' - } - - self._applied = applied - self._created = created - self._changed_by = changed_by - self._id = id - self._pricing_component_id = pricing_component_id - self._unit_of_measure_id = unit_of_measure_id - self._subscription_id = subscription_id - self._invoice_id = invoice_id - self._organization_id = organization_id - self._new_value = new_value - self._old_value = old_value - self._mode = mode - self._state = state - self._as_of = as_of - - @property - def applied(self): - """ - Gets the applied of this InsertableBillingEntity. - { \"description\" : \"The UTC DateTime when the pricing-component-value-change was processed.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The applied of this InsertableBillingEntity. - :rtype: datetime - """ - return self._applied - - @applied.setter - def applied(self, applied): - """ - Sets the applied of this InsertableBillingEntity. - { \"description\" : \"The UTC DateTime when the pricing-component-value-change was processed.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param applied: The applied of this InsertableBillingEntity. - :type: datetime - """ - - self._applied = applied - - @property - def created(self): - """ - Gets the created of this InsertableBillingEntity. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this InsertableBillingEntity. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this InsertableBillingEntity. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this InsertableBillingEntity. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this InsertableBillingEntity. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this InsertableBillingEntity. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this InsertableBillingEntity. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this InsertableBillingEntity. - :type: str - """ - - self._changed_by = changed_by - - @property - def id(self): - """ - Gets the id of this InsertableBillingEntity. - { \"description\" : \"ID of the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this InsertableBillingEntity. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this InsertableBillingEntity. - { \"description\" : \"ID of the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this InsertableBillingEntity. - :type: str - """ - - self._id = id - - @property - def pricing_component_id(self): - """ - Gets the pricing_component_id of this InsertableBillingEntity. - { \"description\" : \"ID of the pricing-component associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The pricing_component_id of this InsertableBillingEntity. - :rtype: str - """ - return self._pricing_component_id - - @pricing_component_id.setter - def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this InsertableBillingEntity. - { \"description\" : \"ID of the pricing-component associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param pricing_component_id: The pricing_component_id of this InsertableBillingEntity. - :type: str - """ - - self._pricing_component_id = pricing_component_id - - @property - def unit_of_measure_id(self): - """ - Gets the unit_of_measure_id of this InsertableBillingEntity. - { \"description\" : \"ID of the unit-of-measure associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The unit_of_measure_id of this InsertableBillingEntity. - :rtype: str - """ - return self._unit_of_measure_id - - @unit_of_measure_id.setter - def unit_of_measure_id(self, unit_of_measure_id): - """ - Sets the unit_of_measure_id of this InsertableBillingEntity. - { \"description\" : \"ID of the unit-of-measure associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param unit_of_measure_id: The unit_of_measure_id of this InsertableBillingEntity. - :type: str - """ - - self._unit_of_measure_id = unit_of_measure_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this InsertableBillingEntity. - { \"description\" : \"ID of the subscription associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this InsertableBillingEntity. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this InsertableBillingEntity. - { \"description\" : \"ID of the subscription associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this InsertableBillingEntity. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def invoice_id(self): - """ - Gets the invoice_id of this InsertableBillingEntity. - { \"description\" : \"ID of the invoice associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The invoice_id of this InsertableBillingEntity. - :rtype: str - """ - return self._invoice_id - - @invoice_id.setter - def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this InsertableBillingEntity. - { \"description\" : \"ID of the invoice associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param invoice_id: The invoice_id of this InsertableBillingEntity. - :type: str - """ - - self._invoice_id = invoice_id - - @property - def organization_id(self): - """ - Gets the organization_id of this InsertableBillingEntity. - { \"description\" : \"The organizationID.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this InsertableBillingEntity. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this InsertableBillingEntity. - { \"description\" : \"The organizationID.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this InsertableBillingEntity. - :type: str - """ - - self._organization_id = organization_id - - @property - def new_value(self): - """ - Gets the new_value of this InsertableBillingEntity. - { \"description\" : \"The new value of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The new_value of this InsertableBillingEntity. - :rtype: int - """ - return self._new_value - - @new_value.setter - def new_value(self, new_value): - """ - Sets the new_value of this InsertableBillingEntity. - { \"description\" : \"The new value of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param new_value: The new_value of this InsertableBillingEntity. - :type: int - """ - - self._new_value = new_value - - @property - def old_value(self): - """ - Gets the old_value of this InsertableBillingEntity. - { \"description\" : \"The new value of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The old_value of this InsertableBillingEntity. - :rtype: int - """ - return self._old_value - - @old_value.setter - def old_value(self, old_value): - """ - Sets the old_value of this InsertableBillingEntity. - { \"description\" : \"The new value of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param old_value: The old_value of this InsertableBillingEntity. - :type: int - """ - - self._old_value = old_value - - @property - def mode(self): - """ - Gets the mode of this InsertableBillingEntity. - { \"description\" : \"The value change mode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The mode of this InsertableBillingEntity. - :rtype: str - """ - return self._mode - - @mode.setter - def mode(self, mode): - """ - Sets the mode of this InsertableBillingEntity. - { \"description\" : \"The value change mode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param mode: The mode of this InsertableBillingEntity. - :type: str - """ - allowed_values = ["immediate", "delayed"] - if mode not in allowed_values: - raise ValueError( - "Invalid value for `mode` ({0}), must be one of {1}" - .format(mode, allowed_values) - ) - - self._mode = mode - - @property - def state(self): - """ - Gets the state of this InsertableBillingEntity. - { \"description\" : \"The value change state.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The state of this InsertableBillingEntity. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this InsertableBillingEntity. - { \"description\" : \"The value change state.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param state: The state of this InsertableBillingEntity. - :type: str - """ - allowed_values = ["New", "Accepted", "Rejected", "ChargeCreated"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def as_of(self): - """ - Gets the as_of of this InsertableBillingEntity. - { \"description\" : \"The UTC DateTime when the pricing-component-value-change was calculated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The as_of of this InsertableBillingEntity. - :rtype: datetime - """ - return self._as_of - - @as_of.setter - def as_of(self, as_of): - """ - Sets the as_of of this InsertableBillingEntity. - { \"description\" : \"The UTC DateTime when the pricing-component-value-change was calculated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param as_of: The as_of of this InsertableBillingEntity. - :type: datetime - """ - - self._as_of = as_of - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/interval_date.py b/billforward/models/interval_date.py new file mode 100644 index 0000000..319a652 --- /dev/null +++ b/billforward/models/interval_date.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class IntervalDate(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + '_from': 'datetime', + 'to': 'datetime' + } + + attribute_map = { + '_from': 'from', + 'to': 'to' + } + + def __init__(self, _from=None, to=None): # noqa: E501 + """IntervalDate - a model defined in Swagger""" # noqa: E501 + self.__from = None + self._to = None + self.discriminator = None + if _from is not None: + self._from = _from + if to is not None: + self.to = to + + @property + def _from(self): + """Gets the _from of this IntervalDate. # noqa: E501 + + + :return: The _from of this IntervalDate. # noqa: E501 + :rtype: datetime + """ + return self.__from + + @_from.setter + def _from(self, _from): + """Sets the _from of this IntervalDate. + + + :param _from: The _from of this IntervalDate. # noqa: E501 + :type: datetime + """ + + self.__from = _from + + @property + def to(self): + """Gets the to of this IntervalDate. # noqa: E501 + + + :return: The to of this IntervalDate. # noqa: E501 + :rtype: datetime + """ + return self._to + + @to.setter + def to(self, to): + """Sets the to of this IntervalDate. + + + :param to: The to of this IntervalDate. # noqa: E501 + :type: datetime + """ + + self._to = to + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(IntervalDate, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, IntervalDate): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/invoice.py b/billforward/models/invoice.py index 2fe20ad..ad0d2b7 100644 --- a/billforward/models/invoice.py +++ b/billforward/models/invoice.py @@ -1,211 +1,316 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class Invoice(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, version_id=None, id=None, crm_id=None, subscription_id=None, subscription_version_id=None, account_id=None, organization_id=None, parent_invoice_id=None, name=None, description=None, state=None, issued=None, period_start=None, period_end=None, due=None, deleted=False, total_execution_attempts=None, last_execution_attempt=None, next_execution_attempt=None, final_execution_attempt=None, payment_received=None, currency=None, cost_excluding_tax=None, invoice_cost=None, non_discounted_cost=None, non_discounted_cost_excluding_tax=None, invoice_paid=None, discount_amount=None, discount_amount_excluding_tax=None, invoice_refunded=None, credit_rolled_over=None, credit_rolled_over_excluding_tax=None, type=None, locked=None, managed_by=None, initial_invoice=False, version_number=None, invoice_lines=None, tax_lines=None, invoice_payments=None, invoice_refunds=None, invoice_credit_notes=None, charges=None, children=None): - """ - Invoice - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'version_id': 'str', - 'id': 'str', - 'crm_id': 'str', - 'subscription_id': 'str', - 'subscription_version_id': 'str', - 'account_id': 'str', - 'organization_id': 'str', - 'parent_invoice_id': 'str', - 'name': 'str', - 'description': 'str', - 'state': 'str', - 'issued': 'datetime', - 'period_start': 'datetime', - 'period_end': 'datetime', - 'due': 'datetime', - 'deleted': 'bool', - 'total_execution_attempts': 'int', - 'last_execution_attempt': 'datetime', - 'next_execution_attempt': 'datetime', - 'final_execution_attempt': 'datetime', - 'payment_received': 'datetime', - 'currency': 'str', - 'cost_excluding_tax': 'float', - 'invoice_cost': 'float', - 'non_discounted_cost': 'float', - 'non_discounted_cost_excluding_tax': 'float', - 'invoice_paid': 'float', - 'discount_amount': 'float', - 'discount_amount_excluding_tax': 'float', - 'invoice_refunded': 'float', - 'credit_rolled_over': 'float', - 'credit_rolled_over_excluding_tax': 'float', - 'type': 'str', - 'locked': 'str', - 'managed_by': 'str', - 'initial_invoice': 'bool', - 'version_number': 'int', - 'invoice_lines': 'list[InvoiceLine]', - 'tax_lines': 'list[InsertableBillingEntity]', - 'invoice_payments': 'list[InvoicePayment]', - 'invoice_refunds': 'list[Refund]', - 'invoice_credit_notes': 'list[CreditNote]', - 'charges': 'list[SubscriptionCharge]', - 'children': 'list[Invoice]' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'version_id': 'versionID', - 'id': 'id', - 'crm_id': 'crmID', - 'subscription_id': 'subscriptionID', - 'subscription_version_id': 'subscriptionVersionID', - 'account_id': 'accountID', - 'organization_id': 'organizationID', - 'parent_invoice_id': 'parentInvoiceID', - 'name': 'name', - 'description': 'description', - 'state': 'state', - 'issued': 'issued', - 'period_start': 'periodStart', - 'period_end': 'periodEnd', - 'due': 'due', - 'deleted': 'deleted', - 'total_execution_attempts': 'totalExecutionAttempts', - 'last_execution_attempt': 'lastExecutionAttempt', - 'next_execution_attempt': 'nextExecutionAttempt', - 'final_execution_attempt': 'finalExecutionAttempt', - 'payment_received': 'paymentReceived', - 'currency': 'currency', - 'cost_excluding_tax': 'costExcludingTax', - 'invoice_cost': 'invoiceCost', - 'non_discounted_cost': 'nonDiscountedCost', - 'non_discounted_cost_excluding_tax': 'nonDiscountedCostExcludingTax', - 'invoice_paid': 'invoicePaid', - 'discount_amount': 'discountAmount', - 'discount_amount_excluding_tax': 'discountAmountExcludingTax', - 'invoice_refunded': 'invoiceRefunded', - 'credit_rolled_over': 'creditRolledOver', - 'credit_rolled_over_excluding_tax': 'creditRolledOverExcludingTax', - 'type': 'type', - 'locked': 'locked', - 'managed_by': 'managedBy', - 'initial_invoice': 'initialInvoice', - 'version_number': 'versionNumber', - 'invoice_lines': 'invoiceLines', - 'tax_lines': 'taxLines', - 'invoice_payments': 'invoicePayments', - 'invoice_refunds': 'invoiceRefunds', - 'invoice_credit_notes': 'invoiceCreditNotes', - 'charges': 'charges', - 'children': 'children' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._version_id = version_id - self._id = id - self._crm_id = crm_id - self._subscription_id = subscription_id - self._subscription_version_id = subscription_version_id - self._account_id = account_id - self._organization_id = organization_id - self._parent_invoice_id = parent_invoice_id - self._name = name - self._description = description - self._state = state - self._issued = issued - self._period_start = period_start - self._period_end = period_end - self._due = due - self._deleted = deleted - self._total_execution_attempts = total_execution_attempts - self._last_execution_attempt = last_execution_attempt - self._next_execution_attempt = next_execution_attempt - self._final_execution_attempt = final_execution_attempt - self._payment_received = payment_received - self._currency = currency - self._cost_excluding_tax = cost_excluding_tax - self._invoice_cost = invoice_cost - self._non_discounted_cost = non_discounted_cost - self._non_discounted_cost_excluding_tax = non_discounted_cost_excluding_tax - self._invoice_paid = invoice_paid - self._discount_amount = discount_amount - self._discount_amount_excluding_tax = discount_amount_excluding_tax - self._invoice_refunded = invoice_refunded - self._credit_rolled_over = credit_rolled_over - self._credit_rolled_over_excluding_tax = credit_rolled_over_excluding_tax - self._type = type - self._locked = locked - self._managed_by = managed_by - self._initial_invoice = initial_invoice - self._version_number = version_number - self._invoice_lines = invoice_lines - self._tax_lines = tax_lines - self._invoice_payments = invoice_payments - self._invoice_refunds = invoice_refunds - self._invoice_credit_notes = invoice_credit_notes - self._charges = charges - self._children = children + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'metadata': 'dict(str, object)', + 'version_id': 'str', + 'id': 'str', + 'subscription_id': 'str', + 'subscription_version_id': 'str', + 'account_id': 'str', + 'organization_id': 'str', + 'parent_invoice_id': 'str', + 'name': 'str', + 'description': 'str', + 'state': 'str', + 'issued': 'datetime', + 'due': 'datetime', + 'period_start': 'datetime', + 'period_end': 'datetime', + 'deleted': 'bool', + 'total_execution_attempts': 'int', + 'last_execution_attempt': 'datetime', + 'next_execution_attempt': 'datetime', + 'final_execution_attempt': 'datetime', + 'payment_received': 'datetime', + 'currency': 'CreditNoteCurrency', + 'cost_excluding_tax': 'float', + 'invoice_cost': 'float', + 'non_discounted_cost': 'float', + 'non_discounted_cost_excluding_tax': 'float', + 'invoice_paid': 'float', + 'discount_amount': 'float', + 'discount_amount_excluding_tax': 'float', + 'invoice_refunded': 'float', + 'credit_rolled_over': 'float', + 'credit_rolled_over_excluding_tax': 'float', + 'type': 'str', + 'locked': 'str', + 'managed_by': 'str', + 'initial_invoice': 'bool', + 'processing': 'bool', + 'purchase_order': 'str', + 'version_number': 'int', + 'invoice_lines': 'list[InvoiceLines]', + 'tax_lines': 'list[TaxLine]', + 'invoice_payments': 'list[InvoicePayments]', + 'invoice_refunds': 'list[Refund]', + 'invoice_credit_notes': 'list[CreditNote]', + 'charges': 'list[SubscriptionCharge]', + 'payment_terms': 'int', + 'children': 'list[Invoice]', + 'executions': 'list[ExecutionReceiptResponse]', + 'total_invoice_cost': 'float', + 'zero_cost': 'bool', + 'c_rmid': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'metadata': 'metadata', + 'version_id': 'versionID', + 'id': 'id', + 'subscription_id': 'subscriptionID', + 'subscription_version_id': 'subscriptionVersionID', + 'account_id': 'accountID', + 'organization_id': 'organizationID', + 'parent_invoice_id': 'parentInvoiceID', + 'name': 'name', + 'description': 'description', + 'state': 'state', + 'issued': 'issued', + 'due': 'due', + 'period_start': 'periodStart', + 'period_end': 'periodEnd', + 'deleted': 'deleted', + 'total_execution_attempts': 'totalExecutionAttempts', + 'last_execution_attempt': 'lastExecutionAttempt', + 'next_execution_attempt': 'nextExecutionAttempt', + 'final_execution_attempt': 'finalExecutionAttempt', + 'payment_received': 'paymentReceived', + 'currency': 'currency', + 'cost_excluding_tax': 'costExcludingTax', + 'invoice_cost': 'invoiceCost', + 'non_discounted_cost': 'nonDiscountedCost', + 'non_discounted_cost_excluding_tax': 'nonDiscountedCostExcludingTax', + 'invoice_paid': 'invoicePaid', + 'discount_amount': 'discountAmount', + 'discount_amount_excluding_tax': 'discountAmountExcludingTax', + 'invoice_refunded': 'invoiceRefunded', + 'credit_rolled_over': 'creditRolledOver', + 'credit_rolled_over_excluding_tax': 'creditRolledOverExcludingTax', + 'type': 'type', + 'locked': 'locked', + 'managed_by': 'managedBy', + 'initial_invoice': 'initialInvoice', + 'processing': 'processing', + 'purchase_order': 'purchaseOrder', + 'version_number': 'versionNumber', + 'invoice_lines': 'invoiceLines', + 'tax_lines': 'taxLines', + 'invoice_payments': 'invoicePayments', + 'invoice_refunds': 'invoiceRefunds', + 'invoice_credit_notes': 'invoiceCreditNotes', + 'charges': 'charges', + 'payment_terms': 'paymentTerms', + 'children': 'children', + 'executions': 'executions', + 'total_invoice_cost': 'totalInvoiceCost', + 'zero_cost': 'zeroCost', + 'c_rmid': 'cRMID' + } + + def __init__(self, created=None, changed_by=None, updated=None, metadata=None, version_id=None, id=None, subscription_id=None, subscription_version_id=None, account_id=None, organization_id=None, parent_invoice_id=None, name=None, description=None, state=None, issued=None, due=None, period_start=None, period_end=None, deleted=None, total_execution_attempts=None, last_execution_attempt=None, next_execution_attempt=None, final_execution_attempt=None, payment_received=None, currency=None, cost_excluding_tax=None, invoice_cost=None, non_discounted_cost=None, non_discounted_cost_excluding_tax=None, invoice_paid=None, discount_amount=None, discount_amount_excluding_tax=None, invoice_refunded=None, credit_rolled_over=None, credit_rolled_over_excluding_tax=None, type=None, locked=None, managed_by=None, initial_invoice=None, processing=None, purchase_order=None, version_number=None, invoice_lines=None, tax_lines=None, invoice_payments=None, invoice_refunds=None, invoice_credit_notes=None, charges=None, payment_terms=None, children=None, executions=None, total_invoice_cost=None, zero_cost=None, c_rmid=None): # noqa: E501 + """Invoice - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._metadata = None + self._version_id = None + self._id = None + self._subscription_id = None + self._subscription_version_id = None + self._account_id = None + self._organization_id = None + self._parent_invoice_id = None + self._name = None + self._description = None + self._state = None + self._issued = None + self._due = None + self._period_start = None + self._period_end = None + self._deleted = None + self._total_execution_attempts = None + self._last_execution_attempt = None + self._next_execution_attempt = None + self._final_execution_attempt = None + self._payment_received = None + self._currency = None + self._cost_excluding_tax = None + self._invoice_cost = None + self._non_discounted_cost = None + self._non_discounted_cost_excluding_tax = None + self._invoice_paid = None + self._discount_amount = None + self._discount_amount_excluding_tax = None + self._invoice_refunded = None + self._credit_rolled_over = None + self._credit_rolled_over_excluding_tax = None + self._type = None + self._locked = None + self._managed_by = None + self._initial_invoice = None + self._processing = None + self._purchase_order = None + self._version_number = None + self._invoice_lines = None + self._tax_lines = None + self._invoice_payments = None + self._invoice_refunds = None + self._invoice_credit_notes = None + self._charges = None + self._payment_terms = None + self._children = None + self._executions = None + self._total_invoice_cost = None + self._zero_cost = None + self._c_rmid = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if metadata is not None: + self.metadata = metadata + if version_id is not None: + self.version_id = version_id + if id is not None: + self.id = id + if subscription_id is not None: + self.subscription_id = subscription_id + if subscription_version_id is not None: + self.subscription_version_id = subscription_version_id + self.account_id = account_id + self.organization_id = organization_id + if parent_invoice_id is not None: + self.parent_invoice_id = parent_invoice_id + if name is not None: + self.name = name + if description is not None: + self.description = description + self.state = state + if issued is not None: + self.issued = issued + if due is not None: + self.due = due + if period_start is not None: + self.period_start = period_start + if period_end is not None: + self.period_end = period_end + self.deleted = deleted + if total_execution_attempts is not None: + self.total_execution_attempts = total_execution_attempts + if last_execution_attempt is not None: + self.last_execution_attempt = last_execution_attempt + if next_execution_attempt is not None: + self.next_execution_attempt = next_execution_attempt + if final_execution_attempt is not None: + self.final_execution_attempt = final_execution_attempt + if payment_received is not None: + self.payment_received = payment_received + self.currency = currency + self.cost_excluding_tax = cost_excluding_tax + self.invoice_cost = invoice_cost + if non_discounted_cost is not None: + self.non_discounted_cost = non_discounted_cost + if non_discounted_cost_excluding_tax is not None: + self.non_discounted_cost_excluding_tax = non_discounted_cost_excluding_tax + if invoice_paid is not None: + self.invoice_paid = invoice_paid + if discount_amount is not None: + self.discount_amount = discount_amount + if discount_amount_excluding_tax is not None: + self.discount_amount_excluding_tax = discount_amount_excluding_tax + if invoice_refunded is not None: + self.invoice_refunded = invoice_refunded + self.credit_rolled_over = credit_rolled_over + if credit_rolled_over_excluding_tax is not None: + self.credit_rolled_over_excluding_tax = credit_rolled_over_excluding_tax + self.type = type + if locked is not None: + self.locked = locked + if managed_by is not None: + self.managed_by = managed_by + self.initial_invoice = initial_invoice + self.processing = processing + if purchase_order is not None: + self.purchase_order = purchase_order + self.version_number = version_number + if invoice_lines is not None: + self.invoice_lines = invoice_lines + if tax_lines is not None: + self.tax_lines = tax_lines + if invoice_payments is not None: + self.invoice_payments = invoice_payments + if invoice_refunds is not None: + self.invoice_refunds = invoice_refunds + if invoice_credit_notes is not None: + self.invoice_credit_notes = invoice_credit_notes + if charges is not None: + self.charges = charges + if payment_terms is not None: + self.payment_terms = payment_terms + if children is not None: + self.children = children + if executions is not None: + self.executions = executions + if total_invoice_cost is not None: + self.total_invoice_cost = total_invoice_cost + if zero_cost is not None: + self.zero_cost = zero_cost + if c_rmid is not None: + self.c_rmid = c_rmid @property def created(self): - """ - Gets the created of this Invoice. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this Invoice. # noqa: E501 + - :return: The created of this Invoice. + :return: The created of this Invoice. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this Invoice. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this Invoice. - :param created: The created of this Invoice. + + :param created: The created of this Invoice. # noqa: E501 :type: datetime """ @@ -213,22 +318,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this Invoice. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this Invoice. # noqa: E501 + - :return: The changed_by of this Invoice. + :return: The changed_by of this Invoice. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this Invoice. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this Invoice. + - :param changed_by: The changed_by of this Invoice. + :param changed_by: The changed_by of this Invoice. # noqa: E501 :type: str """ @@ -236,45 +339,62 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this Invoice. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this Invoice. # noqa: E501 - :return: The updated of this Invoice. + + :return: The updated of this Invoice. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this Invoice. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this Invoice. + - :param updated: The updated of this Invoice. + :param updated: The updated of this Invoice. # noqa: E501 :type: datetime """ self._updated = updated @property - def version_id(self): + def metadata(self): + """Gets the metadata of this Invoice. # noqa: E501 + + + :return: The metadata of this Invoice. # noqa: E501 + :rtype: dict(str, object) """ - Gets the version_id of this Invoice. - { \"description\" : \"Version identifier of the invoice.\", \"verbs\":[\"GET\"] } + return self._metadata - :return: The version_id of this Invoice. + @metadata.setter + def metadata(self, metadata): + """Sets the metadata of this Invoice. + + + :param metadata: The metadata of this Invoice. # noqa: E501 + :type: dict(str, object) + """ + + self._metadata = metadata + + @property + def version_id(self): + """Gets the version_id of this Invoice. # noqa: E501 + + + :return: The version_id of this Invoice. # noqa: E501 :rtype: str """ return self._version_id @version_id.setter def version_id(self, version_id): - """ - Sets the version_id of this Invoice. - { \"description\" : \"Version identifier of the invoice.\", \"verbs\":[\"GET\"] } + """Sets the version_id of this Invoice. + - :param version_id: The version_id of this Invoice. + :param version_id: The version_id of this Invoice. # noqa: E501 :type: str """ @@ -282,68 +402,41 @@ def version_id(self, version_id): @property def id(self): - """ - Gets the id of this Invoice. - { \"description\" : \"Unique identifier for the invoice.\", \"verbs\":[\"GET\"] } + """Gets the id of this Invoice. # noqa: E501 - :return: The id of this Invoice. + + :return: The id of this Invoice. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this Invoice. - { \"description\" : \"Unique identifier for the invoice.\", \"verbs\":[\"GET\"] } + """Sets the id of this Invoice. - :param id: The id of this Invoice. - :type: str - """ - - self._id = id - - @property - def crm_id(self): - """ - Gets the crm_id of this Invoice. - { \"description\" : \"CRM identifier of the invoice.\", \"verbs\":[\"PUT\",\"GET\"] } - - :return: The crm_id of this Invoice. - :rtype: str - """ - return self._crm_id - - @crm_id.setter - def crm_id(self, crm_id): - """ - Sets the crm_id of this Invoice. - { \"description\" : \"CRM identifier of the invoice.\", \"verbs\":[\"PUT\",\"GET\"] } - :param crm_id: The crm_id of this Invoice. + :param id: The id of this Invoice. # noqa: E501 :type: str """ - self._crm_id = crm_id + self._id = id @property def subscription_id(self): - """ - Gets the subscription_id of this Invoice. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the subscription_id of this Invoice. # noqa: E501 + - :return: The subscription_id of this Invoice. + :return: The subscription_id of this Invoice. # noqa: E501 :rtype: str """ return self._subscription_id @subscription_id.setter def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this Invoice. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the subscription_id of this Invoice. + - :param subscription_id: The subscription_id of this Invoice. + :param subscription_id: The subscription_id of this Invoice. # noqa: E501 :type: str """ @@ -351,22 +444,20 @@ def subscription_id(self, subscription_id): @property def subscription_version_id(self): - """ - Gets the subscription_version_id of this Invoice. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the subscription_version_id of this Invoice. # noqa: E501 - :return: The subscription_version_id of this Invoice. + + :return: The subscription_version_id of this Invoice. # noqa: E501 :rtype: str """ return self._subscription_version_id @subscription_version_id.setter def subscription_version_id(self, subscription_version_id): - """ - Sets the subscription_version_id of this Invoice. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the subscription_version_id of this Invoice. + - :param subscription_version_id: The subscription_version_id of this Invoice. + :param subscription_version_id: The subscription_version_id of this Invoice. # noqa: E501 :type: str """ @@ -374,68 +465,66 @@ def subscription_version_id(self, subscription_version_id): @property def account_id(self): - """ - Gets the account_id of this Invoice. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the account_id of this Invoice. # noqa: E501 + - :return: The account_id of this Invoice. + :return: The account_id of this Invoice. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this Invoice. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the account_id of this Invoice. - :param account_id: The account_id of this Invoice. + + :param account_id: The account_id of this Invoice. # noqa: E501 :type: str """ + if account_id is None: + raise ValueError("Invalid value for `account_id`, must not be `None`") # noqa: E501 self._account_id = account_id @property def organization_id(self): - """ - Gets the organization_id of this Invoice. - { \"description\" : \"\", \"verbs\":[] } + """Gets the organization_id of this Invoice. # noqa: E501 + - :return: The organization_id of this Invoice. + :return: The organization_id of this Invoice. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this Invoice. - { \"description\" : \"\", \"verbs\":[] } + """Sets the organization_id of this Invoice. + - :param organization_id: The organization_id of this Invoice. + :param organization_id: The organization_id of this Invoice. # noqa: E501 :type: str """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 self._organization_id = organization_id @property def parent_invoice_id(self): - """ - Gets the parent_invoice_id of this Invoice. - { \"description\" : \"\", \"verbs\":[] } + """Gets the parent_invoice_id of this Invoice. # noqa: E501 - :return: The parent_invoice_id of this Invoice. + + :return: The parent_invoice_id of this Invoice. # noqa: E501 :rtype: str """ return self._parent_invoice_id @parent_invoice_id.setter def parent_invoice_id(self, parent_invoice_id): - """ - Sets the parent_invoice_id of this Invoice. - { \"description\" : \"\", \"verbs\":[] } + """Sets the parent_invoice_id of this Invoice. + - :param parent_invoice_id: The parent_invoice_id of this Invoice. + :param parent_invoice_id: The parent_invoice_id of this Invoice. # noqa: E501 :type: str """ @@ -443,22 +532,20 @@ def parent_invoice_id(self, parent_invoice_id): @property def name(self): - """ - Gets the name of this Invoice. - { \"description\" : \"The name of the invoice\", \"verbs\":[] } + """Gets the name of this Invoice. # noqa: E501 + - :return: The name of this Invoice. + :return: The name of this Invoice. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this Invoice. - { \"description\" : \"The name of the invoice\", \"verbs\":[] } + """Sets the name of this Invoice. - :param name: The name of this Invoice. + + :param name: The name of this Invoice. # noqa: E501 :type: str """ @@ -466,22 +553,20 @@ def name(self, name): @property def description(self): - """ - Gets the description of this Invoice. - { \"description\" : \"The description of the invoice\", \"verbs\":[] } + """Gets the description of this Invoice. # noqa: E501 + - :return: The description of this Invoice. + :return: The description of this Invoice. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this Invoice. - { \"description\" : \"The description of the invoice\", \"verbs\":[] } + """Sets the description of this Invoice. + - :param description: The description of this Invoice. + :param description: The description of this Invoice. # noqa: E501 :type: str """ @@ -489,28 +574,28 @@ def description(self, description): @property def state(self): - """ - Gets the state of this Invoice. - { \"description\" : \"Initially an invoice is set as unpaid. Once payment for the full value of the invoice has been received it is marked as paid. An invoice may be paid from various sources including cards, coupons or manual payments.\", \"verbs\":[\"GET\"] } + """Gets the state of this Invoice. # noqa: E501 - :return: The state of this Invoice. + + :return: The state of this Invoice. # noqa: E501 :rtype: str """ return self._state @state.setter def state(self, state): - """ - Sets the state of this Invoice. - { \"description\" : \"Initially an invoice is set as unpaid. Once payment for the full value of the invoice has been received it is marked as paid. An invoice may be paid from various sources including cards, coupons or manual payments.\", \"verbs\":[\"GET\"] } + """Sets the state of this Invoice. + - :param state: The state of this Invoice. + :param state: The state of this Invoice. # noqa: E501 :type: str """ - allowed_values = ["Paid", "Unpaid", "Pending", "Voided"] + if state is None: + raise ValueError("Invalid value for `state`, must not be `None`") # noqa: E501 + allowed_values = ["Paid", "Unpaid", "Pending", "Voided"] # noqa: E501 if state not in allowed_values: raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 .format(state, allowed_values) ) @@ -518,137 +603,127 @@ def state(self, state): @property def issued(self): - """ - Gets the issued of this Invoice. - { \"description\" : \"The UTC DateTime when the invoice was first issued.\", \"verbs\":[\"GET\"] } + """Gets the issued of this Invoice. # noqa: E501 + - :return: The issued of this Invoice. + :return: The issued of this Invoice. # noqa: E501 :rtype: datetime """ return self._issued @issued.setter def issued(self, issued): - """ - Sets the issued of this Invoice. - { \"description\" : \"The UTC DateTime when the invoice was first issued.\", \"verbs\":[\"GET\"] } + """Sets the issued of this Invoice. - :param issued: The issued of this Invoice. + + :param issued: The issued of this Invoice. # noqa: E501 :type: datetime """ self._issued = issued @property - def period_start(self): - """ - Gets the period_start of this Invoice. - { \"description\" : \"Start of the period being billed by this invoice, UTC DateTime\", \"verbs\":[\"GET\"] } + def due(self): + """Gets the due of this Invoice. # noqa: E501 + - :return: The period_start of this Invoice. + :return: The due of this Invoice. # noqa: E501 :rtype: datetime """ - return self._period_start + return self._due + + @due.setter + def due(self, due): + """Sets the due of this Invoice. - @period_start.setter - def period_start(self, period_start): - """ - Sets the period_start of this Invoice. - { \"description\" : \"Start of the period being billed by this invoice, UTC DateTime\", \"verbs\":[\"GET\"] } - :param period_start: The period_start of this Invoice. + :param due: The due of this Invoice. # noqa: E501 :type: datetime """ - self._period_start = period_start + self._due = due @property - def period_end(self): - """ - Gets the period_end of this Invoice. - { \"description\" : \"End of the period being billed by this invoice, UTC DateTime.\", \"verbs\":[\"GET\"] } + def period_start(self): + """Gets the period_start of this Invoice. # noqa: E501 + - :return: The period_end of this Invoice. + :return: The period_start of this Invoice. # noqa: E501 :rtype: datetime """ - return self._period_end + return self._period_start - @period_end.setter - def period_end(self, period_end): - """ - Sets the period_end of this Invoice. - { \"description\" : \"End of the period being billed by this invoice, UTC DateTime.\", \"verbs\":[\"GET\"] } + @period_start.setter + def period_start(self, period_start): + """Sets the period_start of this Invoice. - :param period_end: The period_end of this Invoice. + + :param period_start: The period_start of this Invoice. # noqa: E501 :type: datetime """ - self._period_end = period_end + self._period_start = period_start @property - def due(self): - """ - Gets the due of this Invoice. - { \"description\" : \"Date this invoice is due, UTC DateTime.\", \"verbs\":[\"GET\"] } + def period_end(self): + """Gets the period_end of this Invoice. # noqa: E501 - :return: The due of this Invoice. + + :return: The period_end of this Invoice. # noqa: E501 :rtype: datetime """ - return self._due + return self._period_end + + @period_end.setter + def period_end(self, period_end): + """Sets the period_end of this Invoice. - @due.setter - def due(self, due): - """ - Sets the due of this Invoice. - { \"description\" : \"Date this invoice is due, UTC DateTime.\", \"verbs\":[\"GET\"] } - :param due: The due of this Invoice. + :param period_end: The period_end of this Invoice. # noqa: E501 :type: datetime """ - self._due = due + self._period_end = period_end @property def deleted(self): - """ - Gets the deleted of this Invoice. - { \"description\" : \"Indicates if an invoice has been retired. If an invoice has been retired it can still be retrieved using the appropriate flag on API requests. Generally invoices will not be retired.\", \"verbs\":[] } + """Gets the deleted of this Invoice. # noqa: E501 - :return: The deleted of this Invoice. + + :return: The deleted of this Invoice. # noqa: E501 :rtype: bool """ return self._deleted @deleted.setter def deleted(self, deleted): - """ - Sets the deleted of this Invoice. - { \"description\" : \"Indicates if an invoice has been retired. If an invoice has been retired it can still be retrieved using the appropriate flag on API requests. Generally invoices will not be retired.\", \"verbs\":[] } + """Sets the deleted of this Invoice. + - :param deleted: The deleted of this Invoice. + :param deleted: The deleted of this Invoice. # noqa: E501 :type: bool """ + if deleted is None: + raise ValueError("Invalid value for `deleted`, must not be `None`") # noqa: E501 self._deleted = deleted @property def total_execution_attempts(self): - """ - Gets the total_execution_attempts of this Invoice. - { \"description\" : \"Number of payment attempts for this invoice. This includes any manual execution attempts.\", \"verbs\":[\"GET\"] } + """Gets the total_execution_attempts of this Invoice. # noqa: E501 + - :return: The total_execution_attempts of this Invoice. + :return: The total_execution_attempts of this Invoice. # noqa: E501 :rtype: int """ return self._total_execution_attempts @total_execution_attempts.setter def total_execution_attempts(self, total_execution_attempts): - """ - Sets the total_execution_attempts of this Invoice. - { \"description\" : \"Number of payment attempts for this invoice. This includes any manual execution attempts.\", \"verbs\":[\"GET\"] } + """Sets the total_execution_attempts of this Invoice. - :param total_execution_attempts: The total_execution_attempts of this Invoice. + + :param total_execution_attempts: The total_execution_attempts of this Invoice. # noqa: E501 :type: int """ @@ -656,22 +731,20 @@ def total_execution_attempts(self, total_execution_attempts): @property def last_execution_attempt(self): - """ - Gets the last_execution_attempt of this Invoice. - { \"description\" : \"UTC DateTime of the invoice's last execution attempt. This was the last time an attempt was made to take payment for this invoice.\", \"verbs\":[\"GET\"] } + """Gets the last_execution_attempt of this Invoice. # noqa: E501 + - :return: The last_execution_attempt of this Invoice. + :return: The last_execution_attempt of this Invoice. # noqa: E501 :rtype: datetime """ return self._last_execution_attempt @last_execution_attempt.setter def last_execution_attempt(self, last_execution_attempt): - """ - Sets the last_execution_attempt of this Invoice. - { \"description\" : \"UTC DateTime of the invoice's last execution attempt. This was the last time an attempt was made to take payment for this invoice.\", \"verbs\":[\"GET\"] } + """Sets the last_execution_attempt of this Invoice. + - :param last_execution_attempt: The last_execution_attempt of this Invoice. + :param last_execution_attempt: The last_execution_attempt of this Invoice. # noqa: E501 :type: datetime """ @@ -679,22 +752,20 @@ def last_execution_attempt(self, last_execution_attempt): @property def next_execution_attempt(self): - """ - Gets the next_execution_attempt of this Invoice. - { \"description\" : \"UTC DateTime of the invoice's next execution attempt. If the next execution attempt is greater than the period end for this invoice, the invoice will not receive another automatic execution attempt.\", \"verbs\":[\"GET\"] } + """Gets the next_execution_attempt of this Invoice. # noqa: E501 - :return: The next_execution_attempt of this Invoice. + + :return: The next_execution_attempt of this Invoice. # noqa: E501 :rtype: datetime """ return self._next_execution_attempt @next_execution_attempt.setter def next_execution_attempt(self, next_execution_attempt): - """ - Sets the next_execution_attempt of this Invoice. - { \"description\" : \"UTC DateTime of the invoice's next execution attempt. If the next execution attempt is greater than the period end for this invoice, the invoice will not receive another automatic execution attempt.\", \"verbs\":[\"GET\"] } + """Sets the next_execution_attempt of this Invoice. - :param next_execution_attempt: The next_execution_attempt of this Invoice. + + :param next_execution_attempt: The next_execution_attempt of this Invoice. # noqa: E501 :type: datetime """ @@ -702,22 +773,20 @@ def next_execution_attempt(self, next_execution_attempt): @property def final_execution_attempt(self): - """ - Gets the final_execution_attempt of this Invoice. - { \"description\" : \"UTC DateTime of the invoice's final execution attempt. The final execution attempt. This may be less than the next execution attempt if the next execution attempt never occurred.\", \"verbs\":[\"GET\"] } + """Gets the final_execution_attempt of this Invoice. # noqa: E501 + - :return: The final_execution_attempt of this Invoice. + :return: The final_execution_attempt of this Invoice. # noqa: E501 :rtype: datetime """ return self._final_execution_attempt @final_execution_attempt.setter def final_execution_attempt(self, final_execution_attempt): - """ - Sets the final_execution_attempt of this Invoice. - { \"description\" : \"UTC DateTime of the invoice's final execution attempt. The final execution attempt. This may be less than the next execution attempt if the next execution attempt never occurred.\", \"verbs\":[\"GET\"] } + """Sets the final_execution_attempt of this Invoice. + - :param final_execution_attempt: The final_execution_attempt of this Invoice. + :param final_execution_attempt: The final_execution_attempt of this Invoice. # noqa: E501 :type: datetime """ @@ -725,22 +794,20 @@ def final_execution_attempt(self, final_execution_attempt): @property def payment_received(self): - """ - Gets the payment_received of this Invoice. - { \"description\" : \"UTC DateTime specifying when payment was received for the invoice.\", \"verbs\":[\"GET\"] } + """Gets the payment_received of this Invoice. # noqa: E501 - :return: The payment_received of this Invoice. + + :return: The payment_received of this Invoice. # noqa: E501 :rtype: datetime """ return self._payment_received @payment_received.setter def payment_received(self, payment_received): - """ - Sets the payment_received of this Invoice. - { \"description\" : \"UTC DateTime specifying when payment was received for the invoice.\", \"verbs\":[\"GET\"] } + """Sets the payment_received of this Invoice. + - :param payment_received: The payment_received of this Invoice. + :param payment_received: The payment_received of this Invoice. # noqa: E501 :type: datetime """ @@ -748,91 +815,89 @@ def payment_received(self, payment_received): @property def currency(self): - """ - Gets the currency of this Invoice. - { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } + """Gets the currency of this Invoice. # noqa: E501 - :return: The currency of this Invoice. - :rtype: str + + :return: The currency of this Invoice. # noqa: E501 + :rtype: CreditNoteCurrency """ return self._currency @currency.setter def currency(self, currency): - """ - Sets the currency of this Invoice. - { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } + """Sets the currency of this Invoice. - :param currency: The currency of this Invoice. - :type: str + + :param currency: The currency of this Invoice. # noqa: E501 + :type: CreditNoteCurrency """ + if currency is None: + raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501 self._currency = currency @property def cost_excluding_tax(self): - """ - Gets the cost_excluding_tax of this Invoice. - { \"description\" : \"Cost of the invoice exclusive of tax.\", \"verbs\":[\"GET\"] } + """Gets the cost_excluding_tax of this Invoice. # noqa: E501 + - :return: The cost_excluding_tax of this Invoice. + :return: The cost_excluding_tax of this Invoice. # noqa: E501 :rtype: float """ return self._cost_excluding_tax @cost_excluding_tax.setter def cost_excluding_tax(self, cost_excluding_tax): - """ - Sets the cost_excluding_tax of this Invoice. - { \"description\" : \"Cost of the invoice exclusive of tax.\", \"verbs\":[\"GET\"] } + """Sets the cost_excluding_tax of this Invoice. - :param cost_excluding_tax: The cost_excluding_tax of this Invoice. + + :param cost_excluding_tax: The cost_excluding_tax of this Invoice. # noqa: E501 :type: float """ + if cost_excluding_tax is None: + raise ValueError("Invalid value for `cost_excluding_tax`, must not be `None`") # noqa: E501 self._cost_excluding_tax = cost_excluding_tax @property def invoice_cost(self): - """ - Gets the invoice_cost of this Invoice. - { \"description\" : \"Cost of the invoice inclusive of tax.\", \"verbs\":[\"GET\"] } + """Gets the invoice_cost of this Invoice. # noqa: E501 + - :return: The invoice_cost of this Invoice. + :return: The invoice_cost of this Invoice. # noqa: E501 :rtype: float """ return self._invoice_cost @invoice_cost.setter def invoice_cost(self, invoice_cost): - """ - Sets the invoice_cost of this Invoice. - { \"description\" : \"Cost of the invoice inclusive of tax.\", \"verbs\":[\"GET\"] } + """Sets the invoice_cost of this Invoice. + - :param invoice_cost: The invoice_cost of this Invoice. + :param invoice_cost: The invoice_cost of this Invoice. # noqa: E501 :type: float """ + if invoice_cost is None: + raise ValueError("Invalid value for `invoice_cost`, must not be `None`") # noqa: E501 self._invoice_cost = invoice_cost @property def non_discounted_cost(self): - """ - Gets the non_discounted_cost of this Invoice. - Cost of the invoice before discounts, inclusive of tax. + """Gets the non_discounted_cost of this Invoice. # noqa: E501 - :return: The non_discounted_cost of this Invoice. + + :return: The non_discounted_cost of this Invoice. # noqa: E501 :rtype: float """ return self._non_discounted_cost @non_discounted_cost.setter def non_discounted_cost(self, non_discounted_cost): - """ - Sets the non_discounted_cost of this Invoice. - Cost of the invoice before discounts, inclusive of tax. + """Sets the non_discounted_cost of this Invoice. + - :param non_discounted_cost: The non_discounted_cost of this Invoice. + :param non_discounted_cost: The non_discounted_cost of this Invoice. # noqa: E501 :type: float """ @@ -840,22 +905,20 @@ def non_discounted_cost(self, non_discounted_cost): @property def non_discounted_cost_excluding_tax(self): - """ - Gets the non_discounted_cost_excluding_tax of this Invoice. - Cost of the invoice before discounts, inclusive of tax. + """Gets the non_discounted_cost_excluding_tax of this Invoice. # noqa: E501 + - :return: The non_discounted_cost_excluding_tax of this Invoice. + :return: The non_discounted_cost_excluding_tax of this Invoice. # noqa: E501 :rtype: float """ return self._non_discounted_cost_excluding_tax @non_discounted_cost_excluding_tax.setter def non_discounted_cost_excluding_tax(self, non_discounted_cost_excluding_tax): - """ - Sets the non_discounted_cost_excluding_tax of this Invoice. - Cost of the invoice before discounts, inclusive of tax. + """Sets the non_discounted_cost_excluding_tax of this Invoice. - :param non_discounted_cost_excluding_tax: The non_discounted_cost_excluding_tax of this Invoice. + + :param non_discounted_cost_excluding_tax: The non_discounted_cost_excluding_tax of this Invoice. # noqa: E501 :type: float """ @@ -863,22 +926,20 @@ def non_discounted_cost_excluding_tax(self, non_discounted_cost_excluding_tax): @property def invoice_paid(self): - """ - Gets the invoice_paid of this Invoice. - { \"description\" : \"Total amount of the invoice currently paid for. As the invoice may be paid by multiple payments, for example partly paid for by a voucher and then paid for by a card, this indicates the current paid amount of the invoice.\", \"verbs\":[\"GET\"] } + """Gets the invoice_paid of this Invoice. # noqa: E501 + - :return: The invoice_paid of this Invoice. + :return: The invoice_paid of this Invoice. # noqa: E501 :rtype: float """ return self._invoice_paid @invoice_paid.setter def invoice_paid(self, invoice_paid): - """ - Sets the invoice_paid of this Invoice. - { \"description\" : \"Total amount of the invoice currently paid for. As the invoice may be paid by multiple payments, for example partly paid for by a voucher and then paid for by a card, this indicates the current paid amount of the invoice.\", \"verbs\":[\"GET\"] } + """Sets the invoice_paid of this Invoice. + - :param invoice_paid: The invoice_paid of this Invoice. + :param invoice_paid: The invoice_paid of this Invoice. # noqa: E501 :type: float """ @@ -886,22 +947,20 @@ def invoice_paid(self, invoice_paid): @property def discount_amount(self): - """ - Gets the discount_amount of this Invoice. - { \"description\" : \"The amount of discounts for the invoice.\", \"verbs\":[\"GET\"] } + """Gets the discount_amount of this Invoice. # noqa: E501 - :return: The discount_amount of this Invoice. + + :return: The discount_amount of this Invoice. # noqa: E501 :rtype: float """ return self._discount_amount @discount_amount.setter def discount_amount(self, discount_amount): - """ - Sets the discount_amount of this Invoice. - { \"description\" : \"The amount of discounts for the invoice.\", \"verbs\":[\"GET\"] } + """Sets the discount_amount of this Invoice. + - :param discount_amount: The discount_amount of this Invoice. + :param discount_amount: The discount_amount of this Invoice. # noqa: E501 :type: float """ @@ -909,22 +968,20 @@ def discount_amount(self, discount_amount): @property def discount_amount_excluding_tax(self): - """ - Gets the discount_amount_excluding_tax of this Invoice. - { \"description\" : \"The amount of discounts for the invoice excluding tax.\", \"verbs\":[\"GET\"] } + """Gets the discount_amount_excluding_tax of this Invoice. # noqa: E501 + - :return: The discount_amount_excluding_tax of this Invoice. + :return: The discount_amount_excluding_tax of this Invoice. # noqa: E501 :rtype: float """ return self._discount_amount_excluding_tax @discount_amount_excluding_tax.setter def discount_amount_excluding_tax(self, discount_amount_excluding_tax): - """ - Sets the discount_amount_excluding_tax of this Invoice. - { \"description\" : \"The amount of discounts for the invoice excluding tax.\", \"verbs\":[\"GET\"] } + """Sets the discount_amount_excluding_tax of this Invoice. - :param discount_amount_excluding_tax: The discount_amount_excluding_tax of this Invoice. + + :param discount_amount_excluding_tax: The discount_amount_excluding_tax of this Invoice. # noqa: E501 :type: float """ @@ -932,22 +989,20 @@ def discount_amount_excluding_tax(self, discount_amount_excluding_tax): @property def invoice_refunded(self): - """ - Gets the invoice_refunded of this Invoice. - { \"description\" : \"Total amount of the invoice refunded.\", \"verbs\":[\"GET\"] } + """Gets the invoice_refunded of this Invoice. # noqa: E501 + - :return: The invoice_refunded of this Invoice. + :return: The invoice_refunded of this Invoice. # noqa: E501 :rtype: float """ return self._invoice_refunded @invoice_refunded.setter def invoice_refunded(self, invoice_refunded): - """ - Sets the invoice_refunded of this Invoice. - { \"description\" : \"Total amount of the invoice refunded.\", \"verbs\":[\"GET\"] } + """Sets the invoice_refunded of this Invoice. + - :param invoice_refunded: The invoice_refunded of this Invoice. + :param invoice_refunded: The invoice_refunded of this Invoice. # noqa: E501 :type: float """ @@ -955,45 +1010,43 @@ def invoice_refunded(self, invoice_refunded): @property def credit_rolled_over(self): - """ - Gets the credit_rolled_over of this Invoice. - { \"description\" : \"The amount of credit to be returned to the pool.\", \"verbs\":[\"GET\"] } + """Gets the credit_rolled_over of this Invoice. # noqa: E501 + - :return: The credit_rolled_over of this Invoice. + :return: The credit_rolled_over of this Invoice. # noqa: E501 :rtype: float """ return self._credit_rolled_over @credit_rolled_over.setter def credit_rolled_over(self, credit_rolled_over): - """ - Sets the credit_rolled_over of this Invoice. - { \"description\" : \"The amount of credit to be returned to the pool.\", \"verbs\":[\"GET\"] } + """Sets the credit_rolled_over of this Invoice. - :param credit_rolled_over: The credit_rolled_over of this Invoice. + + :param credit_rolled_over: The credit_rolled_over of this Invoice. # noqa: E501 :type: float """ + if credit_rolled_over is None: + raise ValueError("Invalid value for `credit_rolled_over`, must not be `None`") # noqa: E501 self._credit_rolled_over = credit_rolled_over @property def credit_rolled_over_excluding_tax(self): - """ - Gets the credit_rolled_over_excluding_tax of this Invoice. - { \"description\" : \"The amount of credit to be returned to the pool excluding tax.\", \"verbs\":[\"GET\"] } + """Gets the credit_rolled_over_excluding_tax of this Invoice. # noqa: E501 + - :return: The credit_rolled_over_excluding_tax of this Invoice. + :return: The credit_rolled_over_excluding_tax of this Invoice. # noqa: E501 :rtype: float """ return self._credit_rolled_over_excluding_tax @credit_rolled_over_excluding_tax.setter def credit_rolled_over_excluding_tax(self, credit_rolled_over_excluding_tax): - """ - Sets the credit_rolled_over_excluding_tax of this Invoice. - { \"description\" : \"The amount of credit to be returned to the pool excluding tax.\", \"verbs\":[\"GET\"] } + """Sets the credit_rolled_over_excluding_tax of this Invoice. + - :param credit_rolled_over_excluding_tax: The credit_rolled_over_excluding_tax of this Invoice. + :param credit_rolled_over_excluding_tax: The credit_rolled_over_excluding_tax of this Invoice. # noqa: E501 :type: float """ @@ -1001,28 +1054,28 @@ def credit_rolled_over_excluding_tax(self, credit_rolled_over_excluding_tax): @property def type(self): - """ - Gets the type of this Invoice. - { \"description\" : \"The type of the invoice. A subscription invoice is raised every time a subscription recurs. An amendment is created for intra-contract changes. An Adhoc invoice is created for payment that is taken out-of-band of a subscription. Finally the invoice generated for a trial period is marked as Trial.\", \"verbs\":[\"GET\"] } + """Gets the type of this Invoice. # noqa: E501 - :return: The type of this Invoice. + + :return: The type of this Invoice. # noqa: E501 :rtype: str """ return self._type @type.setter def type(self, type): - """ - Sets the type of this Invoice. - { \"description\" : \"The type of the invoice. A subscription invoice is raised every time a subscription recurs. An amendment is created for intra-contract changes. An Adhoc invoice is created for payment that is taken out-of-band of a subscription. Finally the invoice generated for a trial period is marked as Trial.\", \"verbs\":[\"GET\"] } + """Sets the type of this Invoice. + - :param type: The type of this Invoice. + :param type: The type of this Invoice. # noqa: E501 :type: str """ - allowed_values = ["Subscription", "Trial", "Charge", "FinalArrears", "Amendment", "Aggregated"] + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + allowed_values = ["Subscription", "Trial", "Charge", "FinalArrears", "Amendment", "Aggregated", "AffiliateCommission"] # noqa: E501 if type not in allowed_values: raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 .format(type, allowed_values) ) @@ -1030,22 +1083,20 @@ def type(self, type): @property def locked(self): - """ - Gets the locked of this Invoice. - { \"description\" : \"If the subscription is locked, it will not be processed by the system\", \"verbs\":[] } + """Gets the locked of this Invoice. # noqa: E501 + - :return: The locked of this Invoice. + :return: The locked of this Invoice. # noqa: E501 :rtype: str """ return self._locked @locked.setter def locked(self, locked): - """ - Sets the locked of this Invoice. - { \"description\" : \"If the subscription is locked, it will not be processed by the system\", \"verbs\":[] } + """Sets the locked of this Invoice. - :param locked: The locked of this Invoice. + + :param locked: The locked of this Invoice. # noqa: E501 :type: str """ @@ -1053,28 +1104,26 @@ def locked(self, locked): @property def managed_by(self): - """ - Gets the managed_by of this Invoice. - { \"description\" : \"Which system is responsible for managing the subscription.\", \"verbs\":[] } + """Gets the managed_by of this Invoice. # noqa: E501 + - :return: The managed_by of this Invoice. + :return: The managed_by of this Invoice. # noqa: E501 :rtype: str """ return self._managed_by @managed_by.setter def managed_by(self, managed_by): - """ - Sets the managed_by of this Invoice. - { \"description\" : \"Which system is responsible for managing the subscription.\", \"verbs\":[] } + """Sets the managed_by of this Invoice. + - :param managed_by: The managed_by of this Invoice. + :param managed_by: The managed_by of this Invoice. # noqa: E501 :type: str """ - allowed_values = ["BillForward", "Stripe"] + allowed_values = ["BillForward", "Stripe"] # noqa: E501 if managed_by not in allowed_values: raise ValueError( - "Invalid value for `managed_by` ({0}), must be one of {1}" + "Invalid value for `managed_by` ({0}), must be one of {1}" # noqa: E501 .format(managed_by, allowed_values) ) @@ -1082,137 +1131,173 @@ def managed_by(self, managed_by): @property def initial_invoice(self): - """ - Gets the initial_invoice of this Invoice. - { \"description\" : \"Is this an initial invoice. An initial invoice is the first invoice generated for a subscription. Initial invoices will not have dunning applied to them and as such will only have a single payment attempt. For trial periods, the trial invoice is the initial invoice.\", \"verbs\":[\"GET\"] } + """Gets the initial_invoice of this Invoice. # noqa: E501 - :return: The initial_invoice of this Invoice. + + :return: The initial_invoice of this Invoice. # noqa: E501 :rtype: bool """ return self._initial_invoice @initial_invoice.setter def initial_invoice(self, initial_invoice): - """ - Sets the initial_invoice of this Invoice. - { \"description\" : \"Is this an initial invoice. An initial invoice is the first invoice generated for a subscription. Initial invoices will not have dunning applied to them and as such will only have a single payment attempt. For trial periods, the trial invoice is the initial invoice.\", \"verbs\":[\"GET\"] } + """Sets the initial_invoice of this Invoice. + - :param initial_invoice: The initial_invoice of this Invoice. + :param initial_invoice: The initial_invoice of this Invoice. # noqa: E501 :type: bool """ + if initial_invoice is None: + raise ValueError("Invalid value for `initial_invoice`, must not be `None`") # noqa: E501 self._initial_invoice = initial_invoice @property - def version_number(self): + def processing(self): + """Gets the processing of this Invoice. # noqa: E501 + + + :return: The processing of this Invoice. # noqa: E501 + :rtype: bool + """ + return self._processing + + @processing.setter + def processing(self, processing): + """Sets the processing of this Invoice. + + + :param processing: The processing of this Invoice. # noqa: E501 + :type: bool """ - Gets the version_number of this Invoice. - { \"description\" : \"The version number of the Invoice. The first version of an Invoice is version number 1\", \"verbs\":[\"GET\"] } + if processing is None: + raise ValueError("Invalid value for `processing`, must not be `None`") # noqa: E501 + + self._processing = processing + + @property + def purchase_order(self): + """Gets the purchase_order of this Invoice. # noqa: E501 + + + :return: The purchase_order of this Invoice. # noqa: E501 + :rtype: str + """ + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this Invoice. + + + :param purchase_order: The purchase_order of this Invoice. # noqa: E501 + :type: str + """ + + self._purchase_order = purchase_order + + @property + def version_number(self): + """Gets the version_number of this Invoice. # noqa: E501 + - :return: The version_number of this Invoice. + :return: The version_number of this Invoice. # noqa: E501 :rtype: int """ return self._version_number @version_number.setter def version_number(self, version_number): - """ - Sets the version_number of this Invoice. - { \"description\" : \"The version number of the Invoice. The first version of an Invoice is version number 1\", \"verbs\":[\"GET\"] } + """Sets the version_number of this Invoice. + - :param version_number: The version_number of this Invoice. + :param version_number: The version_number of this Invoice. # noqa: E501 :type: int """ + if version_number is None: + raise ValueError("Invalid value for `version_number`, must not be `None`") # noqa: E501 self._version_number = version_number @property def invoice_lines(self): - """ - Gets the invoice_lines of this Invoice. - { \"description\" : \"The collection of invoice-lines associated with the invoice.\", \"verbs\":[\"GET\"] } + """Gets the invoice_lines of this Invoice. # noqa: E501 - :return: The invoice_lines of this Invoice. - :rtype: list[InvoiceLine] + + :return: The invoice_lines of this Invoice. # noqa: E501 + :rtype: list[InvoiceLines] """ return self._invoice_lines @invoice_lines.setter def invoice_lines(self, invoice_lines): - """ - Sets the invoice_lines of this Invoice. - { \"description\" : \"The collection of invoice-lines associated with the invoice.\", \"verbs\":[\"GET\"] } + """Sets the invoice_lines of this Invoice. + - :param invoice_lines: The invoice_lines of this Invoice. - :type: list[InvoiceLine] + :param invoice_lines: The invoice_lines of this Invoice. # noqa: E501 + :type: list[InvoiceLines] """ self._invoice_lines = invoice_lines @property def tax_lines(self): - """ - Gets the tax_lines of this Invoice. + """Gets the tax_lines of this Invoice. # noqa: E501 - :return: The tax_lines of this Invoice. - :rtype: list[InsertableBillingEntity] + :return: The tax_lines of this Invoice. # noqa: E501 + :rtype: list[TaxLine] """ return self._tax_lines @tax_lines.setter def tax_lines(self, tax_lines): - """ - Sets the tax_lines of this Invoice. + """Sets the tax_lines of this Invoice. - :param tax_lines: The tax_lines of this Invoice. - :type: list[InsertableBillingEntity] + :param tax_lines: The tax_lines of this Invoice. # noqa: E501 + :type: list[TaxLine] """ self._tax_lines = tax_lines @property def invoice_payments(self): - """ - Gets the invoice_payments of this Invoice. - { \"description\" : \"Payments used for this invoice. Multiple payments may be associated with the invoice.\", \"verbs\":[\"GET\"] } + """Gets the invoice_payments of this Invoice. # noqa: E501 - :return: The invoice_payments of this Invoice. - :rtype: list[InvoicePayment] + + :return: The invoice_payments of this Invoice. # noqa: E501 + :rtype: list[InvoicePayments] """ return self._invoice_payments @invoice_payments.setter def invoice_payments(self, invoice_payments): - """ - Sets the invoice_payments of this Invoice. - { \"description\" : \"Payments used for this invoice. Multiple payments may be associated with the invoice.\", \"verbs\":[\"GET\"] } + """Sets the invoice_payments of this Invoice. + - :param invoice_payments: The invoice_payments of this Invoice. - :type: list[InvoicePayment] + :param invoice_payments: The invoice_payments of this Invoice. # noqa: E501 + :type: list[InvoicePayments] """ self._invoice_payments = invoice_payments @property def invoice_refunds(self): - """ - Gets the invoice_refunds of this Invoice. - { \"description\" : \"Refunds associated with this invoice. Multiple refunds may be associated with the invoice.\", \"verbs\":[\"GET\"] } + """Gets the invoice_refunds of this Invoice. # noqa: E501 + - :return: The invoice_refunds of this Invoice. + :return: The invoice_refunds of this Invoice. # noqa: E501 :rtype: list[Refund] """ return self._invoice_refunds @invoice_refunds.setter def invoice_refunds(self, invoice_refunds): - """ - Sets the invoice_refunds of this Invoice. - { \"description\" : \"Refunds associated with this invoice. Multiple refunds may be associated with the invoice.\", \"verbs\":[\"GET\"] } + """Sets the invoice_refunds of this Invoice. - :param invoice_refunds: The invoice_refunds of this Invoice. + + :param invoice_refunds: The invoice_refunds of this Invoice. # noqa: E501 :type: list[Refund] """ @@ -1220,22 +1305,20 @@ def invoice_refunds(self, invoice_refunds): @property def invoice_credit_notes(self): - """ - Gets the invoice_credit_notes of this Invoice. - { \"description\" : \"Credit Notes associated with this invoice. Multiple credit notes may be associated with the invoice.\", \"verbs\":[\"GET\"] } + """Gets the invoice_credit_notes of this Invoice. # noqa: E501 + - :return: The invoice_credit_notes of this Invoice. + :return: The invoice_credit_notes of this Invoice. # noqa: E501 :rtype: list[CreditNote] """ return self._invoice_credit_notes @invoice_credit_notes.setter def invoice_credit_notes(self, invoice_credit_notes): - """ - Sets the invoice_credit_notes of this Invoice. - { \"description\" : \"Credit Notes associated with this invoice. Multiple credit notes may be associated with the invoice.\", \"verbs\":[\"GET\"] } + """Sets the invoice_credit_notes of this Invoice. + - :param invoice_credit_notes: The invoice_credit_notes of this Invoice. + :param invoice_credit_notes: The invoice_credit_notes of this Invoice. # noqa: E501 :type: list[CreditNote] """ @@ -1243,57 +1326,156 @@ def invoice_credit_notes(self, invoice_credit_notes): @property def charges(self): - """ - Gets the charges of this Invoice. + """Gets the charges of this Invoice. # noqa: E501 - :return: The charges of this Invoice. + :return: The charges of this Invoice. # noqa: E501 :rtype: list[SubscriptionCharge] """ return self._charges @charges.setter def charges(self, charges): - """ - Sets the charges of this Invoice. + """Sets the charges of this Invoice. - :param charges: The charges of this Invoice. + :param charges: The charges of this Invoice. # noqa: E501 :type: list[SubscriptionCharge] """ self._charges = charges @property - def children(self): + def payment_terms(self): + """Gets the payment_terms of this Invoice. # noqa: E501 + + + :return: The payment_terms of this Invoice. # noqa: E501 + :rtype: int + """ + return self._payment_terms + + @payment_terms.setter + def payment_terms(self, payment_terms): + """Sets the payment_terms of this Invoice. + + + :param payment_terms: The payment_terms of this Invoice. # noqa: E501 + :type: int """ - Gets the children of this Invoice. + self._payment_terms = payment_terms - :return: The children of this Invoice. + @property + def children(self): + """Gets the children of this Invoice. # noqa: E501 + + + :return: The children of this Invoice. # noqa: E501 :rtype: list[Invoice] """ return self._children @children.setter def children(self, children): - """ - Sets the children of this Invoice. + """Sets the children of this Invoice. - :param children: The children of this Invoice. + :param children: The children of this Invoice. # noqa: E501 :type: list[Invoice] """ self._children = children - def to_dict(self): + @property + def executions(self): + """Gets the executions of this Invoice. # noqa: E501 + + + :return: The executions of this Invoice. # noqa: E501 + :rtype: list[ExecutionReceiptResponse] + """ + return self._executions + + @executions.setter + def executions(self, executions): + """Sets the executions of this Invoice. + + + :param executions: The executions of this Invoice. # noqa: E501 + :type: list[ExecutionReceiptResponse] """ - Returns the model properties as a dict + + self._executions = executions + + @property + def total_invoice_cost(self): + """Gets the total_invoice_cost of this Invoice. # noqa: E501 + + + :return: The total_invoice_cost of this Invoice. # noqa: E501 + :rtype: float + """ + return self._total_invoice_cost + + @total_invoice_cost.setter + def total_invoice_cost(self, total_invoice_cost): + """Sets the total_invoice_cost of this Invoice. + + + :param total_invoice_cost: The total_invoice_cost of this Invoice. # noqa: E501 + :type: float + """ + + self._total_invoice_cost = total_invoice_cost + + @property + def zero_cost(self): + """Gets the zero_cost of this Invoice. # noqa: E501 + + + :return: The zero_cost of this Invoice. # noqa: E501 + :rtype: bool """ + return self._zero_cost + + @zero_cost.setter + def zero_cost(self, zero_cost): + """Sets the zero_cost of this Invoice. + + + :param zero_cost: The zero_cost of this Invoice. # noqa: E501 + :type: bool + """ + + self._zero_cost = zero_cost + + @property + def c_rmid(self): + """Gets the c_rmid of this Invoice. # noqa: E501 + + + :return: The c_rmid of this Invoice. # noqa: E501 + :rtype: str + """ + return self._c_rmid + + @c_rmid.setter + def c_rmid(self, c_rmid): + """Sets the c_rmid of this Invoice. + + + :param c_rmid: The c_rmid of this Invoice. # noqa: E501 + :type: str + """ + + self._c_rmid = c_rmid + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -1310,29 +1492,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Invoice, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Invoice): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/invoice_charge_request.py b/billforward/models/invoice_charge_request.py index d90f28a..428a85f 100644 --- a/billforward/models/invoice_charge_request.py +++ b/billforward/models/invoice_charge_request.py @@ -1,105 +1,151 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class InvoiceChargeRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, include_aggregated=False, include_invoiced_charges_only=False, invoice_state=None): - """ - InvoiceChargeRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'include_aggregated': 'bool', - 'include_invoiced_charges_only': 'bool', - 'invoice_state': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'include_aggregated': 'includeAggregated', - 'include_invoiced_charges_only': 'includeInvoicedChargesOnly', - 'invoice_state': 'invoiceState' - } - - self._created = created - self._include_aggregated = include_aggregated - self._include_invoiced_charges_only = include_invoiced_charges_only - self._invoice_state = invoice_state + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'subscription_id': 'str', + 'include_aggregated': 'bool', + 'include_invoiced_charges_only': 'bool', + 'invoice_state': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'subscription_id': 'subscriptionID', + 'include_aggregated': 'includeAggregated', + 'include_invoiced_charges_only': 'includeInvoicedChargesOnly', + 'invoice_state': 'invoiceState' + } + + def __init__(self, created=None, organization_id=None, subscription_id=None, include_aggregated=None, include_invoiced_charges_only=None, invoice_state=None): # noqa: E501 + """InvoiceChargeRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._subscription_id = None + self._include_aggregated = None + self._include_invoiced_charges_only = None + self._invoice_state = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if subscription_id is not None: + self.subscription_id = subscription_id + if include_aggregated is not None: + self.include_aggregated = include_aggregated + if include_invoiced_charges_only is not None: + self.include_invoiced_charges_only = include_invoiced_charges_only + if invoice_state is not None: + self.invoice_state = invoice_state @property def created(self): - """ - Gets the created of this InvoiceChargeRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this InvoiceChargeRequest. # noqa: E501 + - :return: The created of this InvoiceChargeRequest. + :return: The created of this InvoiceChargeRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this InvoiceChargeRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this InvoiceChargeRequest. + - :param created: The created of this InvoiceChargeRequest. + :param created: The created of this InvoiceChargeRequest. # noqa: E501 :type: datetime """ self._created = created @property - def include_aggregated(self): + def organization_id(self): + """Gets the organization_id of this InvoiceChargeRequest. # noqa: E501 + + + :return: The organization_id of this InvoiceChargeRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this InvoiceChargeRequest. + + + :param organization_id: The organization_id of this InvoiceChargeRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def subscription_id(self): + """Gets the subscription_id of this InvoiceChargeRequest. # noqa: E501 + + + :return: The subscription_id of this InvoiceChargeRequest. # noqa: E501 + :rtype: str """ - Gets the include_aggregated of this InvoiceChargeRequest. - {\"default\":false,\"description\":\"Outstanding charges for which invoices will be generated:
true — Include charges marked with 'Aggregated' `invoicingType` (i.e. charges that would otherwise be included anyway in the next naturally-occurring invoice)
false — Exclude charges marked with 'Aggregated' `invoicingType` (i.e. prefer that these charges be included instead on the next naturally-occurring invoice).\",\"verbs\":[\"POST\",\"GET\"]} + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this InvoiceChargeRequest. - :return: The include_aggregated of this InvoiceChargeRequest. + + :param subscription_id: The subscription_id of this InvoiceChargeRequest. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def include_aggregated(self): + """Gets the include_aggregated of this InvoiceChargeRequest. # noqa: E501 + + + :return: The include_aggregated of this InvoiceChargeRequest. # noqa: E501 :rtype: bool """ return self._include_aggregated @include_aggregated.setter def include_aggregated(self, include_aggregated): - """ - Sets the include_aggregated of this InvoiceChargeRequest. - {\"default\":false,\"description\":\"Outstanding charges for which invoices will be generated:
true — Include charges marked with 'Aggregated' `invoicingType` (i.e. charges that would otherwise be included anyway in the next naturally-occurring invoice)
false — Exclude charges marked with 'Aggregated' `invoicingType` (i.e. prefer that these charges be included instead on the next naturally-occurring invoice).\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the include_aggregated of this InvoiceChargeRequest. - :param include_aggregated: The include_aggregated of this InvoiceChargeRequest. + + :param include_aggregated: The include_aggregated of this InvoiceChargeRequest. # noqa: E501 :type: bool """ @@ -107,22 +153,20 @@ def include_aggregated(self, include_aggregated): @property def include_invoiced_charges_only(self): - """ - Gets the include_invoiced_charges_only of this InvoiceChargeRequest. - {\"default\":false,\"description\":\"Outstanding charges for which invoices will be generated:
true — Include those charges raised with 'no invoice' specified (i.e. charges against the subscription) — as well as charges raised against some specific invoice.
false — Include only charges raised against some specific invoice.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the include_invoiced_charges_only of this InvoiceChargeRequest. # noqa: E501 - :return: The include_invoiced_charges_only of this InvoiceChargeRequest. + + :return: The include_invoiced_charges_only of this InvoiceChargeRequest. # noqa: E501 :rtype: bool """ return self._include_invoiced_charges_only @include_invoiced_charges_only.setter def include_invoiced_charges_only(self, include_invoiced_charges_only): - """ - Sets the include_invoiced_charges_only of this InvoiceChargeRequest. - {\"default\":false,\"description\":\"Outstanding charges for which invoices will be generated:
true — Include those charges raised with 'no invoice' specified (i.e. charges against the subscription) — as well as charges raised against some specific invoice.
false — Include only charges raised against some specific invoice.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the include_invoiced_charges_only of this InvoiceChargeRequest. - :param include_invoiced_charges_only: The include_invoiced_charges_only of this InvoiceChargeRequest. + + :param include_invoiced_charges_only: The include_invoiced_charges_only of this InvoiceChargeRequest. # noqa: E501 :type: bool """ @@ -130,40 +174,36 @@ def include_invoiced_charges_only(self, include_invoiced_charges_only): @property def invoice_state(self): - """ - Gets the invoice_state of this InvoiceChargeRequest. - {\"default\":null (invoice is raised in its default initial state),\"description\":\"Initial state with which any invoices will be generated.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the invoice_state of this InvoiceChargeRequest. # noqa: E501 - :return: The invoice_state of this InvoiceChargeRequest. + + :return: The invoice_state of this InvoiceChargeRequest. # noqa: E501 :rtype: str """ return self._invoice_state @invoice_state.setter def invoice_state(self, invoice_state): - """ - Sets the invoice_state of this InvoiceChargeRequest. - {\"default\":null (invoice is raised in its default initial state),\"description\":\"Initial state with which any invoices will be generated.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the invoice_state of this InvoiceChargeRequest. - :param invoice_state: The invoice_state of this InvoiceChargeRequest. + + :param invoice_state: The invoice_state of this InvoiceChargeRequest. # noqa: E501 :type: str """ - allowed_values = ["Paid", "Unpaid", "Pending", "Voided"] + allowed_values = ["Paid", "Unpaid", "Pending", "Voided"] # noqa: E501 if invoice_state not in allowed_values: raise ValueError( - "Invalid value for `invoice_state` ({0}), must be one of {1}" + "Invalid value for `invoice_state` ({0}), must be one of {1}" # noqa: E501 .format(invoice_state, allowed_values) ) self._invoice_state = invoice_state def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -180,29 +220,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(InvoiceChargeRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, InvoiceChargeRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/invoice_execution_request.py b/billforward/models/invoice_execution_request.py new file mode 100644 index 0000000..ed58201 --- /dev/null +++ b/billforward/models/invoice_execution_request.py @@ -0,0 +1,241 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InvoiceExecutionRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'payment_amount': 'float', + 'force_paid': 'bool', + 'force_paid_reason': 'str', + 'organization_id': 'str', + 'payment_method_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'payment_amount': 'paymentAmount', + 'force_paid': 'forcePaid', + 'force_paid_reason': 'forcePaidReason', + 'organization_id': 'organizationID', + 'payment_method_id': 'paymentMethodID' + } + + def __init__(self, created=None, payment_amount=None, force_paid=None, force_paid_reason=None, organization_id=None, payment_method_id=None): # noqa: E501 + """InvoiceExecutionRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._payment_amount = None + self._force_paid = None + self._force_paid_reason = None + self._organization_id = None + self._payment_method_id = None + self.discriminator = None + if created is not None: + self.created = created + if payment_amount is not None: + self.payment_amount = payment_amount + self.force_paid = force_paid + if force_paid_reason is not None: + self.force_paid_reason = force_paid_reason + if organization_id is not None: + self.organization_id = organization_id + if payment_method_id is not None: + self.payment_method_id = payment_method_id + + @property + def created(self): + """Gets the created of this InvoiceExecutionRequest. # noqa: E501 + + + :return: The created of this InvoiceExecutionRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this InvoiceExecutionRequest. + + + :param created: The created of this InvoiceExecutionRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def payment_amount(self): + """Gets the payment_amount of this InvoiceExecutionRequest. # noqa: E501 + + + :return: The payment_amount of this InvoiceExecutionRequest. # noqa: E501 + :rtype: float + """ + return self._payment_amount + + @payment_amount.setter + def payment_amount(self, payment_amount): + """Sets the payment_amount of this InvoiceExecutionRequest. + + + :param payment_amount: The payment_amount of this InvoiceExecutionRequest. # noqa: E501 + :type: float + """ + + self._payment_amount = payment_amount + + @property + def force_paid(self): + """Gets the force_paid of this InvoiceExecutionRequest. # noqa: E501 + + + :return: The force_paid of this InvoiceExecutionRequest. # noqa: E501 + :rtype: bool + """ + return self._force_paid + + @force_paid.setter + def force_paid(self, force_paid): + """Sets the force_paid of this InvoiceExecutionRequest. + + + :param force_paid: The force_paid of this InvoiceExecutionRequest. # noqa: E501 + :type: bool + """ + if force_paid is None: + raise ValueError("Invalid value for `force_paid`, must not be `None`") # noqa: E501 + + self._force_paid = force_paid + + @property + def force_paid_reason(self): + """Gets the force_paid_reason of this InvoiceExecutionRequest. # noqa: E501 + + + :return: The force_paid_reason of this InvoiceExecutionRequest. # noqa: E501 + :rtype: str + """ + return self._force_paid_reason + + @force_paid_reason.setter + def force_paid_reason(self, force_paid_reason): + """Sets the force_paid_reason of this InvoiceExecutionRequest. + + + :param force_paid_reason: The force_paid_reason of this InvoiceExecutionRequest. # noqa: E501 + :type: str + """ + + self._force_paid_reason = force_paid_reason + + @property + def organization_id(self): + """Gets the organization_id of this InvoiceExecutionRequest. # noqa: E501 + + + :return: The organization_id of this InvoiceExecutionRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this InvoiceExecutionRequest. + + + :param organization_id: The organization_id of this InvoiceExecutionRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def payment_method_id(self): + """Gets the payment_method_id of this InvoiceExecutionRequest. # noqa: E501 + + + :return: The payment_method_id of this InvoiceExecutionRequest. # noqa: E501 + :rtype: str + """ + return self._payment_method_id + + @payment_method_id.setter + def payment_method_id(self, payment_method_id): + """Sets the payment_method_id of this InvoiceExecutionRequest. + + + :param payment_method_id: The payment_method_id of this InvoiceExecutionRequest. # noqa: E501 + :type: str + """ + + self._payment_method_id = payment_method_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InvoiceExecutionRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InvoiceExecutionRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/invoice_line.py b/billforward/models/invoice_line.py deleted file mode 100644 index c6347ff..0000000 --- a/billforward/models/invoice_line.py +++ /dev/null @@ -1,922 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class InvoiceLine(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, unit_of_measure=None, pricing_component_type=None, charge_type=None, period_start=None, period_end=None, created=None, changed_by=None, updated=None, id=None, invoice_id=None, unit_of_measure_id=None, subscription_id=None, product_rate_plan_id=None, public_product_rate_plan_name=None, product_rate_plan_name=None, product_id=None, public_product_name=None, product_name=None, organization_id=None, name=None, description=None, calculation=None, cost=None, tax=None, component_value=None, pricing_component_id=None, public_pricing_component_name=None, pricing_component_name=None, subscription_charge_id=None, child_invoice_id=None, type=None): - """ - InvoiceLine - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'unit_of_measure': 'UnitOfMeasure', - 'pricing_component_type': 'str', - 'charge_type': 'str', - 'period_start': 'datetime', - 'period_end': 'datetime', - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'invoice_id': 'str', - 'unit_of_measure_id': 'str', - 'subscription_id': 'str', - 'product_rate_plan_id': 'str', - 'public_product_rate_plan_name': 'str', - 'product_rate_plan_name': 'str', - 'product_id': 'str', - 'public_product_name': 'str', - 'product_name': 'str', - 'organization_id': 'str', - 'name': 'str', - 'description': 'str', - 'calculation': 'str', - 'cost': 'float', - 'tax': 'float', - 'component_value': 'int', - 'pricing_component_id': 'str', - 'public_pricing_component_name': 'str', - 'pricing_component_name': 'str', - 'subscription_charge_id': 'str', - 'child_invoice_id': 'str', - 'type': 'str' - } - - self.attribute_map = { - 'unit_of_measure': 'unitOfMeasure', - 'pricing_component_type': 'pricingComponentType', - 'charge_type': 'chargeType', - 'period_start': 'periodStart', - 'period_end': 'periodEnd', - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'invoice_id': 'invoiceID', - 'unit_of_measure_id': 'unitOfMeasureID', - 'subscription_id': 'subscriptionID', - 'product_rate_plan_id': 'productRatePlanID', - 'public_product_rate_plan_name': 'publicProductRatePlanName', - 'product_rate_plan_name': 'productRatePlanName', - 'product_id': 'productID', - 'public_product_name': 'publicProductName', - 'product_name': 'productName', - 'organization_id': 'organizationID', - 'name': 'name', - 'description': 'description', - 'calculation': 'calculation', - 'cost': 'cost', - 'tax': 'tax', - 'component_value': 'componentValue', - 'pricing_component_id': 'pricingComponentID', - 'public_pricing_component_name': 'publicPricingComponentName', - 'pricing_component_name': 'pricingComponentName', - 'subscription_charge_id': 'subscriptionChargeID', - 'child_invoice_id': 'childInvoiceID', - 'type': 'type' - } - - self._unit_of_measure = unit_of_measure - self._pricing_component_type = pricing_component_type - self._charge_type = charge_type - self._period_start = period_start - self._period_end = period_end - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._invoice_id = invoice_id - self._unit_of_measure_id = unit_of_measure_id - self._subscription_id = subscription_id - self._product_rate_plan_id = product_rate_plan_id - self._public_product_rate_plan_name = public_product_rate_plan_name - self._product_rate_plan_name = product_rate_plan_name - self._product_id = product_id - self._public_product_name = public_product_name - self._product_name = product_name - self._organization_id = organization_id - self._name = name - self._description = description - self._calculation = calculation - self._cost = cost - self._tax = tax - self._component_value = component_value - self._pricing_component_id = pricing_component_id - self._public_pricing_component_name = public_pricing_component_name - self._pricing_component_name = pricing_component_name - self._subscription_charge_id = subscription_charge_id - self._child_invoice_id = child_invoice_id - self._type = type - - @property - def unit_of_measure(self): - """ - Gets the unit_of_measure of this InvoiceLine. - { \"description\" : \"The unit-of-measure associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The unit_of_measure of this InvoiceLine. - :rtype: UnitOfMeasure - """ - return self._unit_of_measure - - @unit_of_measure.setter - def unit_of_measure(self, unit_of_measure): - """ - Sets the unit_of_measure of this InvoiceLine. - { \"description\" : \"The unit-of-measure associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param unit_of_measure: The unit_of_measure of this InvoiceLine. - :type: UnitOfMeasure - """ - - self._unit_of_measure = unit_of_measure - - @property - def pricing_component_type(self): - """ - Gets the pricing_component_type of this InvoiceLine. - { \"description\" : \"The type of the pricing component associated with the invoice line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The pricing_component_type of this InvoiceLine. - :rtype: str - """ - return self._pricing_component_type - - @pricing_component_type.setter - def pricing_component_type(self, pricing_component_type): - """ - Sets the pricing_component_type of this InvoiceLine. - { \"description\" : \"The type of the pricing component associated with the invoice line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param pricing_component_type: The pricing_component_type of this InvoiceLine. - :type: str - """ - allowed_values = ["setup", "subscription", "arrears", "usage"] - if pricing_component_type not in allowed_values: - raise ValueError( - "Invalid value for `pricing_component_type` ({0}), must be one of {1}" - .format(pricing_component_type, allowed_values) - ) - - self._pricing_component_type = pricing_component_type - - @property - def charge_type(self): - """ - Gets the charge_type of this InvoiceLine. - { \"description\" : \"charge-type.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The charge_type of this InvoiceLine. - :rtype: str - """ - return self._charge_type - - @charge_type.setter - def charge_type(self, charge_type): - """ - Sets the charge_type of this InvoiceLine. - { \"description\" : \"charge-type.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param charge_type: The charge_type of this InvoiceLine. - :type: str - """ - allowed_values = ["Credit", "Debit"] - if charge_type not in allowed_values: - raise ValueError( - "Invalid value for `charge_type` ({0}), must be one of {1}" - .format(charge_type, allowed_values) - ) - - self._charge_type = charge_type - - @property - def period_start(self): - """ - Gets the period_start of this InvoiceLine. - The period start of the charge. - - :return: The period_start of this InvoiceLine. - :rtype: datetime - """ - return self._period_start - - @period_start.setter - def period_start(self, period_start): - """ - Sets the period_start of this InvoiceLine. - The period start of the charge. - - :param period_start: The period_start of this InvoiceLine. - :type: datetime - """ - - self._period_start = period_start - - @property - def period_end(self): - """ - Gets the period_end of this InvoiceLine. - The period end of the charge. - - :return: The period_end of this InvoiceLine. - :rtype: datetime - """ - return self._period_end - - @period_end.setter - def period_end(self, period_end): - """ - Sets the period_end of this InvoiceLine. - The period end of the charge. - - :param period_end: The period_end of this InvoiceLine. - :type: datetime - """ - - self._period_end = period_end - - @property - def created(self): - """ - Gets the created of this InvoiceLine. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this InvoiceLine. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this InvoiceLine. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this InvoiceLine. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this InvoiceLine. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this InvoiceLine. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this InvoiceLine. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this InvoiceLine. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this InvoiceLine. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this InvoiceLine. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this InvoiceLine. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this InvoiceLine. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this InvoiceLine. - { \"description\" : \"ID of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this InvoiceLine. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this InvoiceLine. - { \"description\" : \"ID of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this InvoiceLine. - :type: str - """ - - self._id = id - - @property - def invoice_id(self): - """ - Gets the invoice_id of this InvoiceLine. - { \"description\" : \"invoice associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The invoice_id of this InvoiceLine. - :rtype: str - """ - return self._invoice_id - - @invoice_id.setter - def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this InvoiceLine. - { \"description\" : \"invoice associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param invoice_id: The invoice_id of this InvoiceLine. - :type: str - """ - - self._invoice_id = invoice_id - - @property - def unit_of_measure_id(self): - """ - Gets the unit_of_measure_id of this InvoiceLine. - { \"description\" : \"unit-of-measure associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The unit_of_measure_id of this InvoiceLine. - :rtype: str - """ - return self._unit_of_measure_id - - @unit_of_measure_id.setter - def unit_of_measure_id(self, unit_of_measure_id): - """ - Sets the unit_of_measure_id of this InvoiceLine. - { \"description\" : \"unit-of-measure associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param unit_of_measure_id: The unit_of_measure_id of this InvoiceLine. - :type: str - """ - - self._unit_of_measure_id = unit_of_measure_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this InvoiceLine. - { \"description\" : \"the subscription ID associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this InvoiceLine. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this InvoiceLine. - { \"description\" : \"the subscription ID associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this InvoiceLine. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def product_rate_plan_id(self): - """ - Gets the product_rate_plan_id of this InvoiceLine. - { \"description\" : \"the product rate plan ID associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The product_rate_plan_id of this InvoiceLine. - :rtype: str - """ - return self._product_rate_plan_id - - @product_rate_plan_id.setter - def product_rate_plan_id(self, product_rate_plan_id): - """ - Sets the product_rate_plan_id of this InvoiceLine. - { \"description\" : \"the product rate plan ID associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param product_rate_plan_id: The product_rate_plan_id of this InvoiceLine. - :type: str - """ - - self._product_rate_plan_id = product_rate_plan_id - - @property - def public_product_rate_plan_name(self): - """ - Gets the public_product_rate_plan_name of this InvoiceLine. - { \"description\" : \"the public product rate plan name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The public_product_rate_plan_name of this InvoiceLine. - :rtype: str - """ - return self._public_product_rate_plan_name - - @public_product_rate_plan_name.setter - def public_product_rate_plan_name(self, public_product_rate_plan_name): - """ - Sets the public_product_rate_plan_name of this InvoiceLine. - { \"description\" : \"the public product rate plan name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param public_product_rate_plan_name: The public_product_rate_plan_name of this InvoiceLine. - :type: str - """ - - self._public_product_rate_plan_name = public_product_rate_plan_name - - @property - def product_rate_plan_name(self): - """ - Gets the product_rate_plan_name of this InvoiceLine. - { \"description\" : \"the product rate plan name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The product_rate_plan_name of this InvoiceLine. - :rtype: str - """ - return self._product_rate_plan_name - - @product_rate_plan_name.setter - def product_rate_plan_name(self, product_rate_plan_name): - """ - Sets the product_rate_plan_name of this InvoiceLine. - { \"description\" : \"the product rate plan name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param product_rate_plan_name: The product_rate_plan_name of this InvoiceLine. - :type: str - """ - - self._product_rate_plan_name = product_rate_plan_name - - @property - def product_id(self): - """ - Gets the product_id of this InvoiceLine. - { \"description\" : \"the product ID associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The product_id of this InvoiceLine. - :rtype: str - """ - return self._product_id - - @product_id.setter - def product_id(self, product_id): - """ - Sets the product_id of this InvoiceLine. - { \"description\" : \"the product ID associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param product_id: The product_id of this InvoiceLine. - :type: str - """ - - self._product_id = product_id - - @property - def public_product_name(self): - """ - Gets the public_product_name of this InvoiceLine. - { \"description\" : \"the public product name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The public_product_name of this InvoiceLine. - :rtype: str - """ - return self._public_product_name - - @public_product_name.setter - def public_product_name(self, public_product_name): - """ - Sets the public_product_name of this InvoiceLine. - { \"description\" : \"the public product name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param public_product_name: The public_product_name of this InvoiceLine. - :type: str - """ - - self._public_product_name = public_product_name - - @property - def product_name(self): - """ - Gets the product_name of this InvoiceLine. - { \"description\" : \"the product name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The product_name of this InvoiceLine. - :rtype: str - """ - return self._product_name - - @product_name.setter - def product_name(self, product_name): - """ - Sets the product_name of this InvoiceLine. - { \"description\" : \"the product name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param product_name: The product_name of this InvoiceLine. - :type: str - """ - - self._product_name = product_name - - @property - def organization_id(self): - """ - Gets the organization_id of this InvoiceLine. - { \"description\" : \"ID of the organization associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this InvoiceLine. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this InvoiceLine. - { \"description\" : \"ID of the organization associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this InvoiceLine. - :type: str - """ - - self._organization_id = organization_id - - @property - def name(self): - """ - Gets the name of this InvoiceLine. - { \"description\" : \"The human readable name of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The name of this InvoiceLine. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this InvoiceLine. - { \"description\" : \"The human readable name of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param name: The name of this InvoiceLine. - :type: str - """ - - self._name = name - - @property - def description(self): - """ - Gets the description of this InvoiceLine. - { \"description\" : \"The human readable description of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The description of this InvoiceLine. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this InvoiceLine. - { \"description\" : \"The human readable description of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param description: The description of this InvoiceLine. - :type: str - """ - - self._description = description - - @property - def calculation(self): - """ - Gets the calculation of this InvoiceLine. - { \"description\" : \"A human readable explanation of how the value of the invoice-line was calculated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The calculation of this InvoiceLine. - :rtype: str - """ - return self._calculation - - @calculation.setter - def calculation(self, calculation): - """ - Sets the calculation of this InvoiceLine. - { \"description\" : \"A human readable explanation of how the value of the invoice-line was calculated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param calculation: The calculation of this InvoiceLine. - :type: str - """ - - self._calculation = calculation - - @property - def cost(self): - """ - Gets the cost of this InvoiceLine. - { \"description\" : \"The cost of the invoice-line including tax.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The cost of this InvoiceLine. - :rtype: float - """ - return self._cost - - @cost.setter - def cost(self, cost): - """ - Sets the cost of this InvoiceLine. - { \"description\" : \"The cost of the invoice-line including tax.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param cost: The cost of this InvoiceLine. - :type: float - """ - - self._cost = cost - - @property - def tax(self): - """ - Gets the tax of this InvoiceLine. - { \"description\" : \"The cumulative tax of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The tax of this InvoiceLine. - :rtype: float - """ - return self._tax - - @tax.setter - def tax(self, tax): - """ - Sets the tax of this InvoiceLine. - { \"description\" : \"The cumulative tax of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param tax: The tax of this InvoiceLine. - :type: float - """ - - self._tax = tax - - @property - def component_value(self): - """ - Gets the component_value of this InvoiceLine. - { \"description\" : \"The component value for the unit-of-measure that is associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The component_value of this InvoiceLine. - :rtype: int - """ - return self._component_value - - @component_value.setter - def component_value(self, component_value): - """ - Sets the component_value of this InvoiceLine. - { \"description\" : \"The component value for the unit-of-measure that is associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param component_value: The component_value of this InvoiceLine. - :type: int - """ - - self._component_value = component_value - - @property - def pricing_component_id(self): - """ - Gets the pricing_component_id of this InvoiceLine. - The ID of the pricing-component that is associated with the invoice-line. - - :return: The pricing_component_id of this InvoiceLine. - :rtype: str - """ - return self._pricing_component_id - - @pricing_component_id.setter - def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this InvoiceLine. - The ID of the pricing-component that is associated with the invoice-line. - - :param pricing_component_id: The pricing_component_id of this InvoiceLine. - :type: str - """ - - self._pricing_component_id = pricing_component_id - - @property - def public_pricing_component_name(self): - """ - Gets the public_pricing_component_name of this InvoiceLine. - The public name of the pricing-component that is associated with the invoice-line. - - :return: The public_pricing_component_name of this InvoiceLine. - :rtype: str - """ - return self._public_pricing_component_name - - @public_pricing_component_name.setter - def public_pricing_component_name(self, public_pricing_component_name): - """ - Sets the public_pricing_component_name of this InvoiceLine. - The public name of the pricing-component that is associated with the invoice-line. - - :param public_pricing_component_name: The public_pricing_component_name of this InvoiceLine. - :type: str - """ - - self._public_pricing_component_name = public_pricing_component_name - - @property - def pricing_component_name(self): - """ - Gets the pricing_component_name of this InvoiceLine. - The name of the pricing-component that is associated with the invoice-line. - - :return: The pricing_component_name of this InvoiceLine. - :rtype: str - """ - return self._pricing_component_name - - @pricing_component_name.setter - def pricing_component_name(self, pricing_component_name): - """ - Sets the pricing_component_name of this InvoiceLine. - The name of the pricing-component that is associated with the invoice-line. - - :param pricing_component_name: The pricing_component_name of this InvoiceLine. - :type: str - """ - - self._pricing_component_name = pricing_component_name - - @property - def subscription_charge_id(self): - """ - Gets the subscription_charge_id of this InvoiceLine. - The ID of the subscription-charge that is associated with the invoice-line. - - :return: The subscription_charge_id of this InvoiceLine. - :rtype: str - """ - return self._subscription_charge_id - - @subscription_charge_id.setter - def subscription_charge_id(self, subscription_charge_id): - """ - Sets the subscription_charge_id of this InvoiceLine. - The ID of the subscription-charge that is associated with the invoice-line. - - :param subscription_charge_id: The subscription_charge_id of this InvoiceLine. - :type: str - """ - - self._subscription_charge_id = subscription_charge_id - - @property - def child_invoice_id(self): - """ - Gets the child_invoice_id of this InvoiceLine. - The ID of the invoice that is associated with the invoice-line. - - :return: The child_invoice_id of this InvoiceLine. - :rtype: str - """ - return self._child_invoice_id - - @child_invoice_id.setter - def child_invoice_id(self, child_invoice_id): - """ - Sets the child_invoice_id of this InvoiceLine. - The ID of the invoice that is associated with the invoice-line. - - :param child_invoice_id: The child_invoice_id of this InvoiceLine. - :type: str - """ - - self._child_invoice_id = child_invoice_id - - @property - def type(self): - """ - Gets the type of this InvoiceLine. - The type of the invoice-line. - - :return: The type of this InvoiceLine. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this InvoiceLine. - The type of the invoice-line. - - :param type: The type of this InvoiceLine. - :type: str - """ - allowed_values = ["PricingComponent", "Coupon", "Migration", "AggregatedInvoice"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/invoice_line_payment.py b/billforward/models/invoice_line_payment.py deleted file mode 100644 index a156094..0000000 --- a/billforward/models/invoice_line_payment.py +++ /dev/null @@ -1,858 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class InvoiceLinePayment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, period_start=None, period_end=None, payment_received=None, refund_received=None, created=None, changed_by=None, id=None, organization_id=None, payment_id=None, gateway_original_payment_reference=None, gateway_refund_payment_reference=None, aggregated_invoice_id=None, aggregated_invoice_line_id=None, invoice_payment_id=None, currency=None, gateway=None, nominal_amount=None, actual_amount=None, refunded_amount=None, pricing_component_id=None, pricing_component_name=None, product_rate_plan_id=None, product_rate_plan_name=None, product_rate_plan_name_public=None, product_id=None, product_name=None, product_name_public=None, subscription_id=None, account_id=None): - """ - InvoiceLinePayment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'period_start': 'datetime', - 'period_end': 'datetime', - 'payment_received': 'datetime', - 'refund_received': 'datetime', - 'created': 'datetime', - 'changed_by': 'str', - 'id': 'str', - 'organization_id': 'str', - 'payment_id': 'str', - 'gateway_original_payment_reference': 'str', - 'gateway_refund_payment_reference': 'str', - 'aggregated_invoice_id': 'str', - 'aggregated_invoice_line_id': 'str', - 'invoice_payment_id': 'str', - 'currency': 'str', - 'gateway': 'str', - 'nominal_amount': 'float', - 'actual_amount': 'float', - 'refunded_amount': 'float', - 'pricing_component_id': 'str', - 'pricing_component_name': 'str', - 'product_rate_plan_id': 'str', - 'product_rate_plan_name': 'str', - 'product_rate_plan_name_public': 'str', - 'product_id': 'str', - 'product_name': 'str', - 'product_name_public': 'str', - 'subscription_id': 'str', - 'account_id': 'str' - } - - self.attribute_map = { - 'period_start': 'periodStart', - 'period_end': 'periodEnd', - 'payment_received': 'paymentReceived', - 'refund_received': 'refundReceived', - 'created': 'created', - 'changed_by': 'changedBy', - 'id': 'id', - 'organization_id': 'organizationID', - 'payment_id': 'paymentID', - 'gateway_original_payment_reference': 'gatewayOriginalPaymentReference', - 'gateway_refund_payment_reference': 'gatewayRefundPaymentReference', - 'aggregated_invoice_id': 'aggregatedInvoiceID', - 'aggregated_invoice_line_id': 'aggregatedInvoiceLineID', - 'invoice_payment_id': 'invoicePaymentID', - 'currency': 'currency', - 'gateway': 'gateway', - 'nominal_amount': 'nominalAmount', - 'actual_amount': 'actualAmount', - 'refunded_amount': 'refundedAmount', - 'pricing_component_id': 'pricingComponentID', - 'pricing_component_name': 'pricingComponentName', - 'product_rate_plan_id': 'productRatePlanID', - 'product_rate_plan_name': 'productRatePlanName', - 'product_rate_plan_name_public': 'productRatePlanNamePublic', - 'product_id': 'productID', - 'product_name': 'productName', - 'product_name_public': 'productNamePublic', - 'subscription_id': 'subscriptionID', - 'account_id': 'accountID' - } - - self._period_start = period_start - self._period_end = period_end - self._payment_received = payment_received - self._refund_received = refund_received - self._created = created - self._changed_by = changed_by - self._id = id - self._organization_id = organization_id - self._payment_id = payment_id - self._gateway_original_payment_reference = gateway_original_payment_reference - self._gateway_refund_payment_reference = gateway_refund_payment_reference - self._aggregated_invoice_id = aggregated_invoice_id - self._aggregated_invoice_line_id = aggregated_invoice_line_id - self._invoice_payment_id = invoice_payment_id - self._currency = currency - self._gateway = gateway - self._nominal_amount = nominal_amount - self._actual_amount = actual_amount - self._refunded_amount = refunded_amount - self._pricing_component_id = pricing_component_id - self._pricing_component_name = pricing_component_name - self._product_rate_plan_id = product_rate_plan_id - self._product_rate_plan_name = product_rate_plan_name - self._product_rate_plan_name_public = product_rate_plan_name_public - self._product_id = product_id - self._product_name = product_name - self._product_name_public = product_name_public - self._subscription_id = subscription_id - self._account_id = account_id - - @property - def period_start(self): - """ - Gets the period_start of this InvoiceLinePayment. - {\"description\":\"PeriodStart of the charge with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The period_start of this InvoiceLinePayment. - :rtype: datetime - """ - return self._period_start - - @period_start.setter - def period_start(self, period_start): - """ - Sets the period_start of this InvoiceLinePayment. - {\"description\":\"PeriodStart of the charge with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param period_start: The period_start of this InvoiceLinePayment. - :type: datetime - """ - - self._period_start = period_start - - @property - def period_end(self): - """ - Gets the period_end of this InvoiceLinePayment. - {\"description\":\"PeriodEnd of the charge with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The period_end of this InvoiceLinePayment. - :rtype: datetime - """ - return self._period_end - - @period_end.setter - def period_end(self, period_end): - """ - Sets the period_end of this InvoiceLinePayment. - {\"description\":\"PeriodEnd of the charge with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param period_end: The period_end of this InvoiceLinePayment. - :type: datetime - """ - - self._period_end = period_end - - @property - def payment_received(self): - """ - Gets the payment_received of this InvoiceLinePayment. - {\"description\":\"The date when the associated payment was received.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The payment_received of this InvoiceLinePayment. - :rtype: datetime - """ - return self._payment_received - - @payment_received.setter - def payment_received(self, payment_received): - """ - Sets the payment_received of this InvoiceLinePayment. - {\"description\":\"The date when the associated payment was received.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param payment_received: The payment_received of this InvoiceLinePayment. - :type: datetime - """ - - self._payment_received = payment_received - - @property - def refund_received(self): - """ - Gets the refund_received of this InvoiceLinePayment. - {\"description\":\"The date when the associated payment was refunded.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The refund_received of this InvoiceLinePayment. - :rtype: datetime - """ - return self._refund_received - - @refund_received.setter - def refund_received(self, refund_received): - """ - Sets the refund_received of this InvoiceLinePayment. - {\"description\":\"The date when the associated payment was refunded.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param refund_received: The refund_received of this InvoiceLinePayment. - :type: datetime - """ - - self._refund_received = refund_received - - @property - def created(self): - """ - Gets the created of this InvoiceLinePayment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this InvoiceLinePayment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this InvoiceLinePayment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this InvoiceLinePayment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this InvoiceLinePayment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this InvoiceLinePayment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this InvoiceLinePayment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this InvoiceLinePayment. - :type: str - """ - - self._changed_by = changed_by - - @property - def id(self): - """ - Gets the id of this InvoiceLinePayment. - {\"description\":\"ID of the InvoiceLinePayment.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The id of this InvoiceLinePayment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this InvoiceLinePayment. - {\"description\":\"ID of the InvoiceLinePayment.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param id: The id of this InvoiceLinePayment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this InvoiceLinePayment. - {\"description\":\"ID of the organization associated with the InvoiceLinePayment.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The organization_id of this InvoiceLinePayment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this InvoiceLinePayment. - {\"description\":\"ID of the organization associated with the InvoiceLinePayment.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param organization_id: The organization_id of this InvoiceLinePayment. - :type: str - """ - - self._organization_id = organization_id - - @property - def payment_id(self): - """ - Gets the payment_id of this InvoiceLinePayment. - {\"description\":\"ID of the Payment used upon this InvoiceLinePayment's invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The payment_id of this InvoiceLinePayment. - :rtype: str - """ - return self._payment_id - - @payment_id.setter - def payment_id(self, payment_id): - """ - Sets the payment_id of this InvoiceLinePayment. - {\"description\":\"ID of the Payment used upon this InvoiceLinePayment's invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param payment_id: The payment_id of this InvoiceLinePayment. - :type: str - """ - - self._payment_id = payment_id - - @property - def gateway_original_payment_reference(self): - """ - Gets the gateway_original_payment_reference of this InvoiceLinePayment. - {\"description\":\"Reference with which the original payment transaction can be looked up in its gateway.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The gateway_original_payment_reference of this InvoiceLinePayment. - :rtype: str - """ - return self._gateway_original_payment_reference - - @gateway_original_payment_reference.setter - def gateway_original_payment_reference(self, gateway_original_payment_reference): - """ - Sets the gateway_original_payment_reference of this InvoiceLinePayment. - {\"description\":\"Reference with which the original payment transaction can be looked up in its gateway.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param gateway_original_payment_reference: The gateway_original_payment_reference of this InvoiceLinePayment. - :type: str - """ - - self._gateway_original_payment_reference = gateway_original_payment_reference - - @property - def gateway_refund_payment_reference(self): - """ - Gets the gateway_refund_payment_reference of this InvoiceLinePayment. - {\"description\":\"Reference with which the refund transaction for the payment can be looked up in its gateway.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The gateway_refund_payment_reference of this InvoiceLinePayment. - :rtype: str - """ - return self._gateway_refund_payment_reference - - @gateway_refund_payment_reference.setter - def gateway_refund_payment_reference(self, gateway_refund_payment_reference): - """ - Sets the gateway_refund_payment_reference of this InvoiceLinePayment. - {\"description\":\"Reference with which the refund transaction for the payment can be looked up in its gateway.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param gateway_refund_payment_reference: The gateway_refund_payment_reference of this InvoiceLinePayment. - :type: str - """ - - self._gateway_refund_payment_reference = gateway_refund_payment_reference - - @property - def aggregated_invoice_id(self): - """ - Gets the aggregated_invoice_id of this InvoiceLinePayment. - {\"description\":\"ID of the invoice to which this InvoiceLinePayment's invoice line belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The aggregated_invoice_id of this InvoiceLinePayment. - :rtype: str - """ - return self._aggregated_invoice_id - - @aggregated_invoice_id.setter - def aggregated_invoice_id(self, aggregated_invoice_id): - """ - Sets the aggregated_invoice_id of this InvoiceLinePayment. - {\"description\":\"ID of the invoice to which this InvoiceLinePayment's invoice line belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param aggregated_invoice_id: The aggregated_invoice_id of this InvoiceLinePayment. - :type: str - """ - - self._aggregated_invoice_id = aggregated_invoice_id - - @property - def aggregated_invoice_line_id(self): - """ - Gets the aggregated_invoice_line_id of this InvoiceLinePayment. - {\"description\":\"ID of the invoice line toward which this InvoiceLinePayment contributes payment.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The aggregated_invoice_line_id of this InvoiceLinePayment. - :rtype: str - """ - return self._aggregated_invoice_line_id - - @aggregated_invoice_line_id.setter - def aggregated_invoice_line_id(self, aggregated_invoice_line_id): - """ - Sets the aggregated_invoice_line_id of this InvoiceLinePayment. - {\"description\":\"ID of the invoice line toward which this InvoiceLinePayment contributes payment.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param aggregated_invoice_line_id: The aggregated_invoice_line_id of this InvoiceLinePayment. - :type: str - """ - - self._aggregated_invoice_line_id = aggregated_invoice_line_id - - @property - def invoice_payment_id(self): - """ - Gets the invoice_payment_id of this InvoiceLinePayment. - {\"description\":\"ID of the InvoicePayment with which this InvoiceLinePayment is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The invoice_payment_id of this InvoiceLinePayment. - :rtype: str - """ - return self._invoice_payment_id - - @invoice_payment_id.setter - def invoice_payment_id(self, invoice_payment_id): - """ - Sets the invoice_payment_id of this InvoiceLinePayment. - {\"description\":\"ID of the InvoicePayment with which this InvoiceLinePayment is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param invoice_payment_id: The invoice_payment_id of this InvoiceLinePayment. - :type: str - """ - - self._invoice_payment_id = invoice_payment_id - - @property - def currency(self): - """ - Gets the currency of this InvoiceLinePayment. - {\"description\":\"The currency of the payment — specified by a three-character ISO 4217 currency code.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The currency of this InvoiceLinePayment. - :rtype: str - """ - return self._currency - - @currency.setter - def currency(self, currency): - """ - Sets the currency of this InvoiceLinePayment. - {\"description\":\"The currency of the payment — specified by a three-character ISO 4217 currency code.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param currency: The currency of this InvoiceLinePayment. - :type: str - """ - - self._currency = currency - - @property - def gateway(self): - """ - Gets the gateway of this InvoiceLinePayment. - {\"description\":\"Payment gateway through which the payment was made.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The gateway of this InvoiceLinePayment. - :rtype: str - """ - return self._gateway - - @gateway.setter - def gateway(self, gateway): - """ - Sets the gateway of this InvoiceLinePayment. - {\"description\":\"Payment gateway through which the payment was made.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param gateway: The gateway of this InvoiceLinePayment. - :type: str - """ - allowed_values = ["cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash"] - if gateway not in allowed_values: - raise ValueError( - "Invalid value for `gateway` ({0}), must be one of {1}" - .format(gateway, allowed_values) - ) - - self._gateway = gateway - - @property - def nominal_amount(self): - """ - Gets the nominal_amount of this InvoiceLinePayment. - {\"description\":\"The amount paid — through credit or otherwise — toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The nominal_amount of this InvoiceLinePayment. - :rtype: float - """ - return self._nominal_amount - - @nominal_amount.setter - def nominal_amount(self, nominal_amount): - """ - Sets the nominal_amount of this InvoiceLinePayment. - {\"description\":\"The amount paid — through credit or otherwise — toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param nominal_amount: The nominal_amount of this InvoiceLinePayment. - :type: float - """ - - self._nominal_amount = nominal_amount - - @property - def actual_amount(self): - """ - Gets the actual_amount of this InvoiceLinePayment. - {\"description\":\"The amount paid — through real money — toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The actual_amount of this InvoiceLinePayment. - :rtype: float - """ - return self._actual_amount - - @actual_amount.setter - def actual_amount(self, actual_amount): - """ - Sets the actual_amount of this InvoiceLinePayment. - {\"description\":\"The amount paid — through real money — toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param actual_amount: The actual_amount of this InvoiceLinePayment. - :type: float - """ - - self._actual_amount = actual_amount - - @property - def refunded_amount(self): - """ - Gets the refunded_amount of this InvoiceLinePayment. - {\"description\":\"The monetary amount refunded toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The refunded_amount of this InvoiceLinePayment. - :rtype: float - """ - return self._refunded_amount - - @refunded_amount.setter - def refunded_amount(self, refunded_amount): - """ - Sets the refunded_amount of this InvoiceLinePayment. - {\"description\":\"The monetary amount refunded toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param refunded_amount: The refunded_amount of this InvoiceLinePayment. - :type: float - """ - - self._refunded_amount = refunded_amount - - @property - def pricing_component_id(self): - """ - Gets the pricing_component_id of this InvoiceLinePayment. - {\"description\":\"ID of the PricingComponent with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The pricing_component_id of this InvoiceLinePayment. - :rtype: str - """ - return self._pricing_component_id - - @pricing_component_id.setter - def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this InvoiceLinePayment. - {\"description\":\"ID of the PricingComponent with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param pricing_component_id: The pricing_component_id of this InvoiceLinePayment. - :type: str - """ - - self._pricing_component_id = pricing_component_id - - @property - def pricing_component_name(self): - """ - Gets the pricing_component_name of this InvoiceLinePayment. - {\"description\":\"Name of the PricingComponent with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The pricing_component_name of this InvoiceLinePayment. - :rtype: str - """ - return self._pricing_component_name - - @pricing_component_name.setter - def pricing_component_name(self, pricing_component_name): - """ - Sets the pricing_component_name of this InvoiceLinePayment. - {\"description\":\"Name of the PricingComponent with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param pricing_component_name: The pricing_component_name of this InvoiceLinePayment. - :type: str - """ - - self._pricing_component_name = pricing_component_name - - @property - def product_rate_plan_id(self): - """ - Gets the product_rate_plan_id of this InvoiceLinePayment. - {\"description\":\"ID of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_rate_plan_id of this InvoiceLinePayment. - :rtype: str - """ - return self._product_rate_plan_id - - @product_rate_plan_id.setter - def product_rate_plan_id(self, product_rate_plan_id): - """ - Sets the product_rate_plan_id of this InvoiceLinePayment. - {\"description\":\"ID of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_rate_plan_id: The product_rate_plan_id of this InvoiceLinePayment. - :type: str - """ - - self._product_rate_plan_id = product_rate_plan_id - - @property - def product_rate_plan_name(self): - """ - Gets the product_rate_plan_name of this InvoiceLinePayment. - {\"description\":\"Internal name of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_rate_plan_name of this InvoiceLinePayment. - :rtype: str - """ - return self._product_rate_plan_name - - @product_rate_plan_name.setter - def product_rate_plan_name(self, product_rate_plan_name): - """ - Sets the product_rate_plan_name of this InvoiceLinePayment. - {\"description\":\"Internal name of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_rate_plan_name: The product_rate_plan_name of this InvoiceLinePayment. - :type: str - """ - - self._product_rate_plan_name = product_rate_plan_name - - @property - def product_rate_plan_name_public(self): - """ - Gets the product_rate_plan_name_public of this InvoiceLinePayment. - {\"description\":\"Public name of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_rate_plan_name_public of this InvoiceLinePayment. - :rtype: str - """ - return self._product_rate_plan_name_public - - @product_rate_plan_name_public.setter - def product_rate_plan_name_public(self, product_rate_plan_name_public): - """ - Sets the product_rate_plan_name_public of this InvoiceLinePayment. - {\"description\":\"Public name of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_rate_plan_name_public: The product_rate_plan_name_public of this InvoiceLinePayment. - :type: str - """ - - self._product_rate_plan_name_public = product_rate_plan_name_public - - @property - def product_id(self): - """ - Gets the product_id of this InvoiceLinePayment. - {\"description\":\"ID of the Product with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_id of this InvoiceLinePayment. - :rtype: str - """ - return self._product_id - - @product_id.setter - def product_id(self, product_id): - """ - Sets the product_id of this InvoiceLinePayment. - {\"description\":\"ID of the Product with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_id: The product_id of this InvoiceLinePayment. - :type: str - """ - - self._product_id = product_id - - @property - def product_name(self): - """ - Gets the product_name of this InvoiceLinePayment. - {\"description\":\"Internal name of the Product with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_name of this InvoiceLinePayment. - :rtype: str - """ - return self._product_name - - @product_name.setter - def product_name(self, product_name): - """ - Sets the product_name of this InvoiceLinePayment. - {\"description\":\"Internal name of the Product with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_name: The product_name of this InvoiceLinePayment. - :type: str - """ - - self._product_name = product_name - - @property - def product_name_public(self): - """ - Gets the product_name_public of this InvoiceLinePayment. - {\"description\":\"Public name of the Product with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_name_public of this InvoiceLinePayment. - :rtype: str - """ - return self._product_name_public - - @product_name_public.setter - def product_name_public(self, product_name_public): - """ - Sets the product_name_public of this InvoiceLinePayment. - {\"description\":\"Public name of the Product with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_name_public: The product_name_public of this InvoiceLinePayment. - :type: str - """ - - self._product_name_public = product_name_public - - @property - def subscription_id(self): - """ - Gets the subscription_id of this InvoiceLinePayment. - {\"description\":\"ID of the Subscription with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The subscription_id of this InvoiceLinePayment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this InvoiceLinePayment. - {\"description\":\"ID of the Subscription with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param subscription_id: The subscription_id of this InvoiceLinePayment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def account_id(self): - """ - Gets the account_id of this InvoiceLinePayment. - {\"description\":\"ID of the Account with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The account_id of this InvoiceLinePayment. - :rtype: str - """ - return self._account_id - - @account_id.setter - def account_id(self, account_id): - """ - Sets the account_id of this InvoiceLinePayment. - {\"description\":\"ID of the Account with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param account_id: The account_id of this InvoiceLinePayment. - :type: str - """ - - self._account_id = account_id - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/invoice_line_payment_paged_metadata.py b/billforward/models/invoice_line_payment_paged_metadata.py deleted file mode 100644 index 3fd4931..0000000 --- a/billforward/models/invoice_line_payment_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class InvoiceLinePaymentPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - InvoiceLinePaymentPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[InvoiceLinePayment]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this InvoiceLinePaymentPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this InvoiceLinePaymentPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this InvoiceLinePaymentPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this InvoiceLinePaymentPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this InvoiceLinePaymentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this InvoiceLinePaymentPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this InvoiceLinePaymentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this InvoiceLinePaymentPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this InvoiceLinePaymentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this InvoiceLinePaymentPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this InvoiceLinePaymentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this InvoiceLinePaymentPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this InvoiceLinePaymentPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this InvoiceLinePaymentPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this InvoiceLinePaymentPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this InvoiceLinePaymentPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this InvoiceLinePaymentPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this InvoiceLinePaymentPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this InvoiceLinePaymentPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this InvoiceLinePaymentPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this InvoiceLinePaymentPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this InvoiceLinePaymentPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this InvoiceLinePaymentPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this InvoiceLinePaymentPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this InvoiceLinePaymentPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this InvoiceLinePaymentPagedMetadata. - :rtype: list[InvoiceLinePayment] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this InvoiceLinePaymentPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this InvoiceLinePaymentPagedMetadata. - :type: list[InvoiceLinePayment] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/invoice_line_payments.py b/billforward/models/invoice_line_payments.py new file mode 100644 index 0000000..597e82e --- /dev/null +++ b/billforward/models/invoice_line_payments.py @@ -0,0 +1,1045 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InvoiceLinePayments(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'id': 'str', + 'organization_id': 'str', + 'payment_id': 'str', + 'gateway_original_payment_reference': 'str', + 'gateway_refund_payment_reference': 'str', + 'paid_invoice_version_id': 'str', + 'invoice_id': 'str', + 'child_invoice_line_id': 'str', + 'invoice_payment_id': 'str', + 'currency': 'CreditNoteCurrency', + 'gateway': 'str', + 'nominal_amount': 'float', + 'actual_amount': 'float', + 'refunded_amount': 'float', + 'pricing_component_id': 'str', + 'pricing_component_name': 'str', + 'product_rate_plan_id': 'str', + 'product_rate_plan_name': 'str', + 'product_rate_plan_name_public': 'str', + 'product_id': 'str', + 'product_name': 'str', + 'product_name_public': 'str', + 'child_subscription_id': 'str', + 'subscription_id': 'str', + 'account_id': 'str', + 'period_start': 'datetime', + 'period_end': 'datetime', + 'payment_received': 'datetime', + 'refund_received': 'datetime', + 'pricing_component_charge_type': 'str', + 'debit_quantity': 'int', + 'province': 'str', + 'country': 'str', + 'manual_charge_name': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'id': 'id', + 'organization_id': 'organizationID', + 'payment_id': 'paymentID', + 'gateway_original_payment_reference': 'gatewayOriginalPaymentReference', + 'gateway_refund_payment_reference': 'gatewayRefundPaymentReference', + 'paid_invoice_version_id': 'paidInvoiceVersionID', + 'invoice_id': 'invoiceID', + 'child_invoice_line_id': 'childInvoiceLineID', + 'invoice_payment_id': 'invoicePaymentID', + 'currency': 'currency', + 'gateway': 'gateway', + 'nominal_amount': 'nominalAmount', + 'actual_amount': 'actualAmount', + 'refunded_amount': 'refundedAmount', + 'pricing_component_id': 'pricingComponentID', + 'pricing_component_name': 'pricingComponentName', + 'product_rate_plan_id': 'productRatePlanID', + 'product_rate_plan_name': 'productRatePlanName', + 'product_rate_plan_name_public': 'productRatePlanNamePublic', + 'product_id': 'productID', + 'product_name': 'productName', + 'product_name_public': 'productNamePublic', + 'child_subscription_id': 'childSubscriptionID', + 'subscription_id': 'subscriptionID', + 'account_id': 'accountID', + 'period_start': 'periodStart', + 'period_end': 'periodEnd', + 'payment_received': 'paymentReceived', + 'refund_received': 'refundReceived', + 'pricing_component_charge_type': 'pricingComponentChargeType', + 'debit_quantity': 'debitQuantity', + 'province': 'province', + 'country': 'country', + 'manual_charge_name': 'manualChargeName' + } + + def __init__(self, created=None, changed_by=None, id=None, organization_id=None, payment_id=None, gateway_original_payment_reference=None, gateway_refund_payment_reference=None, paid_invoice_version_id=None, invoice_id=None, child_invoice_line_id=None, invoice_payment_id=None, currency=None, gateway=None, nominal_amount=None, actual_amount=None, refunded_amount=None, pricing_component_id=None, pricing_component_name=None, product_rate_plan_id=None, product_rate_plan_name=None, product_rate_plan_name_public=None, product_id=None, product_name=None, product_name_public=None, child_subscription_id=None, subscription_id=None, account_id=None, period_start=None, period_end=None, payment_received=None, refund_received=None, pricing_component_charge_type=None, debit_quantity=None, province=None, country=None, manual_charge_name=None): # noqa: E501 + """InvoiceLinePayments - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._id = None + self._organization_id = None + self._payment_id = None + self._gateway_original_payment_reference = None + self._gateway_refund_payment_reference = None + self._paid_invoice_version_id = None + self._invoice_id = None + self._child_invoice_line_id = None + self._invoice_payment_id = None + self._currency = None + self._gateway = None + self._nominal_amount = None + self._actual_amount = None + self._refunded_amount = None + self._pricing_component_id = None + self._pricing_component_name = None + self._product_rate_plan_id = None + self._product_rate_plan_name = None + self._product_rate_plan_name_public = None + self._product_id = None + self._product_name = None + self._product_name_public = None + self._child_subscription_id = None + self._subscription_id = None + self._account_id = None + self._period_start = None + self._period_end = None + self._payment_received = None + self._refund_received = None + self._pricing_component_charge_type = None + self._debit_quantity = None + self._province = None + self._country = None + self._manual_charge_name = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if id is not None: + self.id = id + self.organization_id = organization_id + self.payment_id = payment_id + if gateway_original_payment_reference is not None: + self.gateway_original_payment_reference = gateway_original_payment_reference + if gateway_refund_payment_reference is not None: + self.gateway_refund_payment_reference = gateway_refund_payment_reference + self.paid_invoice_version_id = paid_invoice_version_id + if invoice_id is not None: + self.invoice_id = invoice_id + if child_invoice_line_id is not None: + self.child_invoice_line_id = child_invoice_line_id + self.invoice_payment_id = invoice_payment_id + self.currency = currency + self.gateway = gateway + self.nominal_amount = nominal_amount + self.actual_amount = actual_amount + self.refunded_amount = refunded_amount + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if product_rate_plan_id is not None: + self.product_rate_plan_id = product_rate_plan_id + if product_rate_plan_name is not None: + self.product_rate_plan_name = product_rate_plan_name + if product_rate_plan_name_public is not None: + self.product_rate_plan_name_public = product_rate_plan_name_public + if product_id is not None: + self.product_id = product_id + if product_name is not None: + self.product_name = product_name + if product_name_public is not None: + self.product_name_public = product_name_public + if child_subscription_id is not None: + self.child_subscription_id = child_subscription_id + if subscription_id is not None: + self.subscription_id = subscription_id + if account_id is not None: + self.account_id = account_id + self.period_start = period_start + self.period_end = period_end + self.payment_received = payment_received + self.refund_received = refund_received + if pricing_component_charge_type is not None: + self.pricing_component_charge_type = pricing_component_charge_type + if debit_quantity is not None: + self.debit_quantity = debit_quantity + if province is not None: + self.province = province + if country is not None: + self.country = country + if manual_charge_name is not None: + self.manual_charge_name = manual_charge_name + + @property + def created(self): + """Gets the created of this InvoiceLinePayments. # noqa: E501 + + + :return: The created of this InvoiceLinePayments. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this InvoiceLinePayments. + + + :param created: The created of this InvoiceLinePayments. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this InvoiceLinePayments. # noqa: E501 + + + :return: The changed_by of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this InvoiceLinePayments. + + + :param changed_by: The changed_by of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def id(self): + """Gets the id of this InvoiceLinePayments. # noqa: E501 + + + :return: The id of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this InvoiceLinePayments. + + + :param id: The id of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this InvoiceLinePayments. # noqa: E501 + + + :return: The organization_id of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this InvoiceLinePayments. + + + :param organization_id: The organization_id of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def payment_id(self): + """Gets the payment_id of this InvoiceLinePayments. # noqa: E501 + + + :return: The payment_id of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._payment_id + + @payment_id.setter + def payment_id(self, payment_id): + """Sets the payment_id of this InvoiceLinePayments. + + + :param payment_id: The payment_id of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + if payment_id is None: + raise ValueError("Invalid value for `payment_id`, must not be `None`") # noqa: E501 + + self._payment_id = payment_id + + @property + def gateway_original_payment_reference(self): + """Gets the gateway_original_payment_reference of this InvoiceLinePayments. # noqa: E501 + + + :return: The gateway_original_payment_reference of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._gateway_original_payment_reference + + @gateway_original_payment_reference.setter + def gateway_original_payment_reference(self, gateway_original_payment_reference): + """Sets the gateway_original_payment_reference of this InvoiceLinePayments. + + + :param gateway_original_payment_reference: The gateway_original_payment_reference of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._gateway_original_payment_reference = gateway_original_payment_reference + + @property + def gateway_refund_payment_reference(self): + """Gets the gateway_refund_payment_reference of this InvoiceLinePayments. # noqa: E501 + + + :return: The gateway_refund_payment_reference of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._gateway_refund_payment_reference + + @gateway_refund_payment_reference.setter + def gateway_refund_payment_reference(self, gateway_refund_payment_reference): + """Sets the gateway_refund_payment_reference of this InvoiceLinePayments. + + + :param gateway_refund_payment_reference: The gateway_refund_payment_reference of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._gateway_refund_payment_reference = gateway_refund_payment_reference + + @property + def paid_invoice_version_id(self): + """Gets the paid_invoice_version_id of this InvoiceLinePayments. # noqa: E501 + + + :return: The paid_invoice_version_id of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._paid_invoice_version_id + + @paid_invoice_version_id.setter + def paid_invoice_version_id(self, paid_invoice_version_id): + """Sets the paid_invoice_version_id of this InvoiceLinePayments. + + + :param paid_invoice_version_id: The paid_invoice_version_id of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + if paid_invoice_version_id is None: + raise ValueError("Invalid value for `paid_invoice_version_id`, must not be `None`") # noqa: E501 + + self._paid_invoice_version_id = paid_invoice_version_id + + @property + def invoice_id(self): + """Gets the invoice_id of this InvoiceLinePayments. # noqa: E501 + + + :return: The invoice_id of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this InvoiceLinePayments. + + + :param invoice_id: The invoice_id of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._invoice_id = invoice_id + + @property + def child_invoice_line_id(self): + """Gets the child_invoice_line_id of this InvoiceLinePayments. # noqa: E501 + + + :return: The child_invoice_line_id of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._child_invoice_line_id + + @child_invoice_line_id.setter + def child_invoice_line_id(self, child_invoice_line_id): + """Sets the child_invoice_line_id of this InvoiceLinePayments. + + + :param child_invoice_line_id: The child_invoice_line_id of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._child_invoice_line_id = child_invoice_line_id + + @property + def invoice_payment_id(self): + """Gets the invoice_payment_id of this InvoiceLinePayments. # noqa: E501 + + + :return: The invoice_payment_id of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._invoice_payment_id + + @invoice_payment_id.setter + def invoice_payment_id(self, invoice_payment_id): + """Sets the invoice_payment_id of this InvoiceLinePayments. + + + :param invoice_payment_id: The invoice_payment_id of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + if invoice_payment_id is None: + raise ValueError("Invalid value for `invoice_payment_id`, must not be `None`") # noqa: E501 + + self._invoice_payment_id = invoice_payment_id + + @property + def currency(self): + """Gets the currency of this InvoiceLinePayments. # noqa: E501 + + + :return: The currency of this InvoiceLinePayments. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this InvoiceLinePayments. + + + :param currency: The currency of this InvoiceLinePayments. # noqa: E501 + :type: CreditNoteCurrency + """ + if currency is None: + raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501 + + self._currency = currency + + @property + def gateway(self): + """Gets the gateway of this InvoiceLinePayments. # noqa: E501 + + + :return: The gateway of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._gateway + + @gateway.setter + def gateway(self, gateway): + """Sets the gateway of this InvoiceLinePayments. + + + :param gateway: The gateway of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + if gateway is None: + raise ValueError("Invalid value for `gateway`, must not be `None`") # noqa: E501 + allowed_values = ["VOID", "cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "zooz", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "goCardless", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash", "epx", "shuttle", "square", "billforwardRandomizer", "cardConnect", "ebanx"] # noqa: E501 + if gateway not in allowed_values: + raise ValueError( + "Invalid value for `gateway` ({0}), must be one of {1}" # noqa: E501 + .format(gateway, allowed_values) + ) + + self._gateway = gateway + + @property + def nominal_amount(self): + """Gets the nominal_amount of this InvoiceLinePayments. # noqa: E501 + + + :return: The nominal_amount of this InvoiceLinePayments. # noqa: E501 + :rtype: float + """ + return self._nominal_amount + + @nominal_amount.setter + def nominal_amount(self, nominal_amount): + """Sets the nominal_amount of this InvoiceLinePayments. + + + :param nominal_amount: The nominal_amount of this InvoiceLinePayments. # noqa: E501 + :type: float + """ + if nominal_amount is None: + raise ValueError("Invalid value for `nominal_amount`, must not be `None`") # noqa: E501 + + self._nominal_amount = nominal_amount + + @property + def actual_amount(self): + """Gets the actual_amount of this InvoiceLinePayments. # noqa: E501 + + + :return: The actual_amount of this InvoiceLinePayments. # noqa: E501 + :rtype: float + """ + return self._actual_amount + + @actual_amount.setter + def actual_amount(self, actual_amount): + """Sets the actual_amount of this InvoiceLinePayments. + + + :param actual_amount: The actual_amount of this InvoiceLinePayments. # noqa: E501 + :type: float + """ + if actual_amount is None: + raise ValueError("Invalid value for `actual_amount`, must not be `None`") # noqa: E501 + + self._actual_amount = actual_amount + + @property + def refunded_amount(self): + """Gets the refunded_amount of this InvoiceLinePayments. # noqa: E501 + + + :return: The refunded_amount of this InvoiceLinePayments. # noqa: E501 + :rtype: float + """ + return self._refunded_amount + + @refunded_amount.setter + def refunded_amount(self, refunded_amount): + """Sets the refunded_amount of this InvoiceLinePayments. + + + :param refunded_amount: The refunded_amount of this InvoiceLinePayments. # noqa: E501 + :type: float + """ + if refunded_amount is None: + raise ValueError("Invalid value for `refunded_amount`, must not be `None`") # noqa: E501 + + self._refunded_amount = refunded_amount + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this InvoiceLinePayments. # noqa: E501 + + + :return: The pricing_component_id of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this InvoiceLinePayments. + + + :param pricing_component_id: The pricing_component_id of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._pricing_component_id = pricing_component_id + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this InvoiceLinePayments. # noqa: E501 + + + :return: The pricing_component_name of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._pricing_component_name + + @pricing_component_name.setter + def pricing_component_name(self, pricing_component_name): + """Sets the pricing_component_name of this InvoiceLinePayments. + + + :param pricing_component_name: The pricing_component_name of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._pricing_component_name = pricing_component_name + + @property + def product_rate_plan_id(self): + """Gets the product_rate_plan_id of this InvoiceLinePayments. # noqa: E501 + + + :return: The product_rate_plan_id of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_id + + @product_rate_plan_id.setter + def product_rate_plan_id(self, product_rate_plan_id): + """Sets the product_rate_plan_id of this InvoiceLinePayments. + + + :param product_rate_plan_id: The product_rate_plan_id of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._product_rate_plan_id = product_rate_plan_id + + @property + def product_rate_plan_name(self): + """Gets the product_rate_plan_name of this InvoiceLinePayments. # noqa: E501 + + + :return: The product_rate_plan_name of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_name + + @product_rate_plan_name.setter + def product_rate_plan_name(self, product_rate_plan_name): + """Sets the product_rate_plan_name of this InvoiceLinePayments. + + + :param product_rate_plan_name: The product_rate_plan_name of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._product_rate_plan_name = product_rate_plan_name + + @property + def product_rate_plan_name_public(self): + """Gets the product_rate_plan_name_public of this InvoiceLinePayments. # noqa: E501 + + + :return: The product_rate_plan_name_public of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_name_public + + @product_rate_plan_name_public.setter + def product_rate_plan_name_public(self, product_rate_plan_name_public): + """Sets the product_rate_plan_name_public of this InvoiceLinePayments. + + + :param product_rate_plan_name_public: The product_rate_plan_name_public of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._product_rate_plan_name_public = product_rate_plan_name_public + + @property + def product_id(self): + """Gets the product_id of this InvoiceLinePayments. # noqa: E501 + + + :return: The product_id of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._product_id + + @product_id.setter + def product_id(self, product_id): + """Sets the product_id of this InvoiceLinePayments. + + + :param product_id: The product_id of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._product_id = product_id + + @property + def product_name(self): + """Gets the product_name of this InvoiceLinePayments. # noqa: E501 + + + :return: The product_name of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._product_name + + @product_name.setter + def product_name(self, product_name): + """Sets the product_name of this InvoiceLinePayments. + + + :param product_name: The product_name of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._product_name = product_name + + @property + def product_name_public(self): + """Gets the product_name_public of this InvoiceLinePayments. # noqa: E501 + + + :return: The product_name_public of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._product_name_public + + @product_name_public.setter + def product_name_public(self, product_name_public): + """Sets the product_name_public of this InvoiceLinePayments. + + + :param product_name_public: The product_name_public of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._product_name_public = product_name_public + + @property + def child_subscription_id(self): + """Gets the child_subscription_id of this InvoiceLinePayments. # noqa: E501 + + + :return: The child_subscription_id of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._child_subscription_id + + @child_subscription_id.setter + def child_subscription_id(self, child_subscription_id): + """Sets the child_subscription_id of this InvoiceLinePayments. + + + :param child_subscription_id: The child_subscription_id of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._child_subscription_id = child_subscription_id + + @property + def subscription_id(self): + """Gets the subscription_id of this InvoiceLinePayments. # noqa: E501 + + + :return: The subscription_id of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this InvoiceLinePayments. + + + :param subscription_id: The subscription_id of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def account_id(self): + """Gets the account_id of this InvoiceLinePayments. # noqa: E501 + + + :return: The account_id of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this InvoiceLinePayments. + + + :param account_id: The account_id of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def period_start(self): + """Gets the period_start of this InvoiceLinePayments. # noqa: E501 + + + :return: The period_start of this InvoiceLinePayments. # noqa: E501 + :rtype: datetime + """ + return self._period_start + + @period_start.setter + def period_start(self, period_start): + """Sets the period_start of this InvoiceLinePayments. + + + :param period_start: The period_start of this InvoiceLinePayments. # noqa: E501 + :type: datetime + """ + if period_start is None: + raise ValueError("Invalid value for `period_start`, must not be `None`") # noqa: E501 + + self._period_start = period_start + + @property + def period_end(self): + """Gets the period_end of this InvoiceLinePayments. # noqa: E501 + + + :return: The period_end of this InvoiceLinePayments. # noqa: E501 + :rtype: datetime + """ + return self._period_end + + @period_end.setter + def period_end(self, period_end): + """Sets the period_end of this InvoiceLinePayments. + + + :param period_end: The period_end of this InvoiceLinePayments. # noqa: E501 + :type: datetime + """ + if period_end is None: + raise ValueError("Invalid value for `period_end`, must not be `None`") # noqa: E501 + + self._period_end = period_end + + @property + def payment_received(self): + """Gets the payment_received of this InvoiceLinePayments. # noqa: E501 + + + :return: The payment_received of this InvoiceLinePayments. # noqa: E501 + :rtype: datetime + """ + return self._payment_received + + @payment_received.setter + def payment_received(self, payment_received): + """Sets the payment_received of this InvoiceLinePayments. + + + :param payment_received: The payment_received of this InvoiceLinePayments. # noqa: E501 + :type: datetime + """ + if payment_received is None: + raise ValueError("Invalid value for `payment_received`, must not be `None`") # noqa: E501 + + self._payment_received = payment_received + + @property + def refund_received(self): + """Gets the refund_received of this InvoiceLinePayments. # noqa: E501 + + + :return: The refund_received of this InvoiceLinePayments. # noqa: E501 + :rtype: datetime + """ + return self._refund_received + + @refund_received.setter + def refund_received(self, refund_received): + """Sets the refund_received of this InvoiceLinePayments. + + + :param refund_received: The refund_received of this InvoiceLinePayments. # noqa: E501 + :type: datetime + """ + if refund_received is None: + raise ValueError("Invalid value for `refund_received`, must not be `None`") # noqa: E501 + + self._refund_received = refund_received + + @property + def pricing_component_charge_type(self): + """Gets the pricing_component_charge_type of this InvoiceLinePayments. # noqa: E501 + + + :return: The pricing_component_charge_type of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._pricing_component_charge_type + + @pricing_component_charge_type.setter + def pricing_component_charge_type(self, pricing_component_charge_type): + """Sets the pricing_component_charge_type of this InvoiceLinePayments. + + + :param pricing_component_charge_type: The pricing_component_charge_type of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + allowed_values = ["setup", "subscription", "arrears", "usage"] # noqa: E501 + if pricing_component_charge_type not in allowed_values: + raise ValueError( + "Invalid value for `pricing_component_charge_type` ({0}), must be one of {1}" # noqa: E501 + .format(pricing_component_charge_type, allowed_values) + ) + + self._pricing_component_charge_type = pricing_component_charge_type + + @property + def debit_quantity(self): + """Gets the debit_quantity of this InvoiceLinePayments. # noqa: E501 + + + :return: The debit_quantity of this InvoiceLinePayments. # noqa: E501 + :rtype: int + """ + return self._debit_quantity + + @debit_quantity.setter + def debit_quantity(self, debit_quantity): + """Sets the debit_quantity of this InvoiceLinePayments. + + + :param debit_quantity: The debit_quantity of this InvoiceLinePayments. # noqa: E501 + :type: int + """ + + self._debit_quantity = debit_quantity + + @property + def province(self): + """Gets the province of this InvoiceLinePayments. # noqa: E501 + + + :return: The province of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._province + + @province.setter + def province(self, province): + """Sets the province of this InvoiceLinePayments. + + + :param province: The province of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._province = province + + @property + def country(self): + """Gets the country of this InvoiceLinePayments. # noqa: E501 + + + :return: The country of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._country + + @country.setter + def country(self, country): + """Sets the country of this InvoiceLinePayments. + + + :param country: The country of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._country = country + + @property + def manual_charge_name(self): + """Gets the manual_charge_name of this InvoiceLinePayments. # noqa: E501 + + + :return: The manual_charge_name of this InvoiceLinePayments. # noqa: E501 + :rtype: str + """ + return self._manual_charge_name + + @manual_charge_name.setter + def manual_charge_name(self, manual_charge_name): + """Sets the manual_charge_name of this InvoiceLinePayments. + + + :param manual_charge_name: The manual_charge_name of this InvoiceLinePayments. # noqa: E501 + :type: str + """ + + self._manual_charge_name = manual_charge_name + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InvoiceLinePayments, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InvoiceLinePayments): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/invoice_lines.py b/billforward/models/invoice_lines.py new file mode 100644 index 0000000..46d6c72 --- /dev/null +++ b/billforward/models/invoice_lines.py @@ -0,0 +1,1021 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InvoiceLines(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'invoice_id': 'str', + 'unit_of_measure_id': 'str', + 'subscription_id': 'str', + 'product_rate_plan_id': 'str', + 'public_product_rate_plan_name': 'str', + 'product_rate_plan_name': 'str', + 'product_id': 'str', + 'public_product_name': 'str', + 'product_name': 'str', + 'percentage_of_original': 'float', + 'organization_id': 'str', + 'name': 'str', + 'description': 'str', + 'calculation': 'str', + 'group_name': 'str', + 'cost': 'float', + 'tax': 'float', + 'component_value': 'int', + 'quantity_label': 'str', + 'pricing_component_id': 'str', + 'public_pricing_component_name': 'str', + 'pricing_component_name': 'str', + 'subscription_charge_id': 'str', + 'child_invoice_id': 'str', + 'type': 'str', + 'pricing_component_type': 'str', + 'charge_type': 'str', + 'period_start': 'datetime', + 'period_end': 'datetime', + 'linked_charge_id': 'str', + 'discount': 'float' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'invoice_id': 'invoiceID', + 'unit_of_measure_id': 'unitOfMeasureID', + 'subscription_id': 'subscriptionID', + 'product_rate_plan_id': 'productRatePlanID', + 'public_product_rate_plan_name': 'publicProductRatePlanName', + 'product_rate_plan_name': 'productRatePlanName', + 'product_id': 'productID', + 'public_product_name': 'publicProductName', + 'product_name': 'productName', + 'percentage_of_original': 'percentageOfOriginal', + 'organization_id': 'organizationID', + 'name': 'name', + 'description': 'description', + 'calculation': 'calculation', + 'group_name': 'groupName', + 'cost': 'cost', + 'tax': 'tax', + 'component_value': 'componentValue', + 'quantity_label': 'quantityLabel', + 'pricing_component_id': 'pricingComponentID', + 'public_pricing_component_name': 'publicPricingComponentName', + 'pricing_component_name': 'pricingComponentName', + 'subscription_charge_id': 'subscriptionChargeID', + 'child_invoice_id': 'childInvoiceID', + 'type': 'type', + 'pricing_component_type': 'pricingComponentType', + 'charge_type': 'chargeType', + 'period_start': 'periodStart', + 'period_end': 'periodEnd', + 'linked_charge_id': 'linkedChargeID', + 'discount': 'discount' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, invoice_id=None, unit_of_measure_id=None, subscription_id=None, product_rate_plan_id=None, public_product_rate_plan_name=None, product_rate_plan_name=None, product_id=None, public_product_name=None, product_name=None, percentage_of_original=None, organization_id=None, name=None, description=None, calculation=None, group_name=None, cost=None, tax=None, component_value=None, quantity_label=None, pricing_component_id=None, public_pricing_component_name=None, pricing_component_name=None, subscription_charge_id=None, child_invoice_id=None, type=None, pricing_component_type=None, charge_type=None, period_start=None, period_end=None, linked_charge_id=None, discount=None): # noqa: E501 + """InvoiceLines - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._invoice_id = None + self._unit_of_measure_id = None + self._subscription_id = None + self._product_rate_plan_id = None + self._public_product_rate_plan_name = None + self._product_rate_plan_name = None + self._product_id = None + self._public_product_name = None + self._product_name = None + self._percentage_of_original = None + self._organization_id = None + self._name = None + self._description = None + self._calculation = None + self._group_name = None + self._cost = None + self._tax = None + self._component_value = None + self._quantity_label = None + self._pricing_component_id = None + self._public_pricing_component_name = None + self._pricing_component_name = None + self._subscription_charge_id = None + self._child_invoice_id = None + self._type = None + self._pricing_component_type = None + self._charge_type = None + self._period_start = None + self._period_end = None + self._linked_charge_id = None + self._discount = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.invoice_id = invoice_id + if unit_of_measure_id is not None: + self.unit_of_measure_id = unit_of_measure_id + if subscription_id is not None: + self.subscription_id = subscription_id + if product_rate_plan_id is not None: + self.product_rate_plan_id = product_rate_plan_id + if public_product_rate_plan_name is not None: + self.public_product_rate_plan_name = public_product_rate_plan_name + if product_rate_plan_name is not None: + self.product_rate_plan_name = product_rate_plan_name + if product_id is not None: + self.product_id = product_id + if public_product_name is not None: + self.public_product_name = public_product_name + if product_name is not None: + self.product_name = product_name + if percentage_of_original is not None: + self.percentage_of_original = percentage_of_original + self.organization_id = organization_id + if name is not None: + self.name = name + if description is not None: + self.description = description + self.calculation = calculation + if group_name is not None: + self.group_name = group_name + self.cost = cost + self.tax = tax + if component_value is not None: + self.component_value = component_value + if quantity_label is not None: + self.quantity_label = quantity_label + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + if public_pricing_component_name is not None: + self.public_pricing_component_name = public_pricing_component_name + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if subscription_charge_id is not None: + self.subscription_charge_id = subscription_charge_id + if child_invoice_id is not None: + self.child_invoice_id = child_invoice_id + if type is not None: + self.type = type + self.pricing_component_type = pricing_component_type + self.charge_type = charge_type + self.period_start = period_start + self.period_end = period_end + if linked_charge_id is not None: + self.linked_charge_id = linked_charge_id + if discount is not None: + self.discount = discount + + @property + def created(self): + """Gets the created of this InvoiceLines. # noqa: E501 + + + :return: The created of this InvoiceLines. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this InvoiceLines. + + + :param created: The created of this InvoiceLines. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this InvoiceLines. # noqa: E501 + + + :return: The changed_by of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this InvoiceLines. + + + :param changed_by: The changed_by of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this InvoiceLines. # noqa: E501 + + + :return: The updated of this InvoiceLines. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this InvoiceLines. + + + :param updated: The updated of this InvoiceLines. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this InvoiceLines. # noqa: E501 + + + :return: The id of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this InvoiceLines. + + + :param id: The id of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def invoice_id(self): + """Gets the invoice_id of this InvoiceLines. # noqa: E501 + + + :return: The invoice_id of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this InvoiceLines. + + + :param invoice_id: The invoice_id of this InvoiceLines. # noqa: E501 + :type: str + """ + if invoice_id is None: + raise ValueError("Invalid value for `invoice_id`, must not be `None`") # noqa: E501 + + self._invoice_id = invoice_id + + @property + def unit_of_measure_id(self): + """Gets the unit_of_measure_id of this InvoiceLines. # noqa: E501 + + + :return: The unit_of_measure_id of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._unit_of_measure_id + + @unit_of_measure_id.setter + def unit_of_measure_id(self, unit_of_measure_id): + """Sets the unit_of_measure_id of this InvoiceLines. + + + :param unit_of_measure_id: The unit_of_measure_id of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._unit_of_measure_id = unit_of_measure_id + + @property + def subscription_id(self): + """Gets the subscription_id of this InvoiceLines. # noqa: E501 + + + :return: The subscription_id of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this InvoiceLines. + + + :param subscription_id: The subscription_id of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def product_rate_plan_id(self): + """Gets the product_rate_plan_id of this InvoiceLines. # noqa: E501 + + + :return: The product_rate_plan_id of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_id + + @product_rate_plan_id.setter + def product_rate_plan_id(self, product_rate_plan_id): + """Sets the product_rate_plan_id of this InvoiceLines. + + + :param product_rate_plan_id: The product_rate_plan_id of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._product_rate_plan_id = product_rate_plan_id + + @property + def public_product_rate_plan_name(self): + """Gets the public_product_rate_plan_name of this InvoiceLines. # noqa: E501 + + + :return: The public_product_rate_plan_name of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._public_product_rate_plan_name + + @public_product_rate_plan_name.setter + def public_product_rate_plan_name(self, public_product_rate_plan_name): + """Sets the public_product_rate_plan_name of this InvoiceLines. + + + :param public_product_rate_plan_name: The public_product_rate_plan_name of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._public_product_rate_plan_name = public_product_rate_plan_name + + @property + def product_rate_plan_name(self): + """Gets the product_rate_plan_name of this InvoiceLines. # noqa: E501 + + + :return: The product_rate_plan_name of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_name + + @product_rate_plan_name.setter + def product_rate_plan_name(self, product_rate_plan_name): + """Sets the product_rate_plan_name of this InvoiceLines. + + + :param product_rate_plan_name: The product_rate_plan_name of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._product_rate_plan_name = product_rate_plan_name + + @property + def product_id(self): + """Gets the product_id of this InvoiceLines. # noqa: E501 + + + :return: The product_id of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._product_id + + @product_id.setter + def product_id(self, product_id): + """Sets the product_id of this InvoiceLines. + + + :param product_id: The product_id of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._product_id = product_id + + @property + def public_product_name(self): + """Gets the public_product_name of this InvoiceLines. # noqa: E501 + + + :return: The public_product_name of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._public_product_name + + @public_product_name.setter + def public_product_name(self, public_product_name): + """Sets the public_product_name of this InvoiceLines. + + + :param public_product_name: The public_product_name of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._public_product_name = public_product_name + + @property + def product_name(self): + """Gets the product_name of this InvoiceLines. # noqa: E501 + + + :return: The product_name of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._product_name + + @product_name.setter + def product_name(self, product_name): + """Sets the product_name of this InvoiceLines. + + + :param product_name: The product_name of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._product_name = product_name + + @property + def percentage_of_original(self): + """Gets the percentage_of_original of this InvoiceLines. # noqa: E501 + + + :return: The percentage_of_original of this InvoiceLines. # noqa: E501 + :rtype: float + """ + return self._percentage_of_original + + @percentage_of_original.setter + def percentage_of_original(self, percentage_of_original): + """Sets the percentage_of_original of this InvoiceLines. + + + :param percentage_of_original: The percentage_of_original of this InvoiceLines. # noqa: E501 + :type: float + """ + + self._percentage_of_original = percentage_of_original + + @property + def organization_id(self): + """Gets the organization_id of this InvoiceLines. # noqa: E501 + + + :return: The organization_id of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this InvoiceLines. + + + :param organization_id: The organization_id of this InvoiceLines. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def name(self): + """Gets the name of this InvoiceLines. # noqa: E501 + + + :return: The name of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this InvoiceLines. + + + :param name: The name of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this InvoiceLines. # noqa: E501 + + + :return: The description of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this InvoiceLines. + + + :param description: The description of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def calculation(self): + """Gets the calculation of this InvoiceLines. # noqa: E501 + + + :return: The calculation of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._calculation + + @calculation.setter + def calculation(self, calculation): + """Sets the calculation of this InvoiceLines. + + + :param calculation: The calculation of this InvoiceLines. # noqa: E501 + :type: str + """ + if calculation is None: + raise ValueError("Invalid value for `calculation`, must not be `None`") # noqa: E501 + + self._calculation = calculation + + @property + def group_name(self): + """Gets the group_name of this InvoiceLines. # noqa: E501 + + + :return: The group_name of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._group_name + + @group_name.setter + def group_name(self, group_name): + """Sets the group_name of this InvoiceLines. + + + :param group_name: The group_name of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._group_name = group_name + + @property + def cost(self): + """Gets the cost of this InvoiceLines. # noqa: E501 + + + :return: The cost of this InvoiceLines. # noqa: E501 + :rtype: float + """ + return self._cost + + @cost.setter + def cost(self, cost): + """Sets the cost of this InvoiceLines. + + + :param cost: The cost of this InvoiceLines. # noqa: E501 + :type: float + """ + if cost is None: + raise ValueError("Invalid value for `cost`, must not be `None`") # noqa: E501 + + self._cost = cost + + @property + def tax(self): + """Gets the tax of this InvoiceLines. # noqa: E501 + + + :return: The tax of this InvoiceLines. # noqa: E501 + :rtype: float + """ + return self._tax + + @tax.setter + def tax(self, tax): + """Sets the tax of this InvoiceLines. + + + :param tax: The tax of this InvoiceLines. # noqa: E501 + :type: float + """ + if tax is None: + raise ValueError("Invalid value for `tax`, must not be `None`") # noqa: E501 + + self._tax = tax + + @property + def component_value(self): + """Gets the component_value of this InvoiceLines. # noqa: E501 + + + :return: The component_value of this InvoiceLines. # noqa: E501 + :rtype: int + """ + return self._component_value + + @component_value.setter + def component_value(self, component_value): + """Sets the component_value of this InvoiceLines. + + + :param component_value: The component_value of this InvoiceLines. # noqa: E501 + :type: int + """ + + self._component_value = component_value + + @property + def quantity_label(self): + """Gets the quantity_label of this InvoiceLines. # noqa: E501 + + + :return: The quantity_label of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._quantity_label + + @quantity_label.setter + def quantity_label(self, quantity_label): + """Sets the quantity_label of this InvoiceLines. + + + :param quantity_label: The quantity_label of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._quantity_label = quantity_label + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this InvoiceLines. # noqa: E501 + + + :return: The pricing_component_id of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this InvoiceLines. + + + :param pricing_component_id: The pricing_component_id of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._pricing_component_id = pricing_component_id + + @property + def public_pricing_component_name(self): + """Gets the public_pricing_component_name of this InvoiceLines. # noqa: E501 + + + :return: The public_pricing_component_name of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._public_pricing_component_name + + @public_pricing_component_name.setter + def public_pricing_component_name(self, public_pricing_component_name): + """Sets the public_pricing_component_name of this InvoiceLines. + + + :param public_pricing_component_name: The public_pricing_component_name of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._public_pricing_component_name = public_pricing_component_name + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this InvoiceLines. # noqa: E501 + + + :return: The pricing_component_name of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._pricing_component_name + + @pricing_component_name.setter + def pricing_component_name(self, pricing_component_name): + """Sets the pricing_component_name of this InvoiceLines. + + + :param pricing_component_name: The pricing_component_name of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._pricing_component_name = pricing_component_name + + @property + def subscription_charge_id(self): + """Gets the subscription_charge_id of this InvoiceLines. # noqa: E501 + + + :return: The subscription_charge_id of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._subscription_charge_id + + @subscription_charge_id.setter + def subscription_charge_id(self, subscription_charge_id): + """Sets the subscription_charge_id of this InvoiceLines. + + + :param subscription_charge_id: The subscription_charge_id of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._subscription_charge_id = subscription_charge_id + + @property + def child_invoice_id(self): + """Gets the child_invoice_id of this InvoiceLines. # noqa: E501 + + + :return: The child_invoice_id of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._child_invoice_id + + @child_invoice_id.setter + def child_invoice_id(self, child_invoice_id): + """Sets the child_invoice_id of this InvoiceLines. + + + :param child_invoice_id: The child_invoice_id of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._child_invoice_id = child_invoice_id + + @property + def type(self): + """Gets the type of this InvoiceLines. # noqa: E501 + + + :return: The type of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this InvoiceLines. + + + :param type: The type of this InvoiceLines. # noqa: E501 + :type: str + """ + allowed_values = ["PricingComponent", "Coupon", "Migration", "AggregatedInvoice", "Prepayment", "Manual", "AffiliateCommission"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def pricing_component_type(self): + """Gets the pricing_component_type of this InvoiceLines. # noqa: E501 + + + :return: The pricing_component_type of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._pricing_component_type + + @pricing_component_type.setter + def pricing_component_type(self, pricing_component_type): + """Sets the pricing_component_type of this InvoiceLines. + + + :param pricing_component_type: The pricing_component_type of this InvoiceLines. # noqa: E501 + :type: str + """ + if pricing_component_type is None: + raise ValueError("Invalid value for `pricing_component_type`, must not be `None`") # noqa: E501 + allowed_values = ["setup", "subscription", "arrears", "usage"] # noqa: E501 + if pricing_component_type not in allowed_values: + raise ValueError( + "Invalid value for `pricing_component_type` ({0}), must be one of {1}" # noqa: E501 + .format(pricing_component_type, allowed_values) + ) + + self._pricing_component_type = pricing_component_type + + @property + def charge_type(self): + """Gets the charge_type of this InvoiceLines. # noqa: E501 + + + :return: The charge_type of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._charge_type + + @charge_type.setter + def charge_type(self, charge_type): + """Sets the charge_type of this InvoiceLines. + + + :param charge_type: The charge_type of this InvoiceLines. # noqa: E501 + :type: str + """ + if charge_type is None: + raise ValueError("Invalid value for `charge_type`, must not be `None`") # noqa: E501 + allowed_values = ["Credit", "Debit"] # noqa: E501 + if charge_type not in allowed_values: + raise ValueError( + "Invalid value for `charge_type` ({0}), must be one of {1}" # noqa: E501 + .format(charge_type, allowed_values) + ) + + self._charge_type = charge_type + + @property + def period_start(self): + """Gets the period_start of this InvoiceLines. # noqa: E501 + + + :return: The period_start of this InvoiceLines. # noqa: E501 + :rtype: datetime + """ + return self._period_start + + @period_start.setter + def period_start(self, period_start): + """Sets the period_start of this InvoiceLines. + + + :param period_start: The period_start of this InvoiceLines. # noqa: E501 + :type: datetime + """ + if period_start is None: + raise ValueError("Invalid value for `period_start`, must not be `None`") # noqa: E501 + + self._period_start = period_start + + @property + def period_end(self): + """Gets the period_end of this InvoiceLines. # noqa: E501 + + + :return: The period_end of this InvoiceLines. # noqa: E501 + :rtype: datetime + """ + return self._period_end + + @period_end.setter + def period_end(self, period_end): + """Sets the period_end of this InvoiceLines. + + + :param period_end: The period_end of this InvoiceLines. # noqa: E501 + :type: datetime + """ + if period_end is None: + raise ValueError("Invalid value for `period_end`, must not be `None`") # noqa: E501 + + self._period_end = period_end + + @property + def linked_charge_id(self): + """Gets the linked_charge_id of this InvoiceLines. # noqa: E501 + + + :return: The linked_charge_id of this InvoiceLines. # noqa: E501 + :rtype: str + """ + return self._linked_charge_id + + @linked_charge_id.setter + def linked_charge_id(self, linked_charge_id): + """Sets the linked_charge_id of this InvoiceLines. + + + :param linked_charge_id: The linked_charge_id of this InvoiceLines. # noqa: E501 + :type: str + """ + + self._linked_charge_id = linked_charge_id + + @property + def discount(self): + """Gets the discount of this InvoiceLines. # noqa: E501 + + + :return: The discount of this InvoiceLines. # noqa: E501 + :rtype: float + """ + return self._discount + + @discount.setter + def discount(self, discount): + """Sets the discount of this InvoiceLines. + + + :param discount: The discount of this InvoiceLines. # noqa: E501 + :type: float + """ + + self._discount = discount + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InvoiceLines, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InvoiceLines): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/invoice_next_execution_attempt_amendment.py b/billforward/models/invoice_next_execution_attempt_amendment.py index c1d5d34..daa1205 100644 --- a/billforward/models/invoice_next_execution_attempt_amendment.py +++ b/billforward/models/invoice_next_execution_attempt_amendment.py @@ -1,441 +1,132 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class InvoiceNextExecutionAttemptAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class InvoiceNextExecutionAttemptAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False, invoice_id=None, force_paid=False): - """ - InvoiceNextExecutionAttemptAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool', - 'invoice_id': 'str', - 'force_paid': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted', - 'invoice_id': 'invoiceID', - 'force_paid': 'forcePaid' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - self._invoice_id = invoice_id - self._force_paid = force_paid - - @property - def created(self): - """ - Gets the created of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this InvoiceNextExecutionAttemptAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this InvoiceNextExecutionAttemptAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this InvoiceNextExecutionAttemptAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this InvoiceNextExecutionAttemptAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this InvoiceNextExecutionAttemptAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this InvoiceNextExecutionAttemptAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this InvoiceNextExecutionAttemptAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this InvoiceNextExecutionAttemptAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'invoice_id': 'str', + 'force_paid': 'bool', + 'force_paid_reason': 'str' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'invoice_id': 'invoiceID', + 'force_paid': 'forcePaid', + 'force_paid_reason': 'forcePaidReason' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, invoice_id=None, force_paid=None, force_paid_reason=None, *args, **kwargs): # noqa: E501 + """InvoiceNextExecutionAttemptAmendment - a model defined in Swagger""" # noqa: E501 + self._invoice_id = None + self._force_paid = None + self._force_paid_reason = None + self.discriminator = None + self.invoice_id = invoice_id + if force_paid is not None: + self.force_paid = force_paid + if force_paid_reason is not None: + self.force_paid_reason = force_paid_reason + Amendment.__init__(self, *args, **kwargs) @property - def id(self): - """ - Gets the id of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this InvoiceNextExecutionAttemptAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this InvoiceNextExecutionAttemptAmendment. - :type: str - """ - - self._id = id + def invoice_id(self): + """Gets the invoice_id of this InvoiceNextExecutionAttemptAmendment. # noqa: E501 - @property - def organization_id(self): - """ - Gets the organization_id of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - :return: The organization_id of this InvoiceNextExecutionAttemptAmendment. + :return: The invoice_id of this InvoiceNextExecutionAttemptAmendment. # noqa: E501 :rtype: str """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this InvoiceNextExecutionAttemptAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + return self._invoice_id - :return: The subscription_id of this InvoiceNextExecutionAttemptAmendment. - :rtype: str - """ - return self._subscription_id + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this InvoiceNextExecutionAttemptAmendment. - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - :param subscription_id: The subscription_id of this InvoiceNextExecutionAttemptAmendment. + :param invoice_id: The invoice_id of this InvoiceNextExecutionAttemptAmendment. # noqa: E501 :type: str """ + if invoice_id is None: + raise ValueError("Invalid value for `invoice_id`, must not be `None`") # noqa: E501 - self._subscription_id = subscription_id + self._invoice_id = invoice_id @property - def amendment_type(self): - """ - Gets the amendment_type of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this InvoiceNextExecutionAttemptAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this InvoiceNextExecutionAttemptAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) + def force_paid(self): + """Gets the force_paid of this InvoiceNextExecutionAttemptAmendment. # noqa: E501 - self._amendment_type = amendment_type - @property - def actioning_time(self): + :return: The force_paid of this InvoiceNextExecutionAttemptAmendment. # noqa: E501 + :rtype: bool """ - Gets the actioning_time of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + return self._force_paid - :return: The actioning_time of this InvoiceNextExecutionAttemptAmendment. - :rtype: datetime - """ - return self._actioning_time + @force_paid.setter + def force_paid(self, force_paid): + """Sets the force_paid of this InvoiceNextExecutionAttemptAmendment. - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - :param actioning_time: The actioning_time of this InvoiceNextExecutionAttemptAmendment. - :type: datetime + :param force_paid: The force_paid of this InvoiceNextExecutionAttemptAmendment. # noqa: E501 + :type: bool """ - self._actioning_time = actioning_time + self._force_paid = force_paid @property - def actioned_time(self): - """ - Gets the actioned_time of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } + def force_paid_reason(self): + """Gets the force_paid_reason of this InvoiceNextExecutionAttemptAmendment. # noqa: E501 - :return: The actioned_time of this InvoiceNextExecutionAttemptAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - :param actioned_time: The actioned_time of this InvoiceNextExecutionAttemptAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this InvoiceNextExecutionAttemptAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this InvoiceNextExecutionAttemptAmendment. + :return: The force_paid_reason of this InvoiceNextExecutionAttemptAmendment. # noqa: E501 :rtype: str """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this InvoiceNextExecutionAttemptAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this InvoiceNextExecutionAttemptAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) + return self._force_paid_reason - self._state = state + @force_paid_reason.setter + def force_paid_reason(self, force_paid_reason): + """Sets the force_paid_reason of this InvoiceNextExecutionAttemptAmendment. - @property - def deleted(self): - """ - Gets the deleted of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this InvoiceNextExecutionAttemptAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this InvoiceNextExecutionAttemptAmendment. - :type: bool - """ - self._deleted = deleted - - @property - def invoice_id(self): - """ - Gets the invoice_id of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"ID of the Invoice to which the amendment pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The invoice_id of this InvoiceNextExecutionAttemptAmendment. - :rtype: str - """ - return self._invoice_id - - @invoice_id.setter - def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"ID of the Invoice to which the amendment pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param invoice_id: The invoice_id of this InvoiceNextExecutionAttemptAmendment. + :param force_paid_reason: The force_paid_reason of this InvoiceNextExecutionAttemptAmendment. # noqa: E501 :type: str """ - self._invoice_id = invoice_id - - @property - def force_paid(self): - """ - Gets the force_paid of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"Create an offline payment and force the invoice into the paid state.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The force_paid of this InvoiceNextExecutionAttemptAmendment. - :rtype: bool - """ - return self._force_paid - - @force_paid.setter - def force_paid(self, force_paid): - """ - Sets the force_paid of this InvoiceNextExecutionAttemptAmendment. - { \"description\" : \"Create an offline payment and force the invoice into the paid state.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param force_paid: The force_paid of this InvoiceNextExecutionAttemptAmendment. - :type: bool - """ - - self._force_paid = force_paid + self._force_paid_reason = force_paid_reason def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -452,29 +143,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(InvoiceNextExecutionAttemptAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, InvoiceNextExecutionAttemptAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/invoice_outstanding_charges_amendment.py b/billforward/models/invoice_outstanding_charges_amendment.py index 1921b81..430699a 100644 --- a/billforward/models/invoice_outstanding_charges_amendment.py +++ b/billforward/models/invoice_outstanding_charges_amendment.py @@ -1,415 +1,79 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class InvoiceOutstandingChargesAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class InvoiceOutstandingChargesAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False, invoice_id=None): - """ - InvoiceOutstandingChargesAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool', - 'invoice_id': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted', - 'invoice_id': 'invoiceID' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - self._invoice_id = invoice_id - - @property - def created(self): - """ - Gets the created of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this InvoiceOutstandingChargesAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this InvoiceOutstandingChargesAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this InvoiceOutstandingChargesAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this InvoiceOutstandingChargesAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this InvoiceOutstandingChargesAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this InvoiceOutstandingChargesAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this InvoiceOutstandingChargesAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this InvoiceOutstandingChargesAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def id(self): - """ - Gets the id of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this InvoiceOutstandingChargesAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this InvoiceOutstandingChargesAmendment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this InvoiceOutstandingChargesAmendment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this InvoiceOutstandingChargesAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this InvoiceOutstandingChargesAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this InvoiceOutstandingChargesAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this InvoiceOutstandingChargesAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this InvoiceOutstandingChargesAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this InvoiceOutstandingChargesAmendment. - :rtype: datetime - """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actioning_time: The actioning_time of this InvoiceOutstandingChargesAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this InvoiceOutstandingChargesAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :param actioned_time: The actioned_time of this InvoiceOutstandingChargesAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this InvoiceOutstandingChargesAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this InvoiceOutstandingChargesAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this InvoiceOutstandingChargesAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this InvoiceOutstandingChargesAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this InvoiceOutstandingChargesAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this InvoiceOutstandingChargesAmendment. - :type: bool - """ - - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'invoice_id': 'str' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'invoice_id': 'invoiceID' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, invoice_id=None, *args, **kwargs): # noqa: E501 + """InvoiceOutstandingChargesAmendment - a model defined in Swagger""" # noqa: E501 + self._invoice_id = None + self.discriminator = None + if invoice_id is not None: + self.invoice_id = invoice_id + Amendment.__init__(self, *args, **kwargs) @property def invoice_id(self): - """ - Gets the invoice_id of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"ID of the Invoice with which the amendment is associated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the invoice_id of this InvoiceOutstandingChargesAmendment. # noqa: E501 + - :return: The invoice_id of this InvoiceOutstandingChargesAmendment. + :return: The invoice_id of this InvoiceOutstandingChargesAmendment. # noqa: E501 :rtype: str """ return self._invoice_id @invoice_id.setter def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this InvoiceOutstandingChargesAmendment. - { \"description\" : \"ID of the Invoice with which the amendment is associated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the invoice_id of this InvoiceOutstandingChargesAmendment. - :param invoice_id: The invoice_id of this InvoiceOutstandingChargesAmendment. + + :param invoice_id: The invoice_id of this InvoiceOutstandingChargesAmendment. # noqa: E501 :type: str """ self._invoice_id = invoice_id def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -426,29 +90,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(InvoiceOutstandingChargesAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, InvoiceOutstandingChargesAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/invoice_paged_metadata.py b/billforward/models/invoice_paged_metadata.py deleted file mode 100644 index 6506f35..0000000 --- a/billforward/models/invoice_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class InvoicePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - InvoicePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Invoice]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this InvoicePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this InvoicePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this InvoicePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this InvoicePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this InvoicePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this InvoicePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this InvoicePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this InvoicePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this InvoicePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this InvoicePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this InvoicePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this InvoicePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this InvoicePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this InvoicePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this InvoicePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this InvoicePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this InvoicePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this InvoicePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this InvoicePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this InvoicePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this InvoicePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this InvoicePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this InvoicePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this InvoicePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this InvoicePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this InvoicePagedMetadata. - :rtype: list[Invoice] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this InvoicePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this InvoicePagedMetadata. - :type: list[Invoice] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/invoice_payment.py b/billforward/models/invoice_payment.py deleted file mode 100644 index b30a2cf..0000000 --- a/billforward/models/invoice_payment.py +++ /dev/null @@ -1,494 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class InvoicePayment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, payment_received=None, refund_received=None, created=None, changed_by=None, updated=None, id=None, crm_id=None, payment_id=None, invoice_id=None, organization_id=None, currency=None, gateway=None, nominal_amount=None, actual_amount=None, refunded_amount=None): - """ - InvoicePayment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'payment_received': 'datetime', - 'refund_received': 'datetime', - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'crm_id': 'str', - 'payment_id': 'str', - 'invoice_id': 'str', - 'organization_id': 'str', - 'currency': 'str', - 'gateway': 'str', - 'nominal_amount': 'float', - 'actual_amount': 'float', - 'refunded_amount': 'float' - } - - self.attribute_map = { - 'payment_received': 'paymentReceived', - 'refund_received': 'refundReceived', - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'crm_id': 'crmID', - 'payment_id': 'paymentID', - 'invoice_id': 'invoiceID', - 'organization_id': 'organizationID', - 'currency': 'currency', - 'gateway': 'gateway', - 'nominal_amount': 'nominalAmount', - 'actual_amount': 'actualAmount', - 'refunded_amount': 'refundedAmount' - } - - self._payment_received = payment_received - self._refund_received = refund_received - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._crm_id = crm_id - self._payment_id = payment_id - self._invoice_id = invoice_id - self._organization_id = organization_id - self._currency = currency - self._gateway = gateway - self._nominal_amount = nominal_amount - self._actual_amount = actual_amount - self._refunded_amount = refunded_amount - - @property - def payment_received(self): - """ - Gets the payment_received of this InvoicePayment. - {\"description\":\"The date when the associated payment was received.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The payment_received of this InvoicePayment. - :rtype: datetime - """ - return self._payment_received - - @payment_received.setter - def payment_received(self, payment_received): - """ - Sets the payment_received of this InvoicePayment. - {\"description\":\"The date when the associated payment was received.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param payment_received: The payment_received of this InvoicePayment. - :type: datetime - """ - - self._payment_received = payment_received - - @property - def refund_received(self): - """ - Gets the refund_received of this InvoicePayment. - {\"description\":\"The date when the associated payment was refunded.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The refund_received of this InvoicePayment. - :rtype: datetime - """ - return self._refund_received - - @refund_received.setter - def refund_received(self, refund_received): - """ - Sets the refund_received of this InvoicePayment. - {\"description\":\"The date when the associated payment was refunded.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param refund_received: The refund_received of this InvoicePayment. - :type: datetime - """ - - self._refund_received = refund_received - - @property - def created(self): - """ - Gets the created of this InvoicePayment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this InvoicePayment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this InvoicePayment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this InvoicePayment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this InvoicePayment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this InvoicePayment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this InvoicePayment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this InvoicePayment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this InvoicePayment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this InvoicePayment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this InvoicePayment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this InvoicePayment. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this InvoicePayment. - { \"description\" : \"ID of the payment-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this InvoicePayment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this InvoicePayment. - { \"description\" : \"ID of the payment-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this InvoicePayment. - :type: str - """ - - self._id = id - - @property - def crm_id(self): - """ - Gets the crm_id of this InvoicePayment. - { \"description\" : \"CRM ID of the invoice.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The crm_id of this InvoicePayment. - :rtype: str - """ - return self._crm_id - - @crm_id.setter - def crm_id(self, crm_id): - """ - Sets the crm_id of this InvoicePayment. - { \"description\" : \"CRM ID of the invoice.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param crm_id: The crm_id of this InvoicePayment. - :type: str - """ - - self._crm_id = crm_id - - @property - def payment_id(self): - """ - Gets the payment_id of this InvoicePayment. - { \"description\" : \"ID of the payment used.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The payment_id of this InvoicePayment. - :rtype: str - """ - return self._payment_id - - @payment_id.setter - def payment_id(self, payment_id): - """ - Sets the payment_id of this InvoicePayment. - { \"description\" : \"ID of the payment used.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param payment_id: The payment_id of this InvoicePayment. - :type: str - """ - - self._payment_id = payment_id - - @property - def invoice_id(self): - """ - Gets the invoice_id of this InvoicePayment. - { \"description\" : \"ID of the invoice associated with the payment-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The invoice_id of this InvoicePayment. - :rtype: str - """ - return self._invoice_id - - @invoice_id.setter - def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this InvoicePayment. - { \"description\" : \"ID of the invoice associated with the payment-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param invoice_id: The invoice_id of this InvoicePayment. - :type: str - """ - - self._invoice_id = invoice_id - - @property - def organization_id(self): - """ - Gets the organization_id of this InvoicePayment. - { \"description\" : \"ID of the organization associated with the invoice-payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this InvoicePayment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this InvoicePayment. - { \"description\" : \"ID of the organization associated with the invoice-payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this InvoicePayment. - :type: str - """ - - self._organization_id = organization_id - - @property - def currency(self): - """ - Gets the currency of this InvoicePayment. - { \"description\" : \"The currency of the payment specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The currency of this InvoicePayment. - :rtype: str - """ - return self._currency - - @currency.setter - def currency(self, currency): - """ - Sets the currency of this InvoicePayment. - { \"description\" : \"The currency of the payment specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param currency: The currency of this InvoicePayment. - :type: str - """ - - self._currency = currency - - @property - def gateway(self): - """ - Gets the gateway of this InvoicePayment. - Payment gateway associated with the payment - - :return: The gateway of this InvoicePayment. - :rtype: str - """ - return self._gateway - - @gateway.setter - def gateway(self, gateway): - """ - Sets the gateway of this InvoicePayment. - Payment gateway associated with the payment - - :param gateway: The gateway of this InvoicePayment. - :type: str - """ - allowed_values = ["cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash"] - if gateway not in allowed_values: - raise ValueError( - "Invalid value for `gateway` ({0}), must be one of {1}" - .format(gateway, allowed_values) - ) - - self._gateway = gateway - - @property - def nominal_amount(self): - """ - Gets the nominal_amount of this InvoicePayment. - { \"description\" : \"The value that this payment-line represents.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The nominal_amount of this InvoicePayment. - :rtype: float - """ - return self._nominal_amount - - @nominal_amount.setter - def nominal_amount(self, nominal_amount): - """ - Sets the nominal_amount of this InvoicePayment. - { \"description\" : \"The value that this payment-line represents.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param nominal_amount: The nominal_amount of this InvoicePayment. - :type: float - """ - - self._nominal_amount = nominal_amount - - @property - def actual_amount(self): - """ - Gets the actual_amount of this InvoicePayment. - { \"description\" : \"The value of the payment used by payment-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actual_amount of this InvoicePayment. - :rtype: float - """ - return self._actual_amount - - @actual_amount.setter - def actual_amount(self, actual_amount): - """ - Sets the actual_amount of this InvoicePayment. - { \"description\" : \"The value of the payment used by payment-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actual_amount: The actual_amount of this InvoicePayment. - :type: float - """ - - self._actual_amount = actual_amount - - @property - def refunded_amount(self): - """ - Gets the refunded_amount of this InvoicePayment. - { \"description\" : \"The refunded amount of the invoice-payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The refunded_amount of this InvoicePayment. - :rtype: float - """ - return self._refunded_amount - - @refunded_amount.setter - def refunded_amount(self, refunded_amount): - """ - Sets the refunded_amount of this InvoicePayment. - { \"description\" : \"The refunded amount of the invoice-payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param refunded_amount: The refunded_amount of this InvoicePayment. - :type: float - """ - - self._refunded_amount = refunded_amount - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/invoice_payments.py b/billforward/models/invoice_payments.py new file mode 100644 index 0000000..0899ac0 --- /dev/null +++ b/billforward/models/invoice_payments.py @@ -0,0 +1,489 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InvoicePayments(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'crm_id': 'str', + 'payment_id': 'str', + 'invoice_id': 'str', + 'organization_id': 'str', + 'currency': 'CreditNoteCurrency', + 'gateway': 'str', + 'nominal_amount': 'float', + 'actual_amount': 'float', + 'refunded_amount': 'float', + 'payment_received': 'datetime', + 'refund_received': 'datetime' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'crm_id': 'crmID', + 'payment_id': 'paymentID', + 'invoice_id': 'invoiceID', + 'organization_id': 'organizationID', + 'currency': 'currency', + 'gateway': 'gateway', + 'nominal_amount': 'nominalAmount', + 'actual_amount': 'actualAmount', + 'refunded_amount': 'refundedAmount', + 'payment_received': 'paymentReceived', + 'refund_received': 'refundReceived' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, crm_id=None, payment_id=None, invoice_id=None, organization_id=None, currency=None, gateway=None, nominal_amount=None, actual_amount=None, refunded_amount=None, payment_received=None, refund_received=None): # noqa: E501 + """InvoicePayments - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._crm_id = None + self._payment_id = None + self._invoice_id = None + self._organization_id = None + self._currency = None + self._gateway = None + self._nominal_amount = None + self._actual_amount = None + self._refunded_amount = None + self._payment_received = None + self._refund_received = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if crm_id is not None: + self.crm_id = crm_id + self.payment_id = payment_id + self.invoice_id = invoice_id + self.organization_id = organization_id + self.currency = currency + if gateway is not None: + self.gateway = gateway + self.nominal_amount = nominal_amount + self.actual_amount = actual_amount + self.refunded_amount = refunded_amount + self.payment_received = payment_received + self.refund_received = refund_received + + @property + def created(self): + """Gets the created of this InvoicePayments. # noqa: E501 + + + :return: The created of this InvoicePayments. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this InvoicePayments. + + + :param created: The created of this InvoicePayments. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this InvoicePayments. # noqa: E501 + + + :return: The changed_by of this InvoicePayments. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this InvoicePayments. + + + :param changed_by: The changed_by of this InvoicePayments. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this InvoicePayments. # noqa: E501 + + + :return: The updated of this InvoicePayments. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this InvoicePayments. + + + :param updated: The updated of this InvoicePayments. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this InvoicePayments. # noqa: E501 + + + :return: The id of this InvoicePayments. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this InvoicePayments. + + + :param id: The id of this InvoicePayments. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def crm_id(self): + """Gets the crm_id of this InvoicePayments. # noqa: E501 + + + :return: The crm_id of this InvoicePayments. # noqa: E501 + :rtype: str + """ + return self._crm_id + + @crm_id.setter + def crm_id(self, crm_id): + """Sets the crm_id of this InvoicePayments. + + + :param crm_id: The crm_id of this InvoicePayments. # noqa: E501 + :type: str + """ + + self._crm_id = crm_id + + @property + def payment_id(self): + """Gets the payment_id of this InvoicePayments. # noqa: E501 + + + :return: The payment_id of this InvoicePayments. # noqa: E501 + :rtype: str + """ + return self._payment_id + + @payment_id.setter + def payment_id(self, payment_id): + """Sets the payment_id of this InvoicePayments. + + + :param payment_id: The payment_id of this InvoicePayments. # noqa: E501 + :type: str + """ + if payment_id is None: + raise ValueError("Invalid value for `payment_id`, must not be `None`") # noqa: E501 + + self._payment_id = payment_id + + @property + def invoice_id(self): + """Gets the invoice_id of this InvoicePayments. # noqa: E501 + + + :return: The invoice_id of this InvoicePayments. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this InvoicePayments. + + + :param invoice_id: The invoice_id of this InvoicePayments. # noqa: E501 + :type: str + """ + if invoice_id is None: + raise ValueError("Invalid value for `invoice_id`, must not be `None`") # noqa: E501 + + self._invoice_id = invoice_id + + @property + def organization_id(self): + """Gets the organization_id of this InvoicePayments. # noqa: E501 + + + :return: The organization_id of this InvoicePayments. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this InvoicePayments. + + + :param organization_id: The organization_id of this InvoicePayments. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def currency(self): + """Gets the currency of this InvoicePayments. # noqa: E501 + + + :return: The currency of this InvoicePayments. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this InvoicePayments. + + + :param currency: The currency of this InvoicePayments. # noqa: E501 + :type: CreditNoteCurrency + """ + if currency is None: + raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501 + + self._currency = currency + + @property + def gateway(self): + """Gets the gateway of this InvoicePayments. # noqa: E501 + + + :return: The gateway of this InvoicePayments. # noqa: E501 + :rtype: str + """ + return self._gateway + + @gateway.setter + def gateway(self, gateway): + """Sets the gateway of this InvoicePayments. + + + :param gateway: The gateway of this InvoicePayments. # noqa: E501 + :type: str + """ + allowed_values = ["VOID", "cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "zooz", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "goCardless", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash", "epx", "shuttle", "square", "billforwardRandomizer", "cardConnect", "ebanx"] # noqa: E501 + if gateway not in allowed_values: + raise ValueError( + "Invalid value for `gateway` ({0}), must be one of {1}" # noqa: E501 + .format(gateway, allowed_values) + ) + + self._gateway = gateway + + @property + def nominal_amount(self): + """Gets the nominal_amount of this InvoicePayments. # noqa: E501 + + + :return: The nominal_amount of this InvoicePayments. # noqa: E501 + :rtype: float + """ + return self._nominal_amount + + @nominal_amount.setter + def nominal_amount(self, nominal_amount): + """Sets the nominal_amount of this InvoicePayments. + + + :param nominal_amount: The nominal_amount of this InvoicePayments. # noqa: E501 + :type: float + """ + if nominal_amount is None: + raise ValueError("Invalid value for `nominal_amount`, must not be `None`") # noqa: E501 + + self._nominal_amount = nominal_amount + + @property + def actual_amount(self): + """Gets the actual_amount of this InvoicePayments. # noqa: E501 + + + :return: The actual_amount of this InvoicePayments. # noqa: E501 + :rtype: float + """ + return self._actual_amount + + @actual_amount.setter + def actual_amount(self, actual_amount): + """Sets the actual_amount of this InvoicePayments. + + + :param actual_amount: The actual_amount of this InvoicePayments. # noqa: E501 + :type: float + """ + if actual_amount is None: + raise ValueError("Invalid value for `actual_amount`, must not be `None`") # noqa: E501 + + self._actual_amount = actual_amount + + @property + def refunded_amount(self): + """Gets the refunded_amount of this InvoicePayments. # noqa: E501 + + + :return: The refunded_amount of this InvoicePayments. # noqa: E501 + :rtype: float + """ + return self._refunded_amount + + @refunded_amount.setter + def refunded_amount(self, refunded_amount): + """Sets the refunded_amount of this InvoicePayments. + + + :param refunded_amount: The refunded_amount of this InvoicePayments. # noqa: E501 + :type: float + """ + if refunded_amount is None: + raise ValueError("Invalid value for `refunded_amount`, must not be `None`") # noqa: E501 + + self._refunded_amount = refunded_amount + + @property + def payment_received(self): + """Gets the payment_received of this InvoicePayments. # noqa: E501 + + + :return: The payment_received of this InvoicePayments. # noqa: E501 + :rtype: datetime + """ + return self._payment_received + + @payment_received.setter + def payment_received(self, payment_received): + """Sets the payment_received of this InvoicePayments. + + + :param payment_received: The payment_received of this InvoicePayments. # noqa: E501 + :type: datetime + """ + if payment_received is None: + raise ValueError("Invalid value for `payment_received`, must not be `None`") # noqa: E501 + + self._payment_received = payment_received + + @property + def refund_received(self): + """Gets the refund_received of this InvoicePayments. # noqa: E501 + + + :return: The refund_received of this InvoicePayments. # noqa: E501 + :rtype: datetime + """ + return self._refund_received + + @refund_received.setter + def refund_received(self, refund_received): + """Sets the refund_received of this InvoicePayments. + + + :param refund_received: The refund_received of this InvoicePayments. # noqa: E501 + :type: datetime + """ + if refund_received is None: + raise ValueError("Invalid value for `refund_received`, must not be `None`") # noqa: E501 + + self._refund_received = refund_received + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InvoicePayments, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InvoicePayments): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/invoice_recalculation_amendment.py b/billforward/models/invoice_recalculation_amendment.py index 38e1a38..03417ab 100644 --- a/billforward/models/invoice_recalculation_amendment.py +++ b/billforward/models/invoice_recalculation_amendment.py @@ -1,441 +1,111 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class InvoiceRecalculationAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class InvoiceRecalculationAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False, invoice_id=None, recalculation_behaviour=None, new_invoice_state=None, include_invoiced_charges_only=False): - """ - InvoiceRecalculationAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool', - 'invoice_id': 'str', - 'recalculation_behaviour': 'str', - 'new_invoice_state': 'str', - 'include_invoiced_charges_only': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted', - 'invoice_id': 'invoiceID', - 'recalculation_behaviour': 'recalculationBehaviour', - 'new_invoice_state': 'newInvoiceState', - 'include_invoiced_charges_only': 'includeInvoicedChargesOnly' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - self._invoice_id = invoice_id - self._recalculation_behaviour = recalculation_behaviour - self._new_invoice_state = new_invoice_state - self._include_invoiced_charges_only = include_invoiced_charges_only - - @property - def created(self): - """ - Gets the created of this InvoiceRecalculationAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this InvoiceRecalculationAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this InvoiceRecalculationAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this InvoiceRecalculationAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this InvoiceRecalculationAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this InvoiceRecalculationAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this InvoiceRecalculationAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this InvoiceRecalculationAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this InvoiceRecalculationAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this InvoiceRecalculationAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this InvoiceRecalculationAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this InvoiceRecalculationAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this InvoiceRecalculationAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this InvoiceRecalculationAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this InvoiceRecalculationAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this InvoiceRecalculationAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def id(self): - """ - Gets the id of this InvoiceRecalculationAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this InvoiceRecalculationAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this InvoiceRecalculationAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this InvoiceRecalculationAmendment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this InvoiceRecalculationAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this InvoiceRecalculationAmendment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this InvoiceRecalculationAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this InvoiceRecalculationAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this InvoiceRecalculationAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this InvoiceRecalculationAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this InvoiceRecalculationAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this InvoiceRecalculationAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this InvoiceRecalculationAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this InvoiceRecalculationAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this InvoiceRecalculationAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this InvoiceRecalculationAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this InvoiceRecalculationAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this InvoiceRecalculationAmendment. - :rtype: datetime - """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this InvoiceRecalculationAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actioning_time: The actioning_time of this InvoiceRecalculationAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this InvoiceRecalculationAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this InvoiceRecalculationAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this InvoiceRecalculationAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :param actioned_time: The actioned_time of this InvoiceRecalculationAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this InvoiceRecalculationAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this InvoiceRecalculationAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this InvoiceRecalculationAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this InvoiceRecalculationAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this InvoiceRecalculationAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this InvoiceRecalculationAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this InvoiceRecalculationAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this InvoiceRecalculationAmendment. - :type: bool - """ - - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'invoice_id': 'str', + 'recalculation_behaviour': 'str', + 'new_invoice_state': 'str', + 'include_invoiced_charges_only': 'bool' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'invoice_id': 'invoiceID', + 'recalculation_behaviour': 'recalculationBehaviour', + 'new_invoice_state': 'newInvoiceState', + 'include_invoiced_charges_only': 'includeInvoicedChargesOnly' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, invoice_id=None, recalculation_behaviour=None, new_invoice_state=None, include_invoiced_charges_only=None, *args, **kwargs): # noqa: E501 + """InvoiceRecalculationAmendment - a model defined in Swagger""" # noqa: E501 + self._invoice_id = None + self._recalculation_behaviour = None + self._new_invoice_state = None + self._include_invoiced_charges_only = None + self.discriminator = None + self.invoice_id = invoice_id + self.recalculation_behaviour = recalculation_behaviour + self.new_invoice_state = new_invoice_state + self.include_invoiced_charges_only = include_invoiced_charges_only + Amendment.__init__(self, *args, **kwargs) @property def invoice_id(self): - """ - Gets the invoice_id of this InvoiceRecalculationAmendment. - { \"description\" : \"Identifier of the invoice to recalcaulte\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the invoice_id of this InvoiceRecalculationAmendment. # noqa: E501 + - :return: The invoice_id of this InvoiceRecalculationAmendment. + :return: The invoice_id of this InvoiceRecalculationAmendment. # noqa: E501 :rtype: str """ return self._invoice_id @invoice_id.setter def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this InvoiceRecalculationAmendment. - { \"description\" : \"Identifier of the invoice to recalcaulte\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the invoice_id of this InvoiceRecalculationAmendment. - :param invoice_id: The invoice_id of this InvoiceRecalculationAmendment. + + :param invoice_id: The invoice_id of this InvoiceRecalculationAmendment. # noqa: E501 :type: str """ + if invoice_id is None: + raise ValueError("Invalid value for `invoice_id`, must not be `None`") # noqa: E501 self._invoice_id = invoice_id @property def recalculation_behaviour(self): - """ - Gets the recalculation_behaviour of this InvoiceRecalculationAmendment. - { \"description\" : \"The recalculation behaviour of the invoice\", \"default\" : \"RecalculateAsLatestSubscriptionVersion\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the recalculation_behaviour of this InvoiceRecalculationAmendment. # noqa: E501 - :return: The recalculation_behaviour of this InvoiceRecalculationAmendment. + + :return: The recalculation_behaviour of this InvoiceRecalculationAmendment. # noqa: E501 :rtype: str """ return self._recalculation_behaviour @recalculation_behaviour.setter def recalculation_behaviour(self, recalculation_behaviour): - """ - Sets the recalculation_behaviour of this InvoiceRecalculationAmendment. - { \"description\" : \"The recalculation behaviour of the invoice\", \"default\" : \"RecalculateAsLatestSubscriptionVersion\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the recalculation_behaviour of this InvoiceRecalculationAmendment. + - :param recalculation_behaviour: The recalculation_behaviour of this InvoiceRecalculationAmendment. + :param recalculation_behaviour: The recalculation_behaviour of this InvoiceRecalculationAmendment. # noqa: E501 :type: str """ - allowed_values = ["RecalculateAsLatestSubscriptionVersion", "RecalculateAsCurrentSubscriptionVersion"] + if recalculation_behaviour is None: + raise ValueError("Invalid value for `recalculation_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["RecalculateAsLatestSubscriptionVersion", "RecalculateAsCurrentSubscriptionVersion"] # noqa: E501 if recalculation_behaviour not in allowed_values: raise ValueError( - "Invalid value for `recalculation_behaviour` ({0}), must be one of {1}" + "Invalid value for `recalculation_behaviour` ({0}), must be one of {1}" # noqa: E501 .format(recalculation_behaviour, allowed_values) ) @@ -443,28 +113,28 @@ def recalculation_behaviour(self, recalculation_behaviour): @property def new_invoice_state(self): - """ - Gets the new_invoice_state of this InvoiceRecalculationAmendment. - { \"description\" : \"State of invoice once recalculated\", \"default\" : \"Pending\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the new_invoice_state of this InvoiceRecalculationAmendment. # noqa: E501 + - :return: The new_invoice_state of this InvoiceRecalculationAmendment. + :return: The new_invoice_state of this InvoiceRecalculationAmendment. # noqa: E501 :rtype: str """ return self._new_invoice_state @new_invoice_state.setter def new_invoice_state(self, new_invoice_state): - """ - Sets the new_invoice_state of this InvoiceRecalculationAmendment. - { \"description\" : \"State of invoice once recalculated\", \"default\" : \"Pending\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the new_invoice_state of this InvoiceRecalculationAmendment. - :param new_invoice_state: The new_invoice_state of this InvoiceRecalculationAmendment. + + :param new_invoice_state: The new_invoice_state of this InvoiceRecalculationAmendment. # noqa: E501 :type: str """ - allowed_values = ["Paid", "Unpaid", "Pending", "Voided"] + if new_invoice_state is None: + raise ValueError("Invalid value for `new_invoice_state`, must not be `None`") # noqa: E501 + allowed_values = ["Paid", "Unpaid", "Pending", "Voided"] # noqa: E501 if new_invoice_state not in allowed_values: raise ValueError( - "Invalid value for `new_invoice_state` ({0}), must be one of {1}" + "Invalid value for `new_invoice_state` ({0}), must be one of {1}" # noqa: E501 .format(new_invoice_state, allowed_values) ) @@ -472,34 +142,32 @@ def new_invoice_state(self, new_invoice_state): @property def include_invoiced_charges_only(self): - """ - Gets the include_invoiced_charges_only of this InvoiceRecalculationAmendment. - { \"description\" : \"Only include charges which are already linked to the invoice being recalculated\", \"default\" : \"Pending\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the include_invoiced_charges_only of this InvoiceRecalculationAmendment. # noqa: E501 + - :return: The include_invoiced_charges_only of this InvoiceRecalculationAmendment. + :return: The include_invoiced_charges_only of this InvoiceRecalculationAmendment. # noqa: E501 :rtype: bool """ return self._include_invoiced_charges_only @include_invoiced_charges_only.setter def include_invoiced_charges_only(self, include_invoiced_charges_only): - """ - Sets the include_invoiced_charges_only of this InvoiceRecalculationAmendment. - { \"description\" : \"Only include charges which are already linked to the invoice being recalculated\", \"default\" : \"Pending\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the include_invoiced_charges_only of this InvoiceRecalculationAmendment. + - :param include_invoiced_charges_only: The include_invoiced_charges_only of this InvoiceRecalculationAmendment. + :param include_invoiced_charges_only: The include_invoiced_charges_only of this InvoiceRecalculationAmendment. # noqa: E501 :type: bool """ + if include_invoiced_charges_only is None: + raise ValueError("Invalid value for `include_invoiced_charges_only`, must not be `None`") # noqa: E501 self._include_invoiced_charges_only = include_invoiced_charges_only def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -516,29 +184,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(InvoiceRecalculationAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, InvoiceRecalculationAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/invoice_recalculation_request.py b/billforward/models/invoice_recalculation_request.py index 849588e..8e1768e 100644 --- a/billforward/models/invoice_recalculation_request.py +++ b/billforward/models/invoice_recalculation_request.py @@ -1,85 +1,97 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class InvoiceRecalculationRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, recalculation_behaviour=None, new_state=None, only_invoice_associated_charges=False, dry_run=False): - """ - InvoiceRecalculationRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'recalculation_behaviour': 'str', - 'new_state': 'str', - 'only_invoice_associated_charges': 'bool', - 'dry_run': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'recalculation_behaviour': 'recalculationBehaviour', - 'new_state': 'newState', - 'only_invoice_associated_charges': 'onlyInvoiceAssociatedCharges', - 'dry_run': 'dryRun' - } - - self._created = created - self._recalculation_behaviour = recalculation_behaviour - self._new_state = new_state - self._only_invoice_associated_charges = only_invoice_associated_charges - self._dry_run = dry_run + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'recalculation_behaviour': 'str', + 'new_state': 'str', + 'only_invoice_associated_charges': 'bool', + 'recalculate_parent': 'bool', + 'apply_coupons': 'bool', + 'dry_run': 'bool', + 'organization_id': 'str', + 'invoice_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'recalculation_behaviour': 'recalculationBehaviour', + 'new_state': 'newState', + 'only_invoice_associated_charges': 'onlyInvoiceAssociatedCharges', + 'recalculate_parent': 'recalculateParent', + 'apply_coupons': 'applyCoupons', + 'dry_run': 'dryRun', + 'organization_id': 'organizationID', + 'invoice_id': 'invoiceID' + } + + def __init__(self, created=None, recalculation_behaviour=None, new_state=None, only_invoice_associated_charges=None, recalculate_parent=None, apply_coupons=None, dry_run=None, organization_id=None, invoice_id=None): # noqa: E501 + """InvoiceRecalculationRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._recalculation_behaviour = None + self._new_state = None + self._only_invoice_associated_charges = None + self._recalculate_parent = None + self._apply_coupons = None + self._dry_run = None + self._organization_id = None + self._invoice_id = None + self.discriminator = None + if created is not None: + self.created = created + self.recalculation_behaviour = recalculation_behaviour + self.new_state = new_state + self.only_invoice_associated_charges = only_invoice_associated_charges + self.recalculate_parent = recalculate_parent + self.apply_coupons = apply_coupons + self.dry_run = dry_run + if organization_id is not None: + self.organization_id = organization_id + if invoice_id is not None: + self.invoice_id = invoice_id @property def created(self): - """ - Gets the created of this InvoiceRecalculationRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this InvoiceRecalculationRequest. # noqa: E501 + - :return: The created of this InvoiceRecalculationRequest. + :return: The created of this InvoiceRecalculationRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this InvoiceRecalculationRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this InvoiceRecalculationRequest. + - :param created: The created of this InvoiceRecalculationRequest. + :param created: The created of this InvoiceRecalculationRequest. # noqa: E501 :type: datetime """ @@ -87,28 +99,28 @@ def created(self, created): @property def recalculation_behaviour(self): - """ - Gets the recalculation_behaviour of this InvoiceRecalculationRequest. - {\"default\":\"RecalculateAsLatestSubscriptionVersion\",\"description\":\"On plan change a subscription may have outstanding invoices.If the value of the invoice needs to be changed it can either be calculated via the new or old plan. RecalculateAsLatestSubscriptionVersion calculates as the original plan and RecalculateAsCurrentSubscriptionVersion as the new plan\"verbs\":[\"POST\",\"GET\"]} + """Gets the recalculation_behaviour of this InvoiceRecalculationRequest. # noqa: E501 - :return: The recalculation_behaviour of this InvoiceRecalculationRequest. + + :return: The recalculation_behaviour of this InvoiceRecalculationRequest. # noqa: E501 :rtype: str """ return self._recalculation_behaviour @recalculation_behaviour.setter def recalculation_behaviour(self, recalculation_behaviour): - """ - Sets the recalculation_behaviour of this InvoiceRecalculationRequest. - {\"default\":\"RecalculateAsLatestSubscriptionVersion\",\"description\":\"On plan change a subscription may have outstanding invoices.If the value of the invoice needs to be changed it can either be calculated via the new or old plan. RecalculateAsLatestSubscriptionVersion calculates as the original plan and RecalculateAsCurrentSubscriptionVersion as the new plan\"verbs\":[\"POST\",\"GET\"]} + """Sets the recalculation_behaviour of this InvoiceRecalculationRequest. + - :param recalculation_behaviour: The recalculation_behaviour of this InvoiceRecalculationRequest. + :param recalculation_behaviour: The recalculation_behaviour of this InvoiceRecalculationRequest. # noqa: E501 :type: str """ - allowed_values = ["RecalculateAsLatestSubscriptionVersion", "RecalculateAsCurrentSubscriptionVersion"] + if recalculation_behaviour is None: + raise ValueError("Invalid value for `recalculation_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["RecalculateAsLatestSubscriptionVersion", "RecalculateAsCurrentSubscriptionVersion"] # noqa: E501 if recalculation_behaviour not in allowed_values: raise ValueError( - "Invalid value for `recalculation_behaviour` ({0}), must be one of {1}" + "Invalid value for `recalculation_behaviour` ({0}), must be one of {1}" # noqa: E501 .format(recalculation_behaviour, allowed_values) ) @@ -116,28 +128,28 @@ def recalculation_behaviour(self, recalculation_behaviour): @property def new_state(self): - """ - Gets the new_state of this InvoiceRecalculationRequest. - {\"default\":\"Pending\",\"description\":\"State of the invoice once recalculated\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the new_state of this InvoiceRecalculationRequest. # noqa: E501 + - :return: The new_state of this InvoiceRecalculationRequest. + :return: The new_state of this InvoiceRecalculationRequest. # noqa: E501 :rtype: str """ return self._new_state @new_state.setter def new_state(self, new_state): - """ - Sets the new_state of this InvoiceRecalculationRequest. - {\"default\":\"Pending\",\"description\":\"State of the invoice once recalculated\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the new_state of this InvoiceRecalculationRequest. + - :param new_state: The new_state of this InvoiceRecalculationRequest. + :param new_state: The new_state of this InvoiceRecalculationRequest. # noqa: E501 :type: str """ - allowed_values = ["Paid", "Unpaid", "Pending", "Voided"] + if new_state is None: + raise ValueError("Invalid value for `new_state`, must not be `None`") # noqa: E501 + allowed_values = ["Paid", "Unpaid", "Pending", "Voided"] # noqa: E501 if new_state not in allowed_values: raise ValueError( - "Invalid value for `new_state` ({0}), must be one of {1}" + "Invalid value for `new_state` ({0}), must be one of {1}" # noqa: E501 .format(new_state, allowed_values) ) @@ -145,57 +157,143 @@ def new_state(self, new_state): @property def only_invoice_associated_charges(self): - """ - Gets the only_invoice_associated_charges of this InvoiceRecalculationRequest. - {\"default\":true,\"description\":\"Only include charges which are already associated with the invoice. For example the subscription may have pending charges which can be added to the invoice on recalculation by setting this value to false. Note settings this value to true may cause new invoice line itemsto the invoice\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the only_invoice_associated_charges of this InvoiceRecalculationRequest. # noqa: E501 - :return: The only_invoice_associated_charges of this InvoiceRecalculationRequest. + + :return: The only_invoice_associated_charges of this InvoiceRecalculationRequest. # noqa: E501 :rtype: bool """ return self._only_invoice_associated_charges @only_invoice_associated_charges.setter def only_invoice_associated_charges(self, only_invoice_associated_charges): - """ - Sets the only_invoice_associated_charges of this InvoiceRecalculationRequest. - {\"default\":true,\"description\":\"Only include charges which are already associated with the invoice. For example the subscription may have pending charges which can be added to the invoice on recalculation by setting this value to false. Note settings this value to true may cause new invoice line itemsto the invoice\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the only_invoice_associated_charges of this InvoiceRecalculationRequest. + - :param only_invoice_associated_charges: The only_invoice_associated_charges of this InvoiceRecalculationRequest. + :param only_invoice_associated_charges: The only_invoice_associated_charges of this InvoiceRecalculationRequest. # noqa: E501 :type: bool """ + if only_invoice_associated_charges is None: + raise ValueError("Invalid value for `only_invoice_associated_charges`, must not be `None`") # noqa: E501 self._only_invoice_associated_charges = only_invoice_associated_charges @property - def dry_run(self): + def recalculate_parent(self): + """Gets the recalculate_parent of this InvoiceRecalculationRequest. # noqa: E501 + + + :return: The recalculate_parent of this InvoiceRecalculationRequest. # noqa: E501 + :rtype: bool + """ + return self._recalculate_parent + + @recalculate_parent.setter + def recalculate_parent(self, recalculate_parent): + """Sets the recalculate_parent of this InvoiceRecalculationRequest. + + + :param recalculate_parent: The recalculate_parent of this InvoiceRecalculationRequest. # noqa: E501 + :type: bool + """ + if recalculate_parent is None: + raise ValueError("Invalid value for `recalculate_parent`, must not be `None`") # noqa: E501 + + self._recalculate_parent = recalculate_parent + + @property + def apply_coupons(self): + """Gets the apply_coupons of this InvoiceRecalculationRequest. # noqa: E501 + + + :return: The apply_coupons of this InvoiceRecalculationRequest. # noqa: E501 + :rtype: bool """ - Gets the dry_run of this InvoiceRecalculationRequest. - {\"default\":\"false\",\"description\":\"Calculate the invoice but do not store or attempt payment\",\"verbs\":[\"POST\",\"GET\"]} + return self._apply_coupons - :return: The dry_run of this InvoiceRecalculationRequest. + @apply_coupons.setter + def apply_coupons(self, apply_coupons): + """Sets the apply_coupons of this InvoiceRecalculationRequest. + + + :param apply_coupons: The apply_coupons of this InvoiceRecalculationRequest. # noqa: E501 + :type: bool + """ + if apply_coupons is None: + raise ValueError("Invalid value for `apply_coupons`, must not be `None`") # noqa: E501 + + self._apply_coupons = apply_coupons + + @property + def dry_run(self): + """Gets the dry_run of this InvoiceRecalculationRequest. # noqa: E501 + + + :return: The dry_run of this InvoiceRecalculationRequest. # noqa: E501 :rtype: bool """ return self._dry_run @dry_run.setter def dry_run(self, dry_run): - """ - Sets the dry_run of this InvoiceRecalculationRequest. - {\"default\":\"false\",\"description\":\"Calculate the invoice but do not store or attempt payment\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the dry_run of this InvoiceRecalculationRequest. + - :param dry_run: The dry_run of this InvoiceRecalculationRequest. + :param dry_run: The dry_run of this InvoiceRecalculationRequest. # noqa: E501 :type: bool """ + if dry_run is None: + raise ValueError("Invalid value for `dry_run`, must not be `None`") # noqa: E501 self._dry_run = dry_run - def to_dict(self): + @property + def organization_id(self): + """Gets the organization_id of this InvoiceRecalculationRequest. # noqa: E501 + + + :return: The organization_id of this InvoiceRecalculationRequest. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this InvoiceRecalculationRequest. + + + :param organization_id: The organization_id of this InvoiceRecalculationRequest. # noqa: E501 + :type: str """ + + self._organization_id = organization_id + + @property + def invoice_id(self): + """Gets the invoice_id of this InvoiceRecalculationRequest. # noqa: E501 + + + :return: The invoice_id of this InvoiceRecalculationRequest. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this InvoiceRecalculationRequest. + + + :param invoice_id: The invoice_id of this InvoiceRecalculationRequest. # noqa: E501 + :type: str + """ + + self._invoice_id = invoice_id + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -212,29 +310,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(InvoiceRecalculationRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, InvoiceRecalculationRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/invoice_refund_request.py b/billforward/models/invoice_refund_request.py new file mode 100644 index 0000000..e166c4f --- /dev/null +++ b/billforward/models/invoice_refund_request.py @@ -0,0 +1,195 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InvoiceRefundRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'reason': 'str', + 'amount': 'float', + 'virtual_refund_gateway_types': 'list[str]' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'reason': 'reason', + 'amount': 'amount', + 'virtual_refund_gateway_types': 'virtualRefundGatewayTypes' + } + + def __init__(self, organization_id=None, reason=None, amount=None, virtual_refund_gateway_types=None): # noqa: E501 + """InvoiceRefundRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._reason = None + self._amount = None + self._virtual_refund_gateway_types = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if reason is not None: + self.reason = reason + if amount is not None: + self.amount = amount + if virtual_refund_gateway_types is not None: + self.virtual_refund_gateway_types = virtual_refund_gateway_types + + @property + def organization_id(self): + """Gets the organization_id of this InvoiceRefundRequest. # noqa: E501 + + + :return: The organization_id of this InvoiceRefundRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this InvoiceRefundRequest. + + + :param organization_id: The organization_id of this InvoiceRefundRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def reason(self): + """Gets the reason of this InvoiceRefundRequest. # noqa: E501 + + + :return: The reason of this InvoiceRefundRequest. # noqa: E501 + :rtype: str + """ + return self._reason + + @reason.setter + def reason(self, reason): + """Sets the reason of this InvoiceRefundRequest. + + + :param reason: The reason of this InvoiceRefundRequest. # noqa: E501 + :type: str + """ + + self._reason = reason + + @property + def amount(self): + """Gets the amount of this InvoiceRefundRequest. # noqa: E501 + + + :return: The amount of this InvoiceRefundRequest. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this InvoiceRefundRequest. + + + :param amount: The amount of this InvoiceRefundRequest. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def virtual_refund_gateway_types(self): + """Gets the virtual_refund_gateway_types of this InvoiceRefundRequest. # noqa: E501 + + + :return: The virtual_refund_gateway_types of this InvoiceRefundRequest. # noqa: E501 + :rtype: list[str] + """ + return self._virtual_refund_gateway_types + + @virtual_refund_gateway_types.setter + def virtual_refund_gateway_types(self, virtual_refund_gateway_types): + """Sets the virtual_refund_gateway_types of this InvoiceRefundRequest. + + + :param virtual_refund_gateway_types: The virtual_refund_gateway_types of this InvoiceRefundRequest. # noqa: E501 + :type: list[str] + """ + allowed_values = ["VOID", "cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "zooz", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "goCardless", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash", "epx", "shuttle", "square", "billforwardRandomizer", "cardConnect", "ebanx"] # noqa: E501 + if not set(virtual_refund_gateway_types).issubset(set(allowed_values)): + raise ValueError( + "Invalid values for `virtual_refund_gateway_types` [{0}], must be a subset of [{1}]" # noqa: E501 + .format(", ".join(map(str, set(virtual_refund_gateway_types) - set(allowed_values))), # noqa: E501 + ", ".join(map(str, allowed_values))) + ) + + self._virtual_refund_gateway_types = virtual_refund_gateway_types + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InvoiceRefundRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InvoiceRefundRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/invoice_refund_response.py b/billforward/models/invoice_refund_response.py new file mode 100644 index 0000000..949abf4 --- /dev/null +++ b/billforward/models/invoice_refund_response.py @@ -0,0 +1,266 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InvoiceRefundResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'invoice': 'Invoice', + 'refunds': 'list[Refund]', + 'organization_id': 'str', + 'requested_amount': 'float', + 'refunded_amount': 'float', + 'amount_left_to_refund': 'float' + } + + attribute_map = { + 'created': 'created', + 'invoice': 'invoice', + 'refunds': 'refunds', + 'organization_id': 'organizationID', + 'requested_amount': 'requestedAmount', + 'refunded_amount': 'refundedAmount', + 'amount_left_to_refund': 'amountLeftToRefund' + } + + def __init__(self, created=None, invoice=None, refunds=None, organization_id=None, requested_amount=None, refunded_amount=None, amount_left_to_refund=None): # noqa: E501 + """InvoiceRefundResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._invoice = None + self._refunds = None + self._organization_id = None + self._requested_amount = None + self._refunded_amount = None + self._amount_left_to_refund = None + self.discriminator = None + if created is not None: + self.created = created + if invoice is not None: + self.invoice = invoice + if refunds is not None: + self.refunds = refunds + if organization_id is not None: + self.organization_id = organization_id + if requested_amount is not None: + self.requested_amount = requested_amount + if refunded_amount is not None: + self.refunded_amount = refunded_amount + if amount_left_to_refund is not None: + self.amount_left_to_refund = amount_left_to_refund + + @property + def created(self): + """Gets the created of this InvoiceRefundResponse. # noqa: E501 + + + :return: The created of this InvoiceRefundResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this InvoiceRefundResponse. + + + :param created: The created of this InvoiceRefundResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def invoice(self): + """Gets the invoice of this InvoiceRefundResponse. # noqa: E501 + + + :return: The invoice of this InvoiceRefundResponse. # noqa: E501 + :rtype: Invoice + """ + return self._invoice + + @invoice.setter + def invoice(self, invoice): + """Sets the invoice of this InvoiceRefundResponse. + + + :param invoice: The invoice of this InvoiceRefundResponse. # noqa: E501 + :type: Invoice + """ + + self._invoice = invoice + + @property + def refunds(self): + """Gets the refunds of this InvoiceRefundResponse. # noqa: E501 + + + :return: The refunds of this InvoiceRefundResponse. # noqa: E501 + :rtype: list[Refund] + """ + return self._refunds + + @refunds.setter + def refunds(self, refunds): + """Sets the refunds of this InvoiceRefundResponse. + + + :param refunds: The refunds of this InvoiceRefundResponse. # noqa: E501 + :type: list[Refund] + """ + + self._refunds = refunds + + @property + def organization_id(self): + """Gets the organization_id of this InvoiceRefundResponse. # noqa: E501 + + + :return: The organization_id of this InvoiceRefundResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this InvoiceRefundResponse. + + + :param organization_id: The organization_id of this InvoiceRefundResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def requested_amount(self): + """Gets the requested_amount of this InvoiceRefundResponse. # noqa: E501 + + + :return: The requested_amount of this InvoiceRefundResponse. # noqa: E501 + :rtype: float + """ + return self._requested_amount + + @requested_amount.setter + def requested_amount(self, requested_amount): + """Sets the requested_amount of this InvoiceRefundResponse. + + + :param requested_amount: The requested_amount of this InvoiceRefundResponse. # noqa: E501 + :type: float + """ + + self._requested_amount = requested_amount + + @property + def refunded_amount(self): + """Gets the refunded_amount of this InvoiceRefundResponse. # noqa: E501 + + + :return: The refunded_amount of this InvoiceRefundResponse. # noqa: E501 + :rtype: float + """ + return self._refunded_amount + + @refunded_amount.setter + def refunded_amount(self, refunded_amount): + """Sets the refunded_amount of this InvoiceRefundResponse. + + + :param refunded_amount: The refunded_amount of this InvoiceRefundResponse. # noqa: E501 + :type: float + """ + + self._refunded_amount = refunded_amount + + @property + def amount_left_to_refund(self): + """Gets the amount_left_to_refund of this InvoiceRefundResponse. # noqa: E501 + + + :return: The amount_left_to_refund of this InvoiceRefundResponse. # noqa: E501 + :rtype: float + """ + return self._amount_left_to_refund + + @amount_left_to_refund.setter + def amount_left_to_refund(self, amount_left_to_refund): + """Sets the amount_left_to_refund of this InvoiceRefundResponse. + + + :param amount_left_to_refund: The amount_left_to_refund of this InvoiceRefundResponse. # noqa: E501 + :type: float + """ + + self._amount_left_to_refund = amount_left_to_refund + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InvoiceRefundResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InvoiceRefundResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/invoice_split.py b/billforward/models/invoice_split.py new file mode 100644 index 0000000..26a09f1 --- /dev/null +++ b/billforward/models/invoice_split.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InvoiceSplit(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'percentage': 'float', + 'value': 'float', + 'due_date': 'datetime', + 'description': 'str', + 'purchase_order': 'str' + } + + attribute_map = { + 'percentage': 'percentage', + 'value': 'value', + 'due_date': 'dueDate', + 'description': 'description', + 'purchase_order': 'purchaseOrder' + } + + def __init__(self, percentage=None, value=None, due_date=None, description=None, purchase_order=None): # noqa: E501 + """InvoiceSplit - a model defined in Swagger""" # noqa: E501 + self._percentage = None + self._value = None + self._due_date = None + self._description = None + self._purchase_order = None + self.discriminator = None + if percentage is not None: + self.percentage = percentage + if value is not None: + self.value = value + if due_date is not None: + self.due_date = due_date + if description is not None: + self.description = description + if purchase_order is not None: + self.purchase_order = purchase_order + + @property + def percentage(self): + """Gets the percentage of this InvoiceSplit. # noqa: E501 + + + :return: The percentage of this InvoiceSplit. # noqa: E501 + :rtype: float + """ + return self._percentage + + @percentage.setter + def percentage(self, percentage): + """Sets the percentage of this InvoiceSplit. + + + :param percentage: The percentage of this InvoiceSplit. # noqa: E501 + :type: float + """ + + self._percentage = percentage + + @property + def value(self): + """Gets the value of this InvoiceSplit. # noqa: E501 + + + :return: The value of this InvoiceSplit. # noqa: E501 + :rtype: float + """ + return self._value + + @value.setter + def value(self, value): + """Sets the value of this InvoiceSplit. + + + :param value: The value of this InvoiceSplit. # noqa: E501 + :type: float + """ + + self._value = value + + @property + def due_date(self): + """Gets the due_date of this InvoiceSplit. # noqa: E501 + + + :return: The due_date of this InvoiceSplit. # noqa: E501 + :rtype: datetime + """ + return self._due_date + + @due_date.setter + def due_date(self, due_date): + """Sets the due_date of this InvoiceSplit. + + + :param due_date: The due_date of this InvoiceSplit. # noqa: E501 + :type: datetime + """ + + self._due_date = due_date + + @property + def description(self): + """Gets the description of this InvoiceSplit. # noqa: E501 + + + :return: The description of this InvoiceSplit. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this InvoiceSplit. + + + :param description: The description of this InvoiceSplit. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def purchase_order(self): + """Gets the purchase_order of this InvoiceSplit. # noqa: E501 + + + :return: The purchase_order of this InvoiceSplit. # noqa: E501 + :rtype: str + """ + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this InvoiceSplit. + + + :param purchase_order: The purchase_order of this InvoiceSplit. # noqa: E501 + :type: str + """ + + self._purchase_order = purchase_order + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InvoiceSplit, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InvoiceSplit): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/invoice_split_service_request.py b/billforward/models/invoice_split_service_request.py new file mode 100644 index 0000000..1939c79 --- /dev/null +++ b/billforward/models/invoice_split_service_request.py @@ -0,0 +1,200 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InvoiceSplitServiceRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'requests': 'list[InvoiceSplit]', + 'organization_id': 'str', + 'invoice_state': 'str', + 'invoice_execution_time': 'str' + } + + attribute_map = { + 'requests': 'requests', + 'organization_id': 'organizationID', + 'invoice_state': 'invoiceState', + 'invoice_execution_time': 'invoiceExecutionTime' + } + + def __init__(self, requests=None, organization_id=None, invoice_state=None, invoice_execution_time=None): # noqa: E501 + """InvoiceSplitServiceRequest - a model defined in Swagger""" # noqa: E501 + self._requests = None + self._organization_id = None + self._invoice_state = None + self._invoice_execution_time = None + self.discriminator = None + if requests is not None: + self.requests = requests + if organization_id is not None: + self.organization_id = organization_id + if invoice_state is not None: + self.invoice_state = invoice_state + if invoice_execution_time is not None: + self.invoice_execution_time = invoice_execution_time + + @property + def requests(self): + """Gets the requests of this InvoiceSplitServiceRequest. # noqa: E501 + + + :return: The requests of this InvoiceSplitServiceRequest. # noqa: E501 + :rtype: list[InvoiceSplit] + """ + return self._requests + + @requests.setter + def requests(self, requests): + """Sets the requests of this InvoiceSplitServiceRequest. + + + :param requests: The requests of this InvoiceSplitServiceRequest. # noqa: E501 + :type: list[InvoiceSplit] + """ + + self._requests = requests + + @property + def organization_id(self): + """Gets the organization_id of this InvoiceSplitServiceRequest. # noqa: E501 + + + :return: The organization_id of this InvoiceSplitServiceRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this InvoiceSplitServiceRequest. + + + :param organization_id: The organization_id of this InvoiceSplitServiceRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def invoice_state(self): + """Gets the invoice_state of this InvoiceSplitServiceRequest. # noqa: E501 + + + :return: The invoice_state of this InvoiceSplitServiceRequest. # noqa: E501 + :rtype: str + """ + return self._invoice_state + + @invoice_state.setter + def invoice_state(self, invoice_state): + """Sets the invoice_state of this InvoiceSplitServiceRequest. + + + :param invoice_state: The invoice_state of this InvoiceSplitServiceRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Pending", "Unpaid"] # noqa: E501 + if invoice_state not in allowed_values: + raise ValueError( + "Invalid value for `invoice_state` ({0}), must be one of {1}" # noqa: E501 + .format(invoice_state, allowed_values) + ) + + self._invoice_state = invoice_state + + @property + def invoice_execution_time(self): + """Gets the invoice_execution_time of this InvoiceSplitServiceRequest. # noqa: E501 + + + :return: The invoice_execution_time of this InvoiceSplitServiceRequest. # noqa: E501 + :rtype: str + """ + return self._invoice_execution_time + + @invoice_execution_time.setter + def invoice_execution_time(self, invoice_execution_time): + """Sets the invoice_execution_time of this InvoiceSplitServiceRequest. + + + :param invoice_execution_time: The invoice_execution_time of this InvoiceSplitServiceRequest. # noqa: E501 + :type: str + """ + allowed_values = ["DueDate", "PeriodStart"] # noqa: E501 + if invoice_execution_time not in allowed_values: + raise ValueError( + "Invalid value for `invoice_execution_time` ({0}), must be one of {1}" # noqa: E501 + .format(invoice_execution_time, allowed_values) + ) + + self._invoice_execution_time = invoice_execution_time + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InvoiceSplitServiceRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InvoiceSplitServiceRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/invoice_template_config_response.py b/billforward/models/invoice_template_config_response.py new file mode 100644 index 0000000..afbb3e0 --- /dev/null +++ b/billforward/models/invoice_template_config_response.py @@ -0,0 +1,466 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class InvoiceTemplateConfigResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'representing_account_id': 'str', + 'tier_breakdown': 'bool', + 'inclusive_end': 'bool', + 'show_zero_cost': 'bool', + 'show_plan_only_when_ambiguous': 'bool', + 'include_footer': 'bool', + 'invoice_header_display': 'str', + 'group_invoice_line_items_by': 'str', + 'hide_tax_if_zero': 'bool', + 'show_unit_price': 'str', + 'company_address_on_top': 'bool', + 'upgrade_duration_wording': 'bool' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'representing_account_id': 'representingAccountID', + 'tier_breakdown': 'tierBreakdown', + 'inclusive_end': 'inclusiveEnd', + 'show_zero_cost': 'showZeroCost', + 'show_plan_only_when_ambiguous': 'showPlanOnlyWhenAmbiguous', + 'include_footer': 'includeFooter', + 'invoice_header_display': 'invoiceHeaderDisplay', + 'group_invoice_line_items_by': 'groupInvoiceLineItemsBy', + 'hide_tax_if_zero': 'hideTaxIfZero', + 'show_unit_price': 'showUnitPrice', + 'company_address_on_top': 'companyAddressOnTop', + 'upgrade_duration_wording': 'upgradeDurationWording' + } + + def __init__(self, created=None, organization_id=None, representing_account_id=None, tier_breakdown=None, inclusive_end=None, show_zero_cost=None, show_plan_only_when_ambiguous=None, include_footer=None, invoice_header_display=None, group_invoice_line_items_by=None, hide_tax_if_zero=None, show_unit_price=None, company_address_on_top=None, upgrade_duration_wording=None): # noqa: E501 + """InvoiceTemplateConfigResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._representing_account_id = None + self._tier_breakdown = None + self._inclusive_end = None + self._show_zero_cost = None + self._show_plan_only_when_ambiguous = None + self._include_footer = None + self._invoice_header_display = None + self._group_invoice_line_items_by = None + self._hide_tax_if_zero = None + self._show_unit_price = None + self._company_address_on_top = None + self._upgrade_duration_wording = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if representing_account_id is not None: + self.representing_account_id = representing_account_id + if tier_breakdown is not None: + self.tier_breakdown = tier_breakdown + if inclusive_end is not None: + self.inclusive_end = inclusive_end + if show_zero_cost is not None: + self.show_zero_cost = show_zero_cost + if show_plan_only_when_ambiguous is not None: + self.show_plan_only_when_ambiguous = show_plan_only_when_ambiguous + if include_footer is not None: + self.include_footer = include_footer + if invoice_header_display is not None: + self.invoice_header_display = invoice_header_display + if group_invoice_line_items_by is not None: + self.group_invoice_line_items_by = group_invoice_line_items_by + if hide_tax_if_zero is not None: + self.hide_tax_if_zero = hide_tax_if_zero + if show_unit_price is not None: + self.show_unit_price = show_unit_price + if company_address_on_top is not None: + self.company_address_on_top = company_address_on_top + if upgrade_duration_wording is not None: + self.upgrade_duration_wording = upgrade_duration_wording + + @property + def created(self): + """Gets the created of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The created of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this InvoiceTemplateConfigResponse. + + + :param created: The created of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The organization_id of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this InvoiceTemplateConfigResponse. + + + :param organization_id: The organization_id of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def representing_account_id(self): + """Gets the representing_account_id of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The representing_account_id of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: str + """ + return self._representing_account_id + + @representing_account_id.setter + def representing_account_id(self, representing_account_id): + """Sets the representing_account_id of this InvoiceTemplateConfigResponse. + + + :param representing_account_id: The representing_account_id of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: str + """ + + self._representing_account_id = representing_account_id + + @property + def tier_breakdown(self): + """Gets the tier_breakdown of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The tier_breakdown of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: bool + """ + return self._tier_breakdown + + @tier_breakdown.setter + def tier_breakdown(self, tier_breakdown): + """Sets the tier_breakdown of this InvoiceTemplateConfigResponse. + + + :param tier_breakdown: The tier_breakdown of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: bool + """ + + self._tier_breakdown = tier_breakdown + + @property + def inclusive_end(self): + """Gets the inclusive_end of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The inclusive_end of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: bool + """ + return self._inclusive_end + + @inclusive_end.setter + def inclusive_end(self, inclusive_end): + """Sets the inclusive_end of this InvoiceTemplateConfigResponse. + + + :param inclusive_end: The inclusive_end of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: bool + """ + + self._inclusive_end = inclusive_end + + @property + def show_zero_cost(self): + """Gets the show_zero_cost of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The show_zero_cost of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: bool + """ + return self._show_zero_cost + + @show_zero_cost.setter + def show_zero_cost(self, show_zero_cost): + """Sets the show_zero_cost of this InvoiceTemplateConfigResponse. + + + :param show_zero_cost: The show_zero_cost of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: bool + """ + + self._show_zero_cost = show_zero_cost + + @property + def show_plan_only_when_ambiguous(self): + """Gets the show_plan_only_when_ambiguous of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The show_plan_only_when_ambiguous of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: bool + """ + return self._show_plan_only_when_ambiguous + + @show_plan_only_when_ambiguous.setter + def show_plan_only_when_ambiguous(self, show_plan_only_when_ambiguous): + """Sets the show_plan_only_when_ambiguous of this InvoiceTemplateConfigResponse. + + + :param show_plan_only_when_ambiguous: The show_plan_only_when_ambiguous of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: bool + """ + + self._show_plan_only_when_ambiguous = show_plan_only_when_ambiguous + + @property + def include_footer(self): + """Gets the include_footer of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The include_footer of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: bool + """ + return self._include_footer + + @include_footer.setter + def include_footer(self, include_footer): + """Sets the include_footer of this InvoiceTemplateConfigResponse. + + + :param include_footer: The include_footer of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: bool + """ + + self._include_footer = include_footer + + @property + def invoice_header_display(self): + """Gets the invoice_header_display of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The invoice_header_display of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: str + """ + return self._invoice_header_display + + @invoice_header_display.setter + def invoice_header_display(self, invoice_header_display): + """Sets the invoice_header_display of this InvoiceTemplateConfigResponse. + + + :param invoice_header_display: The invoice_header_display of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: str + """ + allowed_values = ["ID_LEFT", "ID_RIGHT"] # noqa: E501 + if invoice_header_display not in allowed_values: + raise ValueError( + "Invalid value for `invoice_header_display` ({0}), must be one of {1}" # noqa: E501 + .format(invoice_header_display, allowed_values) + ) + + self._invoice_header_display = invoice_header_display + + @property + def group_invoice_line_items_by(self): + """Gets the group_invoice_line_items_by of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The group_invoice_line_items_by of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: str + """ + return self._group_invoice_line_items_by + + @group_invoice_line_items_by.setter + def group_invoice_line_items_by(self, group_invoice_line_items_by): + """Sets the group_invoice_line_items_by of this InvoiceTemplateConfigResponse. + + + :param group_invoice_line_items_by: The group_invoice_line_items_by of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Product", "RatePlan", "ProductAndRatePlan"] # noqa: E501 + if group_invoice_line_items_by not in allowed_values: + raise ValueError( + "Invalid value for `group_invoice_line_items_by` ({0}), must be one of {1}" # noqa: E501 + .format(group_invoice_line_items_by, allowed_values) + ) + + self._group_invoice_line_items_by = group_invoice_line_items_by + + @property + def hide_tax_if_zero(self): + """Gets the hide_tax_if_zero of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The hide_tax_if_zero of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: bool + """ + return self._hide_tax_if_zero + + @hide_tax_if_zero.setter + def hide_tax_if_zero(self, hide_tax_if_zero): + """Sets the hide_tax_if_zero of this InvoiceTemplateConfigResponse. + + + :param hide_tax_if_zero: The hide_tax_if_zero of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: bool + """ + + self._hide_tax_if_zero = hide_tax_if_zero + + @property + def show_unit_price(self): + """Gets the show_unit_price of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The show_unit_price of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: str + """ + return self._show_unit_price + + @show_unit_price.setter + def show_unit_price(self, show_unit_price): + """Sets the show_unit_price of this InvoiceTemplateConfigResponse. + + + :param show_unit_price: The show_unit_price of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Hidden", "Column", "Inline"] # noqa: E501 + if show_unit_price not in allowed_values: + raise ValueError( + "Invalid value for `show_unit_price` ({0}), must be one of {1}" # noqa: E501 + .format(show_unit_price, allowed_values) + ) + + self._show_unit_price = show_unit_price + + @property + def company_address_on_top(self): + """Gets the company_address_on_top of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The company_address_on_top of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: bool + """ + return self._company_address_on_top + + @company_address_on_top.setter + def company_address_on_top(self, company_address_on_top): + """Sets the company_address_on_top of this InvoiceTemplateConfigResponse. + + + :param company_address_on_top: The company_address_on_top of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: bool + """ + + self._company_address_on_top = company_address_on_top + + @property + def upgrade_duration_wording(self): + """Gets the upgrade_duration_wording of this InvoiceTemplateConfigResponse. # noqa: E501 + + + :return: The upgrade_duration_wording of this InvoiceTemplateConfigResponse. # noqa: E501 + :rtype: bool + """ + return self._upgrade_duration_wording + + @upgrade_duration_wording.setter + def upgrade_duration_wording(self, upgrade_duration_wording): + """Sets the upgrade_duration_wording of this InvoiceTemplateConfigResponse. + + + :param upgrade_duration_wording: The upgrade_duration_wording of this InvoiceTemplateConfigResponse. # noqa: E501 + :type: bool + """ + + self._upgrade_duration_wording = upgrade_duration_wording + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(InvoiceTemplateConfigResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, InvoiceTemplateConfigResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/issue_invoice_amendment.py b/billforward/models/issue_invoice_amendment.py index fa6aee5..57d8291 100644 --- a/billforward/models/issue_invoice_amendment.py +++ b/billforward/models/issue_invoice_amendment.py @@ -1,415 +1,80 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class IssueInvoiceAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class IssueInvoiceAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False, invoice_id=None): - """ - IssueInvoiceAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool', - 'invoice_id': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted', - 'invoice_id': 'invoiceID' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - self._invoice_id = invoice_id - - @property - def created(self): - """ - Gets the created of this IssueInvoiceAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this IssueInvoiceAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this IssueInvoiceAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this IssueInvoiceAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this IssueInvoiceAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this IssueInvoiceAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this IssueInvoiceAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this IssueInvoiceAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this IssueInvoiceAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this IssueInvoiceAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this IssueInvoiceAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this IssueInvoiceAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this IssueInvoiceAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this IssueInvoiceAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this IssueInvoiceAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this IssueInvoiceAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def id(self): - """ - Gets the id of this IssueInvoiceAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this IssueInvoiceAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this IssueInvoiceAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this IssueInvoiceAmendment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this IssueInvoiceAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this IssueInvoiceAmendment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this IssueInvoiceAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this IssueInvoiceAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this IssueInvoiceAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this IssueInvoiceAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this IssueInvoiceAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this IssueInvoiceAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this IssueInvoiceAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this IssueInvoiceAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this IssueInvoiceAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this IssueInvoiceAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this IssueInvoiceAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this IssueInvoiceAmendment. - :rtype: datetime - """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this IssueInvoiceAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actioning_time: The actioning_time of this IssueInvoiceAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this IssueInvoiceAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this IssueInvoiceAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this IssueInvoiceAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :param actioned_time: The actioned_time of this IssueInvoiceAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this IssueInvoiceAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this IssueInvoiceAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this IssueInvoiceAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this IssueInvoiceAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this IssueInvoiceAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this IssueInvoiceAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this IssueInvoiceAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this IssueInvoiceAmendment. - :type: bool - """ - - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'invoice_id': 'str' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'invoice_id': 'invoiceID' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, invoice_id=None, *args, **kwargs): # noqa: E501 + """IssueInvoiceAmendment - a model defined in Swagger""" # noqa: E501 + self._invoice_id = None + self.discriminator = None + self.invoice_id = invoice_id + Amendment.__init__(self, *args, **kwargs) @property def invoice_id(self): - """ - Gets the invoice_id of this IssueInvoiceAmendment. - { \"description\" : \"Identifier of invoice to issue\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the invoice_id of this IssueInvoiceAmendment. # noqa: E501 + - :return: The invoice_id of this IssueInvoiceAmendment. + :return: The invoice_id of this IssueInvoiceAmendment. # noqa: E501 :rtype: str """ return self._invoice_id @invoice_id.setter def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this IssueInvoiceAmendment. - { \"description\" : \"Identifier of invoice to issue\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the invoice_id of this IssueInvoiceAmendment. - :param invoice_id: The invoice_id of this IssueInvoiceAmendment. + + :param invoice_id: The invoice_id of this IssueInvoiceAmendment. # noqa: E501 :type: str """ + if invoice_id is None: + raise ValueError("Invalid value for `invoice_id`, must not be `None`") # noqa: E501 self._invoice_id = invoice_id def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -426,29 +91,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(IssueInvoiceAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, IssueInvoiceAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/issue_invoice_request.py b/billforward/models/issue_invoice_request.py new file mode 100644 index 0000000..03dfdef --- /dev/null +++ b/billforward/models/issue_invoice_request.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class IssueInvoiceRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'payment_amount': 'float' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'payment_amount': 'paymentAmount' + } + + def __init__(self, organization_id=None, payment_amount=None): # noqa: E501 + """IssueInvoiceRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._payment_amount = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if payment_amount is not None: + self.payment_amount = payment_amount + + @property + def organization_id(self): + """Gets the organization_id of this IssueInvoiceRequest. # noqa: E501 + + + :return: The organization_id of this IssueInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this IssueInvoiceRequest. + + + :param organization_id: The organization_id of this IssueInvoiceRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def payment_amount(self): + """Gets the payment_amount of this IssueInvoiceRequest. # noqa: E501 + + + :return: The payment_amount of this IssueInvoiceRequest. # noqa: E501 + :rtype: float + """ + return self._payment_amount + + @payment_amount.setter + def payment_amount(self, payment_amount): + """Sets the payment_amount of this IssueInvoiceRequest. + + + :param payment_amount: The payment_amount of this IssueInvoiceRequest. # noqa: E501 + :type: float + """ + + self._payment_amount = payment_amount + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(IssueInvoiceRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, IssueInvoiceRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/issue_invoice_response.py b/billforward/models/issue_invoice_response.py new file mode 100644 index 0000000..78ac1b0 --- /dev/null +++ b/billforward/models/issue_invoice_response.py @@ -0,0 +1,272 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class IssueInvoiceResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'issued': 'bool', + 'voided': 'bool', + 'reason': 'str', + 'invoice': 'Invoice', + 'reason_explanation': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'issued': 'issued', + 'voided': 'voided', + 'reason': 'reason', + 'invoice': 'invoice', + 'reason_explanation': 'reasonExplanation' + } + + def __init__(self, created=None, organization_id=None, issued=None, voided=None, reason=None, invoice=None, reason_explanation=None): # noqa: E501 + """IssueInvoiceResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._issued = None + self._voided = None + self._reason = None + self._invoice = None + self._reason_explanation = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if issued is not None: + self.issued = issued + if voided is not None: + self.voided = voided + if reason is not None: + self.reason = reason + if invoice is not None: + self.invoice = invoice + if reason_explanation is not None: + self.reason_explanation = reason_explanation + + @property + def created(self): + """Gets the created of this IssueInvoiceResponse. # noqa: E501 + + + :return: The created of this IssueInvoiceResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this IssueInvoiceResponse. + + + :param created: The created of this IssueInvoiceResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this IssueInvoiceResponse. # noqa: E501 + + + :return: The organization_id of this IssueInvoiceResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this IssueInvoiceResponse. + + + :param organization_id: The organization_id of this IssueInvoiceResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def issued(self): + """Gets the issued of this IssueInvoiceResponse. # noqa: E501 + + + :return: The issued of this IssueInvoiceResponse. # noqa: E501 + :rtype: bool + """ + return self._issued + + @issued.setter + def issued(self, issued): + """Sets the issued of this IssueInvoiceResponse. + + + :param issued: The issued of this IssueInvoiceResponse. # noqa: E501 + :type: bool + """ + + self._issued = issued + + @property + def voided(self): + """Gets the voided of this IssueInvoiceResponse. # noqa: E501 + + + :return: The voided of this IssueInvoiceResponse. # noqa: E501 + :rtype: bool + """ + return self._voided + + @voided.setter + def voided(self, voided): + """Sets the voided of this IssueInvoiceResponse. + + + :param voided: The voided of this IssueInvoiceResponse. # noqa: E501 + :type: bool + """ + + self._voided = voided + + @property + def reason(self): + """Gets the reason of this IssueInvoiceResponse. # noqa: E501 + + + :return: The reason of this IssueInvoiceResponse. # noqa: E501 + :rtype: str + """ + return self._reason + + @reason.setter + def reason(self, reason): + """Sets the reason of this IssueInvoiceResponse. + + + :param reason: The reason of this IssueInvoiceResponse. # noqa: E501 + :type: str + """ + allowed_values = ["CostThreshold", "WasNotPending"] # noqa: E501 + if reason not in allowed_values: + raise ValueError( + "Invalid value for `reason` ({0}), must be one of {1}" # noqa: E501 + .format(reason, allowed_values) + ) + + self._reason = reason + + @property + def invoice(self): + """Gets the invoice of this IssueInvoiceResponse. # noqa: E501 + + + :return: The invoice of this IssueInvoiceResponse. # noqa: E501 + :rtype: Invoice + """ + return self._invoice + + @invoice.setter + def invoice(self, invoice): + """Sets the invoice of this IssueInvoiceResponse. + + + :param invoice: The invoice of this IssueInvoiceResponse. # noqa: E501 + :type: Invoice + """ + + self._invoice = invoice + + @property + def reason_explanation(self): + """Gets the reason_explanation of this IssueInvoiceResponse. # noqa: E501 + + + :return: The reason_explanation of this IssueInvoiceResponse. # noqa: E501 + :rtype: str + """ + return self._reason_explanation + + @reason_explanation.setter + def reason_explanation(self, reason_explanation): + """Sets the reason_explanation of this IssueInvoiceResponse. + + + :param reason_explanation: The reason_explanation of this IssueInvoiceResponse. # noqa: E501 + :type: str + """ + + self._reason_explanation = reason_explanation + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(IssueInvoiceResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, IssueInvoiceResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/kash_configuration.py b/billforward/models/kash_configuration.py new file mode 100644 index 0000000..8e17918 --- /dev/null +++ b/billforward/models/kash_configuration.py @@ -0,0 +1,142 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class KashConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'key_filename': 'str', + 'secret_key': 'str' + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + 'key_filename': 'keyFilename', + 'secret_key': 'secretKey' + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, key_filename=None, secret_key=None, *args, **kwargs): # noqa: E501 + """KashConfiguration - a model defined in Swagger""" # noqa: E501 + self._key_filename = None + self._secret_key = None + self.discriminator = None + if key_filename is not None: + self.key_filename = key_filename + if secret_key is not None: + self.secret_key = secret_key + APIConfiguration.__init__(self, *args, **kwargs) + + @property + def key_filename(self): + """Gets the key_filename of this KashConfiguration. # noqa: E501 + + + :return: The key_filename of this KashConfiguration. # noqa: E501 + :rtype: str + """ + return self._key_filename + + @key_filename.setter + def key_filename(self, key_filename): + """Sets the key_filename of this KashConfiguration. + + + :param key_filename: The key_filename of this KashConfiguration. # noqa: E501 + :type: str + """ + + self._key_filename = key_filename + + @property + def secret_key(self): + """Gets the secret_key of this KashConfiguration. # noqa: E501 + + + :return: The secret_key of this KashConfiguration. # noqa: E501 + :rtype: str + """ + return self._secret_key + + @secret_key.setter + def secret_key(self, secret_key): + """Sets the secret_key of this KashConfiguration. + + + :param secret_key: The secret_key of this KashConfiguration. # noqa: E501 + :type: str + """ + + self._secret_key = secret_key + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(KashConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, KashConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/legacy_create_webhook_request.py b/billforward/models/legacy_create_webhook_request.py new file mode 100644 index 0000000..c2a4656 --- /dev/null +++ b/billforward/models/legacy_create_webhook_request.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class LegacyCreateWebhookRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'url': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'url': 'url', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, url=None, organization_id=None): # noqa: E501 + """LegacyCreateWebhookRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._url = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if url is not None: + self.url = url + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this LegacyCreateWebhookRequest. # noqa: E501 + + + :return: The created of this LegacyCreateWebhookRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this LegacyCreateWebhookRequest. + + + :param created: The created of this LegacyCreateWebhookRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def url(self): + """Gets the url of this LegacyCreateWebhookRequest. # noqa: E501 + + + :return: The url of this LegacyCreateWebhookRequest. # noqa: E501 + :rtype: str + """ + return self._url + + @url.setter + def url(self, url): + """Sets the url of this LegacyCreateWebhookRequest. + + + :param url: The url of this LegacyCreateWebhookRequest. # noqa: E501 + :type: str + """ + + self._url = url + + @property + def organization_id(self): + """Gets the organization_id of this LegacyCreateWebhookRequest. # noqa: E501 + + + :return: The organization_id of this LegacyCreateWebhookRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this LegacyCreateWebhookRequest. + + + :param organization_id: The organization_id of this LegacyCreateWebhookRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(LegacyCreateWebhookRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, LegacyCreateWebhookRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/manual_charge.py b/billforward/models/manual_charge.py new file mode 100644 index 0000000..0ff0cee --- /dev/null +++ b/billforward/models/manual_charge.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.subscription_charge import SubscriptionCharge # noqa: F401,E501 + +class ManualCharge(SubscriptionCharge): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'quantity': 'int' + } + if hasattr(SubscriptionCharge, "swagger_types"): + swagger_types.update(SubscriptionCharge.swagger_types) + + attribute_map = { + 'quantity': 'quantity' + } + if hasattr(SubscriptionCharge, "attribute_map"): + attribute_map.update(SubscriptionCharge.attribute_map) + + def __init__(self, quantity=None, *args, **kwargs): # noqa: E501 + """ManualCharge - a model defined in Swagger""" # noqa: E501 + self._quantity = None + self.discriminator = None + self.quantity = quantity + SubscriptionCharge.__init__(self, *args, **kwargs) + + @property + def quantity(self): + """Gets the quantity of this ManualCharge. # noqa: E501 + + + :return: The quantity of this ManualCharge. # noqa: E501 + :rtype: int + """ + return self._quantity + + @quantity.setter + def quantity(self, quantity): + """Sets the quantity of this ManualCharge. + + + :param quantity: The quantity of this ManualCharge. # noqa: E501 + :type: int + """ + if quantity is None: + raise ValueError("Invalid value for `quantity`, must not be `None`") # noqa: E501 + + self._quantity = quantity + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ManualCharge, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ManualCharge): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/marketplace_quote.py b/billforward/models/marketplace_quote.py new file mode 100644 index 0000000..2bbdd71 --- /dev/null +++ b/billforward/models/marketplace_quote.py @@ -0,0 +1,292 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class MarketplaceQuote(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'account_id': 'str', + 'invoice_id': 'str', + 'subscription_id': 'str', + 'calculator_results': 'list[CalculatorResult]', + 'currency': 'CreditNoteCurrency', + 'total': 'float' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'invoice_id': 'invoiceID', + 'subscription_id': 'subscriptionID', + 'calculator_results': 'calculatorResults', + 'currency': 'currency', + 'total': 'total' + } + + def __init__(self, created=None, organization_id=None, account_id=None, invoice_id=None, subscription_id=None, calculator_results=None, currency=None, total=None): # noqa: E501 + """MarketplaceQuote - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._account_id = None + self._invoice_id = None + self._subscription_id = None + self._calculator_results = None + self._currency = None + self._total = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if invoice_id is not None: + self.invoice_id = invoice_id + if subscription_id is not None: + self.subscription_id = subscription_id + if calculator_results is not None: + self.calculator_results = calculator_results + if currency is not None: + self.currency = currency + if total is not None: + self.total = total + + @property + def created(self): + """Gets the created of this MarketplaceQuote. # noqa: E501 + + + :return: The created of this MarketplaceQuote. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this MarketplaceQuote. + + + :param created: The created of this MarketplaceQuote. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this MarketplaceQuote. # noqa: E501 + + + :return: The organization_id of this MarketplaceQuote. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this MarketplaceQuote. + + + :param organization_id: The organization_id of this MarketplaceQuote. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_id(self): + """Gets the account_id of this MarketplaceQuote. # noqa: E501 + + + :return: The account_id of this MarketplaceQuote. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this MarketplaceQuote. + + + :param account_id: The account_id of this MarketplaceQuote. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def invoice_id(self): + """Gets the invoice_id of this MarketplaceQuote. # noqa: E501 + + + :return: The invoice_id of this MarketplaceQuote. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this MarketplaceQuote. + + + :param invoice_id: The invoice_id of this MarketplaceQuote. # noqa: E501 + :type: str + """ + + self._invoice_id = invoice_id + + @property + def subscription_id(self): + """Gets the subscription_id of this MarketplaceQuote. # noqa: E501 + + + :return: The subscription_id of this MarketplaceQuote. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this MarketplaceQuote. + + + :param subscription_id: The subscription_id of this MarketplaceQuote. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def calculator_results(self): + """Gets the calculator_results of this MarketplaceQuote. # noqa: E501 + + + :return: The calculator_results of this MarketplaceQuote. # noqa: E501 + :rtype: list[CalculatorResult] + """ + return self._calculator_results + + @calculator_results.setter + def calculator_results(self, calculator_results): + """Sets the calculator_results of this MarketplaceQuote. + + + :param calculator_results: The calculator_results of this MarketplaceQuote. # noqa: E501 + :type: list[CalculatorResult] + """ + + self._calculator_results = calculator_results + + @property + def currency(self): + """Gets the currency of this MarketplaceQuote. # noqa: E501 + + + :return: The currency of this MarketplaceQuote. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this MarketplaceQuote. + + + :param currency: The currency of this MarketplaceQuote. # noqa: E501 + :type: CreditNoteCurrency + """ + + self._currency = currency + + @property + def total(self): + """Gets the total of this MarketplaceQuote. # noqa: E501 + + + :return: The total of this MarketplaceQuote. # noqa: E501 + :rtype: float + """ + return self._total + + @total.setter + def total(self, total): + """Sets the total of this MarketplaceQuote. + + + :param total: The total of this MarketplaceQuote. # noqa: E501 + :type: float + """ + + self._total = total + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(MarketplaceQuote, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, MarketplaceQuote): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/metadata.py b/billforward/models/metadata.py new file mode 100644 index 0000000..24e3a25 --- /dev/null +++ b/billforward/models/metadata.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class Metadata(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'execution_time': 'int', + 'results': 'list[Webhook]' + } + + attribute_map = { + 'execution_time': 'executionTime', + 'results': 'results' + } + + def __init__(self, execution_time=None, results=None): # noqa: E501 + """Metadata - a model defined in Swagger""" # noqa: E501 + self._execution_time = None + self._results = None + self.discriminator = None + self.execution_time = execution_time + self.results = results + + @property + def execution_time(self): + """Gets the execution_time of this Metadata. # noqa: E501 + + + :return: The execution_time of this Metadata. # noqa: E501 + :rtype: int + """ + return self._execution_time + + @execution_time.setter + def execution_time(self, execution_time): + """Sets the execution_time of this Metadata. + + + :param execution_time: The execution_time of this Metadata. # noqa: E501 + :type: int + """ + if execution_time is None: + raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 + + self._execution_time = execution_time + + @property + def results(self): + """Gets the results of this Metadata. # noqa: E501 + + + :return: The results of this Metadata. # noqa: E501 + :rtype: list[Webhook] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this Metadata. + + + :param results: The results of this Metadata. # noqa: E501 + :type: list[Webhook] + """ + if results is None: + raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 + + self._results = results + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(Metadata, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, Metadata): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/metadata_key_values.py b/billforward/models/metadata_key_values.py new file mode 100644 index 0000000..ff3e51d --- /dev/null +++ b/billforward/models/metadata_key_values.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class MetadataKeyValues(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, organization_id=None): # noqa: E501 + """MetadataKeyValues - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this MetadataKeyValues. # noqa: E501 + + + :return: The created of this MetadataKeyValues. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this MetadataKeyValues. + + + :param created: The created of this MetadataKeyValues. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this MetadataKeyValues. # noqa: E501 + + + :return: The organization_id of this MetadataKeyValues. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this MetadataKeyValues. + + + :param organization_id: The organization_id of this MetadataKeyValues. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(MetadataKeyValues, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, MetadataKeyValues): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/metadata_key_values_paged_metadata.py b/billforward/models/metadata_key_values_paged_metadata.py deleted file mode 100644 index 69b4f9c..0000000 --- a/billforward/models/metadata_key_values_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class MetadataKeyValuesPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - MetadataKeyValuesPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this MetadataKeyValuesPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this MetadataKeyValuesPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this MetadataKeyValuesPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this MetadataKeyValuesPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this MetadataKeyValuesPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this MetadataKeyValuesPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this MetadataKeyValuesPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this MetadataKeyValuesPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this MetadataKeyValuesPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this MetadataKeyValuesPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this MetadataKeyValuesPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this MetadataKeyValuesPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this MetadataKeyValuesPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this MetadataKeyValuesPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this MetadataKeyValuesPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this MetadataKeyValuesPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this MetadataKeyValuesPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this MetadataKeyValuesPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this MetadataKeyValuesPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this MetadataKeyValuesPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this MetadataKeyValuesPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this MetadataKeyValuesPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this MetadataKeyValuesPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this MetadataKeyValuesPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this MetadataKeyValuesPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this MetadataKeyValuesPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this MetadataKeyValuesPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this MetadataKeyValuesPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/migration.py b/billforward/models/migration.py new file mode 100644 index 0000000..3923bd2 --- /dev/null +++ b/billforward/models/migration.py @@ -0,0 +1,299 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class Migration(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'configuration_id': 'str', + 'organization_id': 'str', + 'migration_state': 'str', + 'migrated': 'datetime' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'configuration_id': 'configurationID', + 'organization_id': 'organizationID', + 'migration_state': 'migrationState', + 'migrated': 'migrated' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, configuration_id=None, organization_id=None, migration_state=None, migrated=None): # noqa: E501 + """Migration - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._configuration_id = None + self._organization_id = None + self._migration_state = None + self._migrated = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if configuration_id is not None: + self.configuration_id = configuration_id + if organization_id is not None: + self.organization_id = organization_id + self.migration_state = migration_state + if migrated is not None: + self.migrated = migrated + + @property + def created(self): + """Gets the created of this Migration. # noqa: E501 + + + :return: The created of this Migration. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this Migration. + + + :param created: The created of this Migration. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this Migration. # noqa: E501 + + + :return: The changed_by of this Migration. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this Migration. + + + :param changed_by: The changed_by of this Migration. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this Migration. # noqa: E501 + + + :return: The updated of this Migration. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this Migration. + + + :param updated: The updated of this Migration. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this Migration. # noqa: E501 + + + :return: The id of this Migration. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this Migration. + + + :param id: The id of this Migration. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def configuration_id(self): + """Gets the configuration_id of this Migration. # noqa: E501 + + + :return: The configuration_id of this Migration. # noqa: E501 + :rtype: str + """ + return self._configuration_id + + @configuration_id.setter + def configuration_id(self, configuration_id): + """Sets the configuration_id of this Migration. + + + :param configuration_id: The configuration_id of this Migration. # noqa: E501 + :type: str + """ + + self._configuration_id = configuration_id + + @property + def organization_id(self): + """Gets the organization_id of this Migration. # noqa: E501 + + + :return: The organization_id of this Migration. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this Migration. + + + :param organization_id: The organization_id of this Migration. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def migration_state(self): + """Gets the migration_state of this Migration. # noqa: E501 + + + :return: The migration_state of this Migration. # noqa: E501 + :rtype: str + """ + return self._migration_state + + @migration_state.setter + def migration_state(self, migration_state): + """Sets the migration_state of this Migration. + + + :param migration_state: The migration_state of this Migration. # noqa: E501 + :type: str + """ + if migration_state is None: + raise ValueError("Invalid value for `migration_state`, must not be `None`") # noqa: E501 + allowed_values = ["Pending", "Complete"] # noqa: E501 + if migration_state not in allowed_values: + raise ValueError( + "Invalid value for `migration_state` ({0}), must be one of {1}" # noqa: E501 + .format(migration_state, allowed_values) + ) + + self._migration_state = migration_state + + @property + def migrated(self): + """Gets the migrated of this Migration. # noqa: E501 + + + :return: The migrated of this Migration. # noqa: E501 + :rtype: datetime + """ + return self._migrated + + @migrated.setter + def migrated(self, migrated): + """Sets the migrated of this Migration. + + + :param migrated: The migrated of this Migration. # noqa: E501 + :type: datetime + """ + + self._migrated = migrated + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(Migration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, Migration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/migration_request.py b/billforward/models/migration_request.py index 7e88e08..f95484a 100644 --- a/billforward/models/migration_request.py +++ b/billforward/models/migration_request.py @@ -1,120 +1,184 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class MigrationRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, next_subscription_name=None, next_subscription_description=None, product=None, product_rate_plan=None, invoicing_type=None, mappings=None, pricing_behaviour=None, dry_run=False): - """ - MigrationRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'next_subscription_name': 'str', - 'next_subscription_description': 'str', - 'product': 'str', - 'product_rate_plan': 'str', - 'invoicing_type': 'str', - 'mappings': 'list[PricingComponentMigrationValue]', - 'pricing_behaviour': 'str', - 'dry_run': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'next_subscription_name': 'nextSubscriptionName', - 'next_subscription_description': 'nextSubscriptionDescription', - 'product': 'product', - 'product_rate_plan': 'productRatePlan', - 'invoicing_type': 'invoicingType', - 'mappings': 'mappings', - 'pricing_behaviour': 'pricingBehaviour', - 'dry_run': 'dryRun' - } - - self._created = created - self._next_subscription_name = next_subscription_name - self._next_subscription_description = next_subscription_description - self._product = product - self._product_rate_plan = product_rate_plan - self._invoicing_type = invoicing_type - self._mappings = mappings - self._pricing_behaviour = pricing_behaviour - self._dry_run = dry_run + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'subscription_id': 'str', + 'next_subscription_name': 'str', + 'next_subscription_description': 'str', + 'product': 'str', + 'product_rate_plan': 'str', + 'invoicing_type': 'str', + 'mappings': 'list[PricingComponentMigrationValue]', + 'pricing_behaviour': 'str', + 'void_existing_coupons': 'bool', + 'force_trial_end': 'bool', + 'dry_run': 'bool' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'subscription_id': 'subscriptionID', + 'next_subscription_name': 'nextSubscriptionName', + 'next_subscription_description': 'nextSubscriptionDescription', + 'product': 'product', + 'product_rate_plan': 'productRatePlan', + 'invoicing_type': 'invoicingType', + 'mappings': 'mappings', + 'pricing_behaviour': 'pricingBehaviour', + 'void_existing_coupons': 'voidExistingCoupons', + 'force_trial_end': 'forceTrialEnd', + 'dry_run': 'dryRun' + } + + def __init__(self, created=None, organization_id=None, subscription_id=None, next_subscription_name=None, next_subscription_description=None, product=None, product_rate_plan=None, invoicing_type=None, mappings=None, pricing_behaviour=None, void_existing_coupons=None, force_trial_end=None, dry_run=None): # noqa: E501 + """MigrationRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._subscription_id = None + self._next_subscription_name = None + self._next_subscription_description = None + self._product = None + self._product_rate_plan = None + self._invoicing_type = None + self._mappings = None + self._pricing_behaviour = None + self._void_existing_coupons = None + self._force_trial_end = None + self._dry_run = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if subscription_id is not None: + self.subscription_id = subscription_id + if next_subscription_name is not None: + self.next_subscription_name = next_subscription_name + if next_subscription_description is not None: + self.next_subscription_description = next_subscription_description + if product is not None: + self.product = product + if product_rate_plan is not None: + self.product_rate_plan = product_rate_plan + self.invoicing_type = invoicing_type + if mappings is not None: + self.mappings = mappings + self.pricing_behaviour = pricing_behaviour + if void_existing_coupons is not None: + self.void_existing_coupons = void_existing_coupons + if force_trial_end is not None: + self.force_trial_end = force_trial_end + if dry_run is not None: + self.dry_run = dry_run @property def created(self): - """ - Gets the created of this MigrationRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this MigrationRequest. # noqa: E501 + - :return: The created of this MigrationRequest. + :return: The created of this MigrationRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this MigrationRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this MigrationRequest. + - :param created: The created of this MigrationRequest. + :param created: The created of this MigrationRequest. # noqa: E501 :type: datetime """ self._created = created @property - def next_subscription_name(self): + def organization_id(self): + """Gets the organization_id of this MigrationRequest. # noqa: E501 + + + :return: The organization_id of this MigrationRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this MigrationRequest. + + + :param organization_id: The organization_id of this MigrationRequest. # noqa: E501 + :type: str """ - Gets the next_subscription_name of this MigrationRequest. - {\"description\":\"Name to which the subscription will change upon successful migration.\",\"verbs\":[\"POST\",\"GET\"]} - :return: The next_subscription_name of this MigrationRequest. + self._organization_id = organization_id + + @property + def subscription_id(self): + """Gets the subscription_id of this MigrationRequest. # noqa: E501 + + + :return: The subscription_id of this MigrationRequest. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this MigrationRequest. + + + :param subscription_id: The subscription_id of this MigrationRequest. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def next_subscription_name(self): + """Gets the next_subscription_name of this MigrationRequest. # noqa: E501 + + + :return: The next_subscription_name of this MigrationRequest. # noqa: E501 :rtype: str """ return self._next_subscription_name @next_subscription_name.setter def next_subscription_name(self, next_subscription_name): - """ - Sets the next_subscription_name of this MigrationRequest. - {\"description\":\"Name to which the subscription will change upon successful migration.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the next_subscription_name of this MigrationRequest. - :param next_subscription_name: The next_subscription_name of this MigrationRequest. + + :param next_subscription_name: The next_subscription_name of this MigrationRequest. # noqa: E501 :type: str """ @@ -122,22 +186,20 @@ def next_subscription_name(self, next_subscription_name): @property def next_subscription_description(self): - """ - Gets the next_subscription_description of this MigrationRequest. - {\"description\":\"Description to which the subscription will change upon successful migration.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the next_subscription_description of this MigrationRequest. # noqa: E501 - :return: The next_subscription_description of this MigrationRequest. + + :return: The next_subscription_description of this MigrationRequest. # noqa: E501 :rtype: str """ return self._next_subscription_description @next_subscription_description.setter def next_subscription_description(self, next_subscription_description): - """ - Sets the next_subscription_description of this MigrationRequest. - {\"description\":\"Description to which the subscription will change upon successful migration.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the next_subscription_description of this MigrationRequest. - :param next_subscription_description: The next_subscription_description of this MigrationRequest. + + :param next_subscription_description: The next_subscription_description of this MigrationRequest. # noqa: E501 :type: str """ @@ -145,22 +207,20 @@ def next_subscription_description(self, next_subscription_description): @property def product(self): - """ - Gets the product of this MigrationRequest. - {\"description\":\"The product to which the subscription will be migrated.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the product of this MigrationRequest. # noqa: E501 + - :return: The product of this MigrationRequest. + :return: The product of this MigrationRequest. # noqa: E501 :rtype: str """ return self._product @product.setter def product(self, product): - """ - Sets the product of this MigrationRequest. - {\"description\":\"The product to which the subscription will be migrated.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the product of this MigrationRequest. + - :param product: The product of this MigrationRequest. + :param product: The product of this MigrationRequest. # noqa: E501 :type: str """ @@ -168,22 +228,20 @@ def product(self, product): @property def product_rate_plan(self): - """ - Gets the product_rate_plan of this MigrationRequest. - {\"description\":\"The rate plan (of some product) to which the subscription will be migrated.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the product_rate_plan of this MigrationRequest. # noqa: E501 + - :return: The product_rate_plan of this MigrationRequest. + :return: The product_rate_plan of this MigrationRequest. # noqa: E501 :rtype: str """ return self._product_rate_plan @product_rate_plan.setter def product_rate_plan(self, product_rate_plan): - """ - Sets the product_rate_plan of this MigrationRequest. - {\"description\":\"The rate plan (of some product) to which the subscription will be migrated.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the product_rate_plan of this MigrationRequest. + - :param product_rate_plan: The product_rate_plan of this MigrationRequest. + :param product_rate_plan: The product_rate_plan of this MigrationRequest. # noqa: E501 :type: str """ @@ -191,28 +249,28 @@ def product_rate_plan(self, product_rate_plan): @property def invoicing_type(self): - """ - Gets the invoicing_type of this MigrationRequest. - {\"default\":\"Aggregated\",\"description\":\"The strategy for how to raise invoices for charges caused by this migration.
Immediate — Generate straight-away an invoice containing these charges.
Aggregated — Add these charges to the next invoice which is generated naturally — i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the invoicing_type of this MigrationRequest. # noqa: E501 + - :return: The invoicing_type of this MigrationRequest. + :return: The invoicing_type of this MigrationRequest. # noqa: E501 :rtype: str """ return self._invoicing_type @invoicing_type.setter def invoicing_type(self, invoicing_type): - """ - Sets the invoicing_type of this MigrationRequest. - {\"default\":\"Aggregated\",\"description\":\"The strategy for how to raise invoices for charges caused by this migration.
Immediate — Generate straight-away an invoice containing these charges.
Aggregated — Add these charges to the next invoice which is generated naturally — i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the invoicing_type of this MigrationRequest. + - :param invoicing_type: The invoicing_type of this MigrationRequest. + :param invoicing_type: The invoicing_type of this MigrationRequest. # noqa: E501 :type: str """ - allowed_values = ["Immediate", "Aggregated"] + if invoicing_type is None: + raise ValueError("Invalid value for `invoicing_type`, must not be `None`") # noqa: E501 + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 if invoicing_type not in allowed_values: raise ValueError( - "Invalid value for `invoicing_type` ({0}), must be one of {1}" + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 .format(invoicing_type, allowed_values) ) @@ -220,22 +278,20 @@ def invoicing_type(self, invoicing_type): @property def mappings(self): - """ - Gets the mappings of this MigrationRequest. - {\"description\":\"List of pricing components and quantities thereof to be consumed in the new rate plan.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the mappings of this MigrationRequest. # noqa: E501 + - :return: The mappings of this MigrationRequest. + :return: The mappings of this MigrationRequest. # noqa: E501 :rtype: list[PricingComponentMigrationValue] """ return self._mappings @mappings.setter def mappings(self, mappings): - """ - Sets the mappings of this MigrationRequest. - {\"description\":\"List of pricing components and quantities thereof to be consumed in the new rate plan.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the mappings of this MigrationRequest. + - :param mappings: The mappings of this MigrationRequest. + :param mappings: The mappings of this MigrationRequest. # noqa: E501 :type: list[PricingComponentMigrationValue] """ @@ -243,63 +299,101 @@ def mappings(self, mappings): @property def pricing_behaviour(self): - """ - Gets the pricing_behaviour of this MigrationRequest. - {\"default\":\"DifferenceProRated\",\"description\":\"Pricing behaviour defines how migration charges are calculated.
DifferenceProRated — Calculate the difference between in-advance charges of the existing and new rate-plan, then pro-rate based on time remaining.
None — Set the migration charge as zero cost.
Full — Set the costs as the total of the new rate-plan's in-advance charges.
Difference — The same calculation as in DifferenceProRated, but with no pro-ration applied.
ProRated — When moving to a rate-plan of the same duration: Pro-rates the in-advance charges of the new rate-plan.
When moving to a rate-plan of a different duration: A credit-note will be issued for the price of any remaining time on the existing plan's billing period.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the pricing_behaviour of this MigrationRequest. # noqa: E501 - :return: The pricing_behaviour of this MigrationRequest. + + :return: The pricing_behaviour of this MigrationRequest. # noqa: E501 :rtype: str """ return self._pricing_behaviour @pricing_behaviour.setter def pricing_behaviour(self, pricing_behaviour): - """ - Sets the pricing_behaviour of this MigrationRequest. - {\"default\":\"DifferenceProRated\",\"description\":\"Pricing behaviour defines how migration charges are calculated.
DifferenceProRated — Calculate the difference between in-advance charges of the existing and new rate-plan, then pro-rate based on time remaining.
None — Set the migration charge as zero cost.
Full — Set the costs as the total of the new rate-plan's in-advance charges.
Difference — The same calculation as in DifferenceProRated, but with no pro-ration applied.
ProRated — When moving to a rate-plan of the same duration: Pro-rates the in-advance charges of the new rate-plan.
When moving to a rate-plan of a different duration: A credit-note will be issued for the price of any remaining time on the existing plan's billing period.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the pricing_behaviour of this MigrationRequest. - :param pricing_behaviour: The pricing_behaviour of this MigrationRequest. + + :param pricing_behaviour: The pricing_behaviour of this MigrationRequest. # noqa: E501 :type: str """ - allowed_values = ["None", "Full", "Difference", "DifferenceProRated", "ProRated"] + if pricing_behaviour is None: + raise ValueError("Invalid value for `pricing_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["None", "Full", "Difference", "DifferenceProRated", "ProRated"] # noqa: E501 if pricing_behaviour not in allowed_values: raise ValueError( - "Invalid value for `pricing_behaviour` ({0}), must be one of {1}" + "Invalid value for `pricing_behaviour` ({0}), must be one of {1}" # noqa: E501 .format(pricing_behaviour, allowed_values) ) self._pricing_behaviour = pricing_behaviour @property - def dry_run(self): + def void_existing_coupons(self): + """Gets the void_existing_coupons of this MigrationRequest. # noqa: E501 + + + :return: The void_existing_coupons of this MigrationRequest. # noqa: E501 + :rtype: bool """ - Gets the dry_run of this MigrationRequest. - {\"default\":\"false\",\"description\":\"Calculate the effects of migration but do not actually perform a migration.\",\"verbs\":[\"POST\",\"GET\"]} + return self._void_existing_coupons - :return: The dry_run of this MigrationRequest. + @void_existing_coupons.setter + def void_existing_coupons(self, void_existing_coupons): + """Sets the void_existing_coupons of this MigrationRequest. + + + :param void_existing_coupons: The void_existing_coupons of this MigrationRequest. # noqa: E501 + :type: bool + """ + + self._void_existing_coupons = void_existing_coupons + + @property + def force_trial_end(self): + """Gets the force_trial_end of this MigrationRequest. # noqa: E501 + + + :return: The force_trial_end of this MigrationRequest. # noqa: E501 + :rtype: bool + """ + return self._force_trial_end + + @force_trial_end.setter + def force_trial_end(self, force_trial_end): + """Sets the force_trial_end of this MigrationRequest. + + + :param force_trial_end: The force_trial_end of this MigrationRequest. # noqa: E501 + :type: bool + """ + + self._force_trial_end = force_trial_end + + @property + def dry_run(self): + """Gets the dry_run of this MigrationRequest. # noqa: E501 + + + :return: The dry_run of this MigrationRequest. # noqa: E501 :rtype: bool """ return self._dry_run @dry_run.setter def dry_run(self, dry_run): - """ - Sets the dry_run of this MigrationRequest. - {\"default\":\"false\",\"description\":\"Calculate the effects of migration but do not actually perform a migration.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the dry_run of this MigrationRequest. - :param dry_run: The dry_run of this MigrationRequest. + + :param dry_run: The dry_run of this MigrationRequest. # noqa: E501 :type: bool """ self._dry_run = dry_run def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -316,29 +410,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(MigrationRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, MigrationRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/migration_response.py b/billforward/models/migration_response.py new file mode 100644 index 0000000..6352792 --- /dev/null +++ b/billforward/models/migration_response.py @@ -0,0 +1,754 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class MigrationResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'subscription_id': 'str', + 'next_subscription_name': 'str', + 'next_subscription_description': 'str', + 'product': 'str', + 'product_rate_plan': 'str', + 'invoicing_type': 'str', + 'mappings': 'list[PricingComponentMigrationValue]', + 'pricing_behaviour': 'str', + 'void_existing_coupons': 'bool', + 'force_trial_end': 'bool', + 'dry_run': 'bool', + 'new_subscription_id': 'str', + 'new_subscription': 'Subscription', + 'previous_subscription': 'Subscription', + 'previous_product_rate_plan_id': 'str', + 'previous_product_rate_plan_name': 'str', + 'new_product_rate_plan_id': 'str', + 'new_product_rate_plan_name': 'str', + 'charge_type': 'str', + 'amount': 'float', + 'tax': 'float', + 'invoices': 'list[Invoice]', + 'amendment': 'Amendment' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'subscription_id': 'subscriptionID', + 'next_subscription_name': 'nextSubscriptionName', + 'next_subscription_description': 'nextSubscriptionDescription', + 'product': 'product', + 'product_rate_plan': 'productRatePlan', + 'invoicing_type': 'invoicingType', + 'mappings': 'mappings', + 'pricing_behaviour': 'pricingBehaviour', + 'void_existing_coupons': 'voidExistingCoupons', + 'force_trial_end': 'forceTrialEnd', + 'dry_run': 'dryRun', + 'new_subscription_id': 'newSubscriptionID', + 'new_subscription': 'newSubscription', + 'previous_subscription': 'previousSubscription', + 'previous_product_rate_plan_id': 'previousProductRatePlanID', + 'previous_product_rate_plan_name': 'previousProductRatePlanName', + 'new_product_rate_plan_id': 'newProductRatePlanID', + 'new_product_rate_plan_name': 'newProductRatePlanName', + 'charge_type': 'chargeType', + 'amount': 'amount', + 'tax': 'tax', + 'invoices': 'invoices', + 'amendment': 'amendment' + } + + def __init__(self, created=None, organization_id=None, subscription_id=None, next_subscription_name=None, next_subscription_description=None, product=None, product_rate_plan=None, invoicing_type=None, mappings=None, pricing_behaviour=None, void_existing_coupons=None, force_trial_end=None, dry_run=None, new_subscription_id=None, new_subscription=None, previous_subscription=None, previous_product_rate_plan_id=None, previous_product_rate_plan_name=None, new_product_rate_plan_id=None, new_product_rate_plan_name=None, charge_type=None, amount=None, tax=None, invoices=None, amendment=None): # noqa: E501 + """MigrationResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._subscription_id = None + self._next_subscription_name = None + self._next_subscription_description = None + self._product = None + self._product_rate_plan = None + self._invoicing_type = None + self._mappings = None + self._pricing_behaviour = None + self._void_existing_coupons = None + self._force_trial_end = None + self._dry_run = None + self._new_subscription_id = None + self._new_subscription = None + self._previous_subscription = None + self._previous_product_rate_plan_id = None + self._previous_product_rate_plan_name = None + self._new_product_rate_plan_id = None + self._new_product_rate_plan_name = None + self._charge_type = None + self._amount = None + self._tax = None + self._invoices = None + self._amendment = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if subscription_id is not None: + self.subscription_id = subscription_id + if next_subscription_name is not None: + self.next_subscription_name = next_subscription_name + if next_subscription_description is not None: + self.next_subscription_description = next_subscription_description + if product is not None: + self.product = product + if product_rate_plan is not None: + self.product_rate_plan = product_rate_plan + self.invoicing_type = invoicing_type + if mappings is not None: + self.mappings = mappings + self.pricing_behaviour = pricing_behaviour + if void_existing_coupons is not None: + self.void_existing_coupons = void_existing_coupons + if force_trial_end is not None: + self.force_trial_end = force_trial_end + if dry_run is not None: + self.dry_run = dry_run + if new_subscription_id is not None: + self.new_subscription_id = new_subscription_id + if new_subscription is not None: + self.new_subscription = new_subscription + if previous_subscription is not None: + self.previous_subscription = previous_subscription + if previous_product_rate_plan_id is not None: + self.previous_product_rate_plan_id = previous_product_rate_plan_id + if previous_product_rate_plan_name is not None: + self.previous_product_rate_plan_name = previous_product_rate_plan_name + if new_product_rate_plan_id is not None: + self.new_product_rate_plan_id = new_product_rate_plan_id + if new_product_rate_plan_name is not None: + self.new_product_rate_plan_name = new_product_rate_plan_name + if charge_type is not None: + self.charge_type = charge_type + if amount is not None: + self.amount = amount + if tax is not None: + self.tax = tax + if invoices is not None: + self.invoices = invoices + if amendment is not None: + self.amendment = amendment + + @property + def created(self): + """Gets the created of this MigrationResponse. # noqa: E501 + + + :return: The created of this MigrationResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this MigrationResponse. + + + :param created: The created of this MigrationResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this MigrationResponse. # noqa: E501 + + + :return: The organization_id of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this MigrationResponse. + + + :param organization_id: The organization_id of this MigrationResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def subscription_id(self): + """Gets the subscription_id of this MigrationResponse. # noqa: E501 + + + :return: The subscription_id of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this MigrationResponse. + + + :param subscription_id: The subscription_id of this MigrationResponse. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def next_subscription_name(self): + """Gets the next_subscription_name of this MigrationResponse. # noqa: E501 + + + :return: The next_subscription_name of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._next_subscription_name + + @next_subscription_name.setter + def next_subscription_name(self, next_subscription_name): + """Sets the next_subscription_name of this MigrationResponse. + + + :param next_subscription_name: The next_subscription_name of this MigrationResponse. # noqa: E501 + :type: str + """ + + self._next_subscription_name = next_subscription_name + + @property + def next_subscription_description(self): + """Gets the next_subscription_description of this MigrationResponse. # noqa: E501 + + + :return: The next_subscription_description of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._next_subscription_description + + @next_subscription_description.setter + def next_subscription_description(self, next_subscription_description): + """Sets the next_subscription_description of this MigrationResponse. + + + :param next_subscription_description: The next_subscription_description of this MigrationResponse. # noqa: E501 + :type: str + """ + + self._next_subscription_description = next_subscription_description + + @property + def product(self): + """Gets the product of this MigrationResponse. # noqa: E501 + + + :return: The product of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._product + + @product.setter + def product(self, product): + """Sets the product of this MigrationResponse. + + + :param product: The product of this MigrationResponse. # noqa: E501 + :type: str + """ + + self._product = product + + @property + def product_rate_plan(self): + """Gets the product_rate_plan of this MigrationResponse. # noqa: E501 + + + :return: The product_rate_plan of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan + + @product_rate_plan.setter + def product_rate_plan(self, product_rate_plan): + """Sets the product_rate_plan of this MigrationResponse. + + + :param product_rate_plan: The product_rate_plan of this MigrationResponse. # noqa: E501 + :type: str + """ + + self._product_rate_plan = product_rate_plan + + @property + def invoicing_type(self): + """Gets the invoicing_type of this MigrationResponse. # noqa: E501 + + + :return: The invoicing_type of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._invoicing_type + + @invoicing_type.setter + def invoicing_type(self, invoicing_type): + """Sets the invoicing_type of this MigrationResponse. + + + :param invoicing_type: The invoicing_type of this MigrationResponse. # noqa: E501 + :type: str + """ + if invoicing_type is None: + raise ValueError("Invalid value for `invoicing_type`, must not be `None`") # noqa: E501 + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 + if invoicing_type not in allowed_values: + raise ValueError( + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 + .format(invoicing_type, allowed_values) + ) + + self._invoicing_type = invoicing_type + + @property + def mappings(self): + """Gets the mappings of this MigrationResponse. # noqa: E501 + + + :return: The mappings of this MigrationResponse. # noqa: E501 + :rtype: list[PricingComponentMigrationValue] + """ + return self._mappings + + @mappings.setter + def mappings(self, mappings): + """Sets the mappings of this MigrationResponse. + + + :param mappings: The mappings of this MigrationResponse. # noqa: E501 + :type: list[PricingComponentMigrationValue] + """ + + self._mappings = mappings + + @property + def pricing_behaviour(self): + """Gets the pricing_behaviour of this MigrationResponse. # noqa: E501 + + + :return: The pricing_behaviour of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._pricing_behaviour + + @pricing_behaviour.setter + def pricing_behaviour(self, pricing_behaviour): + """Sets the pricing_behaviour of this MigrationResponse. + + + :param pricing_behaviour: The pricing_behaviour of this MigrationResponse. # noqa: E501 + :type: str + """ + if pricing_behaviour is None: + raise ValueError("Invalid value for `pricing_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["None", "Full", "Difference", "DifferenceProRated", "ProRated"] # noqa: E501 + if pricing_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `pricing_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(pricing_behaviour, allowed_values) + ) + + self._pricing_behaviour = pricing_behaviour + + @property + def void_existing_coupons(self): + """Gets the void_existing_coupons of this MigrationResponse. # noqa: E501 + + + :return: The void_existing_coupons of this MigrationResponse. # noqa: E501 + :rtype: bool + """ + return self._void_existing_coupons + + @void_existing_coupons.setter + def void_existing_coupons(self, void_existing_coupons): + """Sets the void_existing_coupons of this MigrationResponse. + + + :param void_existing_coupons: The void_existing_coupons of this MigrationResponse. # noqa: E501 + :type: bool + """ + + self._void_existing_coupons = void_existing_coupons + + @property + def force_trial_end(self): + """Gets the force_trial_end of this MigrationResponse. # noqa: E501 + + + :return: The force_trial_end of this MigrationResponse. # noqa: E501 + :rtype: bool + """ + return self._force_trial_end + + @force_trial_end.setter + def force_trial_end(self, force_trial_end): + """Sets the force_trial_end of this MigrationResponse. + + + :param force_trial_end: The force_trial_end of this MigrationResponse. # noqa: E501 + :type: bool + """ + + self._force_trial_end = force_trial_end + + @property + def dry_run(self): + """Gets the dry_run of this MigrationResponse. # noqa: E501 + + + :return: The dry_run of this MigrationResponse. # noqa: E501 + :rtype: bool + """ + return self._dry_run + + @dry_run.setter + def dry_run(self, dry_run): + """Sets the dry_run of this MigrationResponse. + + + :param dry_run: The dry_run of this MigrationResponse. # noqa: E501 + :type: bool + """ + + self._dry_run = dry_run + + @property + def new_subscription_id(self): + """Gets the new_subscription_id of this MigrationResponse. # noqa: E501 + + + :return: The new_subscription_id of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._new_subscription_id + + @new_subscription_id.setter + def new_subscription_id(self, new_subscription_id): + """Sets the new_subscription_id of this MigrationResponse. + + + :param new_subscription_id: The new_subscription_id of this MigrationResponse. # noqa: E501 + :type: str + """ + + self._new_subscription_id = new_subscription_id + + @property + def new_subscription(self): + """Gets the new_subscription of this MigrationResponse. # noqa: E501 + + + :return: The new_subscription of this MigrationResponse. # noqa: E501 + :rtype: Subscription + """ + return self._new_subscription + + @new_subscription.setter + def new_subscription(self, new_subscription): + """Sets the new_subscription of this MigrationResponse. + + + :param new_subscription: The new_subscription of this MigrationResponse. # noqa: E501 + :type: Subscription + """ + + self._new_subscription = new_subscription + + @property + def previous_subscription(self): + """Gets the previous_subscription of this MigrationResponse. # noqa: E501 + + + :return: The previous_subscription of this MigrationResponse. # noqa: E501 + :rtype: Subscription + """ + return self._previous_subscription + + @previous_subscription.setter + def previous_subscription(self, previous_subscription): + """Sets the previous_subscription of this MigrationResponse. + + + :param previous_subscription: The previous_subscription of this MigrationResponse. # noqa: E501 + :type: Subscription + """ + + self._previous_subscription = previous_subscription + + @property + def previous_product_rate_plan_id(self): + """Gets the previous_product_rate_plan_id of this MigrationResponse. # noqa: E501 + + + :return: The previous_product_rate_plan_id of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._previous_product_rate_plan_id + + @previous_product_rate_plan_id.setter + def previous_product_rate_plan_id(self, previous_product_rate_plan_id): + """Sets the previous_product_rate_plan_id of this MigrationResponse. + + + :param previous_product_rate_plan_id: The previous_product_rate_plan_id of this MigrationResponse. # noqa: E501 + :type: str + """ + + self._previous_product_rate_plan_id = previous_product_rate_plan_id + + @property + def previous_product_rate_plan_name(self): + """Gets the previous_product_rate_plan_name of this MigrationResponse. # noqa: E501 + + + :return: The previous_product_rate_plan_name of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._previous_product_rate_plan_name + + @previous_product_rate_plan_name.setter + def previous_product_rate_plan_name(self, previous_product_rate_plan_name): + """Sets the previous_product_rate_plan_name of this MigrationResponse. + + + :param previous_product_rate_plan_name: The previous_product_rate_plan_name of this MigrationResponse. # noqa: E501 + :type: str + """ + + self._previous_product_rate_plan_name = previous_product_rate_plan_name + + @property + def new_product_rate_plan_id(self): + """Gets the new_product_rate_plan_id of this MigrationResponse. # noqa: E501 + + + :return: The new_product_rate_plan_id of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._new_product_rate_plan_id + + @new_product_rate_plan_id.setter + def new_product_rate_plan_id(self, new_product_rate_plan_id): + """Sets the new_product_rate_plan_id of this MigrationResponse. + + + :param new_product_rate_plan_id: The new_product_rate_plan_id of this MigrationResponse. # noqa: E501 + :type: str + """ + + self._new_product_rate_plan_id = new_product_rate_plan_id + + @property + def new_product_rate_plan_name(self): + """Gets the new_product_rate_plan_name of this MigrationResponse. # noqa: E501 + + + :return: The new_product_rate_plan_name of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._new_product_rate_plan_name + + @new_product_rate_plan_name.setter + def new_product_rate_plan_name(self, new_product_rate_plan_name): + """Sets the new_product_rate_plan_name of this MigrationResponse. + + + :param new_product_rate_plan_name: The new_product_rate_plan_name of this MigrationResponse. # noqa: E501 + :type: str + """ + + self._new_product_rate_plan_name = new_product_rate_plan_name + + @property + def charge_type(self): + """Gets the charge_type of this MigrationResponse. # noqa: E501 + + + :return: The charge_type of this MigrationResponse. # noqa: E501 + :rtype: str + """ + return self._charge_type + + @charge_type.setter + def charge_type(self, charge_type): + """Sets the charge_type of this MigrationResponse. + + + :param charge_type: The charge_type of this MigrationResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Credit", "Debit"] # noqa: E501 + if charge_type not in allowed_values: + raise ValueError( + "Invalid value for `charge_type` ({0}), must be one of {1}" # noqa: E501 + .format(charge_type, allowed_values) + ) + + self._charge_type = charge_type + + @property + def amount(self): + """Gets the amount of this MigrationResponse. # noqa: E501 + + + :return: The amount of this MigrationResponse. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this MigrationResponse. + + + :param amount: The amount of this MigrationResponse. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def tax(self): + """Gets the tax of this MigrationResponse. # noqa: E501 + + + :return: The tax of this MigrationResponse. # noqa: E501 + :rtype: float + """ + return self._tax + + @tax.setter + def tax(self, tax): + """Sets the tax of this MigrationResponse. + + + :param tax: The tax of this MigrationResponse. # noqa: E501 + :type: float + """ + + self._tax = tax + + @property + def invoices(self): + """Gets the invoices of this MigrationResponse. # noqa: E501 + + + :return: The invoices of this MigrationResponse. # noqa: E501 + :rtype: list[Invoice] + """ + return self._invoices + + @invoices.setter + def invoices(self, invoices): + """Sets the invoices of this MigrationResponse. + + + :param invoices: The invoices of this MigrationResponse. # noqa: E501 + :type: list[Invoice] + """ + + self._invoices = invoices + + @property + def amendment(self): + """Gets the amendment of this MigrationResponse. # noqa: E501 + + + :return: The amendment of this MigrationResponse. # noqa: E501 + :rtype: Amendment + """ + return self._amendment + + @amendment.setter + def amendment(self, amendment): + """Sets the amendment of this MigrationResponse. + + + :param amendment: The amendment of this MigrationResponse. # noqa: E501 + :type: Amendment + """ + + self._amendment = amendment + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(MigrationResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, MigrationResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/mutable_billing_entity.py b/billforward/models/mutable_billing_entity.py deleted file mode 100644 index 6ba4dab..0000000 --- a/billforward/models/mutable_billing_entity.py +++ /dev/null @@ -1,642 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class MutableBillingEntity(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, config_id=None, organization_id=None, state=None, type=None, scope=None, target=None, name=None, description=None, data_from=None, data_till=None, started=None, stopped=None, created_by=None, max_retry_times=None, retry_attempted=None, deleted=False): - """ - MutableBillingEntity - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'config_id': 'str', - 'organization_id': 'str', - 'state': 'str', - 'type': 'str', - 'scope': 'str', - 'target': 'str', - 'name': 'str', - 'description': 'str', - 'data_from': 'datetime', - 'data_till': 'datetime', - 'started': 'datetime', - 'stopped': 'datetime', - 'created_by': 'str', - 'max_retry_times': 'int', - 'retry_attempted': 'int', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'config_id': 'configID', - 'organization_id': 'organizationID', - 'state': 'state', - 'type': 'type', - 'scope': 'scope', - 'target': 'target', - 'name': 'name', - 'description': 'description', - 'data_from': 'dataFrom', - 'data_till': 'dataTill', - 'started': 'started', - 'stopped': 'stopped', - 'created_by': 'createdBy', - 'max_retry_times': 'maxRetryTimes', - 'retry_attempted': 'retryAttempted', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._config_id = config_id - self._organization_id = organization_id - self._state = state - self._type = type - self._scope = scope - self._target = target - self._name = name - self._description = description - self._data_from = data_from - self._data_till = data_till - self._started = started - self._stopped = stopped - self._created_by = created_by - self._max_retry_times = max_retry_times - self._retry_attempted = retry_attempted - self._deleted = deleted - - @property - def created(self): - """ - Gets the created of this MutableBillingEntity. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this MutableBillingEntity. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this MutableBillingEntity. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this MutableBillingEntity. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this MutableBillingEntity. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this MutableBillingEntity. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this MutableBillingEntity. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this MutableBillingEntity. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this MutableBillingEntity. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this MutableBillingEntity. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this MutableBillingEntity. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this MutableBillingEntity. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this MutableBillingEntity. - ID of the Synchronization Job. - - :return: The id of this MutableBillingEntity. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this MutableBillingEntity. - ID of the Synchronization Job. - - :param id: The id of this MutableBillingEntity. - :type: str - """ - - self._id = id - - @property - def config_id(self): - """ - Gets the config_id of this MutableBillingEntity. - This is config id which links to this sync job. - - :return: The config_id of this MutableBillingEntity. - :rtype: str - """ - return self._config_id - - @config_id.setter - def config_id(self, config_id): - """ - Sets the config_id of this MutableBillingEntity. - This is config id which links to this sync job. - - :param config_id: The config_id of this MutableBillingEntity. - :type: str - """ - - self._config_id = config_id - - @property - def organization_id(self): - """ - Gets the organization_id of this MutableBillingEntity. - Organization associated with the refund. - - :return: The organization_id of this MutableBillingEntity. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this MutableBillingEntity. - Organization associated with the refund. - - :param organization_id: The organization_id of this MutableBillingEntity. - :type: str - """ - - self._organization_id = organization_id - - @property - def state(self): - """ - Gets the state of this MutableBillingEntity. - This is the state of job. Pending jobs have not run. Complete jobs have run without error. Failed jobs have one of more errors. Cancelled jobs did not run. - - :return: The state of this MutableBillingEntity. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this MutableBillingEntity. - This is the state of job. Pending jobs have not run. Complete jobs have run without error. Failed jobs have one of more errors. Cancelled jobs did not run. - - :param state: The state of this MutableBillingEntity. - :type: str - """ - allowed_values = ["Pending", "Complete", "Failed", "Cancelled", "Processing"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def type(self): - """ - Gets the type of this MutableBillingEntity. - This is the type of job. Incremental jobs just sync changes, fully jobs sync all data. - - :return: The type of this MutableBillingEntity. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this MutableBillingEntity. - This is the type of job. Incremental jobs just sync changes, fully jobs sync all data. - - :param type: The type of this MutableBillingEntity. - :type: str - """ - allowed_values = ["Incremental", "Full"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def scope(self): - """ - Gets the scope of this MutableBillingEntity. - The scope of the data synch'd. - - :return: The scope of this MutableBillingEntity. - :rtype: str - """ - return self._scope - - @scope.setter - def scope(self, scope): - """ - Sets the scope of this MutableBillingEntity. - The scope of the data synch'd. - - :param scope: The scope of this MutableBillingEntity. - :type: str - """ - allowed_values = ["Manual", "Scheduled"] - if scope not in allowed_values: - raise ValueError( - "Invalid value for `scope` ({0}), must be one of {1}" - .format(scope, allowed_values) - ) - - self._scope = scope - - @property - def target(self): - """ - Gets the target of this MutableBillingEntity. - This is the target of the job. - - :return: The target of this MutableBillingEntity. - :rtype: str - """ - return self._target - - @target.setter - def target(self, target): - """ - Sets the target of this MutableBillingEntity. - This is the target of the job. - - :param target: The target of this MutableBillingEntity. - :type: str - """ - allowed_values = ["Salesforce"] - if target not in allowed_values: - raise ValueError( - "Invalid value for `target` ({0}), must be one of {1}" - .format(target, allowed_values) - ) - - self._target = target - - @property - def name(self): - """ - Gets the name of this MutableBillingEntity. - Name of the Job. - - :return: The name of this MutableBillingEntity. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this MutableBillingEntity. - Name of the Job. - - :param name: The name of this MutableBillingEntity. - :type: str - """ - - self._name = name - - @property - def description(self): - """ - Gets the description of this MutableBillingEntity. - Description of the Job. - - :return: The description of this MutableBillingEntity. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this MutableBillingEntity. - Description of the Job. - - :param description: The description of this MutableBillingEntity. - :type: str - """ - - self._description = description - - @property - def data_from(self): - """ - Gets the data_from of this MutableBillingEntity. - UTC DateTime of the start of the data to sync. - - :return: The data_from of this MutableBillingEntity. - :rtype: datetime - """ - return self._data_from - - @data_from.setter - def data_from(self, data_from): - """ - Sets the data_from of this MutableBillingEntity. - UTC DateTime of the start of the data to sync. - - :param data_from: The data_from of this MutableBillingEntity. - :type: datetime - """ - - self._data_from = data_from - - @property - def data_till(self): - """ - Gets the data_till of this MutableBillingEntity. - UTC DateTime of the start of the data to sync. - - :return: The data_till of this MutableBillingEntity. - :rtype: datetime - """ - return self._data_till - - @data_till.setter - def data_till(self, data_till): - """ - Sets the data_till of this MutableBillingEntity. - UTC DateTime of the start of the data to sync. - - :param data_till: The data_till of this MutableBillingEntity. - :type: datetime - """ - - self._data_till = data_till - - @property - def started(self): - """ - Gets the started of this MutableBillingEntity. - UTC DateTime of the end of the data to sync. - - :return: The started of this MutableBillingEntity. - :rtype: datetime - """ - return self._started - - @started.setter - def started(self, started): - """ - Sets the started of this MutableBillingEntity. - UTC DateTime of the end of the data to sync. - - :param started: The started of this MutableBillingEntity. - :type: datetime - """ - - self._started = started - - @property - def stopped(self): - """ - Gets the stopped of this MutableBillingEntity. - UTC DateTime of the start of the data to sync. - - :return: The stopped of this MutableBillingEntity. - :rtype: datetime - """ - return self._stopped - - @stopped.setter - def stopped(self, stopped): - """ - Sets the stopped of this MutableBillingEntity. - UTC DateTime of the start of the data to sync. - - :param stopped: The stopped of this MutableBillingEntity. - :type: datetime - """ - - self._stopped = stopped - - @property - def created_by(self): - """ - Gets the created_by of this MutableBillingEntity. - The account who created the synch job. - - :return: The created_by of this MutableBillingEntity. - :rtype: str - """ - return self._created_by - - @created_by.setter - def created_by(self, created_by): - """ - Sets the created_by of this MutableBillingEntity. - The account who created the synch job. - - :param created_by: The created_by of this MutableBillingEntity. - :type: str - """ - - self._created_by = created_by - - @property - def max_retry_times(self): - """ - Gets the max_retry_times of this MutableBillingEntity. - The max number of times the records will try to resync. - - :return: The max_retry_times of this MutableBillingEntity. - :rtype: int - """ - return self._max_retry_times - - @max_retry_times.setter - def max_retry_times(self, max_retry_times): - """ - Sets the max_retry_times of this MutableBillingEntity. - The max number of times the records will try to resync. - - :param max_retry_times: The max_retry_times of this MutableBillingEntity. - :type: int - """ - - self._max_retry_times = max_retry_times - - @property - def retry_attempted(self): - """ - Gets the retry_attempted of this MutableBillingEntity. - The number of times the records tried to resync. - - :return: The retry_attempted of this MutableBillingEntity. - :rtype: int - """ - return self._retry_attempted - - @retry_attempted.setter - def retry_attempted(self, retry_attempted): - """ - Sets the retry_attempted of this MutableBillingEntity. - The number of times the records tried to resync. - - :param retry_attempted: The retry_attempted of this MutableBillingEntity. - :type: int - """ - - self._retry_attempted = retry_attempted - - @property - def deleted(self): - """ - Gets the deleted of this MutableBillingEntity. - Is the sync job deleted. - - :return: The deleted of this MutableBillingEntity. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this MutableBillingEntity. - Is the sync job deleted. - - :param deleted: The deleted of this MutableBillingEntity. - :type: bool - """ - - self._deleted = deleted - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/nested_adhoc_charge_request.py b/billforward/models/nested_adhoc_charge_request.py new file mode 100644 index 0000000..2deb5f2 --- /dev/null +++ b/billforward/models/nested_adhoc_charge_request.py @@ -0,0 +1,324 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class NestedAdhocChargeRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'amount': 'float', + 'tax_amount': 'bool', + 'charge_type': 'str', + 'trial': 'bool', + 'quantity': 'int', + 'period_start': 'datetime', + 'period_end': 'datetime' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'amount': 'amount', + 'tax_amount': 'taxAmount', + 'charge_type': 'chargeType', + 'trial': 'trial', + 'quantity': 'quantity', + 'period_start': 'periodStart', + 'period_end': 'periodEnd' + } + + def __init__(self, name=None, description=None, amount=None, tax_amount=None, charge_type=None, trial=None, quantity=None, period_start=None, period_end=None): # noqa: E501 + """NestedAdhocChargeRequest - a model defined in Swagger""" # noqa: E501 + self._name = None + self._description = None + self._amount = None + self._tax_amount = None + self._charge_type = None + self._trial = None + self._quantity = None + self._period_start = None + self._period_end = None + self.discriminator = None + if name is not None: + self.name = name + if description is not None: + self.description = description + if amount is not None: + self.amount = amount + if tax_amount is not None: + self.tax_amount = tax_amount + if charge_type is not None: + self.charge_type = charge_type + if trial is not None: + self.trial = trial + if quantity is not None: + self.quantity = quantity + if period_start is not None: + self.period_start = period_start + if period_end is not None: + self.period_end = period_end + + @property + def name(self): + """Gets the name of this NestedAdhocChargeRequest. # noqa: E501 + + + :return: The name of this NestedAdhocChargeRequest. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this NestedAdhocChargeRequest. + + + :param name: The name of this NestedAdhocChargeRequest. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this NestedAdhocChargeRequest. # noqa: E501 + + + :return: The description of this NestedAdhocChargeRequest. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this NestedAdhocChargeRequest. + + + :param description: The description of this NestedAdhocChargeRequest. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def amount(self): + """Gets the amount of this NestedAdhocChargeRequest. # noqa: E501 + + + :return: The amount of this NestedAdhocChargeRequest. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this NestedAdhocChargeRequest. + + + :param amount: The amount of this NestedAdhocChargeRequest. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def tax_amount(self): + """Gets the tax_amount of this NestedAdhocChargeRequest. # noqa: E501 + + + :return: The tax_amount of this NestedAdhocChargeRequest. # noqa: E501 + :rtype: bool + """ + return self._tax_amount + + @tax_amount.setter + def tax_amount(self, tax_amount): + """Sets the tax_amount of this NestedAdhocChargeRequest. + + + :param tax_amount: The tax_amount of this NestedAdhocChargeRequest. # noqa: E501 + :type: bool + """ + + self._tax_amount = tax_amount + + @property + def charge_type(self): + """Gets the charge_type of this NestedAdhocChargeRequest. # noqa: E501 + + + :return: The charge_type of this NestedAdhocChargeRequest. # noqa: E501 + :rtype: str + """ + return self._charge_type + + @charge_type.setter + def charge_type(self, charge_type): + """Sets the charge_type of this NestedAdhocChargeRequest. + + + :param charge_type: The charge_type of this NestedAdhocChargeRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Credit", "Debit"] # noqa: E501 + if charge_type not in allowed_values: + raise ValueError( + "Invalid value for `charge_type` ({0}), must be one of {1}" # noqa: E501 + .format(charge_type, allowed_values) + ) + + self._charge_type = charge_type + + @property + def trial(self): + """Gets the trial of this NestedAdhocChargeRequest. # noqa: E501 + + + :return: The trial of this NestedAdhocChargeRequest. # noqa: E501 + :rtype: bool + """ + return self._trial + + @trial.setter + def trial(self, trial): + """Sets the trial of this NestedAdhocChargeRequest. + + + :param trial: The trial of this NestedAdhocChargeRequest. # noqa: E501 + :type: bool + """ + + self._trial = trial + + @property + def quantity(self): + """Gets the quantity of this NestedAdhocChargeRequest. # noqa: E501 + + + :return: The quantity of this NestedAdhocChargeRequest. # noqa: E501 + :rtype: int + """ + return self._quantity + + @quantity.setter + def quantity(self, quantity): + """Sets the quantity of this NestedAdhocChargeRequest. + + + :param quantity: The quantity of this NestedAdhocChargeRequest. # noqa: E501 + :type: int + """ + + self._quantity = quantity + + @property + def period_start(self): + """Gets the period_start of this NestedAdhocChargeRequest. # noqa: E501 + + + :return: The period_start of this NestedAdhocChargeRequest. # noqa: E501 + :rtype: datetime + """ + return self._period_start + + @period_start.setter + def period_start(self, period_start): + """Sets the period_start of this NestedAdhocChargeRequest. + + + :param period_start: The period_start of this NestedAdhocChargeRequest. # noqa: E501 + :type: datetime + """ + + self._period_start = period_start + + @property + def period_end(self): + """Gets the period_end of this NestedAdhocChargeRequest. # noqa: E501 + + + :return: The period_end of this NestedAdhocChargeRequest. # noqa: E501 + :rtype: datetime + """ + return self._period_end + + @period_end.setter + def period_end(self, period_end): + """Sets the period_end of this NestedAdhocChargeRequest. + + + :param period_end: The period_end of this NestedAdhocChargeRequest. # noqa: E501 + :type: datetime + """ + + self._period_end = period_end + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(NestedAdhocChargeRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, NestedAdhocChargeRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/nested_charge_request.py b/billforward/models/nested_charge_request.py new file mode 100644 index 0000000..673c2d1 --- /dev/null +++ b/billforward/models/nested_charge_request.py @@ -0,0 +1,428 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class NestedChargeRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'name': 'str', + 'description': 'str', + 'amount': 'float', + 'tax_amount': 'bool', + 'period_start': 'datetime', + 'period_end': 'datetime', + 'charge_type': 'str', + 'trial': 'bool', + 'product': 'str', + 'product_rate_plan': 'str', + 'pricing_component': 'str', + 'pricing_component_value': 'int' + } + + attribute_map = { + 'id': 'id', + 'name': 'name', + 'description': 'description', + 'amount': 'amount', + 'tax_amount': 'taxAmount', + 'period_start': 'periodStart', + 'period_end': 'periodEnd', + 'charge_type': 'chargeType', + 'trial': 'trial', + 'product': 'product', + 'product_rate_plan': 'productRatePlan', + 'pricing_component': 'pricingComponent', + 'pricing_component_value': 'pricingComponentValue' + } + + def __init__(self, id=None, name=None, description=None, amount=None, tax_amount=None, period_start=None, period_end=None, charge_type=None, trial=None, product=None, product_rate_plan=None, pricing_component=None, pricing_component_value=None): # noqa: E501 + """NestedChargeRequest - a model defined in Swagger""" # noqa: E501 + self._id = None + self._name = None + self._description = None + self._amount = None + self._tax_amount = None + self._period_start = None + self._period_end = None + self._charge_type = None + self._trial = None + self._product = None + self._product_rate_plan = None + self._pricing_component = None + self._pricing_component_value = None + self.discriminator = None + if id is not None: + self.id = id + if name is not None: + self.name = name + if description is not None: + self.description = description + if amount is not None: + self.amount = amount + if tax_amount is not None: + self.tax_amount = tax_amount + if period_start is not None: + self.period_start = period_start + if period_end is not None: + self.period_end = period_end + if charge_type is not None: + self.charge_type = charge_type + if trial is not None: + self.trial = trial + if product is not None: + self.product = product + if product_rate_plan is not None: + self.product_rate_plan = product_rate_plan + if pricing_component is not None: + self.pricing_component = pricing_component + if pricing_component_value is not None: + self.pricing_component_value = pricing_component_value + + @property + def id(self): + """Gets the id of this NestedChargeRequest. # noqa: E501 + + + :return: The id of this NestedChargeRequest. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this NestedChargeRequest. + + + :param id: The id of this NestedChargeRequest. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def name(self): + """Gets the name of this NestedChargeRequest. # noqa: E501 + + + :return: The name of this NestedChargeRequest. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this NestedChargeRequest. + + + :param name: The name of this NestedChargeRequest. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this NestedChargeRequest. # noqa: E501 + + + :return: The description of this NestedChargeRequest. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this NestedChargeRequest. + + + :param description: The description of this NestedChargeRequest. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def amount(self): + """Gets the amount of this NestedChargeRequest. # noqa: E501 + + + :return: The amount of this NestedChargeRequest. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this NestedChargeRequest. + + + :param amount: The amount of this NestedChargeRequest. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def tax_amount(self): + """Gets the tax_amount of this NestedChargeRequest. # noqa: E501 + + + :return: The tax_amount of this NestedChargeRequest. # noqa: E501 + :rtype: bool + """ + return self._tax_amount + + @tax_amount.setter + def tax_amount(self, tax_amount): + """Sets the tax_amount of this NestedChargeRequest. + + + :param tax_amount: The tax_amount of this NestedChargeRequest. # noqa: E501 + :type: bool + """ + + self._tax_amount = tax_amount + + @property + def period_start(self): + """Gets the period_start of this NestedChargeRequest. # noqa: E501 + + + :return: The period_start of this NestedChargeRequest. # noqa: E501 + :rtype: datetime + """ + return self._period_start + + @period_start.setter + def period_start(self, period_start): + """Sets the period_start of this NestedChargeRequest. + + + :param period_start: The period_start of this NestedChargeRequest. # noqa: E501 + :type: datetime + """ + + self._period_start = period_start + + @property + def period_end(self): + """Gets the period_end of this NestedChargeRequest. # noqa: E501 + + + :return: The period_end of this NestedChargeRequest. # noqa: E501 + :rtype: datetime + """ + return self._period_end + + @period_end.setter + def period_end(self, period_end): + """Sets the period_end of this NestedChargeRequest. + + + :param period_end: The period_end of this NestedChargeRequest. # noqa: E501 + :type: datetime + """ + + self._period_end = period_end + + @property + def charge_type(self): + """Gets the charge_type of this NestedChargeRequest. # noqa: E501 + + + :return: The charge_type of this NestedChargeRequest. # noqa: E501 + :rtype: str + """ + return self._charge_type + + @charge_type.setter + def charge_type(self, charge_type): + """Sets the charge_type of this NestedChargeRequest. + + + :param charge_type: The charge_type of this NestedChargeRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Credit", "Debit"] # noqa: E501 + if charge_type not in allowed_values: + raise ValueError( + "Invalid value for `charge_type` ({0}), must be one of {1}" # noqa: E501 + .format(charge_type, allowed_values) + ) + + self._charge_type = charge_type + + @property + def trial(self): + """Gets the trial of this NestedChargeRequest. # noqa: E501 + + + :return: The trial of this NestedChargeRequest. # noqa: E501 + :rtype: bool + """ + return self._trial + + @trial.setter + def trial(self, trial): + """Sets the trial of this NestedChargeRequest. + + + :param trial: The trial of this NestedChargeRequest. # noqa: E501 + :type: bool + """ + + self._trial = trial + + @property + def product(self): + """Gets the product of this NestedChargeRequest. # noqa: E501 + + + :return: The product of this NestedChargeRequest. # noqa: E501 + :rtype: str + """ + return self._product + + @product.setter + def product(self, product): + """Sets the product of this NestedChargeRequest. + + + :param product: The product of this NestedChargeRequest. # noqa: E501 + :type: str + """ + + self._product = product + + @property + def product_rate_plan(self): + """Gets the product_rate_plan of this NestedChargeRequest. # noqa: E501 + + + :return: The product_rate_plan of this NestedChargeRequest. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan + + @product_rate_plan.setter + def product_rate_plan(self, product_rate_plan): + """Sets the product_rate_plan of this NestedChargeRequest. + + + :param product_rate_plan: The product_rate_plan of this NestedChargeRequest. # noqa: E501 + :type: str + """ + + self._product_rate_plan = product_rate_plan + + @property + def pricing_component(self): + """Gets the pricing_component of this NestedChargeRequest. # noqa: E501 + + + :return: The pricing_component of this NestedChargeRequest. # noqa: E501 + :rtype: str + """ + return self._pricing_component + + @pricing_component.setter + def pricing_component(self, pricing_component): + """Sets the pricing_component of this NestedChargeRequest. + + + :param pricing_component: The pricing_component of this NestedChargeRequest. # noqa: E501 + :type: str + """ + + self._pricing_component = pricing_component + + @property + def pricing_component_value(self): + """Gets the pricing_component_value of this NestedChargeRequest. # noqa: E501 + + + :return: The pricing_component_value of this NestedChargeRequest. # noqa: E501 + :rtype: int + """ + return self._pricing_component_value + + @pricing_component_value.setter + def pricing_component_value(self, pricing_component_value): + """Sets the pricing_component_value of this NestedChargeRequest. + + + :param pricing_component_value: The pricing_component_value of this NestedChargeRequest. # noqa: E501 + :type: int + """ + + self._pricing_component_value = pricing_component_value + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(NestedChargeRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, NestedChargeRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/notification.py b/billforward/models/notification.py deleted file mode 100644 index 07755cd..0000000 --- a/billforward/models/notification.py +++ /dev/null @@ -1,642 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class Notification(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, domain=None, action=None, organization_id=None, webhook_id=None, entity_id=None, destination_url=None, format=None, ack_enabled=False, entity=None, changes=None, last_send_attempt=None, next_send_attempt=None, final_send_attempt=None, total_send_attempts=None, state=None, acked=None): - """ - Notification - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'domain': 'str', - 'action': 'str', - 'organization_id': 'str', - 'webhook_id': 'str', - 'entity_id': 'str', - 'destination_url': 'str', - 'format': 'str', - 'ack_enabled': 'bool', - 'entity': 'list[str]', - 'changes': 'list[str]', - 'last_send_attempt': 'datetime', - 'next_send_attempt': 'datetime', - 'final_send_attempt': 'datetime', - 'total_send_attempts': 'int', - 'state': 'str', - 'acked': 'datetime' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'domain': 'domain', - 'action': 'action', - 'organization_id': 'organizationID', - 'webhook_id': 'webhookID', - 'entity_id': 'entityID', - 'destination_url': 'destinationURL', - 'format': 'format', - 'ack_enabled': 'ackEnabled', - 'entity': 'entity', - 'changes': 'changes', - 'last_send_attempt': 'lastSendAttempt', - 'next_send_attempt': 'nextSendAttempt', - 'final_send_attempt': 'finalSendAttempt', - 'total_send_attempts': 'totalSendAttempts', - 'state': 'state', - 'acked': 'acked' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._domain = domain - self._action = action - self._organization_id = organization_id - self._webhook_id = webhook_id - self._entity_id = entity_id - self._destination_url = destination_url - self._format = format - self._ack_enabled = ack_enabled - self._entity = entity - self._changes = changes - self._last_send_attempt = last_send_attempt - self._next_send_attempt = next_send_attempt - self._final_send_attempt = final_send_attempt - self._total_send_attempts = total_send_attempts - self._state = state - self._acked = acked - - @property - def created(self): - """ - Gets the created of this Notification. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this Notification. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this Notification. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this Notification. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this Notification. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this Notification. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this Notification. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this Notification. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this Notification. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this Notification. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this Notification. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this Notification. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this Notification. - { \"description\" : \"ID of the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this Notification. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this Notification. - { \"description\" : \"ID of the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this Notification. - :type: str - """ - - self._id = id - - @property - def domain(self): - """ - Gets the domain of this Notification. - { \"description\" : \"The domain of the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The domain of this Notification. - :rtype: str - """ - return self._domain - - @domain.setter - def domain(self, domain): - """ - Sets the domain of this Notification. - { \"description\" : \"The domain of the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param domain: The domain of this Notification. - :type: str - """ - allowed_values = ["Notification", "Organization", "OrganizationGateway", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "Coupon", "CouponDiscount", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "WebhookSubscription", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "Payment", "PaymentMethod", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "PaypalSimplePaymentReconciliation", "FreePaymentReconciliation", "LocustworldPaymentReconciliation", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "SearchResult", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "BalancedToken", "AuthorizeNetToken", "PaypalToken", "SpreedlyToken", "SagePayToken", "TrustCommerceToken", "PayVisionToken", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "SagePayTransaction", "GatewayRevenue", "Migration", "AdhocSubscription", "SubscriptionCharge", "ComponentChange", "Verification", "UsageRoundingStrategies", "PricingComponentValueMigrationChargeAmendmentMapping", "AmendmentDiscardAmendment", "EntityTime", "AggregatingComponent", "PricingComponentMigrationValue", "MetadataKeyValue", "Metadata", "AggregationLink", "BFPermission", "Role", "PermissionLink", "PayVisionTransaction", "KashToken", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "InvoiceLinePayment", "EmailSubscription", "EmailProvider", "TimeResponse", "Email", "RevenueAttribution", "Unknown"] - if domain not in allowed_values: - raise ValueError( - "Invalid value for `domain` ({0}), must be one of {1}" - .format(domain, allowed_values) - ) - - self._domain = domain - - @property - def action(self): - """ - Gets the action of this Notification. - { \"description\" : \"The action associated with the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The action of this Notification. - :rtype: str - """ - return self._action - - @action.setter - def action(self, action): - """ - Sets the action of this Notification. - { \"description\" : \"The action associated with the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param action: The action of this Notification. - :type: str - """ - allowed_values = ["Accept", "Active", "AwaitingPayment", "AwaitingRefund", "Cancelled", "Completed", "Created", "Error", "Expiring", "Expired", "Failed", "Migrated", "NeedsAmendments", "Paid", "Pending", "Provisioned", "Refunded", "Reject", "Trial", "Unknown", "Unpaid", "Updated", "Voided", "PaymentFailed"] - if action not in allowed_values: - raise ValueError( - "Invalid value for `action` ({0}), must be one of {1}" - .format(action, allowed_values) - ) - - self._action = action - - @property - def organization_id(self): - """ - Gets the organization_id of this Notification. - { \"description\" : \"Organization associated with the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this Notification. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this Notification. - { \"description\" : \"Organization associated with the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this Notification. - :type: str - """ - - self._organization_id = organization_id - - @property - def webhook_id(self): - """ - Gets the webhook_id of this Notification. - { \"description\" : \"Webhook associated with the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The webhook_id of this Notification. - :rtype: str - """ - return self._webhook_id - - @webhook_id.setter - def webhook_id(self, webhook_id): - """ - Sets the webhook_id of this Notification. - { \"description\" : \"Webhook associated with the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param webhook_id: The webhook_id of this Notification. - :type: str - """ - - self._webhook_id = webhook_id - - @property - def entity_id(self): - """ - Gets the entity_id of this Notification. - { \"description\" : \"The id of the entity associated with the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The entity_id of this Notification. - :rtype: str - """ - return self._entity_id - - @entity_id.setter - def entity_id(self, entity_id): - """ - Sets the entity_id of this Notification. - { \"description\" : \"The id of the entity associated with the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param entity_id: The entity_id of this Notification. - :type: str - """ - - self._entity_id = entity_id - - @property - def destination_url(self): - """ - Gets the destination_url of this Notification. - { \"description\" : \"The URL the notification will be sent to.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The destination_url of this Notification. - :rtype: str - """ - return self._destination_url - - @destination_url.setter - def destination_url(self, destination_url): - """ - Sets the destination_url of this Notification. - { \"description\" : \"The URL the notification will be sent to.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param destination_url: The destination_url of this Notification. - :type: str - """ - - self._destination_url = destination_url - - @property - def format(self): - """ - Gets the format of this Notification. - { \"description\" : \"Format of the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The format of this Notification. - :rtype: str - """ - return self._format - - @format.setter - def format(self, format): - """ - Sets the format of this Notification. - { \"description\" : \"Format of the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param format: The format of this Notification. - :type: str - """ - allowed_values = ["JSON", "XML"] - if format not in allowed_values: - raise ValueError( - "Invalid value for `format` ({0}), must be one of {1}" - .format(format, allowed_values) - ) - - self._format = format - - @property - def ack_enabled(self): - """ - Gets the ack_enabled of this Notification. - { \"description\" : \"If true notifications will continue to be sent until an acknowledgment is received.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The ack_enabled of this Notification. - :rtype: bool - """ - return self._ack_enabled - - @ack_enabled.setter - def ack_enabled(self, ack_enabled): - """ - Sets the ack_enabled of this Notification. - { \"description\" : \"If true notifications will continue to be sent until an acknowledgment is received.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param ack_enabled: The ack_enabled of this Notification. - :type: bool - """ - - self._ack_enabled = ack_enabled - - @property - def entity(self): - """ - Gets the entity of this Notification. - - - :return: The entity of this Notification. - :rtype: list[str] - """ - return self._entity - - @entity.setter - def entity(self, entity): - """ - Sets the entity of this Notification. - - - :param entity: The entity of this Notification. - :type: list[str] - """ - - self._entity = entity - - @property - def changes(self): - """ - Gets the changes of this Notification. - - - :return: The changes of this Notification. - :rtype: list[str] - """ - return self._changes - - @changes.setter - def changes(self, changes): - """ - Sets the changes of this Notification. - - - :param changes: The changes of this Notification. - :type: list[str] - """ - - self._changes = changes - - @property - def last_send_attempt(self): - """ - Gets the last_send_attempt of this Notification. - { \"description\" : \"The UTC DateTime of the notifications's last send attempt.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The last_send_attempt of this Notification. - :rtype: datetime - """ - return self._last_send_attempt - - @last_send_attempt.setter - def last_send_attempt(self, last_send_attempt): - """ - Sets the last_send_attempt of this Notification. - { \"description\" : \"The UTC DateTime of the notifications's last send attempt.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param last_send_attempt: The last_send_attempt of this Notification. - :type: datetime - """ - - self._last_send_attempt = last_send_attempt - - @property - def next_send_attempt(self): - """ - Gets the next_send_attempt of this Notification. - { \"description\" : \"The UTC DateTime of the notification's next send attempt.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The next_send_attempt of this Notification. - :rtype: datetime - """ - return self._next_send_attempt - - @next_send_attempt.setter - def next_send_attempt(self, next_send_attempt): - """ - Sets the next_send_attempt of this Notification. - { \"description\" : \"The UTC DateTime of the notification's next send attempt.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param next_send_attempt: The next_send_attempt of this Notification. - :type: datetime - """ - - self._next_send_attempt = next_send_attempt - - @property - def final_send_attempt(self): - """ - Gets the final_send_attempt of this Notification. - { \"description\" : \"The UTC DateTime of the notification's final send attempt.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The final_send_attempt of this Notification. - :rtype: datetime - """ - return self._final_send_attempt - - @final_send_attempt.setter - def final_send_attempt(self, final_send_attempt): - """ - Sets the final_send_attempt of this Notification. - { \"description\" : \"The UTC DateTime of the notification's final send attempt.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param final_send_attempt: The final_send_attempt of this Notification. - :type: datetime - """ - - self._final_send_attempt = final_send_attempt - - @property - def total_send_attempts(self): - """ - Gets the total_send_attempts of this Notification. - { \"description\" : \"The number of send attempts for this notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The total_send_attempts of this Notification. - :rtype: int - """ - return self._total_send_attempts - - @total_send_attempts.setter - def total_send_attempts(self, total_send_attempts): - """ - Sets the total_send_attempts of this Notification. - { \"description\" : \"The number of send attempts for this notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param total_send_attempts: The total_send_attempts of this Notification. - :type: int - """ - - self._total_send_attempts = total_send_attempts - - @property - def state(self): - """ - Gets the state of this Notification. - { \"description\" : \"Whether the notification has been sent.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The state of this Notification. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this Notification. - { \"description\" : \"Whether the notification has been sent.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param state: The state of this Notification. - :type: str - """ - allowed_values = ["Unsent", "Sending", "Sent"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def acked(self): - """ - Gets the acked of this Notification. - { \"description\" : \"The UTC DateTime when the notification was acked if it is ack enabled.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The acked of this Notification. - :rtype: datetime - """ - return self._acked - - @acked.setter - def acked(self, acked): - """ - Sets the acked of this Notification. - { \"description\" : \"The UTC DateTime when the notification was acked if it is ack enabled.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param acked: The acked of this Notification. - :type: datetime - """ - - self._acked = acked - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/notification_paged_metadata.py b/billforward/models/notification_paged_metadata.py deleted file mode 100644 index 0e1ae70..0000000 --- a/billforward/models/notification_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class NotificationPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - NotificationPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Notification]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this NotificationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this NotificationPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this NotificationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this NotificationPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this NotificationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this NotificationPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this NotificationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this NotificationPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this NotificationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this NotificationPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this NotificationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this NotificationPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this NotificationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this NotificationPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this NotificationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this NotificationPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this NotificationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this NotificationPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this NotificationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this NotificationPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this NotificationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this NotificationPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this NotificationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this NotificationPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this NotificationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this NotificationPagedMetadata. - :rtype: list[Notification] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this NotificationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this NotificationPagedMetadata. - :type: list[Notification] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/notification_send_request.py b/billforward/models/notification_send_request.py new file mode 100644 index 0000000..d1a4486 --- /dev/null +++ b/billforward/models/notification_send_request.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class NotificationSendRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'force_send': 'bool' + } + + attribute_map = { + 'force_send': 'forceSend' + } + + def __init__(self, force_send=None): # noqa: E501 + """NotificationSendRequest - a model defined in Swagger""" # noqa: E501 + self._force_send = None + self.discriminator = None + if force_send is not None: + self.force_send = force_send + + @property + def force_send(self): + """Gets the force_send of this NotificationSendRequest. # noqa: E501 + + + :return: The force_send of this NotificationSendRequest. # noqa: E501 + :rtype: bool + """ + return self._force_send + + @force_send.setter + def force_send(self, force_send): + """Sets the force_send of this NotificationSendRequest. + + + :param force_send: The force_send of this NotificationSendRequest. # noqa: E501 + :type: bool + """ + + self._force_send = force_send + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(NotificationSendRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, NotificationSendRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/notification_send_response.py b/billforward/models/notification_send_response.py new file mode 100644 index 0000000..fc46d6b --- /dev/null +++ b/billforward/models/notification_send_response.py @@ -0,0 +1,570 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class NotificationSendResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'id': 'str', + 'domain': 'str', + 'action': 'str', + 'organization_id': 'str', + 'webhook_id': 'str', + 'entity_id': 'str', + 'destination_url': 'str', + 'entity': 'list[str]', + 'changes': 'list[str]', + 'last_send_attempt': 'datetime', + 'next_send_attempt': 'datetime', + 'final_send_attempt': 'datetime', + 'total_send_attempts': 'int', + 'state': 'str', + 'http_response_code': 'int', + 'http_response_message': 'str', + 'http_response_body': 'str' + } + + attribute_map = { + 'created': 'created', + 'id': 'id', + 'domain': 'domain', + 'action': 'action', + 'organization_id': 'organizationID', + 'webhook_id': 'webhookID', + 'entity_id': 'entityID', + 'destination_url': 'destinationURL', + 'entity': 'entity', + 'changes': 'changes', + 'last_send_attempt': 'lastSendAttempt', + 'next_send_attempt': 'nextSendAttempt', + 'final_send_attempt': 'finalSendAttempt', + 'total_send_attempts': 'totalSendAttempts', + 'state': 'state', + 'http_response_code': 'httpResponseCode', + 'http_response_message': 'httpResponseMessage', + 'http_response_body': 'httpResponseBody' + } + + def __init__(self, created=None, id=None, domain=None, action=None, organization_id=None, webhook_id=None, entity_id=None, destination_url=None, entity=None, changes=None, last_send_attempt=None, next_send_attempt=None, final_send_attempt=None, total_send_attempts=None, state=None, http_response_code=None, http_response_message=None, http_response_body=None): # noqa: E501 + """NotificationSendResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._id = None + self._domain = None + self._action = None + self._organization_id = None + self._webhook_id = None + self._entity_id = None + self._destination_url = None + self._entity = None + self._changes = None + self._last_send_attempt = None + self._next_send_attempt = None + self._final_send_attempt = None + self._total_send_attempts = None + self._state = None + self._http_response_code = None + self._http_response_message = None + self._http_response_body = None + self.discriminator = None + if created is not None: + self.created = created + if id is not None: + self.id = id + if domain is not None: + self.domain = domain + if action is not None: + self.action = action + if organization_id is not None: + self.organization_id = organization_id + if webhook_id is not None: + self.webhook_id = webhook_id + if entity_id is not None: + self.entity_id = entity_id + if destination_url is not None: + self.destination_url = destination_url + if entity is not None: + self.entity = entity + if changes is not None: + self.changes = changes + if last_send_attempt is not None: + self.last_send_attempt = last_send_attempt + if next_send_attempt is not None: + self.next_send_attempt = next_send_attempt + if final_send_attempt is not None: + self.final_send_attempt = final_send_attempt + if total_send_attempts is not None: + self.total_send_attempts = total_send_attempts + if state is not None: + self.state = state + if http_response_code is not None: + self.http_response_code = http_response_code + if http_response_message is not None: + self.http_response_message = http_response_message + if http_response_body is not None: + self.http_response_body = http_response_body + + @property + def created(self): + """Gets the created of this NotificationSendResponse. # noqa: E501 + + + :return: The created of this NotificationSendResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this NotificationSendResponse. + + + :param created: The created of this NotificationSendResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def id(self): + """Gets the id of this NotificationSendResponse. # noqa: E501 + + + :return: The id of this NotificationSendResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this NotificationSendResponse. + + + :param id: The id of this NotificationSendResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def domain(self): + """Gets the domain of this NotificationSendResponse. # noqa: E501 + + + :return: The domain of this NotificationSendResponse. # noqa: E501 + :rtype: str + """ + return self._domain + + @domain.setter + def domain(self, domain): + """Sets the domain of this NotificationSendResponse. + + + :param domain: The domain of this NotificationSendResponse. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if domain not in allowed_values: + raise ValueError( + "Invalid value for `domain` ({0}), must be one of {1}" # noqa: E501 + .format(domain, allowed_values) + ) + + self._domain = domain + + @property + def action(self): + """Gets the action of this NotificationSendResponse. # noqa: E501 + + + :return: The action of this NotificationSendResponse. # noqa: E501 + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """Sets the action of this NotificationSendResponse. + + + :param action: The action of this NotificationSendResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Accept", "Active", "AwaitingPayment", "AwaitingRefund", "Cancelled", "Completed", "Created", "Current", "Error", "Expiring", "Expired", "Failed", "Migrated", "NeedsAmendments", "Paid", "Pending", "Provisioned", "Refunded", "Reject", "Restarted", "Trial", "Unknown", "Unpaid", "Updated", "Voided", "PaymentFailed", "ProcessingPayment", "ServiceEnded", "AdvanceNotification"] # noqa: E501 + if action not in allowed_values: + raise ValueError( + "Invalid value for `action` ({0}), must be one of {1}" # noqa: E501 + .format(action, allowed_values) + ) + + self._action = action + + @property + def organization_id(self): + """Gets the organization_id of this NotificationSendResponse. # noqa: E501 + + + :return: The organization_id of this NotificationSendResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this NotificationSendResponse. + + + :param organization_id: The organization_id of this NotificationSendResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def webhook_id(self): + """Gets the webhook_id of this NotificationSendResponse. # noqa: E501 + + + :return: The webhook_id of this NotificationSendResponse. # noqa: E501 + :rtype: str + """ + return self._webhook_id + + @webhook_id.setter + def webhook_id(self, webhook_id): + """Sets the webhook_id of this NotificationSendResponse. + + + :param webhook_id: The webhook_id of this NotificationSendResponse. # noqa: E501 + :type: str + """ + + self._webhook_id = webhook_id + + @property + def entity_id(self): + """Gets the entity_id of this NotificationSendResponse. # noqa: E501 + + + :return: The entity_id of this NotificationSendResponse. # noqa: E501 + :rtype: str + """ + return self._entity_id + + @entity_id.setter + def entity_id(self, entity_id): + """Sets the entity_id of this NotificationSendResponse. + + + :param entity_id: The entity_id of this NotificationSendResponse. # noqa: E501 + :type: str + """ + + self._entity_id = entity_id + + @property + def destination_url(self): + """Gets the destination_url of this NotificationSendResponse. # noqa: E501 + + + :return: The destination_url of this NotificationSendResponse. # noqa: E501 + :rtype: str + """ + return self._destination_url + + @destination_url.setter + def destination_url(self, destination_url): + """Sets the destination_url of this NotificationSendResponse. + + + :param destination_url: The destination_url of this NotificationSendResponse. # noqa: E501 + :type: str + """ + + self._destination_url = destination_url + + @property + def entity(self): + """Gets the entity of this NotificationSendResponse. # noqa: E501 + + + :return: The entity of this NotificationSendResponse. # noqa: E501 + :rtype: list[str] + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this NotificationSendResponse. + + + :param entity: The entity of this NotificationSendResponse. # noqa: E501 + :type: list[str] + """ + + self._entity = entity + + @property + def changes(self): + """Gets the changes of this NotificationSendResponse. # noqa: E501 + + + :return: The changes of this NotificationSendResponse. # noqa: E501 + :rtype: list[str] + """ + return self._changes + + @changes.setter + def changes(self, changes): + """Sets the changes of this NotificationSendResponse. + + + :param changes: The changes of this NotificationSendResponse. # noqa: E501 + :type: list[str] + """ + + self._changes = changes + + @property + def last_send_attempt(self): + """Gets the last_send_attempt of this NotificationSendResponse. # noqa: E501 + + + :return: The last_send_attempt of this NotificationSendResponse. # noqa: E501 + :rtype: datetime + """ + return self._last_send_attempt + + @last_send_attempt.setter + def last_send_attempt(self, last_send_attempt): + """Sets the last_send_attempt of this NotificationSendResponse. + + + :param last_send_attempt: The last_send_attempt of this NotificationSendResponse. # noqa: E501 + :type: datetime + """ + + self._last_send_attempt = last_send_attempt + + @property + def next_send_attempt(self): + """Gets the next_send_attempt of this NotificationSendResponse. # noqa: E501 + + + :return: The next_send_attempt of this NotificationSendResponse. # noqa: E501 + :rtype: datetime + """ + return self._next_send_attempt + + @next_send_attempt.setter + def next_send_attempt(self, next_send_attempt): + """Sets the next_send_attempt of this NotificationSendResponse. + + + :param next_send_attempt: The next_send_attempt of this NotificationSendResponse. # noqa: E501 + :type: datetime + """ + + self._next_send_attempt = next_send_attempt + + @property + def final_send_attempt(self): + """Gets the final_send_attempt of this NotificationSendResponse. # noqa: E501 + + + :return: The final_send_attempt of this NotificationSendResponse. # noqa: E501 + :rtype: datetime + """ + return self._final_send_attempt + + @final_send_attempt.setter + def final_send_attempt(self, final_send_attempt): + """Sets the final_send_attempt of this NotificationSendResponse. + + + :param final_send_attempt: The final_send_attempt of this NotificationSendResponse. # noqa: E501 + :type: datetime + """ + + self._final_send_attempt = final_send_attempt + + @property + def total_send_attempts(self): + """Gets the total_send_attempts of this NotificationSendResponse. # noqa: E501 + + + :return: The total_send_attempts of this NotificationSendResponse. # noqa: E501 + :rtype: int + """ + return self._total_send_attempts + + @total_send_attempts.setter + def total_send_attempts(self, total_send_attempts): + """Sets the total_send_attempts of this NotificationSendResponse. + + + :param total_send_attempts: The total_send_attempts of this NotificationSendResponse. # noqa: E501 + :type: int + """ + + self._total_send_attempts = total_send_attempts + + @property + def state(self): + """Gets the state of this NotificationSendResponse. # noqa: E501 + + + :return: The state of this NotificationSendResponse. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this NotificationSendResponse. + + + :param state: The state of this NotificationSendResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Unsent", "Sending", "Sent", "Voided"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def http_response_code(self): + """Gets the http_response_code of this NotificationSendResponse. # noqa: E501 + + + :return: The http_response_code of this NotificationSendResponse. # noqa: E501 + :rtype: int + """ + return self._http_response_code + + @http_response_code.setter + def http_response_code(self, http_response_code): + """Sets the http_response_code of this NotificationSendResponse. + + + :param http_response_code: The http_response_code of this NotificationSendResponse. # noqa: E501 + :type: int + """ + + self._http_response_code = http_response_code + + @property + def http_response_message(self): + """Gets the http_response_message of this NotificationSendResponse. # noqa: E501 + + + :return: The http_response_message of this NotificationSendResponse. # noqa: E501 + :rtype: str + """ + return self._http_response_message + + @http_response_message.setter + def http_response_message(self, http_response_message): + """Sets the http_response_message of this NotificationSendResponse. + + + :param http_response_message: The http_response_message of this NotificationSendResponse. # noqa: E501 + :type: str + """ + + self._http_response_message = http_response_message + + @property + def http_response_body(self): + """Gets the http_response_body of this NotificationSendResponse. # noqa: E501 + + + :return: The http_response_body of this NotificationSendResponse. # noqa: E501 + :rtype: str + """ + return self._http_response_body + + @http_response_body.setter + def http_response_body(self, http_response_body): + """Sets the http_response_body of this NotificationSendResponse. + + + :param http_response_body: The http_response_body of this NotificationSendResponse. # noqa: E501 + :type: str + """ + + self._http_response_body = http_response_body + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(NotificationSendResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, NotificationSendResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/notifications.py b/billforward/models/notifications.py new file mode 100644 index 0000000..824acac --- /dev/null +++ b/billforward/models/notifications.py @@ -0,0 +1,662 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class Notifications(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'domain': 'str', + 'action': 'str', + 'organization_id': 'str', + 'webhook_id': 'str', + 'audit_entry_id': 'str', + 'entity_id': 'str', + 'destination_url': 'str', + 'format': 'str', + 'ack_enabled': 'bool', + 'entity': 'list[str]', + 'changes': 'list[str]', + 'last_send_attempt': 'datetime', + 'next_send_attempt': 'datetime', + 'final_send_attempt': 'datetime', + 'total_send_attempts': 'int', + 'state': 'str', + 'acked': 'datetime' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'domain': 'domain', + 'action': 'action', + 'organization_id': 'organizationID', + 'webhook_id': 'webhookID', + 'audit_entry_id': 'auditEntryID', + 'entity_id': 'entityID', + 'destination_url': 'destinationURL', + 'format': 'format', + 'ack_enabled': 'ackEnabled', + 'entity': 'entity', + 'changes': 'changes', + 'last_send_attempt': 'lastSendAttempt', + 'next_send_attempt': 'nextSendAttempt', + 'final_send_attempt': 'finalSendAttempt', + 'total_send_attempts': 'totalSendAttempts', + 'state': 'state', + 'acked': 'acked' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, domain=None, action=None, organization_id=None, webhook_id=None, audit_entry_id=None, entity_id=None, destination_url=None, format=None, ack_enabled=None, entity=None, changes=None, last_send_attempt=None, next_send_attempt=None, final_send_attempt=None, total_send_attempts=None, state=None, acked=None): # noqa: E501 + """Notifications - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._domain = None + self._action = None + self._organization_id = None + self._webhook_id = None + self._audit_entry_id = None + self._entity_id = None + self._destination_url = None + self._format = None + self._ack_enabled = None + self._entity = None + self._changes = None + self._last_send_attempt = None + self._next_send_attempt = None + self._final_send_attempt = None + self._total_send_attempts = None + self._state = None + self._acked = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.domain = domain + self.action = action + self.organization_id = organization_id + if webhook_id is not None: + self.webhook_id = webhook_id + if audit_entry_id is not None: + self.audit_entry_id = audit_entry_id + self.entity_id = entity_id + self.destination_url = destination_url + self.format = format + self.ack_enabled = ack_enabled + if entity is not None: + self.entity = entity + if changes is not None: + self.changes = changes + if last_send_attempt is not None: + self.last_send_attempt = last_send_attempt + if next_send_attempt is not None: + self.next_send_attempt = next_send_attempt + if final_send_attempt is not None: + self.final_send_attempt = final_send_attempt + if total_send_attempts is not None: + self.total_send_attempts = total_send_attempts + self.state = state + if acked is not None: + self.acked = acked + + @property + def created(self): + """Gets the created of this Notifications. # noqa: E501 + + + :return: The created of this Notifications. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this Notifications. + + + :param created: The created of this Notifications. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this Notifications. # noqa: E501 + + + :return: The changed_by of this Notifications. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this Notifications. + + + :param changed_by: The changed_by of this Notifications. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this Notifications. # noqa: E501 + + + :return: The updated of this Notifications. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this Notifications. + + + :param updated: The updated of this Notifications. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this Notifications. # noqa: E501 + + + :return: The id of this Notifications. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this Notifications. + + + :param id: The id of this Notifications. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def domain(self): + """Gets the domain of this Notifications. # noqa: E501 + + + :return: The domain of this Notifications. # noqa: E501 + :rtype: str + """ + return self._domain + + @domain.setter + def domain(self, domain): + """Sets the domain of this Notifications. + + + :param domain: The domain of this Notifications. # noqa: E501 + :type: str + """ + if domain is None: + raise ValueError("Invalid value for `domain`, must not be `None`") # noqa: E501 + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if domain not in allowed_values: + raise ValueError( + "Invalid value for `domain` ({0}), must be one of {1}" # noqa: E501 + .format(domain, allowed_values) + ) + + self._domain = domain + + @property + def action(self): + """Gets the action of this Notifications. # noqa: E501 + + + :return: The action of this Notifications. # noqa: E501 + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """Sets the action of this Notifications. + + + :param action: The action of this Notifications. # noqa: E501 + :type: str + """ + if action is None: + raise ValueError("Invalid value for `action`, must not be `None`") # noqa: E501 + allowed_values = ["Accept", "Active", "AwaitingPayment", "AwaitingRefund", "Cancelled", "Completed", "Created", "Current", "Error", "Expiring", "Expired", "Failed", "Migrated", "NeedsAmendments", "Paid", "Pending", "Provisioned", "Refunded", "Reject", "Restarted", "Trial", "Unknown", "Unpaid", "Updated", "Voided", "PaymentFailed", "ProcessingPayment", "ServiceEnded", "AdvanceNotification"] # noqa: E501 + if action not in allowed_values: + raise ValueError( + "Invalid value for `action` ({0}), must be one of {1}" # noqa: E501 + .format(action, allowed_values) + ) + + self._action = action + + @property + def organization_id(self): + """Gets the organization_id of this Notifications. # noqa: E501 + + + :return: The organization_id of this Notifications. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this Notifications. + + + :param organization_id: The organization_id of this Notifications. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def webhook_id(self): + """Gets the webhook_id of this Notifications. # noqa: E501 + + + :return: The webhook_id of this Notifications. # noqa: E501 + :rtype: str + """ + return self._webhook_id + + @webhook_id.setter + def webhook_id(self, webhook_id): + """Sets the webhook_id of this Notifications. + + + :param webhook_id: The webhook_id of this Notifications. # noqa: E501 + :type: str + """ + + self._webhook_id = webhook_id + + @property + def audit_entry_id(self): + """Gets the audit_entry_id of this Notifications. # noqa: E501 + + + :return: The audit_entry_id of this Notifications. # noqa: E501 + :rtype: str + """ + return self._audit_entry_id + + @audit_entry_id.setter + def audit_entry_id(self, audit_entry_id): + """Sets the audit_entry_id of this Notifications. + + + :param audit_entry_id: The audit_entry_id of this Notifications. # noqa: E501 + :type: str + """ + + self._audit_entry_id = audit_entry_id + + @property + def entity_id(self): + """Gets the entity_id of this Notifications. # noqa: E501 + + + :return: The entity_id of this Notifications. # noqa: E501 + :rtype: str + """ + return self._entity_id + + @entity_id.setter + def entity_id(self, entity_id): + """Sets the entity_id of this Notifications. + + + :param entity_id: The entity_id of this Notifications. # noqa: E501 + :type: str + """ + if entity_id is None: + raise ValueError("Invalid value for `entity_id`, must not be `None`") # noqa: E501 + + self._entity_id = entity_id + + @property + def destination_url(self): + """Gets the destination_url of this Notifications. # noqa: E501 + + + :return: The destination_url of this Notifications. # noqa: E501 + :rtype: str + """ + return self._destination_url + + @destination_url.setter + def destination_url(self, destination_url): + """Sets the destination_url of this Notifications. + + + :param destination_url: The destination_url of this Notifications. # noqa: E501 + :type: str + """ + if destination_url is None: + raise ValueError("Invalid value for `destination_url`, must not be `None`") # noqa: E501 + + self._destination_url = destination_url + + @property + def format(self): + """Gets the format of this Notifications. # noqa: E501 + + + :return: The format of this Notifications. # noqa: E501 + :rtype: str + """ + return self._format + + @format.setter + def format(self, format): + """Sets the format of this Notifications. + + + :param format: The format of this Notifications. # noqa: E501 + :type: str + """ + if format is None: + raise ValueError("Invalid value for `format`, must not be `None`") # noqa: E501 + allowed_values = ["JSON", "XML"] # noqa: E501 + if format not in allowed_values: + raise ValueError( + "Invalid value for `format` ({0}), must be one of {1}" # noqa: E501 + .format(format, allowed_values) + ) + + self._format = format + + @property + def ack_enabled(self): + """Gets the ack_enabled of this Notifications. # noqa: E501 + + + :return: The ack_enabled of this Notifications. # noqa: E501 + :rtype: bool + """ + return self._ack_enabled + + @ack_enabled.setter + def ack_enabled(self, ack_enabled): + """Sets the ack_enabled of this Notifications. + + + :param ack_enabled: The ack_enabled of this Notifications. # noqa: E501 + :type: bool + """ + if ack_enabled is None: + raise ValueError("Invalid value for `ack_enabled`, must not be `None`") # noqa: E501 + + self._ack_enabled = ack_enabled + + @property + def entity(self): + """Gets the entity of this Notifications. # noqa: E501 + + + :return: The entity of this Notifications. # noqa: E501 + :rtype: list[str] + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this Notifications. + + + :param entity: The entity of this Notifications. # noqa: E501 + :type: list[str] + """ + + self._entity = entity + + @property + def changes(self): + """Gets the changes of this Notifications. # noqa: E501 + + + :return: The changes of this Notifications. # noqa: E501 + :rtype: list[str] + """ + return self._changes + + @changes.setter + def changes(self, changes): + """Sets the changes of this Notifications. + + + :param changes: The changes of this Notifications. # noqa: E501 + :type: list[str] + """ + + self._changes = changes + + @property + def last_send_attempt(self): + """Gets the last_send_attempt of this Notifications. # noqa: E501 + + + :return: The last_send_attempt of this Notifications. # noqa: E501 + :rtype: datetime + """ + return self._last_send_attempt + + @last_send_attempt.setter + def last_send_attempt(self, last_send_attempt): + """Sets the last_send_attempt of this Notifications. + + + :param last_send_attempt: The last_send_attempt of this Notifications. # noqa: E501 + :type: datetime + """ + + self._last_send_attempt = last_send_attempt + + @property + def next_send_attempt(self): + """Gets the next_send_attempt of this Notifications. # noqa: E501 + + + :return: The next_send_attempt of this Notifications. # noqa: E501 + :rtype: datetime + """ + return self._next_send_attempt + + @next_send_attempt.setter + def next_send_attempt(self, next_send_attempt): + """Sets the next_send_attempt of this Notifications. + + + :param next_send_attempt: The next_send_attempt of this Notifications. # noqa: E501 + :type: datetime + """ + + self._next_send_attempt = next_send_attempt + + @property + def final_send_attempt(self): + """Gets the final_send_attempt of this Notifications. # noqa: E501 + + + :return: The final_send_attempt of this Notifications. # noqa: E501 + :rtype: datetime + """ + return self._final_send_attempt + + @final_send_attempt.setter + def final_send_attempt(self, final_send_attempt): + """Sets the final_send_attempt of this Notifications. + + + :param final_send_attempt: The final_send_attempt of this Notifications. # noqa: E501 + :type: datetime + """ + + self._final_send_attempt = final_send_attempt + + @property + def total_send_attempts(self): + """Gets the total_send_attempts of this Notifications. # noqa: E501 + + + :return: The total_send_attempts of this Notifications. # noqa: E501 + :rtype: int + """ + return self._total_send_attempts + + @total_send_attempts.setter + def total_send_attempts(self, total_send_attempts): + """Sets the total_send_attempts of this Notifications. + + + :param total_send_attempts: The total_send_attempts of this Notifications. # noqa: E501 + :type: int + """ + + self._total_send_attempts = total_send_attempts + + @property + def state(self): + """Gets the state of this Notifications. # noqa: E501 + + + :return: The state of this Notifications. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this Notifications. + + + :param state: The state of this Notifications. # noqa: E501 + :type: str + """ + if state is None: + raise ValueError("Invalid value for `state`, must not be `None`") # noqa: E501 + allowed_values = ["Unsent", "Sending", "Sent", "Voided"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def acked(self): + """Gets the acked of this Notifications. # noqa: E501 + + + :return: The acked of this Notifications. # noqa: E501 + :rtype: datetime + """ + return self._acked + + @acked.setter + def acked(self, acked): + """Sets the acked of this Notifications. + + + :param acked: The acked of this Notifications. # noqa: E501 + :type: datetime + """ + + self._acked = acked + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(Notifications, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, Notifications): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/o_auth_token.py b/billforward/models/o_auth_token.py new file mode 100644 index 0000000..61914ca --- /dev/null +++ b/billforward/models/o_auth_token.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class OAuthToken(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'access_token': 'str', + 'refresh_token': 'str' + } + + attribute_map = { + 'access_token': 'accessToken', + 'refresh_token': 'refreshToken' + } + + def __init__(self, access_token=None, refresh_token=None): # noqa: E501 + """OAuthToken - a model defined in Swagger""" # noqa: E501 + self._access_token = None + self._refresh_token = None + self.discriminator = None + if access_token is not None: + self.access_token = access_token + if refresh_token is not None: + self.refresh_token = refresh_token + + @property + def access_token(self): + """Gets the access_token of this OAuthToken. # noqa: E501 + + + :return: The access_token of this OAuthToken. # noqa: E501 + :rtype: str + """ + return self._access_token + + @access_token.setter + def access_token(self, access_token): + """Sets the access_token of this OAuthToken. + + + :param access_token: The access_token of this OAuthToken. # noqa: E501 + :type: str + """ + + self._access_token = access_token + + @property + def refresh_token(self): + """Gets the refresh_token of this OAuthToken. # noqa: E501 + + + :return: The refresh_token of this OAuthToken. # noqa: E501 + :rtype: str + """ + return self._refresh_token + + @refresh_token.setter + def refresh_token(self, refresh_token): + """Sets the refresh_token of this OAuthToken. + + + :param refresh_token: The refresh_token of this OAuthToken. # noqa: E501 + :type: str + """ + + self._refresh_token = refresh_token + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(OAuthToken, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, OAuthToken): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/offline_payment.py b/billforward/models/offline_payment.py new file mode 100644 index 0000000..5d92bbe --- /dev/null +++ b/billforward/models/offline_payment.py @@ -0,0 +1,200 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class OfflinePayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'reference': 'str', + 'description': 'str', + 'name': 'str', + 'offline_payment_type': 'str' + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + 'reference': 'reference', + 'description': 'description', + 'name': 'name', + 'offline_payment_type': 'offlinePaymentType' + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, reference=None, description=None, name=None, offline_payment_type=None, *args, **kwargs): # noqa: E501 + """OfflinePayment - a model defined in Swagger""" # noqa: E501 + self._reference = None + self._description = None + self._name = None + self._offline_payment_type = None + self.discriminator = None + if reference is not None: + self.reference = reference + if description is not None: + self.description = description + if name is not None: + self.name = name + if offline_payment_type is not None: + self.offline_payment_type = offline_payment_type + Payment.__init__(self, *args, **kwargs) + + @property + def reference(self): + """Gets the reference of this OfflinePayment. # noqa: E501 + + + :return: The reference of this OfflinePayment. # noqa: E501 + :rtype: str + """ + return self._reference + + @reference.setter + def reference(self, reference): + """Sets the reference of this OfflinePayment. + + + :param reference: The reference of this OfflinePayment. # noqa: E501 + :type: str + """ + + self._reference = reference + + @property + def description(self): + """Gets the description of this OfflinePayment. # noqa: E501 + + + :return: The description of this OfflinePayment. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this OfflinePayment. + + + :param description: The description of this OfflinePayment. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def name(self): + """Gets the name of this OfflinePayment. # noqa: E501 + + + :return: The name of this OfflinePayment. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this OfflinePayment. + + + :param name: The name of this OfflinePayment. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def offline_payment_type(self): + """Gets the offline_payment_type of this OfflinePayment. # noqa: E501 + + + :return: The offline_payment_type of this OfflinePayment. # noqa: E501 + :rtype: str + """ + return self._offline_payment_type + + @offline_payment_type.setter + def offline_payment_type(self, offline_payment_type): + """Sets the offline_payment_type of this OfflinePayment. + + + :param offline_payment_type: The offline_payment_type of this OfflinePayment. # noqa: E501 + :type: str + """ + allowed_values = ["WireTransfer", "Check", "Cash", "Other", "Prepayment"] # noqa: E501 + if offline_payment_type not in allowed_values: + raise ValueError( + "Invalid value for `offline_payment_type` ({0}), must be one of {1}" # noqa: E501 + .format(offline_payment_type, allowed_values) + ) + + self._offline_payment_type = offline_payment_type + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(OfflinePayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, OfflinePayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/open_id_registration_response.py b/billforward/models/open_id_registration_response.py new file mode 100644 index 0000000..5163adf --- /dev/null +++ b/billforward/models/open_id_registration_response.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class OpenIDRegistrationResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, organization_id=None): # noqa: E501 + """OpenIDRegistrationResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this OpenIDRegistrationResponse. # noqa: E501 + + + :return: The created of this OpenIDRegistrationResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this OpenIDRegistrationResponse. + + + :param created: The created of this OpenIDRegistrationResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this OpenIDRegistrationResponse. # noqa: E501 + + + :return: The organization_id of this OpenIDRegistrationResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this OpenIDRegistrationResponse. + + + :param organization_id: The organization_id of this OpenIDRegistrationResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(OpenIDRegistrationResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, OpenIDRegistrationResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/open_id_user_link_request.py b/billforward/models/open_id_user_link_request.py new file mode 100644 index 0000000..5db9ec1 --- /dev/null +++ b/billforward/models/open_id_user_link_request.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class OpenIdUserLinkRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'provider': 'str', + 'password_reset_code': 'str', + 'id_token': 'str' + } + + attribute_map = { + 'provider': 'provider', + 'password_reset_code': 'passwordResetCode', + 'id_token': 'idToken' + } + + def __init__(self, provider=None, password_reset_code=None, id_token=None): # noqa: E501 + """OpenIdUserLinkRequest - a model defined in Swagger""" # noqa: E501 + self._provider = None + self._password_reset_code = None + self._id_token = None + self.discriminator = None + if provider is not None: + self.provider = provider + if password_reset_code is not None: + self.password_reset_code = password_reset_code + if id_token is not None: + self.id_token = id_token + + @property + def provider(self): + """Gets the provider of this OpenIdUserLinkRequest. # noqa: E501 + + + :return: The provider of this OpenIdUserLinkRequest. # noqa: E501 + :rtype: str + """ + return self._provider + + @provider.setter + def provider(self, provider): + """Sets the provider of this OpenIdUserLinkRequest. + + + :param provider: The provider of this OpenIdUserLinkRequest. # noqa: E501 + :type: str + """ + + self._provider = provider + + @property + def password_reset_code(self): + """Gets the password_reset_code of this OpenIdUserLinkRequest. # noqa: E501 + + + :return: The password_reset_code of this OpenIdUserLinkRequest. # noqa: E501 + :rtype: str + """ + return self._password_reset_code + + @password_reset_code.setter + def password_reset_code(self, password_reset_code): + """Sets the password_reset_code of this OpenIdUserLinkRequest. + + + :param password_reset_code: The password_reset_code of this OpenIdUserLinkRequest. # noqa: E501 + :type: str + """ + + self._password_reset_code = password_reset_code + + @property + def id_token(self): + """Gets the id_token of this OpenIdUserLinkRequest. # noqa: E501 + + + :return: The id_token of this OpenIdUserLinkRequest. # noqa: E501 + :rtype: str + """ + return self._id_token + + @id_token.setter + def id_token(self, id_token): + """Sets the id_token of this OpenIdUserLinkRequest. + + + :param id_token: The id_token of this OpenIdUserLinkRequest. # noqa: E501 + :type: str + """ + + self._id_token = id_token + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(OpenIdUserLinkRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, OpenIdUserLinkRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/organization.py b/billforward/models/organization.py deleted file mode 100644 index 032bdc7..0000000 --- a/billforward/models/organization.py +++ /dev/null @@ -1,462 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class Organization(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, customer_code=None, name=None, deleted=False, webhooks=None, alias=None, clients=None, dunning_lines=None, taxation_strategies=None, organization_gateways=None, api_configurations=None): - """ - Organization - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'customer_code': 'str', - 'name': 'str', - 'deleted': 'bool', - 'webhooks': 'list[MutableBillingEntity]', - 'alias': 'list[Alias]', - 'clients': 'list[Client]', - 'dunning_lines': 'list[DunningLine]', - 'taxation_strategies': 'list[MutableBillingEntity]', - 'organization_gateways': 'list[MutableBillingEntity]', - 'api_configurations': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'customer_code': 'customerCode', - 'name': 'name', - 'deleted': 'deleted', - 'webhooks': 'webhooks', - 'alias': 'alias', - 'clients': 'clients', - 'dunning_lines': 'dunningLines', - 'taxation_strategies': 'taxationStrategies', - 'organization_gateways': 'organizationGateways', - 'api_configurations': 'apiConfigurations' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._customer_code = customer_code - self._name = name - self._deleted = deleted - self._webhooks = webhooks - self._alias = alias - self._clients = clients - self._dunning_lines = dunning_lines - self._taxation_strategies = taxation_strategies - self._organization_gateways = organization_gateways - self._api_configurations = api_configurations - - @property - def created(self): - """ - Gets the created of this Organization. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this Organization. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this Organization. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this Organization. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this Organization. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this Organization. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this Organization. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this Organization. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this Organization. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this Organization. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this Organization. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this Organization. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this Organization. - { \"description\" : \"ID of the organization.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this Organization. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this Organization. - { \"description\" : \"ID of the organization.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this Organization. - :type: str - """ - - self._id = id - - @property - def customer_code(self): - """ - Gets the customer_code of this Organization. - { \"description\" : \"A shortcode for the organization. This is used as a short reference code for use when referring to the organization, by default this is set to the organizations name.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The customer_code of this Organization. - :rtype: str - """ - return self._customer_code - - @customer_code.setter - def customer_code(self, customer_code): - """ - Sets the customer_code of this Organization. - { \"description\" : \"A shortcode for the organization. This is used as a short reference code for use when referring to the organization, by default this is set to the organizations name.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param customer_code: The customer_code of this Organization. - :type: str - """ - - self._customer_code = customer_code - - @property - def name(self): - """ - Gets the name of this Organization. - { \"description\" : \"The name of the organization.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The name of this Organization. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this Organization. - { \"description\" : \"The name of the organization.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param name: The name of this Organization. - :type: str - """ - - self._name = name - - @property - def deleted(self): - """ - Gets the deleted of this Organization. - { \"description\" : \"Indicates if an organization has been retired. If an organization has been retired it can still be retrieved using the appropriate flag on API requests.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The deleted of this Organization. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this Organization. - { \"description\" : \"Indicates if an organization has been retired. If an organization has been retired it can still be retrieved using the appropriate flag on API requests.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param deleted: The deleted of this Organization. - :type: bool - """ - - self._deleted = deleted - - @property - def webhooks(self): - """ - Gets the webhooks of this Organization. - { \"description\" : \"The WebHooks associated with the organization. These are the end-points where notifications are sent. WebHooks are added, updated and removed from the organization. Thus to add a WebHook, the webhook must be defined on this property of the organization and then the organization updated. To update a WebHook the same procedure must be followed, first retrieving the organization followed by updating the appropriate WebHook, finally the organization is updated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The webhooks of this Organization. - :rtype: list[MutableBillingEntity] - """ - return self._webhooks - - @webhooks.setter - def webhooks(self, webhooks): - """ - Sets the webhooks of this Organization. - { \"description\" : \"The WebHooks associated with the organization. These are the end-points where notifications are sent. WebHooks are added, updated and removed from the organization. Thus to add a WebHook, the webhook must be defined on this property of the organization and then the organization updated. To update a WebHook the same procedure must be followed, first retrieving the organization followed by updating the appropriate WebHook, finally the organization is updated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param webhooks: The webhooks of this Organization. - :type: list[MutableBillingEntity] - """ - - self._webhooks = webhooks - - @property - def alias(self): - """ - Gets the alias of this Organization. - - - :return: The alias of this Organization. - :rtype: list[Alias] - """ - return self._alias - - @alias.setter - def alias(self, alias): - """ - Sets the alias of this Organization. - - - :param alias: The alias of this Organization. - :type: list[Alias] - """ - - self._alias = alias - - @property - def clients(self): - """ - Gets the clients of this Organization. - { \"description\" : \"The OAuth2 clients associated with the organization. In most cases an organization would not have any clients associated with their account. In the case of an APP developer, a clients would exist per an application they have developed. To further understand clients please see the client, OAuth2 API and APP development documentation.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The clients of this Organization. - :rtype: list[Client] - """ - return self._clients - - @clients.setter - def clients(self, clients): - """ - Sets the clients of this Organization. - { \"description\" : \"The OAuth2 clients associated with the organization. In most cases an organization would not have any clients associated with their account. In the case of an APP developer, a clients would exist per an application they have developed. To further understand clients please see the client, OAuth2 API and APP development documentation.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param clients: The clients of this Organization. - :type: list[Client] - """ - - self._clients = clients - - @property - def dunning_lines(self): - """ - Gets the dunning_lines of this Organization. - { \"description\" : \"The dunning-lines associated with the organization. Dunning lines are used as re-try logic for invoices to attempt to reconcile the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The dunning_lines of this Organization. - :rtype: list[DunningLine] - """ - return self._dunning_lines - - @dunning_lines.setter - def dunning_lines(self, dunning_lines): - """ - Sets the dunning_lines of this Organization. - { \"description\" : \"The dunning-lines associated with the organization. Dunning lines are used as re-try logic for invoices to attempt to reconcile the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param dunning_lines: The dunning_lines of this Organization. - :type: list[DunningLine] - """ - - self._dunning_lines = dunning_lines - - @property - def taxation_strategies(self): - """ - Gets the taxation_strategies of this Organization. - { \"description\" : \"The taxation-strategies associated with the organization. Taxation-strategies may be linked to product-rate-plans to specify how their tax should be calculated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The taxation_strategies of this Organization. - :rtype: list[MutableBillingEntity] - """ - return self._taxation_strategies - - @taxation_strategies.setter - def taxation_strategies(self, taxation_strategies): - """ - Sets the taxation_strategies of this Organization. - { \"description\" : \"The taxation-strategies associated with the organization. Taxation-strategies may be linked to product-rate-plans to specify how their tax should be calculated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param taxation_strategies: The taxation_strategies of this Organization. - :type: list[MutableBillingEntity] - """ - - self._taxation_strategies = taxation_strategies - - @property - def organization_gateways(self): - """ - Gets the organization_gateways of this Organization. - { \"description\" : \"The card-vault gateways associated with the organization.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_gateways of this Organization. - :rtype: list[MutableBillingEntity] - """ - return self._organization_gateways - - @organization_gateways.setter - def organization_gateways(self, organization_gateways): - """ - Sets the organization_gateways of this Organization. - { \"description\" : \"The card-vault gateways associated with the organization.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_gateways: The organization_gateways of this Organization. - :type: list[MutableBillingEntity] - """ - - self._organization_gateways = organization_gateways - - @property - def api_configurations(self): - """ - Gets the api_configurations of this Organization. - { \"description\" : \"Stores the organizations 3rd party API keys which may be used by the system for payment gateway integration etc.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The api_configurations of this Organization. - :rtype: list[MutableBillingEntity] - """ - return self._api_configurations - - @api_configurations.setter - def api_configurations(self, api_configurations): - """ - Sets the api_configurations of this Organization. - { \"description\" : \"Stores the organizations 3rd party API keys which may be used by the system for payment gateway integration etc.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param api_configurations: The api_configurations of this Organization. - :type: list[MutableBillingEntity] - """ - - self._api_configurations = api_configurations - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/organization_lite_view.py b/billforward/models/organization_lite_view.py new file mode 100644 index 0000000..23f7274 --- /dev/null +++ b/billforward/models/organization_lite_view.py @@ -0,0 +1,240 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class OrganizationLiteView(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'id': 'str', + 'customer_code': 'str', + 'name': 'str', + 'deleted': 'bool', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'id': 'id', + 'customer_code': 'customerCode', + 'name': 'name', + 'deleted': 'deleted', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, id=None, customer_code=None, name=None, deleted=None, organization_id=None): # noqa: E501 + """OrganizationLiteView - a model defined in Swagger""" # noqa: E501 + self._created = None + self._id = None + self._customer_code = None + self._name = None + self._deleted = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if id is not None: + self.id = id + if customer_code is not None: + self.customer_code = customer_code + if name is not None: + self.name = name + if deleted is not None: + self.deleted = deleted + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this OrganizationLiteView. # noqa: E501 + + + :return: The created of this OrganizationLiteView. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this OrganizationLiteView. + + + :param created: The created of this OrganizationLiteView. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def id(self): + """Gets the id of this OrganizationLiteView. # noqa: E501 + + + :return: The id of this OrganizationLiteView. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this OrganizationLiteView. + + + :param id: The id of this OrganizationLiteView. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def customer_code(self): + """Gets the customer_code of this OrganizationLiteView. # noqa: E501 + + + :return: The customer_code of this OrganizationLiteView. # noqa: E501 + :rtype: str + """ + return self._customer_code + + @customer_code.setter + def customer_code(self, customer_code): + """Sets the customer_code of this OrganizationLiteView. + + + :param customer_code: The customer_code of this OrganizationLiteView. # noqa: E501 + :type: str + """ + + self._customer_code = customer_code + + @property + def name(self): + """Gets the name of this OrganizationLiteView. # noqa: E501 + + + :return: The name of this OrganizationLiteView. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this OrganizationLiteView. + + + :param name: The name of this OrganizationLiteView. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def deleted(self): + """Gets the deleted of this OrganizationLiteView. # noqa: E501 + + + :return: The deleted of this OrganizationLiteView. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this OrganizationLiteView. + + + :param deleted: The deleted of this OrganizationLiteView. # noqa: E501 + :type: bool + """ + + self._deleted = deleted + + @property + def organization_id(self): + """Gets the organization_id of this OrganizationLiteView. # noqa: E501 + + + :return: The organization_id of this OrganizationLiteView. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this OrganizationLiteView. + + + :param organization_id: The organization_id of this OrganizationLiteView. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(OrganizationLiteView, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, OrganizationLiteView): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/organization_paged_metadata.py b/billforward/models/organization_paged_metadata.py deleted file mode 100644 index f56b5f2..0000000 --- a/billforward/models/organization_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class OrganizationPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - OrganizationPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Organization]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this OrganizationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this OrganizationPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this OrganizationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this OrganizationPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this OrganizationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this OrganizationPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this OrganizationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this OrganizationPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this OrganizationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this OrganizationPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this OrganizationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this OrganizationPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this OrganizationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this OrganizationPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this OrganizationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this OrganizationPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this OrganizationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this OrganizationPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this OrganizationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this OrganizationPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this OrganizationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this OrganizationPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this OrganizationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this OrganizationPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this OrganizationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this OrganizationPagedMetadata. - :rtype: list[Organization] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this OrganizationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this OrganizationPagedMetadata. - :type: list[Organization] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/password.py b/billforward/models/password.py index f32a46a..9c693af 100644 --- a/billforward/models/password.py +++ b/billforward/models/password.py @@ -1,91 +1,89 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class Password(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, id=None, user_id=None, organization_id=None, password=None, active=False): - """ - Password - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'id': 'str', - 'user_id': 'str', - 'organization_id': 'str', - 'password': 'str', - 'active': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'id': 'id', - 'user_id': 'userID', - 'organization_id': 'organizationID', - 'password': 'password', - 'active': 'active' - } - - self._created = created - self._changed_by = changed_by - self._id = id - self._user_id = user_id - self._organization_id = organization_id - self._password = password - self._active = active + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'id': 'str', + 'user_id': 'str', + 'organization_id': 'str', + 'password': 'str', + 'active': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'id': 'id', + 'user_id': 'userID', + 'organization_id': 'organizationID', + 'password': 'password', + 'active': 'active' + } + + def __init__(self, created=None, changed_by=None, id=None, user_id=None, organization_id=None, password=None, active=None): # noqa: E501 + """Password - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._id = None + self._user_id = None + self._organization_id = None + self._password = None + self._active = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if id is not None: + self.id = id + self.user_id = user_id + self.organization_id = organization_id + self.password = password + self.active = active @property def created(self): - """ - Gets the created of this Password. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this Password. # noqa: E501 - :return: The created of this Password. + + :return: The created of this Password. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this Password. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this Password. + - :param created: The created of this Password. + :param created: The created of this Password. # noqa: E501 :type: datetime """ @@ -93,22 +91,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this Password. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this Password. # noqa: E501 + - :return: The changed_by of this Password. + :return: The changed_by of this Password. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this Password. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this Password. + - :param changed_by: The changed_by of this Password. + :param changed_by: The changed_by of this Password. # noqa: E501 :type: str """ @@ -116,22 +112,20 @@ def changed_by(self, changed_by): @property def id(self): - """ - Gets the id of this Password. - { \"description\" : \"ID of the password.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the id of this Password. # noqa: E501 + - :return: The id of this Password. + :return: The id of this Password. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this Password. - { \"description\" : \"ID of the password.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the id of this Password. - :param id: The id of this Password. + + :param id: The id of this Password. # noqa: E501 :type: str """ @@ -139,103 +133,101 @@ def id(self, id): @property def user_id(self): - """ - Gets the user_id of this Password. - { \"description\" : \"ID of the user associated with the password.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the user_id of this Password. # noqa: E501 - :return: The user_id of this Password. + + :return: The user_id of this Password. # noqa: E501 :rtype: str """ return self._user_id @user_id.setter def user_id(self, user_id): - """ - Sets the user_id of this Password. - { \"description\" : \"ID of the user associated with the password.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the user_id of this Password. - :param user_id: The user_id of this Password. + + :param user_id: The user_id of this Password. # noqa: E501 :type: str """ + if user_id is None: + raise ValueError("Invalid value for `user_id`, must not be `None`") # noqa: E501 self._user_id = user_id @property def organization_id(self): - """ - Gets the organization_id of this Password. - { \"description\" : \"Organization associated with the user\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the organization_id of this Password. # noqa: E501 + - :return: The organization_id of this Password. + :return: The organization_id of this Password. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this Password. - { \"description\" : \"Organization associated with the user\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the organization_id of this Password. + - :param organization_id: The organization_id of this Password. + :param organization_id: The organization_id of this Password. # noqa: E501 :type: str """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 self._organization_id = organization_id @property def password(self): - """ - Gets the password of this Password. - { \"description\" : \"The password.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the password of this Password. # noqa: E501 + - :return: The password of this Password. + :return: The password of this Password. # noqa: E501 :rtype: str """ return self._password @password.setter def password(self, password): - """ - Sets the password of this Password. - { \"description\" : \"The password.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the password of this Password. + - :param password: The password of this Password. + :param password: The password of this Password. # noqa: E501 :type: str """ + if password is None: + raise ValueError("Invalid value for `password`, must not be `None`") # noqa: E501 self._password = password @property def active(self): - """ - Gets the active of this Password. - { \"description\" : \"Is this the active password.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the active of this Password. # noqa: E501 - :return: The active of this Password. + + :return: The active of this Password. # noqa: E501 :rtype: bool """ return self._active @active.setter def active(self, active): - """ - Sets the active of this Password. - { \"description\" : \"Is this the active password.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the active of this Password. - :param active: The active of this Password. + + :param active: The active of this Password. # noqa: E501 :type: bool """ + if active is None: + raise ValueError("Invalid value for `active`, must not be `None`") # noqa: E501 self._active = active def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -252,29 +244,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Password, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Password): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/password_paged_metadata.py b/billforward/models/password_paged_metadata.py deleted file mode 100644 index a6d1464..0000000 --- a/billforward/models/password_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PasswordPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - PasswordPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Password]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this PasswordPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this PasswordPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this PasswordPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this PasswordPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this PasswordPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this PasswordPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this PasswordPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this PasswordPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this PasswordPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this PasswordPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this PasswordPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this PasswordPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this PasswordPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this PasswordPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this PasswordPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this PasswordPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this PasswordPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this PasswordPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this PasswordPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this PasswordPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this PasswordPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this PasswordPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this PasswordPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this PasswordPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this PasswordPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this PasswordPagedMetadata. - :rtype: list[Password] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this PasswordPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this PasswordPagedMetadata. - :type: list[Password] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/password_reset_code_request.py b/billforward/models/password_reset_code_request.py new file mode 100644 index 0000000..c172f49 --- /dev/null +++ b/billforward/models/password_reset_code_request.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PasswordResetCodeRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'email': 'str' + } + + attribute_map = { + 'email': 'email' + } + + def __init__(self, email=None): # noqa: E501 + """PasswordResetCodeRequest - a model defined in Swagger""" # noqa: E501 + self._email = None + self.discriminator = None + if email is not None: + self.email = email + + @property + def email(self): + """Gets the email of this PasswordResetCodeRequest. # noqa: E501 + + + :return: The email of this PasswordResetCodeRequest. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this PasswordResetCodeRequest. + + + :param email: The email of this PasswordResetCodeRequest. # noqa: E501 + :type: str + """ + + self._email = email + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PasswordResetCodeRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PasswordResetCodeRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/password_reset_request.py b/billforward/models/password_reset_request.py deleted file mode 100644 index b9170bf..0000000 --- a/billforward/models/password_reset_request.py +++ /dev/null @@ -1,124 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PasswordResetRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, email=None): - """ - PasswordResetRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'email': 'str' - } - - self.attribute_map = { - 'email': 'email' - } - - self._email = email - - @property - def email(self): - """ - Gets the email of this PasswordResetRequest. - {\"description\":\"Login E-mail address of the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The email of this PasswordResetRequest. - :rtype: str - """ - return self._email - - @email.setter - def email(self, email): - """ - Sets the email of this PasswordResetRequest. - {\"description\":\"Login E-mail address of the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param email: The email of this PasswordResetRequest. - :type: str - """ - - self._email = email - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/password_reset_response.py b/billforward/models/password_reset_response.py new file mode 100644 index 0000000..516ce22 --- /dev/null +++ b/billforward/models/password_reset_response.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PasswordResetResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'password_reset_valid_till': 'datetime', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'password_reset_valid_till': 'passwordResetValidTill', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, password_reset_valid_till=None, organization_id=None): # noqa: E501 + """PasswordResetResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._password_reset_valid_till = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if password_reset_valid_till is not None: + self.password_reset_valid_till = password_reset_valid_till + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this PasswordResetResponse. # noqa: E501 + + + :return: The created of this PasswordResetResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this PasswordResetResponse. + + + :param created: The created of this PasswordResetResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def password_reset_valid_till(self): + """Gets the password_reset_valid_till of this PasswordResetResponse. # noqa: E501 + + + :return: The password_reset_valid_till of this PasswordResetResponse. # noqa: E501 + :rtype: datetime + """ + return self._password_reset_valid_till + + @password_reset_valid_till.setter + def password_reset_valid_till(self, password_reset_valid_till): + """Sets the password_reset_valid_till of this PasswordResetResponse. + + + :param password_reset_valid_till: The password_reset_valid_till of this PasswordResetResponse. # noqa: E501 + :type: datetime + """ + + self._password_reset_valid_till = password_reset_valid_till + + @property + def organization_id(self): + """Gets the organization_id of this PasswordResetResponse. # noqa: E501 + + + :return: The organization_id of this PasswordResetResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this PasswordResetResponse. + + + :param organization_id: The organization_id of this PasswordResetResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PasswordResetResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PasswordResetResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/password_update_with_reset_code_request.py b/billforward/models/password_update_with_reset_code_request.py new file mode 100644 index 0000000..c28adc5 --- /dev/null +++ b/billforward/models/password_update_with_reset_code_request.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PasswordUpdateWithResetCodeRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'password_reset_code': 'str', + 'new_password': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'password_reset_code': 'passwordResetCode', + 'new_password': 'newPassword' + } + + def __init__(self, created=None, organization_id=None, password_reset_code=None, new_password=None): # noqa: E501 + """PasswordUpdateWithResetCodeRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._password_reset_code = None + self._new_password = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if password_reset_code is not None: + self.password_reset_code = password_reset_code + if new_password is not None: + self.new_password = new_password + + @property + def created(self): + """Gets the created of this PasswordUpdateWithResetCodeRequest. # noqa: E501 + + + :return: The created of this PasswordUpdateWithResetCodeRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this PasswordUpdateWithResetCodeRequest. + + + :param created: The created of this PasswordUpdateWithResetCodeRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this PasswordUpdateWithResetCodeRequest. # noqa: E501 + + + :return: The organization_id of this PasswordUpdateWithResetCodeRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this PasswordUpdateWithResetCodeRequest. + + + :param organization_id: The organization_id of this PasswordUpdateWithResetCodeRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def password_reset_code(self): + """Gets the password_reset_code of this PasswordUpdateWithResetCodeRequest. # noqa: E501 + + + :return: The password_reset_code of this PasswordUpdateWithResetCodeRequest. # noqa: E501 + :rtype: str + """ + return self._password_reset_code + + @password_reset_code.setter + def password_reset_code(self, password_reset_code): + """Sets the password_reset_code of this PasswordUpdateWithResetCodeRequest. + + + :param password_reset_code: The password_reset_code of this PasswordUpdateWithResetCodeRequest. # noqa: E501 + :type: str + """ + + self._password_reset_code = password_reset_code + + @property + def new_password(self): + """Gets the new_password of this PasswordUpdateWithResetCodeRequest. # noqa: E501 + + + :return: The new_password of this PasswordUpdateWithResetCodeRequest. # noqa: E501 + :rtype: str + """ + return self._new_password + + @new_password.setter + def new_password(self, new_password): + """Sets the new_password of this PasswordUpdateWithResetCodeRequest. + + + :param new_password: The new_password of this PasswordUpdateWithResetCodeRequest. # noqa: E501 + :type: str + """ + + self._new_password = new_password + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PasswordUpdateWithResetCodeRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PasswordUpdateWithResetCodeRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/pause_request.py b/billforward/models/pause_request.py index 150850f..060ea13 100644 --- a/billforward/models/pause_request.py +++ b/billforward/models/pause_request.py @@ -1,76 +1,93 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class PauseRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, resume=None): - """ - PauseRequest - a model defined in Swagger + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'resume': 'datetime', + 'new_subscription_start': 'datetime', + 'new_subscription_state': 'str', + 'organization_id': 'str', + 'subscription_id': 'str', + 'dry_run': 'bool' + } - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'resume': 'datetime' - } + attribute_map = { + 'created': 'created', + 'resume': 'resume', + 'new_subscription_start': 'newSubscriptionStart', + 'new_subscription_state': 'newSubscriptionState', + 'organization_id': 'organizationID', + 'subscription_id': 'subscriptionID', + 'dry_run': 'dryRun' + } - self.attribute_map = { - 'created': 'created', - 'resume': 'resume' - } - - self._created = created - self._resume = resume + def __init__(self, created=None, resume=None, new_subscription_start=None, new_subscription_state=None, organization_id=None, subscription_id=None, dry_run=None): # noqa: E501 + """PauseRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._resume = None + self._new_subscription_start = None + self._new_subscription_state = None + self._organization_id = None + self._subscription_id = None + self._dry_run = None + self.discriminator = None + if created is not None: + self.created = created + if resume is not None: + self.resume = resume + if new_subscription_start is not None: + self.new_subscription_start = new_subscription_start + if new_subscription_state is not None: + self.new_subscription_state = new_subscription_state + if organization_id is not None: + self.organization_id = organization_id + if subscription_id is not None: + self.subscription_id = subscription_id + if dry_run is not None: + self.dry_run = dry_run @property def created(self): - """ - Gets the created of this PauseRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this PauseRequest. # noqa: E501 + - :return: The created of this PauseRequest. + :return: The created of this PauseRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this PauseRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this PauseRequest. + - :param created: The created of this PauseRequest. + :param created: The created of this PauseRequest. # noqa: E501 :type: datetime """ @@ -78,34 +95,141 @@ def created(self, created): @property def resume(self): - """ - Gets the resume of this PauseRequest. - {\"default\":\"(No resumption is scheduled)\",\"description\":\"Schedules the frozen subscription to resume at some time.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the resume of this PauseRequest. # noqa: E501 + - :return: The resume of this PauseRequest. + :return: The resume of this PauseRequest. # noqa: E501 :rtype: datetime """ return self._resume @resume.setter def resume(self, resume): - """ - Sets the resume of this PauseRequest. - {\"default\":\"(No resumption is scheduled)\",\"description\":\"Schedules the frozen subscription to resume at some time.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the resume of this PauseRequest. - :param resume: The resume of this PauseRequest. + + :param resume: The resume of this PauseRequest. # noqa: E501 :type: datetime """ self._resume = resume - def to_dict(self): + @property + def new_subscription_start(self): + """Gets the new_subscription_start of this PauseRequest. # noqa: E501 + + + :return: The new_subscription_start of this PauseRequest. # noqa: E501 + :rtype: datetime + """ + return self._new_subscription_start + + @new_subscription_start.setter + def new_subscription_start(self, new_subscription_start): + """Sets the new_subscription_start of this PauseRequest. + + + :param new_subscription_start: The new_subscription_start of this PauseRequest. # noqa: E501 + :type: datetime + """ + + self._new_subscription_start = new_subscription_start + + @property + def new_subscription_state(self): + """Gets the new_subscription_state of this PauseRequest. # noqa: E501 + + + :return: The new_subscription_state of this PauseRequest. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._new_subscription_state + + @new_subscription_state.setter + def new_subscription_state(self, new_subscription_state): + """Sets the new_subscription_state of this PauseRequest. + + + :param new_subscription_state: The new_subscription_state of this PauseRequest. # noqa: E501 + :type: str """ + allowed_values = ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"] # noqa: E501 + if new_subscription_state not in allowed_values: + raise ValueError( + "Invalid value for `new_subscription_state` ({0}), must be one of {1}" # noqa: E501 + .format(new_subscription_state, allowed_values) + ) + + self._new_subscription_state = new_subscription_state + + @property + def organization_id(self): + """Gets the organization_id of this PauseRequest. # noqa: E501 + + + :return: The organization_id of this PauseRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this PauseRequest. + + + :param organization_id: The organization_id of this PauseRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def subscription_id(self): + """Gets the subscription_id of this PauseRequest. # noqa: E501 + + + :return: The subscription_id of this PauseRequest. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this PauseRequest. + + + :param subscription_id: The subscription_id of this PauseRequest. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def dry_run(self): + """Gets the dry_run of this PauseRequest. # noqa: E501 + + + :return: The dry_run of this PauseRequest. # noqa: E501 + :rtype: bool + """ + return self._dry_run + + @dry_run.setter + def dry_run(self, dry_run): + """Sets the dry_run of this PauseRequest. + + + :param dry_run: The dry_run of this PauseRequest. # noqa: E501 + :type: bool + """ + + self._dry_run = dry_run + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -122,29 +246,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(PauseRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, PauseRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/pay_vision_auth_capture_request.py b/billforward/models/pay_vision_auth_capture_request.py new file mode 100644 index 0000000..7999580 --- /dev/null +++ b/billforward/models/pay_vision_auth_capture_request.py @@ -0,0 +1,144 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.auth_capture_request import AuthCaptureRequest # noqa: F401,E501 + +class PayVisionAuthCaptureRequest(AuthCaptureRequest): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'registration_id': 'str', + 'registration_resource_path': 'str' + } + if hasattr(AuthCaptureRequest, "swagger_types"): + swagger_types.update(AuthCaptureRequest.swagger_types) + + attribute_map = { + 'registration_id': 'registrationID', + 'registration_resource_path': 'registrationResourcePath' + } + if hasattr(AuthCaptureRequest, "attribute_map"): + attribute_map.update(AuthCaptureRequest.attribute_map) + + def __init__(self, registration_id=None, registration_resource_path=None, *args, **kwargs): # noqa: E501 + """PayVisionAuthCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._registration_id = None + self._registration_resource_path = None + self.discriminator = None + self.registration_id = registration_id + self.registration_resource_path = registration_resource_path + AuthCaptureRequest.__init__(self, *args, **kwargs) + + @property + def registration_id(self): + """Gets the registration_id of this PayVisionAuthCaptureRequest. # noqa: E501 + + + :return: The registration_id of this PayVisionAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._registration_id + + @registration_id.setter + def registration_id(self, registration_id): + """Sets the registration_id of this PayVisionAuthCaptureRequest. + + + :param registration_id: The registration_id of this PayVisionAuthCaptureRequest. # noqa: E501 + :type: str + """ + if registration_id is None: + raise ValueError("Invalid value for `registration_id`, must not be `None`") # noqa: E501 + + self._registration_id = registration_id + + @property + def registration_resource_path(self): + """Gets the registration_resource_path of this PayVisionAuthCaptureRequest. # noqa: E501 + + + :return: The registration_resource_path of this PayVisionAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._registration_resource_path + + @registration_resource_path.setter + def registration_resource_path(self, registration_resource_path): + """Sets the registration_resource_path of this PayVisionAuthCaptureRequest. + + + :param registration_resource_path: The registration_resource_path of this PayVisionAuthCaptureRequest. # noqa: E501 + :type: str + """ + if registration_resource_path is None: + raise ValueError("Invalid value for `registration_resource_path`, must not be `None`") # noqa: E501 + + self._registration_resource_path = registration_resource_path + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PayVisionAuthCaptureRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PayVisionAuthCaptureRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/pay_vision_configuration.py b/billforward/models/pay_vision_configuration.py new file mode 100644 index 0000000..8edcec4 --- /dev/null +++ b/billforward/models/pay_vision_configuration.py @@ -0,0 +1,220 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class PayVisionConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'key_filename': 'str', + 'domain': 'str', + 'entity_id': 'str', + 'password': 'str', + 'user_id': 'str' + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + 'key_filename': 'keyFilename', + 'domain': 'domain', + 'entity_id': 'entityID', + 'password': 'password', + 'user_id': 'userID' + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, key_filename=None, domain=None, entity_id=None, password=None, user_id=None, *args, **kwargs): # noqa: E501 + """PayVisionConfiguration - a model defined in Swagger""" # noqa: E501 + self._key_filename = None + self._domain = None + self._entity_id = None + self._password = None + self._user_id = None + self.discriminator = None + if key_filename is not None: + self.key_filename = key_filename + if domain is not None: + self.domain = domain + if entity_id is not None: + self.entity_id = entity_id + if password is not None: + self.password = password + if user_id is not None: + self.user_id = user_id + APIConfiguration.__init__(self, *args, **kwargs) + + @property + def key_filename(self): + """Gets the key_filename of this PayVisionConfiguration. # noqa: E501 + + + :return: The key_filename of this PayVisionConfiguration. # noqa: E501 + :rtype: str + """ + return self._key_filename + + @key_filename.setter + def key_filename(self, key_filename): + """Sets the key_filename of this PayVisionConfiguration. + + + :param key_filename: The key_filename of this PayVisionConfiguration. # noqa: E501 + :type: str + """ + + self._key_filename = key_filename + + @property + def domain(self): + """Gets the domain of this PayVisionConfiguration. # noqa: E501 + + + :return: The domain of this PayVisionConfiguration. # noqa: E501 + :rtype: str + """ + return self._domain + + @domain.setter + def domain(self, domain): + """Sets the domain of this PayVisionConfiguration. + + + :param domain: The domain of this PayVisionConfiguration. # noqa: E501 + :type: str + """ + + self._domain = domain + + @property + def entity_id(self): + """Gets the entity_id of this PayVisionConfiguration. # noqa: E501 + + + :return: The entity_id of this PayVisionConfiguration. # noqa: E501 + :rtype: str + """ + return self._entity_id + + @entity_id.setter + def entity_id(self, entity_id): + """Sets the entity_id of this PayVisionConfiguration. + + + :param entity_id: The entity_id of this PayVisionConfiguration. # noqa: E501 + :type: str + """ + + self._entity_id = entity_id + + @property + def password(self): + """Gets the password of this PayVisionConfiguration. # noqa: E501 + + + :return: The password of this PayVisionConfiguration. # noqa: E501 + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """Sets the password of this PayVisionConfiguration. + + + :param password: The password of this PayVisionConfiguration. # noqa: E501 + :type: str + """ + + self._password = password + + @property + def user_id(self): + """Gets the user_id of this PayVisionConfiguration. # noqa: E501 + + + :return: The user_id of this PayVisionConfiguration. # noqa: E501 + :rtype: str + """ + return self._user_id + + @user_id.setter + def user_id(self, user_id): + """Sets the user_id of this PayVisionConfiguration. + + + :param user_id: The user_id of this PayVisionConfiguration. # noqa: E501 + :type: str + """ + + self._user_id = user_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PayVisionConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PayVisionConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/pay_vision_pre_auth_request.py b/billforward/models/pay_vision_pre_auth_request.py new file mode 100644 index 0000000..f91eed4 --- /dev/null +++ b/billforward/models/pay_vision_pre_auth_request.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.tokenization_pre_auth_request import TokenizationPreAuthRequest # noqa: F401,E501 + +class PayVisionPreAuthRequest(TokenizationPreAuthRequest): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(TokenizationPreAuthRequest, "swagger_types"): + swagger_types.update(TokenizationPreAuthRequest.swagger_types) + + attribute_map = { + } + if hasattr(TokenizationPreAuthRequest, "attribute_map"): + attribute_map.update(TokenizationPreAuthRequest.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """PayVisionPreAuthRequest - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + TokenizationPreAuthRequest.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PayVisionPreAuthRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PayVisionPreAuthRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/payment.py b/billforward/models/payment.py index 6b919ea..36547c0 100644 --- a/billforward/models/payment.py +++ b/billforward/models/payment.py @@ -1,121 +1,175 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class Payment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, crm_id=None, payment_method_id=None, invoice_id=None, organization_id=None, gateway=None, currency=None, nominal_value=None, actual_value=None, remaining_nominal_value=None, payment_received=None, refunded_value=None, refund_id=None, type=None): - """ - Payment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'crm_id': 'str', - 'payment_method_id': 'str', - 'invoice_id': 'str', - 'organization_id': 'str', - 'gateway': 'str', - 'currency': 'str', - 'nominal_value': 'float', - 'actual_value': 'float', - 'remaining_nominal_value': 'float', - 'payment_received': 'datetime', - 'refunded_value': 'float', - 'refund_id': 'str', - 'type': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'crm_id': 'crmID', - 'payment_method_id': 'paymentMethodID', - 'invoice_id': 'invoiceID', - 'organization_id': 'organizationID', - 'gateway': 'gateway', - 'currency': 'currency', - 'nominal_value': 'nominalValue', - 'actual_value': 'actualValue', - 'remaining_nominal_value': 'remainingNominalValue', - 'payment_received': 'paymentReceived', - 'refunded_value': 'refundedValue', - 'refund_id': 'refundID', - 'type': 'type' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._crm_id = crm_id - self._payment_method_id = payment_method_id - self._invoice_id = invoice_id - self._organization_id = organization_id - self._gateway = gateway - self._currency = currency - self._nominal_value = nominal_value - self._actual_value = actual_value - self._remaining_nominal_value = remaining_nominal_value - self._payment_received = payment_received - self._refunded_value = refunded_value - self._refund_id = refund_id - self._type = type + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'metadata': 'dict(str, object)', + 'id': 'str', + 'crm_id': 'str', + 'account_id': 'str', + 'subscription_id': 'str', + 'payment_method_id': 'str', + 'invoice_id': 'str', + 'organization_id': 'str', + 'gateway': 'str', + 'currency': 'CreditNoteCurrency', + 'nominal_value': 'float', + 'actual_value': 'float', + 'payment_received': 'datetime', + 'refunded_value': 'float', + 'refund_id': 'str', + 'type': 'str', + 'remaining_nominal_value': 'float', + 'type': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'metadata': 'metadata', + 'id': 'id', + 'crm_id': 'crmID', + 'account_id': 'accountID', + 'subscription_id': 'subscriptionID', + 'payment_method_id': 'paymentMethodID', + 'invoice_id': 'invoiceID', + 'organization_id': 'organizationID', + 'gateway': 'gateway', + 'currency': 'currency', + 'nominal_value': 'nominalValue', + 'actual_value': 'actualValue', + 'payment_received': 'paymentReceived', + 'refunded_value': 'refundedValue', + 'refund_id': 'refundID', + 'type': 'type', + 'remaining_nominal_value': 'remainingNominalValue', + 'type': '@type' + } + + discriminator_value_class_map = { + 'AuthorizeNetPayment': 'AuthorizeNetPayment', +'CardConnectPayment': 'CardConnectPayment', +'StripeACHPayment': 'StripeACHPayment', +'EBANXPayment': 'EBANXPayment', +'CouponPayment': 'CouponPayment', +'ShuttlePayment': 'ShuttlePayment', +'BraintreePayment': 'BraintreePayment', +'CreditNotePayment': 'CreditNotePayment', +'OfflinePayment': 'OfflinePayment', +'ZoozPayment': 'ZoozPayment', +'CybersourcePayment': 'CybersourcePayment', +'SagePayCardPayment': 'SagePayCardPayment', +'SquarePayment': 'SquarePayment', +'StripeCardPayment': 'StripeCardPayment', +'EpxPayment': 'EpxPayment', +'PaypalPayment': 'PaypalPayment' } + + def __init__(self, created=None, changed_by=None, updated=None, metadata=None, id=None, crm_id=None, account_id=None, subscription_id=None, payment_method_id=None, invoice_id=None, organization_id=None, gateway=None, currency=None, nominal_value=None, actual_value=None, payment_received=None, refunded_value=None, refund_id=None, type=None, remaining_nominal_value=None, type=None): # noqa: E501 + """Payment - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._metadata = None + self._id = None + self._crm_id = None + self._account_id = None + self._subscription_id = None + self._payment_method_id = None + self._invoice_id = None + self._organization_id = None + self._gateway = None + self._currency = None + self._nominal_value = None + self._actual_value = None + self._payment_received = None + self._refunded_value = None + self._refund_id = None + self._type = None + self._remaining_nominal_value = None + self._type = None + self.discriminator = '@type' + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if metadata is not None: + self.metadata = metadata + if id is not None: + self.id = id + if crm_id is not None: + self.crm_id = crm_id + if account_id is not None: + self.account_id = account_id + if subscription_id is not None: + self.subscription_id = subscription_id + if payment_method_id is not None: + self.payment_method_id = payment_method_id + if invoice_id is not None: + self.invoice_id = invoice_id + if organization_id is not None: + self.organization_id = organization_id + if gateway is not None: + self.gateway = gateway + self.currency = currency + self.nominal_value = nominal_value + self.actual_value = actual_value + if payment_received is not None: + self.payment_received = payment_received + if refunded_value is not None: + self.refunded_value = refunded_value + if refund_id is not None: + self.refund_id = refund_id + self.type = type + self.remaining_nominal_value = remaining_nominal_value + self.type = type @property def created(self): - """ - Gets the created of this Payment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this Payment. # noqa: E501 + - :return: The created of this Payment. + :return: The created of this Payment. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this Payment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this Payment. + - :param created: The created of this Payment. + :param created: The created of this Payment. # noqa: E501 :type: datetime """ @@ -123,22 +177,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this Payment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this Payment. # noqa: E501 - :return: The changed_by of this Payment. + + :return: The changed_by of this Payment. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this Payment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this Payment. + - :param changed_by: The changed_by of this Payment. + :param changed_by: The changed_by of this Payment. # noqa: E501 :type: str """ @@ -146,45 +198,62 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this Payment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this Payment. # noqa: E501 + - :return: The updated of this Payment. + :return: The updated of this Payment. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this Payment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this Payment. - :param updated: The updated of this Payment. + + :param updated: The updated of this Payment. # noqa: E501 :type: datetime """ self._updated = updated @property - def id(self): + def metadata(self): + """Gets the metadata of this Payment. # noqa: E501 + + + :return: The metadata of this Payment. # noqa: E501 + :rtype: dict(str, object) """ - Gets the id of this Payment. - { \"description\" : \"ID of the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """Sets the metadata of this Payment. + - :return: The id of this Payment. + :param metadata: The metadata of this Payment. # noqa: E501 + :type: dict(str, object) + """ + + self._metadata = metadata + + @property + def id(self): + """Gets the id of this Payment. # noqa: E501 + + + :return: The id of this Payment. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this Payment. - { \"description\" : \"ID of the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the id of this Payment. - :param id: The id of this Payment. + + :param id: The id of this Payment. # noqa: E501 :type: str """ @@ -192,45 +261,83 @@ def id(self, id): @property def crm_id(self): - """ - Gets the crm_id of this Payment. - { \"description\" : \"CRM ID of the invoice.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the crm_id of this Payment. # noqa: E501 + - :return: The crm_id of this Payment. + :return: The crm_id of this Payment. # noqa: E501 :rtype: str """ return self._crm_id @crm_id.setter def crm_id(self, crm_id): - """ - Sets the crm_id of this Payment. - { \"description\" : \"CRM ID of the invoice.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the crm_id of this Payment. + - :param crm_id: The crm_id of this Payment. + :param crm_id: The crm_id of this Payment. # noqa: E501 :type: str """ self._crm_id = crm_id @property - def payment_method_id(self): + def account_id(self): + """Gets the account_id of this Payment. # noqa: E501 + + + :return: The account_id of this Payment. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this Payment. + + + :param account_id: The account_id of this Payment. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def subscription_id(self): + """Gets the subscription_id of this Payment. # noqa: E501 + + + :return: The subscription_id of this Payment. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this Payment. + + + :param subscription_id: The subscription_id of this Payment. # noqa: E501 + :type: str """ - Gets the payment_method_id of this Payment. - { \"description\" : \"ID of the payment method associated with the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - :return: The payment_method_id of this Payment. + self._subscription_id = subscription_id + + @property + def payment_method_id(self): + """Gets the payment_method_id of this Payment. # noqa: E501 + + + :return: The payment_method_id of this Payment. # noqa: E501 :rtype: str """ return self._payment_method_id @payment_method_id.setter def payment_method_id(self, payment_method_id): - """ - Sets the payment_method_id of this Payment. - { \"description\" : \"ID of the payment method associated with the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the payment_method_id of this Payment. - :param payment_method_id: The payment_method_id of this Payment. + + :param payment_method_id: The payment_method_id of this Payment. # noqa: E501 :type: str """ @@ -238,22 +345,20 @@ def payment_method_id(self, payment_method_id): @property def invoice_id(self): - """ - Gets the invoice_id of this Payment. - { \"description\" : \"ID of the invoice associated with the payment. This may be null when a payment is not explicitly associated with an invoice. Payments may be used across multiple invoices.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the invoice_id of this Payment. # noqa: E501 + - :return: The invoice_id of this Payment. + :return: The invoice_id of this Payment. # noqa: E501 :rtype: str """ return self._invoice_id @invoice_id.setter def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this Payment. - { \"description\" : \"ID of the invoice associated with the payment. This may be null when a payment is not explicitly associated with an invoice. Payments may be used across multiple invoices.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the invoice_id of this Payment. + - :param invoice_id: The invoice_id of this Payment. + :param invoice_id: The invoice_id of this Payment. # noqa: E501 :type: str """ @@ -261,22 +366,20 @@ def invoice_id(self, invoice_id): @property def organization_id(self): - """ - Gets the organization_id of this Payment. - { \"description\" : \"ID of the organization associated with the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the organization_id of this Payment. # noqa: E501 - :return: The organization_id of this Payment. + + :return: The organization_id of this Payment. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this Payment. - { \"description\" : \"ID of the organization associated with the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the organization_id of this Payment. + - :param organization_id: The organization_id of this Payment. + :param organization_id: The organization_id of this Payment. # noqa: E501 :type: str """ @@ -284,28 +387,26 @@ def organization_id(self, organization_id): @property def gateway(self): - """ - Gets the gateway of this Payment. - { \"description\" : \"Payment gateway associated with the payment\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the gateway of this Payment. # noqa: E501 + - :return: The gateway of this Payment. + :return: The gateway of this Payment. # noqa: E501 :rtype: str """ return self._gateway @gateway.setter def gateway(self, gateway): - """ - Sets the gateway of this Payment. - { \"description\" : \"Payment gateway associated with the payment\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the gateway of this Payment. + - :param gateway: The gateway of this Payment. + :param gateway: The gateway of this Payment. # noqa: E501 :type: str """ - allowed_values = ["cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash"] + allowed_values = ["VOID", "cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "zooz", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "goCardless", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash", "epx", "shuttle", "square", "billforwardRandomizer", "cardConnect", "ebanx"] # noqa: E501 if gateway not in allowed_values: raise ValueError( - "Invalid value for `gateway` ({0}), must be one of {1}" + "Invalid value for `gateway` ({0}), must be one of {1}" # noqa: E501 .format(gateway, allowed_values) ) @@ -313,114 +414,89 @@ def gateway(self, gateway): @property def currency(self): - """ - Gets the currency of this Payment. - { \"description\" : \"The currency of the payment specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the currency of this Payment. # noqa: E501 - :return: The currency of this Payment. - :rtype: str + + :return: The currency of this Payment. # noqa: E501 + :rtype: CreditNoteCurrency """ return self._currency @currency.setter def currency(self, currency): - """ - Sets the currency of this Payment. - { \"description\" : \"The currency of the payment specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the currency of this Payment. - :param currency: The currency of this Payment. - :type: str + + :param currency: The currency of this Payment. # noqa: E501 + :type: CreditNoteCurrency """ + if currency is None: + raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501 self._currency = currency @property def nominal_value(self): - """ - Gets the nominal_value of this Payment. - { \"description\" : \"Nominal value of the payment. This is the theoretical value of the payment, thus the value this payment can pay off an invoice. For example a coupon has a nominal value of the discount, and the actual value is zero.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the nominal_value of this Payment. # noqa: E501 - :return: The nominal_value of this Payment. + + :return: The nominal_value of this Payment. # noqa: E501 :rtype: float """ return self._nominal_value @nominal_value.setter def nominal_value(self, nominal_value): - """ - Sets the nominal_value of this Payment. - { \"description\" : \"Nominal value of the payment. This is the theoretical value of the payment, thus the value this payment can pay off an invoice. For example a coupon has a nominal value of the discount, and the actual value is zero.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the nominal_value of this Payment. + - :param nominal_value: The nominal_value of this Payment. + :param nominal_value: The nominal_value of this Payment. # noqa: E501 :type: float """ + if nominal_value is None: + raise ValueError("Invalid value for `nominal_value`, must not be `None`") # noqa: E501 self._nominal_value = nominal_value @property def actual_value(self): - """ - Gets the actual_value of this Payment. - { \"description\" : \"Actual monetary value of the payment. This is real value of the payment amount, thus the amount of currency received for this payment. A coupon has a real value of zero, even though the nominal amount it pays may be greater than zero.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the actual_value of this Payment. # noqa: E501 + - :return: The actual_value of this Payment. + :return: The actual_value of this Payment. # noqa: E501 :rtype: float """ return self._actual_value @actual_value.setter def actual_value(self, actual_value): - """ - Sets the actual_value of this Payment. - { \"description\" : \"Actual monetary value of the payment. This is real value of the payment amount, thus the amount of currency received for this payment. A coupon has a real value of zero, even though the nominal amount it pays may be greater than zero.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actual_value: The actual_value of this Payment. - :type: float - """ + """Sets the actual_value of this Payment. - self._actual_value = actual_value - - @property - def remaining_nominal_value(self): - """ - Gets the remaining_nominal_value of this Payment. - { \"description\" : \"Remaining nominal value of the payment not used. In the case when a payment is used across a range of invoices a payment may be used multiple times, each use reducing the available blance of the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - :return: The remaining_nominal_value of this Payment. - :rtype: float - """ - return self._remaining_nominal_value - - @remaining_nominal_value.setter - def remaining_nominal_value(self, remaining_nominal_value): - """ - Sets the remaining_nominal_value of this Payment. - { \"description\" : \"Remaining nominal value of the payment not used. In the case when a payment is used across a range of invoices a payment may be used multiple times, each use reducing the available blance of the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param remaining_nominal_value: The remaining_nominal_value of this Payment. + :param actual_value: The actual_value of this Payment. # noqa: E501 :type: float """ + if actual_value is None: + raise ValueError("Invalid value for `actual_value`, must not be `None`") # noqa: E501 - self._remaining_nominal_value = remaining_nominal_value + self._actual_value = actual_value @property def payment_received(self): - """ - Gets the payment_received of this Payment. - { \"description\" : \"UTC DateTime specifying when payment was received for the invoice.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the payment_received of this Payment. # noqa: E501 + - :return: The payment_received of this Payment. + :return: The payment_received of this Payment. # noqa: E501 :rtype: datetime """ return self._payment_received @payment_received.setter def payment_received(self, payment_received): - """ - Sets the payment_received of this Payment. - { \"description\" : \"UTC DateTime specifying when payment was received for the invoice.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the payment_received of this Payment. - :param payment_received: The payment_received of this Payment. + + :param payment_received: The payment_received of this Payment. # noqa: E501 :type: datetime """ @@ -428,22 +504,20 @@ def payment_received(self, payment_received): @property def refunded_value(self): - """ - Gets the refunded_value of this Payment. - { \"description\" : \"Refunded nominal value of the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the refunded_value of this Payment. # noqa: E501 + - :return: The refunded_value of this Payment. + :return: The refunded_value of this Payment. # noqa: E501 :rtype: float """ return self._refunded_value @refunded_value.setter def refunded_value(self, refunded_value): - """ - Sets the refunded_value of this Payment. - { \"description\" : \"Refunded nominal value of the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the refunded_value of this Payment. + - :param refunded_value: The refunded_value of this Payment. + :param refunded_value: The refunded_value of this Payment. # noqa: E501 :type: float """ @@ -451,22 +525,20 @@ def refunded_value(self, refunded_value): @property def refund_id(self): - """ - Gets the refund_id of this Payment. - { \"description\" : \"ID of the refund associated with the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the refund_id of this Payment. # noqa: E501 - :return: The refund_id of this Payment. + + :return: The refund_id of this Payment. # noqa: E501 :rtype: str """ return self._refund_id @refund_id.setter def refund_id(self, refund_id): - """ - Sets the refund_id of this Payment. - { \"description\" : \"ID of the refund associated with the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the refund_id of this Payment. + - :param refund_id: The refund_id of this Payment. + :param refund_id: The refund_id of this Payment. # noqa: E501 :type: str """ @@ -474,40 +546,89 @@ def refund_id(self, refund_id): @property def type(self): - """ - Gets the type of this Payment. - { \"description\" : \"Type of payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the type of this Payment. # noqa: E501 + - :return: The type of this Payment. + :return: The type of this Payment. # noqa: E501 :rtype: str """ return self._type @type.setter def type(self, type): - """ - Sets the type of this Payment. - { \"description\" : \"Type of payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the type of this Payment. + - :param type: The type of this Payment. + :param type: The type of this Payment. # noqa: E501 :type: str """ - allowed_values = ["credit", "debit"] + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + allowed_values = ["credit", "debit"] # noqa: E501 if type not in allowed_values: raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 .format(type, allowed_values) ) self._type = type - def to_dict(self): + @property + def remaining_nominal_value(self): + """Gets the remaining_nominal_value of this Payment. # noqa: E501 + + + :return: The remaining_nominal_value of this Payment. # noqa: E501 + :rtype: float + """ + return self._remaining_nominal_value + + @remaining_nominal_value.setter + def remaining_nominal_value(self, remaining_nominal_value): + """Sets the remaining_nominal_value of this Payment. + + + :param remaining_nominal_value: The remaining_nominal_value of this Payment. # noqa: E501 + :type: float + """ + if remaining_nominal_value is None: + raise ValueError("Invalid value for `remaining_nominal_value`, must not be `None`") # noqa: E501 + + self._remaining_nominal_value = remaining_nominal_value + + @property + def type(self): + """Gets the type of this Payment. # noqa: E501 + + + :return: The type of this Payment. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._type + + @type.setter + def type(self, type): + """Sets the type of this Payment. + + + :param type: The type of this Payment. # noqa: E501 + :type: str """ + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + + self._type = type + + def get_real_child_model(self, data): + """Returns the real base class specified by the discriminator""" + discriminator_value = data[self.discriminator].lower() + return self.discriminator_value_class_map.get(discriminator_value) + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -524,29 +645,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Payment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Payment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/payment_accounting_view.py b/billforward/models/payment_accounting_view.py new file mode 100644 index 0000000..8ebb831 --- /dev/null +++ b/billforward/models/payment_accounting_view.py @@ -0,0 +1,402 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PaymentAccountingView(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'account_id': 'str', + 'subscription_id': 'str', + 'payment_method_id': 'str', + 'invoice_id': 'str', + 'actual_value': 'float', + 'nominal_value': 'float', + 'remaining_value': 'float', + 'refunded_value': 'float', + 'currency': 'CreditNoteCurrency', + 'gateway': 'str', + 'payment_received': 'datetime' + } + + attribute_map = { + 'id': 'id', + 'account_id': 'accountID', + 'subscription_id': 'subscriptionID', + 'payment_method_id': 'paymentMethodID', + 'invoice_id': 'invoiceID', + 'actual_value': 'actualValue', + 'nominal_value': 'nominalValue', + 'remaining_value': 'remainingValue', + 'refunded_value': 'refundedValue', + 'currency': 'currency', + 'gateway': 'gateway', + 'payment_received': 'paymentReceived' + } + + def __init__(self, id=None, account_id=None, subscription_id=None, payment_method_id=None, invoice_id=None, actual_value=None, nominal_value=None, remaining_value=None, refunded_value=None, currency=None, gateway=None, payment_received=None): # noqa: E501 + """PaymentAccountingView - a model defined in Swagger""" # noqa: E501 + self._id = None + self._account_id = None + self._subscription_id = None + self._payment_method_id = None + self._invoice_id = None + self._actual_value = None + self._nominal_value = None + self._remaining_value = None + self._refunded_value = None + self._currency = None + self._gateway = None + self._payment_received = None + self.discriminator = None + if id is not None: + self.id = id + if account_id is not None: + self.account_id = account_id + if subscription_id is not None: + self.subscription_id = subscription_id + if payment_method_id is not None: + self.payment_method_id = payment_method_id + if invoice_id is not None: + self.invoice_id = invoice_id + if actual_value is not None: + self.actual_value = actual_value + if nominal_value is not None: + self.nominal_value = nominal_value + if remaining_value is not None: + self.remaining_value = remaining_value + if refunded_value is not None: + self.refunded_value = refunded_value + if currency is not None: + self.currency = currency + if gateway is not None: + self.gateway = gateway + if payment_received is not None: + self.payment_received = payment_received + + @property + def id(self): + """Gets the id of this PaymentAccountingView. # noqa: E501 + + + :return: The id of this PaymentAccountingView. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this PaymentAccountingView. + + + :param id: The id of this PaymentAccountingView. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def account_id(self): + """Gets the account_id of this PaymentAccountingView. # noqa: E501 + + + :return: The account_id of this PaymentAccountingView. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this PaymentAccountingView. + + + :param account_id: The account_id of this PaymentAccountingView. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def subscription_id(self): + """Gets the subscription_id of this PaymentAccountingView. # noqa: E501 + + + :return: The subscription_id of this PaymentAccountingView. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this PaymentAccountingView. + + + :param subscription_id: The subscription_id of this PaymentAccountingView. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def payment_method_id(self): + """Gets the payment_method_id of this PaymentAccountingView. # noqa: E501 + + + :return: The payment_method_id of this PaymentAccountingView. # noqa: E501 + :rtype: str + """ + return self._payment_method_id + + @payment_method_id.setter + def payment_method_id(self, payment_method_id): + """Sets the payment_method_id of this PaymentAccountingView. + + + :param payment_method_id: The payment_method_id of this PaymentAccountingView. # noqa: E501 + :type: str + """ + + self._payment_method_id = payment_method_id + + @property + def invoice_id(self): + """Gets the invoice_id of this PaymentAccountingView. # noqa: E501 + + + :return: The invoice_id of this PaymentAccountingView. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this PaymentAccountingView. + + + :param invoice_id: The invoice_id of this PaymentAccountingView. # noqa: E501 + :type: str + """ + + self._invoice_id = invoice_id + + @property + def actual_value(self): + """Gets the actual_value of this PaymentAccountingView. # noqa: E501 + + + :return: The actual_value of this PaymentAccountingView. # noqa: E501 + :rtype: float + """ + return self._actual_value + + @actual_value.setter + def actual_value(self, actual_value): + """Sets the actual_value of this PaymentAccountingView. + + + :param actual_value: The actual_value of this PaymentAccountingView. # noqa: E501 + :type: float + """ + + self._actual_value = actual_value + + @property + def nominal_value(self): + """Gets the nominal_value of this PaymentAccountingView. # noqa: E501 + + + :return: The nominal_value of this PaymentAccountingView. # noqa: E501 + :rtype: float + """ + return self._nominal_value + + @nominal_value.setter + def nominal_value(self, nominal_value): + """Sets the nominal_value of this PaymentAccountingView. + + + :param nominal_value: The nominal_value of this PaymentAccountingView. # noqa: E501 + :type: float + """ + + self._nominal_value = nominal_value + + @property + def remaining_value(self): + """Gets the remaining_value of this PaymentAccountingView. # noqa: E501 + + + :return: The remaining_value of this PaymentAccountingView. # noqa: E501 + :rtype: float + """ + return self._remaining_value + + @remaining_value.setter + def remaining_value(self, remaining_value): + """Sets the remaining_value of this PaymentAccountingView. + + + :param remaining_value: The remaining_value of this PaymentAccountingView. # noqa: E501 + :type: float + """ + + self._remaining_value = remaining_value + + @property + def refunded_value(self): + """Gets the refunded_value of this PaymentAccountingView. # noqa: E501 + + + :return: The refunded_value of this PaymentAccountingView. # noqa: E501 + :rtype: float + """ + return self._refunded_value + + @refunded_value.setter + def refunded_value(self, refunded_value): + """Sets the refunded_value of this PaymentAccountingView. + + + :param refunded_value: The refunded_value of this PaymentAccountingView. # noqa: E501 + :type: float + """ + + self._refunded_value = refunded_value + + @property + def currency(self): + """Gets the currency of this PaymentAccountingView. # noqa: E501 + + + :return: The currency of this PaymentAccountingView. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this PaymentAccountingView. + + + :param currency: The currency of this PaymentAccountingView. # noqa: E501 + :type: CreditNoteCurrency + """ + + self._currency = currency + + @property + def gateway(self): + """Gets the gateway of this PaymentAccountingView. # noqa: E501 + + + :return: The gateway of this PaymentAccountingView. # noqa: E501 + :rtype: str + """ + return self._gateway + + @gateway.setter + def gateway(self, gateway): + """Sets the gateway of this PaymentAccountingView. + + + :param gateway: The gateway of this PaymentAccountingView. # noqa: E501 + :type: str + """ + allowed_values = ["VOID", "cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "zooz", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "goCardless", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash", "epx", "shuttle", "square", "billforwardRandomizer", "cardConnect", "ebanx"] # noqa: E501 + if gateway not in allowed_values: + raise ValueError( + "Invalid value for `gateway` ({0}), must be one of {1}" # noqa: E501 + .format(gateway, allowed_values) + ) + + self._gateway = gateway + + @property + def payment_received(self): + """Gets the payment_received of this PaymentAccountingView. # noqa: E501 + + + :return: The payment_received of this PaymentAccountingView. # noqa: E501 + :rtype: datetime + """ + return self._payment_received + + @payment_received.setter + def payment_received(self, payment_received): + """Sets the payment_received of this PaymentAccountingView. + + + :param payment_received: The payment_received of this PaymentAccountingView. # noqa: E501 + :type: datetime + """ + + self._payment_received = payment_received + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PaymentAccountingView, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PaymentAccountingView): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/payment_method.py b/billforward/models/payment_method.py index 1a6da94..f51b971 100644 --- a/billforward/models/payment_method.py +++ b/billforward/models/payment_method.py @@ -1,145 +1,198 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class PaymentMethod(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, crm_id=None, account_id=None, organization_id=None, name=None, description=None, card_holder_name=None, expiry_date=None, card_type=None, country=None, province=None, first_six=None, last_four=None, expiry_year=None, expiry_month=None, link_id=None, gateway=None, ip_address=None, ip_address_country=None, state=None, deleted=False, default_payment_method=False): - """ - PaymentMethod - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'crm_id': 'str', - 'account_id': 'str', - 'organization_id': 'str', - 'name': 'str', - 'description': 'str', - 'card_holder_name': 'str', - 'expiry_date': 'str', - 'card_type': 'str', - 'country': 'str', - 'province': 'str', - 'first_six': 'str', - 'last_four': 'str', - 'expiry_year': 'int', - 'expiry_month': 'int', - 'link_id': 'str', - 'gateway': 'str', - 'ip_address': 'str', - 'ip_address_country': 'str', - 'state': 'str', - 'deleted': 'bool', - 'default_payment_method': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'crm_id': 'crmID', - 'account_id': 'accountID', - 'organization_id': 'organizationID', - 'name': 'name', - 'description': 'description', - 'card_holder_name': 'cardHolderName', - 'expiry_date': 'expiryDate', - 'card_type': 'cardType', - 'country': 'country', - 'province': 'province', - 'first_six': 'firstSix', - 'last_four': 'lastFour', - 'expiry_year': 'expiryYear', - 'expiry_month': 'expiryMonth', - 'link_id': 'linkID', - 'gateway': 'gateway', - 'ip_address': 'ipAddress', - 'ip_address_country': 'ipAddressCountry', - 'state': 'state', - 'deleted': 'deleted', - 'default_payment_method': 'defaultPaymentMethod' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._crm_id = crm_id - self._account_id = account_id - self._organization_id = organization_id - self._name = name - self._description = description - self._card_holder_name = card_holder_name - self._expiry_date = expiry_date - self._card_type = card_type - self._country = country - self._province = province - self._first_six = first_six - self._last_four = last_four - self._expiry_year = expiry_year - self._expiry_month = expiry_month - self._link_id = link_id - self._gateway = gateway - self._ip_address = ip_address - self._ip_address_country = ip_address_country - self._state = state - self._deleted = deleted - self._default_payment_method = default_payment_method + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'crm_id': 'str', + 'account_id': 'str', + 'organization_id': 'str', + 'name': 'str', + 'description': 'str', + 'card_holder_name': 'str', + 'expiry_date': 'str', + 'card_type': 'str', + 'country': 'str', + 'province': 'str', + 'first_six': 'str', + 'last_four': 'str', + 'expiry_year': 'int', + 'expiry_month': 'int', + 'link_id': 'str', + 'gateway': 'str', + 'api_configuration_id': 'str', + 'ip_address': 'str', + 'ip_address_country': 'str', + 'tokenization_method': 'str', + 'state': 'str', + 'gateway_refreshed': 'datetime', + 'deleted': 'bool', + 'default_payment_method': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'crm_id': 'crmID', + 'account_id': 'accountID', + 'organization_id': 'organizationID', + 'name': 'name', + 'description': 'description', + 'card_holder_name': 'cardHolderName', + 'expiry_date': 'expiryDate', + 'card_type': 'cardType', + 'country': 'country', + 'province': 'province', + 'first_six': 'firstSix', + 'last_four': 'lastFour', + 'expiry_year': 'expiryYear', + 'expiry_month': 'expiryMonth', + 'link_id': 'linkID', + 'gateway': 'gateway', + 'api_configuration_id': 'apiConfigurationID', + 'ip_address': 'ipAddress', + 'ip_address_country': 'ipAddressCountry', + 'tokenization_method': 'tokenizationMethod', + 'state': 'state', + 'gateway_refreshed': 'gatewayRefreshed', + 'deleted': 'deleted', + 'default_payment_method': 'defaultPaymentMethod' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, crm_id=None, account_id=None, organization_id=None, name=None, description=None, card_holder_name=None, expiry_date=None, card_type=None, country=None, province=None, first_six=None, last_four=None, expiry_year=None, expiry_month=None, link_id=None, gateway=None, api_configuration_id=None, ip_address=None, ip_address_country=None, tokenization_method=None, state=None, gateway_refreshed=None, deleted=None, default_payment_method=None): # noqa: E501 + """PaymentMethod - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._crm_id = None + self._account_id = None + self._organization_id = None + self._name = None + self._description = None + self._card_holder_name = None + self._expiry_date = None + self._card_type = None + self._country = None + self._province = None + self._first_six = None + self._last_four = None + self._expiry_year = None + self._expiry_month = None + self._link_id = None + self._gateway = None + self._api_configuration_id = None + self._ip_address = None + self._ip_address_country = None + self._tokenization_method = None + self._state = None + self._gateway_refreshed = None + self._deleted = None + self._default_payment_method = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if crm_id is not None: + self.crm_id = crm_id + if account_id is not None: + self.account_id = account_id + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if description is not None: + self.description = description + if card_holder_name is not None: + self.card_holder_name = card_holder_name + if expiry_date is not None: + self.expiry_date = expiry_date + if card_type is not None: + self.card_type = card_type + if country is not None: + self.country = country + if province is not None: + self.province = province + if first_six is not None: + self.first_six = first_six + if last_four is not None: + self.last_four = last_four + if expiry_year is not None: + self.expiry_year = expiry_year + if expiry_month is not None: + self.expiry_month = expiry_month + if link_id is not None: + self.link_id = link_id + if gateway is not None: + self.gateway = gateway + if api_configuration_id is not None: + self.api_configuration_id = api_configuration_id + if ip_address is not None: + self.ip_address = ip_address + if ip_address_country is not None: + self.ip_address_country = ip_address_country + if tokenization_method is not None: + self.tokenization_method = tokenization_method + if state is not None: + self.state = state + if gateway_refreshed is not None: + self.gateway_refreshed = gateway_refreshed + if deleted is not None: + self.deleted = deleted + if default_payment_method is not None: + self.default_payment_method = default_payment_method @property def created(self): - """ - Gets the created of this PaymentMethod. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this PaymentMethod. # noqa: E501 - :return: The created of this PaymentMethod. + + :return: The created of this PaymentMethod. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this PaymentMethod. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this PaymentMethod. - :param created: The created of this PaymentMethod. + + :param created: The created of this PaymentMethod. # noqa: E501 :type: datetime """ @@ -147,22 +200,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this PaymentMethod. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this PaymentMethod. # noqa: E501 + - :return: The changed_by of this PaymentMethod. + :return: The changed_by of this PaymentMethod. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this PaymentMethod. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this PaymentMethod. + - :param changed_by: The changed_by of this PaymentMethod. + :param changed_by: The changed_by of this PaymentMethod. # noqa: E501 :type: str """ @@ -170,22 +221,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this PaymentMethod. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this PaymentMethod. # noqa: E501 + - :return: The updated of this PaymentMethod. + :return: The updated of this PaymentMethod. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this PaymentMethod. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this PaymentMethod. - :param updated: The updated of this PaymentMethod. + + :param updated: The updated of this PaymentMethod. # noqa: E501 :type: datetime """ @@ -193,22 +242,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this PaymentMethod. - { \"description\" : \"ID of the payment-method.\", \"verbs\":[\"GET\"] } + """Gets the id of this PaymentMethod. # noqa: E501 + - :return: The id of this PaymentMethod. + :return: The id of this PaymentMethod. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this PaymentMethod. - { \"description\" : \"ID of the payment-method.\", \"verbs\":[\"GET\"] } + """Sets the id of this PaymentMethod. + - :param id: The id of this PaymentMethod. + :param id: The id of this PaymentMethod. # noqa: E501 :type: str """ @@ -216,22 +263,20 @@ def id(self, id): @property def crm_id(self): - """ - Gets the crm_id of this PaymentMethod. - { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":] } + """Gets the crm_id of this PaymentMethod. # noqa: E501 - :return: The crm_id of this PaymentMethod. + + :return: The crm_id of this PaymentMethod. # noqa: E501 :rtype: str """ return self._crm_id @crm_id.setter def crm_id(self, crm_id): - """ - Sets the crm_id of this PaymentMethod. - { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":] } + """Sets the crm_id of this PaymentMethod. - :param crm_id: The crm_id of this PaymentMethod. + + :param crm_id: The crm_id of this PaymentMethod. # noqa: E501 :type: str """ @@ -239,22 +284,20 @@ def crm_id(self, crm_id): @property def account_id(self): - """ - Gets the account_id of this PaymentMethod. - { \"description\" : \"ID of the account associated with the payment-method.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the account_id of this PaymentMethod. # noqa: E501 + - :return: The account_id of this PaymentMethod. + :return: The account_id of this PaymentMethod. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this PaymentMethod. - { \"description\" : \"ID of the account associated with the payment-method.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the account_id of this PaymentMethod. + - :param account_id: The account_id of this PaymentMethod. + :param account_id: The account_id of this PaymentMethod. # noqa: E501 :type: str """ @@ -262,22 +305,20 @@ def account_id(self, account_id): @property def organization_id(self): - """ - Gets the organization_id of this PaymentMethod. + """Gets the organization_id of this PaymentMethod. # noqa: E501 - :return: The organization_id of this PaymentMethod. + :return: The organization_id of this PaymentMethod. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this PaymentMethod. + """Sets the organization_id of this PaymentMethod. - :param organization_id: The organization_id of this PaymentMethod. + :param organization_id: The organization_id of this PaymentMethod. # noqa: E501 :type: str """ @@ -285,22 +326,20 @@ def organization_id(self, organization_id): @property def name(self): - """ - Gets the name of this PaymentMethod. - { \"description\" : \"Name of the payment-method.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the name of this PaymentMethod. # noqa: E501 - :return: The name of this PaymentMethod. + + :return: The name of this PaymentMethod. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this PaymentMethod. - { \"description\" : \"Name of the payment-method.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the name of this PaymentMethod. - :param name: The name of this PaymentMethod. + + :param name: The name of this PaymentMethod. # noqa: E501 :type: str """ @@ -308,22 +347,20 @@ def name(self, name): @property def description(self): - """ - Gets the description of this PaymentMethod. - { \"description\" : \"Description of the payment-method.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the description of this PaymentMethod. # noqa: E501 + - :return: The description of this PaymentMethod. + :return: The description of this PaymentMethod. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this PaymentMethod. - { \"description\" : \"Description of the payment-method.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the description of this PaymentMethod. + - :param description: The description of this PaymentMethod. + :param description: The description of this PaymentMethod. # noqa: E501 :type: str """ @@ -331,22 +368,20 @@ def description(self, description): @property def card_holder_name(self): - """ - Gets the card_holder_name of this PaymentMethod. - { \"description\" : \"Name of the card holder\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the card_holder_name of this PaymentMethod. # noqa: E501 + - :return: The card_holder_name of this PaymentMethod. + :return: The card_holder_name of this PaymentMethod. # noqa: E501 :rtype: str """ return self._card_holder_name @card_holder_name.setter def card_holder_name(self, card_holder_name): - """ - Sets the card_holder_name of this PaymentMethod. - { \"description\" : \"Name of the card holder\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the card_holder_name of this PaymentMethod. - :param card_holder_name: The card_holder_name of this PaymentMethod. + + :param card_holder_name: The card_holder_name of this PaymentMethod. # noqa: E501 :type: str """ @@ -354,22 +389,20 @@ def card_holder_name(self, card_holder_name): @property def expiry_date(self): - """ - Gets the expiry_date of this PaymentMethod. - { \"description\" : \"In the case of card payment methods this is the expiry date of the card, format should be MMYY including leading 0's. For example 0115 for January 2015.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the expiry_date of this PaymentMethod. # noqa: E501 - :return: The expiry_date of this PaymentMethod. + + :return: The expiry_date of this PaymentMethod. # noqa: E501 :rtype: str """ return self._expiry_date @expiry_date.setter def expiry_date(self, expiry_date): - """ - Sets the expiry_date of this PaymentMethod. - { \"description\" : \"In the case of card payment methods this is the expiry date of the card, format should be MMYY including leading 0's. For example 0115 for January 2015.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the expiry_date of this PaymentMethod. + - :param expiry_date: The expiry_date of this PaymentMethod. + :param expiry_date: The expiry_date of this PaymentMethod. # noqa: E501 :type: str """ @@ -377,22 +410,20 @@ def expiry_date(self, expiry_date): @property def card_type(self): - """ - Gets the card_type of this PaymentMethod. - { \"description\" : \"Type of the card. In the case of card payment methods this is the payment type, for example VISA, MasterCard.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the card_type of this PaymentMethod. # noqa: E501 + - :return: The card_type of this PaymentMethod. + :return: The card_type of this PaymentMethod. # noqa: E501 :rtype: str """ return self._card_type @card_type.setter def card_type(self, card_type): - """ - Sets the card_type of this PaymentMethod. - { \"description\" : \"Type of the card. In the case of card payment methods this is the payment type, for example VISA, MasterCard.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the card_type of this PaymentMethod. + - :param card_type: The card_type of this PaymentMethod. + :param card_type: The card_type of this PaymentMethod. # noqa: E501 :type: str """ @@ -400,22 +431,20 @@ def card_type(self, card_type): @property def country(self): - """ - Gets the country of this PaymentMethod. + """Gets the country of this PaymentMethod. # noqa: E501 - :return: The country of this PaymentMethod. + :return: The country of this PaymentMethod. # noqa: E501 :rtype: str """ return self._country @country.setter def country(self, country): - """ - Sets the country of this PaymentMethod. + """Sets the country of this PaymentMethod. - :param country: The country of this PaymentMethod. + :param country: The country of this PaymentMethod. # noqa: E501 :type: str """ @@ -423,22 +452,20 @@ def country(self, country): @property def province(self): - """ - Gets the province of this PaymentMethod. + """Gets the province of this PaymentMethod. # noqa: E501 - :return: The province of this PaymentMethod. + :return: The province of this PaymentMethod. # noqa: E501 :rtype: str """ return self._province @province.setter def province(self, province): - """ - Sets the province of this PaymentMethod. + """Sets the province of this PaymentMethod. - :param province: The province of this PaymentMethod. + :param province: The province of this PaymentMethod. # noqa: E501 :type: str """ @@ -446,22 +473,20 @@ def province(self, province): @property def first_six(self): - """ - Gets the first_six of this PaymentMethod. + """Gets the first_six of this PaymentMethod. # noqa: E501 - :return: The first_six of this PaymentMethod. + :return: The first_six of this PaymentMethod. # noqa: E501 :rtype: str """ return self._first_six @first_six.setter def first_six(self, first_six): - """ - Sets the first_six of this PaymentMethod. + """Sets the first_six of this PaymentMethod. - :param first_six: The first_six of this PaymentMethod. + :param first_six: The first_six of this PaymentMethod. # noqa: E501 :type: str """ @@ -469,22 +494,20 @@ def first_six(self, first_six): @property def last_four(self): - """ - Gets the last_four of this PaymentMethod. + """Gets the last_four of this PaymentMethod. # noqa: E501 - :return: The last_four of this PaymentMethod. + :return: The last_four of this PaymentMethod. # noqa: E501 :rtype: str """ return self._last_four @last_four.setter def last_four(self, last_four): - """ - Sets the last_four of this PaymentMethod. + """Sets the last_four of this PaymentMethod. - :param last_four: The last_four of this PaymentMethod. + :param last_four: The last_four of this PaymentMethod. # noqa: E501 :type: str """ @@ -492,22 +515,20 @@ def last_four(self, last_four): @property def expiry_year(self): - """ - Gets the expiry_year of this PaymentMethod. + """Gets the expiry_year of this PaymentMethod. # noqa: E501 - :return: The expiry_year of this PaymentMethod. + :return: The expiry_year of this PaymentMethod. # noqa: E501 :rtype: int """ return self._expiry_year @expiry_year.setter def expiry_year(self, expiry_year): - """ - Sets the expiry_year of this PaymentMethod. + """Sets the expiry_year of this PaymentMethod. - :param expiry_year: The expiry_year of this PaymentMethod. + :param expiry_year: The expiry_year of this PaymentMethod. # noqa: E501 :type: int """ @@ -515,22 +536,20 @@ def expiry_year(self, expiry_year): @property def expiry_month(self): - """ - Gets the expiry_month of this PaymentMethod. + """Gets the expiry_month of this PaymentMethod. # noqa: E501 - :return: The expiry_month of this PaymentMethod. + :return: The expiry_month of this PaymentMethod. # noqa: E501 :rtype: int """ return self._expiry_month @expiry_month.setter def expiry_month(self, expiry_month): - """ - Sets the expiry_month of this PaymentMethod. + """Sets the expiry_month of this PaymentMethod. - :param expiry_month: The expiry_month of this PaymentMethod. + :param expiry_month: The expiry_month of this PaymentMethod. # noqa: E501 :type: int """ @@ -538,22 +557,20 @@ def expiry_month(self, expiry_month): @property def link_id(self): - """ - Gets the link_id of this PaymentMethod. + """Gets the link_id of this PaymentMethod. # noqa: E501 - :return: The link_id of this PaymentMethod. + :return: The link_id of this PaymentMethod. # noqa: E501 :rtype: str """ return self._link_id @link_id.setter def link_id(self, link_id): - """ - Sets the link_id of this PaymentMethod. + """Sets the link_id of this PaymentMethod. - :param link_id: The link_id of this PaymentMethod. + :param link_id: The link_id of this PaymentMethod. # noqa: E501 :type: str """ @@ -561,51 +578,68 @@ def link_id(self, link_id): @property def gateway(self): - """ - Gets the gateway of this PaymentMethod. - { \"description\" : \"Gateway type for payment-method.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the gateway of this PaymentMethod. # noqa: E501 + - :return: The gateway of this PaymentMethod. + :return: The gateway of this PaymentMethod. # noqa: E501 :rtype: str """ return self._gateway @gateway.setter def gateway(self, gateway): - """ - Sets the gateway of this PaymentMethod. - { \"description\" : \"Gateway type for payment-method.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the gateway of this PaymentMethod. - :param gateway: The gateway of this PaymentMethod. + + :param gateway: The gateway of this PaymentMethod. # noqa: E501 :type: str """ - allowed_values = ["cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash"] + allowed_values = ["VOID", "cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "zooz", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "goCardless", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash", "epx", "shuttle", "square", "billforwardRandomizer", "cardConnect", "ebanx"] # noqa: E501 if gateway not in allowed_values: raise ValueError( - "Invalid value for `gateway` ({0}), must be one of {1}" + "Invalid value for `gateway` ({0}), must be one of {1}" # noqa: E501 .format(gateway, allowed_values) ) self._gateway = gateway @property - def ip_address(self): + def api_configuration_id(self): + """Gets the api_configuration_id of this PaymentMethod. # noqa: E501 + + + :return: The api_configuration_id of this PaymentMethod. # noqa: E501 + :rtype: str """ - Gets the ip_address of this PaymentMethod. - {\"description\":\"IP address associated with this payment method.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + return self._api_configuration_id + + @api_configuration_id.setter + def api_configuration_id(self, api_configuration_id): + """Sets the api_configuration_id of this PaymentMethod. + - :return: The ip_address of this PaymentMethod. + :param api_configuration_id: The api_configuration_id of this PaymentMethod. # noqa: E501 + :type: str + """ + + self._api_configuration_id = api_configuration_id + + @property + def ip_address(self): + """Gets the ip_address of this PaymentMethod. # noqa: E501 + + + :return: The ip_address of this PaymentMethod. # noqa: E501 :rtype: str """ return self._ip_address @ip_address.setter def ip_address(self, ip_address): - """ - Sets the ip_address of this PaymentMethod. - {\"description\":\"IP address associated with this payment method.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the ip_address of this PaymentMethod. + - :param ip_address: The ip_address of this PaymentMethod. + :param ip_address: The ip_address of this PaymentMethod. # noqa: E501 :type: str """ @@ -613,74 +647,110 @@ def ip_address(self, ip_address): @property def ip_address_country(self): - """ - Gets the ip_address_country of this PaymentMethod. - {\"description\":\"Country of the IP address associated with this payment method.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the ip_address_country of this PaymentMethod. # noqa: E501 + - :return: The ip_address_country of this PaymentMethod. + :return: The ip_address_country of this PaymentMethod. # noqa: E501 :rtype: str """ return self._ip_address_country @ip_address_country.setter def ip_address_country(self, ip_address_country): - """ - Sets the ip_address_country of this PaymentMethod. - {\"description\":\"Country of the IP address associated with this payment method.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the ip_address_country of this PaymentMethod. - :param ip_address_country: The ip_address_country of this PaymentMethod. + + :param ip_address_country: The ip_address_country of this PaymentMethod. # noqa: E501 :type: str """ self._ip_address_country = ip_address_country @property - def state(self): + def tokenization_method(self): + """Gets the tokenization_method of this PaymentMethod. # noqa: E501 + + + :return: The tokenization_method of this PaymentMethod. # noqa: E501 + :rtype: str + """ + return self._tokenization_method + + @tokenization_method.setter + def tokenization_method(self, tokenization_method): + """Sets the tokenization_method of this PaymentMethod. + + + :param tokenization_method: The tokenization_method of this PaymentMethod. # noqa: E501 + :type: str """ - Gets the state of this PaymentMethod. - { \"description\" : \"State of the payment-method.\", \"verbs\":[\"POST\",\"GET\"] } - :return: The state of this PaymentMethod. + self._tokenization_method = tokenization_method + + @property + def state(self): + """Gets the state of this PaymentMethod. # noqa: E501 + + + :return: The state of this PaymentMethod. # noqa: E501 :rtype: str """ return self._state @state.setter def state(self, state): - """ - Sets the state of this PaymentMethod. - { \"description\" : \"State of the payment-method.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the state of this PaymentMethod. - :param state: The state of this PaymentMethod. + + :param state: The state of this PaymentMethod. # noqa: E501 :type: str """ - allowed_values = ["Pending", "Active", "Expiring", "Expired"] + allowed_values = ["Pending", "Active", "Expiring", "Expired"] # noqa: E501 if state not in allowed_values: raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 .format(state, allowed_values) ) self._state = state @property - def deleted(self): + def gateway_refreshed(self): + """Gets the gateway_refreshed of this PaymentMethod. # noqa: E501 + + + :return: The gateway_refreshed of this PaymentMethod. # noqa: E501 + :rtype: datetime + """ + return self._gateway_refreshed + + @gateway_refreshed.setter + def gateway_refreshed(self, gateway_refreshed): + """Sets the gateway_refreshed of this PaymentMethod. + + + :param gateway_refreshed: The gateway_refreshed of this PaymentMethod. # noqa: E501 + :type: datetime """ - Gets the deleted of this PaymentMethod. - {\"default\" : \"false\", \"description\" : \"Indicates if a payment-method has been retired. If a payment-method has been retired it can still be retrieved using the appropriate flag on API requests. Generally payment-methods will be retired by customers wanting to remove the payment method from their account. Caution should be used when requested deleted payment methods.\", \"verbs\":[\"GET\"] } - :return: The deleted of this PaymentMethod. + self._gateway_refreshed = gateway_refreshed + + @property + def deleted(self): + """Gets the deleted of this PaymentMethod. # noqa: E501 + + + :return: The deleted of this PaymentMethod. # noqa: E501 :rtype: bool """ return self._deleted @deleted.setter def deleted(self, deleted): - """ - Sets the deleted of this PaymentMethod. - {\"default\" : \"false\", \"description\" : \"Indicates if a payment-method has been retired. If a payment-method has been retired it can still be retrieved using the appropriate flag on API requests. Generally payment-methods will be retired by customers wanting to remove the payment method from their account. Caution should be used when requested deleted payment methods.\", \"verbs\":[\"GET\"] } + """Sets the deleted of this PaymentMethod. + - :param deleted: The deleted of this PaymentMethod. + :param deleted: The deleted of this PaymentMethod. # noqa: E501 :type: bool """ @@ -688,34 +758,30 @@ def deleted(self, deleted): @property def default_payment_method(self): - """ - Gets the default_payment_method of this PaymentMethod. - {\"default\" : \"false\", \"description\" : \"Indicates if this is the default payment method for the account.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the default_payment_method of this PaymentMethod. # noqa: E501 + - :return: The default_payment_method of this PaymentMethod. + :return: The default_payment_method of this PaymentMethod. # noqa: E501 :rtype: bool """ return self._default_payment_method @default_payment_method.setter def default_payment_method(self, default_payment_method): - """ - Sets the default_payment_method of this PaymentMethod. - {\"default\" : \"false\", \"description\" : \"Indicates if this is the default payment method for the account.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the default_payment_method of this PaymentMethod. - :param default_payment_method: The default_payment_method of this PaymentMethod. + + :param default_payment_method: The default_payment_method of this PaymentMethod. # noqa: E501 :type: bool """ self._default_payment_method = default_payment_method def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -732,29 +798,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(PaymentMethod, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, PaymentMethod): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/payment_method_paged_metadata.py b/billforward/models/payment_method_paged_metadata.py deleted file mode 100644 index 59e9944..0000000 --- a/billforward/models/payment_method_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PaymentMethodPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - PaymentMethodPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[PaymentMethod]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this PaymentMethodPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this PaymentMethodPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this PaymentMethodPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this PaymentMethodPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this PaymentMethodPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this PaymentMethodPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this PaymentMethodPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this PaymentMethodPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this PaymentMethodPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this PaymentMethodPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this PaymentMethodPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this PaymentMethodPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this PaymentMethodPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this PaymentMethodPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this PaymentMethodPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this PaymentMethodPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this PaymentMethodPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this PaymentMethodPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this PaymentMethodPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this PaymentMethodPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this PaymentMethodPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this PaymentMethodPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this PaymentMethodPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this PaymentMethodPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this PaymentMethodPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this PaymentMethodPagedMetadata. - :rtype: list[PaymentMethod] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this PaymentMethodPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this PaymentMethodPagedMetadata. - :type: list[PaymentMethod] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/payment_method_subscription_link.py b/billforward/models/payment_method_subscription_link.py index d2c6949..75ca601 100644 --- a/billforward/models/payment_method_subscription_link.py +++ b/billforward/models/payment_method_subscription_link.py @@ -1,100 +1,107 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class PaymentMethodSubscriptionLink(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, crm_id=None, subscription_id=None, organization_id=None, payment_method_id=None, deleted=False, payment_method=None): - """ - PaymentMethodSubscriptionLink - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'crm_id': 'str', - 'subscription_id': 'str', - 'organization_id': 'str', - 'payment_method_id': 'str', - 'deleted': 'bool', - 'payment_method': 'PaymentMethod' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'crm_id': 'crmID', - 'subscription_id': 'subscriptionID', - 'organization_id': 'organizationID', - 'payment_method_id': 'paymentMethodID', - 'deleted': 'deleted', - 'payment_method': 'paymentMethod' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._crm_id = crm_id - self._subscription_id = subscription_id - self._organization_id = organization_id - self._payment_method_id = payment_method_id - self._deleted = deleted - self._payment_method = payment_method + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'crm_id': 'str', + 'subscription_id': 'str', + 'organization_id': 'str', + 'payment_method_id': 'str', + 'deleted': 'bool', + 'payment_method': 'PaymentMethod' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'crm_id': 'crmID', + 'subscription_id': 'subscriptionID', + 'organization_id': 'organizationID', + 'payment_method_id': 'paymentMethodID', + 'deleted': 'deleted', + 'payment_method': 'paymentMethod' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, crm_id=None, subscription_id=None, organization_id=None, payment_method_id=None, deleted=None, payment_method=None): # noqa: E501 + """PaymentMethodSubscriptionLink - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._crm_id = None + self._subscription_id = None + self._organization_id = None + self._payment_method_id = None + self._deleted = None + self._payment_method = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if crm_id is not None: + self.crm_id = crm_id + if subscription_id is not None: + self.subscription_id = subscription_id + if organization_id is not None: + self.organization_id = organization_id + self.payment_method_id = payment_method_id + if deleted is not None: + self.deleted = deleted + if payment_method is not None: + self.payment_method = payment_method @property def created(self): - """ - Gets the created of this PaymentMethodSubscriptionLink. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this PaymentMethodSubscriptionLink. # noqa: E501 + - :return: The created of this PaymentMethodSubscriptionLink. + :return: The created of this PaymentMethodSubscriptionLink. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this PaymentMethodSubscriptionLink. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this PaymentMethodSubscriptionLink. + - :param created: The created of this PaymentMethodSubscriptionLink. + :param created: The created of this PaymentMethodSubscriptionLink. # noqa: E501 :type: datetime """ @@ -102,22 +109,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this PaymentMethodSubscriptionLink. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this PaymentMethodSubscriptionLink. # noqa: E501 + - :return: The changed_by of this PaymentMethodSubscriptionLink. + :return: The changed_by of this PaymentMethodSubscriptionLink. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this PaymentMethodSubscriptionLink. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this PaymentMethodSubscriptionLink. + - :param changed_by: The changed_by of this PaymentMethodSubscriptionLink. + :param changed_by: The changed_by of this PaymentMethodSubscriptionLink. # noqa: E501 :type: str """ @@ -125,22 +130,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this PaymentMethodSubscriptionLink. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this PaymentMethodSubscriptionLink. # noqa: E501 + - :return: The updated of this PaymentMethodSubscriptionLink. + :return: The updated of this PaymentMethodSubscriptionLink. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this PaymentMethodSubscriptionLink. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this PaymentMethodSubscriptionLink. + - :param updated: The updated of this PaymentMethodSubscriptionLink. + :param updated: The updated of this PaymentMethodSubscriptionLink. # noqa: E501 :type: datetime """ @@ -148,22 +151,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this PaymentMethodSubscriptionLink. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the id of this PaymentMethodSubscriptionLink. # noqa: E501 + - :return: The id of this PaymentMethodSubscriptionLink. + :return: The id of this PaymentMethodSubscriptionLink. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this PaymentMethodSubscriptionLink. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the id of this PaymentMethodSubscriptionLink. - :param id: The id of this PaymentMethodSubscriptionLink. + + :param id: The id of this PaymentMethodSubscriptionLink. # noqa: E501 :type: str """ @@ -171,22 +172,20 @@ def id(self, id): @property def crm_id(self): - """ - Gets the crm_id of this PaymentMethodSubscriptionLink. - { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the crm_id of this PaymentMethodSubscriptionLink. # noqa: E501 - :return: The crm_id of this PaymentMethodSubscriptionLink. + + :return: The crm_id of this PaymentMethodSubscriptionLink. # noqa: E501 :rtype: str """ return self._crm_id @crm_id.setter def crm_id(self, crm_id): - """ - Sets the crm_id of this PaymentMethodSubscriptionLink. - { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the crm_id of this PaymentMethodSubscriptionLink. - :param crm_id: The crm_id of this PaymentMethodSubscriptionLink. + + :param crm_id: The crm_id of this PaymentMethodSubscriptionLink. # noqa: E501 :type: str """ @@ -194,22 +193,20 @@ def crm_id(self, crm_id): @property def subscription_id(self): - """ - Gets the subscription_id of this PaymentMethodSubscriptionLink. - { \"description\" : \"Subscription to add payment method to.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the subscription_id of this PaymentMethodSubscriptionLink. # noqa: E501 - :return: The subscription_id of this PaymentMethodSubscriptionLink. + + :return: The subscription_id of this PaymentMethodSubscriptionLink. # noqa: E501 :rtype: str """ return self._subscription_id @subscription_id.setter def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this PaymentMethodSubscriptionLink. - { \"description\" : \"Subscription to add payment method to.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the subscription_id of this PaymentMethodSubscriptionLink. - :param subscription_id: The subscription_id of this PaymentMethodSubscriptionLink. + + :param subscription_id: The subscription_id of this PaymentMethodSubscriptionLink. # noqa: E501 :type: str """ @@ -217,22 +214,20 @@ def subscription_id(self, subscription_id): @property def organization_id(self): - """ - Gets the organization_id of this PaymentMethodSubscriptionLink. + """Gets the organization_id of this PaymentMethodSubscriptionLink. # noqa: E501 - :return: The organization_id of this PaymentMethodSubscriptionLink. + :return: The organization_id of this PaymentMethodSubscriptionLink. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this PaymentMethodSubscriptionLink. + """Sets the organization_id of this PaymentMethodSubscriptionLink. - :param organization_id: The organization_id of this PaymentMethodSubscriptionLink. + :param organization_id: The organization_id of this PaymentMethodSubscriptionLink. # noqa: E501 :type: str """ @@ -240,45 +235,43 @@ def organization_id(self, organization_id): @property def payment_method_id(self): - """ - Gets the payment_method_id of this PaymentMethodSubscriptionLink. - { \"description\" : \"Payment method to add to subscription.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the payment_method_id of this PaymentMethodSubscriptionLink. # noqa: E501 - :return: The payment_method_id of this PaymentMethodSubscriptionLink. + + :return: The payment_method_id of this PaymentMethodSubscriptionLink. # noqa: E501 :rtype: str """ return self._payment_method_id @payment_method_id.setter def payment_method_id(self, payment_method_id): - """ - Sets the payment_method_id of this PaymentMethodSubscriptionLink. - { \"description\" : \"Payment method to add to subscription.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the payment_method_id of this PaymentMethodSubscriptionLink. - :param payment_method_id: The payment_method_id of this PaymentMethodSubscriptionLink. + + :param payment_method_id: The payment_method_id of this PaymentMethodSubscriptionLink. # noqa: E501 :type: str """ + if payment_method_id is None: + raise ValueError("Invalid value for `payment_method_id`, must not be `None`") # noqa: E501 self._payment_method_id = payment_method_id @property def deleted(self): - """ - Gets the deleted of this PaymentMethodSubscriptionLink. + """Gets the deleted of this PaymentMethodSubscriptionLink. # noqa: E501 - :return: The deleted of this PaymentMethodSubscriptionLink. + :return: The deleted of this PaymentMethodSubscriptionLink. # noqa: E501 :rtype: bool """ return self._deleted @deleted.setter def deleted(self, deleted): - """ - Sets the deleted of this PaymentMethodSubscriptionLink. + """Sets the deleted of this PaymentMethodSubscriptionLink. - :param deleted: The deleted of this PaymentMethodSubscriptionLink. + :param deleted: The deleted of this PaymentMethodSubscriptionLink. # noqa: E501 :type: bool """ @@ -286,34 +279,30 @@ def deleted(self, deleted): @property def payment_method(self): - """ - Gets the payment_method of this PaymentMethodSubscriptionLink. + """Gets the payment_method of this PaymentMethodSubscriptionLink. # noqa: E501 - :return: The payment_method of this PaymentMethodSubscriptionLink. + :return: The payment_method of this PaymentMethodSubscriptionLink. # noqa: E501 :rtype: PaymentMethod """ return self._payment_method @payment_method.setter def payment_method(self, payment_method): - """ - Sets the payment_method of this PaymentMethodSubscriptionLink. + """Sets the payment_method of this PaymentMethodSubscriptionLink. - :param payment_method: The payment_method of this PaymentMethodSubscriptionLink. + :param payment_method: The payment_method of this PaymentMethodSubscriptionLink. # noqa: E501 :type: PaymentMethod """ self._payment_method = payment_method def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -330,29 +319,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(PaymentMethodSubscriptionLink, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, PaymentMethodSubscriptionLink): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/payment_method_subscription_link_paged_metadata.py b/billforward/models/payment_method_subscription_link_paged_metadata.py deleted file mode 100644 index 048686f..0000000 --- a/billforward/models/payment_method_subscription_link_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PaymentMethodSubscriptionLinkPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - PaymentMethodSubscriptionLinkPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[PaymentMethodSubscriptionLink]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this PaymentMethodSubscriptionLinkPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this PaymentMethodSubscriptionLinkPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this PaymentMethodSubscriptionLinkPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this PaymentMethodSubscriptionLinkPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this PaymentMethodSubscriptionLinkPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this PaymentMethodSubscriptionLinkPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this PaymentMethodSubscriptionLinkPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this PaymentMethodSubscriptionLinkPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this PaymentMethodSubscriptionLinkPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this PaymentMethodSubscriptionLinkPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this PaymentMethodSubscriptionLinkPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this PaymentMethodSubscriptionLinkPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this PaymentMethodSubscriptionLinkPagedMetadata. - :rtype: list[PaymentMethodSubscriptionLink] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this PaymentMethodSubscriptionLinkPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this PaymentMethodSubscriptionLinkPagedMetadata. - :type: list[PaymentMethodSubscriptionLink] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/payment_paged_metadata.py b/billforward/models/payment_paged_metadata.py deleted file mode 100644 index 6e15245..0000000 --- a/billforward/models/payment_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PaymentPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - PaymentPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Payment]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this PaymentPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this PaymentPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this PaymentPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this PaymentPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this PaymentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this PaymentPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this PaymentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this PaymentPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this PaymentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this PaymentPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this PaymentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this PaymentPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this PaymentPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this PaymentPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this PaymentPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this PaymentPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this PaymentPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this PaymentPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this PaymentPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this PaymentPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this PaymentPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this PaymentPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this PaymentPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this PaymentPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this PaymentPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this PaymentPagedMetadata. - :rtype: list[Payment] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this PaymentPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this PaymentPagedMetadata. - :type: list[Payment] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/payment_refund_request.py b/billforward/models/payment_refund_request.py new file mode 100644 index 0000000..d4d2ea7 --- /dev/null +++ b/billforward/models/payment_refund_request.py @@ -0,0 +1,195 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PaymentRefundRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'reason': 'str', + 'amount': 'float', + 'virtual_refund_gateway_types': 'list[str]' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'reason': 'reason', + 'amount': 'amount', + 'virtual_refund_gateway_types': 'virtualRefundGatewayTypes' + } + + def __init__(self, organization_id=None, reason=None, amount=None, virtual_refund_gateway_types=None): # noqa: E501 + """PaymentRefundRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._reason = None + self._amount = None + self._virtual_refund_gateway_types = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if reason is not None: + self.reason = reason + if amount is not None: + self.amount = amount + if virtual_refund_gateway_types is not None: + self.virtual_refund_gateway_types = virtual_refund_gateway_types + + @property + def organization_id(self): + """Gets the organization_id of this PaymentRefundRequest. # noqa: E501 + + + :return: The organization_id of this PaymentRefundRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this PaymentRefundRequest. + + + :param organization_id: The organization_id of this PaymentRefundRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def reason(self): + """Gets the reason of this PaymentRefundRequest. # noqa: E501 + + + :return: The reason of this PaymentRefundRequest. # noqa: E501 + :rtype: str + """ + return self._reason + + @reason.setter + def reason(self, reason): + """Sets the reason of this PaymentRefundRequest. + + + :param reason: The reason of this PaymentRefundRequest. # noqa: E501 + :type: str + """ + + self._reason = reason + + @property + def amount(self): + """Gets the amount of this PaymentRefundRequest. # noqa: E501 + + + :return: The amount of this PaymentRefundRequest. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this PaymentRefundRequest. + + + :param amount: The amount of this PaymentRefundRequest. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def virtual_refund_gateway_types(self): + """Gets the virtual_refund_gateway_types of this PaymentRefundRequest. # noqa: E501 + + + :return: The virtual_refund_gateway_types of this PaymentRefundRequest. # noqa: E501 + :rtype: list[str] + """ + return self._virtual_refund_gateway_types + + @virtual_refund_gateway_types.setter + def virtual_refund_gateway_types(self, virtual_refund_gateway_types): + """Sets the virtual_refund_gateway_types of this PaymentRefundRequest. + + + :param virtual_refund_gateway_types: The virtual_refund_gateway_types of this PaymentRefundRequest. # noqa: E501 + :type: list[str] + """ + allowed_values = ["VOID", "cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "zooz", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "goCardless", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash", "epx", "shuttle", "square", "billforwardRandomizer", "cardConnect", "ebanx"] # noqa: E501 + if not set(virtual_refund_gateway_types).issubset(set(allowed_values)): + raise ValueError( + "Invalid values for `virtual_refund_gateway_types` [{0}], must be a subset of [{1}]" # noqa: E501 + .format(", ".join(map(str, set(virtual_refund_gateway_types) - set(allowed_values))), # noqa: E501 + ", ".join(map(str, allowed_values))) + ) + + self._virtual_refund_gateway_types = virtual_refund_gateway_types + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PaymentRefundRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PaymentRefundRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/payment_refund_response.py b/billforward/models/payment_refund_response.py new file mode 100644 index 0000000..2425514 --- /dev/null +++ b/billforward/models/payment_refund_response.py @@ -0,0 +1,292 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PaymentRefundResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'payment': 'Payment', + 'refunds': 'list[Refund]', + 'invoices': 'list[Invoice]', + 'organization_id': 'str', + 'requested_amount': 'float', + 'refunded_amount': 'float', + 'amount_left_to_refund': 'float' + } + + attribute_map = { + 'created': 'created', + 'payment': 'payment', + 'refunds': 'refunds', + 'invoices': 'invoices', + 'organization_id': 'organizationID', + 'requested_amount': 'requestedAmount', + 'refunded_amount': 'refundedAmount', + 'amount_left_to_refund': 'amountLeftToRefund' + } + + def __init__(self, created=None, payment=None, refunds=None, invoices=None, organization_id=None, requested_amount=None, refunded_amount=None, amount_left_to_refund=None): # noqa: E501 + """PaymentRefundResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._payment = None + self._refunds = None + self._invoices = None + self._organization_id = None + self._requested_amount = None + self._refunded_amount = None + self._amount_left_to_refund = None + self.discriminator = None + if created is not None: + self.created = created + if payment is not None: + self.payment = payment + if refunds is not None: + self.refunds = refunds + if invoices is not None: + self.invoices = invoices + if organization_id is not None: + self.organization_id = organization_id + if requested_amount is not None: + self.requested_amount = requested_amount + if refunded_amount is not None: + self.refunded_amount = refunded_amount + if amount_left_to_refund is not None: + self.amount_left_to_refund = amount_left_to_refund + + @property + def created(self): + """Gets the created of this PaymentRefundResponse. # noqa: E501 + + + :return: The created of this PaymentRefundResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this PaymentRefundResponse. + + + :param created: The created of this PaymentRefundResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def payment(self): + """Gets the payment of this PaymentRefundResponse. # noqa: E501 + + + :return: The payment of this PaymentRefundResponse. # noqa: E501 + :rtype: Payment + """ + return self._payment + + @payment.setter + def payment(self, payment): + """Sets the payment of this PaymentRefundResponse. + + + :param payment: The payment of this PaymentRefundResponse. # noqa: E501 + :type: Payment + """ + + self._payment = payment + + @property + def refunds(self): + """Gets the refunds of this PaymentRefundResponse. # noqa: E501 + + + :return: The refunds of this PaymentRefundResponse. # noqa: E501 + :rtype: list[Refund] + """ + return self._refunds + + @refunds.setter + def refunds(self, refunds): + """Sets the refunds of this PaymentRefundResponse. + + + :param refunds: The refunds of this PaymentRefundResponse. # noqa: E501 + :type: list[Refund] + """ + + self._refunds = refunds + + @property + def invoices(self): + """Gets the invoices of this PaymentRefundResponse. # noqa: E501 + + + :return: The invoices of this PaymentRefundResponse. # noqa: E501 + :rtype: list[Invoice] + """ + return self._invoices + + @invoices.setter + def invoices(self, invoices): + """Sets the invoices of this PaymentRefundResponse. + + + :param invoices: The invoices of this PaymentRefundResponse. # noqa: E501 + :type: list[Invoice] + """ + + self._invoices = invoices + + @property + def organization_id(self): + """Gets the organization_id of this PaymentRefundResponse. # noqa: E501 + + + :return: The organization_id of this PaymentRefundResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this PaymentRefundResponse. + + + :param organization_id: The organization_id of this PaymentRefundResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def requested_amount(self): + """Gets the requested_amount of this PaymentRefundResponse. # noqa: E501 + + + :return: The requested_amount of this PaymentRefundResponse. # noqa: E501 + :rtype: float + """ + return self._requested_amount + + @requested_amount.setter + def requested_amount(self, requested_amount): + """Sets the requested_amount of this PaymentRefundResponse. + + + :param requested_amount: The requested_amount of this PaymentRefundResponse. # noqa: E501 + :type: float + """ + + self._requested_amount = requested_amount + + @property + def refunded_amount(self): + """Gets the refunded_amount of this PaymentRefundResponse. # noqa: E501 + + + :return: The refunded_amount of this PaymentRefundResponse. # noqa: E501 + :rtype: float + """ + return self._refunded_amount + + @refunded_amount.setter + def refunded_amount(self, refunded_amount): + """Sets the refunded_amount of this PaymentRefundResponse. + + + :param refunded_amount: The refunded_amount of this PaymentRefundResponse. # noqa: E501 + :type: float + """ + + self._refunded_amount = refunded_amount + + @property + def amount_left_to_refund(self): + """Gets the amount_left_to_refund of this PaymentRefundResponse. # noqa: E501 + + + :return: The amount_left_to_refund of this PaymentRefundResponse. # noqa: E501 + :rtype: float + """ + return self._amount_left_to_refund + + @amount_left_to_refund.setter + def amount_left_to_refund(self, amount_left_to_refund): + """Sets the amount_left_to_refund of this PaymentRefundResponse. + + + :param amount_left_to_refund: The amount_left_to_refund of this PaymentRefundResponse. # noqa: E501 + :type: float + """ + + self._amount_left_to_refund = amount_left_to_refund + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PaymentRefundResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PaymentRefundResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/payment_retry_request.py b/billforward/models/payment_retry_request.py index eb934f8..c2984b4 100644 --- a/billforward/models/payment_retry_request.py +++ b/billforward/models/payment_retry_request.py @@ -1,76 +1,68 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class PaymentRetryRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, organization_id=None, retry_time=None): - """ - PaymentRetryRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'organization_id': 'str', - 'retry_time': 'datetime' - } - - self.attribute_map = { - 'organization_id': 'organizationID', - 'retry_time': 'retryTime' - } - - self._organization_id = organization_id - self._retry_time = retry_time + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'retry_time': 'datetime' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'retry_time': 'retryTime' + } + + def __init__(self, organization_id=None, retry_time=None): # noqa: E501 + """PaymentRetryRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._retry_time = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if retry_time is not None: + self.retry_time = retry_time @property def organization_id(self): - """ - Gets the organization_id of this PaymentRetryRequest. - { \"description\" : \"\", \"verbs\":[] } + """Gets the organization_id of this PaymentRetryRequest. # noqa: E501 - :return: The organization_id of this PaymentRetryRequest. + + :return: The organization_id of this PaymentRetryRequest. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this PaymentRetryRequest. - { \"description\" : \"\", \"verbs\":[] } + """Sets the organization_id of this PaymentRetryRequest. - :param organization_id: The organization_id of this PaymentRetryRequest. + + :param organization_id: The organization_id of this PaymentRetryRequest. # noqa: E501 :type: str """ @@ -78,34 +70,30 @@ def organization_id(self, organization_id): @property def retry_time(self): - """ - Gets the retry_time of this PaymentRetryRequest. - { \"default\" : \"immediately\", \"description\" : \"When the payment retry will be attempted\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the retry_time of this PaymentRetryRequest. # noqa: E501 - :return: The retry_time of this PaymentRetryRequest. + + :return: The retry_time of this PaymentRetryRequest. # noqa: E501 :rtype: datetime """ return self._retry_time @retry_time.setter def retry_time(self, retry_time): - """ - Sets the retry_time of this PaymentRetryRequest. - { \"default\" : \"immediately\", \"description\" : \"When the payment retry will be attempted\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the retry_time of this PaymentRetryRequest. - :param retry_time: The retry_time of this PaymentRetryRequest. + + :param retry_time: The retry_time of this PaymentRetryRequest. # noqa: E501 :type: datetime """ self._retry_time = retry_time def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -122,29 +110,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(PaymentRetryRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, PaymentRetryRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/paypal_configuration.py b/billforward/models/paypal_configuration.py new file mode 100644 index 0000000..a0a3b26 --- /dev/null +++ b/billforward/models/paypal_configuration.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class PaypalConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """PaypalConfiguration - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + APIConfiguration.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PaypalConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PaypalConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/paypal_payment.py b/billforward/models/paypal_payment.py new file mode 100644 index 0000000..84eaaa8 --- /dev/null +++ b/billforward/models/paypal_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class PaypalPayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """PaypalPayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PaypalPayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PaypalPayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/pending_component_value_change.py b/billforward/models/pending_component_value_change.py index 022ad71..cde88f9 100644 --- a/billforward/models/pending_component_value_change.py +++ b/billforward/models/pending_component_value_change.py @@ -1,82 +1,78 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class PendingComponentValueChange(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, value=None, at=None, discard_url=None, discard_http_verb=None): - """ - PendingComponentValueChange - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'value': 'int', - 'at': 'datetime', - 'discard_url': 'str', - 'discard_http_verb': 'str' - } - - self.attribute_map = { - 'value': 'value', - 'at': 'at', - 'discard_url': 'discardUrl', - 'discard_http_verb': 'discardHttpVerb' - } - - self._value = value - self._at = at - self._discard_url = discard_url - self._discard_http_verb = discard_http_verb + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'value': 'int', + 'at': 'datetime', + 'discard_url': 'str', + 'discard_http_verb': 'str' + } + + attribute_map = { + 'value': 'value', + 'at': 'at', + 'discard_url': 'discardUrl', + 'discard_http_verb': 'discardHttpVerb' + } + + def __init__(self, value=None, at=None, discard_url=None, discard_http_verb=None): # noqa: E501 + """PendingComponentValueChange - a model defined in Swagger""" # noqa: E501 + self._value = None + self._at = None + self._discard_url = None + self._discard_http_verb = None + self.discriminator = None + if value is not None: + self.value = value + if at is not None: + self.at = at + if discard_url is not None: + self.discard_url = discard_url + if discard_http_verb is not None: + self.discard_http_verb = discard_http_verb @property def value(self): - """ - Gets the value of this PendingComponentValueChange. + """Gets the value of this PendingComponentValueChange. # noqa: E501 - :return: The value of this PendingComponentValueChange. + :return: The value of this PendingComponentValueChange. # noqa: E501 :rtype: int """ return self._value @value.setter def value(self, value): - """ - Sets the value of this PendingComponentValueChange. + """Sets the value of this PendingComponentValueChange. - :param value: The value of this PendingComponentValueChange. + :param value: The value of this PendingComponentValueChange. # noqa: E501 :type: int """ @@ -84,22 +80,20 @@ def value(self, value): @property def at(self): - """ - Gets the at of this PendingComponentValueChange. + """Gets the at of this PendingComponentValueChange. # noqa: E501 - :return: The at of this PendingComponentValueChange. + :return: The at of this PendingComponentValueChange. # noqa: E501 :rtype: datetime """ return self._at @at.setter def at(self, at): - """ - Sets the at of this PendingComponentValueChange. + """Sets the at of this PendingComponentValueChange. - :param at: The at of this PendingComponentValueChange. + :param at: The at of this PendingComponentValueChange. # noqa: E501 :type: datetime """ @@ -107,22 +101,20 @@ def at(self, at): @property def discard_url(self): - """ - Gets the discard_url of this PendingComponentValueChange. + """Gets the discard_url of this PendingComponentValueChange. # noqa: E501 - :return: The discard_url of this PendingComponentValueChange. + :return: The discard_url of this PendingComponentValueChange. # noqa: E501 :rtype: str """ return self._discard_url @discard_url.setter def discard_url(self, discard_url): - """ - Sets the discard_url of this PendingComponentValueChange. + """Sets the discard_url of this PendingComponentValueChange. - :param discard_url: The discard_url of this PendingComponentValueChange. + :param discard_url: The discard_url of this PendingComponentValueChange. # noqa: E501 :type: str """ @@ -130,34 +122,30 @@ def discard_url(self, discard_url): @property def discard_http_verb(self): - """ - Gets the discard_http_verb of this PendingComponentValueChange. + """Gets the discard_http_verb of this PendingComponentValueChange. # noqa: E501 - :return: The discard_http_verb of this PendingComponentValueChange. + :return: The discard_http_verb of this PendingComponentValueChange. # noqa: E501 :rtype: str """ return self._discard_http_verb @discard_http_verb.setter def discard_http_verb(self, discard_http_verb): - """ - Sets the discard_http_verb of this PendingComponentValueChange. + """Sets the discard_http_verb of this PendingComponentValueChange. - :param discard_http_verb: The discard_http_verb of this PendingComponentValueChange. + :param discard_http_verb: The discard_http_verb of this PendingComponentValueChange. # noqa: E501 :type: str """ self._discard_http_verb = discard_http_verb def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -174,29 +162,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(PendingComponentValueChange, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, PendingComponentValueChange): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/period.py b/billforward/models/period.py deleted file mode 100644 index fbeffb3..0000000 --- a/billforward/models/period.py +++ /dev/null @@ -1,344 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class Period(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, subscription_id=None, organization_id=None, invoice_id=None, state=None, period=None, start=None, stop=None, usage_type=None): - """ - Period - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'subscription_id': 'str', - 'organization_id': 'str', - 'invoice_id': 'str', - 'state': 'str', - 'period': 'int', - 'start': 'datetime', - 'stop': 'datetime', - 'usage_type': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'subscription_id': 'subscriptionID', - 'organization_id': 'organizationID', - 'invoice_id': 'invoiceID', - 'state': 'state', - 'period': 'period', - 'start': 'start', - 'stop': 'stop', - 'usage_type': 'usageType' - } - - self._created = created - self._subscription_id = subscription_id - self._organization_id = organization_id - self._invoice_id = invoice_id - self._state = state - self._period = period - self._start = start - self._stop = stop - self._usage_type = usage_type - - @property - def created(self): - """ - Gets the created of this Period. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this Period. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this Period. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this Period. - :type: datetime - """ - - self._created = created - - @property - def subscription_id(self): - """ - Gets the subscription_id of this Period. - { \"description\" : \"ID of the subscription to which this billing period pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this Period. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this Period. - { \"description\" : \"ID of the subscription to which this billing period pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this Period. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def organization_id(self): - """ - Gets the organization_id of this Period. - { \"description\" : \"Organization associated with this billing period.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this Period. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this Period. - { \"description\" : \"Organization associated with this billing period.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this Period. - :type: str - """ - - self._organization_id = organization_id - - @property - def invoice_id(self): - """ - Gets the invoice_id of this Period. - - - :return: The invoice_id of this Period. - :rtype: str - """ - return self._invoice_id - - @invoice_id.setter - def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this Period. - - - :param invoice_id: The invoice_id of this Period. - :type: str - """ - - self._invoice_id = invoice_id - - @property - def state(self): - """ - Gets the state of this Period. - { \"description\" : \"The current state of this billing period. Initially a period is '\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] }ACTIVE_STATE'. Once the 'stop' date is passed, the billing period becomes HISTORIC_STATE. - - :return: The state of this Period. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this Period. - { \"description\" : \"The current state of this billing period. Initially a period is '\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] }ACTIVE_STATE'. Once the 'stop' date is passed, the billing period becomes HISTORIC_STATE. - - :param state: The state of this Period. - :type: str - """ - allowed_values = ["Active", "Historic"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def period(self): - """ - Gets the period of this Period. - { \"description\" : \"The incarnation of the subscription to which this billing period refers. The first incarnation of the subscription is in 'period 0'. A recurring subscription may enter 'period 1' and further.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The period of this Period. - :rtype: int - """ - return self._period - - @period.setter - def period(self, period): - """ - Sets the period of this Period. - { \"description\" : \"The incarnation of the subscription to which this billing period refers. The first incarnation of the subscription is in 'period 0'. A recurring subscription may enter 'period 1' and further.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param period: The period of this Period. - :type: int - """ - - self._period = period - - @property - def start(self): - """ - Gets the start of this Period. - { \"description\" : \"The start date of this billing period, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The start of this Period. - :rtype: datetime - """ - return self._start - - @start.setter - def start(self, start): - """ - Sets the start of this Period. - { \"description\" : \"The start date of this billing period, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param start: The start of this Period. - :type: datetime - """ - - self._start = start - - @property - def stop(self): - """ - Gets the stop of this Period. - { \"description\" : \"The end date of this billing period, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The stop of this Period. - :rtype: datetime - """ - return self._stop - - @stop.setter - def stop(self, stop): - """ - Sets the stop of this Period. - { \"description\" : \"The end date of this billing period, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param stop: The stop of this Period. - :type: datetime - """ - - self._stop = stop - - @property - def usage_type(self): - """ - Gets the usage_type of this Period. - { \"description\" : \"The type of usage measured within this billing period. Options are '\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] }Temporal which refers to time-based usage and Itemized, which refers to one-off usages. - - :return: The usage_type of this Period. - :rtype: str - """ - return self._usage_type - - @usage_type.setter - def usage_type(self, usage_type): - """ - Sets the usage_type of this Period. - { \"description\" : \"The type of usage measured within this billing period. Options are '\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] }Temporal which refers to time-based usage and Itemized, which refers to one-off usages. - - :param usage_type: The usage_type of this Period. - :type: str - """ - allowed_values = ["Temporal", "Itemized"] - if usage_type not in allowed_values: - raise ValueError( - "Invalid value for `usage_type` ({0}), must be one of {1}" - .format(usage_type, allowed_values) - ) - - self._usage_type = usage_type - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/period_paged_metadata.py b/billforward/models/period_paged_metadata.py deleted file mode 100644 index 0b567ab..0000000 --- a/billforward/models/period_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PeriodPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - PeriodPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Period]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this PeriodPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this PeriodPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this PeriodPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this PeriodPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this PeriodPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this PeriodPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this PeriodPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this PeriodPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this PeriodPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this PeriodPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this PeriodPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this PeriodPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this PeriodPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this PeriodPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this PeriodPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this PeriodPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this PeriodPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this PeriodPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this PeriodPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this PeriodPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this PeriodPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this PeriodPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this PeriodPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this PeriodPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this PeriodPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this PeriodPagedMetadata. - :rtype: list[Period] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this PeriodPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this PeriodPagedMetadata. - :type: list[Period] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/permission_action_entity.py b/billforward/models/permission_action_entity.py new file mode 100644 index 0000000..bc246d4 --- /dev/null +++ b/billforward/models/permission_action_entity.py @@ -0,0 +1,169 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PermissionActionEntity(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'actions': 'list[str]' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'actions': 'actions' + } + + def __init__(self, created=None, organization_id=None, actions=None): # noqa: E501 + """PermissionActionEntity - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._actions = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if actions is not None: + self.actions = actions + + @property + def created(self): + """Gets the created of this PermissionActionEntity. # noqa: E501 + + + :return: The created of this PermissionActionEntity. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this PermissionActionEntity. + + + :param created: The created of this PermissionActionEntity. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this PermissionActionEntity. # noqa: E501 + + + :return: The organization_id of this PermissionActionEntity. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this PermissionActionEntity. + + + :param organization_id: The organization_id of this PermissionActionEntity. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def actions(self): + """Gets the actions of this PermissionActionEntity. # noqa: E501 + + + :return: The actions of this PermissionActionEntity. # noqa: E501 + :rtype: list[str] + """ + return self._actions + + @actions.setter + def actions(self, actions): + """Sets the actions of this PermissionActionEntity. + + + :param actions: The actions of this PermissionActionEntity. # noqa: E501 + :type: list[str] + """ + allowed_values = ["All", "AddToInvoice", "AddToAccount", "AddToProductRatePlan", "AddToSubscription", "Advance", "Aggregate", "RemoveFromInvoice", "RemoveFromProductRatePlan", "RemoveFromSubscription", "Cancel", "Create", "Delete", "Edit", "Execute", "Freeze", "Import", "InvoiceCharges", "Issue", "MetadataCreate", "MetadataEdit", "MetadataDelete", "Migrate", "Read", "Recalculate", "Refund", "Reset", "Resume", "Revive", "Start", "Stop", "Tokenize", "Void"] # noqa: E501 + if not set(actions).issubset(set(allowed_values)): + raise ValueError( + "Invalid values for `actions` [{0}], must be a subset of [{1}]" # noqa: E501 + .format(", ".join(map(str, set(actions) - set(allowed_values))), # noqa: E501 + ", ".join(map(str, allowed_values))) + ) + + self._actions = actions + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PermissionActionEntity, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PermissionActionEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/permission_action_entity_paged_metadata.py b/billforward/models/permission_action_entity_paged_metadata.py deleted file mode 100644 index 4de6f3d..0000000 --- a/billforward/models/permission_action_entity_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PermissionActionEntityPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - PermissionActionEntityPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this PermissionActionEntityPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this PermissionActionEntityPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this PermissionActionEntityPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this PermissionActionEntityPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this PermissionActionEntityPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this PermissionActionEntityPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this PermissionActionEntityPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this PermissionActionEntityPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this PermissionActionEntityPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this PermissionActionEntityPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this PermissionActionEntityPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this PermissionActionEntityPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this PermissionActionEntityPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this PermissionActionEntityPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this PermissionActionEntityPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this PermissionActionEntityPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this PermissionActionEntityPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this PermissionActionEntityPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this PermissionActionEntityPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this PermissionActionEntityPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this PermissionActionEntityPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this PermissionActionEntityPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this PermissionActionEntityPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this PermissionActionEntityPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this PermissionActionEntityPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this PermissionActionEntityPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this PermissionActionEntityPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this PermissionActionEntityPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/permission_resource_entity.py b/billforward/models/permission_resource_entity.py new file mode 100644 index 0000000..e96112e --- /dev/null +++ b/billforward/models/permission_resource_entity.py @@ -0,0 +1,169 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PermissionResourceEntity(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'resources': 'list[str]' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'resources': 'resources' + } + + def __init__(self, created=None, organization_id=None, resources=None): # noqa: E501 + """PermissionResourceEntity - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._resources = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if resources is not None: + self.resources = resources + + @property + def created(self): + """Gets the created of this PermissionResourceEntity. # noqa: E501 + + + :return: The created of this PermissionResourceEntity. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this PermissionResourceEntity. + + + :param created: The created of this PermissionResourceEntity. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this PermissionResourceEntity. # noqa: E501 + + + :return: The organization_id of this PermissionResourceEntity. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this PermissionResourceEntity. + + + :param organization_id: The organization_id of this PermissionResourceEntity. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def resources(self): + """Gets the resources of this PermissionResourceEntity. # noqa: E501 + + + :return: The resources of this PermissionResourceEntity. # noqa: E501 + :rtype: list[str] + """ + return self._resources + + @resources.setter + def resources(self, resources): + """Sets the resources of this PermissionResourceEntity. + + + :param resources: The resources of this PermissionResourceEntity. # noqa: E501 + :type: list[str] + """ + allowed_values = ["All", "Account", "Address", "Amendment", "Analytics", "Audit", "BFAdmin", "BFJS", "Charge", "CheckoutDefinition", "Client", "Configuration", "CouponBook", "CouponBookDefinition", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "Coupon", "Credit", "CybersourceToken", "Dunning", "Email", "FixedTerm", "Gateway", "Invoice", "InvoiceTemplateConfiguration", "Metadata", "Notification", "Organization", "OrganizationProfile", "Password", "PaymentMethod", "Payment", "Permission", "PricingComponent", "PricingComponentTier", "PricingComponentValueChange", "PricingComponentValue", "ProductRatePlan", "Product", "ProductResources", "Profile", "SubscriptionNotificationConfiguration", "Quote", "Receipt", "Report", "Refund", "Salesforce", "Search", "Subscription", "Tax", "UnitOfMeasure", "Usage", "Username", "User", "UserResources", "Webhook", "Contract", "Xero", "QuickBooks", "ContractPeriod", "HubSpot", "EmailNotifications", "EmailNotificationsConfig", "Shuttle", "RequestLogging"] # noqa: E501 + if not set(resources).issubset(set(allowed_values)): + raise ValueError( + "Invalid values for `resources` [{0}], must be a subset of [{1}]" # noqa: E501 + .format(", ".join(map(str, set(resources) - set(allowed_values))), # noqa: E501 + ", ".join(map(str, allowed_values))) + ) + + self._resources = resources + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PermissionResourceEntity, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PermissionResourceEntity): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/permission_resource_entity_paged_metadata.py b/billforward/models/permission_resource_entity_paged_metadata.py deleted file mode 100644 index cc20171..0000000 --- a/billforward/models/permission_resource_entity_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PermissionResourceEntityPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - PermissionResourceEntityPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this PermissionResourceEntityPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this PermissionResourceEntityPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this PermissionResourceEntityPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this PermissionResourceEntityPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this PermissionResourceEntityPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this PermissionResourceEntityPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this PermissionResourceEntityPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this PermissionResourceEntityPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this PermissionResourceEntityPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this PermissionResourceEntityPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this PermissionResourceEntityPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this PermissionResourceEntityPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this PermissionResourceEntityPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this PermissionResourceEntityPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this PermissionResourceEntityPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this PermissionResourceEntityPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this PermissionResourceEntityPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this PermissionResourceEntityPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this PermissionResourceEntityPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this PermissionResourceEntityPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this PermissionResourceEntityPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this PermissionResourceEntityPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this PermissionResourceEntityPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this PermissionResourceEntityPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this PermissionResourceEntityPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this PermissionResourceEntityPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this PermissionResourceEntityPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this PermissionResourceEntityPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/plan_aggregation.py b/billforward/models/plan_aggregation.py new file mode 100644 index 0000000..a08bcbb --- /dev/null +++ b/billforward/models/plan_aggregation.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PlanAggregation(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'pricing_components': 'list[AggregatingComponentDescription]' + } + + attribute_map = { + 'pricing_components': 'pricingComponents' + } + + def __init__(self, pricing_components=None): # noqa: E501 + """PlanAggregation - a model defined in Swagger""" # noqa: E501 + self._pricing_components = None + self.discriminator = None + if pricing_components is not None: + self.pricing_components = pricing_components + + @property + def pricing_components(self): + """Gets the pricing_components of this PlanAggregation. # noqa: E501 + + + :return: The pricing_components of this PlanAggregation. # noqa: E501 + :rtype: list[AggregatingComponentDescription] + """ + return self._pricing_components + + @pricing_components.setter + def pricing_components(self, pricing_components): + """Sets the pricing_components of this PlanAggregation. + + + :param pricing_components: The pricing_components of this PlanAggregation. # noqa: E501 + :type: list[AggregatingComponentDescription] + """ + + self._pricing_components = pricing_components + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PlanAggregation, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PlanAggregation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/plan_request.py b/billforward/models/plan_request.py new file mode 100644 index 0000000..ef0795c --- /dev/null +++ b/billforward/models/plan_request.py @@ -0,0 +1,730 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PlanRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'display_name': 'str', + 'description': 'str', + 'tax_status': 'str', + 'failed_payment_behaviour': 'str', + 'duration': 'int', + 'duration_period': 'str', + 'trial': 'int', + 'trial_period': 'str', + 'pro_rata_mode': 'str', + 'localised_tax': 'bool', + 'create_zero_valued_invoices': 'bool', + 'migration_behaviour': 'str', + 'invoice_issue_type': 'str', + 'issue_duration': 'int', + 'issue_period': 'str', + 'payment_terms': 'int', + 'generate_service_end_invoice': 'bool', + 'fixed_term': 'FixedTerm', + 'taxation_strategies': 'list[str]', + 'pricing': 'PricingComponentsByChargeType', + 'metadata': 'dict(str, object)', + 'path': 'str' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'display_name': 'displayName', + 'description': 'description', + 'tax_status': 'taxStatus', + 'failed_payment_behaviour': 'failedPaymentBehaviour', + 'duration': 'duration', + 'duration_period': 'durationPeriod', + 'trial': 'trial', + 'trial_period': 'trialPeriod', + 'pro_rata_mode': 'proRataMode', + 'localised_tax': 'localisedTax', + 'create_zero_valued_invoices': 'createZeroValuedInvoices', + 'migration_behaviour': 'migrationBehaviour', + 'invoice_issue_type': 'invoiceIssueType', + 'issue_duration': 'issueDuration', + 'issue_period': 'issuePeriod', + 'payment_terms': 'paymentTerms', + 'generate_service_end_invoice': 'generateServiceEndInvoice', + 'fixed_term': 'fixedTerm', + 'taxation_strategies': 'taxationStrategies', + 'pricing': 'pricing', + 'metadata': 'metadata', + 'path': 'path' + } + + def __init__(self, organization_id=None, display_name=None, description=None, tax_status=None, failed_payment_behaviour=None, duration=None, duration_period=None, trial=None, trial_period=None, pro_rata_mode=None, localised_tax=None, create_zero_valued_invoices=None, migration_behaviour=None, invoice_issue_type=None, issue_duration=None, issue_period=None, payment_terms=None, generate_service_end_invoice=None, fixed_term=None, taxation_strategies=None, pricing=None, metadata=None, path=None): # noqa: E501 + """PlanRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._display_name = None + self._description = None + self._tax_status = None + self._failed_payment_behaviour = None + self._duration = None + self._duration_period = None + self._trial = None + self._trial_period = None + self._pro_rata_mode = None + self._localised_tax = None + self._create_zero_valued_invoices = None + self._migration_behaviour = None + self._invoice_issue_type = None + self._issue_duration = None + self._issue_period = None + self._payment_terms = None + self._generate_service_end_invoice = None + self._fixed_term = None + self._taxation_strategies = None + self._pricing = None + self._metadata = None + self._path = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if display_name is not None: + self.display_name = display_name + if description is not None: + self.description = description + if tax_status is not None: + self.tax_status = tax_status + if failed_payment_behaviour is not None: + self.failed_payment_behaviour = failed_payment_behaviour + if duration is not None: + self.duration = duration + if duration_period is not None: + self.duration_period = duration_period + if trial is not None: + self.trial = trial + if trial_period is not None: + self.trial_period = trial_period + if pro_rata_mode is not None: + self.pro_rata_mode = pro_rata_mode + if localised_tax is not None: + self.localised_tax = localised_tax + if create_zero_valued_invoices is not None: + self.create_zero_valued_invoices = create_zero_valued_invoices + if migration_behaviour is not None: + self.migration_behaviour = migration_behaviour + if invoice_issue_type is not None: + self.invoice_issue_type = invoice_issue_type + if issue_duration is not None: + self.issue_duration = issue_duration + if issue_period is not None: + self.issue_period = issue_period + if payment_terms is not None: + self.payment_terms = payment_terms + if generate_service_end_invoice is not None: + self.generate_service_end_invoice = generate_service_end_invoice + if fixed_term is not None: + self.fixed_term = fixed_term + if taxation_strategies is not None: + self.taxation_strategies = taxation_strategies + if pricing is not None: + self.pricing = pricing + if metadata is not None: + self.metadata = metadata + if path is not None: + self.path = path + + @property + def organization_id(self): + """Gets the organization_id of this PlanRequest. # noqa: E501 + + + :return: The organization_id of this PlanRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this PlanRequest. + + + :param organization_id: The organization_id of this PlanRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def display_name(self): + """Gets the display_name of this PlanRequest. # noqa: E501 + + + :return: The display_name of this PlanRequest. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this PlanRequest. + + + :param display_name: The display_name of this PlanRequest. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def description(self): + """Gets the description of this PlanRequest. # noqa: E501 + + + :return: The description of this PlanRequest. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this PlanRequest. + + + :param description: The description of this PlanRequest. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def tax_status(self): + """Gets the tax_status of this PlanRequest. # noqa: E501 + + + :return: The tax_status of this PlanRequest. # noqa: E501 + :rtype: str + """ + return self._tax_status + + @tax_status.setter + def tax_status(self, tax_status): + """Sets the tax_status of this PlanRequest. + + + :param tax_status: The tax_status of this PlanRequest. # noqa: E501 + :type: str + """ + allowed_values = ["inclusive", "exclusive"] # noqa: E501 + if tax_status not in allowed_values: + raise ValueError( + "Invalid value for `tax_status` ({0}), must be one of {1}" # noqa: E501 + .format(tax_status, allowed_values) + ) + + self._tax_status = tax_status + + @property + def failed_payment_behaviour(self): + """Gets the failed_payment_behaviour of this PlanRequest. # noqa: E501 + + + :return: The failed_payment_behaviour of this PlanRequest. # noqa: E501 + :rtype: str + """ + return self._failed_payment_behaviour + + @failed_payment_behaviour.setter + def failed_payment_behaviour(self, failed_payment_behaviour): + """Sets the failed_payment_behaviour of this PlanRequest. + + + :param failed_payment_behaviour: The failed_payment_behaviour of this PlanRequest. # noqa: E501 + :type: str + """ + allowed_values = ["CancelSubscription", "None"] # noqa: E501 + if failed_payment_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `failed_payment_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(failed_payment_behaviour, allowed_values) + ) + + self._failed_payment_behaviour = failed_payment_behaviour + + @property + def duration(self): + """Gets the duration of this PlanRequest. # noqa: E501 + + + :return: The duration of this PlanRequest. # noqa: E501 + :rtype: int + """ + return self._duration + + @duration.setter + def duration(self, duration): + """Sets the duration of this PlanRequest. + + + :param duration: The duration of this PlanRequest. # noqa: E501 + :type: int + """ + + self._duration = duration + + @property + def duration_period(self): + """Gets the duration_period of this PlanRequest. # noqa: E501 + + + :return: The duration_period of this PlanRequest. # noqa: E501 + :rtype: str + """ + return self._duration_period + + @duration_period.setter + def duration_period(self, duration_period): + """Sets the duration_period of this PlanRequest. + + + :param duration_period: The duration_period of this PlanRequest. # noqa: E501 + :type: str + """ + allowed_values = ["minutes", "days", "months", "years"] # noqa: E501 + if duration_period not in allowed_values: + raise ValueError( + "Invalid value for `duration_period` ({0}), must be one of {1}" # noqa: E501 + .format(duration_period, allowed_values) + ) + + self._duration_period = duration_period + + @property + def trial(self): + """Gets the trial of this PlanRequest. # noqa: E501 + + + :return: The trial of this PlanRequest. # noqa: E501 + :rtype: int + """ + return self._trial + + @trial.setter + def trial(self, trial): + """Sets the trial of this PlanRequest. + + + :param trial: The trial of this PlanRequest. # noqa: E501 + :type: int + """ + + self._trial = trial + + @property + def trial_period(self): + """Gets the trial_period of this PlanRequest. # noqa: E501 + + + :return: The trial_period of this PlanRequest. # noqa: E501 + :rtype: str + """ + return self._trial_period + + @trial_period.setter + def trial_period(self, trial_period): + """Sets the trial_period of this PlanRequest. + + + :param trial_period: The trial_period of this PlanRequest. # noqa: E501 + :type: str + """ + allowed_values = ["none", "minutes", "days", "months"] # noqa: E501 + if trial_period not in allowed_values: + raise ValueError( + "Invalid value for `trial_period` ({0}), must be one of {1}" # noqa: E501 + .format(trial_period, allowed_values) + ) + + self._trial_period = trial_period + + @property + def pro_rata_mode(self): + """Gets the pro_rata_mode of this PlanRequest. # noqa: E501 + + + :return: The pro_rata_mode of this PlanRequest. # noqa: E501 + :rtype: str + """ + return self._pro_rata_mode + + @pro_rata_mode.setter + def pro_rata_mode(self, pro_rata_mode): + """Sets the pro_rata_mode of this PlanRequest. + + + :param pro_rata_mode: The pro_rata_mode of this PlanRequest. # noqa: E501 + :type: str + """ + allowed_values = ["None", "WithCoupon", "WithoutCoupon", "Full"] # noqa: E501 + if pro_rata_mode not in allowed_values: + raise ValueError( + "Invalid value for `pro_rata_mode` ({0}), must be one of {1}" # noqa: E501 + .format(pro_rata_mode, allowed_values) + ) + + self._pro_rata_mode = pro_rata_mode + + @property + def localised_tax(self): + """Gets the localised_tax of this PlanRequest. # noqa: E501 + + + :return: The localised_tax of this PlanRequest. # noqa: E501 + :rtype: bool + """ + return self._localised_tax + + @localised_tax.setter + def localised_tax(self, localised_tax): + """Sets the localised_tax of this PlanRequest. + + + :param localised_tax: The localised_tax of this PlanRequest. # noqa: E501 + :type: bool + """ + + self._localised_tax = localised_tax + + @property + def create_zero_valued_invoices(self): + """Gets the create_zero_valued_invoices of this PlanRequest. # noqa: E501 + + + :return: The create_zero_valued_invoices of this PlanRequest. # noqa: E501 + :rtype: bool + """ + return self._create_zero_valued_invoices + + @create_zero_valued_invoices.setter + def create_zero_valued_invoices(self, create_zero_valued_invoices): + """Sets the create_zero_valued_invoices of this PlanRequest. + + + :param create_zero_valued_invoices: The create_zero_valued_invoices of this PlanRequest. # noqa: E501 + :type: bool + """ + + self._create_zero_valued_invoices = create_zero_valued_invoices + + @property + def migration_behaviour(self): + """Gets the migration_behaviour of this PlanRequest. # noqa: E501 + + + :return: The migration_behaviour of this PlanRequest. # noqa: E501 + :rtype: str + """ + return self._migration_behaviour + + @migration_behaviour.setter + def migration_behaviour(self, migration_behaviour): + """Sets the migration_behaviour of this PlanRequest. + + + :param migration_behaviour: The migration_behaviour of this PlanRequest. # noqa: E501 + :type: str + """ + allowed_values = ["NoCharge", "CreditAccount"] # noqa: E501 + if migration_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `migration_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(migration_behaviour, allowed_values) + ) + + self._migration_behaviour = migration_behaviour + + @property + def invoice_issue_type(self): + """Gets the invoice_issue_type of this PlanRequest. # noqa: E501 + + + :return: The invoice_issue_type of this PlanRequest. # noqa: E501 + :rtype: str + """ + return self._invoice_issue_type + + @invoice_issue_type.setter + def invoice_issue_type(self, invoice_issue_type): + """Sets the invoice_issue_type of this PlanRequest. + + + :param invoice_issue_type: The invoice_issue_type of this PlanRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Immediate", "Delayed", "Manual"] # noqa: E501 + if invoice_issue_type not in allowed_values: + raise ValueError( + "Invalid value for `invoice_issue_type` ({0}), must be one of {1}" # noqa: E501 + .format(invoice_issue_type, allowed_values) + ) + + self._invoice_issue_type = invoice_issue_type + + @property + def issue_duration(self): + """Gets the issue_duration of this PlanRequest. # noqa: E501 + + + :return: The issue_duration of this PlanRequest. # noqa: E501 + :rtype: int + """ + return self._issue_duration + + @issue_duration.setter + def issue_duration(self, issue_duration): + """Sets the issue_duration of this PlanRequest. + + + :param issue_duration: The issue_duration of this PlanRequest. # noqa: E501 + :type: int + """ + + self._issue_duration = issue_duration + + @property + def issue_period(self): + """Gets the issue_period of this PlanRequest. # noqa: E501 + + + :return: The issue_period of this PlanRequest. # noqa: E501 + :rtype: str + """ + return self._issue_period + + @issue_period.setter + def issue_period(self, issue_period): + """Sets the issue_period of this PlanRequest. + + + :param issue_period: The issue_period of this PlanRequest. # noqa: E501 + :type: str + """ + allowed_values = ["minutes", "days", "months", "years"] # noqa: E501 + if issue_period not in allowed_values: + raise ValueError( + "Invalid value for `issue_period` ({0}), must be one of {1}" # noqa: E501 + .format(issue_period, allowed_values) + ) + + self._issue_period = issue_period + + @property + def payment_terms(self): + """Gets the payment_terms of this PlanRequest. # noqa: E501 + + + :return: The payment_terms of this PlanRequest. # noqa: E501 + :rtype: int + """ + return self._payment_terms + + @payment_terms.setter + def payment_terms(self, payment_terms): + """Sets the payment_terms of this PlanRequest. + + + :param payment_terms: The payment_terms of this PlanRequest. # noqa: E501 + :type: int + """ + + self._payment_terms = payment_terms + + @property + def generate_service_end_invoice(self): + """Gets the generate_service_end_invoice of this PlanRequest. # noqa: E501 + + + :return: The generate_service_end_invoice of this PlanRequest. # noqa: E501 + :rtype: bool + """ + return self._generate_service_end_invoice + + @generate_service_end_invoice.setter + def generate_service_end_invoice(self, generate_service_end_invoice): + """Sets the generate_service_end_invoice of this PlanRequest. + + + :param generate_service_end_invoice: The generate_service_end_invoice of this PlanRequest. # noqa: E501 + :type: bool + """ + + self._generate_service_end_invoice = generate_service_end_invoice + + @property + def fixed_term(self): + """Gets the fixed_term of this PlanRequest. # noqa: E501 + + + :return: The fixed_term of this PlanRequest. # noqa: E501 + :rtype: FixedTerm + """ + return self._fixed_term + + @fixed_term.setter + def fixed_term(self, fixed_term): + """Sets the fixed_term of this PlanRequest. + + + :param fixed_term: The fixed_term of this PlanRequest. # noqa: E501 + :type: FixedTerm + """ + + self._fixed_term = fixed_term + + @property + def taxation_strategies(self): + """Gets the taxation_strategies of this PlanRequest. # noqa: E501 + + + :return: The taxation_strategies of this PlanRequest. # noqa: E501 + :rtype: list[str] + """ + return self._taxation_strategies + + @taxation_strategies.setter + def taxation_strategies(self, taxation_strategies): + """Sets the taxation_strategies of this PlanRequest. + + + :param taxation_strategies: The taxation_strategies of this PlanRequest. # noqa: E501 + :type: list[str] + """ + + self._taxation_strategies = taxation_strategies + + @property + def pricing(self): + """Gets the pricing of this PlanRequest. # noqa: E501 + + + :return: The pricing of this PlanRequest. # noqa: E501 + :rtype: PricingComponentsByChargeType + """ + return self._pricing + + @pricing.setter + def pricing(self, pricing): + """Sets the pricing of this PlanRequest. + + + :param pricing: The pricing of this PlanRequest. # noqa: E501 + :type: PricingComponentsByChargeType + """ + + self._pricing = pricing + + @property + def metadata(self): + """Gets the metadata of this PlanRequest. # noqa: E501 + + + :return: The metadata of this PlanRequest. # noqa: E501 + :rtype: dict(str, object) + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """Sets the metadata of this PlanRequest. + + + :param metadata: The metadata of this PlanRequest. # noqa: E501 + :type: dict(str, object) + """ + + self._metadata = metadata + + @property + def path(self): + """Gets the path of this PlanRequest. # noqa: E501 + + + :return: The path of this PlanRequest. # noqa: E501 + :rtype: str + """ + return self._path + + @path.setter + def path(self, path): + """Sets the path of this PlanRequest. + + + :param path: The path of this PlanRequest. # noqa: E501 + :type: str + """ + + self._path = path + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PlanRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PlanRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/plan_response.py b/billforward/models/plan_response.py new file mode 100644 index 0000000..daeb473 --- /dev/null +++ b/billforward/models/plan_response.py @@ -0,0 +1,886 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PlanResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'id': 'str', + 'path': 'str', + 'name': 'str', + 'display_name': 'str', + 'description': 'str', + 'currency': 'CreditNoteCurrency', + 'tax_status': 'str', + 'failed_payment_behaviour': 'str', + 'duration': 'int', + 'duration_period': 'str', + 'trial': 'int', + 'trial_period': 'str', + 'pro_rata_mode': 'str', + 'localised_tax': 'bool', + 'create_zero_valued_invoices': 'bool', + 'migration_behaviour': 'str', + 'invoice_issue_type': 'str', + 'issue_duration': 'int', + 'issue_period': 'str', + 'payment_terms': 'int', + 'generate_service_end_invoice': 'bool', + 'fixed_term': 'FixedTerm', + 'taxation_strategies': 'list[str]', + 'pricing': 'PricingComponentsByChargeType', + 'valid_from': 'datetime', + 'valid_till': 'datetime', + 'metadata': 'dict(str, object)' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'id': 'id', + 'path': 'path', + 'name': 'name', + 'display_name': 'displayName', + 'description': 'description', + 'currency': 'currency', + 'tax_status': 'taxStatus', + 'failed_payment_behaviour': 'failedPaymentBehaviour', + 'duration': 'duration', + 'duration_period': 'durationPeriod', + 'trial': 'trial', + 'trial_period': 'trialPeriod', + 'pro_rata_mode': 'proRataMode', + 'localised_tax': 'localisedTax', + 'create_zero_valued_invoices': 'createZeroValuedInvoices', + 'migration_behaviour': 'migrationBehaviour', + 'invoice_issue_type': 'invoiceIssueType', + 'issue_duration': 'issueDuration', + 'issue_period': 'issuePeriod', + 'payment_terms': 'paymentTerms', + 'generate_service_end_invoice': 'generateServiceEndInvoice', + 'fixed_term': 'fixedTerm', + 'taxation_strategies': 'taxationStrategies', + 'pricing': 'pricing', + 'valid_from': 'validFrom', + 'valid_till': 'validTill', + 'metadata': 'metadata' + } + + def __init__(self, created=None, organization_id=None, id=None, path=None, name=None, display_name=None, description=None, currency=None, tax_status=None, failed_payment_behaviour=None, duration=None, duration_period=None, trial=None, trial_period=None, pro_rata_mode=None, localised_tax=None, create_zero_valued_invoices=None, migration_behaviour=None, invoice_issue_type=None, issue_duration=None, issue_period=None, payment_terms=None, generate_service_end_invoice=None, fixed_term=None, taxation_strategies=None, pricing=None, valid_from=None, valid_till=None, metadata=None): # noqa: E501 + """PlanResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._id = None + self._path = None + self._name = None + self._display_name = None + self._description = None + self._currency = None + self._tax_status = None + self._failed_payment_behaviour = None + self._duration = None + self._duration_period = None + self._trial = None + self._trial_period = None + self._pro_rata_mode = None + self._localised_tax = None + self._create_zero_valued_invoices = None + self._migration_behaviour = None + self._invoice_issue_type = None + self._issue_duration = None + self._issue_period = None + self._payment_terms = None + self._generate_service_end_invoice = None + self._fixed_term = None + self._taxation_strategies = None + self._pricing = None + self._valid_from = None + self._valid_till = None + self._metadata = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if id is not None: + self.id = id + if path is not None: + self.path = path + if name is not None: + self.name = name + if display_name is not None: + self.display_name = display_name + if description is not None: + self.description = description + if currency is not None: + self.currency = currency + if tax_status is not None: + self.tax_status = tax_status + if failed_payment_behaviour is not None: + self.failed_payment_behaviour = failed_payment_behaviour + if duration is not None: + self.duration = duration + if duration_period is not None: + self.duration_period = duration_period + if trial is not None: + self.trial = trial + if trial_period is not None: + self.trial_period = trial_period + if pro_rata_mode is not None: + self.pro_rata_mode = pro_rata_mode + if localised_tax is not None: + self.localised_tax = localised_tax + if create_zero_valued_invoices is not None: + self.create_zero_valued_invoices = create_zero_valued_invoices + if migration_behaviour is not None: + self.migration_behaviour = migration_behaviour + if invoice_issue_type is not None: + self.invoice_issue_type = invoice_issue_type + if issue_duration is not None: + self.issue_duration = issue_duration + if issue_period is not None: + self.issue_period = issue_period + if payment_terms is not None: + self.payment_terms = payment_terms + if generate_service_end_invoice is not None: + self.generate_service_end_invoice = generate_service_end_invoice + if fixed_term is not None: + self.fixed_term = fixed_term + if taxation_strategies is not None: + self.taxation_strategies = taxation_strategies + if pricing is not None: + self.pricing = pricing + if valid_from is not None: + self.valid_from = valid_from + if valid_till is not None: + self.valid_till = valid_till + if metadata is not None: + self.metadata = metadata + + @property + def created(self): + """Gets the created of this PlanResponse. # noqa: E501 + + + :return: The created of this PlanResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this PlanResponse. + + + :param created: The created of this PlanResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this PlanResponse. # noqa: E501 + + + :return: The organization_id of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this PlanResponse. + + + :param organization_id: The organization_id of this PlanResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def id(self): + """Gets the id of this PlanResponse. # noqa: E501 + + + :return: The id of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this PlanResponse. + + + :param id: The id of this PlanResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def path(self): + """Gets the path of this PlanResponse. # noqa: E501 + + + :return: The path of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._path + + @path.setter + def path(self, path): + """Sets the path of this PlanResponse. + + + :param path: The path of this PlanResponse. # noqa: E501 + :type: str + """ + + self._path = path + + @property + def name(self): + """Gets the name of this PlanResponse. # noqa: E501 + + + :return: The name of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this PlanResponse. + + + :param name: The name of this PlanResponse. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def display_name(self): + """Gets the display_name of this PlanResponse. # noqa: E501 + + + :return: The display_name of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this PlanResponse. + + + :param display_name: The display_name of this PlanResponse. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def description(self): + """Gets the description of this PlanResponse. # noqa: E501 + + + :return: The description of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this PlanResponse. + + + :param description: The description of this PlanResponse. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def currency(self): + """Gets the currency of this PlanResponse. # noqa: E501 + + + :return: The currency of this PlanResponse. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this PlanResponse. + + + :param currency: The currency of this PlanResponse. # noqa: E501 + :type: CreditNoteCurrency + """ + + self._currency = currency + + @property + def tax_status(self): + """Gets the tax_status of this PlanResponse. # noqa: E501 + + + :return: The tax_status of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._tax_status + + @tax_status.setter + def tax_status(self, tax_status): + """Sets the tax_status of this PlanResponse. + + + :param tax_status: The tax_status of this PlanResponse. # noqa: E501 + :type: str + """ + allowed_values = ["inclusive", "exclusive"] # noqa: E501 + if tax_status not in allowed_values: + raise ValueError( + "Invalid value for `tax_status` ({0}), must be one of {1}" # noqa: E501 + .format(tax_status, allowed_values) + ) + + self._tax_status = tax_status + + @property + def failed_payment_behaviour(self): + """Gets the failed_payment_behaviour of this PlanResponse. # noqa: E501 + + + :return: The failed_payment_behaviour of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._failed_payment_behaviour + + @failed_payment_behaviour.setter + def failed_payment_behaviour(self, failed_payment_behaviour): + """Sets the failed_payment_behaviour of this PlanResponse. + + + :param failed_payment_behaviour: The failed_payment_behaviour of this PlanResponse. # noqa: E501 + :type: str + """ + allowed_values = ["CancelSubscription", "None"] # noqa: E501 + if failed_payment_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `failed_payment_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(failed_payment_behaviour, allowed_values) + ) + + self._failed_payment_behaviour = failed_payment_behaviour + + @property + def duration(self): + """Gets the duration of this PlanResponse. # noqa: E501 + + + :return: The duration of this PlanResponse. # noqa: E501 + :rtype: int + """ + return self._duration + + @duration.setter + def duration(self, duration): + """Sets the duration of this PlanResponse. + + + :param duration: The duration of this PlanResponse. # noqa: E501 + :type: int + """ + + self._duration = duration + + @property + def duration_period(self): + """Gets the duration_period of this PlanResponse. # noqa: E501 + + + :return: The duration_period of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._duration_period + + @duration_period.setter + def duration_period(self, duration_period): + """Sets the duration_period of this PlanResponse. + + + :param duration_period: The duration_period of this PlanResponse. # noqa: E501 + :type: str + """ + allowed_values = ["minutes", "days", "months", "years"] # noqa: E501 + if duration_period not in allowed_values: + raise ValueError( + "Invalid value for `duration_period` ({0}), must be one of {1}" # noqa: E501 + .format(duration_period, allowed_values) + ) + + self._duration_period = duration_period + + @property + def trial(self): + """Gets the trial of this PlanResponse. # noqa: E501 + + + :return: The trial of this PlanResponse. # noqa: E501 + :rtype: int + """ + return self._trial + + @trial.setter + def trial(self, trial): + """Sets the trial of this PlanResponse. + + + :param trial: The trial of this PlanResponse. # noqa: E501 + :type: int + """ + + self._trial = trial + + @property + def trial_period(self): + """Gets the trial_period of this PlanResponse. # noqa: E501 + + + :return: The trial_period of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._trial_period + + @trial_period.setter + def trial_period(self, trial_period): + """Sets the trial_period of this PlanResponse. + + + :param trial_period: The trial_period of this PlanResponse. # noqa: E501 + :type: str + """ + allowed_values = ["none", "minutes", "days", "months"] # noqa: E501 + if trial_period not in allowed_values: + raise ValueError( + "Invalid value for `trial_period` ({0}), must be one of {1}" # noqa: E501 + .format(trial_period, allowed_values) + ) + + self._trial_period = trial_period + + @property + def pro_rata_mode(self): + """Gets the pro_rata_mode of this PlanResponse. # noqa: E501 + + + :return: The pro_rata_mode of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._pro_rata_mode + + @pro_rata_mode.setter + def pro_rata_mode(self, pro_rata_mode): + """Sets the pro_rata_mode of this PlanResponse. + + + :param pro_rata_mode: The pro_rata_mode of this PlanResponse. # noqa: E501 + :type: str + """ + allowed_values = ["None", "WithCoupon", "WithoutCoupon", "Full"] # noqa: E501 + if pro_rata_mode not in allowed_values: + raise ValueError( + "Invalid value for `pro_rata_mode` ({0}), must be one of {1}" # noqa: E501 + .format(pro_rata_mode, allowed_values) + ) + + self._pro_rata_mode = pro_rata_mode + + @property + def localised_tax(self): + """Gets the localised_tax of this PlanResponse. # noqa: E501 + + + :return: The localised_tax of this PlanResponse. # noqa: E501 + :rtype: bool + """ + return self._localised_tax + + @localised_tax.setter + def localised_tax(self, localised_tax): + """Sets the localised_tax of this PlanResponse. + + + :param localised_tax: The localised_tax of this PlanResponse. # noqa: E501 + :type: bool + """ + + self._localised_tax = localised_tax + + @property + def create_zero_valued_invoices(self): + """Gets the create_zero_valued_invoices of this PlanResponse. # noqa: E501 + + + :return: The create_zero_valued_invoices of this PlanResponse. # noqa: E501 + :rtype: bool + """ + return self._create_zero_valued_invoices + + @create_zero_valued_invoices.setter + def create_zero_valued_invoices(self, create_zero_valued_invoices): + """Sets the create_zero_valued_invoices of this PlanResponse. + + + :param create_zero_valued_invoices: The create_zero_valued_invoices of this PlanResponse. # noqa: E501 + :type: bool + """ + + self._create_zero_valued_invoices = create_zero_valued_invoices + + @property + def migration_behaviour(self): + """Gets the migration_behaviour of this PlanResponse. # noqa: E501 + + + :return: The migration_behaviour of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._migration_behaviour + + @migration_behaviour.setter + def migration_behaviour(self, migration_behaviour): + """Sets the migration_behaviour of this PlanResponse. + + + :param migration_behaviour: The migration_behaviour of this PlanResponse. # noqa: E501 + :type: str + """ + allowed_values = ["NoCharge", "CreditAccount"] # noqa: E501 + if migration_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `migration_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(migration_behaviour, allowed_values) + ) + + self._migration_behaviour = migration_behaviour + + @property + def invoice_issue_type(self): + """Gets the invoice_issue_type of this PlanResponse. # noqa: E501 + + + :return: The invoice_issue_type of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._invoice_issue_type + + @invoice_issue_type.setter + def invoice_issue_type(self, invoice_issue_type): + """Sets the invoice_issue_type of this PlanResponse. + + + :param invoice_issue_type: The invoice_issue_type of this PlanResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Immediate", "Delayed", "Manual"] # noqa: E501 + if invoice_issue_type not in allowed_values: + raise ValueError( + "Invalid value for `invoice_issue_type` ({0}), must be one of {1}" # noqa: E501 + .format(invoice_issue_type, allowed_values) + ) + + self._invoice_issue_type = invoice_issue_type + + @property + def issue_duration(self): + """Gets the issue_duration of this PlanResponse. # noqa: E501 + + + :return: The issue_duration of this PlanResponse. # noqa: E501 + :rtype: int + """ + return self._issue_duration + + @issue_duration.setter + def issue_duration(self, issue_duration): + """Sets the issue_duration of this PlanResponse. + + + :param issue_duration: The issue_duration of this PlanResponse. # noqa: E501 + :type: int + """ + + self._issue_duration = issue_duration + + @property + def issue_period(self): + """Gets the issue_period of this PlanResponse. # noqa: E501 + + + :return: The issue_period of this PlanResponse. # noqa: E501 + :rtype: str + """ + return self._issue_period + + @issue_period.setter + def issue_period(self, issue_period): + """Sets the issue_period of this PlanResponse. + + + :param issue_period: The issue_period of this PlanResponse. # noqa: E501 + :type: str + """ + allowed_values = ["minutes", "days", "months", "years"] # noqa: E501 + if issue_period not in allowed_values: + raise ValueError( + "Invalid value for `issue_period` ({0}), must be one of {1}" # noqa: E501 + .format(issue_period, allowed_values) + ) + + self._issue_period = issue_period + + @property + def payment_terms(self): + """Gets the payment_terms of this PlanResponse. # noqa: E501 + + + :return: The payment_terms of this PlanResponse. # noqa: E501 + :rtype: int + """ + return self._payment_terms + + @payment_terms.setter + def payment_terms(self, payment_terms): + """Sets the payment_terms of this PlanResponse. + + + :param payment_terms: The payment_terms of this PlanResponse. # noqa: E501 + :type: int + """ + + self._payment_terms = payment_terms + + @property + def generate_service_end_invoice(self): + """Gets the generate_service_end_invoice of this PlanResponse. # noqa: E501 + + + :return: The generate_service_end_invoice of this PlanResponse. # noqa: E501 + :rtype: bool + """ + return self._generate_service_end_invoice + + @generate_service_end_invoice.setter + def generate_service_end_invoice(self, generate_service_end_invoice): + """Sets the generate_service_end_invoice of this PlanResponse. + + + :param generate_service_end_invoice: The generate_service_end_invoice of this PlanResponse. # noqa: E501 + :type: bool + """ + + self._generate_service_end_invoice = generate_service_end_invoice + + @property + def fixed_term(self): + """Gets the fixed_term of this PlanResponse. # noqa: E501 + + + :return: The fixed_term of this PlanResponse. # noqa: E501 + :rtype: FixedTerm + """ + return self._fixed_term + + @fixed_term.setter + def fixed_term(self, fixed_term): + """Sets the fixed_term of this PlanResponse. + + + :param fixed_term: The fixed_term of this PlanResponse. # noqa: E501 + :type: FixedTerm + """ + + self._fixed_term = fixed_term + + @property + def taxation_strategies(self): + """Gets the taxation_strategies of this PlanResponse. # noqa: E501 + + + :return: The taxation_strategies of this PlanResponse. # noqa: E501 + :rtype: list[str] + """ + return self._taxation_strategies + + @taxation_strategies.setter + def taxation_strategies(self, taxation_strategies): + """Sets the taxation_strategies of this PlanResponse. + + + :param taxation_strategies: The taxation_strategies of this PlanResponse. # noqa: E501 + :type: list[str] + """ + + self._taxation_strategies = taxation_strategies + + @property + def pricing(self): + """Gets the pricing of this PlanResponse. # noqa: E501 + + + :return: The pricing of this PlanResponse. # noqa: E501 + :rtype: PricingComponentsByChargeType + """ + return self._pricing + + @pricing.setter + def pricing(self, pricing): + """Sets the pricing of this PlanResponse. + + + :param pricing: The pricing of this PlanResponse. # noqa: E501 + :type: PricingComponentsByChargeType + """ + + self._pricing = pricing + + @property + def valid_from(self): + """Gets the valid_from of this PlanResponse. # noqa: E501 + + + :return: The valid_from of this PlanResponse. # noqa: E501 + :rtype: datetime + """ + return self._valid_from + + @valid_from.setter + def valid_from(self, valid_from): + """Sets the valid_from of this PlanResponse. + + + :param valid_from: The valid_from of this PlanResponse. # noqa: E501 + :type: datetime + """ + + self._valid_from = valid_from + + @property + def valid_till(self): + """Gets the valid_till of this PlanResponse. # noqa: E501 + + + :return: The valid_till of this PlanResponse. # noqa: E501 + :rtype: datetime + """ + return self._valid_till + + @valid_till.setter + def valid_till(self, valid_till): + """Sets the valid_till of this PlanResponse. + + + :param valid_till: The valid_till of this PlanResponse. # noqa: E501 + :type: datetime + """ + + self._valid_till = valid_till + + @property + def metadata(self): + """Gets the metadata of this PlanResponse. # noqa: E501 + + + :return: The metadata of this PlanResponse. # noqa: E501 + :rtype: dict(str, object) + """ + return self._metadata + + @metadata.setter + def metadata(self, metadata): + """Sets the metadata of this PlanResponse. + + + :param metadata: The metadata of this PlanResponse. # noqa: E501 + :type: dict(str, object) + """ + + self._metadata = metadata + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PlanResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PlanResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/prepayment_charge.py b/billforward/models/prepayment_charge.py new file mode 100644 index 0000000..199fa91 --- /dev/null +++ b/billforward/models/prepayment_charge.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.subscription_charge import SubscriptionCharge # noqa: F401,E501 + +class PrepaymentCharge(SubscriptionCharge): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(SubscriptionCharge, "swagger_types"): + swagger_types.update(SubscriptionCharge.swagger_types) + + attribute_map = { + } + if hasattr(SubscriptionCharge, "attribute_map"): + attribute_map.update(SubscriptionCharge.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """PrepaymentCharge - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + SubscriptionCharge.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PrepaymentCharge, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PrepaymentCharge): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/price_breakdown.py b/billforward/models/price_breakdown.py new file mode 100644 index 0000000..520a6dd --- /dev/null +++ b/billforward/models/price_breakdown.py @@ -0,0 +1,240 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PriceBreakdown(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'total_cost': 'float', + 'total_cost_excluding_tax': 'float', + 'tax': 'float', + 'proration': 'float', + 'price_lines': 'list[PriceLine]', + 'calculation_details': 'str' + } + + attribute_map = { + 'total_cost': 'totalCost', + 'total_cost_excluding_tax': 'totalCostExcludingTax', + 'tax': 'tax', + 'proration': 'proration', + 'price_lines': 'priceLines', + 'calculation_details': 'calculationDetails' + } + + def __init__(self, total_cost=None, total_cost_excluding_tax=None, tax=None, proration=None, price_lines=None, calculation_details=None): # noqa: E501 + """PriceBreakdown - a model defined in Swagger""" # noqa: E501 + self._total_cost = None + self._total_cost_excluding_tax = None + self._tax = None + self._proration = None + self._price_lines = None + self._calculation_details = None + self.discriminator = None + if total_cost is not None: + self.total_cost = total_cost + if total_cost_excluding_tax is not None: + self.total_cost_excluding_tax = total_cost_excluding_tax + if tax is not None: + self.tax = tax + if proration is not None: + self.proration = proration + if price_lines is not None: + self.price_lines = price_lines + if calculation_details is not None: + self.calculation_details = calculation_details + + @property + def total_cost(self): + """Gets the total_cost of this PriceBreakdown. # noqa: E501 + + + :return: The total_cost of this PriceBreakdown. # noqa: E501 + :rtype: float + """ + return self._total_cost + + @total_cost.setter + def total_cost(self, total_cost): + """Sets the total_cost of this PriceBreakdown. + + + :param total_cost: The total_cost of this PriceBreakdown. # noqa: E501 + :type: float + """ + + self._total_cost = total_cost + + @property + def total_cost_excluding_tax(self): + """Gets the total_cost_excluding_tax of this PriceBreakdown. # noqa: E501 + + + :return: The total_cost_excluding_tax of this PriceBreakdown. # noqa: E501 + :rtype: float + """ + return self._total_cost_excluding_tax + + @total_cost_excluding_tax.setter + def total_cost_excluding_tax(self, total_cost_excluding_tax): + """Sets the total_cost_excluding_tax of this PriceBreakdown. + + + :param total_cost_excluding_tax: The total_cost_excluding_tax of this PriceBreakdown. # noqa: E501 + :type: float + """ + + self._total_cost_excluding_tax = total_cost_excluding_tax + + @property + def tax(self): + """Gets the tax of this PriceBreakdown. # noqa: E501 + + + :return: The tax of this PriceBreakdown. # noqa: E501 + :rtype: float + """ + return self._tax + + @tax.setter + def tax(self, tax): + """Sets the tax of this PriceBreakdown. + + + :param tax: The tax of this PriceBreakdown. # noqa: E501 + :type: float + """ + + self._tax = tax + + @property + def proration(self): + """Gets the proration of this PriceBreakdown. # noqa: E501 + + + :return: The proration of this PriceBreakdown. # noqa: E501 + :rtype: float + """ + return self._proration + + @proration.setter + def proration(self, proration): + """Sets the proration of this PriceBreakdown. + + + :param proration: The proration of this PriceBreakdown. # noqa: E501 + :type: float + """ + + self._proration = proration + + @property + def price_lines(self): + """Gets the price_lines of this PriceBreakdown. # noqa: E501 + + + :return: The price_lines of this PriceBreakdown. # noqa: E501 + :rtype: list[PriceLine] + """ + return self._price_lines + + @price_lines.setter + def price_lines(self, price_lines): + """Sets the price_lines of this PriceBreakdown. + + + :param price_lines: The price_lines of this PriceBreakdown. # noqa: E501 + :type: list[PriceLine] + """ + + self._price_lines = price_lines + + @property + def calculation_details(self): + """Gets the calculation_details of this PriceBreakdown. # noqa: E501 + + + :return: The calculation_details of this PriceBreakdown. # noqa: E501 + :rtype: str + """ + return self._calculation_details + + @calculation_details.setter + def calculation_details(self, calculation_details): + """Sets the calculation_details of this PriceBreakdown. + + + :param calculation_details: The calculation_details of this PriceBreakdown. # noqa: E501 + :type: str + """ + + self._calculation_details = calculation_details + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PriceBreakdown, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PriceBreakdown): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/price_calculation_paged_metadata.py b/billforward/models/price_calculation_paged_metadata.py deleted file mode 100644 index 70c1f2c..0000000 --- a/billforward/models/price_calculation_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PriceCalculationPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - PriceCalculationPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this PriceCalculationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this PriceCalculationPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this PriceCalculationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this PriceCalculationPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this PriceCalculationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this PriceCalculationPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this PriceCalculationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this PriceCalculationPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this PriceCalculationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this PriceCalculationPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this PriceCalculationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this PriceCalculationPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this PriceCalculationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this PriceCalculationPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this PriceCalculationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this PriceCalculationPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this PriceCalculationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this PriceCalculationPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this PriceCalculationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this PriceCalculationPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this PriceCalculationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this PriceCalculationPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this PriceCalculationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this PriceCalculationPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this PriceCalculationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this PriceCalculationPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this PriceCalculationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this PriceCalculationPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/price_line.py b/billforward/models/price_line.py new file mode 100644 index 0000000..8b0947e --- /dev/null +++ b/billforward/models/price_line.py @@ -0,0 +1,532 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PriceLine(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'tier_id': 'str', + 'pricing_component_version_id': 'str', + 'pricing_component_id': 'str', + 'product_rate_plan_id': 'str', + 'lower_threshold': 'int', + 'upper_threshold': 'int', + 'pricing_type': 'str', + 'calculation_details': 'str', + 'unit_price': 'float', + 'unit_price_excluding_tax': 'float', + 'prorated_unit_price': 'float', + 'prorated_unit_price_excluding_tax': 'float', + 'quantity': 'int', + 'cost': 'float', + 'cost_excluding_tax': 'float', + 'prorated_cost': 'float', + 'prorated_cost_excluding_tax': 'float' + } + + attribute_map = { + 'tier_id': 'tierID', + 'pricing_component_version_id': 'pricingComponentVersionID', + 'pricing_component_id': 'pricingComponentID', + 'product_rate_plan_id': 'productRatePlanID', + 'lower_threshold': 'lowerThreshold', + 'upper_threshold': 'upperThreshold', + 'pricing_type': 'pricingType', + 'calculation_details': 'calculationDetails', + 'unit_price': 'unitPrice', + 'unit_price_excluding_tax': 'unitPriceExcludingTax', + 'prorated_unit_price': 'proratedUnitPrice', + 'prorated_unit_price_excluding_tax': 'proratedUnitPriceExcludingTax', + 'quantity': 'quantity', + 'cost': 'cost', + 'cost_excluding_tax': 'costExcludingTax', + 'prorated_cost': 'proratedCost', + 'prorated_cost_excluding_tax': 'proratedCostExcludingTax' + } + + def __init__(self, tier_id=None, pricing_component_version_id=None, pricing_component_id=None, product_rate_plan_id=None, lower_threshold=None, upper_threshold=None, pricing_type=None, calculation_details=None, unit_price=None, unit_price_excluding_tax=None, prorated_unit_price=None, prorated_unit_price_excluding_tax=None, quantity=None, cost=None, cost_excluding_tax=None, prorated_cost=None, prorated_cost_excluding_tax=None): # noqa: E501 + """PriceLine - a model defined in Swagger""" # noqa: E501 + self._tier_id = None + self._pricing_component_version_id = None + self._pricing_component_id = None + self._product_rate_plan_id = None + self._lower_threshold = None + self._upper_threshold = None + self._pricing_type = None + self._calculation_details = None + self._unit_price = None + self._unit_price_excluding_tax = None + self._prorated_unit_price = None + self._prorated_unit_price_excluding_tax = None + self._quantity = None + self._cost = None + self._cost_excluding_tax = None + self._prorated_cost = None + self._prorated_cost_excluding_tax = None + self.discriminator = None + if tier_id is not None: + self.tier_id = tier_id + if pricing_component_version_id is not None: + self.pricing_component_version_id = pricing_component_version_id + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + if product_rate_plan_id is not None: + self.product_rate_plan_id = product_rate_plan_id + if lower_threshold is not None: + self.lower_threshold = lower_threshold + if upper_threshold is not None: + self.upper_threshold = upper_threshold + if pricing_type is not None: + self.pricing_type = pricing_type + if calculation_details is not None: + self.calculation_details = calculation_details + if unit_price is not None: + self.unit_price = unit_price + if unit_price_excluding_tax is not None: + self.unit_price_excluding_tax = unit_price_excluding_tax + if prorated_unit_price is not None: + self.prorated_unit_price = prorated_unit_price + if prorated_unit_price_excluding_tax is not None: + self.prorated_unit_price_excluding_tax = prorated_unit_price_excluding_tax + if quantity is not None: + self.quantity = quantity + if cost is not None: + self.cost = cost + if cost_excluding_tax is not None: + self.cost_excluding_tax = cost_excluding_tax + if prorated_cost is not None: + self.prorated_cost = prorated_cost + if prorated_cost_excluding_tax is not None: + self.prorated_cost_excluding_tax = prorated_cost_excluding_tax + + @property + def tier_id(self): + """Gets the tier_id of this PriceLine. # noqa: E501 + + + :return: The tier_id of this PriceLine. # noqa: E501 + :rtype: str + """ + return self._tier_id + + @tier_id.setter + def tier_id(self, tier_id): + """Sets the tier_id of this PriceLine. + + + :param tier_id: The tier_id of this PriceLine. # noqa: E501 + :type: str + """ + + self._tier_id = tier_id + + @property + def pricing_component_version_id(self): + """Gets the pricing_component_version_id of this PriceLine. # noqa: E501 + + + :return: The pricing_component_version_id of this PriceLine. # noqa: E501 + :rtype: str + """ + return self._pricing_component_version_id + + @pricing_component_version_id.setter + def pricing_component_version_id(self, pricing_component_version_id): + """Sets the pricing_component_version_id of this PriceLine. + + + :param pricing_component_version_id: The pricing_component_version_id of this PriceLine. # noqa: E501 + :type: str + """ + + self._pricing_component_version_id = pricing_component_version_id + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this PriceLine. # noqa: E501 + + + :return: The pricing_component_id of this PriceLine. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this PriceLine. + + + :param pricing_component_id: The pricing_component_id of this PriceLine. # noqa: E501 + :type: str + """ + + self._pricing_component_id = pricing_component_id + + @property + def product_rate_plan_id(self): + """Gets the product_rate_plan_id of this PriceLine. # noqa: E501 + + + :return: The product_rate_plan_id of this PriceLine. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_id + + @product_rate_plan_id.setter + def product_rate_plan_id(self, product_rate_plan_id): + """Sets the product_rate_plan_id of this PriceLine. + + + :param product_rate_plan_id: The product_rate_plan_id of this PriceLine. # noqa: E501 + :type: str + """ + + self._product_rate_plan_id = product_rate_plan_id + + @property + def lower_threshold(self): + """Gets the lower_threshold of this PriceLine. # noqa: E501 + + + :return: The lower_threshold of this PriceLine. # noqa: E501 + :rtype: int + """ + return self._lower_threshold + + @lower_threshold.setter + def lower_threshold(self, lower_threshold): + """Sets the lower_threshold of this PriceLine. + + + :param lower_threshold: The lower_threshold of this PriceLine. # noqa: E501 + :type: int + """ + + self._lower_threshold = lower_threshold + + @property + def upper_threshold(self): + """Gets the upper_threshold of this PriceLine. # noqa: E501 + + + :return: The upper_threshold of this PriceLine. # noqa: E501 + :rtype: int + """ + return self._upper_threshold + + @upper_threshold.setter + def upper_threshold(self, upper_threshold): + """Sets the upper_threshold of this PriceLine. + + + :param upper_threshold: The upper_threshold of this PriceLine. # noqa: E501 + :type: int + """ + + self._upper_threshold = upper_threshold + + @property + def pricing_type(self): + """Gets the pricing_type of this PriceLine. # noqa: E501 + + + :return: The pricing_type of this PriceLine. # noqa: E501 + :rtype: str + """ + return self._pricing_type + + @pricing_type.setter + def pricing_type(self, pricing_type): + """Sets the pricing_type of this PriceLine. + + + :param pricing_type: The pricing_type of this PriceLine. # noqa: E501 + :type: str + """ + allowed_values = ["unit", "fixed", "bucket"] # noqa: E501 + if pricing_type not in allowed_values: + raise ValueError( + "Invalid value for `pricing_type` ({0}), must be one of {1}" # noqa: E501 + .format(pricing_type, allowed_values) + ) + + self._pricing_type = pricing_type + + @property + def calculation_details(self): + """Gets the calculation_details of this PriceLine. # noqa: E501 + + + :return: The calculation_details of this PriceLine. # noqa: E501 + :rtype: str + """ + return self._calculation_details + + @calculation_details.setter + def calculation_details(self, calculation_details): + """Sets the calculation_details of this PriceLine. + + + :param calculation_details: The calculation_details of this PriceLine. # noqa: E501 + :type: str + """ + + self._calculation_details = calculation_details + + @property + def unit_price(self): + """Gets the unit_price of this PriceLine. # noqa: E501 + + + :return: The unit_price of this PriceLine. # noqa: E501 + :rtype: float + """ + return self._unit_price + + @unit_price.setter + def unit_price(self, unit_price): + """Sets the unit_price of this PriceLine. + + + :param unit_price: The unit_price of this PriceLine. # noqa: E501 + :type: float + """ + + self._unit_price = unit_price + + @property + def unit_price_excluding_tax(self): + """Gets the unit_price_excluding_tax of this PriceLine. # noqa: E501 + + + :return: The unit_price_excluding_tax of this PriceLine. # noqa: E501 + :rtype: float + """ + return self._unit_price_excluding_tax + + @unit_price_excluding_tax.setter + def unit_price_excluding_tax(self, unit_price_excluding_tax): + """Sets the unit_price_excluding_tax of this PriceLine. + + + :param unit_price_excluding_tax: The unit_price_excluding_tax of this PriceLine. # noqa: E501 + :type: float + """ + + self._unit_price_excluding_tax = unit_price_excluding_tax + + @property + def prorated_unit_price(self): + """Gets the prorated_unit_price of this PriceLine. # noqa: E501 + + + :return: The prorated_unit_price of this PriceLine. # noqa: E501 + :rtype: float + """ + return self._prorated_unit_price + + @prorated_unit_price.setter + def prorated_unit_price(self, prorated_unit_price): + """Sets the prorated_unit_price of this PriceLine. + + + :param prorated_unit_price: The prorated_unit_price of this PriceLine. # noqa: E501 + :type: float + """ + + self._prorated_unit_price = prorated_unit_price + + @property + def prorated_unit_price_excluding_tax(self): + """Gets the prorated_unit_price_excluding_tax of this PriceLine. # noqa: E501 + + + :return: The prorated_unit_price_excluding_tax of this PriceLine. # noqa: E501 + :rtype: float + """ + return self._prorated_unit_price_excluding_tax + + @prorated_unit_price_excluding_tax.setter + def prorated_unit_price_excluding_tax(self, prorated_unit_price_excluding_tax): + """Sets the prorated_unit_price_excluding_tax of this PriceLine. + + + :param prorated_unit_price_excluding_tax: The prorated_unit_price_excluding_tax of this PriceLine. # noqa: E501 + :type: float + """ + + self._prorated_unit_price_excluding_tax = prorated_unit_price_excluding_tax + + @property + def quantity(self): + """Gets the quantity of this PriceLine. # noqa: E501 + + + :return: The quantity of this PriceLine. # noqa: E501 + :rtype: int + """ + return self._quantity + + @quantity.setter + def quantity(self, quantity): + """Sets the quantity of this PriceLine. + + + :param quantity: The quantity of this PriceLine. # noqa: E501 + :type: int + """ + + self._quantity = quantity + + @property + def cost(self): + """Gets the cost of this PriceLine. # noqa: E501 + + + :return: The cost of this PriceLine. # noqa: E501 + :rtype: float + """ + return self._cost + + @cost.setter + def cost(self, cost): + """Sets the cost of this PriceLine. + + + :param cost: The cost of this PriceLine. # noqa: E501 + :type: float + """ + + self._cost = cost + + @property + def cost_excluding_tax(self): + """Gets the cost_excluding_tax of this PriceLine. # noqa: E501 + + + :return: The cost_excluding_tax of this PriceLine. # noqa: E501 + :rtype: float + """ + return self._cost_excluding_tax + + @cost_excluding_tax.setter + def cost_excluding_tax(self, cost_excluding_tax): + """Sets the cost_excluding_tax of this PriceLine. + + + :param cost_excluding_tax: The cost_excluding_tax of this PriceLine. # noqa: E501 + :type: float + """ + + self._cost_excluding_tax = cost_excluding_tax + + @property + def prorated_cost(self): + """Gets the prorated_cost of this PriceLine. # noqa: E501 + + + :return: The prorated_cost of this PriceLine. # noqa: E501 + :rtype: float + """ + return self._prorated_cost + + @prorated_cost.setter + def prorated_cost(self, prorated_cost): + """Sets the prorated_cost of this PriceLine. + + + :param prorated_cost: The prorated_cost of this PriceLine. # noqa: E501 + :type: float + """ + + self._prorated_cost = prorated_cost + + @property + def prorated_cost_excluding_tax(self): + """Gets the prorated_cost_excluding_tax of this PriceLine. # noqa: E501 + + + :return: The prorated_cost_excluding_tax of this PriceLine. # noqa: E501 + :rtype: float + """ + return self._prorated_cost_excluding_tax + + @prorated_cost_excluding_tax.setter + def prorated_cost_excluding_tax(self, prorated_cost_excluding_tax): + """Sets the prorated_cost_excluding_tax of this PriceLine. + + + :param prorated_cost_excluding_tax: The prorated_cost_excluding_tax of this PriceLine. # noqa: E501 + :type: float + """ + + self._prorated_cost_excluding_tax = prorated_cost_excluding_tax + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PriceLine, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PriceLine): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/pricing_component.py b/billforward/models/pricing_component.py index 4f5911e..1e1f326 100644 --- a/billforward/models/pricing_component.py +++ b/billforward/models/pricing_component.py @@ -1,145 +1,204 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class PricingComponent(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, version_id=None, crm_id=None, id=None, product_rate_plan_id=None, unit_of_measure_id=None, organization_id=None, name=None, public_name=None, description=None, charge_type=None, invoicing_type=None, charge_model=None, upgrade_mode=None, downgrade_mode=None, default_quantity=None, min_quantity=None, max_quantity=None, valid_from=None, valid_till=None, tiers=None, unit_of_measure=None): - """ - PricingComponent - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'version_id': 'str', - 'crm_id': 'str', - 'id': 'str', - 'product_rate_plan_id': 'str', - 'unit_of_measure_id': 'str', - 'organization_id': 'str', - 'name': 'str', - 'public_name': 'str', - 'description': 'str', - 'charge_type': 'str', - 'invoicing_type': 'str', - 'charge_model': 'str', - 'upgrade_mode': 'str', - 'downgrade_mode': 'str', - 'default_quantity': 'int', - 'min_quantity': 'int', - 'max_quantity': 'int', - 'valid_from': 'datetime', - 'valid_till': 'datetime', - 'tiers': 'list[PricingComponentTier]', - 'unit_of_measure': 'UnitOfMeasure' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'version_id': 'versionID', - 'crm_id': 'crmID', - 'id': 'id', - 'product_rate_plan_id': 'productRatePlanID', - 'unit_of_measure_id': 'unitOfMeasureID', - 'organization_id': 'organizationID', - 'name': 'name', - 'public_name': 'publicName', - 'description': 'description', - 'charge_type': 'chargeType', - 'invoicing_type': 'invoicingType', - 'charge_model': 'chargeModel', - 'upgrade_mode': 'upgradeMode', - 'downgrade_mode': 'downgradeMode', - 'default_quantity': 'defaultQuantity', - 'min_quantity': 'minQuantity', - 'max_quantity': 'maxQuantity', - 'valid_from': 'validFrom', - 'valid_till': 'validTill', - 'tiers': 'tiers', - 'unit_of_measure': 'unitOfMeasure' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._version_id = version_id - self._crm_id = crm_id - self._id = id - self._product_rate_plan_id = product_rate_plan_id - self._unit_of_measure_id = unit_of_measure_id - self._organization_id = organization_id - self._name = name - self._public_name = public_name - self._description = description - self._charge_type = charge_type - self._invoicing_type = invoicing_type - self._charge_model = charge_model - self._upgrade_mode = upgrade_mode - self._downgrade_mode = downgrade_mode - self._default_quantity = default_quantity - self._min_quantity = min_quantity - self._max_quantity = max_quantity - self._valid_from = valid_from - self._valid_till = valid_till - self._tiers = tiers - self._unit_of_measure = unit_of_measure + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'dummy_field': 'str', + 'crm_id': 'str', + 'product_rate_plan_id': 'str', + 'product_rate_plan_version_id': 'str', + 'unit_of_measure_id': 'str', + 'organization_id': 'str', + 'name': 'str', + 'public_name': 'str', + 'description': 'str', + 'tax_code': 'str', + 'charge_type': 'str', + 'invoicing_type': 'str', + 'charge_model': 'str', + 'upgrade_mode': 'str', + 'downgrade_mode': 'str', + 'default_quantity': 'int', + 'min_quantity': 'int', + 'max_quantity': 'int', + 'valid_from': 'datetime', + 'valid_till': 'datetime', + 'unit_credit': 'int', + 'tiers': 'list[PricingComponentTier]', + 'unit_of_measure': 'UnitOfMeasure', + 'sorted_tiers': 'list[PricingComponentTier]', + 'version_id': 'str', + 'id': 'str', + 'type': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'dummy_field': 'dummyField', + 'crm_id': 'crmID', + 'product_rate_plan_id': 'productRatePlanID', + 'product_rate_plan_version_id': 'productRatePlanVersionID', + 'unit_of_measure_id': 'unitOfMeasureID', + 'organization_id': 'organizationID', + 'name': 'name', + 'public_name': 'publicName', + 'description': 'description', + 'tax_code': 'taxCode', + 'charge_type': 'chargeType', + 'invoicing_type': 'invoicingType', + 'charge_model': 'chargeModel', + 'upgrade_mode': 'upgradeMode', + 'downgrade_mode': 'downgradeMode', + 'default_quantity': 'defaultQuantity', + 'min_quantity': 'minQuantity', + 'max_quantity': 'maxQuantity', + 'valid_from': 'validFrom', + 'valid_till': 'validTill', + 'unit_credit': 'unitCredit', + 'tiers': 'tiers', + 'unit_of_measure': 'unitOfMeasure', + 'sorted_tiers': 'sortedTiers', + 'version_id': 'versionID', + 'id': 'id', + 'type': '@type' + } + + discriminator_value_class_map = { + 'TieredPricingComponent': 'TieredPricingComponent', +'FlatPricingComponent': 'FlatPricingComponent', +'TieredVolumePricingComponent': 'TieredVolumePricingComponent' } + + def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None, crm_id=None, product_rate_plan_id=None, product_rate_plan_version_id=None, unit_of_measure_id=None, organization_id=None, name=None, public_name=None, description=None, tax_code=None, charge_type=None, invoicing_type=None, charge_model=None, upgrade_mode=None, downgrade_mode=None, default_quantity=None, min_quantity=None, max_quantity=None, valid_from=None, valid_till=None, unit_credit=None, tiers=None, unit_of_measure=None, sorted_tiers=None, version_id=None, id=None, type=None): # noqa: E501 + """PricingComponent - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._dummy_field = None + self._crm_id = None + self._product_rate_plan_id = None + self._product_rate_plan_version_id = None + self._unit_of_measure_id = None + self._organization_id = None + self._name = None + self._public_name = None + self._description = None + self._tax_code = None + self._charge_type = None + self._invoicing_type = None + self._charge_model = None + self._upgrade_mode = None + self._downgrade_mode = None + self._default_quantity = None + self._min_quantity = None + self._max_quantity = None + self._valid_from = None + self._valid_till = None + self._unit_credit = None + self._tiers = None + self._unit_of_measure = None + self._sorted_tiers = None + self._version_id = None + self._id = None + self._type = None + self.discriminator = '@type' + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if dummy_field is not None: + self.dummy_field = dummy_field + if crm_id is not None: + self.crm_id = crm_id + self.product_rate_plan_id = product_rate_plan_id + self.product_rate_plan_version_id = product_rate_plan_version_id + self.unit_of_measure_id = unit_of_measure_id + self.organization_id = organization_id + self.name = name + if public_name is not None: + self.public_name = public_name + if description is not None: + self.description = description + if tax_code is not None: + self.tax_code = tax_code + self.charge_type = charge_type + if invoicing_type is not None: + self.invoicing_type = invoicing_type + if charge_model is not None: + self.charge_model = charge_model + if upgrade_mode is not None: + self.upgrade_mode = upgrade_mode + if downgrade_mode is not None: + self.downgrade_mode = downgrade_mode + if default_quantity is not None: + self.default_quantity = default_quantity + if min_quantity is not None: + self.min_quantity = min_quantity + if max_quantity is not None: + self.max_quantity = max_quantity + self.valid_from = valid_from + if valid_till is not None: + self.valid_till = valid_till + if unit_credit is not None: + self.unit_credit = unit_credit + if tiers is not None: + self.tiers = tiers + if unit_of_measure is not None: + self.unit_of_measure = unit_of_measure + if sorted_tiers is not None: + self.sorted_tiers = sorted_tiers + if version_id is not None: + self.version_id = version_id + self.id = id + self.type = type @property def created(self): - """ - Gets the created of this PricingComponent. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this PricingComponent. # noqa: E501 + - :return: The created of this PricingComponent. + :return: The created of this PricingComponent. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this PricingComponent. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this PricingComponent. - :param created: The created of this PricingComponent. + + :param created: The created of this PricingComponent. # noqa: E501 :type: datetime """ @@ -147,22 +206,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this PricingComponent. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this PricingComponent. # noqa: E501 - :return: The changed_by of this PricingComponent. + + :return: The changed_by of this PricingComponent. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this PricingComponent. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this PricingComponent. - :param changed_by: The changed_by of this PricingComponent. + + :param changed_by: The changed_by of this PricingComponent. # noqa: E501 :type: str """ @@ -170,235 +227,198 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this PricingComponent. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this PricingComponent. # noqa: E501 - :return: The updated of this PricingComponent. + + :return: The updated of this PricingComponent. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this PricingComponent. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this PricingComponent. - :param updated: The updated of this PricingComponent. + + :param updated: The updated of this PricingComponent. # noqa: E501 :type: datetime """ self._updated = updated @property - def type(self): - """ - Gets the type of this PricingComponent. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + def dummy_field(self): + """Gets the dummy_field of this PricingComponent. # noqa: E501 - :return: The type of this PricingComponent. - :rtype: str - """ - return self._type - @type.setter - def type(self, type): - """ - Sets the type of this PricingComponent. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this PricingComponent. - :type: str - """ - allowed_values = ["tieredPricingComponent", "flatPricingComponent", "tieredVolumePricingComponent"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def version_id(self): - """ - Gets the version_id of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The version_id of this PricingComponent. + :return: The dummy_field of this PricingComponent. # noqa: E501 :rtype: str """ - return self._version_id + return self._dummy_field - @version_id.setter - def version_id(self, version_id): - """ - Sets the version_id of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + @dummy_field.setter + def dummy_field(self, dummy_field): + """Sets the dummy_field of this PricingComponent. - :param version_id: The version_id of this PricingComponent. + + :param dummy_field: The dummy_field of this PricingComponent. # noqa: E501 :type: str """ - self._version_id = version_id + self._dummy_field = dummy_field @property def crm_id(self): - """ - Gets the crm_id of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the crm_id of this PricingComponent. # noqa: E501 + - :return: The crm_id of this PricingComponent. + :return: The crm_id of this PricingComponent. # noqa: E501 :rtype: str """ return self._crm_id @crm_id.setter def crm_id(self, crm_id): - """ - Sets the crm_id of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the crm_id of this PricingComponent. + - :param crm_id: The crm_id of this PricingComponent. + :param crm_id: The crm_id of this PricingComponent. # noqa: E501 :type: str """ self._crm_id = crm_id @property - def id(self): - """ - Gets the id of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } When associating a pricing component with a product rate plan, this ID should be used. + def product_rate_plan_id(self): + """Gets the product_rate_plan_id of this PricingComponent. # noqa: E501 + - :return: The id of this PricingComponent. + :return: The product_rate_plan_id of this PricingComponent. # noqa: E501 :rtype: str """ - return self._id + return self._product_rate_plan_id + + @product_rate_plan_id.setter + def product_rate_plan_id(self, product_rate_plan_id): + """Sets the product_rate_plan_id of this PricingComponent. - @id.setter - def id(self, id): - """ - Sets the id of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } When associating a pricing component with a product rate plan, this ID should be used. - :param id: The id of this PricingComponent. + :param product_rate_plan_id: The product_rate_plan_id of this PricingComponent. # noqa: E501 :type: str """ + if product_rate_plan_id is None: + raise ValueError("Invalid value for `product_rate_plan_id`, must not be `None`") # noqa: E501 - self._id = id + self._product_rate_plan_id = product_rate_plan_id @property - def product_rate_plan_id(self): - """ - Gets the product_rate_plan_id of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + def product_rate_plan_version_id(self): + """Gets the product_rate_plan_version_id of this PricingComponent. # noqa: E501 - :return: The product_rate_plan_id of this PricingComponent. + + :return: The product_rate_plan_version_id of this PricingComponent. # noqa: E501 :rtype: str """ - return self._product_rate_plan_id + return self._product_rate_plan_version_id + + @product_rate_plan_version_id.setter + def product_rate_plan_version_id(self, product_rate_plan_version_id): + """Sets the product_rate_plan_version_id of this PricingComponent. - @product_rate_plan_id.setter - def product_rate_plan_id(self, product_rate_plan_id): - """ - Sets the product_rate_plan_id of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - :param product_rate_plan_id: The product_rate_plan_id of this PricingComponent. + :param product_rate_plan_version_id: The product_rate_plan_version_id of this PricingComponent. # noqa: E501 :type: str """ + if product_rate_plan_version_id is None: + raise ValueError("Invalid value for `product_rate_plan_version_id`, must not be `None`") # noqa: E501 - self._product_rate_plan_id = product_rate_plan_id + self._product_rate_plan_version_id = product_rate_plan_version_id @property def unit_of_measure_id(self): - """ - Gets the unit_of_measure_id of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the unit_of_measure_id of this PricingComponent. # noqa: E501 - :return: The unit_of_measure_id of this PricingComponent. + + :return: The unit_of_measure_id of this PricingComponent. # noqa: E501 :rtype: str """ return self._unit_of_measure_id @unit_of_measure_id.setter def unit_of_measure_id(self, unit_of_measure_id): - """ - Sets the unit_of_measure_id of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the unit_of_measure_id of this PricingComponent. + - :param unit_of_measure_id: The unit_of_measure_id of this PricingComponent. + :param unit_of_measure_id: The unit_of_measure_id of this PricingComponent. # noqa: E501 :type: str """ + if unit_of_measure_id is None: + raise ValueError("Invalid value for `unit_of_measure_id`, must not be `None`") # noqa: E501 self._unit_of_measure_id = unit_of_measure_id @property def organization_id(self): - """ - Gets the organization_id of this PricingComponent. - { \"description\" : \"\", \"verbs\":[] } + """Gets the organization_id of this PricingComponent. # noqa: E501 + - :return: The organization_id of this PricingComponent. + :return: The organization_id of this PricingComponent. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this PricingComponent. - { \"description\" : \"\", \"verbs\":[] } + """Sets the organization_id of this PricingComponent. + - :param organization_id: The organization_id of this PricingComponent. + :param organization_id: The organization_id of this PricingComponent. # noqa: E501 :type: str """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 self._organization_id = organization_id @property def name(self): - """ - Gets the name of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the name of this PricingComponent. # noqa: E501 + - :return: The name of this PricingComponent. + :return: The name of this PricingComponent. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the name of this PricingComponent. + - :param name: The name of this PricingComponent. + :param name: The name of this PricingComponent. # noqa: E501 :type: str """ + if name is None: + raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501 self._name = name @property def public_name(self): - """ - Gets the public_name of this PricingComponent. - {\"description\":\"A friendly non-unique name used to identify this pricing-component\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the public_name of this PricingComponent. # noqa: E501 + - :return: The public_name of this PricingComponent. + :return: The public_name of this PricingComponent. # noqa: E501 :rtype: str """ return self._public_name @public_name.setter def public_name(self, public_name): - """ - Sets the public_name of this PricingComponent. - {\"description\":\"A friendly non-unique name used to identify this pricing-component\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the public_name of this PricingComponent. + - :param public_name: The public_name of this PricingComponent. + :param public_name: The public_name of this PricingComponent. # noqa: E501 :type: str """ @@ -406,51 +426,70 @@ def public_name(self, public_name): @property def description(self): - """ - Gets the description of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the description of this PricingComponent. # noqa: E501 + - :return: The description of this PricingComponent. + :return: The description of this PricingComponent. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this PricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the description of this PricingComponent. + - :param description: The description of this PricingComponent. + :param description: The description of this PricingComponent. # noqa: E501 :type: str """ self._description = description @property - def charge_type(self): + def tax_code(self): + """Gets the tax_code of this PricingComponent. # noqa: E501 + + + :return: The tax_code of this PricingComponent. # noqa: E501 + :rtype: str + """ + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this PricingComponent. + + + :param tax_code: The tax_code of this PricingComponent. # noqa: E501 + :type: str """ - Gets the charge_type of this PricingComponent. - { \"description\" : \"The charge type of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - :return: The charge_type of this PricingComponent. + self._tax_code = tax_code + + @property + def charge_type(self): + """Gets the charge_type of this PricingComponent. # noqa: E501 + + + :return: The charge_type of this PricingComponent. # noqa: E501 :rtype: str """ return self._charge_type @charge_type.setter def charge_type(self, charge_type): - """ - Sets the charge_type of this PricingComponent. - { \"description\" : \"The charge type of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the charge_type of this PricingComponent. + - :param charge_type: The charge_type of this PricingComponent. + :param charge_type: The charge_type of this PricingComponent. # noqa: E501 :type: str """ - allowed_values = ["setup", "subscription", "arrears", "usage"] + if charge_type is None: + raise ValueError("Invalid value for `charge_type`, must not be `None`") # noqa: E501 + allowed_values = ["setup", "subscription", "arrears", "usage"] # noqa: E501 if charge_type not in allowed_values: raise ValueError( - "Invalid value for `charge_type` ({0}), must be one of {1}" + "Invalid value for `charge_type` ({0}), must be one of {1}" # noqa: E501 .format(charge_type, allowed_values) ) @@ -458,28 +497,26 @@ def charge_type(self, charge_type): @property def invoicing_type(self): - """ - Gets the invoicing_type of this PricingComponent. - { \"default\" : \"Aggregated\", \"description\" : \"For setup pricing components Immediate invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. Aggregated invoicing will add a charge to the first invoice of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the invoicing_type of this PricingComponent. # noqa: E501 - :return: The invoicing_type of this PricingComponent. + + :return: The invoicing_type of this PricingComponent. # noqa: E501 :rtype: str """ return self._invoicing_type @invoicing_type.setter def invoicing_type(self, invoicing_type): - """ - Sets the invoicing_type of this PricingComponent. - { \"default\" : \"Aggregated\", \"description\" : \"For setup pricing components Immediate invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. Aggregated invoicing will add a charge to the first invoice of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the invoicing_type of this PricingComponent. - :param invoicing_type: The invoicing_type of this PricingComponent. + + :param invoicing_type: The invoicing_type of this PricingComponent. # noqa: E501 :type: str """ - allowed_values = ["Immediate", "Aggregated"] + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 if invoicing_type not in allowed_values: raise ValueError( - "Invalid value for `invoicing_type` ({0}), must be one of {1}" + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 .format(invoicing_type, allowed_values) ) @@ -487,28 +524,26 @@ def invoicing_type(self, invoicing_type): @property def charge_model(self): - """ - Gets the charge_model of this PricingComponent. - { \"description\" : \"The charge model of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the charge_model of this PricingComponent. # noqa: E501 - :return: The charge_model of this PricingComponent. + + :return: The charge_model of this PricingComponent. # noqa: E501 :rtype: str """ return self._charge_model @charge_model.setter def charge_model(self, charge_model): - """ - Sets the charge_model of this PricingComponent. - { \"description\" : \"The charge model of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the charge_model of this PricingComponent. - :param charge_model: The charge_model of this PricingComponent. + + :param charge_model: The charge_model of this PricingComponent. # noqa: E501 :type: str """ - allowed_values = ["flat", "tiered", "tiered_volume"] + allowed_values = ["flat", "tiered", "tiered_volume"] # noqa: E501 if charge_model not in allowed_values: raise ValueError( - "Invalid value for `charge_model` ({0}), must be one of {1}" + "Invalid value for `charge_model` ({0}), must be one of {1}" # noqa: E501 .format(charge_model, allowed_values) ) @@ -516,28 +551,26 @@ def charge_model(self, charge_model): @property def upgrade_mode(self): - """ - Gets the upgrade_mode of this PricingComponent. - {\"default\":\"immediate\",\"description\":\"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Upgrade will apply at the time the request is made.
delayed — Upgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the upgrade_mode of this PricingComponent. # noqa: E501 - :return: The upgrade_mode of this PricingComponent. + + :return: The upgrade_mode of this PricingComponent. # noqa: E501 :rtype: str """ return self._upgrade_mode @upgrade_mode.setter def upgrade_mode(self, upgrade_mode): - """ - Sets the upgrade_mode of this PricingComponent. - {\"default\":\"immediate\",\"description\":\"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Upgrade will apply at the time the request is made.
delayed — Upgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the upgrade_mode of this PricingComponent. - :param upgrade_mode: The upgrade_mode of this PricingComponent. + + :param upgrade_mode: The upgrade_mode of this PricingComponent. # noqa: E501 :type: str """ - allowed_values = ["immediate", "delayed"] + allowed_values = ["immediate", "delayed"] # noqa: E501 if upgrade_mode not in allowed_values: raise ValueError( - "Invalid value for `upgrade_mode` ({0}), must be one of {1}" + "Invalid value for `upgrade_mode` ({0}), must be one of {1}" # noqa: E501 .format(upgrade_mode, allowed_values) ) @@ -545,28 +578,26 @@ def upgrade_mode(self, upgrade_mode): @property def downgrade_mode(self): - """ - Gets the downgrade_mode of this PricingComponent. - {\"default\":\"delayed\",\"description\":\"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Downgrade will apply at the time the request is made.
delayed — Downgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the downgrade_mode of this PricingComponent. # noqa: E501 - :return: The downgrade_mode of this PricingComponent. + + :return: The downgrade_mode of this PricingComponent. # noqa: E501 :rtype: str """ return self._downgrade_mode @downgrade_mode.setter def downgrade_mode(self, downgrade_mode): - """ - Sets the downgrade_mode of this PricingComponent. - {\"default\":\"delayed\",\"description\":\"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Downgrade will apply at the time the request is made.
delayed — Downgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the downgrade_mode of this PricingComponent. - :param downgrade_mode: The downgrade_mode of this PricingComponent. + + :param downgrade_mode: The downgrade_mode of this PricingComponent. # noqa: E501 :type: str """ - allowed_values = ["immediate", "delayed"] + allowed_values = ["immediate", "delayed"] # noqa: E501 if downgrade_mode not in allowed_values: raise ValueError( - "Invalid value for `downgrade_mode` ({0}), must be one of {1}" + "Invalid value for `downgrade_mode` ({0}), must be one of {1}" # noqa: E501 .format(downgrade_mode, allowed_values) ) @@ -574,22 +605,20 @@ def downgrade_mode(self, downgrade_mode): @property def default_quantity(self): - """ - Gets the default_quantity of this PricingComponent. - { \"description\" : \"The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the default_quantity of this PricingComponent. # noqa: E501 - :return: The default_quantity of this PricingComponent. + + :return: The default_quantity of this PricingComponent. # noqa: E501 :rtype: int """ return self._default_quantity @default_quantity.setter def default_quantity(self, default_quantity): - """ - Sets the default_quantity of this PricingComponent. - { \"description\" : \"The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the default_quantity of this PricingComponent. - :param default_quantity: The default_quantity of this PricingComponent. + + :param default_quantity: The default_quantity of this PricingComponent. # noqa: E501 :type: int """ @@ -597,22 +626,20 @@ def default_quantity(self, default_quantity): @property def min_quantity(self): - """ - Gets the min_quantity of this PricingComponent. - { \"default\" : \"0\", \"description\" : \"The minimum quantity of the pricing-component.\", \"verbs\":[] } + """Gets the min_quantity of this PricingComponent. # noqa: E501 - :return: The min_quantity of this PricingComponent. + + :return: The min_quantity of this PricingComponent. # noqa: E501 :rtype: int """ return self._min_quantity @min_quantity.setter def min_quantity(self, min_quantity): - """ - Sets the min_quantity of this PricingComponent. - { \"default\" : \"0\", \"description\" : \"The minimum quantity of the pricing-component.\", \"verbs\":[] } + """Sets the min_quantity of this PricingComponent. - :param min_quantity: The min_quantity of this PricingComponent. + + :param min_quantity: The min_quantity of this PricingComponent. # noqa: E501 :type: int """ @@ -620,22 +647,20 @@ def min_quantity(self, min_quantity): @property def max_quantity(self): - """ - Gets the max_quantity of this PricingComponent. - { \"description\" : \"The maximum quantity of the pricing-component.\", \"verbs\":[] } + """Gets the max_quantity of this PricingComponent. # noqa: E501 - :return: The max_quantity of this PricingComponent. + + :return: The max_quantity of this PricingComponent. # noqa: E501 :rtype: int """ return self._max_quantity @max_quantity.setter def max_quantity(self, max_quantity): - """ - Sets the max_quantity of this PricingComponent. - { \"description\" : \"The maximum quantity of the pricing-component.\", \"verbs\":[] } + """Sets the max_quantity of this PricingComponent. - :param max_quantity: The max_quantity of this PricingComponent. + + :param max_quantity: The max_quantity of this PricingComponent. # noqa: E501 :type: int """ @@ -643,68 +668,85 @@ def max_quantity(self, max_quantity): @property def valid_from(self): - """ - Gets the valid_from of this PricingComponent. - { \"default\" : \"current time\", \"description\" : \"The DateTime specifying when the pricing-component is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the valid_from of this PricingComponent. # noqa: E501 - :return: The valid_from of this PricingComponent. + + :return: The valid_from of this PricingComponent. # noqa: E501 :rtype: datetime """ return self._valid_from @valid_from.setter def valid_from(self, valid_from): - """ - Sets the valid_from of this PricingComponent. - { \"default\" : \"current time\", \"description\" : \"The DateTime specifying when the pricing-component is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the valid_from of this PricingComponent. - :param valid_from: The valid_from of this PricingComponent. + + :param valid_from: The valid_from of this PricingComponent. # noqa: E501 :type: datetime """ + if valid_from is None: + raise ValueError("Invalid value for `valid_from`, must not be `None`") # noqa: E501 self._valid_from = valid_from @property def valid_till(self): - """ - Gets the valid_till of this PricingComponent. - { \"default\" : \"null\", \"description\" : \"The UTC DateTime specifying when the pricing-component is valid till.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the valid_till of this PricingComponent. # noqa: E501 + - :return: The valid_till of this PricingComponent. + :return: The valid_till of this PricingComponent. # noqa: E501 :rtype: datetime """ return self._valid_till @valid_till.setter def valid_till(self, valid_till): - """ - Sets the valid_till of this PricingComponent. - { \"default\" : \"null\", \"description\" : \"The UTC DateTime specifying when the pricing-component is valid till.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the valid_till of this PricingComponent. + - :param valid_till: The valid_till of this PricingComponent. + :param valid_till: The valid_till of this PricingComponent. # noqa: E501 :type: datetime """ self._valid_till = valid_till @property - def tiers(self): + def unit_credit(self): + """Gets the unit_credit of this PricingComponent. # noqa: E501 + + + :return: The unit_credit of this PricingComponent. # noqa: E501 + :rtype: int """ - Gets the tiers of this PricingComponent. - { \"default\" : \"[]\", \"description\" : \"The pricing-component-tiers associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + return self._unit_credit - :return: The tiers of this PricingComponent. + @unit_credit.setter + def unit_credit(self, unit_credit): + """Sets the unit_credit of this PricingComponent. + + + :param unit_credit: The unit_credit of this PricingComponent. # noqa: E501 + :type: int + """ + + self._unit_credit = unit_credit + + @property + def tiers(self): + """Gets the tiers of this PricingComponent. # noqa: E501 + + + :return: The tiers of this PricingComponent. # noqa: E501 :rtype: list[PricingComponentTier] """ return self._tiers @tiers.setter def tiers(self, tiers): - """ - Sets the tiers of this PricingComponent. - { \"default\" : \"[]\", \"description\" : \"The pricing-component-tiers associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the tiers of this PricingComponent. + - :param tiers: The tiers of this PricingComponent. + :param tiers: The tiers of this PricingComponent. # noqa: E501 :type: list[PricingComponentTier] """ @@ -712,34 +754,123 @@ def tiers(self, tiers): @property def unit_of_measure(self): - """ - Gets the unit_of_measure of this PricingComponent. - { \"description\" : \"The unit-of-measure associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the unit_of_measure of this PricingComponent. # noqa: E501 + - :return: The unit_of_measure of this PricingComponent. + :return: The unit_of_measure of this PricingComponent. # noqa: E501 :rtype: UnitOfMeasure """ return self._unit_of_measure @unit_of_measure.setter def unit_of_measure(self, unit_of_measure): - """ - Sets the unit_of_measure of this PricingComponent. - { \"description\" : \"The unit-of-measure associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the unit_of_measure of this PricingComponent. + - :param unit_of_measure: The unit_of_measure of this PricingComponent. + :param unit_of_measure: The unit_of_measure of this PricingComponent. # noqa: E501 :type: UnitOfMeasure """ self._unit_of_measure = unit_of_measure - def to_dict(self): + @property + def sorted_tiers(self): + """Gets the sorted_tiers of this PricingComponent. # noqa: E501 + + + :return: The sorted_tiers of this PricingComponent. # noqa: E501 + :rtype: list[PricingComponentTier] """ - Returns the model properties as a dict + return self._sorted_tiers + + @sorted_tiers.setter + def sorted_tiers(self, sorted_tiers): + """Sets the sorted_tiers of this PricingComponent. + + + :param sorted_tiers: The sorted_tiers of this PricingComponent. # noqa: E501 + :type: list[PricingComponentTier] + """ + + self._sorted_tiers = sorted_tiers + + @property + def version_id(self): + """Gets the version_id of this PricingComponent. # noqa: E501 + + + :return: The version_id of this PricingComponent. # noqa: E501 + :rtype: str + """ + return self._version_id + + @version_id.setter + def version_id(self, version_id): + """Sets the version_id of this PricingComponent. + + + :param version_id: The version_id of this PricingComponent. # noqa: E501 + :type: str """ + + self._version_id = version_id + + @property + def id(self): + """Gets the id of this PricingComponent. # noqa: E501 + + + :return: The id of this PricingComponent. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this PricingComponent. + + + :param id: The id of this PricingComponent. # noqa: E501 + :type: str + """ + if id is None: + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + @property + def type(self): + """Gets the type of this PricingComponent. # noqa: E501 + + + :return: The type of this PricingComponent. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this PricingComponent. + + + :param type: The type of this PricingComponent. # noqa: E501 + :type: str + """ + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + + self._type = type + + def get_real_child_model(self, data): + """Returns the real base class specified by the discriminator""" + discriminator_value = data[self.discriminator].lower() + return self.discriminator_value_class_map.get(discriminator_value) + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -756,29 +887,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(PricingComponent, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, PricingComponent): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/pricing_component_charge.py b/billforward/models/pricing_component_charge.py new file mode 100644 index 0000000..107c9f3 --- /dev/null +++ b/billforward/models/pricing_component_charge.py @@ -0,0 +1,554 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.subscription_charge import SubscriptionCharge # noqa: F401,E501 + +class PricingComponentCharge(SubscriptionCharge): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'pricing_component_name': 'str', + 'public_pricing_component_name': 'str', + 'pricing_component_id': 'str', + 'product_name': 'str', + 'public_product_name': 'str', + 'product_id': 'str', + 'product_rate_plan_name': 'str', + 'public_product_rate_plan_name': 'str', + 'product_rate_plan_id': 'str', + 'unit_of_measure_id': 'str', + 'unit_of_measure_name': 'str', + 'pricing_component_value': 'int', + 'existing_pricing_component_value': 'int', + 'pricing_component_type': 'str', + 'creation_type': 'str', + 'proration': 'float', + 'quantity_label': 'str' + } + if hasattr(SubscriptionCharge, "swagger_types"): + swagger_types.update(SubscriptionCharge.swagger_types) + + attribute_map = { + 'pricing_component_name': 'pricingComponentName', + 'public_pricing_component_name': 'publicPricingComponentName', + 'pricing_component_id': 'pricingComponentID', + 'product_name': 'productName', + 'public_product_name': 'publicProductName', + 'product_id': 'productID', + 'product_rate_plan_name': 'productRatePlanName', + 'public_product_rate_plan_name': 'publicProductRatePlanName', + 'product_rate_plan_id': 'productRatePlanID', + 'unit_of_measure_id': 'unitOfMeasureID', + 'unit_of_measure_name': 'unitOfMeasureName', + 'pricing_component_value': 'pricingComponentValue', + 'existing_pricing_component_value': 'existingPricingComponentValue', + 'pricing_component_type': 'pricingComponentType', + 'creation_type': 'creationType', + 'proration': 'proration', + 'quantity_label': 'quantityLabel' + } + if hasattr(SubscriptionCharge, "attribute_map"): + attribute_map.update(SubscriptionCharge.attribute_map) + + def __init__(self, pricing_component_name=None, public_pricing_component_name=None, pricing_component_id=None, product_name=None, public_product_name=None, product_id=None, product_rate_plan_name=None, public_product_rate_plan_name=None, product_rate_plan_id=None, unit_of_measure_id=None, unit_of_measure_name=None, pricing_component_value=None, existing_pricing_component_value=None, pricing_component_type=None, creation_type=None, proration=None, quantity_label=None, *args, **kwargs): # noqa: E501 + """PricingComponentCharge - a model defined in Swagger""" # noqa: E501 + self._pricing_component_name = None + self._public_pricing_component_name = None + self._pricing_component_id = None + self._product_name = None + self._public_product_name = None + self._product_id = None + self._product_rate_plan_name = None + self._public_product_rate_plan_name = None + self._product_rate_plan_id = None + self._unit_of_measure_id = None + self._unit_of_measure_name = None + self._pricing_component_value = None + self._existing_pricing_component_value = None + self._pricing_component_type = None + self._creation_type = None + self._proration = None + self._quantity_label = None + self.discriminator = None + self.pricing_component_name = pricing_component_name + if public_pricing_component_name is not None: + self.public_pricing_component_name = public_pricing_component_name + self.pricing_component_id = pricing_component_id + self.product_name = product_name + if public_product_name is not None: + self.public_product_name = public_product_name + self.product_id = product_id + self.product_rate_plan_name = product_rate_plan_name + if public_product_rate_plan_name is not None: + self.public_product_rate_plan_name = public_product_rate_plan_name + self.product_rate_plan_id = product_rate_plan_id + self.unit_of_measure_id = unit_of_measure_id + self.unit_of_measure_name = unit_of_measure_name + self.pricing_component_value = pricing_component_value + self.existing_pricing_component_value = existing_pricing_component_value + if pricing_component_type is not None: + self.pricing_component_type = pricing_component_type + if creation_type is not None: + self.creation_type = creation_type + if proration is not None: + self.proration = proration + if quantity_label is not None: + self.quantity_label = quantity_label + SubscriptionCharge.__init__(self, *args, **kwargs) + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this PricingComponentCharge. # noqa: E501 + + + :return: The pricing_component_name of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._pricing_component_name + + @pricing_component_name.setter + def pricing_component_name(self, pricing_component_name): + """Sets the pricing_component_name of this PricingComponentCharge. + + + :param pricing_component_name: The pricing_component_name of this PricingComponentCharge. # noqa: E501 + :type: str + """ + if pricing_component_name is None: + raise ValueError("Invalid value for `pricing_component_name`, must not be `None`") # noqa: E501 + + self._pricing_component_name = pricing_component_name + + @property + def public_pricing_component_name(self): + """Gets the public_pricing_component_name of this PricingComponentCharge. # noqa: E501 + + + :return: The public_pricing_component_name of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._public_pricing_component_name + + @public_pricing_component_name.setter + def public_pricing_component_name(self, public_pricing_component_name): + """Sets the public_pricing_component_name of this PricingComponentCharge. + + + :param public_pricing_component_name: The public_pricing_component_name of this PricingComponentCharge. # noqa: E501 + :type: str + """ + + self._public_pricing_component_name = public_pricing_component_name + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this PricingComponentCharge. # noqa: E501 + + + :return: The pricing_component_id of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this PricingComponentCharge. + + + :param pricing_component_id: The pricing_component_id of this PricingComponentCharge. # noqa: E501 + :type: str + """ + if pricing_component_id is None: + raise ValueError("Invalid value for `pricing_component_id`, must not be `None`") # noqa: E501 + + self._pricing_component_id = pricing_component_id + + @property + def product_name(self): + """Gets the product_name of this PricingComponentCharge. # noqa: E501 + + + :return: The product_name of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._product_name + + @product_name.setter + def product_name(self, product_name): + """Sets the product_name of this PricingComponentCharge. + + + :param product_name: The product_name of this PricingComponentCharge. # noqa: E501 + :type: str + """ + if product_name is None: + raise ValueError("Invalid value for `product_name`, must not be `None`") # noqa: E501 + + self._product_name = product_name + + @property + def public_product_name(self): + """Gets the public_product_name of this PricingComponentCharge. # noqa: E501 + + + :return: The public_product_name of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._public_product_name + + @public_product_name.setter + def public_product_name(self, public_product_name): + """Sets the public_product_name of this PricingComponentCharge. + + + :param public_product_name: The public_product_name of this PricingComponentCharge. # noqa: E501 + :type: str + """ + + self._public_product_name = public_product_name + + @property + def product_id(self): + """Gets the product_id of this PricingComponentCharge. # noqa: E501 + + + :return: The product_id of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._product_id + + @product_id.setter + def product_id(self, product_id): + """Sets the product_id of this PricingComponentCharge. + + + :param product_id: The product_id of this PricingComponentCharge. # noqa: E501 + :type: str + """ + if product_id is None: + raise ValueError("Invalid value for `product_id`, must not be `None`") # noqa: E501 + + self._product_id = product_id + + @property + def product_rate_plan_name(self): + """Gets the product_rate_plan_name of this PricingComponentCharge. # noqa: E501 + + + :return: The product_rate_plan_name of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_name + + @product_rate_plan_name.setter + def product_rate_plan_name(self, product_rate_plan_name): + """Sets the product_rate_plan_name of this PricingComponentCharge. + + + :param product_rate_plan_name: The product_rate_plan_name of this PricingComponentCharge. # noqa: E501 + :type: str + """ + if product_rate_plan_name is None: + raise ValueError("Invalid value for `product_rate_plan_name`, must not be `None`") # noqa: E501 + + self._product_rate_plan_name = product_rate_plan_name + + @property + def public_product_rate_plan_name(self): + """Gets the public_product_rate_plan_name of this PricingComponentCharge. # noqa: E501 + + + :return: The public_product_rate_plan_name of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._public_product_rate_plan_name + + @public_product_rate_plan_name.setter + def public_product_rate_plan_name(self, public_product_rate_plan_name): + """Sets the public_product_rate_plan_name of this PricingComponentCharge. + + + :param public_product_rate_plan_name: The public_product_rate_plan_name of this PricingComponentCharge. # noqa: E501 + :type: str + """ + + self._public_product_rate_plan_name = public_product_rate_plan_name + + @property + def product_rate_plan_id(self): + """Gets the product_rate_plan_id of this PricingComponentCharge. # noqa: E501 + + + :return: The product_rate_plan_id of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_id + + @product_rate_plan_id.setter + def product_rate_plan_id(self, product_rate_plan_id): + """Sets the product_rate_plan_id of this PricingComponentCharge. + + + :param product_rate_plan_id: The product_rate_plan_id of this PricingComponentCharge. # noqa: E501 + :type: str + """ + if product_rate_plan_id is None: + raise ValueError("Invalid value for `product_rate_plan_id`, must not be `None`") # noqa: E501 + + self._product_rate_plan_id = product_rate_plan_id + + @property + def unit_of_measure_id(self): + """Gets the unit_of_measure_id of this PricingComponentCharge. # noqa: E501 + + + :return: The unit_of_measure_id of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._unit_of_measure_id + + @unit_of_measure_id.setter + def unit_of_measure_id(self, unit_of_measure_id): + """Sets the unit_of_measure_id of this PricingComponentCharge. + + + :param unit_of_measure_id: The unit_of_measure_id of this PricingComponentCharge. # noqa: E501 + :type: str + """ + if unit_of_measure_id is None: + raise ValueError("Invalid value for `unit_of_measure_id`, must not be `None`") # noqa: E501 + + self._unit_of_measure_id = unit_of_measure_id + + @property + def unit_of_measure_name(self): + """Gets the unit_of_measure_name of this PricingComponentCharge. # noqa: E501 + + + :return: The unit_of_measure_name of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._unit_of_measure_name + + @unit_of_measure_name.setter + def unit_of_measure_name(self, unit_of_measure_name): + """Sets the unit_of_measure_name of this PricingComponentCharge. + + + :param unit_of_measure_name: The unit_of_measure_name of this PricingComponentCharge. # noqa: E501 + :type: str + """ + if unit_of_measure_name is None: + raise ValueError("Invalid value for `unit_of_measure_name`, must not be `None`") # noqa: E501 + + self._unit_of_measure_name = unit_of_measure_name + + @property + def pricing_component_value(self): + """Gets the pricing_component_value of this PricingComponentCharge. # noqa: E501 + + + :return: The pricing_component_value of this PricingComponentCharge. # noqa: E501 + :rtype: int + """ + return self._pricing_component_value + + @pricing_component_value.setter + def pricing_component_value(self, pricing_component_value): + """Sets the pricing_component_value of this PricingComponentCharge. + + + :param pricing_component_value: The pricing_component_value of this PricingComponentCharge. # noqa: E501 + :type: int + """ + if pricing_component_value is None: + raise ValueError("Invalid value for `pricing_component_value`, must not be `None`") # noqa: E501 + + self._pricing_component_value = pricing_component_value + + @property + def existing_pricing_component_value(self): + """Gets the existing_pricing_component_value of this PricingComponentCharge. # noqa: E501 + + + :return: The existing_pricing_component_value of this PricingComponentCharge. # noqa: E501 + :rtype: int + """ + return self._existing_pricing_component_value + + @existing_pricing_component_value.setter + def existing_pricing_component_value(self, existing_pricing_component_value): + """Sets the existing_pricing_component_value of this PricingComponentCharge. + + + :param existing_pricing_component_value: The existing_pricing_component_value of this PricingComponentCharge. # noqa: E501 + :type: int + """ + if existing_pricing_component_value is None: + raise ValueError("Invalid value for `existing_pricing_component_value`, must not be `None`") # noqa: E501 + + self._existing_pricing_component_value = existing_pricing_component_value + + @property + def pricing_component_type(self): + """Gets the pricing_component_type of this PricingComponentCharge. # noqa: E501 + + + :return: The pricing_component_type of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._pricing_component_type + + @pricing_component_type.setter + def pricing_component_type(self, pricing_component_type): + """Sets the pricing_component_type of this PricingComponentCharge. + + + :param pricing_component_type: The pricing_component_type of this PricingComponentCharge. # noqa: E501 + :type: str + """ + allowed_values = ["setup", "subscription", "arrears", "usage"] # noqa: E501 + if pricing_component_type not in allowed_values: + raise ValueError( + "Invalid value for `pricing_component_type` ({0}), must be one of {1}" # noqa: E501 + .format(pricing_component_type, allowed_values) + ) + + self._pricing_component_type = pricing_component_type + + @property + def creation_type(self): + """Gets the creation_type of this PricingComponentCharge. # noqa: E501 + + + :return: The creation_type of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._creation_type + + @creation_type.setter + def creation_type(self, creation_type): + """Sets the creation_type of this PricingComponentCharge. + + + :param creation_type: The creation_type of this PricingComponentCharge. # noqa: E501 + :type: str + """ + allowed_values = ["Adhoc", "Subscription", "Upgrade", "ComponentAggregation"] # noqa: E501 + if creation_type not in allowed_values: + raise ValueError( + "Invalid value for `creation_type` ({0}), must be one of {1}" # noqa: E501 + .format(creation_type, allowed_values) + ) + + self._creation_type = creation_type + + @property + def proration(self): + """Gets the proration of this PricingComponentCharge. # noqa: E501 + + + :return: The proration of this PricingComponentCharge. # noqa: E501 + :rtype: float + """ + return self._proration + + @proration.setter + def proration(self, proration): + """Sets the proration of this PricingComponentCharge. + + + :param proration: The proration of this PricingComponentCharge. # noqa: E501 + :type: float + """ + + self._proration = proration + + @property + def quantity_label(self): + """Gets the quantity_label of this PricingComponentCharge. # noqa: E501 + + + :return: The quantity_label of this PricingComponentCharge. # noqa: E501 + :rtype: str + """ + return self._quantity_label + + @quantity_label.setter + def quantity_label(self, quantity_label): + """Sets the quantity_label of this PricingComponentCharge. + + + :param quantity_label: The quantity_label of this PricingComponentCharge. # noqa: E501 + :type: str + """ + + self._quantity_label = quantity_label + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PricingComponentCharge, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PricingComponentCharge): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/pricing_component_coupon_modifier.py b/billforward/models/pricing_component_coupon_modifier.py deleted file mode 100644 index 2246588..0000000 --- a/billforward/models/pricing_component_coupon_modifier.py +++ /dev/null @@ -1,506 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PricingComponentCouponModifier(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, coupon_definition_id=None, effect_amount=None, operand=None, effect=None, effect_additional=False, specifier_amount=None, domain=None, specifier=None, precedence=None, deleted=False): - """ - PricingComponentCouponModifier - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'coupon_definition_id': 'str', - 'effect_amount': 'float', - 'operand': 'str', - 'effect': 'str', - 'effect_additional': 'bool', - 'specifier_amount': 'int', - 'domain': 'str', - 'specifier': 'str', - 'precedence': 'int', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'coupon_definition_id': 'couponDefinitionID', - 'effect_amount': 'effectAmount', - 'operand': 'operand', - 'effect': 'effect', - 'effect_additional': 'effectAdditional', - 'specifier_amount': 'specifierAmount', - 'domain': 'domain', - 'specifier': 'specifier', - 'precedence': 'precedence', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._coupon_definition_id = coupon_definition_id - self._effect_amount = effect_amount - self._operand = operand - self._effect = effect - self._effect_additional = effect_additional - self._specifier_amount = specifier_amount - self._domain = domain - self._specifier = specifier - self._precedence = precedence - self._deleted = deleted - - @property - def created(self): - """ - Gets the created of this PricingComponentCouponModifier. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this PricingComponentCouponModifier. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this PricingComponentCouponModifier. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this PricingComponentCouponModifier. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this PricingComponentCouponModifier. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this PricingComponentCouponModifier. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this PricingComponentCouponModifier. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this PricingComponentCouponModifier. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this PricingComponentCouponModifier. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this PricingComponentCouponModifier. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this PricingComponentCouponModifier. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this PricingComponentCouponModifier. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this PricingComponentCouponModifier. - { \"description\" : \"ID of the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this PricingComponentCouponModifier. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this PricingComponentCouponModifier. - { \"description\" : \"ID of the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this PricingComponentCouponModifier. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this PricingComponentCouponModifier. - { \"description\" : \"ID of the organization associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this PricingComponentCouponModifier. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this PricingComponentCouponModifier. - { \"description\" : \"ID of the organization associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this PricingComponentCouponModifier. - :type: str - """ - - self._organization_id = organization_id - - @property - def coupon_definition_id(self): - """ - Gets the coupon_definition_id of this PricingComponentCouponModifier. - { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The coupon_definition_id of this PricingComponentCouponModifier. - :rtype: str - """ - return self._coupon_definition_id - - @coupon_definition_id.setter - def coupon_definition_id(self, coupon_definition_id): - """ - Sets the coupon_definition_id of this PricingComponentCouponModifier. - { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param coupon_definition_id: The coupon_definition_id of this PricingComponentCouponModifier. - :type: str - """ - - self._coupon_definition_id = coupon_definition_id - - @property - def effect_amount(self): - """ - Gets the effect_amount of this PricingComponentCouponModifier. - { \"description\" : \"The effect amount for the coupon-modifier. This is affected by the operand field.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The effect_amount of this PricingComponentCouponModifier. - :rtype: float - """ - return self._effect_amount - - @effect_amount.setter - def effect_amount(self, effect_amount): - """ - Sets the effect_amount of this PricingComponentCouponModifier. - { \"description\" : \"The effect amount for the coupon-modifier. This is affected by the operand field.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param effect_amount: The effect_amount of this PricingComponentCouponModifier. - :type: float - """ - - self._effect_amount = effect_amount - - @property - def operand(self): - """ - Gets the operand of this PricingComponentCouponModifier. - { \"description\" : \"The operand field affects the effect amount of the coupon-modifier. If the operand is fixed, it is an exact amount of the currency defined by the coupon-definition. If the operand is percent, this means the coupon will be affecting a percentage of the unaltered cost. E.g. a 25% modifier will apply a 25% discount on a subscription or a pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The operand of this PricingComponentCouponModifier. - :rtype: str - """ - return self._operand - - @operand.setter - def operand(self, operand): - """ - Sets the operand of this PricingComponentCouponModifier. - { \"description\" : \"The operand field affects the effect amount of the coupon-modifier. If the operand is fixed, it is an exact amount of the currency defined by the coupon-definition. If the operand is percent, this means the coupon will be affecting a percentage of the unaltered cost. E.g. a 25% modifier will apply a 25% discount on a subscription or a pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param operand: The operand of this PricingComponentCouponModifier. - :type: str - """ - allowed_values = ["fixed", "percent", "instance_fixed", "instance_percent"] - if operand not in allowed_values: - raise ValueError( - "Invalid value for `operand` ({0}), must be one of {1}" - .format(operand, allowed_values) - ) - - self._operand = operand - - @property - def effect(self): - """ - Gets the effect of this PricingComponentCouponModifier. - { \"description\" : \"The effect of the coupon-modifier. The coupon-modifier can affect first, last, and cheapest value of a specific unit-of-measure-id for a subscription. The coupon-modifier can also affect all of the values for a unit-of-measure-id, or can affect all of the subscription cost.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The effect of this PricingComponentCouponModifier. - :rtype: str - """ - return self._effect - - @effect.setter - def effect(self, effect): - """ - Sets the effect of this PricingComponentCouponModifier. - { \"description\" : \"The effect of the coupon-modifier. The coupon-modifier can affect first, last, and cheapest value of a specific unit-of-measure-id for a subscription. The coupon-modifier can also affect all of the values for a unit-of-measure-id, or can affect all of the subscription cost.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param effect: The effect of this PricingComponentCouponModifier. - :type: str - """ - allowed_values = ["discount_first_units", "discount_last_units", "discount_cheapest_units", "discount_all"] - if effect not in allowed_values: - raise ValueError( - "Invalid value for `effect` ({0}), must be one of {1}" - .format(effect, allowed_values) - ) - - self._effect = effect - - @property - def effect_additional(self): - """ - Gets the effect_additional of this PricingComponentCouponModifier. - { \"description\" : \"Specifies whether the coupon-modifier will be affecting only additional units. If this field is set, the coupon-instance-existing-values for the coupon-instance are observed, and any units of the unit-of-measure-id defined by the modifier below the coupon-instance-existing-values for that unit-of-measure-id will be ignored.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The effect_additional of this PricingComponentCouponModifier. - :rtype: bool - """ - return self._effect_additional - - @effect_additional.setter - def effect_additional(self, effect_additional): - """ - Sets the effect_additional of this PricingComponentCouponModifier. - { \"description\" : \"Specifies whether the coupon-modifier will be affecting only additional units. If this field is set, the coupon-instance-existing-values for the coupon-instance are observed, and any units of the unit-of-measure-id defined by the modifier below the coupon-instance-existing-values for that unit-of-measure-id will be ignored.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param effect_additional: The effect_additional of this PricingComponentCouponModifier. - :type: bool - """ - - self._effect_additional = effect_additional - - @property - def specifier_amount(self): - """ - Gets the specifier_amount of this PricingComponentCouponModifier. - { \"description\" : \"The number of units that will be affected by the coupon-modifier, if the domain is set to uom\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The specifier_amount of this PricingComponentCouponModifier. - :rtype: int - """ - return self._specifier_amount - - @specifier_amount.setter - def specifier_amount(self, specifier_amount): - """ - Sets the specifier_amount of this PricingComponentCouponModifier. - { \"description\" : \"The number of units that will be affected by the coupon-modifier, if the domain is set to uom\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param specifier_amount: The specifier_amount of this PricingComponentCouponModifier. - :type: int - """ - - self._specifier_amount = specifier_amount - - @property - def domain(self): - """ - Gets the domain of this PricingComponentCouponModifier. - { \"description\" : \"The domain of the coupon-modifier\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The domain of this PricingComponentCouponModifier. - :rtype: str - """ - return self._domain - - @domain.setter - def domain(self, domain): - """ - Sets the domain of this PricingComponentCouponModifier. - { \"description\" : \"The domain of the coupon-modifier\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param domain: The domain of this PricingComponentCouponModifier. - :type: str - """ - allowed_values = ["product", "uom", "PricingComponent"] - if domain not in allowed_values: - raise ValueError( - "Invalid value for `domain` ({0}), must be one of {1}" - .format(domain, allowed_values) - ) - - self._domain = domain - - @property - def specifier(self): - """ - Gets the specifier of this PricingComponentCouponModifier. - { \"description\" : \"The specifier is domain-specific. If the domain is uom, this field is used to limit the coupon-modifier to a specific unit-of-measure-id.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The specifier of this PricingComponentCouponModifier. - :rtype: str - """ - return self._specifier - - @specifier.setter - def specifier(self, specifier): - """ - Sets the specifier of this PricingComponentCouponModifier. - { \"description\" : \"The specifier is domain-specific. If the domain is uom, this field is used to limit the coupon-modifier to a specific unit-of-measure-id.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param specifier: The specifier of this PricingComponentCouponModifier. - :type: str - """ - - self._specifier = specifier - - @property - def precedence(self): - """ - Gets the precedence of this PricingComponentCouponModifier. - { \"description\" : \"The precedence of the coupon-modifier. This is used to order application of coupon-modifiers. Higher precedence means the coupon-modifier will be applied before others.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The precedence of this PricingComponentCouponModifier. - :rtype: int - """ - return self._precedence - - @precedence.setter - def precedence(self, precedence): - """ - Sets the precedence of this PricingComponentCouponModifier. - { \"description\" : \"The precedence of the coupon-modifier. This is used to order application of coupon-modifiers. Higher precedence means the coupon-modifier will be applied before others.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param precedence: The precedence of this PricingComponentCouponModifier. - :type: int - """ - - self._precedence = precedence - - @property - def deleted(self): - """ - Gets the deleted of this PricingComponentCouponModifier. - { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The deleted of this PricingComponentCouponModifier. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this PricingComponentCouponModifier. - { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param deleted: The deleted of this PricingComponentCouponModifier. - :type: bool - """ - - self._deleted = deleted - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/pricing_component_migration_value.py b/billforward/models/pricing_component_migration_value.py index 7385548..df83a1d 100644 --- a/billforward/models/pricing_component_migration_value.py +++ b/billforward/models/pricing_component_migration_value.py @@ -1,85 +1,98 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class PricingComponentMigrationValue(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, id=None, pricing_component=None, value=None): - """ - PricingComponentMigrationValue - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'id': 'str', - 'pricing_component': 'str', - 'value': 'int' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'id': 'id', - 'pricing_component': 'pricingComponent', - 'value': 'value' - } - - self._created = created - self._changed_by = changed_by - self._id = id - self._pricing_component = pricing_component - self._value = value + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'id': 'str', + 'pricing_component': 'str', + 'pricing_component_id': 'str', + 'pricing_component_name': 'str', + 'value': 'int', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'id': 'id', + 'pricing_component': 'pricingComponent', + 'pricing_component_id': 'pricingComponentID', + 'pricing_component_name': 'pricingComponentName', + 'value': 'value', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, changed_by=None, id=None, pricing_component=None, pricing_component_id=None, pricing_component_name=None, value=None, organization_id=None): # noqa: E501 + """PricingComponentMigrationValue - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._id = None + self._pricing_component = None + self._pricing_component_id = None + self._pricing_component_name = None + self._value = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if id is not None: + self.id = id + if pricing_component is not None: + self.pricing_component = pricing_component + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if value is not None: + self.value = value + if organization_id is not None: + self.organization_id = organization_id @property def created(self): - """ - Gets the created of this PricingComponentMigrationValue. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this PricingComponentMigrationValue. # noqa: E501 + - :return: The created of this PricingComponentMigrationValue. + :return: The created of this PricingComponentMigrationValue. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this PricingComponentMigrationValue. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this PricingComponentMigrationValue. + - :param created: The created of this PricingComponentMigrationValue. + :param created: The created of this PricingComponentMigrationValue. # noqa: E501 :type: datetime """ @@ -87,22 +100,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this PricingComponentMigrationValue. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this PricingComponentMigrationValue. # noqa: E501 - :return: The changed_by of this PricingComponentMigrationValue. + + :return: The changed_by of this PricingComponentMigrationValue. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this PricingComponentMigrationValue. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this PricingComponentMigrationValue. - :param changed_by: The changed_by of this PricingComponentMigrationValue. + + :param changed_by: The changed_by of this PricingComponentMigrationValue. # noqa: E501 :type: str """ @@ -110,22 +121,20 @@ def changed_by(self, changed_by): @property def id(self): - """ - Gets the id of this PricingComponentMigrationValue. - {\"description\":\"The ID of the charge.\",\"verbs\":[\"GET\"]} + """Gets the id of this PricingComponentMigrationValue. # noqa: E501 + - :return: The id of this PricingComponentMigrationValue. + :return: The id of this PricingComponentMigrationValue. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this PricingComponentMigrationValue. - {\"description\":\"The ID of the charge.\",\"verbs\":[\"GET\"]} + """Sets the id of this PricingComponentMigrationValue. + - :param id: The id of this PricingComponentMigrationValue. + :param id: The id of this PricingComponentMigrationValue. # noqa: E501 :type: str """ @@ -133,57 +142,114 @@ def id(self, id): @property def pricing_component(self): - """ - Gets the pricing_component of this PricingComponentMigrationValue. - {\"description\":\"ID or name of the pricing component whose migration value is being described.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the pricing_component of this PricingComponentMigrationValue. # noqa: E501 + - :return: The pricing_component of this PricingComponentMigrationValue. + :return: The pricing_component of this PricingComponentMigrationValue. # noqa: E501 :rtype: str """ return self._pricing_component @pricing_component.setter def pricing_component(self, pricing_component): - """ - Sets the pricing_component of this PricingComponentMigrationValue. - {\"description\":\"ID or name of the pricing component whose migration value is being described.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the pricing_component of this PricingComponentMigrationValue. - :param pricing_component: The pricing_component of this PricingComponentMigrationValue. + + :param pricing_component: The pricing_component of this PricingComponentMigrationValue. # noqa: E501 :type: str """ self._pricing_component = pricing_component @property - def value(self): + def pricing_component_id(self): + """Gets the pricing_component_id of this PricingComponentMigrationValue. # noqa: E501 + + + :return: The pricing_component_id of this PricingComponentMigrationValue. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this PricingComponentMigrationValue. + + + :param pricing_component_id: The pricing_component_id of this PricingComponentMigrationValue. # noqa: E501 + :type: str + """ + + self._pricing_component_id = pricing_component_id + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this PricingComponentMigrationValue. # noqa: E501 + + + :return: The pricing_component_name of this PricingComponentMigrationValue. # noqa: E501 + :rtype: str + """ + return self._pricing_component_name + + @pricing_component_name.setter + def pricing_component_name(self, pricing_component_name): + """Sets the pricing_component_name of this PricingComponentMigrationValue. + + + :param pricing_component_name: The pricing_component_name of this PricingComponentMigrationValue. # noqa: E501 + :type: str """ - Gets the value of this PricingComponentMigrationValue. - {\"description\":\"Amount consumed of the pricing component whose migration value is being described.\",\"verbs\":[\"POST\",\"GET\"]} - :return: The value of this PricingComponentMigrationValue. + self._pricing_component_name = pricing_component_name + + @property + def value(self): + """Gets the value of this PricingComponentMigrationValue. # noqa: E501 + + + :return: The value of this PricingComponentMigrationValue. # noqa: E501 :rtype: int """ return self._value @value.setter def value(self, value): - """ - Sets the value of this PricingComponentMigrationValue. - {\"description\":\"Amount consumed of the pricing component whose migration value is being described.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the value of this PricingComponentMigrationValue. + - :param value: The value of this PricingComponentMigrationValue. + :param value: The value of this PricingComponentMigrationValue. # noqa: E501 :type: int """ self._value = value - def to_dict(self): + @property + def organization_id(self): + """Gets the organization_id of this PricingComponentMigrationValue. # noqa: E501 + + + :return: The organization_id of this PricingComponentMigrationValue. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this PricingComponentMigrationValue. + + + :param organization_id: The organization_id of this PricingComponentMigrationValue. # noqa: E501 + :type: str """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -200,29 +266,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(PricingComponentMigrationValue, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, PricingComponentMigrationValue): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/pricing_component_paged_metadata.py b/billforward/models/pricing_component_paged_metadata.py deleted file mode 100644 index 674cc0b..0000000 --- a/billforward/models/pricing_component_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PricingComponentPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - PricingComponentPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[PricingComponent]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this PricingComponentPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this PricingComponentPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this PricingComponentPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this PricingComponentPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this PricingComponentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this PricingComponentPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this PricingComponentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this PricingComponentPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this PricingComponentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this PricingComponentPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this PricingComponentPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this PricingComponentPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this PricingComponentPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this PricingComponentPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this PricingComponentPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this PricingComponentPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this PricingComponentPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this PricingComponentPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this PricingComponentPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this PricingComponentPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this PricingComponentPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this PricingComponentPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this PricingComponentPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this PricingComponentPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this PricingComponentPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this PricingComponentPagedMetadata. - :rtype: list[PricingComponent] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this PricingComponentPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this PricingComponentPagedMetadata. - :type: list[PricingComponent] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/pricing_component_quantity_request.py b/billforward/models/pricing_component_quantity_request.py deleted file mode 100644 index ddd95e4..0000000 --- a/billforward/models/pricing_component_quantity_request.py +++ /dev/null @@ -1,176 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PricingComponentQuantityRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, pricing_component=None, quantity=None, percentage_discount=None): - """ - PricingComponentQuantityRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'pricing_component': 'str', - 'quantity': 'int', - 'percentage_discount': 'float' - } - - self.attribute_map = { - 'pricing_component': 'pricingComponent', - 'quantity': 'quantity', - 'percentage_discount': 'percentageDiscount' - } - - self._pricing_component = pricing_component - self._quantity = quantity - self._percentage_discount = percentage_discount - - @property - def pricing_component(self): - """ - Gets the pricing_component of this PricingComponentQuantityRequest. - - - :return: The pricing_component of this PricingComponentQuantityRequest. - :rtype: str - """ - return self._pricing_component - - @pricing_component.setter - def pricing_component(self, pricing_component): - """ - Sets the pricing_component of this PricingComponentQuantityRequest. - - - :param pricing_component: The pricing_component of this PricingComponentQuantityRequest. - :type: str - """ - - self._pricing_component = pricing_component - - @property - def quantity(self): - """ - Gets the quantity of this PricingComponentQuantityRequest. - - - :return: The quantity of this PricingComponentQuantityRequest. - :rtype: int - """ - return self._quantity - - @quantity.setter - def quantity(self, quantity): - """ - Sets the quantity of this PricingComponentQuantityRequest. - - - :param quantity: The quantity of this PricingComponentQuantityRequest. - :type: int - """ - - self._quantity = quantity - - @property - def percentage_discount(self): - """ - Gets the percentage_discount of this PricingComponentQuantityRequest. - { \"description\" : \"Percentage to be discounted\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The percentage_discount of this PricingComponentQuantityRequest. - :rtype: float - """ - return self._percentage_discount - - @percentage_discount.setter - def percentage_discount(self, percentage_discount): - """ - Sets the percentage_discount of this PricingComponentQuantityRequest. - { \"description\" : \"Percentage to be discounted\", \"verbs\":[\"POST\",\"GET\"] } - - :param percentage_discount: The percentage_discount of this PricingComponentQuantityRequest. - :type: float - """ - - self._percentage_discount = percentage_discount - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/pricing_component_tier.py b/billforward/models/pricing_component_tier.py index 890d1d1..1c8da63 100644 --- a/billforward/models/pricing_component_tier.py +++ b/billforward/models/pricing_component_tier.py @@ -1,152 +1,126 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class PricingComponentTier(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, lower_threshold=None, upper_threshold=None, created=None, changed_by=None, id=None, crm_id=None, pricing_component_version_id=None, pricing_component_id=None, product_rate_plan_id=None, organization_id=None, pricing_type=None, price=None): - """ - PricingComponentTier - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'lower_threshold': 'int', - 'upper_threshold': 'int', - 'created': 'datetime', - 'changed_by': 'str', - 'id': 'str', - 'crm_id': 'str', - 'pricing_component_version_id': 'str', - 'pricing_component_id': 'str', - 'product_rate_plan_id': 'str', - 'organization_id': 'str', - 'pricing_type': 'str', - 'price': 'float' - } - - self.attribute_map = { - 'lower_threshold': 'lowerThreshold', - 'upper_threshold': 'upperThreshold', - 'created': 'created', - 'changed_by': 'changedBy', - 'id': 'id', - 'crm_id': 'crmID', - 'pricing_component_version_id': 'pricingComponentVersionID', - 'pricing_component_id': 'pricingComponentID', - 'product_rate_plan_id': 'productRatePlanID', - 'organization_id': 'organizationID', - 'pricing_type': 'pricingType', - 'price': 'price' - } - - self._lower_threshold = lower_threshold - self._upper_threshold = upper_threshold - self._created = created - self._changed_by = changed_by - self._id = id - self._crm_id = crm_id - self._pricing_component_version_id = pricing_component_version_id - self._pricing_component_id = pricing_component_id - self._product_rate_plan_id = product_rate_plan_id - self._organization_id = organization_id - self._pricing_type = pricing_type - self._price = price - - @property - def lower_threshold(self): - """ - Gets the lower_threshold of this PricingComponentTier. - { \"description\" : \"The lower threshold of the tier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The lower_threshold of this PricingComponentTier. - :rtype: int - """ - return self._lower_threshold - - @lower_threshold.setter - def lower_threshold(self, lower_threshold): - """ - Sets the lower_threshold of this PricingComponentTier. - { \"description\" : \"The lower threshold of the tier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param lower_threshold: The lower_threshold of this PricingComponentTier. - :type: int - """ - - self._lower_threshold = lower_threshold - - @property - def upper_threshold(self): - """ - Gets the upper_threshold of this PricingComponentTier. - { \"default\" : \"∞\", \"description\" : \"The upper threshold of the tier. If this is left null the tier will be infinite\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The upper_threshold of this PricingComponentTier. - :rtype: int - """ - return self._upper_threshold - - @upper_threshold.setter - def upper_threshold(self, upper_threshold): - """ - Sets the upper_threshold of this PricingComponentTier. - { \"default\" : \"∞\", \"description\" : \"The upper threshold of the tier. If this is left null the tier will be infinite\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param upper_threshold: The upper_threshold of this PricingComponentTier. - :type: int - """ - - self._upper_threshold = upper_threshold + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'id': 'str', + 'crm_id': 'str', + 'pricing_component_version_id': 'str', + 'product_rate_plan_id': 'str', + 'organization_id': 'str', + 'lower_threshold': 'int', + 'bucket_size': 'int', + 'upper_threshold': 'int', + 'pricing_type': 'str', + 'price': 'float', + 'component_id': 'str', + 'pricing_component_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'id': 'id', + 'crm_id': 'crmID', + 'pricing_component_version_id': 'pricingComponentVersionID', + 'product_rate_plan_id': 'productRatePlanID', + 'organization_id': 'organizationID', + 'lower_threshold': 'lowerThreshold', + 'bucket_size': 'bucketSize', + 'upper_threshold': 'upperThreshold', + 'pricing_type': 'pricingType', + 'price': 'price', + 'component_id': 'componentID', + 'pricing_component_id': 'pricingComponentID' + } + + def __init__(self, created=None, changed_by=None, id=None, crm_id=None, pricing_component_version_id=None, product_rate_plan_id=None, organization_id=None, lower_threshold=None, bucket_size=None, upper_threshold=None, pricing_type=None, price=None, component_id=None, pricing_component_id=None): # noqa: E501 + """PricingComponentTier - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._id = None + self._crm_id = None + self._pricing_component_version_id = None + self._product_rate_plan_id = None + self._organization_id = None + self._lower_threshold = None + self._bucket_size = None + self._upper_threshold = None + self._pricing_type = None + self._price = None + self._component_id = None + self._pricing_component_id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if id is not None: + self.id = id + if crm_id is not None: + self.crm_id = crm_id + if pricing_component_version_id is not None: + self.pricing_component_version_id = pricing_component_version_id + if product_rate_plan_id is not None: + self.product_rate_plan_id = product_rate_plan_id + if organization_id is not None: + self.organization_id = organization_id + if lower_threshold is not None: + self.lower_threshold = lower_threshold + if bucket_size is not None: + self.bucket_size = bucket_size + if upper_threshold is not None: + self.upper_threshold = upper_threshold + self.pricing_type = pricing_type + self.price = price + if component_id is not None: + self.component_id = component_id + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id @property def created(self): - """ - Gets the created of this PricingComponentTier. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this PricingComponentTier. # noqa: E501 - :return: The created of this PricingComponentTier. + + :return: The created of this PricingComponentTier. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this PricingComponentTier. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this PricingComponentTier. + - :param created: The created of this PricingComponentTier. + :param created: The created of this PricingComponentTier. # noqa: E501 :type: datetime """ @@ -154,22 +128,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this PricingComponentTier. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this PricingComponentTier. # noqa: E501 + - :return: The changed_by of this PricingComponentTier. + :return: The changed_by of this PricingComponentTier. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this PricingComponentTier. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this PricingComponentTier. - :param changed_by: The changed_by of this PricingComponentTier. + + :param changed_by: The changed_by of this PricingComponentTier. # noqa: E501 :type: str """ @@ -177,22 +149,20 @@ def changed_by(self, changed_by): @property def id(self): - """ - Gets the id of this PricingComponentTier. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the id of this PricingComponentTier. # noqa: E501 + - :return: The id of this PricingComponentTier. + :return: The id of this PricingComponentTier. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this PricingComponentTier. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the id of this PricingComponentTier. + - :param id: The id of this PricingComponentTier. + :param id: The id of this PricingComponentTier. # noqa: E501 :type: str """ @@ -200,22 +170,20 @@ def id(self, id): @property def crm_id(self): - """ - Gets the crm_id of this PricingComponentTier. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the crm_id of this PricingComponentTier. # noqa: E501 - :return: The crm_id of this PricingComponentTier. + + :return: The crm_id of this PricingComponentTier. # noqa: E501 :rtype: str """ return self._crm_id @crm_id.setter def crm_id(self, crm_id): - """ - Sets the crm_id of this PricingComponentTier. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the crm_id of this PricingComponentTier. + - :param crm_id: The crm_id of this PricingComponentTier. + :param crm_id: The crm_id of this PricingComponentTier. # noqa: E501 :type: str """ @@ -223,68 +191,41 @@ def crm_id(self, crm_id): @property def pricing_component_version_id(self): - """ - Gets the pricing_component_version_id of this PricingComponentTier. - { \"description\" : \"Version ID of the associated pricing-component\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the pricing_component_version_id of this PricingComponentTier. # noqa: E501 + - :return: The pricing_component_version_id of this PricingComponentTier. + :return: The pricing_component_version_id of this PricingComponentTier. # noqa: E501 :rtype: str """ return self._pricing_component_version_id @pricing_component_version_id.setter def pricing_component_version_id(self, pricing_component_version_id): - """ - Sets the pricing_component_version_id of this PricingComponentTier. - { \"description\" : \"Version ID of the associated pricing-component\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param pricing_component_version_id: The pricing_component_version_id of this PricingComponentTier. - :type: str - """ - - self._pricing_component_version_id = pricing_component_version_id - - @property - def pricing_component_id(self): - """ - Gets the pricing_component_id of this PricingComponentTier. - { \"description\" : \"ID of the pricing-component associated with the pricing-component-tier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the pricing_component_version_id of this PricingComponentTier. - :return: The pricing_component_id of this PricingComponentTier. - :rtype: str - """ - return self._pricing_component_id - - @pricing_component_id.setter - def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this PricingComponentTier. - { \"description\" : \"ID of the pricing-component associated with the pricing-component-tier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - :param pricing_component_id: The pricing_component_id of this PricingComponentTier. + :param pricing_component_version_id: The pricing_component_version_id of this PricingComponentTier. # noqa: E501 :type: str """ - self._pricing_component_id = pricing_component_id + self._pricing_component_version_id = pricing_component_version_id @property def product_rate_plan_id(self): - """ - Gets the product_rate_plan_id of this PricingComponentTier. - { \"description\" : \"ID of the product-rate-plan associated with the pricing-component-tier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the product_rate_plan_id of this PricingComponentTier. # noqa: E501 + - :return: The product_rate_plan_id of this PricingComponentTier. + :return: The product_rate_plan_id of this PricingComponentTier. # noqa: E501 :rtype: str """ return self._product_rate_plan_id @product_rate_plan_id.setter def product_rate_plan_id(self, product_rate_plan_id): - """ - Sets the product_rate_plan_id of this PricingComponentTier. - { \"description\" : \"ID of the product-rate-plan associated with the pricing-component-tier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the product_rate_plan_id of this PricingComponentTier. - :param product_rate_plan_id: The product_rate_plan_id of this PricingComponentTier. + + :param product_rate_plan_id: The product_rate_plan_id of this PricingComponentTier. # noqa: E501 :type: str """ @@ -292,51 +233,112 @@ def product_rate_plan_id(self, product_rate_plan_id): @property def organization_id(self): - """ - Gets the organization_id of this PricingComponentTier. - { \"description\" : \"Organization associated with the pricing-component-tier.\", \"verbs\":[] } + """Gets the organization_id of this PricingComponentTier. # noqa: E501 - :return: The organization_id of this PricingComponentTier. + + :return: The organization_id of this PricingComponentTier. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this PricingComponentTier. - { \"description\" : \"Organization associated with the pricing-component-tier.\", \"verbs\":[] } + """Sets the organization_id of this PricingComponentTier. - :param organization_id: The organization_id of this PricingComponentTier. + + :param organization_id: The organization_id of this PricingComponentTier. # noqa: E501 :type: str """ self._organization_id = organization_id @property - def pricing_type(self): + def lower_threshold(self): + """Gets the lower_threshold of this PricingComponentTier. # noqa: E501 + + + :return: The lower_threshold of this PricingComponentTier. # noqa: E501 + :rtype: int """ - Gets the pricing_type of this PricingComponentTier. - { \"description\" : \"Pricing calculation used to price items in this pricing tier. Unit pricing means every distinct value is used in the calculation. Fixed means that the total price of the tier is fixed regardless of the purchased amount.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + return self._lower_threshold + + @lower_threshold.setter + def lower_threshold(self, lower_threshold): + """Sets the lower_threshold of this PricingComponentTier. + + + :param lower_threshold: The lower_threshold of this PricingComponentTier. # noqa: E501 + :type: int + """ + + self._lower_threshold = lower_threshold + + @property + def bucket_size(self): + """Gets the bucket_size of this PricingComponentTier. # noqa: E501 + + + :return: The bucket_size of this PricingComponentTier. # noqa: E501 + :rtype: int + """ + return self._bucket_size + + @bucket_size.setter + def bucket_size(self, bucket_size): + """Sets the bucket_size of this PricingComponentTier. + + + :param bucket_size: The bucket_size of this PricingComponentTier. # noqa: E501 + :type: int + """ + + self._bucket_size = bucket_size + + @property + def upper_threshold(self): + """Gets the upper_threshold of this PricingComponentTier. # noqa: E501 + + + :return: The upper_threshold of this PricingComponentTier. # noqa: E501 + :rtype: int + """ + return self._upper_threshold + + @upper_threshold.setter + def upper_threshold(self, upper_threshold): + """Sets the upper_threshold of this PricingComponentTier. + + + :param upper_threshold: The upper_threshold of this PricingComponentTier. # noqa: E501 + :type: int + """ + + self._upper_threshold = upper_threshold - :return: The pricing_type of this PricingComponentTier. + @property + def pricing_type(self): + """Gets the pricing_type of this PricingComponentTier. # noqa: E501 + + + :return: The pricing_type of this PricingComponentTier. # noqa: E501 :rtype: str """ return self._pricing_type @pricing_type.setter def pricing_type(self, pricing_type): - """ - Sets the pricing_type of this PricingComponentTier. - { \"description\" : \"Pricing calculation used to price items in this pricing tier. Unit pricing means every distinct value is used in the calculation. Fixed means that the total price of the tier is fixed regardless of the purchased amount.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the pricing_type of this PricingComponentTier. + - :param pricing_type: The pricing_type of this PricingComponentTier. + :param pricing_type: The pricing_type of this PricingComponentTier. # noqa: E501 :type: str """ - allowed_values = ["unit", "fixed"] + if pricing_type is None: + raise ValueError("Invalid value for `pricing_type`, must not be `None`") # noqa: E501 + allowed_values = ["unit", "fixed", "bucket"] # noqa: E501 if pricing_type not in allowed_values: raise ValueError( - "Invalid value for `pricing_type` ({0}), must be one of {1}" + "Invalid value for `pricing_type` ({0}), must be one of {1}" # noqa: E501 .format(pricing_type, allowed_values) ) @@ -344,34 +346,74 @@ def pricing_type(self, pricing_type): @property def price(self): - """ - Gets the price of this PricingComponentTier. - { \"description\" : \"Cost associated with tier. When the pricingType is fixed this is the total value. When pricingType is unit, this is the cost of each unit. \", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the price of this PricingComponentTier. # noqa: E501 + - :return: The price of this PricingComponentTier. + :return: The price of this PricingComponentTier. # noqa: E501 :rtype: float """ return self._price @price.setter def price(self, price): - """ - Sets the price of this PricingComponentTier. - { \"description\" : \"Cost associated with tier. When the pricingType is fixed this is the total value. When pricingType is unit, this is the cost of each unit. \", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the price of this PricingComponentTier. - :param price: The price of this PricingComponentTier. + + :param price: The price of this PricingComponentTier. # noqa: E501 :type: float """ + if price is None: + raise ValueError("Invalid value for `price`, must not be `None`") # noqa: E501 self._price = price - def to_dict(self): + @property + def component_id(self): + """Gets the component_id of this PricingComponentTier. # noqa: E501 + + + :return: The component_id of this PricingComponentTier. # noqa: E501 + :rtype: str + """ + return self._component_id + + @component_id.setter + def component_id(self, component_id): + """Sets the component_id of this PricingComponentTier. + + + :param component_id: The component_id of this PricingComponentTier. # noqa: E501 + :type: str + """ + + self._component_id = component_id + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this PricingComponentTier. # noqa: E501 + + + :return: The pricing_component_id of this PricingComponentTier. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this PricingComponentTier. + + + :param pricing_component_id: The pricing_component_id of this PricingComponentTier. # noqa: E501 + :type: str """ + + self._pricing_component_id = pricing_component_id + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -388,29 +430,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(PricingComponentTier, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, PricingComponentTier): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/pricing_component_tier_paged_metadata.py b/billforward/models/pricing_component_tier_paged_metadata.py deleted file mode 100644 index 9a29653..0000000 --- a/billforward/models/pricing_component_tier_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PricingComponentTierPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - PricingComponentTierPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[PricingComponentTier]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this PricingComponentTierPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this PricingComponentTierPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this PricingComponentTierPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this PricingComponentTierPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this PricingComponentTierPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this PricingComponentTierPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this PricingComponentTierPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this PricingComponentTierPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this PricingComponentTierPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this PricingComponentTierPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this PricingComponentTierPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this PricingComponentTierPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this PricingComponentTierPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this PricingComponentTierPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this PricingComponentTierPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this PricingComponentTierPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this PricingComponentTierPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this PricingComponentTierPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this PricingComponentTierPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this PricingComponentTierPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this PricingComponentTierPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this PricingComponentTierPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this PricingComponentTierPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this PricingComponentTierPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this PricingComponentTierPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this PricingComponentTierPagedMetadata. - :rtype: list[PricingComponentTier] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this PricingComponentTierPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this PricingComponentTierPagedMetadata. - :type: list[PricingComponentTier] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/pricing_component_value.py b/billforward/models/pricing_component_value.py index 2c1060e..d9321fb 100644 --- a/billforward/models/pricing_component_value.py +++ b/billforward/models/pricing_component_value.py @@ -1,109 +1,126 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class PricingComponentValue(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, version_id=None, pricing_component_id=None, pricing_component_name=None, subscription_id=None, organization_id=None, value=None, applies_from=None, applies_till=None, pending_change=None): - """ - PricingComponentValue - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'version_id': 'str', - 'pricing_component_id': 'str', - 'pricing_component_name': 'str', - 'subscription_id': 'str', - 'organization_id': 'str', - 'value': 'int', - 'applies_from': 'datetime', - 'applies_till': 'datetime', - 'pending_change': 'PendingComponentValueChange' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'version_id': 'versionID', - 'pricing_component_id': 'pricingComponentID', - 'pricing_component_name': 'pricingComponentName', - 'subscription_id': 'subscriptionID', - 'organization_id': 'organizationID', - 'value': 'value', - 'applies_from': 'appliesFrom', - 'applies_till': 'appliesTill', - 'pending_change': 'pendingChange' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._version_id = version_id - self._pricing_component_id = pricing_component_id - self._pricing_component_name = pricing_component_name - self._subscription_id = subscription_id - self._organization_id = organization_id - self._value = value - self._applies_from = applies_from - self._applies_till = applies_till - self._pending_change = pending_change + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'version_id': 'str', + 'pricing_component_id': 'str', + 'pricing_component_name': 'str', + 'subscription_id': 'str', + 'organization_id': 'str', + 'value': 'int', + 'applies_from': 'datetime', + 'applies_till': 'datetime', + 'pending_change': 'PendingComponentValueChange', + 'inferred_from_default': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'version_id': 'versionID', + 'pricing_component_id': 'pricingComponentID', + 'pricing_component_name': 'pricingComponentName', + 'subscription_id': 'subscriptionID', + 'organization_id': 'organizationID', + 'value': 'value', + 'applies_from': 'appliesFrom', + 'applies_till': 'appliesTill', + 'pending_change': 'pendingChange', + 'inferred_from_default': 'inferredFromDefault' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, version_id=None, pricing_component_id=None, pricing_component_name=None, subscription_id=None, organization_id=None, value=None, applies_from=None, applies_till=None, pending_change=None, inferred_from_default=None): # noqa: E501 + """PricingComponentValue - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._version_id = None + self._pricing_component_id = None + self._pricing_component_name = None + self._subscription_id = None + self._organization_id = None + self._value = None + self._applies_from = None + self._applies_till = None + self._pending_change = None + self._inferred_from_default = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + self.id = id + if version_id is not None: + self.version_id = version_id + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if subscription_id is not None: + self.subscription_id = subscription_id + if organization_id is not None: + self.organization_id = organization_id + self.value = value + if applies_from is not None: + self.applies_from = applies_from + if applies_till is not None: + self.applies_till = applies_till + if pending_change is not None: + self.pending_change = pending_change + if inferred_from_default is not None: + self.inferred_from_default = inferred_from_default @property def created(self): - """ - Gets the created of this PricingComponentValue. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this PricingComponentValue. # noqa: E501 + - :return: The created of this PricingComponentValue. + :return: The created of this PricingComponentValue. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this PricingComponentValue. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this PricingComponentValue. - :param created: The created of this PricingComponentValue. + + :param created: The created of this PricingComponentValue. # noqa: E501 :type: datetime """ @@ -111,22 +128,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this PricingComponentValue. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this PricingComponentValue. # noqa: E501 + - :return: The changed_by of this PricingComponentValue. + :return: The changed_by of this PricingComponentValue. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this PricingComponentValue. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this PricingComponentValue. + - :param changed_by: The changed_by of this PricingComponentValue. + :param changed_by: The changed_by of this PricingComponentValue. # noqa: E501 :type: str """ @@ -134,22 +149,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this PricingComponentValue. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this PricingComponentValue. # noqa: E501 - :return: The updated of this PricingComponentValue. + + :return: The updated of this PricingComponentValue. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this PricingComponentValue. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this PricingComponentValue. + - :param updated: The updated of this PricingComponentValue. + :param updated: The updated of this PricingComponentValue. # noqa: E501 :type: datetime """ @@ -157,45 +170,43 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this PricingComponentValue. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the id of this PricingComponentValue. # noqa: E501 + - :return: The id of this PricingComponentValue. + :return: The id of this PricingComponentValue. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this PricingComponentValue. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the id of this PricingComponentValue. - :param id: The id of this PricingComponentValue. + + :param id: The id of this PricingComponentValue. # noqa: E501 :type: str """ + if id is None: + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 self._id = id @property def version_id(self): - """ - Gets the version_id of this PricingComponentValue. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the version_id of this PricingComponentValue. # noqa: E501 + - :return: The version_id of this PricingComponentValue. + :return: The version_id of this PricingComponentValue. # noqa: E501 :rtype: str """ return self._version_id @version_id.setter def version_id(self, version_id): - """ - Sets the version_id of this PricingComponentValue. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the version_id of this PricingComponentValue. + - :param version_id: The version_id of this PricingComponentValue. + :param version_id: The version_id of this PricingComponentValue. # noqa: E501 :type: str """ @@ -203,22 +214,20 @@ def version_id(self, version_id): @property def pricing_component_id(self): - """ - Gets the pricing_component_id of this PricingComponentValue. - { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the pricing_component_id of this PricingComponentValue. # noqa: E501 - :return: The pricing_component_id of this PricingComponentValue. + + :return: The pricing_component_id of this PricingComponentValue. # noqa: E501 :rtype: str """ return self._pricing_component_id @pricing_component_id.setter def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this PricingComponentValue. - { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the pricing_component_id of this PricingComponentValue. - :param pricing_component_id: The pricing_component_id of this PricingComponentValue. + + :param pricing_component_id: The pricing_component_id of this PricingComponentValue. # noqa: E501 :type: str """ @@ -226,22 +235,20 @@ def pricing_component_id(self, pricing_component_id): @property def pricing_component_name(self): - """ - Gets the pricing_component_name of this PricingComponentValue. - { \"description\" : \"Name of the pricing-component associated with the pricing-component-value.\", \"verbs\":[\"GET\"] } + """Gets the pricing_component_name of this PricingComponentValue. # noqa: E501 + - :return: The pricing_component_name of this PricingComponentValue. + :return: The pricing_component_name of this PricingComponentValue. # noqa: E501 :rtype: str """ return self._pricing_component_name @pricing_component_name.setter def pricing_component_name(self, pricing_component_name): - """ - Sets the pricing_component_name of this PricingComponentValue. - { \"description\" : \"Name of the pricing-component associated with the pricing-component-value.\", \"verbs\":[\"GET\"] } + """Sets the pricing_component_name of this PricingComponentValue. + - :param pricing_component_name: The pricing_component_name of this PricingComponentValue. + :param pricing_component_name: The pricing_component_name of this PricingComponentValue. # noqa: E501 :type: str """ @@ -249,22 +256,20 @@ def pricing_component_name(self, pricing_component_name): @property def subscription_id(self): - """ - Gets the subscription_id of this PricingComponentValue. - { \"description\" : \"Value can be left null if setting the pricing component value on the subscription directly.\", \"verbs\":[\"GET\", \"POST\"] } + """Gets the subscription_id of this PricingComponentValue. # noqa: E501 - :return: The subscription_id of this PricingComponentValue. + + :return: The subscription_id of this PricingComponentValue. # noqa: E501 :rtype: str """ return self._subscription_id @subscription_id.setter def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this PricingComponentValue. - { \"description\" : \"Value can be left null if setting the pricing component value on the subscription directly.\", \"verbs\":[\"GET\", \"POST\"] } + """Sets the subscription_id of this PricingComponentValue. + - :param subscription_id: The subscription_id of this PricingComponentValue. + :param subscription_id: The subscription_id of this PricingComponentValue. # noqa: E501 :type: str """ @@ -272,22 +277,20 @@ def subscription_id(self, subscription_id): @property def organization_id(self): - """ - Gets the organization_id of this PricingComponentValue. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the organization_id of this PricingComponentValue. # noqa: E501 + - :return: The organization_id of this PricingComponentValue. + :return: The organization_id of this PricingComponentValue. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this PricingComponentValue. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the organization_id of this PricingComponentValue. - :param organization_id: The organization_id of this PricingComponentValue. + + :param organization_id: The organization_id of this PricingComponentValue. # noqa: E501 :type: str """ @@ -295,45 +298,43 @@ def organization_id(self, organization_id): @property def value(self): - """ - Gets the value of this PricingComponentValue. - { \"description\" : \"Quantity of a particular pricing component the subscription should have. For example if you have a pricing component for widgets, where $5/widget/month and you set the value to 10 then the customer will be charged $50 ($5 x 10) monthly.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the value of this PricingComponentValue. # noqa: E501 + - :return: The value of this PricingComponentValue. + :return: The value of this PricingComponentValue. # noqa: E501 :rtype: int """ return self._value @value.setter def value(self, value): - """ - Sets the value of this PricingComponentValue. - { \"description\" : \"Quantity of a particular pricing component the subscription should have. For example if you have a pricing component for widgets, where $5/widget/month and you set the value to 10 then the customer will be charged $50 ($5 x 10) monthly.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the value of this PricingComponentValue. + - :param value: The value of this PricingComponentValue. + :param value: The value of this PricingComponentValue. # noqa: E501 :type: int """ + if value is None: + raise ValueError("Invalid value for `value`, must not be `None`") # noqa: E501 self._value = value @property def applies_from(self): - """ - Gets the applies_from of this PricingComponentValue. - { \"description\" : \"

The appliesFrom can be left null. If appliesFrom is set, it indicates when a value came into effect.

\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the applies_from of this PricingComponentValue. # noqa: E501 - :return: The applies_from of this PricingComponentValue. + + :return: The applies_from of this PricingComponentValue. # noqa: E501 :rtype: datetime """ return self._applies_from @applies_from.setter def applies_from(self, applies_from): - """ - Sets the applies_from of this PricingComponentValue. - { \"description\" : \"

The appliesFrom can be left null. If appliesFrom is set, it indicates when a value came into effect.

\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the applies_from of this PricingComponentValue. + - :param applies_from: The applies_from of this PricingComponentValue. + :param applies_from: The applies_from of this PricingComponentValue. # noqa: E501 :type: datetime """ @@ -341,22 +342,20 @@ def applies_from(self, applies_from): @property def applies_till(self): - """ - Gets the applies_till of this PricingComponentValue. - { \"description\" : \"

For setup, subscription, and arrears pricing components if appliesTill is specificed the value will be used whilst the time has not been reached. If appliesTill is null the pricing component value will be used until a new value is added. When a new value is added appliesTill will be set to the time the new value will take effect.

usage pricing applies to the previous billing period as it is charged in-arrears. When adding usage a new pricing component value should be added with appliesTill set to the end of the usages billing period. For example a monthly subscription results in an invoice being generated on the 1st of March, the previous months usage period ended on the same date. A usage value should be added to the subscription with the appliesTill set to the invoices periodStart, the 1st of March.

\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the applies_till of this PricingComponentValue. # noqa: E501 + - :return: The applies_till of this PricingComponentValue. + :return: The applies_till of this PricingComponentValue. # noqa: E501 :rtype: datetime """ return self._applies_till @applies_till.setter def applies_till(self, applies_till): - """ - Sets the applies_till of this PricingComponentValue. - { \"description\" : \"

For setup, subscription, and arrears pricing components if appliesTill is specificed the value will be used whilst the time has not been reached. If appliesTill is null the pricing component value will be used until a new value is added. When a new value is added appliesTill will be set to the time the new value will take effect.

usage pricing applies to the previous billing period as it is charged in-arrears. When adding usage a new pricing component value should be added with appliesTill set to the end of the usages billing period. For example a monthly subscription results in an invoice being generated on the 1st of March, the previous months usage period ended on the same date. A usage value should be added to the subscription with the appliesTill set to the invoices periodStart, the 1st of March.

\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the applies_till of this PricingComponentValue. + - :param applies_till: The applies_till of this PricingComponentValue. + :param applies_till: The applies_till of this PricingComponentValue. # noqa: E501 :type: datetime """ @@ -364,34 +363,51 @@ def applies_till(self, applies_till): @property def pending_change(self): - """ - Gets the pending_change of this PricingComponentValue. + """Gets the pending_change of this PricingComponentValue. # noqa: E501 - :return: The pending_change of this PricingComponentValue. + :return: The pending_change of this PricingComponentValue. # noqa: E501 :rtype: PendingComponentValueChange """ return self._pending_change @pending_change.setter def pending_change(self, pending_change): - """ - Sets the pending_change of this PricingComponentValue. + """Sets the pending_change of this PricingComponentValue. - :param pending_change: The pending_change of this PricingComponentValue. + :param pending_change: The pending_change of this PricingComponentValue. # noqa: E501 :type: PendingComponentValueChange """ self._pending_change = pending_change - def to_dict(self): + @property + def inferred_from_default(self): + """Gets the inferred_from_default of this PricingComponentValue. # noqa: E501 + + + :return: The inferred_from_default of this PricingComponentValue. # noqa: E501 + :rtype: bool """ - Returns the model properties as a dict + return self._inferred_from_default + + @inferred_from_default.setter + def inferred_from_default(self, inferred_from_default): + """Sets the inferred_from_default of this PricingComponentValue. + + + :param inferred_from_default: The inferred_from_default of this PricingComponentValue. # noqa: E501 + :type: bool """ + + self._inferred_from_default = inferred_from_default + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -408,29 +424,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(PricingComponentValue, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, PricingComponentValue): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/pricing_component_value_amendment.py b/billforward/models/pricing_component_value_amendment.py new file mode 100644 index 0000000..351996f --- /dev/null +++ b/billforward/models/pricing_component_value_amendment.py @@ -0,0 +1,175 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class PricingComponentValueAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'invoicing_type': 'str', + 'invoice_id': 'str', + 'component_changes': 'list[ComponentChange]' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'invoicing_type': 'invoicingType', + 'invoice_id': 'invoiceID', + 'component_changes': 'componentChanges' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, invoicing_type=None, invoice_id=None, component_changes=None, *args, **kwargs): # noqa: E501 + """PricingComponentValueAmendment - a model defined in Swagger""" # noqa: E501 + self._invoicing_type = None + self._invoice_id = None + self._component_changes = None + self.discriminator = None + self.invoicing_type = invoicing_type + if invoice_id is not None: + self.invoice_id = invoice_id + if component_changes is not None: + self.component_changes = component_changes + Amendment.__init__(self, *args, **kwargs) + + @property + def invoicing_type(self): + """Gets the invoicing_type of this PricingComponentValueAmendment. # noqa: E501 + + + :return: The invoicing_type of this PricingComponentValueAmendment. # noqa: E501 + :rtype: str + """ + return self._invoicing_type + + @invoicing_type.setter + def invoicing_type(self, invoicing_type): + """Sets the invoicing_type of this PricingComponentValueAmendment. + + + :param invoicing_type: The invoicing_type of this PricingComponentValueAmendment. # noqa: E501 + :type: str + """ + if invoicing_type is None: + raise ValueError("Invalid value for `invoicing_type`, must not be `None`") # noqa: E501 + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 + if invoicing_type not in allowed_values: + raise ValueError( + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 + .format(invoicing_type, allowed_values) + ) + + self._invoicing_type = invoicing_type + + @property + def invoice_id(self): + """Gets the invoice_id of this PricingComponentValueAmendment. # noqa: E501 + + + :return: The invoice_id of this PricingComponentValueAmendment. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this PricingComponentValueAmendment. + + + :param invoice_id: The invoice_id of this PricingComponentValueAmendment. # noqa: E501 + :type: str + """ + + self._invoice_id = invoice_id + + @property + def component_changes(self): + """Gets the component_changes of this PricingComponentValueAmendment. # noqa: E501 + + + :return: The component_changes of this PricingComponentValueAmendment. # noqa: E501 + :rtype: list[ComponentChange] + """ + return self._component_changes + + @component_changes.setter + def component_changes(self, component_changes): + """Sets the component_changes of this PricingComponentValueAmendment. + + + :param component_changes: The component_changes of this PricingComponentValueAmendment. # noqa: E501 + :type: list[ComponentChange] + """ + + self._component_changes = component_changes + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PricingComponentValueAmendment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PricingComponentValueAmendment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/pricing_component_value_change.py b/billforward/models/pricing_component_value_change.py new file mode 100644 index 0000000..162f50e --- /dev/null +++ b/billforward/models/pricing_component_value_change.py @@ -0,0 +1,518 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PricingComponentValueChange(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'id': 'str', + 'unit_of_measure_id': 'str', + 'subscription_id': 'str', + 'invoice_id': 'str', + 'organization_id': 'str', + 'new_value': 'int', + 'old_value': 'int', + 'mode': 'str', + 'state': 'str', + 'applied': 'datetime', + 'as_of': 'datetime', + 'discardable': 'bool', + 'as_of_date': 'datetime', + 'pricing_component_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'id': 'id', + 'unit_of_measure_id': 'unitOfMeasureID', + 'subscription_id': 'subscriptionID', + 'invoice_id': 'invoiceID', + 'organization_id': 'organizationID', + 'new_value': 'newValue', + 'old_value': 'oldValue', + 'mode': 'mode', + 'state': 'state', + 'applied': 'applied', + 'as_of': 'asOf', + 'discardable': 'discardable', + 'as_of_date': 'asOfDate', + 'pricing_component_id': 'pricingComponentID' + } + + def __init__(self, created=None, changed_by=None, id=None, unit_of_measure_id=None, subscription_id=None, invoice_id=None, organization_id=None, new_value=None, old_value=None, mode=None, state=None, applied=None, as_of=None, discardable=None, as_of_date=None, pricing_component_id=None): # noqa: E501 + """PricingComponentValueChange - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._id = None + self._unit_of_measure_id = None + self._subscription_id = None + self._invoice_id = None + self._organization_id = None + self._new_value = None + self._old_value = None + self._mode = None + self._state = None + self._applied = None + self._as_of = None + self._discardable = None + self._as_of_date = None + self._pricing_component_id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if id is not None: + self.id = id + if unit_of_measure_id is not None: + self.unit_of_measure_id = unit_of_measure_id + if subscription_id is not None: + self.subscription_id = subscription_id + if invoice_id is not None: + self.invoice_id = invoice_id + if organization_id is not None: + self.organization_id = organization_id + self.new_value = new_value + self.old_value = old_value + self.mode = mode + self.state = state + if applied is not None: + self.applied = applied + self.as_of = as_of + if discardable is not None: + self.discardable = discardable + if as_of_date is not None: + self.as_of_date = as_of_date + self.pricing_component_id = pricing_component_id + + @property + def created(self): + """Gets the created of this PricingComponentValueChange. # noqa: E501 + + + :return: The created of this PricingComponentValueChange. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this PricingComponentValueChange. + + + :param created: The created of this PricingComponentValueChange. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this PricingComponentValueChange. # noqa: E501 + + + :return: The changed_by of this PricingComponentValueChange. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this PricingComponentValueChange. + + + :param changed_by: The changed_by of this PricingComponentValueChange. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def id(self): + """Gets the id of this PricingComponentValueChange. # noqa: E501 + + + :return: The id of this PricingComponentValueChange. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this PricingComponentValueChange. + + + :param id: The id of this PricingComponentValueChange. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def unit_of_measure_id(self): + """Gets the unit_of_measure_id of this PricingComponentValueChange. # noqa: E501 + + + :return: The unit_of_measure_id of this PricingComponentValueChange. # noqa: E501 + :rtype: str + """ + return self._unit_of_measure_id + + @unit_of_measure_id.setter + def unit_of_measure_id(self, unit_of_measure_id): + """Sets the unit_of_measure_id of this PricingComponentValueChange. + + + :param unit_of_measure_id: The unit_of_measure_id of this PricingComponentValueChange. # noqa: E501 + :type: str + """ + + self._unit_of_measure_id = unit_of_measure_id + + @property + def subscription_id(self): + """Gets the subscription_id of this PricingComponentValueChange. # noqa: E501 + + + :return: The subscription_id of this PricingComponentValueChange. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this PricingComponentValueChange. + + + :param subscription_id: The subscription_id of this PricingComponentValueChange. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def invoice_id(self): + """Gets the invoice_id of this PricingComponentValueChange. # noqa: E501 + + + :return: The invoice_id of this PricingComponentValueChange. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this PricingComponentValueChange. + + + :param invoice_id: The invoice_id of this PricingComponentValueChange. # noqa: E501 + :type: str + """ + + self._invoice_id = invoice_id + + @property + def organization_id(self): + """Gets the organization_id of this PricingComponentValueChange. # noqa: E501 + + + :return: The organization_id of this PricingComponentValueChange. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this PricingComponentValueChange. + + + :param organization_id: The organization_id of this PricingComponentValueChange. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def new_value(self): + """Gets the new_value of this PricingComponentValueChange. # noqa: E501 + + + :return: The new_value of this PricingComponentValueChange. # noqa: E501 + :rtype: int + """ + return self._new_value + + @new_value.setter + def new_value(self, new_value): + """Sets the new_value of this PricingComponentValueChange. + + + :param new_value: The new_value of this PricingComponentValueChange. # noqa: E501 + :type: int + """ + if new_value is None: + raise ValueError("Invalid value for `new_value`, must not be `None`") # noqa: E501 + + self._new_value = new_value + + @property + def old_value(self): + """Gets the old_value of this PricingComponentValueChange. # noqa: E501 + + + :return: The old_value of this PricingComponentValueChange. # noqa: E501 + :rtype: int + """ + return self._old_value + + @old_value.setter + def old_value(self, old_value): + """Sets the old_value of this PricingComponentValueChange. + + + :param old_value: The old_value of this PricingComponentValueChange. # noqa: E501 + :type: int + """ + if old_value is None: + raise ValueError("Invalid value for `old_value`, must not be `None`") # noqa: E501 + + self._old_value = old_value + + @property + def mode(self): + """Gets the mode of this PricingComponentValueChange. # noqa: E501 + + + :return: The mode of this PricingComponentValueChange. # noqa: E501 + :rtype: str + """ + return self._mode + + @mode.setter + def mode(self, mode): + """Sets the mode of this PricingComponentValueChange. + + + :param mode: The mode of this PricingComponentValueChange. # noqa: E501 + :type: str + """ + if mode is None: + raise ValueError("Invalid value for `mode`, must not be `None`") # noqa: E501 + allowed_values = ["immediate", "delayed"] # noqa: E501 + if mode not in allowed_values: + raise ValueError( + "Invalid value for `mode` ({0}), must be one of {1}" # noqa: E501 + .format(mode, allowed_values) + ) + + self._mode = mode + + @property + def state(self): + """Gets the state of this PricingComponentValueChange. # noqa: E501 + + + :return: The state of this PricingComponentValueChange. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this PricingComponentValueChange. + + + :param state: The state of this PricingComponentValueChange. # noqa: E501 + :type: str + """ + if state is None: + raise ValueError("Invalid value for `state`, must not be `None`") # noqa: E501 + allowed_values = ["New", "Accepted", "Rejected", "ChargeCreated"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def applied(self): + """Gets the applied of this PricingComponentValueChange. # noqa: E501 + + + :return: The applied of this PricingComponentValueChange. # noqa: E501 + :rtype: datetime + """ + return self._applied + + @applied.setter + def applied(self, applied): + """Sets the applied of this PricingComponentValueChange. + + + :param applied: The applied of this PricingComponentValueChange. # noqa: E501 + :type: datetime + """ + + self._applied = applied + + @property + def as_of(self): + """Gets the as_of of this PricingComponentValueChange. # noqa: E501 + + + :return: The as_of of this PricingComponentValueChange. # noqa: E501 + :rtype: datetime + """ + return self._as_of + + @as_of.setter + def as_of(self, as_of): + """Sets the as_of of this PricingComponentValueChange. + + + :param as_of: The as_of of this PricingComponentValueChange. # noqa: E501 + :type: datetime + """ + if as_of is None: + raise ValueError("Invalid value for `as_of`, must not be `None`") # noqa: E501 + + self._as_of = as_of + + @property + def discardable(self): + """Gets the discardable of this PricingComponentValueChange. # noqa: E501 + + + :return: The discardable of this PricingComponentValueChange. # noqa: E501 + :rtype: bool + """ + return self._discardable + + @discardable.setter + def discardable(self, discardable): + """Sets the discardable of this PricingComponentValueChange. + + + :param discardable: The discardable of this PricingComponentValueChange. # noqa: E501 + :type: bool + """ + + self._discardable = discardable + + @property + def as_of_date(self): + """Gets the as_of_date of this PricingComponentValueChange. # noqa: E501 + + + :return: The as_of_date of this PricingComponentValueChange. # noqa: E501 + :rtype: datetime + """ + return self._as_of_date + + @as_of_date.setter + def as_of_date(self, as_of_date): + """Sets the as_of_date of this PricingComponentValueChange. + + + :param as_of_date: The as_of_date of this PricingComponentValueChange. # noqa: E501 + :type: datetime + """ + + self._as_of_date = as_of_date + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this PricingComponentValueChange. # noqa: E501 + + + :return: The pricing_component_id of this PricingComponentValueChange. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this PricingComponentValueChange. + + + :param pricing_component_id: The pricing_component_id of this PricingComponentValueChange. # noqa: E501 + :type: str + """ + if pricing_component_id is None: + raise ValueError("Invalid value for `pricing_component_id`, must not be `None`") # noqa: E501 + + self._pricing_component_id = pricing_component_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PricingComponentValueChange, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PricingComponentValueChange): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/pricing_component_value_change_amendment.py b/billforward/models/pricing_component_value_change_amendment.py deleted file mode 100644 index a83342b..0000000 --- a/billforward/models/pricing_component_value_change_amendment.py +++ /dev/null @@ -1,512 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PricingComponentValueChangeAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False, invoicing_type=None, invoice_id=None, component_changes=None): - """ - PricingComponentValueChangeAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool', - 'invoicing_type': 'str', - 'invoice_id': 'str', - 'component_changes': 'list[ComponentChange]' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted', - 'invoicing_type': 'invoicingType', - 'invoice_id': 'invoiceID', - 'component_changes': 'componentChanges' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - self._invoicing_type = invoicing_type - self._invoice_id = invoice_id - self._component_changes = component_changes - - @property - def created(self): - """ - Gets the created of this PricingComponentValueChangeAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this PricingComponentValueChangeAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this PricingComponentValueChangeAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this PricingComponentValueChangeAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this PricingComponentValueChangeAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this PricingComponentValueChangeAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this PricingComponentValueChangeAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this PricingComponentValueChangeAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this PricingComponentValueChangeAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this PricingComponentValueChangeAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this PricingComponentValueChangeAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this PricingComponentValueChangeAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this PricingComponentValueChangeAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this PricingComponentValueChangeAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this PricingComponentValueChangeAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this PricingComponentValueChangeAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def id(self): - """ - Gets the id of this PricingComponentValueChangeAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this PricingComponentValueChangeAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this PricingComponentValueChangeAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this PricingComponentValueChangeAmendment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this PricingComponentValueChangeAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this PricingComponentValueChangeAmendment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this PricingComponentValueChangeAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this PricingComponentValueChangeAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this PricingComponentValueChangeAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this PricingComponentValueChangeAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this PricingComponentValueChangeAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this PricingComponentValueChangeAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this PricingComponentValueChangeAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this PricingComponentValueChangeAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this PricingComponentValueChangeAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this PricingComponentValueChangeAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this PricingComponentValueChangeAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this PricingComponentValueChangeAmendment. - :rtype: datetime - """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this PricingComponentValueChangeAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actioning_time: The actioning_time of this PricingComponentValueChangeAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this PricingComponentValueChangeAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this PricingComponentValueChangeAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this PricingComponentValueChangeAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :param actioned_time: The actioned_time of this PricingComponentValueChangeAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this PricingComponentValueChangeAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this PricingComponentValueChangeAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this PricingComponentValueChangeAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this PricingComponentValueChangeAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this PricingComponentValueChangeAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this PricingComponentValueChangeAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this PricingComponentValueChangeAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this PricingComponentValueChangeAmendment. - :type: bool - """ - - self._deleted = deleted - - @property - def invoicing_type(self): - """ - Gets the invoicing_type of this PricingComponentValueChangeAmendment. - { \"description\" : \"Immediate generates an invoice straight away for any costs arising from this change, for example upgrade charge. Aggregated add any upgrade charges to the next invoice, generally this would be at the next period end.\", \"default\" : \"Aggregated\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The invoicing_type of this PricingComponentValueChangeAmendment. - :rtype: str - """ - return self._invoicing_type - - @invoicing_type.setter - def invoicing_type(self, invoicing_type): - """ - Sets the invoicing_type of this PricingComponentValueChangeAmendment. - { \"description\" : \"Immediate generates an invoice straight away for any costs arising from this change, for example upgrade charge. Aggregated add any upgrade charges to the next invoice, generally this would be at the next period end.\", \"default\" : \"Aggregated\", \"verbs\":[\"POST\",\"GET\"] } - - :param invoicing_type: The invoicing_type of this PricingComponentValueChangeAmendment. - :type: str - """ - allowed_values = ["Immediate", "Aggregated"] - if invoicing_type not in allowed_values: - raise ValueError( - "Invalid value for `invoicing_type` ({0}), must be one of {1}" - .format(invoicing_type, allowed_values) - ) - - self._invoicing_type = invoicing_type - - @property - def invoice_id(self): - """ - Gets the invoice_id of this PricingComponentValueChangeAmendment. - { \"description\" : \"Identifer of the invoice with the charges for this change.\", \"verbs\":[\"GET\"] } - - :return: The invoice_id of this PricingComponentValueChangeAmendment. - :rtype: str - """ - return self._invoice_id - - @invoice_id.setter - def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this PricingComponentValueChangeAmendment. - { \"description\" : \"Identifer of the invoice with the charges for this change.\", \"verbs\":[\"GET\"] } - - :param invoice_id: The invoice_id of this PricingComponentValueChangeAmendment. - :type: str - """ - - self._invoice_id = invoice_id - - @property - def component_changes(self): - """ - Gets the component_changes of this PricingComponentValueChangeAmendment. - { \"description\" : \"Changes to perform, for example upgrade\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The component_changes of this PricingComponentValueChangeAmendment. - :rtype: list[ComponentChange] - """ - return self._component_changes - - @component_changes.setter - def component_changes(self, component_changes): - """ - Sets the component_changes of this PricingComponentValueChangeAmendment. - { \"description\" : \"Changes to perform, for example upgrade\", \"verbs\":[\"POST\",\"GET\"] } - - :param component_changes: The component_changes of this PricingComponentValueChangeAmendment. - :type: list[ComponentChange] - """ - - self._component_changes = component_changes - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/pricing_component_value_change_paged_metadata.py b/billforward/models/pricing_component_value_change_paged_metadata.py deleted file mode 100644 index 8f49cbf..0000000 --- a/billforward/models/pricing_component_value_change_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PricingComponentValueChangePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - PricingComponentValueChangePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[InsertableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this PricingComponentValueChangePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this PricingComponentValueChangePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this PricingComponentValueChangePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this PricingComponentValueChangePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this PricingComponentValueChangePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this PricingComponentValueChangePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this PricingComponentValueChangePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this PricingComponentValueChangePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this PricingComponentValueChangePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this PricingComponentValueChangePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this PricingComponentValueChangePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this PricingComponentValueChangePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this PricingComponentValueChangePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this PricingComponentValueChangePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this PricingComponentValueChangePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this PricingComponentValueChangePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this PricingComponentValueChangePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this PricingComponentValueChangePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this PricingComponentValueChangePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this PricingComponentValueChangePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this PricingComponentValueChangePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this PricingComponentValueChangePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this PricingComponentValueChangePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this PricingComponentValueChangePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this PricingComponentValueChangePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this PricingComponentValueChangePagedMetadata. - :rtype: list[InsertableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this PricingComponentValueChangePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this PricingComponentValueChangePagedMetadata. - :type: list[InsertableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/pricing_component_value_migration_amendment_mapping.py b/billforward/models/pricing_component_value_migration_amendment_mapping.py index 91a5f80..9ed20b7 100644 --- a/billforward/models/pricing_component_value_migration_amendment_mapping.py +++ b/billforward/models/pricing_component_value_migration_amendment_mapping.py @@ -1,97 +1,102 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class PricingComponentValueMigrationAmendmentMapping(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, amendment_id=None, value=None, pricing_component_id=None, pricing_component_name=None, organization_id=None): - """ - PricingComponentValueMigrationAmendmentMapping - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'amendment_id': 'str', - 'value': 'int', - 'pricing_component_id': 'str', - 'pricing_component_name': 'str', - 'organization_id': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'amendment_id': 'amendmentID', - 'value': 'value', - 'pricing_component_id': 'pricingComponentID', - 'pricing_component_name': 'pricingComponentName', - 'organization_id': 'organizationID' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._amendment_id = amendment_id - self._value = value - self._pricing_component_id = pricing_component_id - self._pricing_component_name = pricing_component_name - self._organization_id = organization_id + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'amendment_id': 'str', + 'value': 'int', + 'pricing_component_name': 'str', + 'organization_id': 'str', + 'pricing_component_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'amendment_id': 'amendmentID', + 'value': 'value', + 'pricing_component_name': 'pricingComponentName', + 'organization_id': 'organizationID', + 'pricing_component_id': 'pricingComponentID' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, amendment_id=None, value=None, pricing_component_name=None, organization_id=None, pricing_component_id=None): # noqa: E501 + """PricingComponentValueMigrationAmendmentMapping - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._amendment_id = None + self._value = None + self._pricing_component_name = None + self._organization_id = None + self._pricing_component_id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if amendment_id is not None: + self.amendment_id = amendment_id + self.value = value + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if organization_id is not None: + self.organization_id = organization_id + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id @property def created(self): - """ - Gets the created of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 - :return: The created of this PricingComponentValueMigrationAmendmentMapping. + + :return: The created of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this PricingComponentValueMigrationAmendmentMapping. + - :param created: The created of this PricingComponentValueMigrationAmendmentMapping. + :param created: The created of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :type: datetime """ @@ -99,22 +104,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 + - :return: The changed_by of this PricingComponentValueMigrationAmendmentMapping. + :return: The changed_by of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this PricingComponentValueMigrationAmendmentMapping. - :param changed_by: The changed_by of this PricingComponentValueMigrationAmendmentMapping. + + :param changed_by: The changed_by of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :type: str """ @@ -122,22 +125,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 + - :return: The updated of this PricingComponentValueMigrationAmendmentMapping. + :return: The updated of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this PricingComponentValueMigrationAmendmentMapping. + - :param updated: The updated of this PricingComponentValueMigrationAmendmentMapping. + :param updated: The updated of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :type: datetime """ @@ -145,22 +146,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the id of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 - :return: The id of this PricingComponentValueMigrationAmendmentMapping. + + :return: The id of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the id of this PricingComponentValueMigrationAmendmentMapping. + - :param id: The id of this PricingComponentValueMigrationAmendmentMapping. + :param id: The id of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :type: str """ @@ -168,22 +167,20 @@ def id(self, id): @property def amendment_id(self): - """ - Gets the amendment_id of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the amendment_id of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 + - :return: The amendment_id of this PricingComponentValueMigrationAmendmentMapping. + :return: The amendment_id of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :rtype: str """ return self._amendment_id @amendment_id.setter def amendment_id(self, amendment_id): - """ - Sets the amendment_id of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the amendment_id of this PricingComponentValueMigrationAmendmentMapping. - :param amendment_id: The amendment_id of this PricingComponentValueMigrationAmendmentMapping. + + :param amendment_id: The amendment_id of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :type: str """ @@ -191,68 +188,43 @@ def amendment_id(self, amendment_id): @property def value(self): - """ - Gets the value of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"Units purchased for pricing-component\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the value of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 + - :return: The value of this PricingComponentValueMigrationAmendmentMapping. + :return: The value of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :rtype: int """ return self._value @value.setter def value(self, value): - """ - Sets the value of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"Units purchased for pricing-component\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the value of this PricingComponentValueMigrationAmendmentMapping. + - :param value: The value of this PricingComponentValueMigrationAmendmentMapping. + :param value: The value of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :type: int """ + if value is None: + raise ValueError("Invalid value for `value`, must not be `None`") # noqa: E501 self._value = value - @property - def pricing_component_id(self): - """ - Gets the pricing_component_id of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"Identifier for pricing-component in new the new rate-plan\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The pricing_component_id of this PricingComponentValueMigrationAmendmentMapping. - :rtype: str - """ - return self._pricing_component_id - - @pricing_component_id.setter - def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"Identifier for pricing-component in new the new rate-plan\", \"verbs\":[\"POST\",\"GET\"] } - - :param pricing_component_id: The pricing_component_id of this PricingComponentValueMigrationAmendmentMapping. - :type: str - """ - - self._pricing_component_id = pricing_component_id - @property def pricing_component_name(self): - """ - Gets the pricing_component_name of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"Name of the pricing component. (Must be provided if pricingComponentID is empty)\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the pricing_component_name of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 + - :return: The pricing_component_name of this PricingComponentValueMigrationAmendmentMapping. + :return: The pricing_component_name of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :rtype: str """ return self._pricing_component_name @pricing_component_name.setter def pricing_component_name(self, pricing_component_name): - """ - Sets the pricing_component_name of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"Name of the pricing component. (Must be provided if pricingComponentID is empty)\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the pricing_component_name of this PricingComponentValueMigrationAmendmentMapping. + - :param pricing_component_name: The pricing_component_name of this PricingComponentValueMigrationAmendmentMapping. + :param pricing_component_name: The pricing_component_name of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :type: str """ @@ -260,34 +232,51 @@ def pricing_component_name(self, pricing_component_name): @property def organization_id(self): - """ - Gets the organization_id of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"\", \"verbs\":[] } + """Gets the organization_id of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 - :return: The organization_id of this PricingComponentValueMigrationAmendmentMapping. + + :return: The organization_id of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this PricingComponentValueMigrationAmendmentMapping. - { \"description\" : \"\", \"verbs\":[] } + """Sets the organization_id of this PricingComponentValueMigrationAmendmentMapping. + - :param organization_id: The organization_id of this PricingComponentValueMigrationAmendmentMapping. + :param organization_id: The organization_id of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 :type: str """ self._organization_id = organization_id - def to_dict(self): + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 + + + :return: The pricing_component_id of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this PricingComponentValueMigrationAmendmentMapping. + + + :param pricing_component_id: The pricing_component_id of this PricingComponentValueMigrationAmendmentMapping. # noqa: E501 + :type: str """ + + self._pricing_component_id = pricing_component_id + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -304,29 +293,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(PricingComponentValueMigrationAmendmentMapping, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, PricingComponentValueMigrationAmendmentMapping): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/pricing_component_value_paged_metadata.py b/billforward/models/pricing_component_value_paged_metadata.py deleted file mode 100644 index 0cb8ee8..0000000 --- a/billforward/models/pricing_component_value_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PricingComponentValuePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - PricingComponentValuePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[PricingComponentValue]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this PricingComponentValuePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this PricingComponentValuePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this PricingComponentValuePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this PricingComponentValuePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this PricingComponentValuePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this PricingComponentValuePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this PricingComponentValuePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this PricingComponentValuePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this PricingComponentValuePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this PricingComponentValuePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this PricingComponentValuePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this PricingComponentValuePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this PricingComponentValuePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this PricingComponentValuePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this PricingComponentValuePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this PricingComponentValuePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this PricingComponentValuePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this PricingComponentValuePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this PricingComponentValuePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this PricingComponentValuePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this PricingComponentValuePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this PricingComponentValuePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this PricingComponentValuePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this PricingComponentValuePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this PricingComponentValuePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this PricingComponentValuePagedMetadata. - :rtype: list[PricingComponentValue] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this PricingComponentValuePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this PricingComponentValuePagedMetadata. - :type: list[PricingComponentValue] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/pricing_component_value_request.py b/billforward/models/pricing_component_value_request.py index 7d16aa7..476544b 100644 --- a/billforward/models/pricing_component_value_request.py +++ b/billforward/models/pricing_component_value_request.py @@ -1,85 +1,92 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class PricingComponentValueRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, value=None, change_mode=None, invoicing_type=None, no_charge=False): - """ - PricingComponentValueRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'value': 'int', - 'change_mode': 'str', - 'invoicing_type': 'str', - 'no_charge': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'value': 'value', - 'change_mode': 'changeMode', - 'invoicing_type': 'invoicingType', - 'no_charge': 'noCharge' - } - - self._created = created - self._value = value - self._change_mode = change_mode - self._invoicing_type = invoicing_type - self._no_charge = no_charge + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'value': 'int', + 'organization_id': 'str', + 'change_mode': 'str', + 'prorate': 'bool', + 'invoicing_type': 'str', + 'no_charge': 'bool' + } + + attribute_map = { + 'created': 'created', + 'value': 'value', + 'organization_id': 'organizationID', + 'change_mode': 'changeMode', + 'prorate': 'prorate', + 'invoicing_type': 'invoicingType', + 'no_charge': 'noCharge' + } + + def __init__(self, created=None, value=None, organization_id=None, change_mode=None, prorate=None, invoicing_type=None, no_charge=None): # noqa: E501 + """PricingComponentValueRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._value = None + self._organization_id = None + self._change_mode = None + self._prorate = None + self._invoicing_type = None + self._no_charge = None + self.discriminator = None + if created is not None: + self.created = created + self.value = value + if organization_id is not None: + self.organization_id = organization_id + if change_mode is not None: + self.change_mode = change_mode + if prorate is not None: + self.prorate = prorate + if invoicing_type is not None: + self.invoicing_type = invoicing_type + if no_charge is not None: + self.no_charge = no_charge @property def created(self): - """ - Gets the created of this PricingComponentValueRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this PricingComponentValueRequest. # noqa: E501 + - :return: The created of this PricingComponentValueRequest. + :return: The created of this PricingComponentValueRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this PricingComponentValueRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this PricingComponentValueRequest. + - :param created: The created of this PricingComponentValueRequest. + :param created: The created of this PricingComponentValueRequest. # noqa: E501 :type: datetime """ @@ -87,80 +94,118 @@ def created(self, created): @property def value(self): - """ - Gets the value of this PricingComponentValueRequest. - {\"default\":\"\",\"description\":\"Modifies the current value used to calculate the recurring costs of the subscription. This can effectively be thought of as an upsert.Note: altering costs on invoices are made be editing charges.
Setup Pricing — Value changed if initial invoice has not been issued.
In-Advance/Subscription Pricing — Value changed and a charge added. If the change is delayed the current value on the subscription will show the delayed change.
Arrears Pricing — Value updated, and a pro-rated charge added to the subscription if required.
Usage Pricing — Usage created or updated for the current billing cycle.which is generated naturally — i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the value of this PricingComponentValueRequest. # noqa: E501 - :return: The value of this PricingComponentValueRequest. + + :return: The value of this PricingComponentValueRequest. # noqa: E501 :rtype: int """ return self._value @value.setter def value(self, value): - """ - Sets the value of this PricingComponentValueRequest. - {\"default\":\"\",\"description\":\"Modifies the current value used to calculate the recurring costs of the subscription. This can effectively be thought of as an upsert.Note: altering costs on invoices are made be editing charges.
Setup Pricing — Value changed if initial invoice has not been issued.
In-Advance/Subscription Pricing — Value changed and a charge added. If the change is delayed the current value on the subscription will show the delayed change.
Arrears Pricing — Value updated, and a pro-rated charge added to the subscription if required.
Usage Pricing — Usage created or updated for the current billing cycle.which is generated naturally — i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the value of this PricingComponentValueRequest. - :param value: The value of this PricingComponentValueRequest. + + :param value: The value of this PricingComponentValueRequest. # noqa: E501 :type: int """ + if value is None: + raise ValueError("Invalid value for `value`, must not be `None`") # noqa: E501 self._value = value @property - def change_mode(self): + def organization_id(self): + """Gets the organization_id of this PricingComponentValueRequest. # noqa: E501 + + + :return: The organization_id of this PricingComponentValueRequest. # noqa: E501 + :rtype: str """ - Gets the change_mode of this PricingComponentValueRequest. - {\"default\":\"as on pricing component\",\"description\":\"Default behaviour when a value is changed by default the change mode from the pricing component is used.
immediate — Change will apply at the time the request is made.
delayed — Change will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this PricingComponentValueRequest. + - :return: The change_mode of this PricingComponentValueRequest. + :param organization_id: The organization_id of this PricingComponentValueRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def change_mode(self): + """Gets the change_mode of this PricingComponentValueRequest. # noqa: E501 + + + :return: The change_mode of this PricingComponentValueRequest. # noqa: E501 :rtype: str """ return self._change_mode @change_mode.setter def change_mode(self, change_mode): - """ - Sets the change_mode of this PricingComponentValueRequest. - {\"default\":\"as on pricing component\",\"description\":\"Default behaviour when a value is changed by default the change mode from the pricing component is used.
immediate — Change will apply at the time the request is made.
delayed — Change will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the change_mode of this PricingComponentValueRequest. - :param change_mode: The change_mode of this PricingComponentValueRequest. + + :param change_mode: The change_mode of this PricingComponentValueRequest. # noqa: E501 :type: str """ - allowed_values = ["immediate", "delayed"] + allowed_values = ["immediate", "delayed"] # noqa: E501 if change_mode not in allowed_values: raise ValueError( - "Invalid value for `change_mode` ({0}), must be one of {1}" + "Invalid value for `change_mode` ({0}), must be one of {1}" # noqa: E501 .format(change_mode, allowed_values) ) self._change_mode = change_mode @property - def invoicing_type(self): + def prorate(self): + """Gets the prorate of this PricingComponentValueRequest. # noqa: E501 + + + :return: The prorate of this PricingComponentValueRequest. # noqa: E501 + :rtype: bool + """ + return self._prorate + + @prorate.setter + def prorate(self, prorate): + """Sets the prorate of this PricingComponentValueRequest. + + + :param prorate: The prorate of this PricingComponentValueRequest. # noqa: E501 + :type: bool """ - Gets the invoicing_type of this PricingComponentValueRequest. - {\"default\":\"Aggregated\",\"description\":\"If the change results in a charge should it be invoiced straight away or on the next invoice.
Immediate — If the change has a cost associated with it , for example a pro-rated upgrade charge, an invoice will be raised at the time the request is made. If the invoice fails to be paid the upgrade will fail and the invoice will be voided. No credit or refund is issued for immediate downgrades.
Aggregated — If the change has a cost associated with it , for example a pro-rated upgrade charge, the charge will be added to the next invoice raised for this subscription. As no payment is required when the change is request the change always succeeds.\",\"verbs\":[\"POST\",\"GET\"]} - :return: The invoicing_type of this PricingComponentValueRequest. + self._prorate = prorate + + @property + def invoicing_type(self): + """Gets the invoicing_type of this PricingComponentValueRequest. # noqa: E501 + + + :return: The invoicing_type of this PricingComponentValueRequest. # noqa: E501 :rtype: str """ return self._invoicing_type @invoicing_type.setter def invoicing_type(self, invoicing_type): - """ - Sets the invoicing_type of this PricingComponentValueRequest. - {\"default\":\"Aggregated\",\"description\":\"If the change results in a charge should it be invoiced straight away or on the next invoice.
Immediate — If the change has a cost associated with it , for example a pro-rated upgrade charge, an invoice will be raised at the time the request is made. If the invoice fails to be paid the upgrade will fail and the invoice will be voided. No credit or refund is issued for immediate downgrades.
Aggregated — If the change has a cost associated with it , for example a pro-rated upgrade charge, the charge will be added to the next invoice raised for this subscription. As no payment is required when the change is request the change always succeeds.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the invoicing_type of this PricingComponentValueRequest. + - :param invoicing_type: The invoicing_type of this PricingComponentValueRequest. + :param invoicing_type: The invoicing_type of this PricingComponentValueRequest. # noqa: E501 :type: str """ - allowed_values = ["Immediate", "Aggregated"] + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 if invoicing_type not in allowed_values: raise ValueError( - "Invalid value for `invoicing_type` ({0}), must be one of {1}" + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 .format(invoicing_type, allowed_values) ) @@ -168,34 +213,30 @@ def invoicing_type(self, invoicing_type): @property def no_charge(self): - """ - Gets the no_charge of this PricingComponentValueRequest. - {\"default\":\"false\",\"description\":\"If specified the change will have no cost associated with it. This is useful for immediately changing a value without creating any upgrade charge.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the no_charge of this PricingComponentValueRequest. # noqa: E501 - :return: The no_charge of this PricingComponentValueRequest. + + :return: The no_charge of this PricingComponentValueRequest. # noqa: E501 :rtype: bool """ return self._no_charge @no_charge.setter def no_charge(self, no_charge): - """ - Sets the no_charge of this PricingComponentValueRequest. - {\"default\":\"false\",\"description\":\"If specified the change will have no cost associated with it. This is useful for immediately changing a value without creating any upgrade charge.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the no_charge of this PricingComponentValueRequest. - :param no_charge: The no_charge of this PricingComponentValueRequest. + + :param no_charge: The no_charge of this PricingComponentValueRequest. # noqa: E501 :type: bool """ self._no_charge = no_charge def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -212,29 +253,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(PricingComponentValueRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, PricingComponentValueRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/pricing_component_value_response.py b/billforward/models/pricing_component_value_response.py new file mode 100644 index 0000000..aa8d51e --- /dev/null +++ b/billforward/models/pricing_component_value_response.py @@ -0,0 +1,590 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PricingComponentValueResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'state': 'str', + 'existing_value': 'int', + 'new_value': 'int', + 'type': 'str', + 'pricing_component_id': 'str', + 'pricing_component_name': 'str', + 'pricing_component_public_name': 'str', + 'organization_id': 'str', + 'invoice_id': 'str', + 'subscription_id': 'str', + 'cost': 'float', + 'credit': 'float', + 'discount': 'float', + 'currency': 'CreditNoteCurrency', + 'new_value_active': 'datetime', + 'charge_id': 'str', + 'amendment_id': 'str', + 'coupon_charge_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'state': 'state', + 'existing_value': 'existingValue', + 'new_value': 'newValue', + 'type': 'type', + 'pricing_component_id': 'pricingComponentID', + 'pricing_component_name': 'pricingComponentName', + 'pricing_component_public_name': 'pricingComponentPublicName', + 'organization_id': 'organizationID', + 'invoice_id': 'invoiceID', + 'subscription_id': 'subscriptionID', + 'cost': 'cost', + 'credit': 'credit', + 'discount': 'discount', + 'currency': 'currency', + 'new_value_active': 'newValueActive', + 'charge_id': 'chargeID', + 'amendment_id': 'amendmentID', + 'coupon_charge_id': 'couponChargeID' + } + + def __init__(self, created=None, state=None, existing_value=None, new_value=None, type=None, pricing_component_id=None, pricing_component_name=None, pricing_component_public_name=None, organization_id=None, invoice_id=None, subscription_id=None, cost=None, credit=None, discount=None, currency=None, new_value_active=None, charge_id=None, amendment_id=None, coupon_charge_id=None): # noqa: E501 + """PricingComponentValueResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._state = None + self._existing_value = None + self._new_value = None + self._type = None + self._pricing_component_id = None + self._pricing_component_name = None + self._pricing_component_public_name = None + self._organization_id = None + self._invoice_id = None + self._subscription_id = None + self._cost = None + self._credit = None + self._discount = None + self._currency = None + self._new_value_active = None + self._charge_id = None + self._amendment_id = None + self._coupon_charge_id = None + self.discriminator = None + if created is not None: + self.created = created + if state is not None: + self.state = state + if existing_value is not None: + self.existing_value = existing_value + if new_value is not None: + self.new_value = new_value + if type is not None: + self.type = type + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if pricing_component_public_name is not None: + self.pricing_component_public_name = pricing_component_public_name + if organization_id is not None: + self.organization_id = organization_id + if invoice_id is not None: + self.invoice_id = invoice_id + if subscription_id is not None: + self.subscription_id = subscription_id + if cost is not None: + self.cost = cost + if credit is not None: + self.credit = credit + if discount is not None: + self.discount = discount + if currency is not None: + self.currency = currency + if new_value_active is not None: + self.new_value_active = new_value_active + if charge_id is not None: + self.charge_id = charge_id + if amendment_id is not None: + self.amendment_id = amendment_id + if coupon_charge_id is not None: + self.coupon_charge_id = coupon_charge_id + + @property + def created(self): + """Gets the created of this PricingComponentValueResponse. # noqa: E501 + + + :return: The created of this PricingComponentValueResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this PricingComponentValueResponse. + + + :param created: The created of this PricingComponentValueResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def state(self): + """Gets the state of this PricingComponentValueResponse. # noqa: E501 + + + :return: The state of this PricingComponentValueResponse. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this PricingComponentValueResponse. + + + :param state: The state of this PricingComponentValueResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Success", "Failed"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def existing_value(self): + """Gets the existing_value of this PricingComponentValueResponse. # noqa: E501 + + + :return: The existing_value of this PricingComponentValueResponse. # noqa: E501 + :rtype: int + """ + return self._existing_value + + @existing_value.setter + def existing_value(self, existing_value): + """Sets the existing_value of this PricingComponentValueResponse. + + + :param existing_value: The existing_value of this PricingComponentValueResponse. # noqa: E501 + :type: int + """ + + self._existing_value = existing_value + + @property + def new_value(self): + """Gets the new_value of this PricingComponentValueResponse. # noqa: E501 + + + :return: The new_value of this PricingComponentValueResponse. # noqa: E501 + :rtype: int + """ + return self._new_value + + @new_value.setter + def new_value(self, new_value): + """Sets the new_value of this PricingComponentValueResponse. + + + :param new_value: The new_value of this PricingComponentValueResponse. # noqa: E501 + :type: int + """ + + self._new_value = new_value + + @property + def type(self): + """Gets the type of this PricingComponentValueResponse. # noqa: E501 + + + :return: The type of this PricingComponentValueResponse. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this PricingComponentValueResponse. + + + :param type: The type of this PricingComponentValueResponse. # noqa: E501 + :type: str + """ + allowed_values = ["Initial", "Upgrade", "Downgrade"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this PricingComponentValueResponse. # noqa: E501 + + + :return: The pricing_component_id of this PricingComponentValueResponse. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this PricingComponentValueResponse. + + + :param pricing_component_id: The pricing_component_id of this PricingComponentValueResponse. # noqa: E501 + :type: str + """ + + self._pricing_component_id = pricing_component_id + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this PricingComponentValueResponse. # noqa: E501 + + + :return: The pricing_component_name of this PricingComponentValueResponse. # noqa: E501 + :rtype: str + """ + return self._pricing_component_name + + @pricing_component_name.setter + def pricing_component_name(self, pricing_component_name): + """Sets the pricing_component_name of this PricingComponentValueResponse. + + + :param pricing_component_name: The pricing_component_name of this PricingComponentValueResponse. # noqa: E501 + :type: str + """ + + self._pricing_component_name = pricing_component_name + + @property + def pricing_component_public_name(self): + """Gets the pricing_component_public_name of this PricingComponentValueResponse. # noqa: E501 + + + :return: The pricing_component_public_name of this PricingComponentValueResponse. # noqa: E501 + :rtype: str + """ + return self._pricing_component_public_name + + @pricing_component_public_name.setter + def pricing_component_public_name(self, pricing_component_public_name): + """Sets the pricing_component_public_name of this PricingComponentValueResponse. + + + :param pricing_component_public_name: The pricing_component_public_name of this PricingComponentValueResponse. # noqa: E501 + :type: str + """ + + self._pricing_component_public_name = pricing_component_public_name + + @property + def organization_id(self): + """Gets the organization_id of this PricingComponentValueResponse. # noqa: E501 + + + :return: The organization_id of this PricingComponentValueResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this PricingComponentValueResponse. + + + :param organization_id: The organization_id of this PricingComponentValueResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def invoice_id(self): + """Gets the invoice_id of this PricingComponentValueResponse. # noqa: E501 + + + :return: The invoice_id of this PricingComponentValueResponse. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this PricingComponentValueResponse. + + + :param invoice_id: The invoice_id of this PricingComponentValueResponse. # noqa: E501 + :type: str + """ + + self._invoice_id = invoice_id + + @property + def subscription_id(self): + """Gets the subscription_id of this PricingComponentValueResponse. # noqa: E501 + + + :return: The subscription_id of this PricingComponentValueResponse. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this PricingComponentValueResponse. + + + :param subscription_id: The subscription_id of this PricingComponentValueResponse. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def cost(self): + """Gets the cost of this PricingComponentValueResponse. # noqa: E501 + + + :return: The cost of this PricingComponentValueResponse. # noqa: E501 + :rtype: float + """ + return self._cost + + @cost.setter + def cost(self, cost): + """Sets the cost of this PricingComponentValueResponse. + + + :param cost: The cost of this PricingComponentValueResponse. # noqa: E501 + :type: float + """ + + self._cost = cost + + @property + def credit(self): + """Gets the credit of this PricingComponentValueResponse. # noqa: E501 + + + :return: The credit of this PricingComponentValueResponse. # noqa: E501 + :rtype: float + """ + return self._credit + + @credit.setter + def credit(self, credit): + """Sets the credit of this PricingComponentValueResponse. + + + :param credit: The credit of this PricingComponentValueResponse. # noqa: E501 + :type: float + """ + + self._credit = credit + + @property + def discount(self): + """Gets the discount of this PricingComponentValueResponse. # noqa: E501 + + + :return: The discount of this PricingComponentValueResponse. # noqa: E501 + :rtype: float + """ + return self._discount + + @discount.setter + def discount(self, discount): + """Sets the discount of this PricingComponentValueResponse. + + + :param discount: The discount of this PricingComponentValueResponse. # noqa: E501 + :type: float + """ + + self._discount = discount + + @property + def currency(self): + """Gets the currency of this PricingComponentValueResponse. # noqa: E501 + + + :return: The currency of this PricingComponentValueResponse. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this PricingComponentValueResponse. + + + :param currency: The currency of this PricingComponentValueResponse. # noqa: E501 + :type: CreditNoteCurrency + """ + + self._currency = currency + + @property + def new_value_active(self): + """Gets the new_value_active of this PricingComponentValueResponse. # noqa: E501 + + + :return: The new_value_active of this PricingComponentValueResponse. # noqa: E501 + :rtype: datetime + """ + return self._new_value_active + + @new_value_active.setter + def new_value_active(self, new_value_active): + """Sets the new_value_active of this PricingComponentValueResponse. + + + :param new_value_active: The new_value_active of this PricingComponentValueResponse. # noqa: E501 + :type: datetime + """ + + self._new_value_active = new_value_active + + @property + def charge_id(self): + """Gets the charge_id of this PricingComponentValueResponse. # noqa: E501 + + + :return: The charge_id of this PricingComponentValueResponse. # noqa: E501 + :rtype: str + """ + return self._charge_id + + @charge_id.setter + def charge_id(self, charge_id): + """Sets the charge_id of this PricingComponentValueResponse. + + + :param charge_id: The charge_id of this PricingComponentValueResponse. # noqa: E501 + :type: str + """ + + self._charge_id = charge_id + + @property + def amendment_id(self): + """Gets the amendment_id of this PricingComponentValueResponse. # noqa: E501 + + + :return: The amendment_id of this PricingComponentValueResponse. # noqa: E501 + :rtype: str + """ + return self._amendment_id + + @amendment_id.setter + def amendment_id(self, amendment_id): + """Sets the amendment_id of this PricingComponentValueResponse. + + + :param amendment_id: The amendment_id of this PricingComponentValueResponse. # noqa: E501 + :type: str + """ + + self._amendment_id = amendment_id + + @property + def coupon_charge_id(self): + """Gets the coupon_charge_id of this PricingComponentValueResponse. # noqa: E501 + + + :return: The coupon_charge_id of this PricingComponentValueResponse. # noqa: E501 + :rtype: str + """ + return self._coupon_charge_id + + @coupon_charge_id.setter + def coupon_charge_id(self, coupon_charge_id): + """Sets the coupon_charge_id of this PricingComponentValueResponse. + + + :param coupon_charge_id: The coupon_charge_id of this PricingComponentValueResponse. # noqa: E501 + :type: str + """ + + self._coupon_charge_id = coupon_charge_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PricingComponentValueResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PricingComponentValueResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/pricing_component_value_response_paged_metadata.py b/billforward/models/pricing_component_value_response_paged_metadata.py deleted file mode 100644 index 2a29913..0000000 --- a/billforward/models/pricing_component_value_response_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class PricingComponentValueResponsePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - PricingComponentValueResponsePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this PricingComponentValueResponsePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this PricingComponentValueResponsePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this PricingComponentValueResponsePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this PricingComponentValueResponsePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this PricingComponentValueResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this PricingComponentValueResponsePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this PricingComponentValueResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this PricingComponentValueResponsePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this PricingComponentValueResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this PricingComponentValueResponsePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this PricingComponentValueResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this PricingComponentValueResponsePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this PricingComponentValueResponsePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this PricingComponentValueResponsePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this PricingComponentValueResponsePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this PricingComponentValueResponsePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this PricingComponentValueResponsePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this PricingComponentValueResponsePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this PricingComponentValueResponsePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this PricingComponentValueResponsePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this PricingComponentValueResponsePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this PricingComponentValueResponsePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this PricingComponentValueResponsePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this PricingComponentValueResponsePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this PricingComponentValueResponsePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this PricingComponentValueResponsePagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this PricingComponentValueResponsePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this PricingComponentValueResponsePagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/pricing_components_by_charge_type.py b/billforward/models/pricing_components_by_charge_type.py new file mode 100644 index 0000000..a275a03 --- /dev/null +++ b/billforward/models/pricing_components_by_charge_type.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PricingComponentsByChargeType(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'setup': 'SetupPricingComponentsByChargeModel', + 'advance': 'AdvancePricingComponentsByChargeModel', + 'arrears': 'ArrearsPricingComponentsByChargeModel', + 'usage': 'UsagePricingComponentsByChargeModel', + 'aggregation': 'PlanAggregation' + } + + attribute_map = { + 'setup': 'setup', + 'advance': 'advance', + 'arrears': 'arrears', + 'usage': 'usage', + 'aggregation': 'aggregation' + } + + def __init__(self, setup=None, advance=None, arrears=None, usage=None, aggregation=None): # noqa: E501 + """PricingComponentsByChargeType - a model defined in Swagger""" # noqa: E501 + self._setup = None + self._advance = None + self._arrears = None + self._usage = None + self._aggregation = None + self.discriminator = None + if setup is not None: + self.setup = setup + if advance is not None: + self.advance = advance + if arrears is not None: + self.arrears = arrears + if usage is not None: + self.usage = usage + if aggregation is not None: + self.aggregation = aggregation + + @property + def setup(self): + """Gets the setup of this PricingComponentsByChargeType. # noqa: E501 + + + :return: The setup of this PricingComponentsByChargeType. # noqa: E501 + :rtype: SetupPricingComponentsByChargeModel + """ + return self._setup + + @setup.setter + def setup(self, setup): + """Sets the setup of this PricingComponentsByChargeType. + + + :param setup: The setup of this PricingComponentsByChargeType. # noqa: E501 + :type: SetupPricingComponentsByChargeModel + """ + + self._setup = setup + + @property + def advance(self): + """Gets the advance of this PricingComponentsByChargeType. # noqa: E501 + + + :return: The advance of this PricingComponentsByChargeType. # noqa: E501 + :rtype: AdvancePricingComponentsByChargeModel + """ + return self._advance + + @advance.setter + def advance(self, advance): + """Sets the advance of this PricingComponentsByChargeType. + + + :param advance: The advance of this PricingComponentsByChargeType. # noqa: E501 + :type: AdvancePricingComponentsByChargeModel + """ + + self._advance = advance + + @property + def arrears(self): + """Gets the arrears of this PricingComponentsByChargeType. # noqa: E501 + + + :return: The arrears of this PricingComponentsByChargeType. # noqa: E501 + :rtype: ArrearsPricingComponentsByChargeModel + """ + return self._arrears + + @arrears.setter + def arrears(self, arrears): + """Sets the arrears of this PricingComponentsByChargeType. + + + :param arrears: The arrears of this PricingComponentsByChargeType. # noqa: E501 + :type: ArrearsPricingComponentsByChargeModel + """ + + self._arrears = arrears + + @property + def usage(self): + """Gets the usage of this PricingComponentsByChargeType. # noqa: E501 + + + :return: The usage of this PricingComponentsByChargeType. # noqa: E501 + :rtype: UsagePricingComponentsByChargeModel + """ + return self._usage + + @usage.setter + def usage(self, usage): + """Sets the usage of this PricingComponentsByChargeType. + + + :param usage: The usage of this PricingComponentsByChargeType. # noqa: E501 + :type: UsagePricingComponentsByChargeModel + """ + + self._usage = usage + + @property + def aggregation(self): + """Gets the aggregation of this PricingComponentsByChargeType. # noqa: E501 + + + :return: The aggregation of this PricingComponentsByChargeType. # noqa: E501 + :rtype: PlanAggregation + """ + return self._aggregation + + @aggregation.setter + def aggregation(self, aggregation): + """Sets the aggregation of this PricingComponentsByChargeType. + + + :param aggregation: The aggregation of this PricingComponentsByChargeType. # noqa: E501 + :type: PlanAggregation + """ + + self._aggregation = aggregation + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PricingComponentsByChargeType, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PricingComponentsByChargeType): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/pricing_tier.py b/billforward/models/pricing_tier.py new file mode 100644 index 0000000..b468f0f --- /dev/null +++ b/billforward/models/pricing_tier.py @@ -0,0 +1,220 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PricingTier(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + '_from': 'int', + 'to': 'int', + 'price': 'float', + 'bucket_size': 'int', + 'type': 'str' + } + + attribute_map = { + '_from': 'from', + 'to': 'to', + 'price': 'price', + 'bucket_size': 'bucketSize', + 'type': 'type' + } + + def __init__(self, _from=None, to=None, price=None, bucket_size=None, type=None): # noqa: E501 + """PricingTier - a model defined in Swagger""" # noqa: E501 + self.__from = None + self._to = None + self._price = None + self._bucket_size = None + self._type = None + self.discriminator = None + if _from is not None: + self._from = _from + if to is not None: + self.to = to + if price is not None: + self.price = price + if bucket_size is not None: + self.bucket_size = bucket_size + if type is not None: + self.type = type + + @property + def _from(self): + """Gets the _from of this PricingTier. # noqa: E501 + + + :return: The _from of this PricingTier. # noqa: E501 + :rtype: int + """ + return self.__from + + @_from.setter + def _from(self, _from): + """Sets the _from of this PricingTier. + + + :param _from: The _from of this PricingTier. # noqa: E501 + :type: int + """ + + self.__from = _from + + @property + def to(self): + """Gets the to of this PricingTier. # noqa: E501 + + + :return: The to of this PricingTier. # noqa: E501 + :rtype: int + """ + return self._to + + @to.setter + def to(self, to): + """Sets the to of this PricingTier. + + + :param to: The to of this PricingTier. # noqa: E501 + :type: int + """ + + self._to = to + + @property + def price(self): + """Gets the price of this PricingTier. # noqa: E501 + + + :return: The price of this PricingTier. # noqa: E501 + :rtype: float + """ + return self._price + + @price.setter + def price(self, price): + """Sets the price of this PricingTier. + + + :param price: The price of this PricingTier. # noqa: E501 + :type: float + """ + + self._price = price + + @property + def bucket_size(self): + """Gets the bucket_size of this PricingTier. # noqa: E501 + + + :return: The bucket_size of this PricingTier. # noqa: E501 + :rtype: int + """ + return self._bucket_size + + @bucket_size.setter + def bucket_size(self, bucket_size): + """Sets the bucket_size of this PricingTier. + + + :param bucket_size: The bucket_size of this PricingTier. # noqa: E501 + :type: int + """ + + self._bucket_size = bucket_size + + @property + def type(self): + """Gets the type of this PricingTier. # noqa: E501 + + + :return: The type of this PricingTier. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this PricingTier. + + + :param type: The type of this PricingTier. # noqa: E501 + :type: str + """ + allowed_values = ["unit", "fixed", "bucket"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PricingTier, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PricingTier): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/product.py b/billforward/models/product.py deleted file mode 100644 index 0de212a..0000000 --- a/billforward/models/product.py +++ /dev/null @@ -1,584 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class Product(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, crm_id=None, account_id=None, name=None, public_name=None, description=None, duration=None, duration_period=None, metadata=None, trial=None, trial_period=None, product_type=None, deleted=False, start_date=None, payment_terms=None): - """ - Product - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'crm_id': 'str', - 'account_id': 'str', - 'name': 'str', - 'public_name': 'str', - 'description': 'str', - 'duration': 'int', - 'duration_period': 'str', - 'metadata': 'DynamicMetadata', - 'trial': 'int', - 'trial_period': 'str', - 'product_type': 'str', - 'deleted': 'bool', - 'start_date': 'datetime', - 'payment_terms': 'int' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'crm_id': 'crmID', - 'account_id': 'accountID', - 'name': 'name', - 'public_name': 'publicName', - 'description': 'description', - 'duration': 'duration', - 'duration_period': 'durationPeriod', - 'metadata': 'metadata', - 'trial': 'trial', - 'trial_period': 'trialPeriod', - 'product_type': 'productType', - 'deleted': 'deleted', - 'start_date': 'startDate', - 'payment_terms': 'paymentTerms' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._crm_id = crm_id - self._account_id = account_id - self._name = name - self._public_name = public_name - self._description = description - self._duration = duration - self._duration_period = duration_period - self._metadata = metadata - self._trial = trial - self._trial_period = trial_period - self._product_type = product_type - self._deleted = deleted - self._start_date = start_date - self._payment_terms = payment_terms - - @property - def created(self): - """ - Gets the created of this Product. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this Product. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this Product. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this Product. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this Product. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this Product. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this Product. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this Product. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this Product. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this Product. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this Product. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this Product. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this Product. - {\"description\":\"ID uniquely identifying this product.\",\"verbs\":[\"GET\"]} - - :return: The id of this Product. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this Product. - {\"description\":\"ID uniquely identifying this product.\",\"verbs\":[\"GET\"]} - - :param id: The id of this Product. - :type: str - """ - - self._id = id - - @property - def crm_id(self): - """ - Gets the crm_id of this Product. - {\"description\":\"Customer-relationship-management ID of the product.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The crm_id of this Product. - :rtype: str - """ - return self._crm_id - - @crm_id.setter - def crm_id(self, crm_id): - """ - Sets the crm_id of this Product. - {\"description\":\"Customer-relationship-management ID of the product.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param crm_id: The crm_id of this Product. - :type: str - """ - - self._crm_id = crm_id - - @property - def account_id(self): - """ - Gets the account_id of this Product. - {\"description\":\"\",\"verbs\":[]} - - :return: The account_id of this Product. - :rtype: str - """ - return self._account_id - - @account_id.setter - def account_id(self, account_id): - """ - Sets the account_id of this Product. - {\"description\":\"\",\"verbs\":[]} - - :param account_id: The account_id of this Product. - :type: str - """ - - self._account_id = account_id - - @property - def name(self): - """ - Gets the name of this Product. - {\"description\":\"A unique name — for your benefit — used to identify this product within BillForward. It should reflect the fact that this product confers some service to a customer (e.g. \\\"Gold membership\\\").
The product can also be defined by the frequency with which it recurs (e.g. \\\"Monthly Gold membership\\\").
Remember also that rate plans can override the timing prescribed by their product. If you intend to override that timing, you may consider the product's period duration to be an unimportant factor when it comes to naming it.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The name of this Product. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this Product. - {\"description\":\"A unique name — for your benefit — used to identify this product within BillForward. It should reflect the fact that this product confers some service to a customer (e.g. \\\"Gold membership\\\").
The product can also be defined by the frequency with which it recurs (e.g. \\\"Monthly Gold membership\\\").
Remember also that rate plans can override the timing prescribed by their product. If you intend to override that timing, you may consider the product's period duration to be an unimportant factor when it comes to naming it.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param name: The name of this Product. - :type: str - """ - - self._name = name - - @property - def public_name(self): - """ - Gets the public_name of this Product. - {\"description\":\"A friendly non-unique name used to identify this product\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The public_name of this Product. - :rtype: str - """ - return self._public_name - - @public_name.setter - def public_name(self, public_name): - """ - Sets the public_name of this Product. - {\"description\":\"A friendly non-unique name used to identify this product\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param public_name: The public_name of this Product. - :type: str - """ - - self._public_name = public_name - - @property - def description(self): - """ - Gets the description of this Product. - {\"description\":\"A description — for your benefit — of the product. For example: you could explain what service this product entitles a customer to.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The description of this Product. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this Product. - {\"description\":\"A description — for your benefit — of the product. For example: you could explain what service this product entitles a customer to.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param description: The description of this Product. - :type: str - """ - - self._description = description - - @property - def duration(self): - """ - Gets the duration of this Product. - {\"description\":\"Number of length-measures which constitute the product's period.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The duration of this Product. - :rtype: int - """ - return self._duration - - @duration.setter - def duration(self, duration): - """ - Sets the duration of this Product. - {\"description\":\"Number of length-measures which constitute the product's period.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param duration: The duration of this Product. - :type: int - """ - - self._duration = duration - - @property - def duration_period(self): - """ - Gets the duration_period of this Product. - {\"description\":\"Measure describing the magnitude of the product's period.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The duration_period of this Product. - :rtype: str - """ - return self._duration_period - - @duration_period.setter - def duration_period(self, duration_period): - """ - Sets the duration_period of this Product. - {\"description\":\"Measure describing the magnitude of the product's period.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param duration_period: The duration_period of this Product. - :type: str - """ - allowed_values = ["minutes", "days", "months", "years"] - if duration_period not in allowed_values: - raise ValueError( - "Invalid value for `duration_period` ({0}), must be one of {1}" - .format(duration_period, allowed_values) - ) - - self._duration_period = duration_period - - @property - def metadata(self): - """ - Gets the metadata of this Product. - - - :return: The metadata of this Product. - :rtype: DynamicMetadata - """ - return self._metadata - - @metadata.setter - def metadata(self, metadata): - """ - Sets the metadata of this Product. - - - :param metadata: The metadata of this Product. - :type: DynamicMetadata - """ - - self._metadata = metadata - - @property - def trial(self): - """ - Gets the trial of this Product. - {\"default\":0,\"description\":\"Number of trial-length-measures which constitute the product's trial period\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The trial of this Product. - :rtype: int - """ - return self._trial - - @trial.setter - def trial(self, trial): - """ - Sets the trial of this Product. - {\"default\":0,\"description\":\"Number of trial-length-measures which constitute the product's trial period\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param trial: The trial of this Product. - :type: int - """ - - self._trial = trial - - @property - def trial_period(self): - """ - Gets the trial_period of this Product. - {\"default\":\"none\",\"description\":\"Measure describing the magnitude of the product's trial period.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The trial_period of this Product. - :rtype: str - """ - return self._trial_period - - @trial_period.setter - def trial_period(self, trial_period): - """ - Sets the trial_period of this Product. - {\"default\":\"none\",\"description\":\"Measure describing the magnitude of the product's trial period.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param trial_period: The trial_period of this Product. - :type: str - """ - allowed_values = ["none", "minutes", "days", "months"] - if trial_period not in allowed_values: - raise ValueError( - "Invalid value for `trial_period` ({0}), must be one of {1}" - .format(trial_period, allowed_values) - ) - - self._trial_period = trial_period - - @property - def product_type(self): - """ - Gets the product_type of this Product. - {\"default\":\"recurring\",\"description\":\"The frequency of the product — either recurring or non-recurring.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_type of this Product. - :rtype: str - """ - return self._product_type - - @product_type.setter - def product_type(self, product_type): - """ - Sets the product_type of this Product. - {\"default\":\"recurring\",\"description\":\"The frequency of the product — either recurring or non-recurring.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_type: The product_type of this Product. - :type: str - """ - allowed_values = ["nonrecurring", "recurring"] - if product_type not in allowed_values: - raise ValueError( - "Invalid value for `product_type` ({0}), must be one of {1}" - .format(product_type, allowed_values) - ) - - self._product_type = product_type - - @property - def deleted(self): - """ - Gets the deleted of this Product. - {\"description\":\"\",\"verbs\":[\"GET\"]} - - :return: The deleted of this Product. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this Product. - {\"description\":\"\",\"verbs\":[\"GET\"]} - - :param deleted: The deleted of this Product. - :type: bool - """ - - self._deleted = deleted - - @property - def start_date(self): - """ - Gets the start_date of this Product. - {\"description\":\"\",\"verbs\":[]} - - :return: The start_date of this Product. - :rtype: datetime - """ - return self._start_date - - @start_date.setter - def start_date(self, start_date): - """ - Sets the start_date of this Product. - {\"description\":\"\",\"verbs\":[]} - - :param start_date: The start_date of this Product. - :type: datetime - """ - - self._start_date = start_date - - @property - def payment_terms(self): - """ - Gets the payment_terms of this Product. - - - :return: The payment_terms of this Product. - :rtype: int - """ - return self._payment_terms - - @payment_terms.setter - def payment_terms(self, payment_terms): - """ - Sets the payment_terms of this Product. - - - :param payment_terms: The payment_terms of this Product. - :type: int - """ - - self._payment_terms = payment_terms - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/product_coupon_modifier.py b/billforward/models/product_coupon_modifier.py deleted file mode 100644 index e3ea6f6..0000000 --- a/billforward/models/product_coupon_modifier.py +++ /dev/null @@ -1,506 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class ProductCouponModifier(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, coupon_definition_id=None, effect_amount=None, operand=None, effect=None, effect_additional=False, specifier_amount=None, domain=None, specifier=None, precedence=None, deleted=False): - """ - ProductCouponModifier - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'coupon_definition_id': 'str', - 'effect_amount': 'float', - 'operand': 'str', - 'effect': 'str', - 'effect_additional': 'bool', - 'specifier_amount': 'int', - 'domain': 'str', - 'specifier': 'str', - 'precedence': 'int', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'coupon_definition_id': 'couponDefinitionID', - 'effect_amount': 'effectAmount', - 'operand': 'operand', - 'effect': 'effect', - 'effect_additional': 'effectAdditional', - 'specifier_amount': 'specifierAmount', - 'domain': 'domain', - 'specifier': 'specifier', - 'precedence': 'precedence', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._coupon_definition_id = coupon_definition_id - self._effect_amount = effect_amount - self._operand = operand - self._effect = effect - self._effect_additional = effect_additional - self._specifier_amount = specifier_amount - self._domain = domain - self._specifier = specifier - self._precedence = precedence - self._deleted = deleted - - @property - def created(self): - """ - Gets the created of this ProductCouponModifier. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this ProductCouponModifier. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this ProductCouponModifier. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this ProductCouponModifier. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this ProductCouponModifier. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this ProductCouponModifier. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this ProductCouponModifier. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this ProductCouponModifier. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this ProductCouponModifier. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this ProductCouponModifier. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this ProductCouponModifier. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this ProductCouponModifier. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this ProductCouponModifier. - { \"description\" : \"ID of the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this ProductCouponModifier. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ProductCouponModifier. - { \"description\" : \"ID of the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this ProductCouponModifier. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this ProductCouponModifier. - { \"description\" : \"ID of the organization associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this ProductCouponModifier. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this ProductCouponModifier. - { \"description\" : \"ID of the organization associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this ProductCouponModifier. - :type: str - """ - - self._organization_id = organization_id - - @property - def coupon_definition_id(self): - """ - Gets the coupon_definition_id of this ProductCouponModifier. - { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The coupon_definition_id of this ProductCouponModifier. - :rtype: str - """ - return self._coupon_definition_id - - @coupon_definition_id.setter - def coupon_definition_id(self, coupon_definition_id): - """ - Sets the coupon_definition_id of this ProductCouponModifier. - { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param coupon_definition_id: The coupon_definition_id of this ProductCouponModifier. - :type: str - """ - - self._coupon_definition_id = coupon_definition_id - - @property - def effect_amount(self): - """ - Gets the effect_amount of this ProductCouponModifier. - { \"description\" : \"The effect amount for the coupon-modifier. This is affected by the operand field.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The effect_amount of this ProductCouponModifier. - :rtype: float - """ - return self._effect_amount - - @effect_amount.setter - def effect_amount(self, effect_amount): - """ - Sets the effect_amount of this ProductCouponModifier. - { \"description\" : \"The effect amount for the coupon-modifier. This is affected by the operand field.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param effect_amount: The effect_amount of this ProductCouponModifier. - :type: float - """ - - self._effect_amount = effect_amount - - @property - def operand(self): - """ - Gets the operand of this ProductCouponModifier. - { \"description\" : \"The operand field affects the effect amount of the coupon-modifier. If the operand is fixed, it is an exact amount of the currency defined by the coupon-definition. If the operand is percent, this means the coupon will be affecting a percentage of the unaltered cost. E.g. a 25% modifier will apply a 25% discount on a subscription or a pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The operand of this ProductCouponModifier. - :rtype: str - """ - return self._operand - - @operand.setter - def operand(self, operand): - """ - Sets the operand of this ProductCouponModifier. - { \"description\" : \"The operand field affects the effect amount of the coupon-modifier. If the operand is fixed, it is an exact amount of the currency defined by the coupon-definition. If the operand is percent, this means the coupon will be affecting a percentage of the unaltered cost. E.g. a 25% modifier will apply a 25% discount on a subscription or a pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param operand: The operand of this ProductCouponModifier. - :type: str - """ - allowed_values = ["fixed", "percent", "instance_fixed", "instance_percent"] - if operand not in allowed_values: - raise ValueError( - "Invalid value for `operand` ({0}), must be one of {1}" - .format(operand, allowed_values) - ) - - self._operand = operand - - @property - def effect(self): - """ - Gets the effect of this ProductCouponModifier. - { \"description\" : \"The effect of the coupon-modifier. The coupon-modifier can affect first, last, and cheapest value of a specific unit-of-measure-id for a subscription. The coupon-modifier can also affect all of the values for a unit-of-measure-id, or can affect all of the subscription cost.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The effect of this ProductCouponModifier. - :rtype: str - """ - return self._effect - - @effect.setter - def effect(self, effect): - """ - Sets the effect of this ProductCouponModifier. - { \"description\" : \"The effect of the coupon-modifier. The coupon-modifier can affect first, last, and cheapest value of a specific unit-of-measure-id for a subscription. The coupon-modifier can also affect all of the values for a unit-of-measure-id, or can affect all of the subscription cost.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param effect: The effect of this ProductCouponModifier. - :type: str - """ - allowed_values = ["discount_first_units", "discount_last_units", "discount_cheapest_units", "discount_all"] - if effect not in allowed_values: - raise ValueError( - "Invalid value for `effect` ({0}), must be one of {1}" - .format(effect, allowed_values) - ) - - self._effect = effect - - @property - def effect_additional(self): - """ - Gets the effect_additional of this ProductCouponModifier. - { \"description\" : \"Specifies whether the coupon-modifier will be affecting only additional units. If this field is set, the coupon-instance-existing-values for the coupon-instance are observed, and any units of the unit-of-measure-id defined by the modifier below the coupon-instance-existing-values for that unit-of-measure-id will be ignored.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The effect_additional of this ProductCouponModifier. - :rtype: bool - """ - return self._effect_additional - - @effect_additional.setter - def effect_additional(self, effect_additional): - """ - Sets the effect_additional of this ProductCouponModifier. - { \"description\" : \"Specifies whether the coupon-modifier will be affecting only additional units. If this field is set, the coupon-instance-existing-values for the coupon-instance are observed, and any units of the unit-of-measure-id defined by the modifier below the coupon-instance-existing-values for that unit-of-measure-id will be ignored.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param effect_additional: The effect_additional of this ProductCouponModifier. - :type: bool - """ - - self._effect_additional = effect_additional - - @property - def specifier_amount(self): - """ - Gets the specifier_amount of this ProductCouponModifier. - { \"description\" : \"The number of units that will be affected by the coupon-modifier, if the domain is set to uom\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The specifier_amount of this ProductCouponModifier. - :rtype: int - """ - return self._specifier_amount - - @specifier_amount.setter - def specifier_amount(self, specifier_amount): - """ - Sets the specifier_amount of this ProductCouponModifier. - { \"description\" : \"The number of units that will be affected by the coupon-modifier, if the domain is set to uom\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param specifier_amount: The specifier_amount of this ProductCouponModifier. - :type: int - """ - - self._specifier_amount = specifier_amount - - @property - def domain(self): - """ - Gets the domain of this ProductCouponModifier. - { \"description\" : \"The domain of the coupon-modifier\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The domain of this ProductCouponModifier. - :rtype: str - """ - return self._domain - - @domain.setter - def domain(self, domain): - """ - Sets the domain of this ProductCouponModifier. - { \"description\" : \"The domain of the coupon-modifier\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param domain: The domain of this ProductCouponModifier. - :type: str - """ - allowed_values = ["product", "uom", "PricingComponent"] - if domain not in allowed_values: - raise ValueError( - "Invalid value for `domain` ({0}), must be one of {1}" - .format(domain, allowed_values) - ) - - self._domain = domain - - @property - def specifier(self): - """ - Gets the specifier of this ProductCouponModifier. - { \"description\" : \"The specifier is domain-specific. If the domain is uom, this field is used to limit the coupon-modifier to a specific unit-of-measure-id.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The specifier of this ProductCouponModifier. - :rtype: str - """ - return self._specifier - - @specifier.setter - def specifier(self, specifier): - """ - Sets the specifier of this ProductCouponModifier. - { \"description\" : \"The specifier is domain-specific. If the domain is uom, this field is used to limit the coupon-modifier to a specific unit-of-measure-id.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param specifier: The specifier of this ProductCouponModifier. - :type: str - """ - - self._specifier = specifier - - @property - def precedence(self): - """ - Gets the precedence of this ProductCouponModifier. - { \"description\" : \"The precedence of the coupon-modifier. This is used to order application of coupon-modifiers. Higher precedence means the coupon-modifier will be applied before others.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The precedence of this ProductCouponModifier. - :rtype: int - """ - return self._precedence - - @precedence.setter - def precedence(self, precedence): - """ - Sets the precedence of this ProductCouponModifier. - { \"description\" : \"The precedence of the coupon-modifier. This is used to order application of coupon-modifiers. Higher precedence means the coupon-modifier will be applied before others.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param precedence: The precedence of this ProductCouponModifier. - :type: int - """ - - self._precedence = precedence - - @property - def deleted(self): - """ - Gets the deleted of this ProductCouponModifier. - { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The deleted of this ProductCouponModifier. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this ProductCouponModifier. - { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param deleted: The deleted of this ProductCouponModifier. - :type: bool - """ - - self._deleted = deleted - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/product_paged_metadata.py b/billforward/models/product_paged_metadata.py deleted file mode 100644 index e389737..0000000 --- a/billforward/models/product_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class ProductPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - ProductPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Product]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this ProductPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this ProductPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this ProductPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this ProductPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this ProductPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this ProductPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this ProductPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this ProductPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this ProductPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this ProductPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this ProductPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this ProductPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this ProductPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this ProductPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this ProductPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this ProductPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this ProductPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this ProductPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this ProductPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this ProductPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this ProductPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this ProductPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this ProductPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this ProductPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this ProductPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this ProductPagedMetadata. - :rtype: list[Product] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this ProductPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this ProductPagedMetadata. - :type: list[Product] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/product_payments_result_paged_metadata.py b/billforward/models/product_payments_result_paged_metadata.py deleted file mode 100644 index a53f6e3..0000000 --- a/billforward/models/product_payments_result_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class ProductPaymentsResultPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - ProductPaymentsResultPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this ProductPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this ProductPaymentsResultPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this ProductPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this ProductPaymentsResultPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this ProductPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this ProductPaymentsResultPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this ProductPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this ProductPaymentsResultPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this ProductPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this ProductPaymentsResultPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this ProductPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this ProductPaymentsResultPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this ProductPaymentsResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this ProductPaymentsResultPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this ProductPaymentsResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this ProductPaymentsResultPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this ProductPaymentsResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this ProductPaymentsResultPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this ProductPaymentsResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this ProductPaymentsResultPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this ProductPaymentsResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this ProductPaymentsResultPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this ProductPaymentsResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this ProductPaymentsResultPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this ProductPaymentsResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this ProductPaymentsResultPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this ProductPaymentsResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this ProductPaymentsResultPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/product_rate_plan.py b/billforward/models/product_rate_plan.py deleted file mode 100644 index f62aed1..0000000 --- a/billforward/models/product_rate_plan.py +++ /dev/null @@ -1,984 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class ProductRatePlan(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, metadata=None, id=None, crm_id=None, product_id=None, currency=None, tax_status=None, failed_payment_behaviour=None, duration=None, duration_period=None, trial=None, trial_period=None, product_type=None, pro_rata_mode=None, create_zero_valued_invoices=False, name=None, public_name=None, valid_from=None, valid_till=None, status=None, migration_behaviour=None, invoice_issue_type=None, issue_duration=None, issue_period=None, taxation=None, fixed_term_definitions=None, product=None, pricing_components=None, aggregating_components=None, payment_terms=None): - """ - ProductRatePlan - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'metadata': 'DynamicMetadata', - 'id': 'str', - 'crm_id': 'str', - 'product_id': 'str', - 'currency': 'str', - 'tax_status': 'str', - 'failed_payment_behaviour': 'str', - 'duration': 'int', - 'duration_period': 'str', - 'trial': 'int', - 'trial_period': 'str', - 'product_type': 'str', - 'pro_rata_mode': 'str', - 'create_zero_valued_invoices': 'bool', - 'name': 'str', - 'public_name': 'str', - 'valid_from': 'datetime', - 'valid_till': 'datetime', - 'status': 'str', - 'migration_behaviour': 'str', - 'invoice_issue_type': 'str', - 'issue_duration': 'int', - 'issue_period': 'str', - 'taxation': 'list[MutableBillingEntity]', - 'fixed_term_definitions': 'list[MutableBillingEntity]', - 'product': 'Product', - 'pricing_components': 'list[PricingComponent]', - 'aggregating_components': 'list[AggregatingComponent]', - 'payment_terms': 'int' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'metadata': 'metadata', - 'id': 'id', - 'crm_id': 'crmID', - 'product_id': 'productID', - 'currency': 'currency', - 'tax_status': 'taxStatus', - 'failed_payment_behaviour': 'failedPaymentBehaviour', - 'duration': 'duration', - 'duration_period': 'durationPeriod', - 'trial': 'trial', - 'trial_period': 'trialPeriod', - 'product_type': 'productType', - 'pro_rata_mode': 'proRataMode', - 'create_zero_valued_invoices': 'createZeroValuedInvoices', - 'name': 'name', - 'public_name': 'publicName', - 'valid_from': 'validFrom', - 'valid_till': 'validTill', - 'status': 'status', - 'migration_behaviour': 'migrationBehaviour', - 'invoice_issue_type': 'invoiceIssueType', - 'issue_duration': 'issueDuration', - 'issue_period': 'issuePeriod', - 'taxation': 'taxation', - 'fixed_term_definitions': 'fixedTermDefinitions', - 'product': 'product', - 'pricing_components': 'pricingComponents', - 'aggregating_components': 'aggregatingComponents', - 'payment_terms': 'paymentTerms' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._metadata = metadata - self._id = id - self._crm_id = crm_id - self._product_id = product_id - self._currency = currency - self._tax_status = tax_status - self._failed_payment_behaviour = failed_payment_behaviour - self._duration = duration - self._duration_period = duration_period - self._trial = trial - self._trial_period = trial_period - self._product_type = product_type - self._pro_rata_mode = pro_rata_mode - self._create_zero_valued_invoices = create_zero_valued_invoices - self._name = name - self._public_name = public_name - self._valid_from = valid_from - self._valid_till = valid_till - self._status = status - self._migration_behaviour = migration_behaviour - self._invoice_issue_type = invoice_issue_type - self._issue_duration = issue_duration - self._issue_period = issue_period - self._taxation = taxation - self._fixed_term_definitions = fixed_term_definitions - self._product = product - self._pricing_components = pricing_components - self._aggregating_components = aggregating_components - self._payment_terms = payment_terms - - @property - def created(self): - """ - Gets the created of this ProductRatePlan. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this ProductRatePlan. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this ProductRatePlan. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this ProductRatePlan. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this ProductRatePlan. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this ProductRatePlan. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this ProductRatePlan. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this ProductRatePlan. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this ProductRatePlan. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this ProductRatePlan. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this ProductRatePlan. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this ProductRatePlan. - :type: datetime - """ - - self._updated = updated - - @property - def metadata(self): - """ - Gets the metadata of this ProductRatePlan. - { \"description\" : \"Add metadata.\", \"verbs\":[\"POST\"] } - - :return: The metadata of this ProductRatePlan. - :rtype: DynamicMetadata - """ - return self._metadata - - @metadata.setter - def metadata(self, metadata): - """ - Sets the metadata of this ProductRatePlan. - { \"description\" : \"Add metadata.\", \"verbs\":[\"POST\"] } - - :param metadata: The metadata of this ProductRatePlan. - :type: DynamicMetadata - """ - - self._metadata = metadata - - @property - def id(self): - """ - Gets the id of this ProductRatePlan. - {\"description\":\"ID uniquely identifying this rate plan.\",\"verbs\":[\"GET\"]} - - :return: The id of this ProductRatePlan. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ProductRatePlan. - {\"description\":\"ID uniquely identifying this rate plan.\",\"verbs\":[\"GET\"]} - - :param id: The id of this ProductRatePlan. - :type: str - """ - - self._id = id - - @property - def crm_id(self): - """ - Gets the crm_id of this ProductRatePlan. - {\"description\":\"Customer-relationship-management ID of the rate plan.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The crm_id of this ProductRatePlan. - :rtype: str - """ - return self._crm_id - - @crm_id.setter - def crm_id(self, crm_id): - """ - Sets the crm_id of this ProductRatePlan. - {\"description\":\"Customer-relationship-management ID of the rate plan.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param crm_id: The crm_id of this ProductRatePlan. - :type: str - """ - - self._crm_id = crm_id - - @property - def product_id(self): - """ - Gets the product_id of this ProductRatePlan. - {\"description\":\"ID of the product to which this rate plan belongs. A product is essentially a collection of rate plans, and describes the service conferred to a customer upon subscription to any of said product's rate plans. The product serves also as a template from which its rate plans can infer default attributes.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The product_id of this ProductRatePlan. - :rtype: str - """ - return self._product_id - - @product_id.setter - def product_id(self, product_id): - """ - Sets the product_id of this ProductRatePlan. - {\"description\":\"ID of the product to which this rate plan belongs. A product is essentially a collection of rate plans, and describes the service conferred to a customer upon subscription to any of said product's rate plans. The product serves also as a template from which its rate plans can infer default attributes.\",\"verbs\":[\"POST\",\"GET\"]} - - :param product_id: The product_id of this ProductRatePlan. - :type: str - """ - - self._product_id = product_id - - @property - def currency(self): - """ - Gets the currency of this ProductRatePlan. - {\"description\":\"The currency of the product-rate-plan — as specified by a three-character ISO 4217 currency code (i.e. USD).\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The currency of this ProductRatePlan. - :rtype: str - """ - return self._currency - - @currency.setter - def currency(self, currency): - """ - Sets the currency of this ProductRatePlan. - {\"description\":\"The currency of the product-rate-plan — as specified by a three-character ISO 4217 currency code (i.e. USD).\",\"verbs\":[\"POST\",\"GET\"]} - - :param currency: The currency of this ProductRatePlan. - :type: str - """ - - self._currency = currency - - @property - def tax_status(self): - """ - Gets the tax_status of this ProductRatePlan. - {\"default\":\"inclusive\",\"description\":\"The tax status of the product-rate-plan — either inclusive or exclusive.
exclusivepricing indicates that the cost of the Pricing Components do not include tax; when BillForward generates an Invoice, the tax will be calculated with this price as a base.
Tax-inclusivepricing indicates that the Pricing components include Tax. BillForward will still calculate tax on each invoice. Tax will be calculated from the sales price.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The tax_status of this ProductRatePlan. - :rtype: str - """ - return self._tax_status - - @tax_status.setter - def tax_status(self, tax_status): - """ - Sets the tax_status of this ProductRatePlan. - {\"default\":\"inclusive\",\"description\":\"The tax status of the product-rate-plan — either inclusive or exclusive.
exclusivepricing indicates that the cost of the Pricing Components do not include tax; when BillForward generates an Invoice, the tax will be calculated with this price as a base.
Tax-inclusivepricing indicates that the Pricing components include Tax. BillForward will still calculate tax on each invoice. Tax will be calculated from the sales price.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param tax_status: The tax_status of this ProductRatePlan. - :type: str - """ - allowed_values = ["inclusive", "exclusive"] - if tax_status not in allowed_values: - raise ValueError( - "Invalid value for `tax_status` ({0}), must be one of {1}" - .format(tax_status, allowed_values) - ) - - self._tax_status = tax_status - - @property - def failed_payment_behaviour(self): - """ - Gets the failed_payment_behaviour of this ProductRatePlan. - {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.
CancelSubscription — Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.
None — The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles — or when manual invoice remediation is common — None is recommended.
In a heavily-automated SaaS environment, automatic cancellation via CancelSubscription is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The failed_payment_behaviour of this ProductRatePlan. - :rtype: str - """ - return self._failed_payment_behaviour - - @failed_payment_behaviour.setter - def failed_payment_behaviour(self, failed_payment_behaviour): - """ - Sets the failed_payment_behaviour of this ProductRatePlan. - {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.
CancelSubscription — Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.
None — The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles — or when manual invoice remediation is common — None is recommended.
In a heavily-automated SaaS environment, automatic cancellation via CancelSubscription is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param failed_payment_behaviour: The failed_payment_behaviour of this ProductRatePlan. - :type: str - """ - allowed_values = ["CancelSubscription", "None"] - if failed_payment_behaviour not in allowed_values: - raise ValueError( - "Invalid value for `failed_payment_behaviour` ({0}), must be one of {1}" - .format(failed_payment_behaviour, allowed_values) - ) - - self._failed_payment_behaviour = failed_payment_behaviour - - @property - def duration(self): - """ - Gets the duration of this ProductRatePlan. - {\"description\":\"Number of length-measures which constitute the rate plan's period. If left unspecified: the rate plan will use the same `duration` number as the Product to which it belongs.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The duration of this ProductRatePlan. - :rtype: int - """ - return self._duration - - @duration.setter - def duration(self, duration): - """ - Sets the duration of this ProductRatePlan. - {\"description\":\"Number of length-measures which constitute the rate plan's period. If left unspecified: the rate plan will use the same `duration` number as the Product to which it belongs.\",\"verbs\":[\"POST\",\"GET\"]} - - :param duration: The duration of this ProductRatePlan. - :type: int - """ - - self._duration = duration - - @property - def duration_period(self): - """ - Gets the duration_period of this ProductRatePlan. - {\"description\":\"Measure describing the magnitude of the rate plan's period. If left unspecified: the rate plan will use the same `durationPeriod` magnitude as the Product to which it belongs.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The duration_period of this ProductRatePlan. - :rtype: str - """ - return self._duration_period - - @duration_period.setter - def duration_period(self, duration_period): - """ - Sets the duration_period of this ProductRatePlan. - {\"description\":\"Measure describing the magnitude of the rate plan's period. If left unspecified: the rate plan will use the same `durationPeriod` magnitude as the Product to which it belongs.\",\"verbs\":[\"POST\",\"GET\"]} - - :param duration_period: The duration_period of this ProductRatePlan. - :type: str - """ - allowed_values = ["minutes", "days", "months", "years"] - if duration_period not in allowed_values: - raise ValueError( - "Invalid value for `duration_period` ({0}), must be one of {1}" - .format(duration_period, allowed_values) - ) - - self._duration_period = duration_period - - @property - def trial(self): - """ - Gets the trial of this ProductRatePlan. - {\"default\":0,\"description\":\"Number of trial-length-measures which constitute the rate plan's trial period. If left unspecified: the rate plan will use the same `trial` number as the Product to which it belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The trial of this ProductRatePlan. - :rtype: int - """ - return self._trial - - @trial.setter - def trial(self, trial): - """ - Sets the trial of this ProductRatePlan. - {\"default\":0,\"description\":\"Number of trial-length-measures which constitute the rate plan's trial period. If left unspecified: the rate plan will use the same `trial` number as the Product to which it belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param trial: The trial of this ProductRatePlan. - :type: int - """ - - self._trial = trial - - @property - def trial_period(self): - """ - Gets the trial_period of this ProductRatePlan. - {\"default\":\"none\",\"description\":\"Measure describing the magnitude of the rate plan's trial period. If left unspecified: the rate plan will use the same `trialPeriod` magnitude as the Product to which it belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The trial_period of this ProductRatePlan. - :rtype: str - """ - return self._trial_period - - @trial_period.setter - def trial_period(self, trial_period): - """ - Sets the trial_period of this ProductRatePlan. - {\"default\":\"none\",\"description\":\"Measure describing the magnitude of the rate plan's trial period. If left unspecified: the rate plan will use the same `trialPeriod` magnitude as the Product to which it belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param trial_period: The trial_period of this ProductRatePlan. - :type: str - """ - allowed_values = ["none", "minutes", "days", "months"] - if trial_period not in allowed_values: - raise ValueError( - "Invalid value for `trial_period` ({0}), must be one of {1}" - .format(trial_period, allowed_values) - ) - - self._trial_period = trial_period - - @property - def product_type(self): - """ - Gets the product_type of this ProductRatePlan. - {\"default\":\"recurring\",\"description\":\"The frequency of the rate plan — either recurring or non-recurring. If left unspecified: the rate plan will use the same `productType` frequency as the Product to which it belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_type of this ProductRatePlan. - :rtype: str - """ - return self._product_type - - @product_type.setter - def product_type(self, product_type): - """ - Sets the product_type of this ProductRatePlan. - {\"default\":\"recurring\",\"description\":\"The frequency of the rate plan — either recurring or non-recurring. If left unspecified: the rate plan will use the same `productType` frequency as the Product to which it belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_type: The product_type of this ProductRatePlan. - :type: str - """ - allowed_values = ["nonrecurring", "recurring"] - if product_type not in allowed_values: - raise ValueError( - "Invalid value for `product_type` ({0}), must be one of {1}" - .format(product_type, allowed_values) - ) - - self._product_type = product_type - - @property - def pro_rata_mode(self): - """ - Gets the pro_rata_mode of this ProductRatePlan. - {\"default\":\"WithCoupon\",\"description\":\"The pro-rata mode for the rate plan.
None — The pro-rata cost for upgrades will be ignored.
WithCoupon — The pro-rata cost for upgrades will be calculated based on the time remaining for the subscription. Discounts from any attached coupons will be deducted from the pro-rated cost.
WithoutCoupon — The pro-rata cost for upgrades will be calculated based on the time remaining for the subscription. Discounts from any attached coupons will not be deducted from the pro-rated cost. \",\"verbs\":[]} - - :return: The pro_rata_mode of this ProductRatePlan. - :rtype: str - """ - return self._pro_rata_mode - - @pro_rata_mode.setter - def pro_rata_mode(self, pro_rata_mode): - """ - Sets the pro_rata_mode of this ProductRatePlan. - {\"default\":\"WithCoupon\",\"description\":\"The pro-rata mode for the rate plan.
None — The pro-rata cost for upgrades will be ignored.
WithCoupon — The pro-rata cost for upgrades will be calculated based on the time remaining for the subscription. Discounts from any attached coupons will be deducted from the pro-rated cost.
WithoutCoupon — The pro-rata cost for upgrades will be calculated based on the time remaining for the subscription. Discounts from any attached coupons will not be deducted from the pro-rated cost. \",\"verbs\":[]} - - :param pro_rata_mode: The pro_rata_mode of this ProductRatePlan. - :type: str - """ - allowed_values = ["None", "WithCoupon", "WithoutCoupon", "Full"] - if pro_rata_mode not in allowed_values: - raise ValueError( - "Invalid value for `pro_rata_mode` ({0}), must be one of {1}" - .format(pro_rata_mode, allowed_values) - ) - - self._pro_rata_mode = pro_rata_mode - - @property - def create_zero_valued_invoices(self): - """ - Gets the create_zero_valued_invoices of this ProductRatePlan. - {\"default\":\"true\",\"description\":\"Whether invoices are created if they have a zero valued cost before any discounts are applied.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The create_zero_valued_invoices of this ProductRatePlan. - :rtype: bool - """ - return self._create_zero_valued_invoices - - @create_zero_valued_invoices.setter - def create_zero_valued_invoices(self, create_zero_valued_invoices): - """ - Sets the create_zero_valued_invoices of this ProductRatePlan. - {\"default\":\"true\",\"description\":\"Whether invoices are created if they have a zero valued cost before any discounts are applied.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param create_zero_valued_invoices: The create_zero_valued_invoices of this ProductRatePlan. - :type: bool - """ - - self._create_zero_valued_invoices = create_zero_valued_invoices - - @property - def name(self): - """ - Gets the name of this ProductRatePlan. - {\"description\":\"A friendly name — for your benefit — used to identify this rate plan within some product in BillForward. The name should reflect the fact that this rate plan provides to the customer a price tiering system within which a subscription to its Product can be made.
The rate plan's name could describe the nature of its price tiering (e.g. \\\"Default pricing\\\", \\\"Student pricing\\\").
Remember also that rate plans can override the timing prescribed by their product. If your rate plan is defined by its overriding the default timing of its product, then that can be reflected in that rate plan's name. (e.g. \\\"Student pricing - Annual\\\").\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The name of this ProductRatePlan. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this ProductRatePlan. - {\"description\":\"A friendly name — for your benefit — used to identify this rate plan within some product in BillForward. The name should reflect the fact that this rate plan provides to the customer a price tiering system within which a subscription to its Product can be made.
The rate plan's name could describe the nature of its price tiering (e.g. \\\"Default pricing\\\", \\\"Student pricing\\\").
Remember also that rate plans can override the timing prescribed by their product. If your rate plan is defined by its overriding the default timing of its product, then that can be reflected in that rate plan's name. (e.g. \\\"Student pricing - Annual\\\").\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param name: The name of this ProductRatePlan. - :type: str - """ - - self._name = name - - @property - def public_name(self): - """ - Gets the public_name of this ProductRatePlan. - {\"description\":\"A friendly non-unique name used to identify this product-rate-plan\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The public_name of this ProductRatePlan. - :rtype: str - """ - return self._public_name - - @public_name.setter - def public_name(self, public_name): - """ - Sets the public_name of this ProductRatePlan. - {\"description\":\"A friendly non-unique name used to identify this product-rate-plan\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param public_name: The public_name of this ProductRatePlan. - :type: str - """ - - self._public_name = public_name - - @property - def valid_from(self): - """ - Gets the valid_from of this ProductRatePlan. - {\"description\":\"The UTC DateTime specifying when the rate plan is valid from.\",\"verbs\":[\"GET\"]} - - :return: The valid_from of this ProductRatePlan. - :rtype: datetime - """ - return self._valid_from - - @valid_from.setter - def valid_from(self, valid_from): - """ - Sets the valid_from of this ProductRatePlan. - {\"description\":\"The UTC DateTime specifying when the rate plan is valid from.\",\"verbs\":[\"GET\"]} - - :param valid_from: The valid_from of this ProductRatePlan. - :type: datetime - """ - - self._valid_from = valid_from - - @property - def valid_till(self): - """ - Gets the valid_till of this ProductRatePlan. - {\"description\":\"The UTC DateTime specifying when the product-rate-plan is valid till.\",\"verbs\":[\"GET\"]} - - :return: The valid_till of this ProductRatePlan. - :rtype: datetime - """ - return self._valid_till - - @valid_till.setter - def valid_till(self, valid_till): - """ - Sets the valid_till of this ProductRatePlan. - {\"description\":\"The UTC DateTime specifying when the product-rate-plan is valid till.\",\"verbs\":[\"GET\"]} - - :param valid_till: The valid_till of this ProductRatePlan. - :type: datetime - """ - - self._valid_till = valid_till - - @property - def status(self): - """ - Gets the status of this ProductRatePlan. - {\"description\":\"The current status of the rate plan.\",\"verbs\":[]} - - :return: The status of this ProductRatePlan. - :rtype: str - """ - return self._status - - @status.setter - def status(self, status): - """ - Sets the status of this ProductRatePlan. - {\"description\":\"The current status of the rate plan.\",\"verbs\":[]} - - :param status: The status of this ProductRatePlan. - :type: str - """ - - self._status = status - - @property - def migration_behaviour(self): - """ - Gets the migration_behaviour of this ProductRatePlan. - {\"default\":\"CreditAccount\",\"description\":\"The action that should be taken, should the pro-rata calculation result in a negative value.
NoCharge — Don't return to the customer any money.
CreditAccount — Credit the customer's account with the amount.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The migration_behaviour of this ProductRatePlan. - :rtype: str - """ - return self._migration_behaviour - - @migration_behaviour.setter - def migration_behaviour(self, migration_behaviour): - """ - Sets the migration_behaviour of this ProductRatePlan. - {\"default\":\"CreditAccount\",\"description\":\"The action that should be taken, should the pro-rata calculation result in a negative value.
NoCharge — Don't return to the customer any money.
CreditAccount — Credit the customer's account with the amount.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param migration_behaviour: The migration_behaviour of this ProductRatePlan. - :type: str - """ - allowed_values = ["NoCharge", "CreditAccount"] - if migration_behaviour not in allowed_values: - raise ValueError( - "Invalid value for `migration_behaviour` ({0}), must be one of {1}" - .format(migration_behaviour, allowed_values) - ) - - self._migration_behaviour = migration_behaviour - - @property - def invoice_issue_type(self): - """ - Gets the invoice_issue_type of this ProductRatePlan. - {\"default\":\"Immediate\",\"description\":\"The strategy for how invoices for this plan will be issued.
Immediate — All generated invoices move immediately to the 'Unpaid' state — beginning the payment pursuit process.
Delayed — All generated invoices begin in the 'Pending' state. An 'Issue Invoice' amendment is scheduled (based on the rate plan's `issueDuration` and `issuePeriod`) that will move the invoice to the 'Unpaid' state (beginning the payment pursuit process) in accordance with the rate plan's issuance schedule.
Manual — All generated invoices sit in the 'Pending' state — they will not be issued to the customer unless explicit action is taken. This gives you an opportunity to review or recalculate the invoice.\"verbs\":[\"POST\",\"GET\"]} - - :return: The invoice_issue_type of this ProductRatePlan. - :rtype: str - """ - return self._invoice_issue_type - - @invoice_issue_type.setter - def invoice_issue_type(self, invoice_issue_type): - """ - Sets the invoice_issue_type of this ProductRatePlan. - {\"default\":\"Immediate\",\"description\":\"The strategy for how invoices for this plan will be issued.
Immediate — All generated invoices move immediately to the 'Unpaid' state — beginning the payment pursuit process.
Delayed — All generated invoices begin in the 'Pending' state. An 'Issue Invoice' amendment is scheduled (based on the rate plan's `issueDuration` and `issuePeriod`) that will move the invoice to the 'Unpaid' state (beginning the payment pursuit process) in accordance with the rate plan's issuance schedule.
Manual — All generated invoices sit in the 'Pending' state — they will not be issued to the customer unless explicit action is taken. This gives you an opportunity to review or recalculate the invoice.\"verbs\":[\"POST\",\"GET\"]} - - :param invoice_issue_type: The invoice_issue_type of this ProductRatePlan. - :type: str - """ - allowed_values = ["Immediate", "Delayed", "Manual"] - if invoice_issue_type not in allowed_values: - raise ValueError( - "Invalid value for `invoice_issue_type` ({0}), must be one of {1}" - .format(invoice_issue_type, allowed_values) - ) - - self._invoice_issue_type = invoice_issue_type - - @property - def issue_duration(self): - """ - Gets the issue_duration of this ProductRatePlan. - {\"description\":\"Number of issue-length-measures between issuance of invoices for this rate plan.\"\"verbs\":[\"POST\",\"GET\"]} - - :return: The issue_duration of this ProductRatePlan. - :rtype: int - """ - return self._issue_duration - - @issue_duration.setter - def issue_duration(self, issue_duration): - """ - Sets the issue_duration of this ProductRatePlan. - {\"description\":\"Number of issue-length-measures between issuance of invoices for this rate plan.\"\"verbs\":[\"POST\",\"GET\"]} - - :param issue_duration: The issue_duration of this ProductRatePlan. - :type: int - """ - - self._issue_duration = issue_duration - - @property - def issue_period(self): - """ - Gets the issue_period of this ProductRatePlan. - {\"description\":\"Measure describing the magnitude of the invoice issuance period.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The issue_period of this ProductRatePlan. - :rtype: str - """ - return self._issue_period - - @issue_period.setter - def issue_period(self, issue_period): - """ - Sets the issue_period of this ProductRatePlan. - {\"description\":\"Measure describing the magnitude of the invoice issuance period.\",\"verbs\":[\"POST\",\"GET\"]} - - :param issue_period: The issue_period of this ProductRatePlan. - :type: str - """ - allowed_values = ["minutes", "days", "months", "years"] - if issue_period not in allowed_values: - raise ValueError( - "Invalid value for `issue_period` ({0}), must be one of {1}" - .format(issue_period, allowed_values) - ) - - self._issue_period = issue_period - - @property - def taxation(self): - """ - Gets the taxation of this ProductRatePlan. - {\"description\":\"A list linking taxation strategies to the rate plan.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} - - :return: The taxation of this ProductRatePlan. - :rtype: list[MutableBillingEntity] - """ - return self._taxation - - @taxation.setter - def taxation(self, taxation): - """ - Sets the taxation of this ProductRatePlan. - {\"description\":\"A list linking taxation strategies to the rate plan.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} - - :param taxation: The taxation of this ProductRatePlan. - :type: list[MutableBillingEntity] - """ - - self._taxation = taxation - - @property - def fixed_term_definitions(self): - """ - Gets the fixed_term_definitions of this ProductRatePlan. - {\"description\":\"A list linking \\\"Fixed-Term Definitions\\\" to the rate plan.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The fixed_term_definitions of this ProductRatePlan. - :rtype: list[MutableBillingEntity] - """ - return self._fixed_term_definitions - - @fixed_term_definitions.setter - def fixed_term_definitions(self, fixed_term_definitions): - """ - Sets the fixed_term_definitions of this ProductRatePlan. - {\"description\":\"A list linking \\\"Fixed-Term Definitions\\\" to the rate plan.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param fixed_term_definitions: The fixed_term_definitions of this ProductRatePlan. - :type: list[MutableBillingEntity] - """ - - self._fixed_term_definitions = fixed_term_definitions - - @property - def product(self): - """ - Gets the product of this ProductRatePlan. - {\"description\":\"The product to which this rate plan belongs. A product is essentially a collection of rate plans, and describes the service conferred to a customer upon subscription to any of said product's rate plans. The product serves also as a template from which its rate plans can infer default attributes.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The product of this ProductRatePlan. - :rtype: Product - """ - return self._product - - @product.setter - def product(self, product): - """ - Sets the product of this ProductRatePlan. - {\"description\":\"The product to which this rate plan belongs. A product is essentially a collection of rate plans, and describes the service conferred to a customer upon subscription to any of said product's rate plans. The product serves also as a template from which its rate plans can infer default attributes.\",\"verbs\":[\"POST\",\"GET\"]} - - :param product: The product of this ProductRatePlan. - :type: Product - """ - - self._product = product - - @property - def pricing_components(self): - """ - Gets the pricing_components of this ProductRatePlan. - {\"description\":\"The pricing-components which describe the price tiering system of this rate plan. A product rate plan may have 1 or more pricing components. Each pricing component represents a different charge associated with the subscription. Pricing components are versioned.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The pricing_components of this ProductRatePlan. - :rtype: list[PricingComponent] - """ - return self._pricing_components - - @pricing_components.setter - def pricing_components(self, pricing_components): - """ - Sets the pricing_components of this ProductRatePlan. - {\"description\":\"The pricing-components which describe the price tiering system of this rate plan. A product rate plan may have 1 or more pricing components. Each pricing component represents a different charge associated with the subscription. Pricing components are versioned.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param pricing_components: The pricing_components of this ProductRatePlan. - :type: list[PricingComponent] - """ - - self._pricing_components = pricing_components - - @property - def aggregating_components(self): - """ - Gets the aggregating_components of this ProductRatePlan. - {\"default\":\"(empty list)\",\"description\":\"List of AggregatingComponents — these describe pricing components whose prices should be recalculated upon invoice aggregation. For example: two subscriptions' individual consumptions may be neither of them large enough to achieve bulk-buy discounts. When aggregated, though, the same two subscriptions' consumption may add up to a quantity which does merit a bulk buy discount within your tiering system.\",\"verbs\":[\"POST\"]} - - :return: The aggregating_components of this ProductRatePlan. - :rtype: list[AggregatingComponent] - """ - return self._aggregating_components - - @aggregating_components.setter - def aggregating_components(self, aggregating_components): - """ - Sets the aggregating_components of this ProductRatePlan. - {\"default\":\"(empty list)\",\"description\":\"List of AggregatingComponents — these describe pricing components whose prices should be recalculated upon invoice aggregation. For example: two subscriptions' individual consumptions may be neither of them large enough to achieve bulk-buy discounts. When aggregated, though, the same two subscriptions' consumption may add up to a quantity which does merit a bulk buy discount within your tiering system.\",\"verbs\":[\"POST\"]} - - :param aggregating_components: The aggregating_components of this ProductRatePlan. - :type: list[AggregatingComponent] - """ - - self._aggregating_components = aggregating_components - - @property - def payment_terms(self): - """ - Gets the payment_terms of this ProductRatePlan. - - - :return: The payment_terms of this ProductRatePlan. - :rtype: int - """ - return self._payment_terms - - @payment_terms.setter - def payment_terms(self, payment_terms): - """ - Sets the payment_terms of this ProductRatePlan. - - - :param payment_terms: The payment_terms of this ProductRatePlan. - :type: int - """ - - self._payment_terms = payment_terms - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/product_rate_plan_migration_amendment.py b/billforward/models/product_rate_plan_migration_amendment.py index 0c17566..8000ca0 100644 --- a/billforward/models/product_rate_plan_migration_amendment.py +++ b/billforward/models/product_rate_plan_migration_amendment.py @@ -1,453 +1,137 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class ProductRatePlanMigrationAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class ProductRatePlanMigrationAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False, product_rate_plan_id=None, invoicing_type=None, mappings=None, previous_subscription_id=None, next_subscription_id=None, next_subscription_name=None, next_subscription_description=None, pricing_behaviour=None): - """ - ProductRatePlanMigrationAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool', - 'product_rate_plan_id': 'str', - 'invoicing_type': 'str', - 'mappings': 'list[PricingComponentValueMigrationAmendmentMapping]', - 'previous_subscription_id': 'str', - 'next_subscription_id': 'str', - 'next_subscription_name': 'str', - 'next_subscription_description': 'str', - 'pricing_behaviour': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted', - 'product_rate_plan_id': 'productRatePlanID', - 'invoicing_type': 'invoicingType', - 'mappings': 'mappings', - 'previous_subscription_id': 'previousSubscriptionID', - 'next_subscription_id': 'nextSubscriptionID', - 'next_subscription_name': 'nextSubscriptionName', - 'next_subscription_description': 'nextSubscriptionDescription', - 'pricing_behaviour': 'pricingBehaviour' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - self._product_rate_plan_id = product_rate_plan_id - self._invoicing_type = invoicing_type - self._mappings = mappings - self._previous_subscription_id = previous_subscription_id - self._next_subscription_id = next_subscription_id - self._next_subscription_name = next_subscription_name - self._next_subscription_description = next_subscription_description - self._pricing_behaviour = pricing_behaviour - - @property - def created(self): - """ - Gets the created of this ProductRatePlanMigrationAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this ProductRatePlanMigrationAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this ProductRatePlanMigrationAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this ProductRatePlanMigrationAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this ProductRatePlanMigrationAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this ProductRatePlanMigrationAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this ProductRatePlanMigrationAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this ProductRatePlanMigrationAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this ProductRatePlanMigrationAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this ProductRatePlanMigrationAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this ProductRatePlanMigrationAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this ProductRatePlanMigrationAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this ProductRatePlanMigrationAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this ProductRatePlanMigrationAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this ProductRatePlanMigrationAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this ProductRatePlanMigrationAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def id(self): - """ - Gets the id of this ProductRatePlanMigrationAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this ProductRatePlanMigrationAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ProductRatePlanMigrationAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this ProductRatePlanMigrationAmendment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this ProductRatePlanMigrationAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this ProductRatePlanMigrationAmendment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this ProductRatePlanMigrationAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this ProductRatePlanMigrationAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this ProductRatePlanMigrationAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this ProductRatePlanMigrationAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this ProductRatePlanMigrationAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this ProductRatePlanMigrationAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this ProductRatePlanMigrationAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this ProductRatePlanMigrationAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this ProductRatePlanMigrationAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this ProductRatePlanMigrationAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this ProductRatePlanMigrationAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this ProductRatePlanMigrationAmendment. - :rtype: datetime - """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this ProductRatePlanMigrationAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actioning_time: The actioning_time of this ProductRatePlanMigrationAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this ProductRatePlanMigrationAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this ProductRatePlanMigrationAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this ProductRatePlanMigrationAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :param actioned_time: The actioned_time of this ProductRatePlanMigrationAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this ProductRatePlanMigrationAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this ProductRatePlanMigrationAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this ProductRatePlanMigrationAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this ProductRatePlanMigrationAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this ProductRatePlanMigrationAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this ProductRatePlanMigrationAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this ProductRatePlanMigrationAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this ProductRatePlanMigrationAmendment. - :type: bool - """ - - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'product_rate_plan_id': 'str', + 'invoicing_type': 'str', + 'mappings': 'list[PricingComponentValueMigrationAmendmentMapping]', + 'previous_subscription_id': 'str', + 'next_subscription_id': 'str', + 'next_subscription_name': 'str', + 'next_subscription_description': 'str', + 'pricing_behaviour': 'str', + 'force_trial_end': 'bool' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'product_rate_plan_id': 'productRatePlanID', + 'invoicing_type': 'invoicingType', + 'mappings': 'mappings', + 'previous_subscription_id': 'previousSubscriptionID', + 'next_subscription_id': 'nextSubscriptionID', + 'next_subscription_name': 'nextSubscriptionName', + 'next_subscription_description': 'nextSubscriptionDescription', + 'pricing_behaviour': 'pricingBehaviour', + 'force_trial_end': 'forceTrialEnd' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, product_rate_plan_id=None, invoicing_type=None, mappings=None, previous_subscription_id=None, next_subscription_id=None, next_subscription_name=None, next_subscription_description=None, pricing_behaviour=None, force_trial_end=None, *args, **kwargs): # noqa: E501 + """ProductRatePlanMigrationAmendment - a model defined in Swagger""" # noqa: E501 + self._product_rate_plan_id = None + self._invoicing_type = None + self._mappings = None + self._previous_subscription_id = None + self._next_subscription_id = None + self._next_subscription_name = None + self._next_subscription_description = None + self._pricing_behaviour = None + self._force_trial_end = None + self.discriminator = None + self.product_rate_plan_id = product_rate_plan_id + self.invoicing_type = invoicing_type + if mappings is not None: + self.mappings = mappings + if previous_subscription_id is not None: + self.previous_subscription_id = previous_subscription_id + if next_subscription_id is not None: + self.next_subscription_id = next_subscription_id + if next_subscription_name is not None: + self.next_subscription_name = next_subscription_name + if next_subscription_description is not None: + self.next_subscription_description = next_subscription_description + self.pricing_behaviour = pricing_behaviour + if force_trial_end is not None: + self.force_trial_end = force_trial_end + Amendment.__init__(self, *args, **kwargs) @property def product_rate_plan_id(self): - """ - Gets the product_rate_plan_id of this ProductRatePlanMigrationAmendment. - { \"description\" : \"Identifier of the rate-plan the subscription to migrate to\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the product_rate_plan_id of this ProductRatePlanMigrationAmendment. # noqa: E501 + - :return: The product_rate_plan_id of this ProductRatePlanMigrationAmendment. + :return: The product_rate_plan_id of this ProductRatePlanMigrationAmendment. # noqa: E501 :rtype: str """ return self._product_rate_plan_id @product_rate_plan_id.setter def product_rate_plan_id(self, product_rate_plan_id): - """ - Sets the product_rate_plan_id of this ProductRatePlanMigrationAmendment. - { \"description\" : \"Identifier of the rate-plan the subscription to migrate to\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the product_rate_plan_id of this ProductRatePlanMigrationAmendment. + - :param product_rate_plan_id: The product_rate_plan_id of this ProductRatePlanMigrationAmendment. + :param product_rate_plan_id: The product_rate_plan_id of this ProductRatePlanMigrationAmendment. # noqa: E501 :type: str """ + if product_rate_plan_id is None: + raise ValueError("Invalid value for `product_rate_plan_id`, must not be `None`") # noqa: E501 self._product_rate_plan_id = product_rate_plan_id @property def invoicing_type(self): - """ - Gets the invoicing_type of this ProductRatePlanMigrationAmendment. - { \"description\" : \"Immediate invoicing will result in an invoice being issued immediately for migration charges. Aggregated invoicing will generate a charge to be added to the next issued invoice, for example at the current billing period end.\", \"default\" : \"Immediate\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the invoicing_type of this ProductRatePlanMigrationAmendment. # noqa: E501 + - :return: The invoicing_type of this ProductRatePlanMigrationAmendment. + :return: The invoicing_type of this ProductRatePlanMigrationAmendment. # noqa: E501 :rtype: str """ return self._invoicing_type @invoicing_type.setter def invoicing_type(self, invoicing_type): - """ - Sets the invoicing_type of this ProductRatePlanMigrationAmendment. - { \"description\" : \"Immediate invoicing will result in an invoice being issued immediately for migration charges. Aggregated invoicing will generate a charge to be added to the next issued invoice, for example at the current billing period end.\", \"default\" : \"Immediate\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the invoicing_type of this ProductRatePlanMigrationAmendment. - :param invoicing_type: The invoicing_type of this ProductRatePlanMigrationAmendment. + + :param invoicing_type: The invoicing_type of this ProductRatePlanMigrationAmendment. # noqa: E501 :type: str """ - allowed_values = ["Immediate", "Aggregated"] + if invoicing_type is None: + raise ValueError("Invalid value for `invoicing_type`, must not be `None`") # noqa: E501 + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 if invoicing_type not in allowed_values: raise ValueError( - "Invalid value for `invoicing_type` ({0}), must be one of {1}" + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 .format(invoicing_type, allowed_values) ) @@ -455,22 +139,20 @@ def invoicing_type(self, invoicing_type): @property def mappings(self): - """ - Gets the mappings of this ProductRatePlanMigrationAmendment. - { \"description\" : \"Mapping of new rate-plans pricing-components to values\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the mappings of this ProductRatePlanMigrationAmendment. # noqa: E501 - :return: The mappings of this ProductRatePlanMigrationAmendment. + + :return: The mappings of this ProductRatePlanMigrationAmendment. # noqa: E501 :rtype: list[PricingComponentValueMigrationAmendmentMapping] """ return self._mappings @mappings.setter def mappings(self, mappings): - """ - Sets the mappings of this ProductRatePlanMigrationAmendment. - { \"description\" : \"Mapping of new rate-plans pricing-components to values\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the mappings of this ProductRatePlanMigrationAmendment. - :param mappings: The mappings of this ProductRatePlanMigrationAmendment. + + :param mappings: The mappings of this ProductRatePlanMigrationAmendment. # noqa: E501 :type: list[PricingComponentValueMigrationAmendmentMapping] """ @@ -478,22 +160,20 @@ def mappings(self, mappings): @property def previous_subscription_id(self): - """ - Gets the previous_subscription_id of this ProductRatePlanMigrationAmendment. - { \"description\" : \"ID of the previous subscription.\", \"verbs\":[\"GET\"] } + """Gets the previous_subscription_id of this ProductRatePlanMigrationAmendment. # noqa: E501 + - :return: The previous_subscription_id of this ProductRatePlanMigrationAmendment. + :return: The previous_subscription_id of this ProductRatePlanMigrationAmendment. # noqa: E501 :rtype: str """ return self._previous_subscription_id @previous_subscription_id.setter def previous_subscription_id(self, previous_subscription_id): - """ - Sets the previous_subscription_id of this ProductRatePlanMigrationAmendment. - { \"description\" : \"ID of the previous subscription.\", \"verbs\":[\"GET\"] } + """Sets the previous_subscription_id of this ProductRatePlanMigrationAmendment. + - :param previous_subscription_id: The previous_subscription_id of this ProductRatePlanMigrationAmendment. + :param previous_subscription_id: The previous_subscription_id of this ProductRatePlanMigrationAmendment. # noqa: E501 :type: str """ @@ -501,22 +181,20 @@ def previous_subscription_id(self, previous_subscription_id): @property def next_subscription_id(self): - """ - Gets the next_subscription_id of this ProductRatePlanMigrationAmendment. - { \"description\" : \"ID of the next subscription.\", \"verbs\":[\"GET\"] } + """Gets the next_subscription_id of this ProductRatePlanMigrationAmendment. # noqa: E501 + - :return: The next_subscription_id of this ProductRatePlanMigrationAmendment. + :return: The next_subscription_id of this ProductRatePlanMigrationAmendment. # noqa: E501 :rtype: str """ return self._next_subscription_id @next_subscription_id.setter def next_subscription_id(self, next_subscription_id): - """ - Sets the next_subscription_id of this ProductRatePlanMigrationAmendment. - { \"description\" : \"ID of the next subscription.\", \"verbs\":[\"GET\"] } + """Sets the next_subscription_id of this ProductRatePlanMigrationAmendment. + - :param next_subscription_id: The next_subscription_id of this ProductRatePlanMigrationAmendment. + :param next_subscription_id: The next_subscription_id of this ProductRatePlanMigrationAmendment. # noqa: E501 :type: str """ @@ -524,22 +202,20 @@ def next_subscription_id(self, next_subscription_id): @property def next_subscription_name(self): - """ - Gets the next_subscription_name of this ProductRatePlanMigrationAmendment. - { \"description\" : \"User definable friendly name for the migrated subscription.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the next_subscription_name of this ProductRatePlanMigrationAmendment. # noqa: E501 - :return: The next_subscription_name of this ProductRatePlanMigrationAmendment. + + :return: The next_subscription_name of this ProductRatePlanMigrationAmendment. # noqa: E501 :rtype: str """ return self._next_subscription_name @next_subscription_name.setter def next_subscription_name(self, next_subscription_name): - """ - Sets the next_subscription_name of this ProductRatePlanMigrationAmendment. - { \"description\" : \"User definable friendly name for the migrated subscription.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the next_subscription_name of this ProductRatePlanMigrationAmendment. + - :param next_subscription_name: The next_subscription_name of this ProductRatePlanMigrationAmendment. + :param next_subscription_name: The next_subscription_name of this ProductRatePlanMigrationAmendment. # noqa: E501 :type: str """ @@ -547,22 +223,20 @@ def next_subscription_name(self, next_subscription_name): @property def next_subscription_description(self): - """ - Gets the next_subscription_description of this ProductRatePlanMigrationAmendment. - { \"description\" : \"User definable description for the migrated subscription.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the next_subscription_description of this ProductRatePlanMigrationAmendment. # noqa: E501 + - :return: The next_subscription_description of this ProductRatePlanMigrationAmendment. + :return: The next_subscription_description of this ProductRatePlanMigrationAmendment. # noqa: E501 :rtype: str """ return self._next_subscription_description @next_subscription_description.setter def next_subscription_description(self, next_subscription_description): - """ - Sets the next_subscription_description of this ProductRatePlanMigrationAmendment. - { \"description\" : \"User definable description for the migrated subscription.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the next_subscription_description of this ProductRatePlanMigrationAmendment. - :param next_subscription_description: The next_subscription_description of this ProductRatePlanMigrationAmendment. + + :param next_subscription_description: The next_subscription_description of this ProductRatePlanMigrationAmendment. # noqa: E501 :type: str """ @@ -570,40 +244,59 @@ def next_subscription_description(self, next_subscription_description): @property def pricing_behaviour(self): - """ - Gets the pricing_behaviour of this ProductRatePlanMigrationAmendment. - { \"description\" : \"Pricing behaviour defines how migration charges are calculated. DifferenceProRated calculates the difference between in-advance charges of the existing and new rate-plan, then pro-rates based on time remaining. None sets the migration charge as zero cost. Full sets the costs as the total of the new rate-plans in-advance charges. Difference is the same calculation as DifferenceProRated but no pro-ration is applied. ProRated differs depending on two cases; when moving to a rate-plan of the same duration it pro-rates the in-advance charges of the new rate-plan. If the duration is different, a credit-note will be issued any remaining time on the existing plans billing period.\", \"default\" : \"DifferenceProRated\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the pricing_behaviour of this ProductRatePlanMigrationAmendment. # noqa: E501 - :return: The pricing_behaviour of this ProductRatePlanMigrationAmendment. + + :return: The pricing_behaviour of this ProductRatePlanMigrationAmendment. # noqa: E501 :rtype: str """ return self._pricing_behaviour @pricing_behaviour.setter def pricing_behaviour(self, pricing_behaviour): - """ - Sets the pricing_behaviour of this ProductRatePlanMigrationAmendment. - { \"description\" : \"Pricing behaviour defines how migration charges are calculated. DifferenceProRated calculates the difference between in-advance charges of the existing and new rate-plan, then pro-rates based on time remaining. None sets the migration charge as zero cost. Full sets the costs as the total of the new rate-plans in-advance charges. Difference is the same calculation as DifferenceProRated but no pro-ration is applied. ProRated differs depending on two cases; when moving to a rate-plan of the same duration it pro-rates the in-advance charges of the new rate-plan. If the duration is different, a credit-note will be issued any remaining time on the existing plans billing period.\", \"default\" : \"DifferenceProRated\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the pricing_behaviour of this ProductRatePlanMigrationAmendment. - :param pricing_behaviour: The pricing_behaviour of this ProductRatePlanMigrationAmendment. + + :param pricing_behaviour: The pricing_behaviour of this ProductRatePlanMigrationAmendment. # noqa: E501 :type: str """ - allowed_values = ["None", "Full", "Difference", "DifferenceProRated", "ProRated"] + if pricing_behaviour is None: + raise ValueError("Invalid value for `pricing_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["None", "Full", "Difference", "DifferenceProRated", "ProRated"] # noqa: E501 if pricing_behaviour not in allowed_values: raise ValueError( - "Invalid value for `pricing_behaviour` ({0}), must be one of {1}" + "Invalid value for `pricing_behaviour` ({0}), must be one of {1}" # noqa: E501 .format(pricing_behaviour, allowed_values) ) self._pricing_behaviour = pricing_behaviour - def to_dict(self): + @property + def force_trial_end(self): + """Gets the force_trial_end of this ProductRatePlanMigrationAmendment. # noqa: E501 + + + :return: The force_trial_end of this ProductRatePlanMigrationAmendment. # noqa: E501 + :rtype: bool """ - Returns the model properties as a dict + return self._force_trial_end + + @force_trial_end.setter + def force_trial_end(self, force_trial_end): + """Sets the force_trial_end of this ProductRatePlanMigrationAmendment. + + + :param force_trial_end: The force_trial_end of this ProductRatePlanMigrationAmendment. # noqa: E501 + :type: bool """ + + self._force_trial_end = force_trial_end + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -620,29 +313,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(ProductRatePlanMigrationAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, ProductRatePlanMigrationAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/product_rate_plan_migration_charge.py b/billforward/models/product_rate_plan_migration_charge.py new file mode 100644 index 0000000..1ef7ef6 --- /dev/null +++ b/billforward/models/product_rate_plan_migration_charge.py @@ -0,0 +1,409 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.subscription_charge import SubscriptionCharge # noqa: F401,E501 + +class ProductRatePlanMigrationCharge(SubscriptionCharge): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'pricing_behaviour': 'str', + 'same_period': 'bool', + 'original_product_rate_plan_id': 'str', + 'original_public_product_rate_plan_name': 'str', + 'original_product_rate_plan_name': 'str', + 'new_product_rate_plan_id': 'str', + 'new_public_product_rate_plan_name': 'str', + 'new_product_rate_plan_name': 'str', + 'new_product_id': 'str', + 'new_public_product_name': 'str', + 'new_product_name': 'str', + 'pricing_component_values': 'list[PricingComponentMigrationValue]' + } + if hasattr(SubscriptionCharge, "swagger_types"): + swagger_types.update(SubscriptionCharge.swagger_types) + + attribute_map = { + 'pricing_behaviour': 'pricingBehaviour', + 'same_period': 'samePeriod', + 'original_product_rate_plan_id': 'originalProductRatePlanID', + 'original_public_product_rate_plan_name': 'originalPublicProductRatePlanName', + 'original_product_rate_plan_name': 'originalProductRatePlanName', + 'new_product_rate_plan_id': 'newProductRatePlanID', + 'new_public_product_rate_plan_name': 'newPublicProductRatePlanName', + 'new_product_rate_plan_name': 'newProductRatePlanName', + 'new_product_id': 'newProductID', + 'new_public_product_name': 'newPublicProductName', + 'new_product_name': 'newProductName', + 'pricing_component_values': 'pricingComponentValues' + } + if hasattr(SubscriptionCharge, "attribute_map"): + attribute_map.update(SubscriptionCharge.attribute_map) + + def __init__(self, pricing_behaviour=None, same_period=None, original_product_rate_plan_id=None, original_public_product_rate_plan_name=None, original_product_rate_plan_name=None, new_product_rate_plan_id=None, new_public_product_rate_plan_name=None, new_product_rate_plan_name=None, new_product_id=None, new_public_product_name=None, new_product_name=None, pricing_component_values=None, *args, **kwargs): # noqa: E501 + """ProductRatePlanMigrationCharge - a model defined in Swagger""" # noqa: E501 + self._pricing_behaviour = None + self._same_period = None + self._original_product_rate_plan_id = None + self._original_public_product_rate_plan_name = None + self._original_product_rate_plan_name = None + self._new_product_rate_plan_id = None + self._new_public_product_rate_plan_name = None + self._new_product_rate_plan_name = None + self._new_product_id = None + self._new_public_product_name = None + self._new_product_name = None + self._pricing_component_values = None + self.discriminator = None + self.pricing_behaviour = pricing_behaviour + if same_period is not None: + self.same_period = same_period + if original_product_rate_plan_id is not None: + self.original_product_rate_plan_id = original_product_rate_plan_id + if original_public_product_rate_plan_name is not None: + self.original_public_product_rate_plan_name = original_public_product_rate_plan_name + if original_product_rate_plan_name is not None: + self.original_product_rate_plan_name = original_product_rate_plan_name + if new_product_rate_plan_id is not None: + self.new_product_rate_plan_id = new_product_rate_plan_id + if new_public_product_rate_plan_name is not None: + self.new_public_product_rate_plan_name = new_public_product_rate_plan_name + if new_product_rate_plan_name is not None: + self.new_product_rate_plan_name = new_product_rate_plan_name + if new_product_id is not None: + self.new_product_id = new_product_id + if new_public_product_name is not None: + self.new_public_product_name = new_public_product_name + if new_product_name is not None: + self.new_product_name = new_product_name + if pricing_component_values is not None: + self.pricing_component_values = pricing_component_values + SubscriptionCharge.__init__(self, *args, **kwargs) + + @property + def pricing_behaviour(self): + """Gets the pricing_behaviour of this ProductRatePlanMigrationCharge. # noqa: E501 + + + :return: The pricing_behaviour of this ProductRatePlanMigrationCharge. # noqa: E501 + :rtype: str + """ + return self._pricing_behaviour + + @pricing_behaviour.setter + def pricing_behaviour(self, pricing_behaviour): + """Sets the pricing_behaviour of this ProductRatePlanMigrationCharge. + + + :param pricing_behaviour: The pricing_behaviour of this ProductRatePlanMigrationCharge. # noqa: E501 + :type: str + """ + if pricing_behaviour is None: + raise ValueError("Invalid value for `pricing_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["None", "Full", "Difference", "DifferenceProRated", "ProRated"] # noqa: E501 + if pricing_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `pricing_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(pricing_behaviour, allowed_values) + ) + + self._pricing_behaviour = pricing_behaviour + + @property + def same_period(self): + """Gets the same_period of this ProductRatePlanMigrationCharge. # noqa: E501 + + + :return: The same_period of this ProductRatePlanMigrationCharge. # noqa: E501 + :rtype: bool + """ + return self._same_period + + @same_period.setter + def same_period(self, same_period): + """Sets the same_period of this ProductRatePlanMigrationCharge. + + + :param same_period: The same_period of this ProductRatePlanMigrationCharge. # noqa: E501 + :type: bool + """ + + self._same_period = same_period + + @property + def original_product_rate_plan_id(self): + """Gets the original_product_rate_plan_id of this ProductRatePlanMigrationCharge. # noqa: E501 + + + :return: The original_product_rate_plan_id of this ProductRatePlanMigrationCharge. # noqa: E501 + :rtype: str + """ + return self._original_product_rate_plan_id + + @original_product_rate_plan_id.setter + def original_product_rate_plan_id(self, original_product_rate_plan_id): + """Sets the original_product_rate_plan_id of this ProductRatePlanMigrationCharge. + + + :param original_product_rate_plan_id: The original_product_rate_plan_id of this ProductRatePlanMigrationCharge. # noqa: E501 + :type: str + """ + + self._original_product_rate_plan_id = original_product_rate_plan_id + + @property + def original_public_product_rate_plan_name(self): + """Gets the original_public_product_rate_plan_name of this ProductRatePlanMigrationCharge. # noqa: E501 + + + :return: The original_public_product_rate_plan_name of this ProductRatePlanMigrationCharge. # noqa: E501 + :rtype: str + """ + return self._original_public_product_rate_plan_name + + @original_public_product_rate_plan_name.setter + def original_public_product_rate_plan_name(self, original_public_product_rate_plan_name): + """Sets the original_public_product_rate_plan_name of this ProductRatePlanMigrationCharge. + + + :param original_public_product_rate_plan_name: The original_public_product_rate_plan_name of this ProductRatePlanMigrationCharge. # noqa: E501 + :type: str + """ + + self._original_public_product_rate_plan_name = original_public_product_rate_plan_name + + @property + def original_product_rate_plan_name(self): + """Gets the original_product_rate_plan_name of this ProductRatePlanMigrationCharge. # noqa: E501 + + + :return: The original_product_rate_plan_name of this ProductRatePlanMigrationCharge. # noqa: E501 + :rtype: str + """ + return self._original_product_rate_plan_name + + @original_product_rate_plan_name.setter + def original_product_rate_plan_name(self, original_product_rate_plan_name): + """Sets the original_product_rate_plan_name of this ProductRatePlanMigrationCharge. + + + :param original_product_rate_plan_name: The original_product_rate_plan_name of this ProductRatePlanMigrationCharge. # noqa: E501 + :type: str + """ + + self._original_product_rate_plan_name = original_product_rate_plan_name + + @property + def new_product_rate_plan_id(self): + """Gets the new_product_rate_plan_id of this ProductRatePlanMigrationCharge. # noqa: E501 + + + :return: The new_product_rate_plan_id of this ProductRatePlanMigrationCharge. # noqa: E501 + :rtype: str + """ + return self._new_product_rate_plan_id + + @new_product_rate_plan_id.setter + def new_product_rate_plan_id(self, new_product_rate_plan_id): + """Sets the new_product_rate_plan_id of this ProductRatePlanMigrationCharge. + + + :param new_product_rate_plan_id: The new_product_rate_plan_id of this ProductRatePlanMigrationCharge. # noqa: E501 + :type: str + """ + + self._new_product_rate_plan_id = new_product_rate_plan_id + + @property + def new_public_product_rate_plan_name(self): + """Gets the new_public_product_rate_plan_name of this ProductRatePlanMigrationCharge. # noqa: E501 + + + :return: The new_public_product_rate_plan_name of this ProductRatePlanMigrationCharge. # noqa: E501 + :rtype: str + """ + return self._new_public_product_rate_plan_name + + @new_public_product_rate_plan_name.setter + def new_public_product_rate_plan_name(self, new_public_product_rate_plan_name): + """Sets the new_public_product_rate_plan_name of this ProductRatePlanMigrationCharge. + + + :param new_public_product_rate_plan_name: The new_public_product_rate_plan_name of this ProductRatePlanMigrationCharge. # noqa: E501 + :type: str + """ + + self._new_public_product_rate_plan_name = new_public_product_rate_plan_name + + @property + def new_product_rate_plan_name(self): + """Gets the new_product_rate_plan_name of this ProductRatePlanMigrationCharge. # noqa: E501 + + + :return: The new_product_rate_plan_name of this ProductRatePlanMigrationCharge. # noqa: E501 + :rtype: str + """ + return self._new_product_rate_plan_name + + @new_product_rate_plan_name.setter + def new_product_rate_plan_name(self, new_product_rate_plan_name): + """Sets the new_product_rate_plan_name of this ProductRatePlanMigrationCharge. + + + :param new_product_rate_plan_name: The new_product_rate_plan_name of this ProductRatePlanMigrationCharge. # noqa: E501 + :type: str + """ + + self._new_product_rate_plan_name = new_product_rate_plan_name + + @property + def new_product_id(self): + """Gets the new_product_id of this ProductRatePlanMigrationCharge. # noqa: E501 + + + :return: The new_product_id of this ProductRatePlanMigrationCharge. # noqa: E501 + :rtype: str + """ + return self._new_product_id + + @new_product_id.setter + def new_product_id(self, new_product_id): + """Sets the new_product_id of this ProductRatePlanMigrationCharge. + + + :param new_product_id: The new_product_id of this ProductRatePlanMigrationCharge. # noqa: E501 + :type: str + """ + + self._new_product_id = new_product_id + + @property + def new_public_product_name(self): + """Gets the new_public_product_name of this ProductRatePlanMigrationCharge. # noqa: E501 + + + :return: The new_public_product_name of this ProductRatePlanMigrationCharge. # noqa: E501 + :rtype: str + """ + return self._new_public_product_name + + @new_public_product_name.setter + def new_public_product_name(self, new_public_product_name): + """Sets the new_public_product_name of this ProductRatePlanMigrationCharge. + + + :param new_public_product_name: The new_public_product_name of this ProductRatePlanMigrationCharge. # noqa: E501 + :type: str + """ + + self._new_public_product_name = new_public_product_name + + @property + def new_product_name(self): + """Gets the new_product_name of this ProductRatePlanMigrationCharge. # noqa: E501 + + + :return: The new_product_name of this ProductRatePlanMigrationCharge. # noqa: E501 + :rtype: str + """ + return self._new_product_name + + @new_product_name.setter + def new_product_name(self, new_product_name): + """Sets the new_product_name of this ProductRatePlanMigrationCharge. + + + :param new_product_name: The new_product_name of this ProductRatePlanMigrationCharge. # noqa: E501 + :type: str + """ + + self._new_product_name = new_product_name + + @property + def pricing_component_values(self): + """Gets the pricing_component_values of this ProductRatePlanMigrationCharge. # noqa: E501 + + + :return: The pricing_component_values of this ProductRatePlanMigrationCharge. # noqa: E501 + :rtype: list[PricingComponentMigrationValue] + """ + return self._pricing_component_values + + @pricing_component_values.setter + def pricing_component_values(self, pricing_component_values): + """Sets the pricing_component_values of this ProductRatePlanMigrationCharge. + + + :param pricing_component_values: The pricing_component_values of this ProductRatePlanMigrationCharge. # noqa: E501 + :type: list[PricingComponentMigrationValue] + """ + + self._pricing_component_values = pricing_component_values + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ProductRatePlanMigrationCharge, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ProductRatePlanMigrationCharge): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/product_rate_plan_paged_metadata.py b/billforward/models/product_rate_plan_paged_metadata.py deleted file mode 100644 index fd20dae..0000000 --- a/billforward/models/product_rate_plan_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class ProductRatePlanPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - ProductRatePlanPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[ProductRatePlan]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this ProductRatePlanPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this ProductRatePlanPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this ProductRatePlanPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this ProductRatePlanPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this ProductRatePlanPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this ProductRatePlanPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this ProductRatePlanPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this ProductRatePlanPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this ProductRatePlanPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this ProductRatePlanPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this ProductRatePlanPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this ProductRatePlanPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this ProductRatePlanPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this ProductRatePlanPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this ProductRatePlanPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this ProductRatePlanPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this ProductRatePlanPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this ProductRatePlanPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this ProductRatePlanPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this ProductRatePlanPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this ProductRatePlanPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this ProductRatePlanPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this ProductRatePlanPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this ProductRatePlanPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this ProductRatePlanPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this ProductRatePlanPagedMetadata. - :rtype: list[ProductRatePlan] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this ProductRatePlanPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this ProductRatePlanPagedMetadata. - :type: list[ProductRatePlan] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/product_rate_plan_payments_result_paged_metadata.py b/billforward/models/product_rate_plan_payments_result_paged_metadata.py deleted file mode 100644 index 7cfff53..0000000 --- a/billforward/models/product_rate_plan_payments_result_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class ProductRatePlanPaymentsResultPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - ProductRatePlanPaymentsResultPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this ProductRatePlanPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this ProductRatePlanPaymentsResultPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this ProductRatePlanPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this ProductRatePlanPaymentsResultPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this ProductRatePlanPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this ProductRatePlanPaymentsResultPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this ProductRatePlanPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this ProductRatePlanPaymentsResultPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this ProductRatePlanPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this ProductRatePlanPaymentsResultPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this ProductRatePlanPaymentsResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this ProductRatePlanPaymentsResultPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this ProductRatePlanPaymentsResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this ProductRatePlanPaymentsResultPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this ProductRatePlanPaymentsResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this ProductRatePlanPaymentsResultPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this ProductRatePlanPaymentsResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this ProductRatePlanPaymentsResultPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this ProductRatePlanPaymentsResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this ProductRatePlanPaymentsResultPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this ProductRatePlanPaymentsResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this ProductRatePlanPaymentsResultPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this ProductRatePlanPaymentsResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this ProductRatePlanPaymentsResultPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this ProductRatePlanPaymentsResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this ProductRatePlanPaymentsResultPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this ProductRatePlanPaymentsResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this ProductRatePlanPaymentsResultPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/profile.py b/billforward/models/profile.py index 4b5c40b..8ef5721 100644 --- a/billforward/models/profile.py +++ b/billforward/models/profile.py @@ -1,124 +1,166 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class Profile(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, organization_id=None, email=None, first_name=None, last_name=None, company_name=None, logo_url=None, addresses=None, mobile=None, landline=None, fax=None, dob=None, vat_number=None, additional_information=None): - """ - Profile - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'account_id': 'str', - 'organization_id': 'str', - 'email': 'str', - 'first_name': 'str', - 'last_name': 'str', - 'company_name': 'str', - 'logo_url': 'str', - 'addresses': 'list[Address]', - 'mobile': 'str', - 'landline': 'str', - 'fax': 'str', - 'dob': 'datetime', - 'vat_number': 'str', - 'additional_information': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'account_id': 'accountID', - 'organization_id': 'organizationID', - 'email': 'email', - 'first_name': 'firstName', - 'last_name': 'lastName', - 'company_name': 'companyName', - 'logo_url': 'logoURL', - 'addresses': 'addresses', - 'mobile': 'mobile', - 'landline': 'landline', - 'fax': 'fax', - 'dob': 'dob', - 'vat_number': 'vatNumber', - 'additional_information': 'additionalInformation' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._account_id = account_id - self._organization_id = organization_id - self._email = email - self._first_name = first_name - self._last_name = last_name - self._company_name = company_name - self._logo_url = logo_url - self._addresses = addresses - self._mobile = mobile - self._landline = landline - self._fax = fax - self._dob = dob - self._vat_number = vat_number - self._additional_information = additional_information + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'account_id': 'str', + 'organization_id': 'str', + 'email': 'str', + 'first_name': 'str', + 'last_name': 'str', + 'company_name': 'str', + 'logo_url': 'str', + 'addresses': 'list[Address]', + 'mobile': 'str', + 'landline': 'str', + 'fax': 'str', + 'dob': 'datetime', + 'vat_number': 'str', + 'additional_emails': 'str', + 'additional_information': 'str', + 'correspondence_language': 'str', + 'ava_tax_customer_usage_type': 'str', + 'apply_tax': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'account_id': 'accountID', + 'organization_id': 'organizationID', + 'email': 'email', + 'first_name': 'firstName', + 'last_name': 'lastName', + 'company_name': 'companyName', + 'logo_url': 'logoURL', + 'addresses': 'addresses', + 'mobile': 'mobile', + 'landline': 'landline', + 'fax': 'fax', + 'dob': 'dob', + 'vat_number': 'vatNumber', + 'additional_emails': 'additionalEmails', + 'additional_information': 'additionalInformation', + 'correspondence_language': 'correspondenceLanguage', + 'ava_tax_customer_usage_type': 'avaTaxCustomerUsageType', + 'apply_tax': 'applyTax' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, organization_id=None, email=None, first_name=None, last_name=None, company_name=None, logo_url=None, addresses=None, mobile=None, landline=None, fax=None, dob=None, vat_number=None, additional_emails=None, additional_information=None, correspondence_language=None, ava_tax_customer_usage_type=None, apply_tax=None): # noqa: E501 + """Profile - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._account_id = None + self._organization_id = None + self._email = None + self._first_name = None + self._last_name = None + self._company_name = None + self._logo_url = None + self._addresses = None + self._mobile = None + self._landline = None + self._fax = None + self._dob = None + self._vat_number = None + self._additional_emails = None + self._additional_information = None + self._correspondence_language = None + self._ava_tax_customer_usage_type = None + self._apply_tax = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.account_id = account_id + self.organization_id = organization_id + if email is not None: + self.email = email + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if company_name is not None: + self.company_name = company_name + if logo_url is not None: + self.logo_url = logo_url + if addresses is not None: + self.addresses = addresses + if mobile is not None: + self.mobile = mobile + if landline is not None: + self.landline = landline + if fax is not None: + self.fax = fax + if dob is not None: + self.dob = dob + if vat_number is not None: + self.vat_number = vat_number + if additional_emails is not None: + self.additional_emails = additional_emails + if additional_information is not None: + self.additional_information = additional_information + if correspondence_language is not None: + self.correspondence_language = correspondence_language + if ava_tax_customer_usage_type is not None: + self.ava_tax_customer_usage_type = ava_tax_customer_usage_type + if apply_tax is not None: + self.apply_tax = apply_tax @property def created(self): - """ - Gets the created of this Profile. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this Profile. # noqa: E501 + - :return: The created of this Profile. + :return: The created of this Profile. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this Profile. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this Profile. + - :param created: The created of this Profile. + :param created: The created of this Profile. # noqa: E501 :type: datetime """ @@ -126,22 +168,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this Profile. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this Profile. # noqa: E501 + - :return: The changed_by of this Profile. + :return: The changed_by of this Profile. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this Profile. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this Profile. - :param changed_by: The changed_by of this Profile. + + :param changed_by: The changed_by of this Profile. # noqa: E501 :type: str """ @@ -149,22 +189,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this Profile. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this Profile. # noqa: E501 - :return: The updated of this Profile. + + :return: The updated of this Profile. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this Profile. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this Profile. - :param updated: The updated of this Profile. + + :param updated: The updated of this Profile. # noqa: E501 :type: datetime """ @@ -172,22 +210,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this Profile. - { \"description\" : \"ID of the profile.\", \"verbs\":[\"PUT\",\"GET\"] } + """Gets the id of this Profile. # noqa: E501 - :return: The id of this Profile. + + :return: The id of this Profile. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this Profile. - { \"description\" : \"ID of the profile.\", \"verbs\":[\"PUT\",\"GET\"] } + """Sets the id of this Profile. + - :param id: The id of this Profile. + :param id: The id of this Profile. # noqa: E501 :type: str """ @@ -195,68 +231,66 @@ def id(self, id): @property def account_id(self): - """ - Gets the account_id of this Profile. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the account_id of this Profile. # noqa: E501 + - :return: The account_id of this Profile. + :return: The account_id of this Profile. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this Profile. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the account_id of this Profile. + - :param account_id: The account_id of this Profile. + :param account_id: The account_id of this Profile. # noqa: E501 :type: str """ + if account_id is None: + raise ValueError("Invalid value for `account_id`, must not be `None`") # noqa: E501 self._account_id = account_id @property def organization_id(self): - """ - Gets the organization_id of this Profile. - { \"description\" : \"\", \"verbs\":[] } + """Gets the organization_id of this Profile. # noqa: E501 - :return: The organization_id of this Profile. + + :return: The organization_id of this Profile. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this Profile. - { \"description\" : \"\", \"verbs\":[] } + """Sets the organization_id of this Profile. - :param organization_id: The organization_id of this Profile. + + :param organization_id: The organization_id of this Profile. # noqa: E501 :type: str """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 self._organization_id = organization_id @property def email(self): - """ - Gets the email of this Profile. - { \"description\" : \"E-mail address\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the email of this Profile. # noqa: E501 + - :return: The email of this Profile. + :return: The email of this Profile. # noqa: E501 :rtype: str """ return self._email @email.setter def email(self, email): - """ - Sets the email of this Profile. - { \"description\" : \"E-mail address\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the email of this Profile. + - :param email: The email of this Profile. + :param email: The email of this Profile. # noqa: E501 :type: str """ @@ -264,22 +298,20 @@ def email(self, email): @property def first_name(self): - """ - Gets the first_name of this Profile. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the first_name of this Profile. # noqa: E501 + - :return: The first_name of this Profile. + :return: The first_name of this Profile. # noqa: E501 :rtype: str """ return self._first_name @first_name.setter def first_name(self, first_name): - """ - Sets the first_name of this Profile. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the first_name of this Profile. + - :param first_name: The first_name of this Profile. + :param first_name: The first_name of this Profile. # noqa: E501 :type: str """ @@ -287,22 +319,20 @@ def first_name(self, first_name): @property def last_name(self): - """ - Gets the last_name of this Profile. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the last_name of this Profile. # noqa: E501 + - :return: The last_name of this Profile. + :return: The last_name of this Profile. # noqa: E501 :rtype: str """ return self._last_name @last_name.setter def last_name(self, last_name): - """ - Sets the last_name of this Profile. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the last_name of this Profile. - :param last_name: The last_name of this Profile. + + :param last_name: The last_name of this Profile. # noqa: E501 :type: str """ @@ -310,22 +340,20 @@ def last_name(self, last_name): @property def company_name(self): - """ - Gets the company_name of this Profile. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the company_name of this Profile. # noqa: E501 - :return: The company_name of this Profile. + + :return: The company_name of this Profile. # noqa: E501 :rtype: str """ return self._company_name @company_name.setter def company_name(self, company_name): - """ - Sets the company_name of this Profile. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the company_name of this Profile. + - :param company_name: The company_name of this Profile. + :param company_name: The company_name of this Profile. # noqa: E501 :type: str """ @@ -333,22 +361,20 @@ def company_name(self, company_name): @property def logo_url(self): - """ - Gets the logo_url of this Profile. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the logo_url of this Profile. # noqa: E501 + - :return: The logo_url of this Profile. + :return: The logo_url of this Profile. # noqa: E501 :rtype: str """ return self._logo_url @logo_url.setter def logo_url(self, logo_url): - """ - Sets the logo_url of this Profile. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the logo_url of this Profile. + - :param logo_url: The logo_url of this Profile. + :param logo_url: The logo_url of this Profile. # noqa: E501 :type: str """ @@ -356,22 +382,20 @@ def logo_url(self, logo_url): @property def addresses(self): - """ - Gets the addresses of this Profile. - { \"description\" : \"Address associated with the profile\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the addresses of this Profile. # noqa: E501 - :return: The addresses of this Profile. + + :return: The addresses of this Profile. # noqa: E501 :rtype: list[Address] """ return self._addresses @addresses.setter def addresses(self, addresses): - """ - Sets the addresses of this Profile. - { \"description\" : \"Address associated with the profile\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the addresses of this Profile. - :param addresses: The addresses of this Profile. + + :param addresses: The addresses of this Profile. # noqa: E501 :type: list[Address] """ @@ -379,22 +403,20 @@ def addresses(self, addresses): @property def mobile(self): - """ - Gets the mobile of this Profile. - { \"description\" : \"Mobile telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the mobile of this Profile. # noqa: E501 - :return: The mobile of this Profile. + + :return: The mobile of this Profile. # noqa: E501 :rtype: str """ return self._mobile @mobile.setter def mobile(self, mobile): - """ - Sets the mobile of this Profile. - { \"description\" : \"Mobile telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the mobile of this Profile. - :param mobile: The mobile of this Profile. + + :param mobile: The mobile of this Profile. # noqa: E501 :type: str """ @@ -402,22 +424,20 @@ def mobile(self, mobile): @property def landline(self): - """ - Gets the landline of this Profile. - { \"description\" : \"Home telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the landline of this Profile. # noqa: E501 + - :return: The landline of this Profile. + :return: The landline of this Profile. # noqa: E501 :rtype: str """ return self._landline @landline.setter def landline(self, landline): - """ - Sets the landline of this Profile. - { \"description\" : \"Home telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the landline of this Profile. + - :param landline: The landline of this Profile. + :param landline: The landline of this Profile. # noqa: E501 :type: str """ @@ -425,22 +445,20 @@ def landline(self, landline): @property def fax(self): - """ - Gets the fax of this Profile. - { \"description\" : \"Fax number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the fax of this Profile. # noqa: E501 + - :return: The fax of this Profile. + :return: The fax of this Profile. # noqa: E501 :rtype: str """ return self._fax @fax.setter def fax(self, fax): - """ - Sets the fax of this Profile. - { \"description\" : \"Fax number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the fax of this Profile. - :param fax: The fax of this Profile. + + :param fax: The fax of this Profile. # noqa: E501 :type: str """ @@ -448,22 +466,20 @@ def fax(self, fax): @property def dob(self): - """ - Gets the dob of this Profile. - { \"description\" : \"Date of birth in YYYY-MM-DD format\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the dob of this Profile. # noqa: E501 - :return: The dob of this Profile. + + :return: The dob of this Profile. # noqa: E501 :rtype: datetime """ return self._dob @dob.setter def dob(self, dob): - """ - Sets the dob of this Profile. - { \"description\" : \"Date of birth in YYYY-MM-DD format\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the dob of this Profile. + - :param dob: The dob of this Profile. + :param dob: The dob of this Profile. # noqa: E501 :type: datetime """ @@ -471,57 +487,135 @@ def dob(self, dob): @property def vat_number(self): - """ - Gets the vat_number of this Profile. - { \"description\" : \"VAT number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the vat_number of this Profile. # noqa: E501 + - :return: The vat_number of this Profile. + :return: The vat_number of this Profile. # noqa: E501 :rtype: str """ return self._vat_number @vat_number.setter def vat_number(self, vat_number): - """ - Sets the vat_number of this Profile. - { \"description\" : \"VAT number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the vat_number of this Profile. + - :param vat_number: The vat_number of this Profile. + :param vat_number: The vat_number of this Profile. # noqa: E501 :type: str """ self._vat_number = vat_number @property - def additional_information(self): + def additional_emails(self): + """Gets the additional_emails of this Profile. # noqa: E501 + + + :return: The additional_emails of this Profile. # noqa: E501 + :rtype: str + """ + return self._additional_emails + + @additional_emails.setter + def additional_emails(self, additional_emails): + """Sets the additional_emails of this Profile. + + + :param additional_emails: The additional_emails of this Profile. # noqa: E501 + :type: str """ - Gets the additional_information of this Profile. - { \"description\" : \"Any additional information\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - :return: The additional_information of this Profile. + self._additional_emails = additional_emails + + @property + def additional_information(self): + """Gets the additional_information of this Profile. # noqa: E501 + + + :return: The additional_information of this Profile. # noqa: E501 :rtype: str """ return self._additional_information @additional_information.setter def additional_information(self, additional_information): - """ - Sets the additional_information of this Profile. - { \"description\" : \"Any additional information\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the additional_information of this Profile. - :param additional_information: The additional_information of this Profile. + + :param additional_information: The additional_information of this Profile. # noqa: E501 :type: str """ self._additional_information = additional_information - def to_dict(self): + @property + def correspondence_language(self): + """Gets the correspondence_language of this Profile. # noqa: E501 + + + :return: The correspondence_language of this Profile. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._correspondence_language + + @correspondence_language.setter + def correspondence_language(self, correspondence_language): + """Sets the correspondence_language of this Profile. + + + :param correspondence_language: The correspondence_language of this Profile. # noqa: E501 + :type: str + """ + + self._correspondence_language = correspondence_language + + @property + def ava_tax_customer_usage_type(self): + """Gets the ava_tax_customer_usage_type of this Profile. # noqa: E501 + + + :return: The ava_tax_customer_usage_type of this Profile. # noqa: E501 + :rtype: str + """ + return self._ava_tax_customer_usage_type + + @ava_tax_customer_usage_type.setter + def ava_tax_customer_usage_type(self, ava_tax_customer_usage_type): + """Sets the ava_tax_customer_usage_type of this Profile. + + + :param ava_tax_customer_usage_type: The ava_tax_customer_usage_type of this Profile. # noqa: E501 + :type: str + """ + + self._ava_tax_customer_usage_type = ava_tax_customer_usage_type + + @property + def apply_tax(self): + """Gets the apply_tax of this Profile. # noqa: E501 + + + :return: The apply_tax of this Profile. # noqa: E501 + :rtype: bool + """ + return self._apply_tax + + @apply_tax.setter + def apply_tax(self, apply_tax): + """Sets the apply_tax of this Profile. + + + :param apply_tax: The apply_tax of this Profile. # noqa: E501 + :type: bool """ + + self._apply_tax = apply_tax + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -538,29 +632,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Profile, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Profile): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/profile_paged_metadata.py b/billforward/models/profile_paged_metadata.py deleted file mode 100644 index 0284b7b..0000000 --- a/billforward/models/profile_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class ProfilePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - ProfilePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Profile]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this ProfilePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this ProfilePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this ProfilePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this ProfilePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this ProfilePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this ProfilePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this ProfilePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this ProfilePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this ProfilePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this ProfilePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this ProfilePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this ProfilePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this ProfilePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this ProfilePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this ProfilePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this ProfilePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this ProfilePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this ProfilePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this ProfilePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this ProfilePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this ProfilePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this ProfilePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this ProfilePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this ProfilePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this ProfilePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this ProfilePagedMetadata. - :rtype: list[Profile] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this ProfilePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this ProfilePagedMetadata. - :type: list[Profile] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/public_configuration_response.py b/billforward/models/public_configuration_response.py new file mode 100644 index 0000000..c744bc3 --- /dev/null +++ b/billforward/models/public_configuration_response.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class PublicConfigurationResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'square_app_id': 'str', + 'square_o_auth_url': 'str', + 'stripe_client_id': 'str' + } + + attribute_map = { + 'square_app_id': 'squareAppID', + 'square_o_auth_url': 'squareOAuthUrl', + 'stripe_client_id': 'stripeClientId' + } + + def __init__(self, square_app_id=None, square_o_auth_url=None, stripe_client_id=None): # noqa: E501 + """PublicConfigurationResponse - a model defined in Swagger""" # noqa: E501 + self._square_app_id = None + self._square_o_auth_url = None + self._stripe_client_id = None + self.discriminator = None + if square_app_id is not None: + self.square_app_id = square_app_id + if square_o_auth_url is not None: + self.square_o_auth_url = square_o_auth_url + if stripe_client_id is not None: + self.stripe_client_id = stripe_client_id + + @property + def square_app_id(self): + """Gets the square_app_id of this PublicConfigurationResponse. # noqa: E501 + + + :return: The square_app_id of this PublicConfigurationResponse. # noqa: E501 + :rtype: str + """ + return self._square_app_id + + @square_app_id.setter + def square_app_id(self, square_app_id): + """Sets the square_app_id of this PublicConfigurationResponse. + + + :param square_app_id: The square_app_id of this PublicConfigurationResponse. # noqa: E501 + :type: str + """ + + self._square_app_id = square_app_id + + @property + def square_o_auth_url(self): + """Gets the square_o_auth_url of this PublicConfigurationResponse. # noqa: E501 + + + :return: The square_o_auth_url of this PublicConfigurationResponse. # noqa: E501 + :rtype: str + """ + return self._square_o_auth_url + + @square_o_auth_url.setter + def square_o_auth_url(self, square_o_auth_url): + """Sets the square_o_auth_url of this PublicConfigurationResponse. + + + :param square_o_auth_url: The square_o_auth_url of this PublicConfigurationResponse. # noqa: E501 + :type: str + """ + + self._square_o_auth_url = square_o_auth_url + + @property + def stripe_client_id(self): + """Gets the stripe_client_id of this PublicConfigurationResponse. # noqa: E501 + + + :return: The stripe_client_id of this PublicConfigurationResponse. # noqa: E501 + :rtype: str + """ + return self._stripe_client_id + + @stripe_client_id.setter + def stripe_client_id(self, stripe_client_id): + """Sets the stripe_client_id of this PublicConfigurationResponse. + + + :param stripe_client_id: The stripe_client_id of this PublicConfigurationResponse. # noqa: E501 + :type: str + """ + + self._stripe_client_id = stripe_client_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(PublicConfigurationResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, PublicConfigurationResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/quote_request.py b/billforward/models/quote_request.py index 51569e0..2f2be9f 100644 --- a/billforward/models/quote_request.py +++ b/billforward/models/quote_request.py @@ -1,288 +1,339 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class QuoteRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, product=None, product_rate_plan=None, account_id=None, subscription_id=None, subscription_version_id=None, quote_for=None, prorated=False, free=False, include_applied_coupons=False, period_start=None, period_end=None, remaining_credit_behaviour=None, quantities=None, coupon_codes=None, pricing_behaviour=None): - """ - QuoteRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'product': 'str', - 'product_rate_plan': 'str', - 'account_id': 'str', - 'subscription_id': 'str', - 'subscription_version_id': 'str', - 'quote_for': 'str', - 'prorated': 'bool', - 'free': 'bool', - 'include_applied_coupons': 'bool', - 'period_start': 'datetime', - 'period_end': 'datetime', - 'remaining_credit_behaviour': 'str', - 'quantities': 'list[QuoteRequestValue]', - 'coupon_codes': 'list[str]', - 'pricing_behaviour': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'product': 'product', - 'product_rate_plan': 'productRatePlan', - 'account_id': 'accountID', - 'subscription_id': 'subscriptionID', - 'subscription_version_id': 'subscriptionVersionID', - 'quote_for': 'quoteFor', - 'prorated': 'prorated', - 'free': 'free', - 'include_applied_coupons': 'includeAppliedCoupons', - 'period_start': 'periodStart', - 'period_end': 'periodEnd', - 'remaining_credit_behaviour': 'remainingCreditBehaviour', - 'quantities': 'quantities', - 'coupon_codes': 'couponCodes', - 'pricing_behaviour': 'pricingBehaviour' - } - - self._created = created - self._changed_by = changed_by - self._product = product - self._product_rate_plan = product_rate_plan - self._account_id = account_id - self._subscription_id = subscription_id - self._subscription_version_id = subscription_version_id - self._quote_for = quote_for - self._prorated = prorated - self._free = free - self._include_applied_coupons = include_applied_coupons - self._period_start = period_start - self._period_end = period_end - self._remaining_credit_behaviour = remaining_credit_behaviour - self._quantities = quantities - self._coupon_codes = coupon_codes - self._pricing_behaviour = pricing_behaviour + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'product': 'str', + 'product_rate_plan': 'str', + 'product_id': 'str', + 'product_name': 'str', + 'product_rate_plan_name': 'str', + 'account_id': 'str', + 'organization_id': 'str', + 'subscription_id': 'str', + 'quote_for': 'str', + 'prorated': 'bool', + 'free': 'bool', + 'include_applied_coupons': 'bool', + 'period_start': 'datetime', + 'period_end': 'datetime', + 'remaining_credit_behaviour': 'str', + 'quantities': 'list[QuoteRequestValue]', + 'coupon_codes': 'list[str]', + 'store_quote': 'bool', + 'pricing_behaviour': 'str', + 'purchase_order': 'str', + 'type': 'str', + 'pricing_components': 'list[QuoteRequestValue]' + } + + attribute_map = { + 'product': 'product', + 'product_rate_plan': 'productRatePlan', + 'product_id': 'productID', + 'product_name': 'productName', + 'product_rate_plan_name': 'productRatePlanName', + 'account_id': 'accountID', + 'organization_id': 'organizationID', + 'subscription_id': 'subscriptionID', + 'quote_for': 'quoteFor', + 'prorated': 'prorated', + 'free': 'free', + 'include_applied_coupons': 'includeAppliedCoupons', + 'period_start': 'periodStart', + 'period_end': 'periodEnd', + 'remaining_credit_behaviour': 'remainingCreditBehaviour', + 'quantities': 'quantities', + 'coupon_codes': 'couponCodes', + 'store_quote': 'storeQuote', + 'pricing_behaviour': 'pricingBehaviour', + 'purchase_order': 'purchaseOrder', + 'type': 'type', + 'pricing_components': 'pricingComponents' + } + + def __init__(self, product=None, product_rate_plan=None, product_id=None, product_name=None, product_rate_plan_name=None, account_id=None, organization_id=None, subscription_id=None, quote_for=None, prorated=None, free=None, include_applied_coupons=None, period_start=None, period_end=None, remaining_credit_behaviour=None, quantities=None, coupon_codes=None, store_quote=None, pricing_behaviour=None, purchase_order=None, type=None, pricing_components=None): # noqa: E501 + """QuoteRequest - a model defined in Swagger""" # noqa: E501 + self._product = None + self._product_rate_plan = None + self._product_id = None + self._product_name = None + self._product_rate_plan_name = None + self._account_id = None + self._organization_id = None + self._subscription_id = None + self._quote_for = None + self._prorated = None + self._free = None + self._include_applied_coupons = None + self._period_start = None + self._period_end = None + self._remaining_credit_behaviour = None + self._quantities = None + self._coupon_codes = None + self._store_quote = None + self._pricing_behaviour = None + self._purchase_order = None + self._type = None + self._pricing_components = None + self.discriminator = None + if product is not None: + self.product = product + if product_rate_plan is not None: + self.product_rate_plan = product_rate_plan + if product_id is not None: + self.product_id = product_id + if product_name is not None: + self.product_name = product_name + if product_rate_plan_name is not None: + self.product_rate_plan_name = product_rate_plan_name + if account_id is not None: + self.account_id = account_id + if organization_id is not None: + self.organization_id = organization_id + if subscription_id is not None: + self.subscription_id = subscription_id + if quote_for is not None: + self.quote_for = quote_for + if prorated is not None: + self.prorated = prorated + if free is not None: + self.free = free + if include_applied_coupons is not None: + self.include_applied_coupons = include_applied_coupons + if period_start is not None: + self.period_start = period_start + self.period_end = period_end + self.remaining_credit_behaviour = remaining_credit_behaviour + if quantities is not None: + self.quantities = quantities + if coupon_codes is not None: + self.coupon_codes = coupon_codes + if store_quote is not None: + self.store_quote = store_quote + self.pricing_behaviour = pricing_behaviour + if purchase_order is not None: + self.purchase_order = purchase_order + if type is not None: + self.type = type + if pricing_components is not None: + self.pricing_components = pricing_components @property - def created(self): + def product(self): + """Gets the product of this QuoteRequest. # noqa: E501 + + + :return: The product of this QuoteRequest. # noqa: E501 + :rtype: str """ - Gets the created of this QuoteRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + return self._product - :return: The created of this QuoteRequest. - :rtype: datetime + @product.setter + def product(self, product): + """Sets the product of this QuoteRequest. + + + :param product: The product of this QuoteRequest. # noqa: E501 + :type: str """ - return self._created - @created.setter - def created(self, created): + self._product = product + + @property + def product_rate_plan(self): + """Gets the product_rate_plan of this QuoteRequest. # noqa: E501 + + + :return: The product_rate_plan of this QuoteRequest. # noqa: E501 + :rtype: str """ - Sets the created of this QuoteRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + return self._product_rate_plan - :param created: The created of this QuoteRequest. - :type: datetime + @product_rate_plan.setter + def product_rate_plan(self, product_rate_plan): + """Sets the product_rate_plan of this QuoteRequest. + + + :param product_rate_plan: The product_rate_plan of this QuoteRequest. # noqa: E501 + :type: str """ - self._created = created + self._product_rate_plan = product_rate_plan @property - def changed_by(self): - """ - Gets the changed_by of this QuoteRequest. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + def product_id(self): + """Gets the product_id of this QuoteRequest. # noqa: E501 - :return: The changed_by of this QuoteRequest. + + :return: The product_id of this QuoteRequest. # noqa: E501 :rtype: str """ - return self._changed_by + return self._product_id + + @product_id.setter + def product_id(self, product_id): + """Sets the product_id of this QuoteRequest. - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this QuoteRequest. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - :param changed_by: The changed_by of this QuoteRequest. + :param product_id: The product_id of this QuoteRequest. # noqa: E501 :type: str """ - self._changed_by = changed_by + self._product_id = product_id @property - def product(self): - """ - Gets the product of this QuoteRequest. - {\"description\":\"The product for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + def product_name(self): + """Gets the product_name of this QuoteRequest. # noqa: E501 + - :return: The product of this QuoteRequest. + :return: The product_name of this QuoteRequest. # noqa: E501 :rtype: str """ - return self._product + return self._product_name + + @product_name.setter + def product_name(self, product_name): + """Sets the product_name of this QuoteRequest. - @product.setter - def product(self, product): - """ - Sets the product of this QuoteRequest. - {\"description\":\"The product for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} - :param product: The product of this QuoteRequest. + :param product_name: The product_name of this QuoteRequest. # noqa: E501 :type: str """ - self._product = product + self._product_name = product_name @property - def product_rate_plan(self): - """ - Gets the product_rate_plan of this QuoteRequest. - {\"description\":\"The rate plan (of some product) for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + def product_rate_plan_name(self): + """Gets the product_rate_plan_name of this QuoteRequest. # noqa: E501 + - :return: The product_rate_plan of this QuoteRequest. + :return: The product_rate_plan_name of this QuoteRequest. # noqa: E501 :rtype: str """ - return self._product_rate_plan + return self._product_rate_plan_name + + @product_rate_plan_name.setter + def product_rate_plan_name(self, product_rate_plan_name): + """Sets the product_rate_plan_name of this QuoteRequest. - @product_rate_plan.setter - def product_rate_plan(self, product_rate_plan): - """ - Sets the product_rate_plan of this QuoteRequest. - {\"description\":\"The rate plan (of some product) for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} - :param product_rate_plan: The product_rate_plan of this QuoteRequest. + :param product_rate_plan_name: The product_rate_plan_name of this QuoteRequest. # noqa: E501 :type: str """ - self._product_rate_plan = product_rate_plan + self._product_rate_plan_name = product_rate_plan_name @property def account_id(self): - """ - Gets the account_id of this QuoteRequest. - {\"description\":\"ID of the account for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the account_id of this QuoteRequest. # noqa: E501 + - :return: The account_id of this QuoteRequest. + :return: The account_id of this QuoteRequest. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this QuoteRequest. - {\"description\":\"ID of the account for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the account_id of this QuoteRequest. - :param account_id: The account_id of this QuoteRequest. + + :param account_id: The account_id of this QuoteRequest. # noqa: E501 :type: str """ self._account_id = account_id @property - def subscription_id(self): - """ - Gets the subscription_id of this QuoteRequest. - {\"description\":\"ID of the subscription for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + def organization_id(self): + """Gets the organization_id of this QuoteRequest. # noqa: E501 - :return: The subscription_id of this QuoteRequest. + + :return: The organization_id of this QuoteRequest. # noqa: E501 :rtype: str """ - return self._subscription_id + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this QuoteRequest. - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this QuoteRequest. - {\"description\":\"ID of the subscription for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} - :param subscription_id: The subscription_id of this QuoteRequest. + :param organization_id: The organization_id of this QuoteRequest. # noqa: E501 :type: str """ - self._subscription_id = subscription_id + self._organization_id = organization_id @property - def subscription_version_id(self): - """ - Gets the subscription_version_id of this QuoteRequest. - {\"description\":\"version ID of the subscription for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} + def subscription_id(self): + """Gets the subscription_id of this QuoteRequest. # noqa: E501 - :return: The subscription_version_id of this QuoteRequest. + + :return: The subscription_id of this QuoteRequest. # noqa: E501 :rtype: str """ - return self._subscription_version_id + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this QuoteRequest. - @subscription_version_id.setter - def subscription_version_id(self, subscription_version_id): - """ - Sets the subscription_version_id of this QuoteRequest. - {\"description\":\"version ID of the subscription for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} - :param subscription_version_id: The subscription_version_id of this QuoteRequest. + :param subscription_id: The subscription_id of this QuoteRequest. # noqa: E501 :type: str """ - self._subscription_version_id = subscription_version_id + self._subscription_id = subscription_id @property def quote_for(self): - """ - Gets the quote_for of this QuoteRequest. - {\"default\":\"RecurringPeriod\",\"description\":\"Subscription scenario with which the quote is concerned.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the quote_for of this QuoteRequest. # noqa: E501 + - :return: The quote_for of this QuoteRequest. + :return: The quote_for of this QuoteRequest. # noqa: E501 :rtype: str """ return self._quote_for @quote_for.setter def quote_for(self, quote_for): - """ - Sets the quote_for of this QuoteRequest. - {\"default\":\"RecurringPeriod\",\"description\":\"Subscription scenario with which the quote is concerned.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the quote_for of this QuoteRequest. + - :param quote_for: The quote_for of this QuoteRequest. + :param quote_for: The quote_for of this QuoteRequest. # noqa: E501 :type: str """ - allowed_values = ["InitialPeriod", "RecurringPeriod", "Upgrade", "Migration"] + allowed_values = ["InitialPeriod", "RecurringPeriod", "Upgrade", "Migration"] # noqa: E501 if quote_for not in allowed_values: raise ValueError( - "Invalid value for `quote_for` ({0}), must be one of {1}" + "Invalid value for `quote_for` ({0}), must be one of {1}" # noqa: E501 .format(quote_for, allowed_values) ) @@ -290,22 +341,20 @@ def quote_for(self, quote_for): @property def prorated(self): - """ - Gets the prorated of this QuoteRequest. - {\"default\":true,\"description\":\"Whether or not to pro-rate the price (if the quote concerns a time interval containing a partial period).\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the prorated of this QuoteRequest. # noqa: E501 + - :return: The prorated of this QuoteRequest. + :return: The prorated of this QuoteRequest. # noqa: E501 :rtype: bool """ return self._prorated @prorated.setter def prorated(self, prorated): - """ - Sets the prorated of this QuoteRequest. - {\"default\":true,\"description\":\"Whether or not to pro-rate the price (if the quote concerns a time interval containing a partial period).\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the prorated of this QuoteRequest. - :param prorated: The prorated of this QuoteRequest. + + :param prorated: The prorated of this QuoteRequest. # noqa: E501 :type: bool """ @@ -313,22 +362,20 @@ def prorated(self, prorated): @property def free(self): - """ - Gets the free of this QuoteRequest. - {\"default\":false,\"description\":\"Whether or not to present a waived final price in the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the free of this QuoteRequest. # noqa: E501 + - :return: The free of this QuoteRequest. + :return: The free of this QuoteRequest. # noqa: E501 :rtype: bool """ return self._free @free.setter def free(self, free): - """ - Sets the free of this QuoteRequest. - {\"default\":false,\"description\":\"Whether or not to present a waived final price in the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the free of this QuoteRequest. + - :param free: The free of this QuoteRequest. + :param free: The free of this QuoteRequest. # noqa: E501 :type: bool """ @@ -336,22 +383,20 @@ def free(self, free): @property def include_applied_coupons(self): - """ - Gets the include_applied_coupons of this QuoteRequest. - {\"default\":true,\"description\":\"Whether or not to include coupons which have already been applied to the subscription.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the include_applied_coupons of this QuoteRequest. # noqa: E501 - :return: The include_applied_coupons of this QuoteRequest. + + :return: The include_applied_coupons of this QuoteRequest. # noqa: E501 :rtype: bool """ return self._include_applied_coupons @include_applied_coupons.setter def include_applied_coupons(self, include_applied_coupons): - """ - Sets the include_applied_coupons of this QuoteRequest. - {\"default\":true,\"description\":\"Whether or not to include coupons which have already been applied to the subscription.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the include_applied_coupons of this QuoteRequest. + - :param include_applied_coupons: The include_applied_coupons of this QuoteRequest. + :param include_applied_coupons: The include_applied_coupons of this QuoteRequest. # noqa: E501 :type: bool """ @@ -359,22 +404,20 @@ def include_applied_coupons(self, include_applied_coupons): @property def period_start(self): - """ - Gets the period_start of this QuoteRequest. - {\"default\":\"(Now)\",\"description\":\"The time-beginning of the interval with which the quote is concerned. This can be used to request a quote across partial or multiple periods — potentially pro-rating its price.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the period_start of this QuoteRequest. # noqa: E501 + - :return: The period_start of this QuoteRequest. + :return: The period_start of this QuoteRequest. # noqa: E501 :rtype: datetime """ return self._period_start @period_start.setter def period_start(self, period_start): - """ - Sets the period_start of this QuoteRequest. - {\"default\":\"(Now)\",\"description\":\"The time-beginning of the interval with which the quote is concerned. This can be used to request a quote across partial or multiple periods — potentially pro-rating its price.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the period_start of this QuoteRequest. - :param period_start: The period_start of this QuoteRequest. + + :param period_start: The period_start of this QuoteRequest. # noqa: E501 :type: datetime """ @@ -382,51 +425,51 @@ def period_start(self, period_start): @property def period_end(self): - """ - Gets the period_end of this QuoteRequest. - {\"default\":\"(End of current period)\",\"description\":\"The time-ending of the interval with which the quote is concerned. This can be used to request a quote across partial or multiple periods — potentially pro-rating its price.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the period_end of this QuoteRequest. # noqa: E501 + - :return: The period_end of this QuoteRequest. + :return: The period_end of this QuoteRequest. # noqa: E501 :rtype: datetime """ return self._period_end @period_end.setter def period_end(self, period_end): - """ - Sets the period_end of this QuoteRequest. - {\"default\":\"(End of current period)\",\"description\":\"The time-ending of the interval with which the quote is concerned. This can be used to request a quote across partial or multiple periods — potentially pro-rating its price.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the period_end of this QuoteRequest. + - :param period_end: The period_end of this QuoteRequest. + :param period_end: The period_end of this QuoteRequest. # noqa: E501 :type: datetime """ + if period_end is None: + raise ValueError("Invalid value for `period_end`, must not be `None`") # noqa: E501 self._period_end = period_end @property def remaining_credit_behaviour(self): - """ - Gets the remaining_credit_behaviour of this QuoteRequest. - {\"default\":\"Rollover\",\"description\":\"Defines the behaviour applied to any outstanding credit resulting from the application of the charge..
Rollover — Outstanding credit is returned to the accounts credit pool.
Discard — Outstanding credit is lost.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the remaining_credit_behaviour of this QuoteRequest. # noqa: E501 - :return: The remaining_credit_behaviour of this QuoteRequest. + + :return: The remaining_credit_behaviour of this QuoteRequest. # noqa: E501 :rtype: str """ return self._remaining_credit_behaviour @remaining_credit_behaviour.setter def remaining_credit_behaviour(self, remaining_credit_behaviour): - """ - Sets the remaining_credit_behaviour of this QuoteRequest. - {\"default\":\"Rollover\",\"description\":\"Defines the behaviour applied to any outstanding credit resulting from the application of the charge..
Rollover — Outstanding credit is returned to the accounts credit pool.
Discard — Outstanding credit is lost.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the remaining_credit_behaviour of this QuoteRequest. + - :param remaining_credit_behaviour: The remaining_credit_behaviour of this QuoteRequest. + :param remaining_credit_behaviour: The remaining_credit_behaviour of this QuoteRequest. # noqa: E501 :type: str """ - allowed_values = ["Rollover", "Discard"] + if remaining_credit_behaviour is None: + raise ValueError("Invalid value for `remaining_credit_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["Rollover", "Discard"] # noqa: E501 if remaining_credit_behaviour not in allowed_values: raise ValueError( - "Invalid value for `remaining_credit_behaviour` ({0}), must be one of {1}" + "Invalid value for `remaining_credit_behaviour` ({0}), must be one of {1}" # noqa: E501 .format(remaining_credit_behaviour, allowed_values) ) @@ -434,22 +477,20 @@ def remaining_credit_behaviour(self, remaining_credit_behaviour): @property def quantities(self): - """ - Gets the quantities of this QuoteRequest. - {\"description\":\"A list of pricing components (and their values) to consider in calculating the quote.\",\"verbs\":[\"POST\"]} + """Gets the quantities of this QuoteRequest. # noqa: E501 + - :return: The quantities of this QuoteRequest. + :return: The quantities of this QuoteRequest. # noqa: E501 :rtype: list[QuoteRequestValue] """ return self._quantities @quantities.setter def quantities(self, quantities): - """ - Sets the quantities of this QuoteRequest. - {\"description\":\"A list of pricing components (and their values) to consider in calculating the quote.\",\"verbs\":[\"POST\"]} + """Sets the quantities of this QuoteRequest. - :param quantities: The quantities of this QuoteRequest. + + :param quantities: The quantities of this QuoteRequest. # noqa: E501 :type: list[QuoteRequestValue] """ @@ -457,63 +498,149 @@ def quantities(self, quantities): @property def coupon_codes(self): - """ - Gets the coupon_codes of this QuoteRequest. - {\"description\":\"A list of coupon codes to consider in calculating the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the coupon_codes of this QuoteRequest. # noqa: E501 + - :return: The coupon_codes of this QuoteRequest. + :return: The coupon_codes of this QuoteRequest. # noqa: E501 :rtype: list[str] """ return self._coupon_codes @coupon_codes.setter def coupon_codes(self, coupon_codes): - """ - Sets the coupon_codes of this QuoteRequest. - {\"description\":\"A list of coupon codes to consider in calculating the quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the coupon_codes of this QuoteRequest. + - :param coupon_codes: The coupon_codes of this QuoteRequest. + :param coupon_codes: The coupon_codes of this QuoteRequest. # noqa: E501 :type: list[str] """ self._coupon_codes = coupon_codes @property - def pricing_behaviour(self): + def store_quote(self): + """Gets the store_quote of this QuoteRequest. # noqa: E501 + + + :return: The store_quote of this QuoteRequest. # noqa: E501 + :rtype: bool """ - Gets the pricing_behaviour of this QuoteRequest. - { \"description\" : \"Pricing behaviour defines how migration charges are calculated. DifferenceProRated calculates the difference between in-advance charges of the existing and new rate-plan, then pro-rates based on time remaining. None sets the migration charge as zero cost. Full sets the costs as the total of the new rate-plans in-advance charges. Difference is the same calculation as DifferenceProRated but no pro-ration is applied. ProRated differs depending on two cases; when moving to a rate-plan of the same duration it pro-rates the in-advance charges of the new rate-plan. If the duration is different, a credit-note will be issued any remaining time on the existing plans billing period.\", \"default\" : \"DifferenceProRated\", \"verbs\":[\"POST\",\"GET\"] } + return self._store_quote - :return: The pricing_behaviour of this QuoteRequest. + @store_quote.setter + def store_quote(self, store_quote): + """Sets the store_quote of this QuoteRequest. + + + :param store_quote: The store_quote of this QuoteRequest. # noqa: E501 + :type: bool + """ + + self._store_quote = store_quote + + @property + def pricing_behaviour(self): + """Gets the pricing_behaviour of this QuoteRequest. # noqa: E501 + + + :return: The pricing_behaviour of this QuoteRequest. # noqa: E501 :rtype: str """ return self._pricing_behaviour @pricing_behaviour.setter def pricing_behaviour(self, pricing_behaviour): - """ - Sets the pricing_behaviour of this QuoteRequest. - { \"description\" : \"Pricing behaviour defines how migration charges are calculated. DifferenceProRated calculates the difference between in-advance charges of the existing and new rate-plan, then pro-rates based on time remaining. None sets the migration charge as zero cost. Full sets the costs as the total of the new rate-plans in-advance charges. Difference is the same calculation as DifferenceProRated but no pro-ration is applied. ProRated differs depending on two cases; when moving to a rate-plan of the same duration it pro-rates the in-advance charges of the new rate-plan. If the duration is different, a credit-note will be issued any remaining time on the existing plans billing period.\", \"default\" : \"DifferenceProRated\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the pricing_behaviour of this QuoteRequest. + - :param pricing_behaviour: The pricing_behaviour of this QuoteRequest. + :param pricing_behaviour: The pricing_behaviour of this QuoteRequest. # noqa: E501 :type: str """ - allowed_values = ["None", "Full", "Difference", "DifferenceProRated", "ProRated"] + if pricing_behaviour is None: + raise ValueError("Invalid value for `pricing_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["None", "Full", "Difference", "DifferenceProRated", "ProRated"] # noqa: E501 if pricing_behaviour not in allowed_values: raise ValueError( - "Invalid value for `pricing_behaviour` ({0}), must be one of {1}" + "Invalid value for `pricing_behaviour` ({0}), must be one of {1}" # noqa: E501 .format(pricing_behaviour, allowed_values) ) self._pricing_behaviour = pricing_behaviour - def to_dict(self): + @property + def purchase_order(self): + """Gets the purchase_order of this QuoteRequest. # noqa: E501 + + + :return: The purchase_order of this QuoteRequest. # noqa: E501 + :rtype: str + """ + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this QuoteRequest. + + + :param purchase_order: The purchase_order of this QuoteRequest. # noqa: E501 + :type: str + """ + + self._purchase_order = purchase_order + + @property + def type(self): + """Gets the type of this QuoteRequest. # noqa: E501 + + + :return: The type of this QuoteRequest. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._type + + @type.setter + def type(self, type): + """Sets the type of this QuoteRequest. + + + :param type: The type of this QuoteRequest. # noqa: E501 + :type: str """ + allowed_values = ["InitialPeriod", "RecurringPeriod", "Upgrade", "Migration"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def pricing_components(self): + """Gets the pricing_components of this QuoteRequest. # noqa: E501 + + + :return: The pricing_components of this QuoteRequest. # noqa: E501 + :rtype: list[QuoteRequestValue] + """ + return self._pricing_components + + @pricing_components.setter + def pricing_components(self, pricing_components): + """Sets the pricing_components of this QuoteRequest. + + + :param pricing_components: The pricing_components of this QuoteRequest. # noqa: E501 + :type: list[QuoteRequestValue] + """ + + self._pricing_components = pricing_components + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -530,29 +657,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(QuoteRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, QuoteRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/quote_request_value.py b/billforward/models/quote_request_value.py index 21046d5..c4f94f7 100644 --- a/billforward/models/quote_request_value.py +++ b/billforward/models/quote_request_value.py @@ -1,82 +1,78 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class QuoteRequestValue(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, pricing_component=None, quantity=None, existing_quantity=None, percentage_discount=None): - """ - QuoteRequestValue - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'pricing_component': 'str', - 'quantity': 'int', - 'existing_quantity': 'int', - 'percentage_discount': 'float' - } - - self.attribute_map = { - 'pricing_component': 'pricingComponent', - 'quantity': 'quantity', - 'existing_quantity': 'existingQuantity', - 'percentage_discount': 'percentageDiscount' - } - - self._pricing_component = pricing_component - self._quantity = quantity - self._existing_quantity = existing_quantity - self._percentage_discount = percentage_discount + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'pricing_component': 'str', + 'quantity': 'int', + 'existing_quantity': 'int', + 'percentage_discount': 'float' + } + + attribute_map = { + 'pricing_component': 'pricingComponent', + 'quantity': 'quantity', + 'existing_quantity': 'existingQuantity', + 'percentage_discount': 'percentageDiscount' + } + + def __init__(self, pricing_component=None, quantity=None, existing_quantity=None, percentage_discount=None): # noqa: E501 + """QuoteRequestValue - a model defined in Swagger""" # noqa: E501 + self._pricing_component = None + self._quantity = None + self._existing_quantity = None + self._percentage_discount = None + self.discriminator = None + if pricing_component is not None: + self.pricing_component = pricing_component + if quantity is not None: + self.quantity = quantity + if existing_quantity is not None: + self.existing_quantity = existing_quantity + if percentage_discount is not None: + self.percentage_discount = percentage_discount @property def pricing_component(self): - """ - Gets the pricing_component of this QuoteRequestValue. - {\"description\":\"Name or ID of the pricing component involved in some price quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the pricing_component of this QuoteRequestValue. # noqa: E501 - :return: The pricing_component of this QuoteRequestValue. + + :return: The pricing_component of this QuoteRequestValue. # noqa: E501 :rtype: str """ return self._pricing_component @pricing_component.setter def pricing_component(self, pricing_component): - """ - Sets the pricing_component of this QuoteRequestValue. - {\"description\":\"Name or ID of the pricing component involved in some price quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the pricing_component of this QuoteRequestValue. + - :param pricing_component: The pricing_component of this QuoteRequestValue. + :param pricing_component: The pricing_component of this QuoteRequestValue. # noqa: E501 :type: str """ @@ -84,22 +80,20 @@ def pricing_component(self, pricing_component): @property def quantity(self): - """ - Gets the quantity of this QuoteRequestValue. - {\"description\":\"Quantity consumed of the pricing component involved in some price quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the quantity of this QuoteRequestValue. # noqa: E501 + - :return: The quantity of this QuoteRequestValue. + :return: The quantity of this QuoteRequestValue. # noqa: E501 :rtype: int """ return self._quantity @quantity.setter def quantity(self, quantity): - """ - Sets the quantity of this QuoteRequestValue. - {\"description\":\"Quantity consumed of the pricing component involved in some price quote.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the quantity of this QuoteRequestValue. + - :param quantity: The quantity of this QuoteRequestValue. + :param quantity: The quantity of this QuoteRequestValue. # noqa: E501 :type: int """ @@ -107,22 +101,20 @@ def quantity(self, quantity): @property def existing_quantity(self): - """ - Gets the existing_quantity of this QuoteRequestValue. - {\"description\":\"Pre-existing value of pricing component from which the customer is transitioning. Provide this when calculating (for example) upgrade costs.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the existing_quantity of this QuoteRequestValue. # noqa: E501 - :return: The existing_quantity of this QuoteRequestValue. + + :return: The existing_quantity of this QuoteRequestValue. # noqa: E501 :rtype: int """ return self._existing_quantity @existing_quantity.setter def existing_quantity(self, existing_quantity): - """ - Sets the existing_quantity of this QuoteRequestValue. - {\"description\":\"Pre-existing value of pricing component from which the customer is transitioning. Provide this when calculating (for example) upgrade costs.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the existing_quantity of this QuoteRequestValue. + - :param existing_quantity: The existing_quantity of this QuoteRequestValue. + :param existing_quantity: The existing_quantity of this QuoteRequestValue. # noqa: E501 :type: int """ @@ -130,34 +122,30 @@ def existing_quantity(self, existing_quantity): @property def percentage_discount(self): - """ - Gets the percentage_discount of this QuoteRequestValue. - {\"description\":\"The discount percentage applied to this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the percentage_discount of this QuoteRequestValue. # noqa: E501 + - :return: The percentage_discount of this QuoteRequestValue. + :return: The percentage_discount of this QuoteRequestValue. # noqa: E501 :rtype: float """ return self._percentage_discount @percentage_discount.setter def percentage_discount(self, percentage_discount): - """ - Sets the percentage_discount of this QuoteRequestValue. - {\"description\":\"The discount percentage applied to this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the percentage_discount of this QuoteRequestValue. - :param percentage_discount: The percentage_discount of this QuoteRequestValue. + + :param percentage_discount: The percentage_discount of this QuoteRequestValue. # noqa: E501 :type: float """ self._percentage_discount = percentage_discount def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -174,29 +162,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(QuoteRequestValue, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, QuoteRequestValue): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/recalculate_charge_batch_request.py b/billforward/models/recalculate_charge_batch_request.py new file mode 100644 index 0000000..62f0436 --- /dev/null +++ b/billforward/models/recalculate_charge_batch_request.py @@ -0,0 +1,220 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class RecalculateChargeBatchRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'charges': 'list[SingleRecalculateChargeRequest]', + 'recalculate_invoices': 'bool', + 'invoice_state': 'str', + 'dry_run': 'bool' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'charges': 'charges', + 'recalculate_invoices': 'recalculateInvoices', + 'invoice_state': 'invoiceState', + 'dry_run': 'dryRun' + } + + def __init__(self, organization_id=None, charges=None, recalculate_invoices=None, invoice_state=None, dry_run=None): # noqa: E501 + """RecalculateChargeBatchRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._charges = None + self._recalculate_invoices = None + self._invoice_state = None + self._dry_run = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if charges is not None: + self.charges = charges + if recalculate_invoices is not None: + self.recalculate_invoices = recalculate_invoices + if invoice_state is not None: + self.invoice_state = invoice_state + if dry_run is not None: + self.dry_run = dry_run + + @property + def organization_id(self): + """Gets the organization_id of this RecalculateChargeBatchRequest. # noqa: E501 + + + :return: The organization_id of this RecalculateChargeBatchRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this RecalculateChargeBatchRequest. + + + :param organization_id: The organization_id of this RecalculateChargeBatchRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def charges(self): + """Gets the charges of this RecalculateChargeBatchRequest. # noqa: E501 + + + :return: The charges of this RecalculateChargeBatchRequest. # noqa: E501 + :rtype: list[SingleRecalculateChargeRequest] + """ + return self._charges + + @charges.setter + def charges(self, charges): + """Sets the charges of this RecalculateChargeBatchRequest. + + + :param charges: The charges of this RecalculateChargeBatchRequest. # noqa: E501 + :type: list[SingleRecalculateChargeRequest] + """ + + self._charges = charges + + @property + def recalculate_invoices(self): + """Gets the recalculate_invoices of this RecalculateChargeBatchRequest. # noqa: E501 + + + :return: The recalculate_invoices of this RecalculateChargeBatchRequest. # noqa: E501 + :rtype: bool + """ + return self._recalculate_invoices + + @recalculate_invoices.setter + def recalculate_invoices(self, recalculate_invoices): + """Sets the recalculate_invoices of this RecalculateChargeBatchRequest. + + + :param recalculate_invoices: The recalculate_invoices of this RecalculateChargeBatchRequest. # noqa: E501 + :type: bool + """ + + self._recalculate_invoices = recalculate_invoices + + @property + def invoice_state(self): + """Gets the invoice_state of this RecalculateChargeBatchRequest. # noqa: E501 + + + :return: The invoice_state of this RecalculateChargeBatchRequest. # noqa: E501 + :rtype: str + """ + return self._invoice_state + + @invoice_state.setter + def invoice_state(self, invoice_state): + """Sets the invoice_state of this RecalculateChargeBatchRequest. + + + :param invoice_state: The invoice_state of this RecalculateChargeBatchRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Paid", "Unpaid", "Pending", "Voided"] # noqa: E501 + if invoice_state not in allowed_values: + raise ValueError( + "Invalid value for `invoice_state` ({0}), must be one of {1}" # noqa: E501 + .format(invoice_state, allowed_values) + ) + + self._invoice_state = invoice_state + + @property + def dry_run(self): + """Gets the dry_run of this RecalculateChargeBatchRequest. # noqa: E501 + + + :return: The dry_run of this RecalculateChargeBatchRequest. # noqa: E501 + :rtype: bool + """ + return self._dry_run + + @dry_run.setter + def dry_run(self, dry_run): + """Sets the dry_run of this RecalculateChargeBatchRequest. + + + :param dry_run: The dry_run of this RecalculateChargeBatchRequest. # noqa: E501 + :type: bool + """ + + self._dry_run = dry_run + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(RecalculateChargeBatchRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, RecalculateChargeBatchRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/recalculate_charge_batch_response.py b/billforward/models/recalculate_charge_batch_response.py new file mode 100644 index 0000000..f3352f2 --- /dev/null +++ b/billforward/models/recalculate_charge_batch_response.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class RecalculateChargeBatchResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'charges': 'list[SubscriptionCharge]', + 'recalculated_invoices': 'list[Invoice]', + 'organization_id': 'str', + 'recalculate_invoices': 'bool' + } + + attribute_map = { + 'created': 'created', + 'charges': 'charges', + 'recalculated_invoices': 'recalculatedInvoices', + 'organization_id': 'organizationID', + 'recalculate_invoices': 'recalculateInvoices' + } + + def __init__(self, created=None, charges=None, recalculated_invoices=None, organization_id=None, recalculate_invoices=None): # noqa: E501 + """RecalculateChargeBatchResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._charges = None + self._recalculated_invoices = None + self._organization_id = None + self._recalculate_invoices = None + self.discriminator = None + if created is not None: + self.created = created + if charges is not None: + self.charges = charges + if recalculated_invoices is not None: + self.recalculated_invoices = recalculated_invoices + if organization_id is not None: + self.organization_id = organization_id + if recalculate_invoices is not None: + self.recalculate_invoices = recalculate_invoices + + @property + def created(self): + """Gets the created of this RecalculateChargeBatchResponse. # noqa: E501 + + + :return: The created of this RecalculateChargeBatchResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this RecalculateChargeBatchResponse. + + + :param created: The created of this RecalculateChargeBatchResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def charges(self): + """Gets the charges of this RecalculateChargeBatchResponse. # noqa: E501 + + + :return: The charges of this RecalculateChargeBatchResponse. # noqa: E501 + :rtype: list[SubscriptionCharge] + """ + return self._charges + + @charges.setter + def charges(self, charges): + """Sets the charges of this RecalculateChargeBatchResponse. + + + :param charges: The charges of this RecalculateChargeBatchResponse. # noqa: E501 + :type: list[SubscriptionCharge] + """ + + self._charges = charges + + @property + def recalculated_invoices(self): + """Gets the recalculated_invoices of this RecalculateChargeBatchResponse. # noqa: E501 + + + :return: The recalculated_invoices of this RecalculateChargeBatchResponse. # noqa: E501 + :rtype: list[Invoice] + """ + return self._recalculated_invoices + + @recalculated_invoices.setter + def recalculated_invoices(self, recalculated_invoices): + """Sets the recalculated_invoices of this RecalculateChargeBatchResponse. + + + :param recalculated_invoices: The recalculated_invoices of this RecalculateChargeBatchResponse. # noqa: E501 + :type: list[Invoice] + """ + + self._recalculated_invoices = recalculated_invoices + + @property + def organization_id(self): + """Gets the organization_id of this RecalculateChargeBatchResponse. # noqa: E501 + + + :return: The organization_id of this RecalculateChargeBatchResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this RecalculateChargeBatchResponse. + + + :param organization_id: The organization_id of this RecalculateChargeBatchResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def recalculate_invoices(self): + """Gets the recalculate_invoices of this RecalculateChargeBatchResponse. # noqa: E501 + + + :return: The recalculate_invoices of this RecalculateChargeBatchResponse. # noqa: E501 + :rtype: bool + """ + return self._recalculate_invoices + + @recalculate_invoices.setter + def recalculate_invoices(self, recalculate_invoices): + """Sets the recalculate_invoices of this RecalculateChargeBatchResponse. + + + :param recalculate_invoices: The recalculate_invoices of this RecalculateChargeBatchResponse. # noqa: E501 + :type: bool + """ + + self._recalculate_invoices = recalculate_invoices + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(RecalculateChargeBatchResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, RecalculateChargeBatchResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/recalculate_charge_request.py b/billforward/models/recalculate_charge_request.py index c9c1b64..90ad863 100644 --- a/billforward/models/recalculate_charge_request.py +++ b/billforward/models/recalculate_charge_request.py @@ -1,117 +1,149 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class RecalculateChargeRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, name=None, description=None, amount=None, invoicing_type=None, pricing_component_value=None, recalculation_behaviour=None, dry_run=False): - """ - RecalculateChargeRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'name': 'str', - 'description': 'str', - 'amount': 'float', - 'invoicing_type': 'str', - 'pricing_component_value': 'int', - 'recalculation_behaviour': 'str', - 'dry_run': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'name': 'name', - 'description': 'description', - 'amount': 'amount', - 'invoicing_type': 'invoicingType', - 'pricing_component_value': 'pricingComponentValue', - 'recalculation_behaviour': 'recalculationBehaviour', - 'dry_run': 'dryRun' - } - - self._created = created - self._name = name - self._description = description - self._amount = amount - self._invoicing_type = invoicing_type - self._pricing_component_value = pricing_component_value - self._recalculation_behaviour = recalculation_behaviour - self._dry_run = dry_run + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'name': 'str', + 'description': 'str', + 'quantity_label': 'str', + 'amount': 'float', + 'invoicing_type': 'str', + 'pricing_component_value': 'int', + 'recalculation_behaviour': 'str', + 'dry_run': 'bool' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'name': 'name', + 'description': 'description', + 'quantity_label': 'quantityLabel', + 'amount': 'amount', + 'invoicing_type': 'invoicingType', + 'pricing_component_value': 'pricingComponentValue', + 'recalculation_behaviour': 'recalculationBehaviour', + 'dry_run': 'dryRun' + } + + def __init__(self, created=None, organization_id=None, name=None, description=None, quantity_label=None, amount=None, invoicing_type=None, pricing_component_value=None, recalculation_behaviour=None, dry_run=None): # noqa: E501 + """RecalculateChargeRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._name = None + self._description = None + self._quantity_label = None + self._amount = None + self._invoicing_type = None + self._pricing_component_value = None + self._recalculation_behaviour = None + self._dry_run = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if description is not None: + self.description = description + if quantity_label is not None: + self.quantity_label = quantity_label + if amount is not None: + self.amount = amount + if invoicing_type is not None: + self.invoicing_type = invoicing_type + if pricing_component_value is not None: + self.pricing_component_value = pricing_component_value + self.recalculation_behaviour = recalculation_behaviour + if dry_run is not None: + self.dry_run = dry_run @property def created(self): - """ - Gets the created of this RecalculateChargeRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this RecalculateChargeRequest. # noqa: E501 - :return: The created of this RecalculateChargeRequest. + + :return: The created of this RecalculateChargeRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this RecalculateChargeRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this RecalculateChargeRequest. - :param created: The created of this RecalculateChargeRequest. + + :param created: The created of this RecalculateChargeRequest. # noqa: E501 :type: datetime """ self._created = created @property - def name(self): + def organization_id(self): + """Gets the organization_id of this RecalculateChargeRequest. # noqa: E501 + + + :return: The organization_id of this RecalculateChargeRequest. # noqa: E501 + :rtype: str """ - Gets the name of this RecalculateChargeRequest. - {\"description\":\"New friendly name given to the charge to help identify it.\",\"verbs\":[\"POST\",\"GET\"]} + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this RecalculateChargeRequest. + + + :param organization_id: The organization_id of this RecalculateChargeRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id - :return: The name of this RecalculateChargeRequest. + @property + def name(self): + """Gets the name of this RecalculateChargeRequest. # noqa: E501 + + + :return: The name of this RecalculateChargeRequest. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this RecalculateChargeRequest. - {\"description\":\"New friendly name given to the charge to help identify it.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the name of this RecalculateChargeRequest. - :param name: The name of this RecalculateChargeRequest. + + :param name: The name of this RecalculateChargeRequest. # noqa: E501 :type: str """ @@ -119,45 +151,62 @@ def name(self, name): @property def description(self): - """ - Gets the description of this RecalculateChargeRequest. - {\"description\":\"New description given to the charge.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the description of this RecalculateChargeRequest. # noqa: E501 + - :return: The description of this RecalculateChargeRequest. + :return: The description of this RecalculateChargeRequest. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this RecalculateChargeRequest. - {\"description\":\"New description given to the charge.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the description of this RecalculateChargeRequest. + - :param description: The description of this RecalculateChargeRequest. + :param description: The description of this RecalculateChargeRequest. # noqa: E501 :type: str """ self._description = description @property - def amount(self): + def quantity_label(self): + """Gets the quantity_label of this RecalculateChargeRequest. # noqa: E501 + + + :return: The quantity_label of this RecalculateChargeRequest. # noqa: E501 + :rtype: str """ - Gets the amount of this RecalculateChargeRequest. - {\"description\":\"(Applicable only if the existing charge has none of [`pricingComponentName`, `pricingComponentID`] defined)
New monetary amount for which to charge. Used only for ad-hoc charges (i.e charges not associated with any pricing component).
This amount excludes tax.\",\"verbs\":[\"POST\",\"GET\"]} + return self._quantity_label + + @quantity_label.setter + def quantity_label(self, quantity_label): + """Sets the quantity_label of this RecalculateChargeRequest. + + + :param quantity_label: The quantity_label of this RecalculateChargeRequest. # noqa: E501 + :type: str + """ + + self._quantity_label = quantity_label + + @property + def amount(self): + """Gets the amount of this RecalculateChargeRequest. # noqa: E501 + - :return: The amount of this RecalculateChargeRequest. + :return: The amount of this RecalculateChargeRequest. # noqa: E501 :rtype: float """ return self._amount @amount.setter def amount(self, amount): - """ - Sets the amount of this RecalculateChargeRequest. - {\"description\":\"(Applicable only if the existing charge has none of [`pricingComponentName`, `pricingComponentID`] defined)
New monetary amount for which to charge. Used only for ad-hoc charges (i.e charges not associated with any pricing component).
This amount excludes tax.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the amount of this RecalculateChargeRequest. + - :param amount: The amount of this RecalculateChargeRequest. + :param amount: The amount of this RecalculateChargeRequest. # noqa: E501 :type: float """ @@ -165,28 +214,26 @@ def amount(self, amount): @property def invoicing_type(self): - """ - Gets the invoicing_type of this RecalculateChargeRequest. - {\"default\":\"Aggregated\",\"description\":\"The strategy for how to raise invoices describing the charges produced by this charge recalculation.
Immediate — Generate straight-away an invoice containing these charges.
Aggregated — Add these charges to the next invoice which is generated naturally — i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the invoicing_type of this RecalculateChargeRequest. # noqa: E501 - :return: The invoicing_type of this RecalculateChargeRequest. + + :return: The invoicing_type of this RecalculateChargeRequest. # noqa: E501 :rtype: str """ return self._invoicing_type @invoicing_type.setter def invoicing_type(self, invoicing_type): - """ - Sets the invoicing_type of this RecalculateChargeRequest. - {\"default\":\"Aggregated\",\"description\":\"The strategy for how to raise invoices describing the charges produced by this charge recalculation.
Immediate — Generate straight-away an invoice containing these charges.
Aggregated — Add these charges to the next invoice which is generated naturally — i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the invoicing_type of this RecalculateChargeRequest. + - :param invoicing_type: The invoicing_type of this RecalculateChargeRequest. + :param invoicing_type: The invoicing_type of this RecalculateChargeRequest. # noqa: E501 :type: str """ - allowed_values = ["Immediate", "Aggregated"] + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 if invoicing_type not in allowed_values: raise ValueError( - "Invalid value for `invoicing_type` ({0}), must be one of {1}" + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 .format(invoicing_type, allowed_values) ) @@ -194,22 +241,20 @@ def invoicing_type(self, invoicing_type): @property def pricing_component_value(self): - """ - Gets the pricing_component_value of this RecalculateChargeRequest. - {\"description\":\"(Applicable only if the existing charge has any of [`pricingComponentName`, `pricingComponentID`] defined)
The updated value consumed of the pricing component which this charge concerns.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the pricing_component_value of this RecalculateChargeRequest. # noqa: E501 + - :return: The pricing_component_value of this RecalculateChargeRequest. + :return: The pricing_component_value of this RecalculateChargeRequest. # noqa: E501 :rtype: int """ return self._pricing_component_value @pricing_component_value.setter def pricing_component_value(self, pricing_component_value): - """ - Sets the pricing_component_value of this RecalculateChargeRequest. - {\"description\":\"(Applicable only if the existing charge has any of [`pricingComponentName`, `pricingComponentID`] defined)
The updated value consumed of the pricing component which this charge concerns.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the pricing_component_value of this RecalculateChargeRequest. + - :param pricing_component_value: The pricing_component_value of this RecalculateChargeRequest. + :param pricing_component_value: The pricing_component_value of this RecalculateChargeRequest. # noqa: E501 :type: int """ @@ -217,28 +262,28 @@ def pricing_component_value(self, pricing_component_value): @property def recalculation_behaviour(self): - """ - Gets the recalculation_behaviour of this RecalculateChargeRequest. - {\"default\":\"RecalculateWithLatestPricing\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the recalculation_behaviour of this RecalculateChargeRequest. # noqa: E501 - :return: The recalculation_behaviour of this RecalculateChargeRequest. + + :return: The recalculation_behaviour of this RecalculateChargeRequest. # noqa: E501 :rtype: str """ return self._recalculation_behaviour @recalculation_behaviour.setter def recalculation_behaviour(self, recalculation_behaviour): - """ - Sets the recalculation_behaviour of this RecalculateChargeRequest. - {\"default\":\"RecalculateWithLatestPricing\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the recalculation_behaviour of this RecalculateChargeRequest. + - :param recalculation_behaviour: The recalculation_behaviour of this RecalculateChargeRequest. + :param recalculation_behaviour: The recalculation_behaviour of this RecalculateChargeRequest. # noqa: E501 :type: str """ - allowed_values = ["RecalculateWithLatestPricing", "RecalculateWithCurrentPricing"] + if recalculation_behaviour is None: + raise ValueError("Invalid value for `recalculation_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["RecalculateWithLatestPricing", "RecalculateWithCurrentPricing"] # noqa: E501 if recalculation_behaviour not in allowed_values: raise ValueError( - "Invalid value for `recalculation_behaviour` ({0}), must be one of {1}" + "Invalid value for `recalculation_behaviour` ({0}), must be one of {1}" # noqa: E501 .format(recalculation_behaviour, allowed_values) ) @@ -246,34 +291,30 @@ def recalculation_behaviour(self, recalculation_behaviour): @property def dry_run(self): - """ - Gets the dry_run of this RecalculateChargeRequest. - {\"default\":false,\"description\":\"Changes described in the response:
true — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.
false — Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the dry_run of this RecalculateChargeRequest. # noqa: E501 + - :return: The dry_run of this RecalculateChargeRequest. + :return: The dry_run of this RecalculateChargeRequest. # noqa: E501 :rtype: bool """ return self._dry_run @dry_run.setter def dry_run(self, dry_run): - """ - Sets the dry_run of this RecalculateChargeRequest. - {\"default\":false,\"description\":\"Changes described in the response:
true — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.
false — Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the dry_run of this RecalculateChargeRequest. - :param dry_run: The dry_run of this RecalculateChargeRequest. + + :param dry_run: The dry_run of this RecalculateChargeRequest. # noqa: E501 :type: bool """ self._dry_run = dry_run def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -290,29 +331,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(RecalculateChargeRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, RecalculateChargeRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/receipt.py b/billforward/models/receipt.py index 5e00369..8ca8ea3 100644 --- a/billforward/models/receipt.py +++ b/billforward/models/receipt.py @@ -1,180 +1,207 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class Receipt(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, refund_id=None, created=None, changed_by=None, id=None, crm_id=None, invoice_id=None, gateway_reference_id=None, account_id=None, payment_id=None, payment_method_id=None, organization_id=None, cardholder_name=None, card_last_four=None, card_description=None, card_country=None, card_province=None, card_type=None, ip_address=None, ip_address_country=None, type=None, currency=None, value=None, payment_gateway=None, invoice_type=None, execution_attempt=None, decision=None, reason_code=None, raw_reason_code=None, raw_data=None): - """ - Receipt - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'refund_id': 'str', - 'created': 'datetime', - 'changed_by': 'str', - 'id': 'str', - 'crm_id': 'str', - 'invoice_id': 'str', - 'gateway_reference_id': 'str', - 'account_id': 'str', - 'payment_id': 'str', - 'payment_method_id': 'str', - 'organization_id': 'str', - 'cardholder_name': 'str', - 'card_last_four': 'str', - 'card_description': 'str', - 'card_country': 'str', - 'card_province': 'str', - 'card_type': 'str', - 'ip_address': 'str', - 'ip_address_country': 'str', - 'type': 'str', - 'currency': 'str', - 'value': 'float', - 'payment_gateway': 'str', - 'invoice_type': 'str', - 'execution_attempt': 'int', - 'decision': 'str', - 'reason_code': 'int', - 'raw_reason_code': 'str', - 'raw_data': 'list[str]' - } - - self.attribute_map = { - 'refund_id': 'refundID', - 'created': 'created', - 'changed_by': 'changedBy', - 'id': 'id', - 'crm_id': 'crmID', - 'invoice_id': 'invoiceID', - 'gateway_reference_id': 'gatewayReferenceID', - 'account_id': 'accountID', - 'payment_id': 'paymentID', - 'payment_method_id': 'paymentMethodID', - 'organization_id': 'organizationID', - 'cardholder_name': 'cardholderName', - 'card_last_four': 'cardLastFour', - 'card_description': 'cardDescription', - 'card_country': 'cardCountry', - 'card_province': 'cardProvince', - 'card_type': 'cardType', - 'ip_address': 'ipAddress', - 'ip_address_country': 'ipAddressCountry', - 'type': 'type', - 'currency': 'currency', - 'value': 'value', - 'payment_gateway': 'paymentGateway', - 'invoice_type': 'invoiceType', - 'execution_attempt': 'executionAttempt', - 'decision': 'decision', - 'reason_code': 'reasonCode', - 'raw_reason_code': 'rawReasonCode', - 'raw_data': 'rawData' - } - - self._refund_id = refund_id - self._created = created - self._changed_by = changed_by - self._id = id - self._crm_id = crm_id - self._invoice_id = invoice_id - self._gateway_reference_id = gateway_reference_id - self._account_id = account_id - self._payment_id = payment_id - self._payment_method_id = payment_method_id - self._organization_id = organization_id - self._cardholder_name = cardholder_name - self._card_last_four = card_last_four - self._card_description = card_description - self._card_country = card_country - self._card_province = card_province - self._card_type = card_type - self._ip_address = ip_address - self._ip_address_country = ip_address_country - self._type = type - self._currency = currency - self._value = value - self._payment_gateway = payment_gateway - self._invoice_type = invoice_type - self._execution_attempt = execution_attempt - self._decision = decision - self._reason_code = reason_code - self._raw_reason_code = raw_reason_code - self._raw_data = raw_data - - @property - def refund_id(self): - """ - Gets the refund_id of this Receipt. - - - :return: The refund_id of this Receipt. - :rtype: str - """ - return self._refund_id - - @refund_id.setter - def refund_id(self, refund_id): - """ - Sets the refund_id of this Receipt. - - - :param refund_id: The refund_id of this Receipt. - :type: str - """ - - self._refund_id = refund_id + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'id': 'str', + 'crm_id': 'str', + 'invoice_id': 'str', + 'gateway_reference_id': 'str', + 'account_id': 'str', + 'payment_id': 'str', + 'payment_method_id': 'str', + 'organization_id': 'str', + 'cardholder_name': 'str', + 'card_last_four': 'str', + 'card_description': 'str', + 'card_country': 'str', + 'card_province': 'str', + 'card_type': 'str', + 'ip_address': 'str', + 'ip_address_country': 'str', + 'type': 'str', + 'currency': 'CreditNoteCurrency', + 'value': 'float', + 'payment_gateway': 'str', + 'invoice_type': 'str', + 'execution_attempt': 'int', + 'decision': 'str', + 'reason_code': 'int', + 'raw_reason_code': 'str', + 'raw_data': 'list[str]', + 'refund_id': 'str', + 'subscription_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'id': 'id', + 'crm_id': 'crmID', + 'invoice_id': 'invoiceID', + 'gateway_reference_id': 'gatewayReferenceID', + 'account_id': 'accountID', + 'payment_id': 'paymentID', + 'payment_method_id': 'paymentMethodID', + 'organization_id': 'organizationID', + 'cardholder_name': 'cardholderName', + 'card_last_four': 'cardLastFour', + 'card_description': 'cardDescription', + 'card_country': 'cardCountry', + 'card_province': 'cardProvince', + 'card_type': 'cardType', + 'ip_address': 'ipAddress', + 'ip_address_country': 'ipAddressCountry', + 'type': 'type', + 'currency': 'currency', + 'value': 'value', + 'payment_gateway': 'paymentGateway', + 'invoice_type': 'invoiceType', + 'execution_attempt': 'executionAttempt', + 'decision': 'decision', + 'reason_code': 'reasonCode', + 'raw_reason_code': 'rawReasonCode', + 'raw_data': 'rawData', + 'refund_id': 'refundID', + 'subscription_id': 'subscriptionID' + } + + def __init__(self, created=None, changed_by=None, id=None, crm_id=None, invoice_id=None, gateway_reference_id=None, account_id=None, payment_id=None, payment_method_id=None, organization_id=None, cardholder_name=None, card_last_four=None, card_description=None, card_country=None, card_province=None, card_type=None, ip_address=None, ip_address_country=None, type=None, currency=None, value=None, payment_gateway=None, invoice_type=None, execution_attempt=None, decision=None, reason_code=None, raw_reason_code=None, raw_data=None, refund_id=None, subscription_id=None): # noqa: E501 + """Receipt - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._id = None + self._crm_id = None + self._invoice_id = None + self._gateway_reference_id = None + self._account_id = None + self._payment_id = None + self._payment_method_id = None + self._organization_id = None + self._cardholder_name = None + self._card_last_four = None + self._card_description = None + self._card_country = None + self._card_province = None + self._card_type = None + self._ip_address = None + self._ip_address_country = None + self._type = None + self._currency = None + self._value = None + self._payment_gateway = None + self._invoice_type = None + self._execution_attempt = None + self._decision = None + self._reason_code = None + self._raw_reason_code = None + self._raw_data = None + self._refund_id = None + self._subscription_id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if id is not None: + self.id = id + if crm_id is not None: + self.crm_id = crm_id + if invoice_id is not None: + self.invoice_id = invoice_id + if gateway_reference_id is not None: + self.gateway_reference_id = gateway_reference_id + if account_id is not None: + self.account_id = account_id + if payment_id is not None: + self.payment_id = payment_id + if payment_method_id is not None: + self.payment_method_id = payment_method_id + if organization_id is not None: + self.organization_id = organization_id + if cardholder_name is not None: + self.cardholder_name = cardholder_name + if card_last_four is not None: + self.card_last_four = card_last_four + if card_description is not None: + self.card_description = card_description + if card_country is not None: + self.card_country = card_country + if card_province is not None: + self.card_province = card_province + if card_type is not None: + self.card_type = card_type + if ip_address is not None: + self.ip_address = ip_address + if ip_address_country is not None: + self.ip_address_country = ip_address_country + if type is not None: + self.type = type + if currency is not None: + self.currency = currency + if value is not None: + self.value = value + if payment_gateway is not None: + self.payment_gateway = payment_gateway + if invoice_type is not None: + self.invoice_type = invoice_type + if execution_attempt is not None: + self.execution_attempt = execution_attempt + if decision is not None: + self.decision = decision + if reason_code is not None: + self.reason_code = reason_code + if raw_reason_code is not None: + self.raw_reason_code = raw_reason_code + if raw_data is not None: + self.raw_data = raw_data + self.refund_id = refund_id + if subscription_id is not None: + self.subscription_id = subscription_id @property def created(self): - """ - Gets the created of this Receipt. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this Receipt. # noqa: E501 + - :return: The created of this Receipt. + :return: The created of this Receipt. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this Receipt. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this Receipt. + - :param created: The created of this Receipt. + :param created: The created of this Receipt. # noqa: E501 :type: datetime """ @@ -182,22 +209,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this Receipt. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this Receipt. # noqa: E501 - :return: The changed_by of this Receipt. + + :return: The changed_by of this Receipt. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this Receipt. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this Receipt. - :param changed_by: The changed_by of this Receipt. + + :param changed_by: The changed_by of this Receipt. # noqa: E501 :type: str """ @@ -205,22 +230,20 @@ def changed_by(self, changed_by): @property def id(self): - """ - Gets the id of this Receipt. + """Gets the id of this Receipt. # noqa: E501 - :return: The id of this Receipt. + :return: The id of this Receipt. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this Receipt. + """Sets the id of this Receipt. - :param id: The id of this Receipt. + :param id: The id of this Receipt. # noqa: E501 :type: str """ @@ -228,22 +251,20 @@ def id(self, id): @property def crm_id(self): - """ - Gets the crm_id of this Receipt. - { \"description\" : \"CRM ID of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the crm_id of this Receipt. # noqa: E501 + - :return: The crm_id of this Receipt. + :return: The crm_id of this Receipt. # noqa: E501 :rtype: str """ return self._crm_id @crm_id.setter def crm_id(self, crm_id): - """ - Sets the crm_id of this Receipt. - { \"description\" : \"CRM ID of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the crm_id of this Receipt. - :param crm_id: The crm_id of this Receipt. + + :param crm_id: The crm_id of this Receipt. # noqa: E501 :type: str """ @@ -251,22 +272,20 @@ def crm_id(self, crm_id): @property def invoice_id(self): - """ - Gets the invoice_id of this Receipt. + """Gets the invoice_id of this Receipt. # noqa: E501 - :return: The invoice_id of this Receipt. + :return: The invoice_id of this Receipt. # noqa: E501 :rtype: str """ return self._invoice_id @invoice_id.setter def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this Receipt. + """Sets the invoice_id of this Receipt. - :param invoice_id: The invoice_id of this Receipt. + :param invoice_id: The invoice_id of this Receipt. # noqa: E501 :type: str """ @@ -274,22 +293,20 @@ def invoice_id(self, invoice_id): @property def gateway_reference_id(self): - """ - Gets the gateway_reference_id of this Receipt. + """Gets the gateway_reference_id of this Receipt. # noqa: E501 - :return: The gateway_reference_id of this Receipt. + :return: The gateway_reference_id of this Receipt. # noqa: E501 :rtype: str """ return self._gateway_reference_id @gateway_reference_id.setter def gateway_reference_id(self, gateway_reference_id): - """ - Sets the gateway_reference_id of this Receipt. + """Sets the gateway_reference_id of this Receipt. - :param gateway_reference_id: The gateway_reference_id of this Receipt. + :param gateway_reference_id: The gateway_reference_id of this Receipt. # noqa: E501 :type: str """ @@ -297,22 +314,20 @@ def gateway_reference_id(self, gateway_reference_id): @property def account_id(self): - """ - Gets the account_id of this Receipt. + """Gets the account_id of this Receipt. # noqa: E501 - :return: The account_id of this Receipt. + :return: The account_id of this Receipt. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this Receipt. + """Sets the account_id of this Receipt. - :param account_id: The account_id of this Receipt. + :param account_id: The account_id of this Receipt. # noqa: E501 :type: str """ @@ -320,22 +335,20 @@ def account_id(self, account_id): @property def payment_id(self): - """ - Gets the payment_id of this Receipt. + """Gets the payment_id of this Receipt. # noqa: E501 - :return: The payment_id of this Receipt. + :return: The payment_id of this Receipt. # noqa: E501 :rtype: str """ return self._payment_id @payment_id.setter def payment_id(self, payment_id): - """ - Sets the payment_id of this Receipt. + """Sets the payment_id of this Receipt. - :param payment_id: The payment_id of this Receipt. + :param payment_id: The payment_id of this Receipt. # noqa: E501 :type: str """ @@ -343,22 +356,20 @@ def payment_id(self, payment_id): @property def payment_method_id(self): - """ - Gets the payment_method_id of this Receipt. + """Gets the payment_method_id of this Receipt. # noqa: E501 - :return: The payment_method_id of this Receipt. + :return: The payment_method_id of this Receipt. # noqa: E501 :rtype: str """ return self._payment_method_id @payment_method_id.setter def payment_method_id(self, payment_method_id): - """ - Sets the payment_method_id of this Receipt. + """Sets the payment_method_id of this Receipt. - :param payment_method_id: The payment_method_id of this Receipt. + :param payment_method_id: The payment_method_id of this Receipt. # noqa: E501 :type: str """ @@ -366,22 +377,20 @@ def payment_method_id(self, payment_method_id): @property def organization_id(self): - """ - Gets the organization_id of this Receipt. + """Gets the organization_id of this Receipt. # noqa: E501 - :return: The organization_id of this Receipt. + :return: The organization_id of this Receipt. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this Receipt. + """Sets the organization_id of this Receipt. - :param organization_id: The organization_id of this Receipt. + :param organization_id: The organization_id of this Receipt. # noqa: E501 :type: str """ @@ -389,22 +398,20 @@ def organization_id(self, organization_id): @property def cardholder_name(self): - """ - Gets the cardholder_name of this Receipt. + """Gets the cardholder_name of this Receipt. # noqa: E501 - :return: The cardholder_name of this Receipt. + :return: The cardholder_name of this Receipt. # noqa: E501 :rtype: str """ return self._cardholder_name @cardholder_name.setter def cardholder_name(self, cardholder_name): - """ - Sets the cardholder_name of this Receipt. + """Sets the cardholder_name of this Receipt. - :param cardholder_name: The cardholder_name of this Receipt. + :param cardholder_name: The cardholder_name of this Receipt. # noqa: E501 :type: str """ @@ -412,22 +419,20 @@ def cardholder_name(self, cardholder_name): @property def card_last_four(self): - """ - Gets the card_last_four of this Receipt. + """Gets the card_last_four of this Receipt. # noqa: E501 - :return: The card_last_four of this Receipt. + :return: The card_last_four of this Receipt. # noqa: E501 :rtype: str """ return self._card_last_four @card_last_four.setter def card_last_four(self, card_last_four): - """ - Sets the card_last_four of this Receipt. + """Sets the card_last_four of this Receipt. - :param card_last_four: The card_last_four of this Receipt. + :param card_last_four: The card_last_four of this Receipt. # noqa: E501 :type: str """ @@ -435,22 +440,20 @@ def card_last_four(self, card_last_four): @property def card_description(self): - """ - Gets the card_description of this Receipt. + """Gets the card_description of this Receipt. # noqa: E501 - :return: The card_description of this Receipt. + :return: The card_description of this Receipt. # noqa: E501 :rtype: str """ return self._card_description @card_description.setter def card_description(self, card_description): - """ - Sets the card_description of this Receipt. + """Sets the card_description of this Receipt. - :param card_description: The card_description of this Receipt. + :param card_description: The card_description of this Receipt. # noqa: E501 :type: str """ @@ -458,22 +461,20 @@ def card_description(self, card_description): @property def card_country(self): - """ - Gets the card_country of this Receipt. + """Gets the card_country of this Receipt. # noqa: E501 - :return: The card_country of this Receipt. + :return: The card_country of this Receipt. # noqa: E501 :rtype: str """ return self._card_country @card_country.setter def card_country(self, card_country): - """ - Sets the card_country of this Receipt. + """Sets the card_country of this Receipt. - :param card_country: The card_country of this Receipt. + :param card_country: The card_country of this Receipt. # noqa: E501 :type: str """ @@ -481,22 +482,20 @@ def card_country(self, card_country): @property def card_province(self): - """ - Gets the card_province of this Receipt. + """Gets the card_province of this Receipt. # noqa: E501 - :return: The card_province of this Receipt. + :return: The card_province of this Receipt. # noqa: E501 :rtype: str """ return self._card_province @card_province.setter def card_province(self, card_province): - """ - Sets the card_province of this Receipt. + """Sets the card_province of this Receipt. - :param card_province: The card_province of this Receipt. + :param card_province: The card_province of this Receipt. # noqa: E501 :type: str """ @@ -504,22 +503,20 @@ def card_province(self, card_province): @property def card_type(self): - """ - Gets the card_type of this Receipt. + """Gets the card_type of this Receipt. # noqa: E501 - :return: The card_type of this Receipt. + :return: The card_type of this Receipt. # noqa: E501 :rtype: str """ return self._card_type @card_type.setter def card_type(self, card_type): - """ - Sets the card_type of this Receipt. + """Sets the card_type of this Receipt. - :param card_type: The card_type of this Receipt. + :param card_type: The card_type of this Receipt. # noqa: E501 :type: str """ @@ -527,22 +524,20 @@ def card_type(self, card_type): @property def ip_address(self): - """ - Gets the ip_address of this Receipt. - {\"description\":\"IP address associated with this payment method.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the ip_address of this Receipt. # noqa: E501 - :return: The ip_address of this Receipt. + + :return: The ip_address of this Receipt. # noqa: E501 :rtype: str """ return self._ip_address @ip_address.setter def ip_address(self, ip_address): - """ - Sets the ip_address of this Receipt. - {\"description\":\"IP address associated with this payment method.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the ip_address of this Receipt. + - :param ip_address: The ip_address of this Receipt. + :param ip_address: The ip_address of this Receipt. # noqa: E501 :type: str """ @@ -550,22 +545,20 @@ def ip_address(self, ip_address): @property def ip_address_country(self): - """ - Gets the ip_address_country of this Receipt. - {\"description\":\"Country of the IP address associated with this payment method.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the ip_address_country of this Receipt. # noqa: E501 + - :return: The ip_address_country of this Receipt. + :return: The ip_address_country of this Receipt. # noqa: E501 :rtype: str """ return self._ip_address_country @ip_address_country.setter def ip_address_country(self, ip_address_country): - """ - Sets the ip_address_country of this Receipt. - {\"description\":\"Country of the IP address associated with this payment method.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the ip_address_country of this Receipt. + - :param ip_address_country: The ip_address_country of this Receipt. + :param ip_address_country: The ip_address_country of this Receipt. # noqa: E501 :type: str """ @@ -573,28 +566,26 @@ def ip_address_country(self, ip_address_country): @property def type(self): - """ - Gets the type of this Receipt. - { \"description\" : \"Type of transaction.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the type of this Receipt. # noqa: E501 - :return: The type of this Receipt. + + :return: The type of this Receipt. # noqa: E501 :rtype: str """ return self._type @type.setter def type(self, type): - """ - Sets the type of this Receipt. - { \"description\" : \"Type of transaction.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the type of this Receipt. - :param type: The type of this Receipt. + + :param type: The type of this Receipt. # noqa: E501 :type: str """ - allowed_values = ["credit", "debit"] + allowed_values = ["credit", "debit"] # noqa: E501 if type not in allowed_values: raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 .format(type, allowed_values) ) @@ -602,45 +593,41 @@ def type(self, type): @property def currency(self): - """ - Gets the currency of this Receipt. - { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the currency of this Receipt. # noqa: E501 - :return: The currency of this Receipt. - :rtype: str + + :return: The currency of this Receipt. # noqa: E501 + :rtype: CreditNoteCurrency """ return self._currency @currency.setter def currency(self, currency): - """ - Sets the currency of this Receipt. - { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the currency of this Receipt. - :param currency: The currency of this Receipt. - :type: str + + :param currency: The currency of this Receipt. # noqa: E501 + :type: CreditNoteCurrency """ self._currency = currency @property def value(self): - """ - Gets the value of this Receipt. + """Gets the value of this Receipt. # noqa: E501 - :return: The value of this Receipt. + :return: The value of this Receipt. # noqa: E501 :rtype: float """ return self._value @value.setter def value(self, value): - """ - Sets the value of this Receipt. + """Sets the value of this Receipt. - :param value: The value of this Receipt. + :param value: The value of this Receipt. # noqa: E501 :type: float """ @@ -648,28 +635,26 @@ def value(self, value): @property def payment_gateway(self): - """ - Gets the payment_gateway of this Receipt. + """Gets the payment_gateway of this Receipt. # noqa: E501 - :return: The payment_gateway of this Receipt. + :return: The payment_gateway of this Receipt. # noqa: E501 :rtype: str """ return self._payment_gateway @payment_gateway.setter def payment_gateway(self, payment_gateway): - """ - Sets the payment_gateway of this Receipt. + """Sets the payment_gateway of this Receipt. - :param payment_gateway: The payment_gateway of this Receipt. + :param payment_gateway: The payment_gateway of this Receipt. # noqa: E501 :type: str """ - allowed_values = ["cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash"] + allowed_values = ["VOID", "cybersource_token", "card_vault", "paypal_simple", "locustworld", "free", "coupon", "credit_note", "stripe", "braintree", "zooz", "balanced", "paypal", "billforward_test", "offline", "trial", "stripeACH", "goCardless", "authorizeNet", "spreedly", "sagePay", "trustCommerce", "payvision", "kash", "epx", "shuttle", "square", "billforwardRandomizer", "cardConnect", "ebanx"] # noqa: E501 if payment_gateway not in allowed_values: raise ValueError( - "Invalid value for `payment_gateway` ({0}), must be one of {1}" + "Invalid value for `payment_gateway` ({0}), must be one of {1}" # noqa: E501 .format(payment_gateway, allowed_values) ) @@ -677,28 +662,26 @@ def payment_gateway(self, payment_gateway): @property def invoice_type(self): - """ - Gets the invoice_type of this Receipt. - { \"description\" : \"The type of the invoice. A subscription invoice is raised every time a subscription recurs. An amendment is created for intra-contract changes. An Adhoc invoice is created for payment that is taken out-of-band of a subscription. Finally the invoice generated for a trial period is marked as Trial.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the invoice_type of this Receipt. # noqa: E501 + - :return: The invoice_type of this Receipt. + :return: The invoice_type of this Receipt. # noqa: E501 :rtype: str """ return self._invoice_type @invoice_type.setter def invoice_type(self, invoice_type): - """ - Sets the invoice_type of this Receipt. - { \"description\" : \"The type of the invoice. A subscription invoice is raised every time a subscription recurs. An amendment is created for intra-contract changes. An Adhoc invoice is created for payment that is taken out-of-band of a subscription. Finally the invoice generated for a trial period is marked as Trial.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the invoice_type of this Receipt. - :param invoice_type: The invoice_type of this Receipt. + + :param invoice_type: The invoice_type of this Receipt. # noqa: E501 :type: str """ - allowed_values = ["Subscription", "Trial", "Charge", "FinalArrears", "Amendment", "Aggregated"] + allowed_values = ["Subscription", "Trial", "Charge", "FinalArrears", "Amendment", "Aggregated", "AffiliateCommission"] # noqa: E501 if invoice_type not in allowed_values: raise ValueError( - "Invalid value for `invoice_type` ({0}), must be one of {1}" + "Invalid value for `invoice_type` ({0}), must be one of {1}" # noqa: E501 .format(invoice_type, allowed_values) ) @@ -706,22 +689,20 @@ def invoice_type(self, invoice_type): @property def execution_attempt(self): - """ - Gets the execution_attempt of this Receipt. + """Gets the execution_attempt of this Receipt. # noqa: E501 - :return: The execution_attempt of this Receipt. + :return: The execution_attempt of this Receipt. # noqa: E501 :rtype: int """ return self._execution_attempt @execution_attempt.setter def execution_attempt(self, execution_attempt): - """ - Sets the execution_attempt of this Receipt. + """Sets the execution_attempt of this Receipt. - :param execution_attempt: The execution_attempt of this Receipt. + :param execution_attempt: The execution_attempt of this Receipt. # noqa: E501 :type: int """ @@ -729,28 +710,26 @@ def execution_attempt(self, execution_attempt): @property def decision(self): - """ - Gets the decision of this Receipt. + """Gets the decision of this Receipt. # noqa: E501 - :return: The decision of this Receipt. + :return: The decision of this Receipt. # noqa: E501 :rtype: str """ return self._decision @decision.setter def decision(self, decision): - """ - Sets the decision of this Receipt. + """Sets the decision of this Receipt. - :param decision: The decision of this Receipt. + :param decision: The decision of this Receipt. # noqa: E501 :type: str """ - allowed_values = ["Accept", "Reject", "Error"] + allowed_values = ["Accept", "Reject", "Pending", "Error"] # noqa: E501 if decision not in allowed_values: raise ValueError( - "Invalid value for `decision` ({0}), must be one of {1}" + "Invalid value for `decision` ({0}), must be one of {1}" # noqa: E501 .format(decision, allowed_values) ) @@ -758,22 +737,20 @@ def decision(self, decision): @property def reason_code(self): - """ - Gets the reason_code of this Receipt. + """Gets the reason_code of this Receipt. # noqa: E501 - :return: The reason_code of this Receipt. + :return: The reason_code of this Receipt. # noqa: E501 :rtype: int """ return self._reason_code @reason_code.setter def reason_code(self, reason_code): - """ - Sets the reason_code of this Receipt. + """Sets the reason_code of this Receipt. - :param reason_code: The reason_code of this Receipt. + :param reason_code: The reason_code of this Receipt. # noqa: E501 :type: int """ @@ -781,22 +758,20 @@ def reason_code(self, reason_code): @property def raw_reason_code(self): - """ - Gets the raw_reason_code of this Receipt. + """Gets the raw_reason_code of this Receipt. # noqa: E501 - :return: The raw_reason_code of this Receipt. + :return: The raw_reason_code of this Receipt. # noqa: E501 :rtype: str """ return self._raw_reason_code @raw_reason_code.setter def raw_reason_code(self, raw_reason_code): - """ - Sets the raw_reason_code of this Receipt. + """Sets the raw_reason_code of this Receipt. - :param raw_reason_code: The raw_reason_code of this Receipt. + :param raw_reason_code: The raw_reason_code of this Receipt. # noqa: E501 :type: str """ @@ -804,34 +779,74 @@ def raw_reason_code(self, raw_reason_code): @property def raw_data(self): - """ - Gets the raw_data of this Receipt. + """Gets the raw_data of this Receipt. # noqa: E501 - :return: The raw_data of this Receipt. + :return: The raw_data of this Receipt. # noqa: E501 :rtype: list[str] """ return self._raw_data @raw_data.setter def raw_data(self, raw_data): - """ - Sets the raw_data of this Receipt. + """Sets the raw_data of this Receipt. - :param raw_data: The raw_data of this Receipt. + :param raw_data: The raw_data of this Receipt. # noqa: E501 :type: list[str] """ self._raw_data = raw_data - def to_dict(self): + @property + def refund_id(self): + """Gets the refund_id of this Receipt. # noqa: E501 + + + :return: The refund_id of this Receipt. # noqa: E501 + :rtype: str + """ + return self._refund_id + + @refund_id.setter + def refund_id(self, refund_id): + """Sets the refund_id of this Receipt. + + + :param refund_id: The refund_id of this Receipt. # noqa: E501 + :type: str + """ + if refund_id is None: + raise ValueError("Invalid value for `refund_id`, must not be `None`") # noqa: E501 + + self._refund_id = refund_id + + @property + def subscription_id(self): + """Gets the subscription_id of this Receipt. # noqa: E501 + + + :return: The subscription_id of this Receipt. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this Receipt. + + + :param subscription_id: The subscription_id of this Receipt. # noqa: E501 + :type: str """ + + self._subscription_id = subscription_id + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -848,29 +863,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Receipt, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Receipt): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/receipt_paged_metadata.py b/billforward/models/receipt_paged_metadata.py deleted file mode 100644 index 29bb070..0000000 --- a/billforward/models/receipt_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class ReceiptPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - ReceiptPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Receipt]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this ReceiptPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this ReceiptPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this ReceiptPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this ReceiptPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this ReceiptPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this ReceiptPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this ReceiptPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this ReceiptPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this ReceiptPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this ReceiptPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this ReceiptPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this ReceiptPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this ReceiptPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this ReceiptPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this ReceiptPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this ReceiptPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this ReceiptPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this ReceiptPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this ReceiptPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this ReceiptPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this ReceiptPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this ReceiptPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this ReceiptPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this ReceiptPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this ReceiptPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this ReceiptPagedMetadata. - :rtype: list[Receipt] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this ReceiptPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this ReceiptPagedMetadata. - :type: list[Receipt] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/refund.py b/billforward/models/refund.py index aa60566..35394b8 100644 --- a/billforward/models/refund.py +++ b/billforward/models/refund.py @@ -1,154 +1,230 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class Refund(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, account_id=None, reason=None, nominal_value=None, value=None, refunded=None, actual_value=None, nominal_refunded_value=None, actual_refunded_value=None, refund_state=None, refund_type=None, refund_nature=None, refund_completed=None, currency=None, payment_method_id=None, invoice_payment_id=None, refund_invoice_payment_id=None, original_payment_id=None, original_gateway_payment_reference=None, refund_payment_id=None, invoice_id=None, receipt_id=None, original_receipt_id=None, created_by=None): - """ - Refund - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'account_id': 'str', - 'reason': 'str', - 'nominal_value': 'float', - 'value': 'float', - 'refunded': 'float', - 'actual_value': 'float', - 'nominal_refunded_value': 'float', - 'actual_refunded_value': 'float', - 'refund_state': 'str', - 'refund_type': 'str', - 'refund_nature': 'str', - 'refund_completed': 'datetime', - 'currency': 'str', - 'payment_method_id': 'str', - 'invoice_payment_id': 'str', - 'refund_invoice_payment_id': 'str', - 'original_payment_id': 'str', - 'original_gateway_payment_reference': 'str', - 'refund_payment_id': 'str', - 'invoice_id': 'str', - 'receipt_id': 'str', - 'original_receipt_id': 'str', - 'created_by': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'account_id': 'accountID', - 'reason': 'reason', - 'nominal_value': 'nominalValue', - 'value': 'value', - 'refunded': 'refunded', - 'actual_value': 'actualValue', - 'nominal_refunded_value': 'nominalRefundedValue', - 'actual_refunded_value': 'actualRefundedValue', - 'refund_state': 'refundState', - 'refund_type': 'refundType', - 'refund_nature': 'refundNature', - 'refund_completed': 'refundCompleted', - 'currency': 'currency', - 'payment_method_id': 'paymentMethodID', - 'invoice_payment_id': 'invoicePaymentID', - 'refund_invoice_payment_id': 'refundInvoicePaymentID', - 'original_payment_id': 'originalPaymentID', - 'original_gateway_payment_reference': 'originalGatewayPaymentReference', - 'refund_payment_id': 'refundPaymentID', - 'invoice_id': 'invoiceID', - 'receipt_id': 'receiptID', - 'original_receipt_id': 'originalReceiptID', - 'created_by': 'createdBy' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._account_id = account_id - self._reason = reason - self._nominal_value = nominal_value - self._value = value - self._refunded = refunded - self._actual_value = actual_value - self._nominal_refunded_value = nominal_refunded_value - self._actual_refunded_value = actual_refunded_value - self._refund_state = refund_state - self._refund_type = refund_type - self._refund_nature = refund_nature - self._refund_completed = refund_completed - self._currency = currency - self._payment_method_id = payment_method_id - self._invoice_payment_id = invoice_payment_id - self._refund_invoice_payment_id = refund_invoice_payment_id - self._original_payment_id = original_payment_id - self._original_gateway_payment_reference = original_gateway_payment_reference - self._refund_payment_id = refund_payment_id - self._invoice_id = invoice_id - self._receipt_id = receipt_id - self._original_receipt_id = original_receipt_id - self._created_by = created_by + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'account_id': 'str', + 'reason': 'str', + 'nominal_value': 'float', + 'value': 'float', + 'refunded': 'float', + 'actual_value': 'float', + 'nominal_refunded_value': 'float', + 'actual_refunded_value': 'float', + 'refund_state': 'str', + 'refund_type': 'str', + 'refund_nature': 'str', + 'last_execution_attempt': 'datetime', + 'next_execution_attempt': 'datetime', + 'final_execution_attempt': 'datetime', + 'refund_completed': 'datetime', + 'currency': 'CreditNoteCurrency', + 'payment_method_id': 'str', + 'invoice_payment_id': 'str', + 'refund_invoice_payment_id': 'str', + 'original_payment_id': 'str', + 'original_gateway_payment_reference': 'str', + 'refund_payment_id': 'str', + 'invoice_id': 'str', + 'receipt_id': 'str', + 'original_receipt_id': 'str', + 'created_by': 'str', + 'type': 'str', + 'state': 'str', + 'refunded_value': 'float', + 'refunded_payment': 'Payment', + 'account': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'reason': 'reason', + 'nominal_value': 'nominalValue', + 'value': 'value', + 'refunded': 'refunded', + 'actual_value': 'actualValue', + 'nominal_refunded_value': 'nominalRefundedValue', + 'actual_refunded_value': 'actualRefundedValue', + 'refund_state': 'refundState', + 'refund_type': 'refundType', + 'refund_nature': 'refundNature', + 'last_execution_attempt': 'lastExecutionAttempt', + 'next_execution_attempt': 'nextExecutionAttempt', + 'final_execution_attempt': 'finalExecutionAttempt', + 'refund_completed': 'refundCompleted', + 'currency': 'currency', + 'payment_method_id': 'paymentMethodID', + 'invoice_payment_id': 'invoicePaymentID', + 'refund_invoice_payment_id': 'refundInvoicePaymentID', + 'original_payment_id': 'originalPaymentID', + 'original_gateway_payment_reference': 'originalGatewayPaymentReference', + 'refund_payment_id': 'refundPaymentID', + 'invoice_id': 'invoiceID', + 'receipt_id': 'receiptID', + 'original_receipt_id': 'originalReceiptID', + 'created_by': 'createdBy', + 'type': 'type', + 'state': 'state', + 'refunded_value': 'refundedValue', + 'refunded_payment': 'refundedPayment', + 'account': 'account' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, account_id=None, reason=None, nominal_value=None, value=None, refunded=None, actual_value=None, nominal_refunded_value=None, actual_refunded_value=None, refund_state=None, refund_type=None, refund_nature=None, last_execution_attempt=None, next_execution_attempt=None, final_execution_attempt=None, refund_completed=None, currency=None, payment_method_id=None, invoice_payment_id=None, refund_invoice_payment_id=None, original_payment_id=None, original_gateway_payment_reference=None, refund_payment_id=None, invoice_id=None, receipt_id=None, original_receipt_id=None, created_by=None, type=None, state=None, refunded_value=None, refunded_payment=None, account=None): # noqa: E501 + """Refund - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._account_id = None + self._reason = None + self._nominal_value = None + self._value = None + self._refunded = None + self._actual_value = None + self._nominal_refunded_value = None + self._actual_refunded_value = None + self._refund_state = None + self._refund_type = None + self._refund_nature = None + self._last_execution_attempt = None + self._next_execution_attempt = None + self._final_execution_attempt = None + self._refund_completed = None + self._currency = None + self._payment_method_id = None + self._invoice_payment_id = None + self._refund_invoice_payment_id = None + self._original_payment_id = None + self._original_gateway_payment_reference = None + self._refund_payment_id = None + self._invoice_id = None + self._receipt_id = None + self._original_receipt_id = None + self._created_by = None + self._type = None + self._state = None + self._refunded_value = None + self._refunded_payment = None + self._account = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if reason is not None: + self.reason = reason + self.nominal_value = nominal_value + if value is not None: + self.value = value + if refunded is not None: + self.refunded = refunded + self.actual_value = actual_value + self.nominal_refunded_value = nominal_refunded_value + self.actual_refunded_value = actual_refunded_value + self.refund_state = refund_state + self.refund_type = refund_type + self.refund_nature = refund_nature + if last_execution_attempt is not None: + self.last_execution_attempt = last_execution_attempt + if next_execution_attempt is not None: + self.next_execution_attempt = next_execution_attempt + if final_execution_attempt is not None: + self.final_execution_attempt = final_execution_attempt + if refund_completed is not None: + self.refund_completed = refund_completed + self.currency = currency + if payment_method_id is not None: + self.payment_method_id = payment_method_id + if invoice_payment_id is not None: + self.invoice_payment_id = invoice_payment_id + if refund_invoice_payment_id is not None: + self.refund_invoice_payment_id = refund_invoice_payment_id + if original_payment_id is not None: + self.original_payment_id = original_payment_id + if original_gateway_payment_reference is not None: + self.original_gateway_payment_reference = original_gateway_payment_reference + if refund_payment_id is not None: + self.refund_payment_id = refund_payment_id + if invoice_id is not None: + self.invoice_id = invoice_id + if receipt_id is not None: + self.receipt_id = receipt_id + if original_receipt_id is not None: + self.original_receipt_id = original_receipt_id + if created_by is not None: + self.created_by = created_by + if type is not None: + self.type = type + if state is not None: + self.state = state + if refunded_value is not None: + self.refunded_value = refunded_value + if refunded_payment is not None: + self.refunded_payment = refunded_payment + if account is not None: + self.account = account @property def created(self): - """ - Gets the created of this Refund. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this Refund. # noqa: E501 - :return: The created of this Refund. + + :return: The created of this Refund. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this Refund. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this Refund. - :param created: The created of this Refund. + + :param created: The created of this Refund. # noqa: E501 :type: datetime """ @@ -156,22 +232,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this Refund. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this Refund. # noqa: E501 - :return: The changed_by of this Refund. + + :return: The changed_by of this Refund. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this Refund. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this Refund. - :param changed_by: The changed_by of this Refund. + + :param changed_by: The changed_by of this Refund. # noqa: E501 :type: str """ @@ -179,22 +253,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this Refund. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this Refund. # noqa: E501 - :return: The updated of this Refund. + + :return: The updated of this Refund. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this Refund. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this Refund. - :param updated: The updated of this Refund. + + :param updated: The updated of this Refund. # noqa: E501 :type: datetime """ @@ -202,22 +274,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this Refund. - { \"description\" : \"\", \"verbs\":[\"GET\", \"PUT\"] } + """Gets the id of this Refund. # noqa: E501 - :return: The id of this Refund. + + :return: The id of this Refund. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this Refund. - { \"description\" : \"\", \"verbs\":[\"GET\", \"PUT\"] } + """Sets the id of this Refund. - :param id: The id of this Refund. + + :param id: The id of this Refund. # noqa: E501 :type: str """ @@ -225,22 +295,20 @@ def id(self, id): @property def organization_id(self): - """ - Gets the organization_id of this Refund. - { \"description\" : \"\", \"verbs\":[] } + """Gets the organization_id of this Refund. # noqa: E501 - :return: The organization_id of this Refund. + + :return: The organization_id of this Refund. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this Refund. - { \"description\" : \"\", \"verbs\":[] } + """Sets the organization_id of this Refund. - :param organization_id: The organization_id of this Refund. + + :param organization_id: The organization_id of this Refund. # noqa: E501 :type: str """ @@ -248,22 +316,20 @@ def organization_id(self, organization_id): @property def account_id(self): - """ - Gets the account_id of this Refund. - { \"description\" : \"Identifier of account to refund.\", \"verbs\":[\"GET\"] } + """Gets the account_id of this Refund. # noqa: E501 - :return: The account_id of this Refund. + + :return: The account_id of this Refund. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this Refund. - { \"description\" : \"Identifier of account to refund.\", \"verbs\":[\"GET\"] } + """Sets the account_id of this Refund. - :param account_id: The account_id of this Refund. + + :param account_id: The account_id of this Refund. # noqa: E501 :type: str """ @@ -271,22 +337,20 @@ def account_id(self, account_id): @property def reason(self): - """ - Gets the reason of this Refund. - { \"description\" : \"The reason for the refund.\", \"verbs\":[\"GET\"] } + """Gets the reason of this Refund. # noqa: E501 - :return: The reason of this Refund. + + :return: The reason of this Refund. # noqa: E501 :rtype: str """ return self._reason @reason.setter def reason(self, reason): - """ - Sets the reason of this Refund. - { \"description\" : \"The reason for the refund.\", \"verbs\":[\"GET\"] } + """Sets the reason of this Refund. - :param reason: The reason of this Refund. + + :param reason: The reason of this Refund. # noqa: E501 :type: str """ @@ -294,45 +358,43 @@ def reason(self, reason): @property def nominal_value(self): - """ - Gets the nominal_value of this Refund. - { \"description\" : \"\", \"verbs\":[] } + """Gets the nominal_value of this Refund. # noqa: E501 - :return: The nominal_value of this Refund. + + :return: The nominal_value of this Refund. # noqa: E501 :rtype: float """ return self._nominal_value @nominal_value.setter def nominal_value(self, nominal_value): - """ - Sets the nominal_value of this Refund. - { \"description\" : \"\", \"verbs\":[] } + """Sets the nominal_value of this Refund. - :param nominal_value: The nominal_value of this Refund. + + :param nominal_value: The nominal_value of this Refund. # noqa: E501 :type: float """ + if nominal_value is None: + raise ValueError("Invalid value for `nominal_value`, must not be `None`") # noqa: E501 self._nominal_value = nominal_value @property def value(self): - """ - Gets the value of this Refund. - { \"description\" : \"Positive decimal representing the total value to refund. This is at most the amount un-refunded on the payment. If amount is the total payment amount is refunded.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the value of this Refund. # noqa: E501 - :return: The value of this Refund. + + :return: The value of this Refund. # noqa: E501 :rtype: float """ return self._value @value.setter def value(self, value): - """ - Sets the value of this Refund. - { \"description\" : \"Positive decimal representing the total value to refund. This is at most the amount un-refunded on the payment. If amount is the total payment amount is refunded.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the value of this Refund. - :param value: The value of this Refund. + + :param value: The value of this Refund. # noqa: E501 :type: float """ @@ -340,22 +402,20 @@ def value(self, value): @property def refunded(self): - """ - Gets the refunded of this Refund. - { \"description\" : \"Value refunded\", \"verbs\":[\"GET\"] } + """Gets the refunded of this Refund. # noqa: E501 - :return: The refunded of this Refund. + + :return: The refunded of this Refund. # noqa: E501 :rtype: float """ return self._refunded @refunded.setter def refunded(self, refunded): - """ - Sets the refunded of this Refund. - { \"description\" : \"Value refunded\", \"verbs\":[\"GET\"] } + """Sets the refunded of this Refund. - :param refunded: The refunded of this Refund. + + :param refunded: The refunded of this Refund. # noqa: E501 :type: float """ @@ -363,97 +423,97 @@ def refunded(self, refunded): @property def actual_value(self): - """ - Gets the actual_value of this Refund. - { \"description\" : \"\", \"verbs\":[] } + """Gets the actual_value of this Refund. # noqa: E501 - :return: The actual_value of this Refund. + + :return: The actual_value of this Refund. # noqa: E501 :rtype: float """ return self._actual_value @actual_value.setter def actual_value(self, actual_value): - """ - Sets the actual_value of this Refund. - { \"description\" : \"\", \"verbs\":[] } + """Sets the actual_value of this Refund. - :param actual_value: The actual_value of this Refund. + + :param actual_value: The actual_value of this Refund. # noqa: E501 :type: float """ + if actual_value is None: + raise ValueError("Invalid value for `actual_value`, must not be `None`") # noqa: E501 self._actual_value = actual_value @property def nominal_refunded_value(self): - """ - Gets the nominal_refunded_value of this Refund. - { \"description\" : \"Nominal value refunded.\", \"verbs\":[] } + """Gets the nominal_refunded_value of this Refund. # noqa: E501 - :return: The nominal_refunded_value of this Refund. + + :return: The nominal_refunded_value of this Refund. # noqa: E501 :rtype: float """ return self._nominal_refunded_value @nominal_refunded_value.setter def nominal_refunded_value(self, nominal_refunded_value): - """ - Sets the nominal_refunded_value of this Refund. - { \"description\" : \"Nominal value refunded.\", \"verbs\":[] } + """Sets the nominal_refunded_value of this Refund. - :param nominal_refunded_value: The nominal_refunded_value of this Refund. + + :param nominal_refunded_value: The nominal_refunded_value of this Refund. # noqa: E501 :type: float """ + if nominal_refunded_value is None: + raise ValueError("Invalid value for `nominal_refunded_value`, must not be `None`") # noqa: E501 self._nominal_refunded_value = nominal_refunded_value @property def actual_refunded_value(self): - """ - Gets the actual_refunded_value of this Refund. - { \"description\" : \"Refunded amount\", \"verbs\":[] } + """Gets the actual_refunded_value of this Refund. # noqa: E501 - :return: The actual_refunded_value of this Refund. + + :return: The actual_refunded_value of this Refund. # noqa: E501 :rtype: float """ return self._actual_refunded_value @actual_refunded_value.setter def actual_refunded_value(self, actual_refunded_value): - """ - Sets the actual_refunded_value of this Refund. - { \"description\" : \"Refunded amount\", \"verbs\":[] } + """Sets the actual_refunded_value of this Refund. - :param actual_refunded_value: The actual_refunded_value of this Refund. + + :param actual_refunded_value: The actual_refunded_value of this Refund. # noqa: E501 :type: float """ + if actual_refunded_value is None: + raise ValueError("Invalid value for `actual_refunded_value`, must not be `None`") # noqa: E501 self._actual_refunded_value = actual_refunded_value @property def refund_state(self): - """ - Gets the refund_state of this Refund. - { \"default\" : \"AwaitingRefund\", \"PUT_description\" : \"Pending refunds can be set to AwaitingRefund to initiate the refund or Cancelled to stop the refund.\", \"description\" : \"Initially a refund is in the AwaitingRefund state. Once the funds are successfully returned the state is Refunded. If the refund fails or is rejected is it set as Failed. Refunds can be set to a Pending state to support authorization flows, and will leave the refund pending until updated to AwaitingRefund. Cancelled is when a refund will not be executed.\", \"verbs\":[\"GET\", \"POST\", \"PUT\"] } + """Gets the refund_state of this Refund. # noqa: E501 - :return: The refund_state of this Refund. + + :return: The refund_state of this Refund. # noqa: E501 :rtype: str """ return self._refund_state @refund_state.setter def refund_state(self, refund_state): - """ - Sets the refund_state of this Refund. - { \"default\" : \"AwaitingRefund\", \"PUT_description\" : \"Pending refunds can be set to AwaitingRefund to initiate the refund or Cancelled to stop the refund.\", \"description\" : \"Initially a refund is in the AwaitingRefund state. Once the funds are successfully returned the state is Refunded. If the refund fails or is rejected is it set as Failed. Refunds can be set to a Pending state to support authorization flows, and will leave the refund pending until updated to AwaitingRefund. Cancelled is when a refund will not be executed.\", \"verbs\":[\"GET\", \"POST\", \"PUT\"] } + """Sets the refund_state of this Refund. - :param refund_state: The refund_state of this Refund. + + :param refund_state: The refund_state of this Refund. # noqa: E501 :type: str """ - allowed_values = ["Pending", "AwaitingRefund", "Refunded", "Cancelled", "Failed"] + if refund_state is None: + raise ValueError("Invalid value for `refund_state`, must not be `None`") # noqa: E501 + allowed_values = ["Pending", "AwaitingRefund", "Refunded", "Cancelled", "Failed"] # noqa: E501 if refund_state not in allowed_values: raise ValueError( - "Invalid value for `refund_state` ({0}), must be one of {1}" + "Invalid value for `refund_state` ({0}), must be one of {1}" # noqa: E501 .format(refund_state, allowed_values) ) @@ -461,28 +521,28 @@ def refund_state(self, refund_state): @property def refund_type(self): - """ - Gets the refund_type of this Refund. - { \"description\" : \"This is the type of refund. Refunds are associated with either an invoice and payment, a payment or unreferenced.\", \"verbs\":[] } + """Gets the refund_type of this Refund. # noqa: E501 - :return: The refund_type of this Refund. + + :return: The refund_type of this Refund. # noqa: E501 :rtype: str """ return self._refund_type @refund_type.setter def refund_type(self, refund_type): - """ - Sets the refund_type of this Refund. - { \"description\" : \"This is the type of refund. Refunds are associated with either an invoice and payment, a payment or unreferenced.\", \"verbs\":[] } + """Sets the refund_type of this Refund. - :param refund_type: The refund_type of this Refund. + + :param refund_type: The refund_type of this Refund. # noqa: E501 :type: str """ - allowed_values = ["InvoicePayment", "Payment"] + if refund_type is None: + raise ValueError("Invalid value for `refund_type`, must not be `None`") # noqa: E501 + allowed_values = ["InvoicePayment", "Payment"] # noqa: E501 if refund_type not in allowed_values: raise ValueError( - "Invalid value for `refund_type` ({0}), must be one of {1}" + "Invalid value for `refund_type` ({0}), must be one of {1}" # noqa: E501 .format(refund_type, allowed_values) ) @@ -490,51 +550,112 @@ def refund_type(self, refund_type): @property def refund_nature(self): - """ - Gets the refund_nature of this Refund. - {\"default\":\"SingleAttempt\",\"description\":The mechanism by which credit is returned to the customer:
Void — The original authorized payment is voided before capture.
Refund — A refund is issued against an already-captured payment.\",\"verbs\":[\"GET\"]} + """Gets the refund_nature of this Refund. # noqa: E501 - :return: The refund_nature of this Refund. + + :return: The refund_nature of this Refund. # noqa: E501 :rtype: str """ return self._refund_nature @refund_nature.setter def refund_nature(self, refund_nature): - """ - Sets the refund_nature of this Refund. - {\"default\":\"SingleAttempt\",\"description\":The mechanism by which credit is returned to the customer:
Void — The original authorized payment is voided before capture.
Refund — A refund is issued against an already-captured payment.\",\"verbs\":[\"GET\"]} + """Sets the refund_nature of this Refund. - :param refund_nature: The refund_nature of this Refund. + + :param refund_nature: The refund_nature of this Refund. # noqa: E501 :type: str """ - allowed_values = ["Refund", "Void"] + if refund_nature is None: + raise ValueError("Invalid value for `refund_nature`, must not be `None`") # noqa: E501 + allowed_values = ["Refund", "Void"] # noqa: E501 if refund_nature not in allowed_values: raise ValueError( - "Invalid value for `refund_nature` ({0}), must be one of {1}" + "Invalid value for `refund_nature` ({0}), must be one of {1}" # noqa: E501 .format(refund_nature, allowed_values) ) self._refund_nature = refund_nature @property - def refund_completed(self): + def last_execution_attempt(self): + """Gets the last_execution_attempt of this Refund. # noqa: E501 + + + :return: The last_execution_attempt of this Refund. # noqa: E501 + :rtype: datetime + """ + return self._last_execution_attempt + + @last_execution_attempt.setter + def last_execution_attempt(self, last_execution_attempt): + """Sets the last_execution_attempt of this Refund. + + + :param last_execution_attempt: The last_execution_attempt of this Refund. # noqa: E501 + :type: datetime + """ + + self._last_execution_attempt = last_execution_attempt + + @property + def next_execution_attempt(self): + """Gets the next_execution_attempt of this Refund. # noqa: E501 + + + :return: The next_execution_attempt of this Refund. # noqa: E501 + :rtype: datetime + """ + return self._next_execution_attempt + + @next_execution_attempt.setter + def next_execution_attempt(self, next_execution_attempt): + """Sets the next_execution_attempt of this Refund. + + + :param next_execution_attempt: The next_execution_attempt of this Refund. # noqa: E501 + :type: datetime """ - Gets the refund_completed of this Refund. - { \"description\" : \"When the refund was completed\", \"verbs\":[\"GET\"] } - :return: The refund_completed of this Refund. + self._next_execution_attempt = next_execution_attempt + + @property + def final_execution_attempt(self): + """Gets the final_execution_attempt of this Refund. # noqa: E501 + + + :return: The final_execution_attempt of this Refund. # noqa: E501 + :rtype: datetime + """ + return self._final_execution_attempt + + @final_execution_attempt.setter + def final_execution_attempt(self, final_execution_attempt): + """Sets the final_execution_attempt of this Refund. + + + :param final_execution_attempt: The final_execution_attempt of this Refund. # noqa: E501 + :type: datetime + """ + + self._final_execution_attempt = final_execution_attempt + + @property + def refund_completed(self): + """Gets the refund_completed of this Refund. # noqa: E501 + + + :return: The refund_completed of this Refund. # noqa: E501 :rtype: datetime """ return self._refund_completed @refund_completed.setter def refund_completed(self, refund_completed): - """ - Sets the refund_completed of this Refund. - { \"description\" : \"When the refund was completed\", \"verbs\":[\"GET\"] } + """Sets the refund_completed of this Refund. - :param refund_completed: The refund_completed of this Refund. + + :param refund_completed: The refund_completed of this Refund. # noqa: E501 :type: datetime """ @@ -542,45 +663,43 @@ def refund_completed(self, refund_completed): @property def currency(self): - """ - Gets the currency of this Refund. - { \"description\" : \"Currency of the refund specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } + """Gets the currency of this Refund. # noqa: E501 - :return: The currency of this Refund. - :rtype: str + + :return: The currency of this Refund. # noqa: E501 + :rtype: CreditNoteCurrency """ return self._currency @currency.setter def currency(self, currency): - """ - Sets the currency of this Refund. - { \"description\" : \"Currency of the refund specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } + """Sets the currency of this Refund. - :param currency: The currency of this Refund. - :type: str + + :param currency: The currency of this Refund. # noqa: E501 + :type: CreditNoteCurrency """ + if currency is None: + raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501 self._currency = currency @property def payment_method_id(self): - """ - Gets the payment_method_id of this Refund. - { \"description\" : \"Payment method to refund from\", \"verbs\":[\"GET\"] } + """Gets the payment_method_id of this Refund. # noqa: E501 - :return: The payment_method_id of this Refund. + + :return: The payment_method_id of this Refund. # noqa: E501 :rtype: str """ return self._payment_method_id @payment_method_id.setter def payment_method_id(self, payment_method_id): - """ - Sets the payment_method_id of this Refund. - { \"description\" : \"Payment method to refund from\", \"verbs\":[\"GET\"] } + """Sets the payment_method_id of this Refund. - :param payment_method_id: The payment_method_id of this Refund. + + :param payment_method_id: The payment_method_id of this Refund. # noqa: E501 :type: str """ @@ -588,22 +707,20 @@ def payment_method_id(self, payment_method_id): @property def invoice_payment_id(self): - """ - Gets the invoice_payment_id of this Refund. - { \"description\" : \"Invoice payment to refund\", \"verbs\":[\"POST\", \"GET\"] } + """Gets the invoice_payment_id of this Refund. # noqa: E501 - :return: The invoice_payment_id of this Refund. + + :return: The invoice_payment_id of this Refund. # noqa: E501 :rtype: str """ return self._invoice_payment_id @invoice_payment_id.setter def invoice_payment_id(self, invoice_payment_id): - """ - Sets the invoice_payment_id of this Refund. - { \"description\" : \"Invoice payment to refund\", \"verbs\":[\"POST\", \"GET\"] } + """Sets the invoice_payment_id of this Refund. - :param invoice_payment_id: The invoice_payment_id of this Refund. + + :param invoice_payment_id: The invoice_payment_id of this Refund. # noqa: E501 :type: str """ @@ -611,22 +728,20 @@ def invoice_payment_id(self, invoice_payment_id): @property def refund_invoice_payment_id(self): - """ - Gets the refund_invoice_payment_id of this Refund. - { \"description\" : \"\", \"verbs\":[] } + """Gets the refund_invoice_payment_id of this Refund. # noqa: E501 - :return: The refund_invoice_payment_id of this Refund. + + :return: The refund_invoice_payment_id of this Refund. # noqa: E501 :rtype: str """ return self._refund_invoice_payment_id @refund_invoice_payment_id.setter def refund_invoice_payment_id(self, refund_invoice_payment_id): - """ - Sets the refund_invoice_payment_id of this Refund. - { \"description\" : \"\", \"verbs\":[] } + """Sets the refund_invoice_payment_id of this Refund. - :param refund_invoice_payment_id: The refund_invoice_payment_id of this Refund. + + :param refund_invoice_payment_id: The refund_invoice_payment_id of this Refund. # noqa: E501 :type: str """ @@ -634,22 +749,20 @@ def refund_invoice_payment_id(self, refund_invoice_payment_id): @property def original_payment_id(self): - """ - Gets the original_payment_id of this Refund. - { \"description\" : \"Original payment being refunded.\", \"verbs\":[\"GET\"] } + """Gets the original_payment_id of this Refund. # noqa: E501 - :return: The original_payment_id of this Refund. + + :return: The original_payment_id of this Refund. # noqa: E501 :rtype: str """ return self._original_payment_id @original_payment_id.setter def original_payment_id(self, original_payment_id): - """ - Sets the original_payment_id of this Refund. - { \"description\" : \"Original payment being refunded.\", \"verbs\":[\"GET\"] } + """Sets the original_payment_id of this Refund. - :param original_payment_id: The original_payment_id of this Refund. + + :param original_payment_id: The original_payment_id of this Refund. # noqa: E501 :type: str """ @@ -657,22 +770,20 @@ def original_payment_id(self, original_payment_id): @property def original_gateway_payment_reference(self): - """ - Gets the original_gateway_payment_reference of this Refund. - { \"description\" : \"Reference in the gateway to the payment being refunded.\", \"verbs\":[\"GET\"] } + """Gets the original_gateway_payment_reference of this Refund. # noqa: E501 - :return: The original_gateway_payment_reference of this Refund. + + :return: The original_gateway_payment_reference of this Refund. # noqa: E501 :rtype: str """ return self._original_gateway_payment_reference @original_gateway_payment_reference.setter def original_gateway_payment_reference(self, original_gateway_payment_reference): - """ - Sets the original_gateway_payment_reference of this Refund. - { \"description\" : \"Reference in the gateway to the payment being refunded.\", \"verbs\":[\"GET\"] } + """Sets the original_gateway_payment_reference of this Refund. - :param original_gateway_payment_reference: The original_gateway_payment_reference of this Refund. + + :param original_gateway_payment_reference: The original_gateway_payment_reference of this Refund. # noqa: E501 :type: str """ @@ -680,22 +791,20 @@ def original_gateway_payment_reference(self, original_gateway_payment_reference) @property def refund_payment_id(self): - """ - Gets the refund_payment_id of this Refund. - { \"description\" : \"Identifier for the payment used to refund\", \"verbs\":[\"GET\"] } + """Gets the refund_payment_id of this Refund. # noqa: E501 - :return: The refund_payment_id of this Refund. + + :return: The refund_payment_id of this Refund. # noqa: E501 :rtype: str """ return self._refund_payment_id @refund_payment_id.setter def refund_payment_id(self, refund_payment_id): - """ - Sets the refund_payment_id of this Refund. - { \"description\" : \"Identifier for the payment used to refund\", \"verbs\":[\"GET\"] } + """Sets the refund_payment_id of this Refund. - :param refund_payment_id: The refund_payment_id of this Refund. + + :param refund_payment_id: The refund_payment_id of this Refund. # noqa: E501 :type: str """ @@ -703,22 +812,20 @@ def refund_payment_id(self, refund_payment_id): @property def invoice_id(self): - """ - Gets the invoice_id of this Refund. - { \"description\" : \"Invoice to refund.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the invoice_id of this Refund. # noqa: E501 - :return: The invoice_id of this Refund. + + :return: The invoice_id of this Refund. # noqa: E501 :rtype: str """ return self._invoice_id @invoice_id.setter def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this Refund. - { \"description\" : \"Invoice to refund.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the invoice_id of this Refund. - :param invoice_id: The invoice_id of this Refund. + + :param invoice_id: The invoice_id of this Refund. # noqa: E501 :type: str """ @@ -726,22 +833,20 @@ def invoice_id(self, invoice_id): @property def receipt_id(self): - """ - Gets the receipt_id of this Refund. - { \"description\" : \"ID of the receipt for this refund.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the receipt_id of this Refund. # noqa: E501 - :return: The receipt_id of this Refund. + + :return: The receipt_id of this Refund. # noqa: E501 :rtype: str """ return self._receipt_id @receipt_id.setter def receipt_id(self, receipt_id): - """ - Sets the receipt_id of this Refund. - { \"description\" : \"ID of the receipt for this refund.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the receipt_id of this Refund. - :param receipt_id: The receipt_id of this Refund. + + :param receipt_id: The receipt_id of this Refund. # noqa: E501 :type: str """ @@ -749,22 +854,20 @@ def receipt_id(self, receipt_id): @property def original_receipt_id(self): - """ - Gets the original_receipt_id of this Refund. - { \"description\" : \"ID of the receipt for the successful payment that this entity refunds.\", \"verbs\":[\"POST\",\"GET\"] } + """Gets the original_receipt_id of this Refund. # noqa: E501 - :return: The original_receipt_id of this Refund. + + :return: The original_receipt_id of this Refund. # noqa: E501 :rtype: str """ return self._original_receipt_id @original_receipt_id.setter def original_receipt_id(self, original_receipt_id): - """ - Sets the original_receipt_id of this Refund. - { \"description\" : \"ID of the receipt for the successful payment that this entity refunds.\", \"verbs\":[\"POST\",\"GET\"] } + """Sets the original_receipt_id of this Refund. - :param original_receipt_id: The original_receipt_id of this Refund. + + :param original_receipt_id: The original_receipt_id of this Refund. # noqa: E501 :type: str """ @@ -772,34 +875,147 @@ def original_receipt_id(self, original_receipt_id): @property def created_by(self): - """ - Gets the created_by of this Refund. - { \"description\" : \"Refund requested by this account\", \"verbs\":[\"GET\"] } + """Gets the created_by of this Refund. # noqa: E501 - :return: The created_by of this Refund. + + :return: The created_by of this Refund. # noqa: E501 :rtype: str """ return self._created_by @created_by.setter def created_by(self, created_by): - """ - Sets the created_by of this Refund. - { \"description\" : \"Refund requested by this account\", \"verbs\":[\"GET\"] } + """Sets the created_by of this Refund. - :param created_by: The created_by of this Refund. + + :param created_by: The created_by of this Refund. # noqa: E501 :type: str """ self._created_by = created_by - def to_dict(self): + @property + def type(self): + """Gets the type of this Refund. # noqa: E501 + + + :return: The type of this Refund. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this Refund. + + + :param type: The type of this Refund. # noqa: E501 + :type: str + """ + allowed_values = ["InvoicePayment", "Payment"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def state(self): + """Gets the state of this Refund. # noqa: E501 + + + :return: The state of this Refund. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this Refund. + + + :param state: The state of this Refund. # noqa: E501 + :type: str + """ + allowed_values = ["Pending", "AwaitingRefund", "Refunded", "Cancelled", "Failed"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def refunded_value(self): + """Gets the refunded_value of this Refund. # noqa: E501 + + + :return: The refunded_value of this Refund. # noqa: E501 + :rtype: float + """ + return self._refunded_value + + @refunded_value.setter + def refunded_value(self, refunded_value): + """Sets the refunded_value of this Refund. + + + :param refunded_value: The refunded_value of this Refund. # noqa: E501 + :type: float + """ + + self._refunded_value = refunded_value + + @property + def refunded_payment(self): + """Gets the refunded_payment of this Refund. # noqa: E501 + + + :return: The refunded_payment of this Refund. # noqa: E501 + :rtype: Payment + """ + return self._refunded_payment + + @refunded_payment.setter + def refunded_payment(self, refunded_payment): + """Sets the refunded_payment of this Refund. + + + :param refunded_payment: The refunded_payment of this Refund. # noqa: E501 + :type: Payment + """ + + self._refunded_payment = refunded_payment + + @property + def account(self): + """Gets the account of this Refund. # noqa: E501 + + + :return: The account of this Refund. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._account + + @account.setter + def account(self, account): + """Sets the account of this Refund. + + + :param account: The account of this Refund. # noqa: E501 + :type: str """ + + self._account = account + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -816,29 +1032,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Refund, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Refund): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/refund_accounting_view.py b/billforward/models/refund_accounting_view.py new file mode 100644 index 0000000..2454587 --- /dev/null +++ b/billforward/models/refund_accounting_view.py @@ -0,0 +1,564 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class RefundAccountingView(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str', + 'actual_refunded_value': 'float', + 'refund_completed': 'datetime', + 'currency': 'CreditNoteCurrency', + 'account_id': 'str', + 'reason': 'str', + 'nominal_value': 'float', + 'actual_value': 'float', + 'nominal_refunded_value': 'float', + 'refund_type': 'str', + 'refund_nature': 'str', + 'payment_method_id': 'str', + 'invoice_payment_id': 'str', + 'original_payment_id': 'str', + 'refund_payment_id': 'str', + 'invoice_id': 'str', + 'receipt_id': 'str', + 'original_receipt_id': 'str' + } + + attribute_map = { + 'id': 'id', + 'actual_refunded_value': 'actualRefundedValue', + 'refund_completed': 'refundCompleted', + 'currency': 'currency', + 'account_id': 'accountID', + 'reason': 'reason', + 'nominal_value': 'nominalValue', + 'actual_value': 'actualValue', + 'nominal_refunded_value': 'nominalRefundedValue', + 'refund_type': 'refundType', + 'refund_nature': 'refundNature', + 'payment_method_id': 'paymentMethodID', + 'invoice_payment_id': 'invoicePaymentID', + 'original_payment_id': 'originalPaymentID', + 'refund_payment_id': 'refundPaymentID', + 'invoice_id': 'invoiceID', + 'receipt_id': 'receiptID', + 'original_receipt_id': 'originalReceiptID' + } + + def __init__(self, id=None, actual_refunded_value=None, refund_completed=None, currency=None, account_id=None, reason=None, nominal_value=None, actual_value=None, nominal_refunded_value=None, refund_type=None, refund_nature=None, payment_method_id=None, invoice_payment_id=None, original_payment_id=None, refund_payment_id=None, invoice_id=None, receipt_id=None, original_receipt_id=None): # noqa: E501 + """RefundAccountingView - a model defined in Swagger""" # noqa: E501 + self._id = None + self._actual_refunded_value = None + self._refund_completed = None + self._currency = None + self._account_id = None + self._reason = None + self._nominal_value = None + self._actual_value = None + self._nominal_refunded_value = None + self._refund_type = None + self._refund_nature = None + self._payment_method_id = None + self._invoice_payment_id = None + self._original_payment_id = None + self._refund_payment_id = None + self._invoice_id = None + self._receipt_id = None + self._original_receipt_id = None + self.discriminator = None + if id is not None: + self.id = id + if actual_refunded_value is not None: + self.actual_refunded_value = actual_refunded_value + if refund_completed is not None: + self.refund_completed = refund_completed + if currency is not None: + self.currency = currency + if account_id is not None: + self.account_id = account_id + if reason is not None: + self.reason = reason + if nominal_value is not None: + self.nominal_value = nominal_value + if actual_value is not None: + self.actual_value = actual_value + if nominal_refunded_value is not None: + self.nominal_refunded_value = nominal_refunded_value + if refund_type is not None: + self.refund_type = refund_type + if refund_nature is not None: + self.refund_nature = refund_nature + if payment_method_id is not None: + self.payment_method_id = payment_method_id + if invoice_payment_id is not None: + self.invoice_payment_id = invoice_payment_id + if original_payment_id is not None: + self.original_payment_id = original_payment_id + if refund_payment_id is not None: + self.refund_payment_id = refund_payment_id + if invoice_id is not None: + self.invoice_id = invoice_id + if receipt_id is not None: + self.receipt_id = receipt_id + if original_receipt_id is not None: + self.original_receipt_id = original_receipt_id + + @property + def id(self): + """Gets the id of this RefundAccountingView. # noqa: E501 + + + :return: The id of this RefundAccountingView. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this RefundAccountingView. + + + :param id: The id of this RefundAccountingView. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def actual_refunded_value(self): + """Gets the actual_refunded_value of this RefundAccountingView. # noqa: E501 + + + :return: The actual_refunded_value of this RefundAccountingView. # noqa: E501 + :rtype: float + """ + return self._actual_refunded_value + + @actual_refunded_value.setter + def actual_refunded_value(self, actual_refunded_value): + """Sets the actual_refunded_value of this RefundAccountingView. + + + :param actual_refunded_value: The actual_refunded_value of this RefundAccountingView. # noqa: E501 + :type: float + """ + + self._actual_refunded_value = actual_refunded_value + + @property + def refund_completed(self): + """Gets the refund_completed of this RefundAccountingView. # noqa: E501 + + + :return: The refund_completed of this RefundAccountingView. # noqa: E501 + :rtype: datetime + """ + return self._refund_completed + + @refund_completed.setter + def refund_completed(self, refund_completed): + """Sets the refund_completed of this RefundAccountingView. + + + :param refund_completed: The refund_completed of this RefundAccountingView. # noqa: E501 + :type: datetime + """ + + self._refund_completed = refund_completed + + @property + def currency(self): + """Gets the currency of this RefundAccountingView. # noqa: E501 + + + :return: The currency of this RefundAccountingView. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this RefundAccountingView. + + + :param currency: The currency of this RefundAccountingView. # noqa: E501 + :type: CreditNoteCurrency + """ + + self._currency = currency + + @property + def account_id(self): + """Gets the account_id of this RefundAccountingView. # noqa: E501 + + + :return: The account_id of this RefundAccountingView. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this RefundAccountingView. + + + :param account_id: The account_id of this RefundAccountingView. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def reason(self): + """Gets the reason of this RefundAccountingView. # noqa: E501 + + + :return: The reason of this RefundAccountingView. # noqa: E501 + :rtype: str + """ + return self._reason + + @reason.setter + def reason(self, reason): + """Sets the reason of this RefundAccountingView. + + + :param reason: The reason of this RefundAccountingView. # noqa: E501 + :type: str + """ + + self._reason = reason + + @property + def nominal_value(self): + """Gets the nominal_value of this RefundAccountingView. # noqa: E501 + + + :return: The nominal_value of this RefundAccountingView. # noqa: E501 + :rtype: float + """ + return self._nominal_value + + @nominal_value.setter + def nominal_value(self, nominal_value): + """Sets the nominal_value of this RefundAccountingView. + + + :param nominal_value: The nominal_value of this RefundAccountingView. # noqa: E501 + :type: float + """ + + self._nominal_value = nominal_value + + @property + def actual_value(self): + """Gets the actual_value of this RefundAccountingView. # noqa: E501 + + + :return: The actual_value of this RefundAccountingView. # noqa: E501 + :rtype: float + """ + return self._actual_value + + @actual_value.setter + def actual_value(self, actual_value): + """Sets the actual_value of this RefundAccountingView. + + + :param actual_value: The actual_value of this RefundAccountingView. # noqa: E501 + :type: float + """ + + self._actual_value = actual_value + + @property + def nominal_refunded_value(self): + """Gets the nominal_refunded_value of this RefundAccountingView. # noqa: E501 + + + :return: The nominal_refunded_value of this RefundAccountingView. # noqa: E501 + :rtype: float + """ + return self._nominal_refunded_value + + @nominal_refunded_value.setter + def nominal_refunded_value(self, nominal_refunded_value): + """Sets the nominal_refunded_value of this RefundAccountingView. + + + :param nominal_refunded_value: The nominal_refunded_value of this RefundAccountingView. # noqa: E501 + :type: float + """ + + self._nominal_refunded_value = nominal_refunded_value + + @property + def refund_type(self): + """Gets the refund_type of this RefundAccountingView. # noqa: E501 + + + :return: The refund_type of this RefundAccountingView. # noqa: E501 + :rtype: str + """ + return self._refund_type + + @refund_type.setter + def refund_type(self, refund_type): + """Sets the refund_type of this RefundAccountingView. + + + :param refund_type: The refund_type of this RefundAccountingView. # noqa: E501 + :type: str + """ + allowed_values = ["InvoicePayment", "Payment"] # noqa: E501 + if refund_type not in allowed_values: + raise ValueError( + "Invalid value for `refund_type` ({0}), must be one of {1}" # noqa: E501 + .format(refund_type, allowed_values) + ) + + self._refund_type = refund_type + + @property + def refund_nature(self): + """Gets the refund_nature of this RefundAccountingView. # noqa: E501 + + + :return: The refund_nature of this RefundAccountingView. # noqa: E501 + :rtype: str + """ + return self._refund_nature + + @refund_nature.setter + def refund_nature(self, refund_nature): + """Sets the refund_nature of this RefundAccountingView. + + + :param refund_nature: The refund_nature of this RefundAccountingView. # noqa: E501 + :type: str + """ + allowed_values = ["Refund", "Void"] # noqa: E501 + if refund_nature not in allowed_values: + raise ValueError( + "Invalid value for `refund_nature` ({0}), must be one of {1}" # noqa: E501 + .format(refund_nature, allowed_values) + ) + + self._refund_nature = refund_nature + + @property + def payment_method_id(self): + """Gets the payment_method_id of this RefundAccountingView. # noqa: E501 + + + :return: The payment_method_id of this RefundAccountingView. # noqa: E501 + :rtype: str + """ + return self._payment_method_id + + @payment_method_id.setter + def payment_method_id(self, payment_method_id): + """Sets the payment_method_id of this RefundAccountingView. + + + :param payment_method_id: The payment_method_id of this RefundAccountingView. # noqa: E501 + :type: str + """ + + self._payment_method_id = payment_method_id + + @property + def invoice_payment_id(self): + """Gets the invoice_payment_id of this RefundAccountingView. # noqa: E501 + + + :return: The invoice_payment_id of this RefundAccountingView. # noqa: E501 + :rtype: str + """ + return self._invoice_payment_id + + @invoice_payment_id.setter + def invoice_payment_id(self, invoice_payment_id): + """Sets the invoice_payment_id of this RefundAccountingView. + + + :param invoice_payment_id: The invoice_payment_id of this RefundAccountingView. # noqa: E501 + :type: str + """ + + self._invoice_payment_id = invoice_payment_id + + @property + def original_payment_id(self): + """Gets the original_payment_id of this RefundAccountingView. # noqa: E501 + + + :return: The original_payment_id of this RefundAccountingView. # noqa: E501 + :rtype: str + """ + return self._original_payment_id + + @original_payment_id.setter + def original_payment_id(self, original_payment_id): + """Sets the original_payment_id of this RefundAccountingView. + + + :param original_payment_id: The original_payment_id of this RefundAccountingView. # noqa: E501 + :type: str + """ + + self._original_payment_id = original_payment_id + + @property + def refund_payment_id(self): + """Gets the refund_payment_id of this RefundAccountingView. # noqa: E501 + + + :return: The refund_payment_id of this RefundAccountingView. # noqa: E501 + :rtype: str + """ + return self._refund_payment_id + + @refund_payment_id.setter + def refund_payment_id(self, refund_payment_id): + """Sets the refund_payment_id of this RefundAccountingView. + + + :param refund_payment_id: The refund_payment_id of this RefundAccountingView. # noqa: E501 + :type: str + """ + + self._refund_payment_id = refund_payment_id + + @property + def invoice_id(self): + """Gets the invoice_id of this RefundAccountingView. # noqa: E501 + + + :return: The invoice_id of this RefundAccountingView. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this RefundAccountingView. + + + :param invoice_id: The invoice_id of this RefundAccountingView. # noqa: E501 + :type: str + """ + + self._invoice_id = invoice_id + + @property + def receipt_id(self): + """Gets the receipt_id of this RefundAccountingView. # noqa: E501 + + + :return: The receipt_id of this RefundAccountingView. # noqa: E501 + :rtype: str + """ + return self._receipt_id + + @receipt_id.setter + def receipt_id(self, receipt_id): + """Sets the receipt_id of this RefundAccountingView. + + + :param receipt_id: The receipt_id of this RefundAccountingView. # noqa: E501 + :type: str + """ + + self._receipt_id = receipt_id + + @property + def original_receipt_id(self): + """Gets the original_receipt_id of this RefundAccountingView. # noqa: E501 + + + :return: The original_receipt_id of this RefundAccountingView. # noqa: E501 + :rtype: str + """ + return self._original_receipt_id + + @original_receipt_id.setter + def original_receipt_id(self, original_receipt_id): + """Sets the original_receipt_id of this RefundAccountingView. + + + :param original_receipt_id: The original_receipt_id of this RefundAccountingView. # noqa: E501 + :type: str + """ + + self._original_receipt_id = original_receipt_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(RefundAccountingView, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, RefundAccountingView): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/refund_paged_metadata.py b/billforward/models/refund_paged_metadata.py deleted file mode 100644 index 8016cac..0000000 --- a/billforward/models/refund_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class RefundPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - RefundPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Refund]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this RefundPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this RefundPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this RefundPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this RefundPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this RefundPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this RefundPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this RefundPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this RefundPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this RefundPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this RefundPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this RefundPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this RefundPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this RefundPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this RefundPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this RefundPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this RefundPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this RefundPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this RefundPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this RefundPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this RefundPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this RefundPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this RefundPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this RefundPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this RefundPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this RefundPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this RefundPagedMetadata. - :rtype: list[Refund] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this RefundPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this RefundPagedMetadata. - :type: list[Refund] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/remove_credit_account_request.py b/billforward/models/remove_credit_account_request.py new file mode 100644 index 0000000..47d2991 --- /dev/null +++ b/billforward/models/remove_credit_account_request.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class RemoveCreditAccountRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'value': 'float', + 'currency': 'CreditNoteCurrency' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'value': 'value', + 'currency': 'currency' + } + + def __init__(self, created=None, organization_id=None, value=None, currency=None): # noqa: E501 + """RemoveCreditAccountRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._value = None + self._currency = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if value is not None: + self.value = value + if currency is not None: + self.currency = currency + + @property + def created(self): + """Gets the created of this RemoveCreditAccountRequest. # noqa: E501 + + + :return: The created of this RemoveCreditAccountRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this RemoveCreditAccountRequest. + + + :param created: The created of this RemoveCreditAccountRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this RemoveCreditAccountRequest. # noqa: E501 + + + :return: The organization_id of this RemoveCreditAccountRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this RemoveCreditAccountRequest. + + + :param organization_id: The organization_id of this RemoveCreditAccountRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def value(self): + """Gets the value of this RemoveCreditAccountRequest. # noqa: E501 + + + :return: The value of this RemoveCreditAccountRequest. # noqa: E501 + :rtype: float + """ + return self._value + + @value.setter + def value(self, value): + """Sets the value of this RemoveCreditAccountRequest. + + + :param value: The value of this RemoveCreditAccountRequest. # noqa: E501 + :type: float + """ + + self._value = value + + @property + def currency(self): + """Gets the currency of this RemoveCreditAccountRequest. # noqa: E501 + + + :return: The currency of this RemoveCreditAccountRequest. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this RemoveCreditAccountRequest. + + + :param currency: The currency of this RemoveCreditAccountRequest. # noqa: E501 + :type: CreditNoteCurrency + """ + + self._currency = currency + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(RemoveCreditAccountRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, RemoveCreditAccountRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/resume_request.py b/billforward/models/resume_request.py index d0bff14..4fa806c 100644 --- a/billforward/models/resume_request.py +++ b/billforward/models/resume_request.py @@ -1,79 +1,93 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class ResumeRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, resume=None, dry_run=False): - """ - ResumeRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'resume': 'datetime', - 'dry_run': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'resume': 'resume', - 'dry_run': 'dryRun' - } - - self._created = created - self._resume = resume - self._dry_run = dry_run + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'resume': 'datetime', + 'new_subscription_start': 'datetime', + 'new_subscription_state': 'str', + 'organization_id': 'str', + 'subscription_id': 'str', + 'dry_run': 'bool' + } + + attribute_map = { + 'created': 'created', + 'resume': 'resume', + 'new_subscription_start': 'newSubscriptionStart', + 'new_subscription_state': 'newSubscriptionState', + 'organization_id': 'organizationID', + 'subscription_id': 'subscriptionID', + 'dry_run': 'dryRun' + } + + def __init__(self, created=None, resume=None, new_subscription_start=None, new_subscription_state=None, organization_id=None, subscription_id=None, dry_run=None): # noqa: E501 + """ResumeRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._resume = None + self._new_subscription_start = None + self._new_subscription_state = None + self._organization_id = None + self._subscription_id = None + self._dry_run = None + self.discriminator = None + if created is not None: + self.created = created + if resume is not None: + self.resume = resume + if new_subscription_start is not None: + self.new_subscription_start = new_subscription_start + if new_subscription_state is not None: + self.new_subscription_state = new_subscription_state + if organization_id is not None: + self.organization_id = organization_id + if subscription_id is not None: + self.subscription_id = subscription_id + if dry_run is not None: + self.dry_run = dry_run @property def created(self): - """ - Gets the created of this ResumeRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this ResumeRequest. # noqa: E501 - :return: The created of this ResumeRequest. + + :return: The created of this ResumeRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this ResumeRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this ResumeRequest. + - :param created: The created of this ResumeRequest. + :param created: The created of this ResumeRequest. # noqa: E501 :type: datetime """ @@ -81,57 +95,141 @@ def created(self, created): @property def resume(self): - """ - Gets the resume of this ResumeRequest. - {\"default\":\"(Resume immediately)\",\"description\":\"Schedules the resumption to be actioned at some future time.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the resume of this ResumeRequest. # noqa: E501 + - :return: The resume of this ResumeRequest. + :return: The resume of this ResumeRequest. # noqa: E501 :rtype: datetime """ return self._resume @resume.setter def resume(self, resume): - """ - Sets the resume of this ResumeRequest. - {\"default\":\"(Resume immediately)\",\"description\":\"Schedules the resumption to be actioned at some future time.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the resume of this ResumeRequest. + - :param resume: The resume of this ResumeRequest. + :param resume: The resume of this ResumeRequest. # noqa: E501 :type: datetime """ self._resume = resume @property - def dry_run(self): + def new_subscription_start(self): + """Gets the new_subscription_start of this ResumeRequest. # noqa: E501 + + + :return: The new_subscription_start of this ResumeRequest. # noqa: E501 + :rtype: datetime + """ + return self._new_subscription_start + + @new_subscription_start.setter + def new_subscription_start(self, new_subscription_start): + """Sets the new_subscription_start of this ResumeRequest. + + + :param new_subscription_start: The new_subscription_start of this ResumeRequest. # noqa: E501 + :type: datetime + """ + + self._new_subscription_start = new_subscription_start + + @property + def new_subscription_state(self): + """Gets the new_subscription_state of this ResumeRequest. # noqa: E501 + + + :return: The new_subscription_state of this ResumeRequest. # noqa: E501 + :rtype: str """ - Gets the dry_run of this ResumeRequest. - {\"default\":false,\"description\":\"Changes described in the response:
true — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.
false — Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} + return self._new_subscription_state + + @new_subscription_state.setter + def new_subscription_state(self, new_subscription_state): + """Sets the new_subscription_state of this ResumeRequest. - :return: The dry_run of this ResumeRequest. + + :param new_subscription_state: The new_subscription_state of this ResumeRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"] # noqa: E501 + if new_subscription_state not in allowed_values: + raise ValueError( + "Invalid value for `new_subscription_state` ({0}), must be one of {1}" # noqa: E501 + .format(new_subscription_state, allowed_values) + ) + + self._new_subscription_state = new_subscription_state + + @property + def organization_id(self): + """Gets the organization_id of this ResumeRequest. # noqa: E501 + + + :return: The organization_id of this ResumeRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this ResumeRequest. + + + :param organization_id: The organization_id of this ResumeRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def subscription_id(self): + """Gets the subscription_id of this ResumeRequest. # noqa: E501 + + + :return: The subscription_id of this ResumeRequest. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this ResumeRequest. + + + :param subscription_id: The subscription_id of this ResumeRequest. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def dry_run(self): + """Gets the dry_run of this ResumeRequest. # noqa: E501 + + + :return: The dry_run of this ResumeRequest. # noqa: E501 :rtype: bool """ return self._dry_run @dry_run.setter def dry_run(self, dry_run): - """ - Sets the dry_run of this ResumeRequest. - {\"default\":false,\"description\":\"Changes described in the response:
true — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.
false — Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the dry_run of this ResumeRequest. + - :param dry_run: The dry_run of this ResumeRequest. + :param dry_run: The dry_run of this ResumeRequest. # noqa: E501 :type: bool """ self._dry_run = dry_run def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -148,29 +246,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(ResumeRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, ResumeRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/resume_subscription_amendment.py b/billforward/models/resume_subscription_amendment.py index f72a913..b5389ac 100644 --- a/billforward/models/resume_subscription_amendment.py +++ b/billforward/models/resume_subscription_amendment.py @@ -1,389 +1,111 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class ResumeSubscriptionAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class ResumeSubscriptionAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False): - """ - ResumeSubscriptionAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'new_subscription_state': 'str', + 'new_subscription_start': 'datetime' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'new_subscription_state': 'newSubscriptionState', + 'new_subscription_start': 'newSubscriptionStart' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, new_subscription_state=None, new_subscription_start=None, *args, **kwargs): # noqa: E501 + """ResumeSubscriptionAmendment - a model defined in Swagger""" # noqa: E501 + self._new_subscription_state = None + self._new_subscription_start = None + self.discriminator = None + if new_subscription_state is not None: + self.new_subscription_state = new_subscription_state + if new_subscription_start is not None: + self.new_subscription_start = new_subscription_start + Amendment.__init__(self, *args, **kwargs) @property - def created(self): - """ - Gets the created of this ResumeSubscriptionAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + def new_subscription_state(self): + """Gets the new_subscription_state of this ResumeSubscriptionAmendment. # noqa: E501 - :return: The created of this ResumeSubscriptionAmendment. - :rtype: datetime - """ - return self._created - @created.setter - def created(self, created): - """ - Sets the created of this ResumeSubscriptionAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this ResumeSubscriptionAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this ResumeSubscriptionAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this ResumeSubscriptionAmendment. + :return: The new_subscription_state of this ResumeSubscriptionAmendment. # noqa: E501 :rtype: str """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this ResumeSubscriptionAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this ResumeSubscriptionAmendment. - :type: str - """ + return self._new_subscription_state - self._changed_by = changed_by + @new_subscription_state.setter + def new_subscription_state(self, new_subscription_state): + """Sets the new_subscription_state of this ResumeSubscriptionAmendment. - @property - def updated(self): - """ - Gets the updated of this ResumeSubscriptionAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - :return: The updated of this ResumeSubscriptionAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this ResumeSubscriptionAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this ResumeSubscriptionAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this ResumeSubscriptionAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this ResumeSubscriptionAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this ResumeSubscriptionAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this ResumeSubscriptionAmendment. + :param new_subscription_state: The new_subscription_state of this ResumeSubscriptionAmendment. # noqa: E501 :type: str """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: + allowed_values = ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"] # noqa: E501 + if new_subscription_state not in allowed_values: raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) + "Invalid value for `new_subscription_state` ({0}), must be one of {1}" # noqa: E501 + .format(new_subscription_state, allowed_values) ) - self._type = type - - @property - def id(self): - """ - Gets the id of this ResumeSubscriptionAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this ResumeSubscriptionAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ResumeSubscriptionAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this ResumeSubscriptionAmendment. - :type: str - """ - - self._id = id + self._new_subscription_state = new_subscription_state @property - def organization_id(self): - """ - Gets the organization_id of this ResumeSubscriptionAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this ResumeSubscriptionAmendment. - :rtype: str - """ - return self._organization_id + def new_subscription_start(self): + """Gets the new_subscription_start of this ResumeSubscriptionAmendment. # noqa: E501 - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this ResumeSubscriptionAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this ResumeSubscriptionAmendment. - :type: str - """ - - self._organization_id = organization_id - @property - def subscription_id(self): - """ - Gets the subscription_id of this ResumeSubscriptionAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this ResumeSubscriptionAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this ResumeSubscriptionAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this ResumeSubscriptionAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this ResumeSubscriptionAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this ResumeSubscriptionAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this ResumeSubscriptionAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this ResumeSubscriptionAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this ResumeSubscriptionAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this ResumeSubscriptionAmendment. + :return: The new_subscription_start of this ResumeSubscriptionAmendment. # noqa: E501 :rtype: datetime """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this ResumeSubscriptionAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + return self._new_subscription_start - :param actioning_time: The actioning_time of this ResumeSubscriptionAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this ResumeSubscriptionAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this ResumeSubscriptionAmendment. - :rtype: datetime - """ - return self._actioned_time + @new_subscription_start.setter + def new_subscription_start(self, new_subscription_start): + """Sets the new_subscription_start of this ResumeSubscriptionAmendment. - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this ResumeSubscriptionAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - :param actioned_time: The actioned_time of this ResumeSubscriptionAmendment. + :param new_subscription_start: The new_subscription_start of this ResumeSubscriptionAmendment. # noqa: E501 :type: datetime """ - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this ResumeSubscriptionAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this ResumeSubscriptionAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this ResumeSubscriptionAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this ResumeSubscriptionAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this ResumeSubscriptionAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this ResumeSubscriptionAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this ResumeSubscriptionAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this ResumeSubscriptionAmendment. - :type: bool - """ - - self._deleted = deleted + self._new_subscription_start = new_subscription_start def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -400,29 +122,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(ResumeSubscriptionAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, ResumeSubscriptionAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/revenue_attribution.py b/billforward/models/revenue_attribution.py deleted file mode 100644 index e7f2911..0000000 --- a/billforward/models/revenue_attribution.py +++ /dev/null @@ -1,722 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class RevenueAttribution(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, period_start=None, period_end=None, created=None, changed_by=None, id=None, organization_id=None, invoice_id=None, invoice_version_id=None, aggregated_invoice_id=None, aggregated_invoice_line_id=None, currency=None, nominal_amount=None, actual_amount=None, pricing_component_id=None, pricing_component_name=None, product_rate_plan_id=None, product_rate_plan_name=None, product_rate_plan_name_public=None, product_id=None, product_name=None, product_name_public=None, aggregated_subscription_id=None, subscription_id=None, account_id=None): - """ - RevenueAttribution - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'period_start': 'datetime', - 'period_end': 'datetime', - 'created': 'datetime', - 'changed_by': 'str', - 'id': 'str', - 'organization_id': 'str', - 'invoice_id': 'str', - 'invoice_version_id': 'str', - 'aggregated_invoice_id': 'str', - 'aggregated_invoice_line_id': 'str', - 'currency': 'str', - 'nominal_amount': 'float', - 'actual_amount': 'float', - 'pricing_component_id': 'str', - 'pricing_component_name': 'str', - 'product_rate_plan_id': 'str', - 'product_rate_plan_name': 'str', - 'product_rate_plan_name_public': 'str', - 'product_id': 'str', - 'product_name': 'str', - 'product_name_public': 'str', - 'aggregated_subscription_id': 'str', - 'subscription_id': 'str', - 'account_id': 'str' - } - - self.attribute_map = { - 'period_start': 'periodStart', - 'period_end': 'periodEnd', - 'created': 'created', - 'changed_by': 'changedBy', - 'id': 'id', - 'organization_id': 'organizationID', - 'invoice_id': 'invoiceID', - 'invoice_version_id': 'invoiceVersionID', - 'aggregated_invoice_id': 'aggregatedInvoiceID', - 'aggregated_invoice_line_id': 'aggregatedInvoiceLineID', - 'currency': 'currency', - 'nominal_amount': 'nominalAmount', - 'actual_amount': 'actualAmount', - 'pricing_component_id': 'pricingComponentID', - 'pricing_component_name': 'pricingComponentName', - 'product_rate_plan_id': 'productRatePlanID', - 'product_rate_plan_name': 'productRatePlanName', - 'product_rate_plan_name_public': 'productRatePlanNamePublic', - 'product_id': 'productID', - 'product_name': 'productName', - 'product_name_public': 'productNamePublic', - 'aggregated_subscription_id': 'aggregatedSubscriptionID', - 'subscription_id': 'subscriptionID', - 'account_id': 'accountID' - } - - self._period_start = period_start - self._period_end = period_end - self._created = created - self._changed_by = changed_by - self._id = id - self._organization_id = organization_id - self._invoice_id = invoice_id - self._invoice_version_id = invoice_version_id - self._aggregated_invoice_id = aggregated_invoice_id - self._aggregated_invoice_line_id = aggregated_invoice_line_id - self._currency = currency - self._nominal_amount = nominal_amount - self._actual_amount = actual_amount - self._pricing_component_id = pricing_component_id - self._pricing_component_name = pricing_component_name - self._product_rate_plan_id = product_rate_plan_id - self._product_rate_plan_name = product_rate_plan_name - self._product_rate_plan_name_public = product_rate_plan_name_public - self._product_id = product_id - self._product_name = product_name - self._product_name_public = product_name_public - self._aggregated_subscription_id = aggregated_subscription_id - self._subscription_id = subscription_id - self._account_id = account_id - - @property - def period_start(self): - """ - Gets the period_start of this RevenueAttribution. - {\"description\":\"PeriodStart of the charge with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The period_start of this RevenueAttribution. - :rtype: datetime - """ - return self._period_start - - @period_start.setter - def period_start(self, period_start): - """ - Sets the period_start of this RevenueAttribution. - {\"description\":\"PeriodStart of the charge with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param period_start: The period_start of this RevenueAttribution. - :type: datetime - """ - - self._period_start = period_start - - @property - def period_end(self): - """ - Gets the period_end of this RevenueAttribution. - {\"description\":\"PeriodEnd of the charge with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The period_end of this RevenueAttribution. - :rtype: datetime - """ - return self._period_end - - @period_end.setter - def period_end(self, period_end): - """ - Sets the period_end of this RevenueAttribution. - {\"description\":\"PeriodEnd of the charge with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param period_end: The period_end of this RevenueAttribution. - :type: datetime - """ - - self._period_end = period_end - - @property - def created(self): - """ - Gets the created of this RevenueAttribution. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this RevenueAttribution. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this RevenueAttribution. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this RevenueAttribution. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this RevenueAttribution. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this RevenueAttribution. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this RevenueAttribution. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this RevenueAttribution. - :type: str - """ - - self._changed_by = changed_by - - @property - def id(self): - """ - Gets the id of this RevenueAttribution. - {\"description\":\"ID of the RevenueAttribution.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The id of this RevenueAttribution. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this RevenueAttribution. - {\"description\":\"ID of the RevenueAttribution.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param id: The id of this RevenueAttribution. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this RevenueAttribution. - {\"description\":\"ID of the organization associated with the RevenueAttribution.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The organization_id of this RevenueAttribution. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this RevenueAttribution. - {\"description\":\"ID of the organization associated with the RevenueAttribution.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param organization_id: The organization_id of this RevenueAttribution. - :type: str - """ - - self._organization_id = organization_id - - @property - def invoice_id(self): - """ - Gets the invoice_id of this RevenueAttribution. - {\"description\":\"Consistent ID of the invoice which is expected to be consulted when paying for the billed feature described in this RevenueAttribution. That is: the top parent of that billed feature.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The invoice_id of this RevenueAttribution. - :rtype: str - """ - return self._invoice_id - - @invoice_id.setter - def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this RevenueAttribution. - {\"description\":\"Consistent ID of the invoice which is expected to be consulted when paying for the billed feature described in this RevenueAttribution. That is: the top parent of that billed feature.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param invoice_id: The invoice_id of this RevenueAttribution. - :type: str - """ - - self._invoice_id = invoice_id - - @property - def invoice_version_id(self): - """ - Gets the invoice_version_id of this RevenueAttribution. - {\"description\":\"Version ID of the invoice which is expected to be consulted when paying for the billed feature described in this RevenueAttribution. That is: the top parent of that billed feature.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The invoice_version_id of this RevenueAttribution. - :rtype: str - """ - return self._invoice_version_id - - @invoice_version_id.setter - def invoice_version_id(self, invoice_version_id): - """ - Sets the invoice_version_id of this RevenueAttribution. - {\"description\":\"Version ID of the invoice which is expected to be consulted when paying for the billed feature described in this RevenueAttribution. That is: the top parent of that billed feature.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param invoice_version_id: The invoice_version_id of this RevenueAttribution. - :type: str - """ - - self._invoice_version_id = invoice_version_id - - @property - def aggregated_invoice_id(self): - """ - Gets the aggregated_invoice_id of this RevenueAttribution. - {\"description\":\"ID of the invoice to which this RevenueAttribution's invoice line belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The aggregated_invoice_id of this RevenueAttribution. - :rtype: str - """ - return self._aggregated_invoice_id - - @aggregated_invoice_id.setter - def aggregated_invoice_id(self, aggregated_invoice_id): - """ - Sets the aggregated_invoice_id of this RevenueAttribution. - {\"description\":\"ID of the invoice to which this RevenueAttribution's invoice line belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param aggregated_invoice_id: The aggregated_invoice_id of this RevenueAttribution. - :type: str - """ - - self._aggregated_invoice_id = aggregated_invoice_id - - @property - def aggregated_invoice_line_id(self): - """ - Gets the aggregated_invoice_line_id of this RevenueAttribution. - {\"description\":\"ID of the invoice line whose debt this RevenueAttribution describes.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The aggregated_invoice_line_id of this RevenueAttribution. - :rtype: str - """ - return self._aggregated_invoice_line_id - - @aggregated_invoice_line_id.setter - def aggregated_invoice_line_id(self, aggregated_invoice_line_id): - """ - Sets the aggregated_invoice_line_id of this RevenueAttribution. - {\"description\":\"ID of the invoice line whose debt this RevenueAttribution describes.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param aggregated_invoice_line_id: The aggregated_invoice_line_id of this RevenueAttribution. - :type: str - """ - - self._aggregated_invoice_line_id = aggregated_invoice_line_id - - @property - def currency(self): - """ - Gets the currency of this RevenueAttribution. - {\"description\":\"The currency of the Invoice from which this RevenueAttribution was raised — specified by a three-character ISO 4217 currency code.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The currency of this RevenueAttribution. - :rtype: str - """ - return self._currency - - @currency.setter - def currency(self, currency): - """ - Sets the currency of this RevenueAttribution. - {\"description\":\"The currency of the Invoice from which this RevenueAttribution was raised — specified by a three-character ISO 4217 currency code.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param currency: The currency of this RevenueAttribution. - :type: str - """ - - self._currency = currency - - @property - def nominal_amount(self): - """ - Gets the nominal_amount of this RevenueAttribution. - {\"description\":\"The amount paid — through credit or otherwise — toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The nominal_amount of this RevenueAttribution. - :rtype: float - """ - return self._nominal_amount - - @nominal_amount.setter - def nominal_amount(self, nominal_amount): - """ - Sets the nominal_amount of this RevenueAttribution. - {\"description\":\"The amount paid — through credit or otherwise — toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param nominal_amount: The nominal_amount of this RevenueAttribution. - :type: float - """ - - self._nominal_amount = nominal_amount - - @property - def actual_amount(self): - """ - Gets the actual_amount of this RevenueAttribution. - {\"description\":\"The amount paid — through real money — toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The actual_amount of this RevenueAttribution. - :rtype: float - """ - return self._actual_amount - - @actual_amount.setter - def actual_amount(self, actual_amount): - """ - Sets the actual_amount of this RevenueAttribution. - {\"description\":\"The amount paid — through real money — toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param actual_amount: The actual_amount of this RevenueAttribution. - :type: float - """ - - self._actual_amount = actual_amount - - @property - def pricing_component_id(self): - """ - Gets the pricing_component_id of this RevenueAttribution. - {\"description\":\"ID of the PricingComponent with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The pricing_component_id of this RevenueAttribution. - :rtype: str - """ - return self._pricing_component_id - - @pricing_component_id.setter - def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this RevenueAttribution. - {\"description\":\"ID of the PricingComponent with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param pricing_component_id: The pricing_component_id of this RevenueAttribution. - :type: str - """ - - self._pricing_component_id = pricing_component_id - - @property - def pricing_component_name(self): - """ - Gets the pricing_component_name of this RevenueAttribution. - {\"description\":\"Name of the PricingComponent with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The pricing_component_name of this RevenueAttribution. - :rtype: str - """ - return self._pricing_component_name - - @pricing_component_name.setter - def pricing_component_name(self, pricing_component_name): - """ - Sets the pricing_component_name of this RevenueAttribution. - {\"description\":\"Name of the PricingComponent with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param pricing_component_name: The pricing_component_name of this RevenueAttribution. - :type: str - """ - - self._pricing_component_name = pricing_component_name - - @property - def product_rate_plan_id(self): - """ - Gets the product_rate_plan_id of this RevenueAttribution. - {\"description\":\"ID of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_rate_plan_id of this RevenueAttribution. - :rtype: str - """ - return self._product_rate_plan_id - - @product_rate_plan_id.setter - def product_rate_plan_id(self, product_rate_plan_id): - """ - Sets the product_rate_plan_id of this RevenueAttribution. - {\"description\":\"ID of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_rate_plan_id: The product_rate_plan_id of this RevenueAttribution. - :type: str - """ - - self._product_rate_plan_id = product_rate_plan_id - - @property - def product_rate_plan_name(self): - """ - Gets the product_rate_plan_name of this RevenueAttribution. - {\"description\":\"Internal name of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_rate_plan_name of this RevenueAttribution. - :rtype: str - """ - return self._product_rate_plan_name - - @product_rate_plan_name.setter - def product_rate_plan_name(self, product_rate_plan_name): - """ - Sets the product_rate_plan_name of this RevenueAttribution. - {\"description\":\"Internal name of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_rate_plan_name: The product_rate_plan_name of this RevenueAttribution. - :type: str - """ - - self._product_rate_plan_name = product_rate_plan_name - - @property - def product_rate_plan_name_public(self): - """ - Gets the product_rate_plan_name_public of this RevenueAttribution. - {\"description\":\"Public name of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_rate_plan_name_public of this RevenueAttribution. - :rtype: str - """ - return self._product_rate_plan_name_public - - @product_rate_plan_name_public.setter - def product_rate_plan_name_public(self, product_rate_plan_name_public): - """ - Sets the product_rate_plan_name_public of this RevenueAttribution. - {\"description\":\"Public name of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_rate_plan_name_public: The product_rate_plan_name_public of this RevenueAttribution. - :type: str - """ - - self._product_rate_plan_name_public = product_rate_plan_name_public - - @property - def product_id(self): - """ - Gets the product_id of this RevenueAttribution. - {\"description\":\"ID of the Product with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_id of this RevenueAttribution. - :rtype: str - """ - return self._product_id - - @product_id.setter - def product_id(self, product_id): - """ - Sets the product_id of this RevenueAttribution. - {\"description\":\"ID of the Product with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_id: The product_id of this RevenueAttribution. - :type: str - """ - - self._product_id = product_id - - @property - def product_name(self): - """ - Gets the product_name of this RevenueAttribution. - {\"description\":\"Internal name of the Product with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_name of this RevenueAttribution. - :rtype: str - """ - return self._product_name - - @product_name.setter - def product_name(self, product_name): - """ - Sets the product_name of this RevenueAttribution. - {\"description\":\"Internal name of the Product with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_name: The product_name of this RevenueAttribution. - :type: str - """ - - self._product_name = product_name - - @property - def product_name_public(self): - """ - Gets the product_name_public of this RevenueAttribution. - {\"description\":\"Public name of the Product with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The product_name_public of this RevenueAttribution. - :rtype: str - """ - return self._product_name_public - - @product_name_public.setter - def product_name_public(self, product_name_public): - """ - Sets the product_name_public of this RevenueAttribution. - {\"description\":\"Public name of the Product with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param product_name_public: The product_name_public of this RevenueAttribution. - :type: str - """ - - self._product_name_public = product_name_public - - @property - def aggregated_subscription_id(self): - """ - Gets the aggregated_subscription_id of this RevenueAttribution. - {\"description\":\"ID of the Subscription with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The aggregated_subscription_id of this RevenueAttribution. - :rtype: str - """ - return self._aggregated_subscription_id - - @aggregated_subscription_id.setter - def aggregated_subscription_id(self, aggregated_subscription_id): - """ - Sets the aggregated_subscription_id of this RevenueAttribution. - {\"description\":\"ID of the Subscription with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param aggregated_subscription_id: The aggregated_subscription_id of this RevenueAttribution. - :type: str - """ - - self._aggregated_subscription_id = aggregated_subscription_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this RevenueAttribution. - {\"description\":\"Consistent ID of the Subscription which pays for this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The subscription_id of this RevenueAttribution. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this RevenueAttribution. - {\"description\":\"Consistent ID of the Subscription which pays for this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param subscription_id: The subscription_id of this RevenueAttribution. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def account_id(self): - """ - Gets the account_id of this RevenueAttribution. - {\"description\":\"ID of the Account with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The account_id of this RevenueAttribution. - :rtype: str - """ - return self._account_id - - @account_id.setter - def account_id(self, account_id): - """ - Sets the account_id of this RevenueAttribution. - {\"description\":\"ID of the Account with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param account_id: The account_id of this RevenueAttribution. - :type: str - """ - - self._account_id = account_id - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/revenue_attribution_paged_metadata.py b/billforward/models/revenue_attribution_paged_metadata.py deleted file mode 100644 index 2a45ed9..0000000 --- a/billforward/models/revenue_attribution_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class RevenueAttributionPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - RevenueAttributionPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[RevenueAttribution]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this RevenueAttributionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this RevenueAttributionPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this RevenueAttributionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this RevenueAttributionPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this RevenueAttributionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this RevenueAttributionPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this RevenueAttributionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this RevenueAttributionPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this RevenueAttributionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this RevenueAttributionPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this RevenueAttributionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this RevenueAttributionPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this RevenueAttributionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this RevenueAttributionPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this RevenueAttributionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this RevenueAttributionPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this RevenueAttributionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this RevenueAttributionPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this RevenueAttributionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this RevenueAttributionPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this RevenueAttributionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this RevenueAttributionPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this RevenueAttributionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this RevenueAttributionPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this RevenueAttributionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this RevenueAttributionPagedMetadata. - :rtype: list[RevenueAttribution] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this RevenueAttributionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this RevenueAttributionPagedMetadata. - :type: list[RevenueAttribution] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/revenue_attributions.py b/billforward/models/revenue_attributions.py new file mode 100644 index 0000000..7468ead --- /dev/null +++ b/billforward/models/revenue_attributions.py @@ -0,0 +1,853 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class RevenueAttributions(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'id': 'str', + 'organization_id': 'str', + 'invoice_id': 'str', + 'invoice_version_id': 'str', + 'child_invoice_version_id': 'str', + 'child_invoice_line_id': 'str', + 'currency': 'CreditNoteCurrency', + 'nominal_amount': 'float', + 'actual_amount': 'float', + 'pricing_component_id': 'str', + 'pricing_component_name': 'str', + 'product_rate_plan_id': 'str', + 'product_rate_plan_name': 'str', + 'product_rate_plan_name_public': 'str', + 'product_id': 'str', + 'product_name': 'str', + 'product_name_public': 'str', + 'child_subscription_id': 'str', + 'subscription_id': 'str', + 'account_id': 'str', + 'period_start': 'datetime', + 'period_end': 'datetime', + 'pricing_component_charge_type': 'str', + 'debit_quantity': 'int', + 'province': 'str', + 'country': 'str', + 'manual_charge_name': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'id': 'id', + 'organization_id': 'organizationID', + 'invoice_id': 'invoiceID', + 'invoice_version_id': 'invoiceVersionID', + 'child_invoice_version_id': 'childInvoiceVersionID', + 'child_invoice_line_id': 'childInvoiceLineID', + 'currency': 'currency', + 'nominal_amount': 'nominalAmount', + 'actual_amount': 'actualAmount', + 'pricing_component_id': 'pricingComponentID', + 'pricing_component_name': 'pricingComponentName', + 'product_rate_plan_id': 'productRatePlanID', + 'product_rate_plan_name': 'productRatePlanName', + 'product_rate_plan_name_public': 'productRatePlanNamePublic', + 'product_id': 'productID', + 'product_name': 'productName', + 'product_name_public': 'productNamePublic', + 'child_subscription_id': 'childSubscriptionID', + 'subscription_id': 'subscriptionID', + 'account_id': 'accountID', + 'period_start': 'periodStart', + 'period_end': 'periodEnd', + 'pricing_component_charge_type': 'pricingComponentChargeType', + 'debit_quantity': 'debitQuantity', + 'province': 'province', + 'country': 'country', + 'manual_charge_name': 'manualChargeName' + } + + def __init__(self, created=None, changed_by=None, id=None, organization_id=None, invoice_id=None, invoice_version_id=None, child_invoice_version_id=None, child_invoice_line_id=None, currency=None, nominal_amount=None, actual_amount=None, pricing_component_id=None, pricing_component_name=None, product_rate_plan_id=None, product_rate_plan_name=None, product_rate_plan_name_public=None, product_id=None, product_name=None, product_name_public=None, child_subscription_id=None, subscription_id=None, account_id=None, period_start=None, period_end=None, pricing_component_charge_type=None, debit_quantity=None, province=None, country=None, manual_charge_name=None): # noqa: E501 + """RevenueAttributions - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._id = None + self._organization_id = None + self._invoice_id = None + self._invoice_version_id = None + self._child_invoice_version_id = None + self._child_invoice_line_id = None + self._currency = None + self._nominal_amount = None + self._actual_amount = None + self._pricing_component_id = None + self._pricing_component_name = None + self._product_rate_plan_id = None + self._product_rate_plan_name = None + self._product_rate_plan_name_public = None + self._product_id = None + self._product_name = None + self._product_name_public = None + self._child_subscription_id = None + self._subscription_id = None + self._account_id = None + self._period_start = None + self._period_end = None + self._pricing_component_charge_type = None + self._debit_quantity = None + self._province = None + self._country = None + self._manual_charge_name = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if id is not None: + self.id = id + self.organization_id = organization_id + self.invoice_id = invoice_id + self.invoice_version_id = invoice_version_id + self.child_invoice_version_id = child_invoice_version_id + if child_invoice_line_id is not None: + self.child_invoice_line_id = child_invoice_line_id + self.currency = currency + self.nominal_amount = nominal_amount + self.actual_amount = actual_amount + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if product_rate_plan_id is not None: + self.product_rate_plan_id = product_rate_plan_id + if product_rate_plan_name is not None: + self.product_rate_plan_name = product_rate_plan_name + if product_rate_plan_name_public is not None: + self.product_rate_plan_name_public = product_rate_plan_name_public + if product_id is not None: + self.product_id = product_id + if product_name is not None: + self.product_name = product_name + if product_name_public is not None: + self.product_name_public = product_name_public + if child_subscription_id is not None: + self.child_subscription_id = child_subscription_id + if subscription_id is not None: + self.subscription_id = subscription_id + if account_id is not None: + self.account_id = account_id + self.period_start = period_start + self.period_end = period_end + if pricing_component_charge_type is not None: + self.pricing_component_charge_type = pricing_component_charge_type + if debit_quantity is not None: + self.debit_quantity = debit_quantity + if province is not None: + self.province = province + if country is not None: + self.country = country + if manual_charge_name is not None: + self.manual_charge_name = manual_charge_name + + @property + def created(self): + """Gets the created of this RevenueAttributions. # noqa: E501 + + + :return: The created of this RevenueAttributions. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this RevenueAttributions. + + + :param created: The created of this RevenueAttributions. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this RevenueAttributions. # noqa: E501 + + + :return: The changed_by of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this RevenueAttributions. + + + :param changed_by: The changed_by of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def id(self): + """Gets the id of this RevenueAttributions. # noqa: E501 + + + :return: The id of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this RevenueAttributions. + + + :param id: The id of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this RevenueAttributions. # noqa: E501 + + + :return: The organization_id of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this RevenueAttributions. + + + :param organization_id: The organization_id of this RevenueAttributions. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def invoice_id(self): + """Gets the invoice_id of this RevenueAttributions. # noqa: E501 + + + :return: The invoice_id of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this RevenueAttributions. + + + :param invoice_id: The invoice_id of this RevenueAttributions. # noqa: E501 + :type: str + """ + if invoice_id is None: + raise ValueError("Invalid value for `invoice_id`, must not be `None`") # noqa: E501 + + self._invoice_id = invoice_id + + @property + def invoice_version_id(self): + """Gets the invoice_version_id of this RevenueAttributions. # noqa: E501 + + + :return: The invoice_version_id of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._invoice_version_id + + @invoice_version_id.setter + def invoice_version_id(self, invoice_version_id): + """Sets the invoice_version_id of this RevenueAttributions. + + + :param invoice_version_id: The invoice_version_id of this RevenueAttributions. # noqa: E501 + :type: str + """ + if invoice_version_id is None: + raise ValueError("Invalid value for `invoice_version_id`, must not be `None`") # noqa: E501 + + self._invoice_version_id = invoice_version_id + + @property + def child_invoice_version_id(self): + """Gets the child_invoice_version_id of this RevenueAttributions. # noqa: E501 + + + :return: The child_invoice_version_id of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._child_invoice_version_id + + @child_invoice_version_id.setter + def child_invoice_version_id(self, child_invoice_version_id): + """Sets the child_invoice_version_id of this RevenueAttributions. + + + :param child_invoice_version_id: The child_invoice_version_id of this RevenueAttributions. # noqa: E501 + :type: str + """ + if child_invoice_version_id is None: + raise ValueError("Invalid value for `child_invoice_version_id`, must not be `None`") # noqa: E501 + + self._child_invoice_version_id = child_invoice_version_id + + @property + def child_invoice_line_id(self): + """Gets the child_invoice_line_id of this RevenueAttributions. # noqa: E501 + + + :return: The child_invoice_line_id of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._child_invoice_line_id + + @child_invoice_line_id.setter + def child_invoice_line_id(self, child_invoice_line_id): + """Sets the child_invoice_line_id of this RevenueAttributions. + + + :param child_invoice_line_id: The child_invoice_line_id of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._child_invoice_line_id = child_invoice_line_id + + @property + def currency(self): + """Gets the currency of this RevenueAttributions. # noqa: E501 + + + :return: The currency of this RevenueAttributions. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this RevenueAttributions. + + + :param currency: The currency of this RevenueAttributions. # noqa: E501 + :type: CreditNoteCurrency + """ + if currency is None: + raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501 + + self._currency = currency + + @property + def nominal_amount(self): + """Gets the nominal_amount of this RevenueAttributions. # noqa: E501 + + + :return: The nominal_amount of this RevenueAttributions. # noqa: E501 + :rtype: float + """ + return self._nominal_amount + + @nominal_amount.setter + def nominal_amount(self, nominal_amount): + """Sets the nominal_amount of this RevenueAttributions. + + + :param nominal_amount: The nominal_amount of this RevenueAttributions. # noqa: E501 + :type: float + """ + if nominal_amount is None: + raise ValueError("Invalid value for `nominal_amount`, must not be `None`") # noqa: E501 + + self._nominal_amount = nominal_amount + + @property + def actual_amount(self): + """Gets the actual_amount of this RevenueAttributions. # noqa: E501 + + + :return: The actual_amount of this RevenueAttributions. # noqa: E501 + :rtype: float + """ + return self._actual_amount + + @actual_amount.setter + def actual_amount(self, actual_amount): + """Sets the actual_amount of this RevenueAttributions. + + + :param actual_amount: The actual_amount of this RevenueAttributions. # noqa: E501 + :type: float + """ + if actual_amount is None: + raise ValueError("Invalid value for `actual_amount`, must not be `None`") # noqa: E501 + + self._actual_amount = actual_amount + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this RevenueAttributions. # noqa: E501 + + + :return: The pricing_component_id of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this RevenueAttributions. + + + :param pricing_component_id: The pricing_component_id of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._pricing_component_id = pricing_component_id + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this RevenueAttributions. # noqa: E501 + + + :return: The pricing_component_name of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._pricing_component_name + + @pricing_component_name.setter + def pricing_component_name(self, pricing_component_name): + """Sets the pricing_component_name of this RevenueAttributions. + + + :param pricing_component_name: The pricing_component_name of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._pricing_component_name = pricing_component_name + + @property + def product_rate_plan_id(self): + """Gets the product_rate_plan_id of this RevenueAttributions. # noqa: E501 + + + :return: The product_rate_plan_id of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_id + + @product_rate_plan_id.setter + def product_rate_plan_id(self, product_rate_plan_id): + """Sets the product_rate_plan_id of this RevenueAttributions. + + + :param product_rate_plan_id: The product_rate_plan_id of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._product_rate_plan_id = product_rate_plan_id + + @property + def product_rate_plan_name(self): + """Gets the product_rate_plan_name of this RevenueAttributions. # noqa: E501 + + + :return: The product_rate_plan_name of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_name + + @product_rate_plan_name.setter + def product_rate_plan_name(self, product_rate_plan_name): + """Sets the product_rate_plan_name of this RevenueAttributions. + + + :param product_rate_plan_name: The product_rate_plan_name of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._product_rate_plan_name = product_rate_plan_name + + @property + def product_rate_plan_name_public(self): + """Gets the product_rate_plan_name_public of this RevenueAttributions. # noqa: E501 + + + :return: The product_rate_plan_name_public of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._product_rate_plan_name_public + + @product_rate_plan_name_public.setter + def product_rate_plan_name_public(self, product_rate_plan_name_public): + """Sets the product_rate_plan_name_public of this RevenueAttributions. + + + :param product_rate_plan_name_public: The product_rate_plan_name_public of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._product_rate_plan_name_public = product_rate_plan_name_public + + @property + def product_id(self): + """Gets the product_id of this RevenueAttributions. # noqa: E501 + + + :return: The product_id of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._product_id + + @product_id.setter + def product_id(self, product_id): + """Sets the product_id of this RevenueAttributions. + + + :param product_id: The product_id of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._product_id = product_id + + @property + def product_name(self): + """Gets the product_name of this RevenueAttributions. # noqa: E501 + + + :return: The product_name of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._product_name + + @product_name.setter + def product_name(self, product_name): + """Sets the product_name of this RevenueAttributions. + + + :param product_name: The product_name of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._product_name = product_name + + @property + def product_name_public(self): + """Gets the product_name_public of this RevenueAttributions. # noqa: E501 + + + :return: The product_name_public of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._product_name_public + + @product_name_public.setter + def product_name_public(self, product_name_public): + """Sets the product_name_public of this RevenueAttributions. + + + :param product_name_public: The product_name_public of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._product_name_public = product_name_public + + @property + def child_subscription_id(self): + """Gets the child_subscription_id of this RevenueAttributions. # noqa: E501 + + + :return: The child_subscription_id of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._child_subscription_id + + @child_subscription_id.setter + def child_subscription_id(self, child_subscription_id): + """Sets the child_subscription_id of this RevenueAttributions. + + + :param child_subscription_id: The child_subscription_id of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._child_subscription_id = child_subscription_id + + @property + def subscription_id(self): + """Gets the subscription_id of this RevenueAttributions. # noqa: E501 + + + :return: The subscription_id of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this RevenueAttributions. + + + :param subscription_id: The subscription_id of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def account_id(self): + """Gets the account_id of this RevenueAttributions. # noqa: E501 + + + :return: The account_id of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this RevenueAttributions. + + + :param account_id: The account_id of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def period_start(self): + """Gets the period_start of this RevenueAttributions. # noqa: E501 + + + :return: The period_start of this RevenueAttributions. # noqa: E501 + :rtype: datetime + """ + return self._period_start + + @period_start.setter + def period_start(self, period_start): + """Sets the period_start of this RevenueAttributions. + + + :param period_start: The period_start of this RevenueAttributions. # noqa: E501 + :type: datetime + """ + if period_start is None: + raise ValueError("Invalid value for `period_start`, must not be `None`") # noqa: E501 + + self._period_start = period_start + + @property + def period_end(self): + """Gets the period_end of this RevenueAttributions. # noqa: E501 + + + :return: The period_end of this RevenueAttributions. # noqa: E501 + :rtype: datetime + """ + return self._period_end + + @period_end.setter + def period_end(self, period_end): + """Sets the period_end of this RevenueAttributions. + + + :param period_end: The period_end of this RevenueAttributions. # noqa: E501 + :type: datetime + """ + if period_end is None: + raise ValueError("Invalid value for `period_end`, must not be `None`") # noqa: E501 + + self._period_end = period_end + + @property + def pricing_component_charge_type(self): + """Gets the pricing_component_charge_type of this RevenueAttributions. # noqa: E501 + + + :return: The pricing_component_charge_type of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._pricing_component_charge_type + + @pricing_component_charge_type.setter + def pricing_component_charge_type(self, pricing_component_charge_type): + """Sets the pricing_component_charge_type of this RevenueAttributions. + + + :param pricing_component_charge_type: The pricing_component_charge_type of this RevenueAttributions. # noqa: E501 + :type: str + """ + allowed_values = ["setup", "subscription", "arrears", "usage"] # noqa: E501 + if pricing_component_charge_type not in allowed_values: + raise ValueError( + "Invalid value for `pricing_component_charge_type` ({0}), must be one of {1}" # noqa: E501 + .format(pricing_component_charge_type, allowed_values) + ) + + self._pricing_component_charge_type = pricing_component_charge_type + + @property + def debit_quantity(self): + """Gets the debit_quantity of this RevenueAttributions. # noqa: E501 + + + :return: The debit_quantity of this RevenueAttributions. # noqa: E501 + :rtype: int + """ + return self._debit_quantity + + @debit_quantity.setter + def debit_quantity(self, debit_quantity): + """Sets the debit_quantity of this RevenueAttributions. + + + :param debit_quantity: The debit_quantity of this RevenueAttributions. # noqa: E501 + :type: int + """ + + self._debit_quantity = debit_quantity + + @property + def province(self): + """Gets the province of this RevenueAttributions. # noqa: E501 + + + :return: The province of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._province + + @province.setter + def province(self, province): + """Sets the province of this RevenueAttributions. + + + :param province: The province of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._province = province + + @property + def country(self): + """Gets the country of this RevenueAttributions. # noqa: E501 + + + :return: The country of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._country + + @country.setter + def country(self, country): + """Sets the country of this RevenueAttributions. + + + :param country: The country of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._country = country + + @property + def manual_charge_name(self): + """Gets the manual_charge_name of this RevenueAttributions. # noqa: E501 + + + :return: The manual_charge_name of this RevenueAttributions. # noqa: E501 + :rtype: str + """ + return self._manual_charge_name + + @manual_charge_name.setter + def manual_charge_name(self, manual_charge_name): + """Sets the manual_charge_name of this RevenueAttributions. + + + :param manual_charge_name: The manual_charge_name of this RevenueAttributions. # noqa: E501 + :type: str + """ + + self._manual_charge_name = manual_charge_name + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(RevenueAttributions, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, RevenueAttributions): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/revive_subscription_request.py b/billforward/models/revive_subscription_request.py deleted file mode 100644 index f1b08b5..0000000 --- a/billforward/models/revive_subscription_request.py +++ /dev/null @@ -1,124 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class ReviveSubscriptionRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, subscription_id=None): - """ - ReviveSubscriptionRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'subscription_id': 'str' - } - - self.attribute_map = { - 'subscription_id': 'subscriptionID' - } - - self._subscription_id = subscription_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this ReviveSubscriptionRequest. - - - :return: The subscription_id of this ReviveSubscriptionRequest. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this ReviveSubscriptionRequest. - - - :param subscription_id: The subscription_id of this ReviveSubscriptionRequest. - :type: str - """ - - self._subscription_id = subscription_id - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/role.py b/billforward/models/role.py index 0140f01..e8fbe26 100644 --- a/billforward/models/role.py +++ b/billforward/models/role.py @@ -1,106 +1,118 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class Role(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, name=None, description=None, revoked=None, deleted=False, default_role=False, default_returned=False, permissions=None): - """ - Role - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'name': 'str', - 'description': 'str', - 'revoked': 'datetime', - 'deleted': 'bool', - 'default_role': 'bool', - 'default_returned': 'bool', - 'permissions': 'list[BFPermission]' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'name': 'name', - 'description': 'description', - 'revoked': 'revoked', - 'deleted': 'deleted', - 'default_role': 'defaultRole', - 'default_returned': 'defaultReturned', - 'permissions': 'permissions' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._name = name - self._description = description - self._revoked = revoked - self._deleted = deleted - self._default_role = default_role - self._default_returned = default_returned - self._permissions = permissions + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'name': 'str', + 'description': 'str', + 'revoked': 'datetime', + 'deleted': 'bool', + 'default_role': 'bool', + 'default_returned': 'bool', + 'permissions': 'list[BFPermission]' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'name': 'name', + 'description': 'description', + 'revoked': 'revoked', + 'deleted': 'deleted', + 'default_role': 'defaultRole', + 'default_returned': 'defaultReturned', + 'permissions': 'permissions' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, name=None, description=None, revoked=None, deleted=None, default_role=None, default_returned=None, permissions=None): # noqa: E501 + """Role - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._name = None + self._description = None + self._revoked = None + self._deleted = None + self._default_role = None + self._default_returned = None + self._permissions = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if description is not None: + self.description = description + if revoked is not None: + self.revoked = revoked + if deleted is not None: + self.deleted = deleted + if default_role is not None: + self.default_role = default_role + if default_returned is not None: + self.default_returned = default_returned + if permissions is not None: + self.permissions = permissions @property def created(self): - """ - Gets the created of this Role. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this Role. # noqa: E501 - :return: The created of this Role. + + :return: The created of this Role. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this Role. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this Role. - :param created: The created of this Role. + + :param created: The created of this Role. # noqa: E501 :type: datetime """ @@ -108,22 +120,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this Role. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this Role. # noqa: E501 + - :return: The changed_by of this Role. + :return: The changed_by of this Role. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this Role. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this Role. + - :param changed_by: The changed_by of this Role. + :param changed_by: The changed_by of this Role. # noqa: E501 :type: str """ @@ -131,22 +141,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this Role. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this Role. # noqa: E501 + - :return: The updated of this Role. + :return: The updated of this Role. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this Role. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this Role. - :param updated: The updated of this Role. + + :param updated: The updated of this Role. # noqa: E501 :type: datetime """ @@ -154,22 +162,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this Role. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the id of this Role. # noqa: E501 - :return: The id of this Role. + + :return: The id of this Role. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this Role. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the id of this Role. + - :param id: The id of this Role. + :param id: The id of this Role. # noqa: E501 :type: str """ @@ -177,22 +183,20 @@ def id(self, id): @property def organization_id(self): - """ - Gets the organization_id of this Role. - { \"description\" : \"\", \"verbs\":[\"\"] } + """Gets the organization_id of this Role. # noqa: E501 + - :return: The organization_id of this Role. + :return: The organization_id of this Role. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this Role. - { \"description\" : \"\", \"verbs\":[\"\"] } + """Sets the organization_id of this Role. + - :param organization_id: The organization_id of this Role. + :param organization_id: The organization_id of this Role. # noqa: E501 :type: str """ @@ -200,22 +204,20 @@ def organization_id(self, organization_id): @property def name(self): - """ - Gets the name of this Role. - { \"description\" : \"Friendly name of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the name of this Role. # noqa: E501 - :return: The name of this Role. + + :return: The name of this Role. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this Role. - { \"description\" : \"Friendly name of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the name of this Role. + - :param name: The name of this Role. + :param name: The name of this Role. # noqa: E501 :type: str """ @@ -223,22 +225,20 @@ def name(self, name): @property def description(self): - """ - Gets the description of this Role. - { \"description\" : \"Friendly description of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the description of this Role. # noqa: E501 + - :return: The description of this Role. + :return: The description of this Role. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this Role. - { \"description\" : \"Friendly description of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the description of this Role. - :param description: The description of this Role. + + :param description: The description of this Role. # noqa: E501 :type: str """ @@ -246,22 +246,20 @@ def description(self, description): @property def revoked(self): - """ - Gets the revoked of this Role. - { \"description\" : \"If a role is deleted it is set as revoked from this date. Any account in the role will no longer have its permissions.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the revoked of this Role. # noqa: E501 - :return: The revoked of this Role. + + :return: The revoked of this Role. # noqa: E501 :rtype: datetime """ return self._revoked @revoked.setter def revoked(self, revoked): - """ - Sets the revoked of this Role. - { \"description\" : \"If a role is deleted it is set as revoked from this date. Any account in the role will no longer have its permissions.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the revoked of this Role. + - :param revoked: The revoked of this Role. + :param revoked: The revoked of this Role. # noqa: E501 :type: datetime """ @@ -269,22 +267,20 @@ def revoked(self, revoked): @property def deleted(self): - """ - Gets the deleted of this Role. - { \"default\" : \"false\", \"description\" : \"If a role is deleted any account in the role will no longer have its permissions.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the deleted of this Role. # noqa: E501 + - :return: The deleted of this Role. + :return: The deleted of this Role. # noqa: E501 :rtype: bool """ return self._deleted @deleted.setter def deleted(self, deleted): - """ - Sets the deleted of this Role. - { \"default\" : \"false\", \"description\" : \"If a role is deleted any account in the role will no longer have its permissions.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the deleted of this Role. + - :param deleted: The deleted of this Role. + :param deleted: The deleted of this Role. # noqa: E501 :type: bool """ @@ -292,22 +288,20 @@ def deleted(self, deleted): @property def default_role(self): - """ - Gets the default_role of this Role. - { \"default\" : \"false\", \"description\" : \"If set this role will become the default role for the organization. Any accounts without an explicitly set role will have this applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the default_role of this Role. # noqa: E501 - :return: The default_role of this Role. + + :return: The default_role of this Role. # noqa: E501 :rtype: bool """ return self._default_role @default_role.setter def default_role(self, default_role): - """ - Sets the default_role of this Role. - { \"default\" : \"false\", \"description\" : \"If set this role will become the default role for the organization. Any accounts without an explicitly set role will have this applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the default_role of this Role. - :param default_role: The default_role of this Role. + + :param default_role: The default_role of this Role. # noqa: E501 :type: bool """ @@ -315,22 +309,20 @@ def default_role(self, default_role): @property def default_returned(self): - """ - Gets the default_returned of this Role. - { \"default\" : \"false\", \"description\" : \"When returning the list of roles for an account, this indicates if the role was returned due to defaulting.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the default_returned of this Role. # noqa: E501 + - :return: The default_returned of this Role. + :return: The default_returned of this Role. # noqa: E501 :rtype: bool """ return self._default_returned @default_returned.setter def default_returned(self, default_returned): - """ - Sets the default_returned of this Role. - { \"default\" : \"false\", \"description\" : \"When returning the list of roles for an account, this indicates if the role was returned due to defaulting.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the default_returned of this Role. + - :param default_returned: The default_returned of this Role. + :param default_returned: The default_returned of this Role. # noqa: E501 :type: bool """ @@ -338,34 +330,30 @@ def default_returned(self, default_returned): @property def permissions(self): - """ - Gets the permissions of this Role. - { \"description\" : \"List of permissions in this role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the permissions of this Role. # noqa: E501 + - :return: The permissions of this Role. + :return: The permissions of this Role. # noqa: E501 :rtype: list[BFPermission] """ return self._permissions @permissions.setter def permissions(self, permissions): - """ - Sets the permissions of this Role. - { \"description\" : \"List of permissions in this role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the permissions of this Role. - :param permissions: The permissions of this Role. + + :param permissions: The permissions of this Role. # noqa: E501 :type: list[BFPermission] """ self._permissions = permissions def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -382,29 +370,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Role, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Role): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/role_paged_metadata.py b/billforward/models/role_paged_metadata.py deleted file mode 100644 index 0d1a5d6..0000000 --- a/billforward/models/role_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class RolePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - RolePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Role]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this RolePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this RolePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this RolePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this RolePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this RolePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this RolePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this RolePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this RolePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this RolePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this RolePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this RolePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this RolePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this RolePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this RolePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this RolePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this RolePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this RolePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this RolePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this RolePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this RolePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this RolePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this RolePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this RolePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this RolePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this RolePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this RolePagedMetadata. - :rtype: list[Role] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this RolePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this RolePagedMetadata. - :type: list[Role] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/rule_satisfaction.py b/billforward/models/rule_satisfaction.py deleted file mode 100644 index c55b3ff..0000000 --- a/billforward/models/rule_satisfaction.py +++ /dev/null @@ -1,202 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class RuleSatisfaction(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, satisfied=False, broken_rules=None, coupon_instance_being_initialised=False, new_user=False): - """ - RuleSatisfaction - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'satisfied': 'bool', - 'broken_rules': 'list[CouponRule]', - 'coupon_instance_being_initialised': 'bool', - 'new_user': 'bool' - } - - self.attribute_map = { - 'satisfied': 'satisfied', - 'broken_rules': 'brokenRules', - 'coupon_instance_being_initialised': 'couponInstanceBeingInitialised', - 'new_user': 'newUser' - } - - self._satisfied = satisfied - self._broken_rules = broken_rules - self._coupon_instance_being_initialised = coupon_instance_being_initialised - self._new_user = new_user - - @property - def satisfied(self): - """ - Gets the satisfied of this RuleSatisfaction. - - - :return: The satisfied of this RuleSatisfaction. - :rtype: bool - """ - return self._satisfied - - @satisfied.setter - def satisfied(self, satisfied): - """ - Sets the satisfied of this RuleSatisfaction. - - - :param satisfied: The satisfied of this RuleSatisfaction. - :type: bool - """ - - self._satisfied = satisfied - - @property - def broken_rules(self): - """ - Gets the broken_rules of this RuleSatisfaction. - - - :return: The broken_rules of this RuleSatisfaction. - :rtype: list[CouponRule] - """ - return self._broken_rules - - @broken_rules.setter - def broken_rules(self, broken_rules): - """ - Sets the broken_rules of this RuleSatisfaction. - - - :param broken_rules: The broken_rules of this RuleSatisfaction. - :type: list[CouponRule] - """ - - self._broken_rules = broken_rules - - @property - def coupon_instance_being_initialised(self): - """ - Gets the coupon_instance_being_initialised of this RuleSatisfaction. - - - :return: The coupon_instance_being_initialised of this RuleSatisfaction. - :rtype: bool - """ - return self._coupon_instance_being_initialised - - @coupon_instance_being_initialised.setter - def coupon_instance_being_initialised(self, coupon_instance_being_initialised): - """ - Sets the coupon_instance_being_initialised of this RuleSatisfaction. - - - :param coupon_instance_being_initialised: The coupon_instance_being_initialised of this RuleSatisfaction. - :type: bool - """ - - self._coupon_instance_being_initialised = coupon_instance_being_initialised - - @property - def new_user(self): - """ - Gets the new_user of this RuleSatisfaction. - - - :return: The new_user of this RuleSatisfaction. - :rtype: bool - """ - return self._new_user - - @new_user.setter - def new_user(self, new_user): - """ - Sets the new_user of this RuleSatisfaction. - - - :param new_user: The new_user of this RuleSatisfaction. - :type: bool - """ - - self._new_user = new_user - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/sage_pay_auth_capture_request.py b/billforward/models/sage_pay_auth_capture_request.py new file mode 100644 index 0000000..22bea1c --- /dev/null +++ b/billforward/models/sage_pay_auth_capture_request.py @@ -0,0 +1,195 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.auth_capture_request import AuthCaptureRequest # noqa: F401,E501 + +class SagePayAuthCaptureRequest(AuthCaptureRequest): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'card_token': 'str', + 'card_type': 'str', + 'expiry_date': 'str', + 'last4_digits': 'str' + } + if hasattr(AuthCaptureRequest, "swagger_types"): + swagger_types.update(AuthCaptureRequest.swagger_types) + + attribute_map = { + 'card_token': 'cardToken', + 'card_type': 'cardType', + 'expiry_date': 'expiryDate', + 'last4_digits': 'last4Digits' + } + if hasattr(AuthCaptureRequest, "attribute_map"): + attribute_map.update(AuthCaptureRequest.attribute_map) + + def __init__(self, card_token=None, card_type=None, expiry_date=None, last4_digits=None, *args, **kwargs): # noqa: E501 + """SagePayAuthCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._card_token = None + self._card_type = None + self._expiry_date = None + self._last4_digits = None + self.discriminator = None + self.card_token = card_token + if card_type is not None: + self.card_type = card_type + if expiry_date is not None: + self.expiry_date = expiry_date + if last4_digits is not None: + self.last4_digits = last4_digits + AuthCaptureRequest.__init__(self, *args, **kwargs) + + @property + def card_token(self): + """Gets the card_token of this SagePayAuthCaptureRequest. # noqa: E501 + + + :return: The card_token of this SagePayAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._card_token + + @card_token.setter + def card_token(self, card_token): + """Sets the card_token of this SagePayAuthCaptureRequest. + + + :param card_token: The card_token of this SagePayAuthCaptureRequest. # noqa: E501 + :type: str + """ + if card_token is None: + raise ValueError("Invalid value for `card_token`, must not be `None`") # noqa: E501 + + self._card_token = card_token + + @property + def card_type(self): + """Gets the card_type of this SagePayAuthCaptureRequest. # noqa: E501 + + + :return: The card_type of this SagePayAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._card_type + + @card_type.setter + def card_type(self, card_type): + """Sets the card_type of this SagePayAuthCaptureRequest. + + + :param card_type: The card_type of this SagePayAuthCaptureRequest. # noqa: E501 + :type: str + """ + + self._card_type = card_type + + @property + def expiry_date(self): + """Gets the expiry_date of this SagePayAuthCaptureRequest. # noqa: E501 + + + :return: The expiry_date of this SagePayAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._expiry_date + + @expiry_date.setter + def expiry_date(self, expiry_date): + """Sets the expiry_date of this SagePayAuthCaptureRequest. + + + :param expiry_date: The expiry_date of this SagePayAuthCaptureRequest. # noqa: E501 + :type: str + """ + + self._expiry_date = expiry_date + + @property + def last4_digits(self): + """Gets the last4_digits of this SagePayAuthCaptureRequest. # noqa: E501 + + + :return: The last4_digits of this SagePayAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._last4_digits + + @last4_digits.setter + def last4_digits(self, last4_digits): + """Sets the last4_digits of this SagePayAuthCaptureRequest. + + + :param last4_digits: The last4_digits of this SagePayAuthCaptureRequest. # noqa: E501 + :type: str + """ + + self._last4_digits = last4_digits + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SagePayAuthCaptureRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SagePayAuthCaptureRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/sage_pay_card_payment.py b/billforward/models/sage_pay_card_payment.py new file mode 100644 index 0000000..3f37609 --- /dev/null +++ b/billforward/models/sage_pay_card_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class SagePayCardPayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """SagePayCardPayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SagePayCardPayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SagePayCardPayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/sage_pay_configuration.py b/billforward/models/sage_pay_configuration.py new file mode 100644 index 0000000..62f0608 --- /dev/null +++ b/billforward/models/sage_pay_configuration.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class SagePayConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'enabled_card_types': 'list[SagePayEnabledCardType]', + 'account_type': 'str', + 'vendor': 'str' + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + 'enabled_card_types': 'enabledCardTypes', + 'account_type': 'accountType', + 'vendor': 'vendor' + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, enabled_card_types=None, account_type=None, vendor=None, *args, **kwargs): # noqa: E501 + """SagePayConfiguration - a model defined in Swagger""" # noqa: E501 + self._enabled_card_types = None + self._account_type = None + self._vendor = None + self.discriminator = None + if enabled_card_types is not None: + self.enabled_card_types = enabled_card_types + if account_type is not None: + self.account_type = account_type + if vendor is not None: + self.vendor = vendor + APIConfiguration.__init__(self, *args, **kwargs) + + @property + def enabled_card_types(self): + """Gets the enabled_card_types of this SagePayConfiguration. # noqa: E501 + + + :return: The enabled_card_types of this SagePayConfiguration. # noqa: E501 + :rtype: list[SagePayEnabledCardType] + """ + return self._enabled_card_types + + @enabled_card_types.setter + def enabled_card_types(self, enabled_card_types): + """Sets the enabled_card_types of this SagePayConfiguration. + + + :param enabled_card_types: The enabled_card_types of this SagePayConfiguration. # noqa: E501 + :type: list[SagePayEnabledCardType] + """ + + self._enabled_card_types = enabled_card_types + + @property + def account_type(self): + """Gets the account_type of this SagePayConfiguration. # noqa: E501 + + + :return: The account_type of this SagePayConfiguration. # noqa: E501 + :rtype: str + """ + return self._account_type + + @account_type.setter + def account_type(self, account_type): + """Sets the account_type of this SagePayConfiguration. + + + :param account_type: The account_type of this SagePayConfiguration. # noqa: E501 + :type: str + """ + + self._account_type = account_type + + @property + def vendor(self): + """Gets the vendor of this SagePayConfiguration. # noqa: E501 + + + :return: The vendor of this SagePayConfiguration. # noqa: E501 + :rtype: str + """ + return self._vendor + + @vendor.setter + def vendor(self, vendor): + """Sets the vendor of this SagePayConfiguration. + + + :param vendor: The vendor of this SagePayConfiguration. # noqa: E501 + :type: str + """ + + self._vendor = vendor + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SagePayConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SagePayConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/sage_pay_enabled_card_type.py b/billforward/models/sage_pay_enabled_card_type.py new file mode 100644 index 0000000..3dbc548 --- /dev/null +++ b/billforward/models/sage_pay_enabled_card_type.py @@ -0,0 +1,302 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SagePayEnabledCardType(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'card_type': 'str', + 'api_configuration_id': 'str', + 'deleted': 'bool', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'card_type': 'cardType', + 'api_configuration_id': 'apiConfigurationID', + 'deleted': 'deleted', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, card_type=None, api_configuration_id=None, deleted=None, organization_id=None): # noqa: E501 + """SagePayEnabledCardType - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._card_type = None + self._api_configuration_id = None + self._deleted = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.card_type = card_type + self.api_configuration_id = api_configuration_id + self.deleted = deleted + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this SagePayEnabledCardType. # noqa: E501 + + + :return: The created of this SagePayEnabledCardType. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this SagePayEnabledCardType. + + + :param created: The created of this SagePayEnabledCardType. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this SagePayEnabledCardType. # noqa: E501 + + + :return: The changed_by of this SagePayEnabledCardType. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this SagePayEnabledCardType. + + + :param changed_by: The changed_by of this SagePayEnabledCardType. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this SagePayEnabledCardType. # noqa: E501 + + + :return: The updated of this SagePayEnabledCardType. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this SagePayEnabledCardType. + + + :param updated: The updated of this SagePayEnabledCardType. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this SagePayEnabledCardType. # noqa: E501 + + + :return: The id of this SagePayEnabledCardType. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this SagePayEnabledCardType. + + + :param id: The id of this SagePayEnabledCardType. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def card_type(self): + """Gets the card_type of this SagePayEnabledCardType. # noqa: E501 + + + :return: The card_type of this SagePayEnabledCardType. # noqa: E501 + :rtype: str + """ + return self._card_type + + @card_type.setter + def card_type(self, card_type): + """Sets the card_type of this SagePayEnabledCardType. + + + :param card_type: The card_type of this SagePayEnabledCardType. # noqa: E501 + :type: str + """ + if card_type is None: + raise ValueError("Invalid value for `card_type`, must not be `None`") # noqa: E501 + allowed_values = ["VISA", "MC", "DELTA", "MAESTRO", "UKE", "AMEX", "DC", "JCB", "LASER", "PAYPAL", "SWITCH", "PLCC", "MCDEBIT", "EPS", "GIROPAY", "IDEAL", "SOFORT", "ELV"] # noqa: E501 + if card_type not in allowed_values: + raise ValueError( + "Invalid value for `card_type` ({0}), must be one of {1}" # noqa: E501 + .format(card_type, allowed_values) + ) + + self._card_type = card_type + + @property + def api_configuration_id(self): + """Gets the api_configuration_id of this SagePayEnabledCardType. # noqa: E501 + + + :return: The api_configuration_id of this SagePayEnabledCardType. # noqa: E501 + :rtype: str + """ + return self._api_configuration_id + + @api_configuration_id.setter + def api_configuration_id(self, api_configuration_id): + """Sets the api_configuration_id of this SagePayEnabledCardType. + + + :param api_configuration_id: The api_configuration_id of this SagePayEnabledCardType. # noqa: E501 + :type: str + """ + if api_configuration_id is None: + raise ValueError("Invalid value for `api_configuration_id`, must not be `None`") # noqa: E501 + + self._api_configuration_id = api_configuration_id + + @property + def deleted(self): + """Gets the deleted of this SagePayEnabledCardType. # noqa: E501 + + + :return: The deleted of this SagePayEnabledCardType. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this SagePayEnabledCardType. + + + :param deleted: The deleted of this SagePayEnabledCardType. # noqa: E501 + :type: bool + """ + if deleted is None: + raise ValueError("Invalid value for `deleted`, must not be `None`") # noqa: E501 + + self._deleted = deleted + + @property + def organization_id(self): + """Gets the organization_id of this SagePayEnabledCardType. # noqa: E501 + + + :return: The organization_id of this SagePayEnabledCardType. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SagePayEnabledCardType. + + + :param organization_id: The organization_id of this SagePayEnabledCardType. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SagePayEnabledCardType, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SagePayEnabledCardType): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/sage_pay_pre_auth_request.py b/billforward/models/sage_pay_pre_auth_request.py new file mode 100644 index 0000000..51c3e84 --- /dev/null +++ b/billforward/models/sage_pay_pre_auth_request.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.tokenization_pre_auth_request import TokenizationPreAuthRequest # noqa: F401,E501 + +class SagePayPreAuthRequest(TokenizationPreAuthRequest): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'currency': 'str', + 'form_profile': 'str', + 'vpsprotocol': 'str' + } + if hasattr(TokenizationPreAuthRequest, "swagger_types"): + swagger_types.update(TokenizationPreAuthRequest.swagger_types) + + attribute_map = { + 'currency': 'currency', + 'form_profile': 'formProfile', + 'vpsprotocol': 'vpsprotocol' + } + if hasattr(TokenizationPreAuthRequest, "attribute_map"): + attribute_map.update(TokenizationPreAuthRequest.attribute_map) + + def __init__(self, currency=None, form_profile=None, vpsprotocol=None, *args, **kwargs): # noqa: E501 + """SagePayPreAuthRequest - a model defined in Swagger""" # noqa: E501 + self._currency = None + self._form_profile = None + self._vpsprotocol = None + self.discriminator = None + if currency is not None: + self.currency = currency + if form_profile is not None: + self.form_profile = form_profile + if vpsprotocol is not None: + self.vpsprotocol = vpsprotocol + TokenizationPreAuthRequest.__init__(self, *args, **kwargs) + + @property + def currency(self): + """Gets the currency of this SagePayPreAuthRequest. # noqa: E501 + + + :return: The currency of this SagePayPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this SagePayPreAuthRequest. + + + :param currency: The currency of this SagePayPreAuthRequest. # noqa: E501 + :type: str + """ + + self._currency = currency + + @property + def form_profile(self): + """Gets the form_profile of this SagePayPreAuthRequest. # noqa: E501 + + + :return: The form_profile of this SagePayPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._form_profile + + @form_profile.setter + def form_profile(self, form_profile): + """Sets the form_profile of this SagePayPreAuthRequest. + + + :param form_profile: The form_profile of this SagePayPreAuthRequest. # noqa: E501 + :type: str + """ + + self._form_profile = form_profile + + @property + def vpsprotocol(self): + """Gets the vpsprotocol of this SagePayPreAuthRequest. # noqa: E501 + + + :return: The vpsprotocol of this SagePayPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._vpsprotocol + + @vpsprotocol.setter + def vpsprotocol(self, vpsprotocol): + """Sets the vpsprotocol of this SagePayPreAuthRequest. + + + :param vpsprotocol: The vpsprotocol of this SagePayPreAuthRequest. # noqa: E501 + :type: str + """ + + self._vpsprotocol = vpsprotocol + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SagePayPreAuthRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SagePayPreAuthRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/salesforce_configuration_response.py b/billforward/models/salesforce_configuration_response.py new file mode 100644 index 0000000..dbfd0d3 --- /dev/null +++ b/billforward/models/salesforce_configuration_response.py @@ -0,0 +1,344 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SalesforceConfigurationResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'username': 'str', + 'access_token': 'str', + 'authorized': 'bool', + 'refresh_token': 'str', + 'instance_url': 'str', + 'user_role': 'str', + 'notification_email_addresses': 'str', + 'use_test_environment': 'bool' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'username': 'username', + 'access_token': 'accessToken', + 'authorized': 'authorized', + 'refresh_token': 'refreshToken', + 'instance_url': 'instanceUrl', + 'user_role': 'userRole', + 'notification_email_addresses': 'notificationEmailAddresses', + 'use_test_environment': 'useTestEnvironment' + } + + def __init__(self, created=None, organization_id=None, username=None, access_token=None, authorized=None, refresh_token=None, instance_url=None, user_role=None, notification_email_addresses=None, use_test_environment=None): # noqa: E501 + """SalesforceConfigurationResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._username = None + self._access_token = None + self._authorized = None + self._refresh_token = None + self._instance_url = None + self._user_role = None + self._notification_email_addresses = None + self._use_test_environment = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if username is not None: + self.username = username + if access_token is not None: + self.access_token = access_token + if authorized is not None: + self.authorized = authorized + if refresh_token is not None: + self.refresh_token = refresh_token + if instance_url is not None: + self.instance_url = instance_url + if user_role is not None: + self.user_role = user_role + if notification_email_addresses is not None: + self.notification_email_addresses = notification_email_addresses + if use_test_environment is not None: + self.use_test_environment = use_test_environment + + @property + def created(self): + """Gets the created of this SalesforceConfigurationResponse. # noqa: E501 + + + :return: The created of this SalesforceConfigurationResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this SalesforceConfigurationResponse. + + + :param created: The created of this SalesforceConfigurationResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this SalesforceConfigurationResponse. # noqa: E501 + + + :return: The organization_id of this SalesforceConfigurationResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SalesforceConfigurationResponse. + + + :param organization_id: The organization_id of this SalesforceConfigurationResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def username(self): + """Gets the username of this SalesforceConfigurationResponse. # noqa: E501 + + + :return: The username of this SalesforceConfigurationResponse. # noqa: E501 + :rtype: str + """ + return self._username + + @username.setter + def username(self, username): + """Sets the username of this SalesforceConfigurationResponse. + + + :param username: The username of this SalesforceConfigurationResponse. # noqa: E501 + :type: str + """ + + self._username = username + + @property + def access_token(self): + """Gets the access_token of this SalesforceConfigurationResponse. # noqa: E501 + + + :return: The access_token of this SalesforceConfigurationResponse. # noqa: E501 + :rtype: str + """ + return self._access_token + + @access_token.setter + def access_token(self, access_token): + """Sets the access_token of this SalesforceConfigurationResponse. + + + :param access_token: The access_token of this SalesforceConfigurationResponse. # noqa: E501 + :type: str + """ + + self._access_token = access_token + + @property + def authorized(self): + """Gets the authorized of this SalesforceConfigurationResponse. # noqa: E501 + + + :return: The authorized of this SalesforceConfigurationResponse. # noqa: E501 + :rtype: bool + """ + return self._authorized + + @authorized.setter + def authorized(self, authorized): + """Sets the authorized of this SalesforceConfigurationResponse. + + + :param authorized: The authorized of this SalesforceConfigurationResponse. # noqa: E501 + :type: bool + """ + + self._authorized = authorized + + @property + def refresh_token(self): + """Gets the refresh_token of this SalesforceConfigurationResponse. # noqa: E501 + + + :return: The refresh_token of this SalesforceConfigurationResponse. # noqa: E501 + :rtype: str + """ + return self._refresh_token + + @refresh_token.setter + def refresh_token(self, refresh_token): + """Sets the refresh_token of this SalesforceConfigurationResponse. + + + :param refresh_token: The refresh_token of this SalesforceConfigurationResponse. # noqa: E501 + :type: str + """ + + self._refresh_token = refresh_token + + @property + def instance_url(self): + """Gets the instance_url of this SalesforceConfigurationResponse. # noqa: E501 + + + :return: The instance_url of this SalesforceConfigurationResponse. # noqa: E501 + :rtype: str + """ + return self._instance_url + + @instance_url.setter + def instance_url(self, instance_url): + """Sets the instance_url of this SalesforceConfigurationResponse. + + + :param instance_url: The instance_url of this SalesforceConfigurationResponse. # noqa: E501 + :type: str + """ + + self._instance_url = instance_url + + @property + def user_role(self): + """Gets the user_role of this SalesforceConfigurationResponse. # noqa: E501 + + + :return: The user_role of this SalesforceConfigurationResponse. # noqa: E501 + :rtype: str + """ + return self._user_role + + @user_role.setter + def user_role(self, user_role): + """Sets the user_role of this SalesforceConfigurationResponse. + + + :param user_role: The user_role of this SalesforceConfigurationResponse. # noqa: E501 + :type: str + """ + + self._user_role = user_role + + @property + def notification_email_addresses(self): + """Gets the notification_email_addresses of this SalesforceConfigurationResponse. # noqa: E501 + + + :return: The notification_email_addresses of this SalesforceConfigurationResponse. # noqa: E501 + :rtype: str + """ + return self._notification_email_addresses + + @notification_email_addresses.setter + def notification_email_addresses(self, notification_email_addresses): + """Sets the notification_email_addresses of this SalesforceConfigurationResponse. + + + :param notification_email_addresses: The notification_email_addresses of this SalesforceConfigurationResponse. # noqa: E501 + :type: str + """ + + self._notification_email_addresses = notification_email_addresses + + @property + def use_test_environment(self): + """Gets the use_test_environment of this SalesforceConfigurationResponse. # noqa: E501 + + + :return: The use_test_environment of this SalesforceConfigurationResponse. # noqa: E501 + :rtype: bool + """ + return self._use_test_environment + + @use_test_environment.setter + def use_test_environment(self, use_test_environment): + """Sets the use_test_environment of this SalesforceConfigurationResponse. + + + :param use_test_environment: The use_test_environment of this SalesforceConfigurationResponse. # noqa: E501 + :type: bool + """ + + self._use_test_environment = use_test_environment + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SalesforceConfigurationResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SalesforceConfigurationResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/search_result_paged_metadata.py b/billforward/models/search_result_paged_metadata.py deleted file mode 100644 index 8338742..0000000 --- a/billforward/models/search_result_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class SearchResultPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - SearchResultPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this SearchResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this SearchResultPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this SearchResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this SearchResultPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this SearchResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this SearchResultPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this SearchResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this SearchResultPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this SearchResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this SearchResultPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this SearchResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this SearchResultPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this SearchResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this SearchResultPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this SearchResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this SearchResultPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this SearchResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this SearchResultPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this SearchResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this SearchResultPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this SearchResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this SearchResultPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this SearchResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this SearchResultPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this SearchResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this SearchResultPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this SearchResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this SearchResultPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/service_end_amendment.py b/billforward/models/service_end_amendment.py index 4cbc3f0..a2dfac1 100644 --- a/billforward/models/service_end_amendment.py +++ b/billforward/models/service_end_amendment.py @@ -1,389 +1,53 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class ServiceEndAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class ServiceEndAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False): - """ - ServiceEndAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - - @property - def created(self): - """ - Gets the created of this ServiceEndAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this ServiceEndAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this ServiceEndAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this ServiceEndAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this ServiceEndAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this ServiceEndAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this ServiceEndAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this ServiceEndAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this ServiceEndAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this ServiceEndAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this ServiceEndAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this ServiceEndAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this ServiceEndAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this ServiceEndAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this ServiceEndAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this ServiceEndAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def id(self): - """ - Gets the id of this ServiceEndAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this ServiceEndAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this ServiceEndAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this ServiceEndAmendment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this ServiceEndAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this ServiceEndAmendment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this ServiceEndAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this ServiceEndAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this ServiceEndAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this ServiceEndAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this ServiceEndAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this ServiceEndAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this ServiceEndAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this ServiceEndAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this ServiceEndAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this ServiceEndAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this ServiceEndAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this ServiceEndAmendment. - :rtype: datetime - """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this ServiceEndAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actioning_time: The actioning_time of this ServiceEndAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this ServiceEndAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this ServiceEndAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this ServiceEndAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :param actioned_time: The actioned_time of this ServiceEndAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this ServiceEndAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this ServiceEndAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this ServiceEndAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this ServiceEndAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this ServiceEndAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this ServiceEndAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this ServiceEndAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) - :param deleted: The deleted of this ServiceEndAmendment. - :type: bool - """ + attribute_map = { + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) - self._deleted = deleted + def __init__(self, *args, **kwargs): # noqa: E501 + """ServiceEndAmendment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Amendment.__init__(self, *args, **kwargs) def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -400,29 +64,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(ServiceEndAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, ServiceEndAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/set_rate_plan_affiliate_request.py b/billforward/models/set_rate_plan_affiliate_request.py new file mode 100644 index 0000000..31af1cd --- /dev/null +++ b/billforward/models/set_rate_plan_affiliate_request.py @@ -0,0 +1,298 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SetRatePlanAffiliateRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'account_id': 'str', + 'amount': 'float', + 'type': 'str', + 'description': 'str', + 'pricing_component_name': 'str', + 'start_date': 'datetime', + 'end_date': 'datetime' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'amount': 'amount', + 'type': 'type', + 'description': 'description', + 'pricing_component_name': 'pricingComponentName', + 'start_date': 'startDate', + 'end_date': 'endDate' + } + + def __init__(self, organization_id=None, account_id=None, amount=None, type=None, description=None, pricing_component_name=None, start_date=None, end_date=None): # noqa: E501 + """SetRatePlanAffiliateRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._account_id = None + self._amount = None + self._type = None + self._description = None + self._pricing_component_name = None + self._start_date = None + self._end_date = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if amount is not None: + self.amount = amount + if type is not None: + self.type = type + if description is not None: + self.description = description + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if start_date is not None: + self.start_date = start_date + if end_date is not None: + self.end_date = end_date + + @property + def organization_id(self): + """Gets the organization_id of this SetRatePlanAffiliateRequest. # noqa: E501 + + + :return: The organization_id of this SetRatePlanAffiliateRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SetRatePlanAffiliateRequest. + + + :param organization_id: The organization_id of this SetRatePlanAffiliateRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_id(self): + """Gets the account_id of this SetRatePlanAffiliateRequest. # noqa: E501 + + + :return: The account_id of this SetRatePlanAffiliateRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this SetRatePlanAffiliateRequest. + + + :param account_id: The account_id of this SetRatePlanAffiliateRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def amount(self): + """Gets the amount of this SetRatePlanAffiliateRequest. # noqa: E501 + + + :return: The amount of this SetRatePlanAffiliateRequest. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this SetRatePlanAffiliateRequest. + + + :param amount: The amount of this SetRatePlanAffiliateRequest. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def type(self): + """Gets the type of this SetRatePlanAffiliateRequest. # noqa: E501 + + + :return: The type of this SetRatePlanAffiliateRequest. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this SetRatePlanAffiliateRequest. + + + :param type: The type of this SetRatePlanAffiliateRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Percentage", "FixedAmount"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def description(self): + """Gets the description of this SetRatePlanAffiliateRequest. # noqa: E501 + + + :return: The description of this SetRatePlanAffiliateRequest. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this SetRatePlanAffiliateRequest. + + + :param description: The description of this SetRatePlanAffiliateRequest. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this SetRatePlanAffiliateRequest. # noqa: E501 + + + :return: The pricing_component_name of this SetRatePlanAffiliateRequest. # noqa: E501 + :rtype: str + """ + return self._pricing_component_name + + @pricing_component_name.setter + def pricing_component_name(self, pricing_component_name): + """Sets the pricing_component_name of this SetRatePlanAffiliateRequest. + + + :param pricing_component_name: The pricing_component_name of this SetRatePlanAffiliateRequest. # noqa: E501 + :type: str + """ + + self._pricing_component_name = pricing_component_name + + @property + def start_date(self): + """Gets the start_date of this SetRatePlanAffiliateRequest. # noqa: E501 + + + :return: The start_date of this SetRatePlanAffiliateRequest. # noqa: E501 + :rtype: datetime + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this SetRatePlanAffiliateRequest. + + + :param start_date: The start_date of this SetRatePlanAffiliateRequest. # noqa: E501 + :type: datetime + """ + + self._start_date = start_date + + @property + def end_date(self): + """Gets the end_date of this SetRatePlanAffiliateRequest. # noqa: E501 + + + :return: The end_date of this SetRatePlanAffiliateRequest. # noqa: E501 + :rtype: datetime + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this SetRatePlanAffiliateRequest. + + + :param end_date: The end_date of this SetRatePlanAffiliateRequest. # noqa: E501 + :type: datetime + """ + + self._end_date = end_date + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SetRatePlanAffiliateRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SetRatePlanAffiliateRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/set_subscription_affiliate_request.py b/billforward/models/set_subscription_affiliate_request.py new file mode 100644 index 0000000..41fe693 --- /dev/null +++ b/billforward/models/set_subscription_affiliate_request.py @@ -0,0 +1,246 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SetSubscriptionAffiliateRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'account_id': 'str', + 'description': 'str', + 'type': 'str', + 'amount': 'float', + 'pricing_component_name': 'str' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'description': 'description', + 'type': 'type', + 'amount': 'amount', + 'pricing_component_name': 'pricingComponentName' + } + + def __init__(self, organization_id=None, account_id=None, description=None, type=None, amount=None, pricing_component_name=None): # noqa: E501 + """SetSubscriptionAffiliateRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._account_id = None + self._description = None + self._type = None + self._amount = None + self._pricing_component_name = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if description is not None: + self.description = description + if type is not None: + self.type = type + if amount is not None: + self.amount = amount + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + + @property + def organization_id(self): + """Gets the organization_id of this SetSubscriptionAffiliateRequest. # noqa: E501 + + + :return: The organization_id of this SetSubscriptionAffiliateRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SetSubscriptionAffiliateRequest. + + + :param organization_id: The organization_id of this SetSubscriptionAffiliateRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_id(self): + """Gets the account_id of this SetSubscriptionAffiliateRequest. # noqa: E501 + + + :return: The account_id of this SetSubscriptionAffiliateRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this SetSubscriptionAffiliateRequest. + + + :param account_id: The account_id of this SetSubscriptionAffiliateRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def description(self): + """Gets the description of this SetSubscriptionAffiliateRequest. # noqa: E501 + + + :return: The description of this SetSubscriptionAffiliateRequest. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this SetSubscriptionAffiliateRequest. + + + :param description: The description of this SetSubscriptionAffiliateRequest. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def type(self): + """Gets the type of this SetSubscriptionAffiliateRequest. # noqa: E501 + + + :return: The type of this SetSubscriptionAffiliateRequest. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this SetSubscriptionAffiliateRequest. + + + :param type: The type of this SetSubscriptionAffiliateRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Percentage", "FixedAmount"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def amount(self): + """Gets the amount of this SetSubscriptionAffiliateRequest. # noqa: E501 + + + :return: The amount of this SetSubscriptionAffiliateRequest. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this SetSubscriptionAffiliateRequest. + + + :param amount: The amount of this SetSubscriptionAffiliateRequest. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this SetSubscriptionAffiliateRequest. # noqa: E501 + + + :return: The pricing_component_name of this SetSubscriptionAffiliateRequest. # noqa: E501 + :rtype: str + """ + return self._pricing_component_name + + @pricing_component_name.setter + def pricing_component_name(self, pricing_component_name): + """Sets the pricing_component_name of this SetSubscriptionAffiliateRequest. + + + :param pricing_component_name: The pricing_component_name of this SetSubscriptionAffiliateRequest. # noqa: E501 + :type: str + """ + + self._pricing_component_name = pricing_component_name + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SetSubscriptionAffiliateRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SetSubscriptionAffiliateRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/setup_charge.py b/billforward/models/setup_charge.py new file mode 100644 index 0000000..e9d280b --- /dev/null +++ b/billforward/models/setup_charge.py @@ -0,0 +1,171 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.subscription_charge import SubscriptionCharge # noqa: F401,E501 + +class SetupCharge(SubscriptionCharge): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'pricing_component_id': 'str', + 'unit_of_measure_id': 'str', + 'pricing_component_value': 'int' + } + if hasattr(SubscriptionCharge, "swagger_types"): + swagger_types.update(SubscriptionCharge.swagger_types) + + attribute_map = { + 'pricing_component_id': 'pricingComponentID', + 'unit_of_measure_id': 'unitOfMeasureID', + 'pricing_component_value': 'pricingComponentValue' + } + if hasattr(SubscriptionCharge, "attribute_map"): + attribute_map.update(SubscriptionCharge.attribute_map) + + def __init__(self, pricing_component_id=None, unit_of_measure_id=None, pricing_component_value=None, *args, **kwargs): # noqa: E501 + """SetupCharge - a model defined in Swagger""" # noqa: E501 + self._pricing_component_id = None + self._unit_of_measure_id = None + self._pricing_component_value = None + self.discriminator = None + self.pricing_component_id = pricing_component_id + self.unit_of_measure_id = unit_of_measure_id + self.pricing_component_value = pricing_component_value + SubscriptionCharge.__init__(self, *args, **kwargs) + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this SetupCharge. # noqa: E501 + + + :return: The pricing_component_id of this SetupCharge. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this SetupCharge. + + + :param pricing_component_id: The pricing_component_id of this SetupCharge. # noqa: E501 + :type: str + """ + if pricing_component_id is None: + raise ValueError("Invalid value for `pricing_component_id`, must not be `None`") # noqa: E501 + + self._pricing_component_id = pricing_component_id + + @property + def unit_of_measure_id(self): + """Gets the unit_of_measure_id of this SetupCharge. # noqa: E501 + + + :return: The unit_of_measure_id of this SetupCharge. # noqa: E501 + :rtype: str + """ + return self._unit_of_measure_id + + @unit_of_measure_id.setter + def unit_of_measure_id(self, unit_of_measure_id): + """Sets the unit_of_measure_id of this SetupCharge. + + + :param unit_of_measure_id: The unit_of_measure_id of this SetupCharge. # noqa: E501 + :type: str + """ + if unit_of_measure_id is None: + raise ValueError("Invalid value for `unit_of_measure_id`, must not be `None`") # noqa: E501 + + self._unit_of_measure_id = unit_of_measure_id + + @property + def pricing_component_value(self): + """Gets the pricing_component_value of this SetupCharge. # noqa: E501 + + + :return: The pricing_component_value of this SetupCharge. # noqa: E501 + :rtype: int + """ + return self._pricing_component_value + + @pricing_component_value.setter + def pricing_component_value(self, pricing_component_value): + """Sets the pricing_component_value of this SetupCharge. + + + :param pricing_component_value: The pricing_component_value of this SetupCharge. # noqa: E501 + :type: int + """ + if pricing_component_value is None: + raise ValueError("Invalid value for `pricing_component_value`, must not be `None`") # noqa: E501 + + self._pricing_component_value = pricing_component_value + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SetupCharge, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SetupCharge): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/setup_pricing_components_by_charge_model.py b/billforward/models/setup_pricing_components_by_charge_model.py new file mode 100644 index 0000000..01826ac --- /dev/null +++ b/billforward/models/setup_pricing_components_by_charge_model.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SetupPricingComponentsByChargeModel(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'flat': 'list[FlatSetupPricingComponent]', + 'tiered': 'list[TieredSetupPricingComponent]', + 'volume': 'list[TieredSetupPricingComponent]' + } + + attribute_map = { + 'flat': 'flat', + 'tiered': 'tiered', + 'volume': 'volume' + } + + def __init__(self, flat=None, tiered=None, volume=None): # noqa: E501 + """SetupPricingComponentsByChargeModel - a model defined in Swagger""" # noqa: E501 + self._flat = None + self._tiered = None + self._volume = None + self.discriminator = None + if flat is not None: + self.flat = flat + if tiered is not None: + self.tiered = tiered + if volume is not None: + self.volume = volume + + @property + def flat(self): + """Gets the flat of this SetupPricingComponentsByChargeModel. # noqa: E501 + + + :return: The flat of this SetupPricingComponentsByChargeModel. # noqa: E501 + :rtype: list[FlatSetupPricingComponent] + """ + return self._flat + + @flat.setter + def flat(self, flat): + """Sets the flat of this SetupPricingComponentsByChargeModel. + + + :param flat: The flat of this SetupPricingComponentsByChargeModel. # noqa: E501 + :type: list[FlatSetupPricingComponent] + """ + + self._flat = flat + + @property + def tiered(self): + """Gets the tiered of this SetupPricingComponentsByChargeModel. # noqa: E501 + + + :return: The tiered of this SetupPricingComponentsByChargeModel. # noqa: E501 + :rtype: list[TieredSetupPricingComponent] + """ + return self._tiered + + @tiered.setter + def tiered(self, tiered): + """Sets the tiered of this SetupPricingComponentsByChargeModel. + + + :param tiered: The tiered of this SetupPricingComponentsByChargeModel. # noqa: E501 + :type: list[TieredSetupPricingComponent] + """ + + self._tiered = tiered + + @property + def volume(self): + """Gets the volume of this SetupPricingComponentsByChargeModel. # noqa: E501 + + + :return: The volume of this SetupPricingComponentsByChargeModel. # noqa: E501 + :rtype: list[TieredSetupPricingComponent] + """ + return self._volume + + @volume.setter + def volume(self, volume): + """Sets the volume of this SetupPricingComponentsByChargeModel. + + + :param volume: The volume of this SetupPricingComponentsByChargeModel. # noqa: E501 + :type: list[TieredSetupPricingComponent] + """ + + self._volume = volume + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SetupPricingComponentsByChargeModel, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SetupPricingComponentsByChargeModel): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/shuttle_auth_capture_request.py b/billforward/models/shuttle_auth_capture_request.py new file mode 100644 index 0000000..5b65a7d --- /dev/null +++ b/billforward/models/shuttle_auth_capture_request.py @@ -0,0 +1,144 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.auth_capture_request import AuthCaptureRequest # noqa: F401,E501 + +class ShuttleAuthCaptureRequest(AuthCaptureRequest): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'shuttle_payment_method': 'str', + 'shuttle_instance_id': 'str' + } + if hasattr(AuthCaptureRequest, "swagger_types"): + swagger_types.update(AuthCaptureRequest.swagger_types) + + attribute_map = { + 'shuttle_payment_method': 'shuttlePaymentMethod', + 'shuttle_instance_id': 'shuttleInstanceId' + } + if hasattr(AuthCaptureRequest, "attribute_map"): + attribute_map.update(AuthCaptureRequest.attribute_map) + + def __init__(self, shuttle_payment_method=None, shuttle_instance_id=None, *args, **kwargs): # noqa: E501 + """ShuttleAuthCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._shuttle_payment_method = None + self._shuttle_instance_id = None + self.discriminator = None + self.shuttle_payment_method = shuttle_payment_method + self.shuttle_instance_id = shuttle_instance_id + AuthCaptureRequest.__init__(self, *args, **kwargs) + + @property + def shuttle_payment_method(self): + """Gets the shuttle_payment_method of this ShuttleAuthCaptureRequest. # noqa: E501 + + + :return: The shuttle_payment_method of this ShuttleAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._shuttle_payment_method + + @shuttle_payment_method.setter + def shuttle_payment_method(self, shuttle_payment_method): + """Sets the shuttle_payment_method of this ShuttleAuthCaptureRequest. + + + :param shuttle_payment_method: The shuttle_payment_method of this ShuttleAuthCaptureRequest. # noqa: E501 + :type: str + """ + if shuttle_payment_method is None: + raise ValueError("Invalid value for `shuttle_payment_method`, must not be `None`") # noqa: E501 + + self._shuttle_payment_method = shuttle_payment_method + + @property + def shuttle_instance_id(self): + """Gets the shuttle_instance_id of this ShuttleAuthCaptureRequest. # noqa: E501 + + + :return: The shuttle_instance_id of this ShuttleAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._shuttle_instance_id + + @shuttle_instance_id.setter + def shuttle_instance_id(self, shuttle_instance_id): + """Sets the shuttle_instance_id of this ShuttleAuthCaptureRequest. + + + :param shuttle_instance_id: The shuttle_instance_id of this ShuttleAuthCaptureRequest. # noqa: E501 + :type: str + """ + if shuttle_instance_id is None: + raise ValueError("Invalid value for `shuttle_instance_id`, must not be `None`") # noqa: E501 + + self._shuttle_instance_id = shuttle_instance_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ShuttleAuthCaptureRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ShuttleAuthCaptureRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/shuttle_configuration.py b/billforward/models/shuttle_configuration.py new file mode 100644 index 0000000..2860549 --- /dev/null +++ b/billforward/models/shuttle_configuration.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class ShuttleConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'hosted_payment_config': 'HostedPaymentConfig', + 'instance_key': 'str', + 'percentage_for_other_payment_methods': 'float' + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + 'hosted_payment_config': 'hostedPaymentConfig', + 'instance_key': 'instanceKey', + 'percentage_for_other_payment_methods': 'percentageForOtherPaymentMethods' + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, hosted_payment_config=None, instance_key=None, percentage_for_other_payment_methods=None, *args, **kwargs): # noqa: E501 + """ShuttleConfiguration - a model defined in Swagger""" # noqa: E501 + self._hosted_payment_config = None + self._instance_key = None + self._percentage_for_other_payment_methods = None + self.discriminator = None + if hosted_payment_config is not None: + self.hosted_payment_config = hosted_payment_config + if instance_key is not None: + self.instance_key = instance_key + if percentage_for_other_payment_methods is not None: + self.percentage_for_other_payment_methods = percentage_for_other_payment_methods + APIConfiguration.__init__(self, *args, **kwargs) + + @property + def hosted_payment_config(self): + """Gets the hosted_payment_config of this ShuttleConfiguration. # noqa: E501 + + + :return: The hosted_payment_config of this ShuttleConfiguration. # noqa: E501 + :rtype: HostedPaymentConfig + """ + return self._hosted_payment_config + + @hosted_payment_config.setter + def hosted_payment_config(self, hosted_payment_config): + """Sets the hosted_payment_config of this ShuttleConfiguration. + + + :param hosted_payment_config: The hosted_payment_config of this ShuttleConfiguration. # noqa: E501 + :type: HostedPaymentConfig + """ + + self._hosted_payment_config = hosted_payment_config + + @property + def instance_key(self): + """Gets the instance_key of this ShuttleConfiguration. # noqa: E501 + + + :return: The instance_key of this ShuttleConfiguration. # noqa: E501 + :rtype: str + """ + return self._instance_key + + @instance_key.setter + def instance_key(self, instance_key): + """Sets the instance_key of this ShuttleConfiguration. + + + :param instance_key: The instance_key of this ShuttleConfiguration. # noqa: E501 + :type: str + """ + + self._instance_key = instance_key + + @property + def percentage_for_other_payment_methods(self): + """Gets the percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 + + + :return: The percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 + :rtype: float + """ + return self._percentage_for_other_payment_methods + + @percentage_for_other_payment_methods.setter + def percentage_for_other_payment_methods(self, percentage_for_other_payment_methods): + """Sets the percentage_for_other_payment_methods of this ShuttleConfiguration. + + + :param percentage_for_other_payment_methods: The percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 + :type: float + """ + + self._percentage_for_other_payment_methods = percentage_for_other_payment_methods + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ShuttleConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ShuttleConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/shuttle_payment.py b/billforward/models/shuttle_payment.py new file mode 100644 index 0000000..8819335 --- /dev/null +++ b/billforward/models/shuttle_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class ShuttlePayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """ShuttlePayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ShuttlePayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ShuttlePayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/shuttle_pre_auth_request.py b/billforward/models/shuttle_pre_auth_request.py new file mode 100644 index 0000000..4a01088 --- /dev/null +++ b/billforward/models/shuttle_pre_auth_request.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.tokenization_pre_auth_request import TokenizationPreAuthRequest # noqa: F401,E501 + +class ShuttlePreAuthRequest(TokenizationPreAuthRequest): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'signature_body': 'str' + } + if hasattr(TokenizationPreAuthRequest, "swagger_types"): + swagger_types.update(TokenizationPreAuthRequest.swagger_types) + + attribute_map = { + 'signature_body': 'signatureBody' + } + if hasattr(TokenizationPreAuthRequest, "attribute_map"): + attribute_map.update(TokenizationPreAuthRequest.attribute_map) + + def __init__(self, signature_body=None, *args, **kwargs): # noqa: E501 + """ShuttlePreAuthRequest - a model defined in Swagger""" # noqa: E501 + self._signature_body = None + self.discriminator = None + if signature_body is not None: + self.signature_body = signature_body + TokenizationPreAuthRequest.__init__(self, *args, **kwargs) + + @property + def signature_body(self): + """Gets the signature_body of this ShuttlePreAuthRequest. # noqa: E501 + + + :return: The signature_body of this ShuttlePreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._signature_body + + @signature_body.setter + def signature_body(self, signature_body): + """Sets the signature_body of this ShuttlePreAuthRequest. + + + :param signature_body: The signature_body of this ShuttlePreAuthRequest. # noqa: E501 + :type: str + """ + + self._signature_body = signature_body + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ShuttlePreAuthRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ShuttlePreAuthRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/simple_date_param.py b/billforward/models/simple_date_param.py new file mode 100644 index 0000000..b114c39 --- /dev/null +++ b/billforward/models/simple_date_param.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SimpleDateParam(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + '_date': 'datetime', + 'original_value': 'str' + } + + attribute_map = { + '_date': 'date', + 'original_value': 'originalValue' + } + + def __init__(self, _date=None, original_value=None): # noqa: E501 + """SimpleDateParam - a model defined in Swagger""" # noqa: E501 + self.__date = None + self._original_value = None + self.discriminator = None + if _date is not None: + self._date = _date + if original_value is not None: + self.original_value = original_value + + @property + def _date(self): + """Gets the _date of this SimpleDateParam. # noqa: E501 + + + :return: The _date of this SimpleDateParam. # noqa: E501 + :rtype: datetime + """ + return self.__date + + @_date.setter + def _date(self, _date): + """Sets the _date of this SimpleDateParam. + + + :param _date: The _date of this SimpleDateParam. # noqa: E501 + :type: datetime + """ + + self.__date = _date + + @property + def original_value(self): + """Gets the original_value of this SimpleDateParam. # noqa: E501 + + + :return: The original_value of this SimpleDateParam. # noqa: E501 + :rtype: str + """ + return self._original_value + + @original_value.setter + def original_value(self, original_value): + """Sets the original_value of this SimpleDateParam. + + + :param original_value: The original_value of this SimpleDateParam. # noqa: E501 + :type: str + """ + + self._original_value = original_value + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SimpleDateParam, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SimpleDateParam): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/simple_user.py b/billforward/models/simple_user.py new file mode 100644 index 0000000..1fbc40d --- /dev/null +++ b/billforward/models/simple_user.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SimpleUser(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'id': 'str', + 'username': 'str', + 'email': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'id': 'id', + 'username': 'username', + 'email': 'email', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, id=None, username=None, email=None, organization_id=None): # noqa: E501 + """SimpleUser - a model defined in Swagger""" # noqa: E501 + self._created = None + self._id = None + self._username = None + self._email = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if id is not None: + self.id = id + if username is not None: + self.username = username + if email is not None: + self.email = email + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this SimpleUser. # noqa: E501 + + + :return: The created of this SimpleUser. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this SimpleUser. + + + :param created: The created of this SimpleUser. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def id(self): + """Gets the id of this SimpleUser. # noqa: E501 + + + :return: The id of this SimpleUser. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this SimpleUser. + + + :param id: The id of this SimpleUser. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def username(self): + """Gets the username of this SimpleUser. # noqa: E501 + + + :return: The username of this SimpleUser. # noqa: E501 + :rtype: str + """ + return self._username + + @username.setter + def username(self, username): + """Sets the username of this SimpleUser. + + + :param username: The username of this SimpleUser. # noqa: E501 + :type: str + """ + + self._username = username + + @property + def email(self): + """Gets the email of this SimpleUser. # noqa: E501 + + + :return: The email of this SimpleUser. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this SimpleUser. + + + :param email: The email of this SimpleUser. # noqa: E501 + :type: str + """ + + self._email = email + + @property + def organization_id(self): + """Gets the organization_id of this SimpleUser. # noqa: E501 + + + :return: The organization_id of this SimpleUser. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SimpleUser. + + + :param organization_id: The organization_id of this SimpleUser. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SimpleUser, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SimpleUser): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/single_recalculate_charge_request.py b/billforward/models/single_recalculate_charge_request.py new file mode 100644 index 0000000..3a241df --- /dev/null +++ b/billforward/models/single_recalculate_charge_request.py @@ -0,0 +1,357 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SingleRecalculateChargeRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'name': 'str', + 'description': 'str', + 'quantity_label': 'str', + 'amount': 'float', + 'invoicing_type': 'str', + 'pricing_component_value': 'int', + 'recalculation_behaviour': 'str' + } + + attribute_map = { + 'created': 'created', + 'id': 'id', + 'organization_id': 'organizationID', + 'name': 'name', + 'description': 'description', + 'quantity_label': 'quantityLabel', + 'amount': 'amount', + 'invoicing_type': 'invoicingType', + 'pricing_component_value': 'pricingComponentValue', + 'recalculation_behaviour': 'recalculationBehaviour' + } + + def __init__(self, created=None, id=None, organization_id=None, name=None, description=None, quantity_label=None, amount=None, invoicing_type=None, pricing_component_value=None, recalculation_behaviour=None): # noqa: E501 + """SingleRecalculateChargeRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._id = None + self._organization_id = None + self._name = None + self._description = None + self._quantity_label = None + self._amount = None + self._invoicing_type = None + self._pricing_component_value = None + self._recalculation_behaviour = None + self.discriminator = None + if created is not None: + self.created = created + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if description is not None: + self.description = description + if quantity_label is not None: + self.quantity_label = quantity_label + if amount is not None: + self.amount = amount + if invoicing_type is not None: + self.invoicing_type = invoicing_type + if pricing_component_value is not None: + self.pricing_component_value = pricing_component_value + self.recalculation_behaviour = recalculation_behaviour + + @property + def created(self): + """Gets the created of this SingleRecalculateChargeRequest. # noqa: E501 + + + :return: The created of this SingleRecalculateChargeRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this SingleRecalculateChargeRequest. + + + :param created: The created of this SingleRecalculateChargeRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def id(self): + """Gets the id of this SingleRecalculateChargeRequest. # noqa: E501 + + + :return: The id of this SingleRecalculateChargeRequest. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this SingleRecalculateChargeRequest. + + + :param id: The id of this SingleRecalculateChargeRequest. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this SingleRecalculateChargeRequest. # noqa: E501 + + + :return: The organization_id of this SingleRecalculateChargeRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SingleRecalculateChargeRequest. + + + :param organization_id: The organization_id of this SingleRecalculateChargeRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def name(self): + """Gets the name of this SingleRecalculateChargeRequest. # noqa: E501 + + + :return: The name of this SingleRecalculateChargeRequest. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this SingleRecalculateChargeRequest. + + + :param name: The name of this SingleRecalculateChargeRequest. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this SingleRecalculateChargeRequest. # noqa: E501 + + + :return: The description of this SingleRecalculateChargeRequest. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this SingleRecalculateChargeRequest. + + + :param description: The description of this SingleRecalculateChargeRequest. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def quantity_label(self): + """Gets the quantity_label of this SingleRecalculateChargeRequest. # noqa: E501 + + + :return: The quantity_label of this SingleRecalculateChargeRequest. # noqa: E501 + :rtype: str + """ + return self._quantity_label + + @quantity_label.setter + def quantity_label(self, quantity_label): + """Sets the quantity_label of this SingleRecalculateChargeRequest. + + + :param quantity_label: The quantity_label of this SingleRecalculateChargeRequest. # noqa: E501 + :type: str + """ + + self._quantity_label = quantity_label + + @property + def amount(self): + """Gets the amount of this SingleRecalculateChargeRequest. # noqa: E501 + + + :return: The amount of this SingleRecalculateChargeRequest. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this SingleRecalculateChargeRequest. + + + :param amount: The amount of this SingleRecalculateChargeRequest. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def invoicing_type(self): + """Gets the invoicing_type of this SingleRecalculateChargeRequest. # noqa: E501 + + + :return: The invoicing_type of this SingleRecalculateChargeRequest. # noqa: E501 + :rtype: str + """ + return self._invoicing_type + + @invoicing_type.setter + def invoicing_type(self, invoicing_type): + """Sets the invoicing_type of this SingleRecalculateChargeRequest. + + + :param invoicing_type: The invoicing_type of this SingleRecalculateChargeRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 + if invoicing_type not in allowed_values: + raise ValueError( + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 + .format(invoicing_type, allowed_values) + ) + + self._invoicing_type = invoicing_type + + @property + def pricing_component_value(self): + """Gets the pricing_component_value of this SingleRecalculateChargeRequest. # noqa: E501 + + + :return: The pricing_component_value of this SingleRecalculateChargeRequest. # noqa: E501 + :rtype: int + """ + return self._pricing_component_value + + @pricing_component_value.setter + def pricing_component_value(self, pricing_component_value): + """Sets the pricing_component_value of this SingleRecalculateChargeRequest. + + + :param pricing_component_value: The pricing_component_value of this SingleRecalculateChargeRequest. # noqa: E501 + :type: int + """ + + self._pricing_component_value = pricing_component_value + + @property + def recalculation_behaviour(self): + """Gets the recalculation_behaviour of this SingleRecalculateChargeRequest. # noqa: E501 + + + :return: The recalculation_behaviour of this SingleRecalculateChargeRequest. # noqa: E501 + :rtype: str + """ + return self._recalculation_behaviour + + @recalculation_behaviour.setter + def recalculation_behaviour(self, recalculation_behaviour): + """Sets the recalculation_behaviour of this SingleRecalculateChargeRequest. + + + :param recalculation_behaviour: The recalculation_behaviour of this SingleRecalculateChargeRequest. # noqa: E501 + :type: str + """ + if recalculation_behaviour is None: + raise ValueError("Invalid value for `recalculation_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["RecalculateWithLatestPricing", "RecalculateWithCurrentPricing"] # noqa: E501 + if recalculation_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `recalculation_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(recalculation_behaviour, allowed_values) + ) + + self._recalculation_behaviour = recalculation_behaviour + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SingleRecalculateChargeRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SingleRecalculateChargeRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/spreedly_auth_capture_request.py b/billforward/models/spreedly_auth_capture_request.py new file mode 100644 index 0000000..37819a7 --- /dev/null +++ b/billforward/models/spreedly_auth_capture_request.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.auth_capture_request import AuthCaptureRequest # noqa: F401,E501 + +class SpreedlyAuthCaptureRequest(AuthCaptureRequest): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'card_token': 'str' + } + if hasattr(AuthCaptureRequest, "swagger_types"): + swagger_types.update(AuthCaptureRequest.swagger_types) + + attribute_map = { + 'card_token': 'cardToken' + } + if hasattr(AuthCaptureRequest, "attribute_map"): + attribute_map.update(AuthCaptureRequest.attribute_map) + + def __init__(self, card_token=None, *args, **kwargs): # noqa: E501 + """SpreedlyAuthCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._card_token = None + self.discriminator = None + self.card_token = card_token + AuthCaptureRequest.__init__(self, *args, **kwargs) + + @property + def card_token(self): + """Gets the card_token of this SpreedlyAuthCaptureRequest. # noqa: E501 + + + :return: The card_token of this SpreedlyAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._card_token + + @card_token.setter + def card_token(self, card_token): + """Sets the card_token of this SpreedlyAuthCaptureRequest. + + + :param card_token: The card_token of this SpreedlyAuthCaptureRequest. # noqa: E501 + :type: str + """ + if card_token is None: + raise ValueError("Invalid value for `card_token`, must not be `None`") # noqa: E501 + + self._card_token = card_token + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SpreedlyAuthCaptureRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SpreedlyAuthCaptureRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/spreedly_configuration.py b/billforward/models/spreedly_configuration.py new file mode 100644 index 0000000..4301240 --- /dev/null +++ b/billforward/models/spreedly_configuration.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class SpreedlyConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'access_secret': 'str', + 'signing_secret': 'str', + 'api_key': 'str' + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + 'access_secret': 'accessSecret', + 'signing_secret': 'signingSecret', + 'api_key': 'APIKey' + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, access_secret=None, signing_secret=None, api_key=None, *args, **kwargs): # noqa: E501 + """SpreedlyConfiguration - a model defined in Swagger""" # noqa: E501 + self._access_secret = None + self._signing_secret = None + self._api_key = None + self.discriminator = None + if access_secret is not None: + self.access_secret = access_secret + if signing_secret is not None: + self.signing_secret = signing_secret + if api_key is not None: + self.api_key = api_key + APIConfiguration.__init__(self, *args, **kwargs) + + @property + def access_secret(self): + """Gets the access_secret of this SpreedlyConfiguration. # noqa: E501 + + + :return: The access_secret of this SpreedlyConfiguration. # noqa: E501 + :rtype: str + """ + return self._access_secret + + @access_secret.setter + def access_secret(self, access_secret): + """Sets the access_secret of this SpreedlyConfiguration. + + + :param access_secret: The access_secret of this SpreedlyConfiguration. # noqa: E501 + :type: str + """ + + self._access_secret = access_secret + + @property + def signing_secret(self): + """Gets the signing_secret of this SpreedlyConfiguration. # noqa: E501 + + + :return: The signing_secret of this SpreedlyConfiguration. # noqa: E501 + :rtype: str + """ + return self._signing_secret + + @signing_secret.setter + def signing_secret(self, signing_secret): + """Sets the signing_secret of this SpreedlyConfiguration. + + + :param signing_secret: The signing_secret of this SpreedlyConfiguration. # noqa: E501 + :type: str + """ + + self._signing_secret = signing_secret + + @property + def api_key(self): + """Gets the api_key of this SpreedlyConfiguration. # noqa: E501 + + + :return: The api_key of this SpreedlyConfiguration. # noqa: E501 + :rtype: str + """ + return self._api_key + + @api_key.setter + def api_key(self, api_key): + """Sets the api_key of this SpreedlyConfiguration. + + + :param api_key: The api_key of this SpreedlyConfiguration. # noqa: E501 + :type: str + """ + + self._api_key = api_key + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SpreedlyConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SpreedlyConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/spreedly_pre_auth_request.py b/billforward/models/spreedly_pre_auth_request.py new file mode 100644 index 0000000..65723f9 --- /dev/null +++ b/billforward/models/spreedly_pre_auth_request.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.tokenization_pre_auth_request import TokenizationPreAuthRequest # noqa: F401,E501 + +class SpreedlyPreAuthRequest(TokenizationPreAuthRequest): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(TokenizationPreAuthRequest, "swagger_types"): + swagger_types.update(TokenizationPreAuthRequest.swagger_types) + + attribute_map = { + } + if hasattr(TokenizationPreAuthRequest, "attribute_map"): + attribute_map.update(TokenizationPreAuthRequest.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """SpreedlyPreAuthRequest - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + TokenizationPreAuthRequest.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SpreedlyPreAuthRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SpreedlyPreAuthRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/square_auth_capture_request.py b/billforward/models/square_auth_capture_request.py new file mode 100644 index 0000000..54c3c42 --- /dev/null +++ b/billforward/models/square_auth_capture_request.py @@ -0,0 +1,196 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.auth_capture_request import AuthCaptureRequest # noqa: F401,E501 + +class SquareAuthCaptureRequest(AuthCaptureRequest): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'card_nonce': 'str', + 'buyer_verification_token': 'str', + 'billing_address': 'Address', + 'location_id': 'str' + } + if hasattr(AuthCaptureRequest, "swagger_types"): + swagger_types.update(AuthCaptureRequest.swagger_types) + + attribute_map = { + 'card_nonce': 'cardNonce', + 'buyer_verification_token': 'buyerVerificationToken', + 'billing_address': 'billingAddress', + 'location_id': 'locationId' + } + if hasattr(AuthCaptureRequest, "attribute_map"): + attribute_map.update(AuthCaptureRequest.attribute_map) + + def __init__(self, card_nonce=None, buyer_verification_token=None, billing_address=None, location_id=None, *args, **kwargs): # noqa: E501 + """SquareAuthCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._card_nonce = None + self._buyer_verification_token = None + self._billing_address = None + self._location_id = None + self.discriminator = None + self.card_nonce = card_nonce + if buyer_verification_token is not None: + self.buyer_verification_token = buyer_verification_token + if billing_address is not None: + self.billing_address = billing_address + self.location_id = location_id + AuthCaptureRequest.__init__(self, *args, **kwargs) + + @property + def card_nonce(self): + """Gets the card_nonce of this SquareAuthCaptureRequest. # noqa: E501 + + + :return: The card_nonce of this SquareAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._card_nonce + + @card_nonce.setter + def card_nonce(self, card_nonce): + """Sets the card_nonce of this SquareAuthCaptureRequest. + + + :param card_nonce: The card_nonce of this SquareAuthCaptureRequest. # noqa: E501 + :type: str + """ + if card_nonce is None: + raise ValueError("Invalid value for `card_nonce`, must not be `None`") # noqa: E501 + + self._card_nonce = card_nonce + + @property + def buyer_verification_token(self): + """Gets the buyer_verification_token of this SquareAuthCaptureRequest. # noqa: E501 + + + :return: The buyer_verification_token of this SquareAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._buyer_verification_token + + @buyer_verification_token.setter + def buyer_verification_token(self, buyer_verification_token): + """Sets the buyer_verification_token of this SquareAuthCaptureRequest. + + + :param buyer_verification_token: The buyer_verification_token of this SquareAuthCaptureRequest. # noqa: E501 + :type: str + """ + + self._buyer_verification_token = buyer_verification_token + + @property + def billing_address(self): + """Gets the billing_address of this SquareAuthCaptureRequest. # noqa: E501 + + + :return: The billing_address of this SquareAuthCaptureRequest. # noqa: E501 + :rtype: Address + """ + return self._billing_address + + @billing_address.setter + def billing_address(self, billing_address): + """Sets the billing_address of this SquareAuthCaptureRequest. + + + :param billing_address: The billing_address of this SquareAuthCaptureRequest. # noqa: E501 + :type: Address + """ + + self._billing_address = billing_address + + @property + def location_id(self): + """Gets the location_id of this SquareAuthCaptureRequest. # noqa: E501 + + + :return: The location_id of this SquareAuthCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._location_id + + @location_id.setter + def location_id(self, location_id): + """Sets the location_id of this SquareAuthCaptureRequest. + + + :param location_id: The location_id of this SquareAuthCaptureRequest. # noqa: E501 + :type: str + """ + if location_id is None: + raise ValueError("Invalid value for `location_id`, must not be `None`") # noqa: E501 + + self._location_id = location_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SquareAuthCaptureRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SquareAuthCaptureRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/square_configuration.py b/billforward/models/square_configuration.py new file mode 100644 index 0000000..17197dc --- /dev/null +++ b/billforward/models/square_configuration.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class SquareConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'square_data': 'SquareConfigurationData' + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + 'square_data': 'squareData' + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, square_data=None, *args, **kwargs): # noqa: E501 + """SquareConfiguration - a model defined in Swagger""" # noqa: E501 + self._square_data = None + self.discriminator = None + if square_data is not None: + self.square_data = square_data + APIConfiguration.__init__(self, *args, **kwargs) + + @property + def square_data(self): + """Gets the square_data of this SquareConfiguration. # noqa: E501 + + + :return: The square_data of this SquareConfiguration. # noqa: E501 + :rtype: SquareConfigurationData + """ + return self._square_data + + @square_data.setter + def square_data(self, square_data): + """Sets the square_data of this SquareConfiguration. + + + :param square_data: The square_data of this SquareConfiguration. # noqa: E501 + :type: SquareConfigurationData + """ + + self._square_data = square_data + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SquareConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SquareConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/square_configuration_data.py b/billforward/models/square_configuration_data.py new file mode 100644 index 0000000..100f3ea --- /dev/null +++ b/billforward/models/square_configuration_data.py @@ -0,0 +1,240 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SquareConfigurationData(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'business_name': 'str', + 'country': 'str', + 'language_code': 'str', + 'currency': 'CreditNoteCurrency', + 'main_location_id': 'str', + 'public_url': 'str' + } + + attribute_map = { + 'business_name': 'businessName', + 'country': 'country', + 'language_code': 'languageCode', + 'currency': 'currency', + 'main_location_id': 'mainLocationId', + 'public_url': 'publicUrl' + } + + def __init__(self, business_name=None, country=None, language_code=None, currency=None, main_location_id=None, public_url=None): # noqa: E501 + """SquareConfigurationData - a model defined in Swagger""" # noqa: E501 + self._business_name = None + self._country = None + self._language_code = None + self._currency = None + self._main_location_id = None + self._public_url = None + self.discriminator = None + if business_name is not None: + self.business_name = business_name + if country is not None: + self.country = country + if language_code is not None: + self.language_code = language_code + if currency is not None: + self.currency = currency + if main_location_id is not None: + self.main_location_id = main_location_id + if public_url is not None: + self.public_url = public_url + + @property + def business_name(self): + """Gets the business_name of this SquareConfigurationData. # noqa: E501 + + + :return: The business_name of this SquareConfigurationData. # noqa: E501 + :rtype: str + """ + return self._business_name + + @business_name.setter + def business_name(self, business_name): + """Sets the business_name of this SquareConfigurationData. + + + :param business_name: The business_name of this SquareConfigurationData. # noqa: E501 + :type: str + """ + + self._business_name = business_name + + @property + def country(self): + """Gets the country of this SquareConfigurationData. # noqa: E501 + + + :return: The country of this SquareConfigurationData. # noqa: E501 + :rtype: str + """ + return self._country + + @country.setter + def country(self, country): + """Sets the country of this SquareConfigurationData. + + + :param country: The country of this SquareConfigurationData. # noqa: E501 + :type: str + """ + + self._country = country + + @property + def language_code(self): + """Gets the language_code of this SquareConfigurationData. # noqa: E501 + + + :return: The language_code of this SquareConfigurationData. # noqa: E501 + :rtype: str + """ + return self._language_code + + @language_code.setter + def language_code(self, language_code): + """Sets the language_code of this SquareConfigurationData. + + + :param language_code: The language_code of this SquareConfigurationData. # noqa: E501 + :type: str + """ + + self._language_code = language_code + + @property + def currency(self): + """Gets the currency of this SquareConfigurationData. # noqa: E501 + + + :return: The currency of this SquareConfigurationData. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this SquareConfigurationData. + + + :param currency: The currency of this SquareConfigurationData. # noqa: E501 + :type: CreditNoteCurrency + """ + + self._currency = currency + + @property + def main_location_id(self): + """Gets the main_location_id of this SquareConfigurationData. # noqa: E501 + + + :return: The main_location_id of this SquareConfigurationData. # noqa: E501 + :rtype: str + """ + return self._main_location_id + + @main_location_id.setter + def main_location_id(self, main_location_id): + """Sets the main_location_id of this SquareConfigurationData. + + + :param main_location_id: The main_location_id of this SquareConfigurationData. # noqa: E501 + :type: str + """ + + self._main_location_id = main_location_id + + @property + def public_url(self): + """Gets the public_url of this SquareConfigurationData. # noqa: E501 + + + :return: The public_url of this SquareConfigurationData. # noqa: E501 + :rtype: str + """ + return self._public_url + + @public_url.setter + def public_url(self, public_url): + """Sets the public_url of this SquareConfigurationData. + + + :param public_url: The public_url of this SquareConfigurationData. # noqa: E501 + :type: str + """ + + self._public_url = public_url + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SquareConfigurationData, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SquareConfigurationData): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/square_data.py b/billforward/models/square_data.py new file mode 100644 index 0000000..b558fcf --- /dev/null +++ b/billforward/models/square_data.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SquareData(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'location_id': 'str' + } + + attribute_map = { + 'location_id': 'locationID' + } + + def __init__(self, location_id=None): # noqa: E501 + """SquareData - a model defined in Swagger""" # noqa: E501 + self._location_id = None + self.discriminator = None + if location_id is not None: + self.location_id = location_id + + @property + def location_id(self): + """Gets the location_id of this SquareData. # noqa: E501 + + + :return: The location_id of this SquareData. # noqa: E501 + :rtype: str + """ + return self._location_id + + @location_id.setter + def location_id(self, location_id): + """Sets the location_id of this SquareData. + + + :param location_id: The location_id of this SquareData. # noqa: E501 + :type: str + """ + + self._location_id = location_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SquareData, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SquareData): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/square_payment.py b/billforward/models/square_payment.py new file mode 100644 index 0000000..c56fe4a --- /dev/null +++ b/billforward/models/square_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class SquarePayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """SquarePayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SquarePayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SquarePayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/square_subscription.py b/billforward/models/square_subscription.py new file mode 100644 index 0000000..54de6b3 --- /dev/null +++ b/billforward/models/square_subscription.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SquareSubscription(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'int', + 'organization_id': 'str', + 'subscription_id': 'str', + 'location_id': 'str', + 'customer_id': 'str' + } + + attribute_map = { + 'id': 'id', + 'organization_id': 'organizationId', + 'subscription_id': 'subscriptionID', + 'location_id': 'locationId', + 'customer_id': 'customerId' + } + + def __init__(self, id=None, organization_id=None, subscription_id=None, location_id=None, customer_id=None): # noqa: E501 + """SquareSubscription - a model defined in Swagger""" # noqa: E501 + self._id = None + self._organization_id = None + self._subscription_id = None + self._location_id = None + self._customer_id = None + self.discriminator = None + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if subscription_id is not None: + self.subscription_id = subscription_id + if location_id is not None: + self.location_id = location_id + if customer_id is not None: + self.customer_id = customer_id + + @property + def id(self): + """Gets the id of this SquareSubscription. # noqa: E501 + + + :return: The id of this SquareSubscription. # noqa: E501 + :rtype: int + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this SquareSubscription. + + + :param id: The id of this SquareSubscription. # noqa: E501 + :type: int + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this SquareSubscription. # noqa: E501 + + + :return: The organization_id of this SquareSubscription. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SquareSubscription. + + + :param organization_id: The organization_id of this SquareSubscription. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def subscription_id(self): + """Gets the subscription_id of this SquareSubscription. # noqa: E501 + + + :return: The subscription_id of this SquareSubscription. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this SquareSubscription. + + + :param subscription_id: The subscription_id of this SquareSubscription. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def location_id(self): + """Gets the location_id of this SquareSubscription. # noqa: E501 + + + :return: The location_id of this SquareSubscription. # noqa: E501 + :rtype: str + """ + return self._location_id + + @location_id.setter + def location_id(self, location_id): + """Sets the location_id of this SquareSubscription. + + + :param location_id: The location_id of this SquareSubscription. # noqa: E501 + :type: str + """ + + self._location_id = location_id + + @property + def customer_id(self): + """Gets the customer_id of this SquareSubscription. # noqa: E501 + + + :return: The customer_id of this SquareSubscription. # noqa: E501 + :rtype: str + """ + return self._customer_id + + @customer_id.setter + def customer_id(self, customer_id): + """Sets the customer_id of this SquareSubscription. + + + :param customer_id: The customer_id of this SquareSubscription. # noqa: E501 + :type: str + """ + + self._customer_id = customer_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SquareSubscription, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SquareSubscription): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/start_all_subscriptions_request.py b/billforward/models/start_all_subscriptions_request.py new file mode 100644 index 0000000..9072740 --- /dev/null +++ b/billforward/models/start_all_subscriptions_request.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class StartAllSubscriptionsRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, organization_id=None): # noqa: E501 + """StartAllSubscriptionsRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this StartAllSubscriptionsRequest. # noqa: E501 + + + :return: The created of this StartAllSubscriptionsRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this StartAllSubscriptionsRequest. + + + :param created: The created of this StartAllSubscriptionsRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this StartAllSubscriptionsRequest. # noqa: E501 + + + :return: The organization_id of this StartAllSubscriptionsRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this StartAllSubscriptionsRequest. + + + :param organization_id: The organization_id of this StartAllSubscriptionsRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(StartAllSubscriptionsRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, StartAllSubscriptionsRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/start_all_subscriptions_response.py b/billforward/models/start_all_subscriptions_response.py new file mode 100644 index 0000000..798e4d8 --- /dev/null +++ b/billforward/models/start_all_subscriptions_response.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class StartAllSubscriptionsResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'subscriptions': 'list[Subscription]', + 'parent': 'Subscription', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'subscriptions': 'subscriptions', + 'parent': 'parent', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, subscriptions=None, parent=None, organization_id=None): # noqa: E501 + """StartAllSubscriptionsResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._subscriptions = None + self._parent = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if subscriptions is not None: + self.subscriptions = subscriptions + if parent is not None: + self.parent = parent + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this StartAllSubscriptionsResponse. # noqa: E501 + + + :return: The created of this StartAllSubscriptionsResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this StartAllSubscriptionsResponse. + + + :param created: The created of this StartAllSubscriptionsResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def subscriptions(self): + """Gets the subscriptions of this StartAllSubscriptionsResponse. # noqa: E501 + + + :return: The subscriptions of this StartAllSubscriptionsResponse. # noqa: E501 + :rtype: list[Subscription] + """ + return self._subscriptions + + @subscriptions.setter + def subscriptions(self, subscriptions): + """Sets the subscriptions of this StartAllSubscriptionsResponse. + + + :param subscriptions: The subscriptions of this StartAllSubscriptionsResponse. # noqa: E501 + :type: list[Subscription] + """ + + self._subscriptions = subscriptions + + @property + def parent(self): + """Gets the parent of this StartAllSubscriptionsResponse. # noqa: E501 + + + :return: The parent of this StartAllSubscriptionsResponse. # noqa: E501 + :rtype: Subscription + """ + return self._parent + + @parent.setter + def parent(self, parent): + """Sets the parent of this StartAllSubscriptionsResponse. + + + :param parent: The parent of this StartAllSubscriptionsResponse. # noqa: E501 + :type: Subscription + """ + + self._parent = parent + + @property + def organization_id(self): + """Gets the organization_id of this StartAllSubscriptionsResponse. # noqa: E501 + + + :return: The organization_id of this StartAllSubscriptionsResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this StartAllSubscriptionsResponse. + + + :param organization_id: The organization_id of this StartAllSubscriptionsResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(StartAllSubscriptionsResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, StartAllSubscriptionsResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/start_contract_request.py b/billforward/models/start_contract_request.py new file mode 100644 index 0000000..6c55d2f --- /dev/null +++ b/billforward/models/start_contract_request.py @@ -0,0 +1,168 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class StartContractRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'start': 'datetime', + 'state': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'start': 'start', + 'state': 'state', + 'organization_id': 'organizationID' + } + + def __init__(self, start=None, state=None, organization_id=None): # noqa: E501 + """StartContractRequest - a model defined in Swagger""" # noqa: E501 + self._start = None + self._state = None + self._organization_id = None + self.discriminator = None + if start is not None: + self.start = start + if state is not None: + self.state = state + if organization_id is not None: + self.organization_id = organization_id + + @property + def start(self): + """Gets the start of this StartContractRequest. # noqa: E501 + + + :return: The start of this StartContractRequest. # noqa: E501 + :rtype: datetime + """ + return self._start + + @start.setter + def start(self, start): + """Sets the start of this StartContractRequest. + + + :param start: The start of this StartContractRequest. # noqa: E501 + :type: datetime + """ + + self._start = start + + @property + def state(self): + """Gets the state of this StartContractRequest. # noqa: E501 + + + :return: The state of this StartContractRequest. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this StartContractRequest. + + + :param state: The state of this StartContractRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Provisioned", "AwaitingPayment"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def organization_id(self): + """Gets the organization_id of this StartContractRequest. # noqa: E501 + + + :return: The organization_id of this StartContractRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this StartContractRequest. + + + :param organization_id: The organization_id of this StartContractRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(StartContractRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, StartContractRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/start_contract_response.py b/billforward/models/start_contract_response.py new file mode 100644 index 0000000..12a11e9 --- /dev/null +++ b/billforward/models/start_contract_response.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class StartContractResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'subscription': 'Subscription', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'subscription': 'subscription', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, subscription=None, organization_id=None): # noqa: E501 + """StartContractResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._subscription = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if subscription is not None: + self.subscription = subscription + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this StartContractResponse. # noqa: E501 + + + :return: The created of this StartContractResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this StartContractResponse. + + + :param created: The created of this StartContractResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def subscription(self): + """Gets the subscription of this StartContractResponse. # noqa: E501 + + + :return: The subscription of this StartContractResponse. # noqa: E501 + :rtype: Subscription + """ + return self._subscription + + @subscription.setter + def subscription(self, subscription): + """Sets the subscription of this StartContractResponse. + + + :param subscription: The subscription of this StartContractResponse. # noqa: E501 + :type: Subscription + """ + + self._subscription = subscription + + @property + def organization_id(self): + """Gets the organization_id of this StartContractResponse. # noqa: E501 + + + :return: The organization_id of this StartContractResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this StartContractResponse. + + + :param organization_id: The organization_id of this StartContractResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(StartContractResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, StartContractResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/stripe_ach_capture_request.py b/billforward/models/stripe_ach_capture_request.py new file mode 100644 index 0000000..ecd09df --- /dev/null +++ b/billforward/models/stripe_ach_capture_request.py @@ -0,0 +1,370 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class StripeACHCaptureRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'account_id': 'str', + 'default_payment_method': 'bool', + 'routing_number': 'str', + 'account_number': 'str', + 'stripe_customer_id': 'str', + 'holder_name': 'str', + 'bank_account_name': 'str', + 'account_holder_type': 'str', + 'email_tokenization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'default_payment_method': 'defaultPaymentMethod', + 'routing_number': 'routingNumber', + 'account_number': 'accountNumber', + 'stripe_customer_id': 'stripeCustomerID', + 'holder_name': 'holderName', + 'bank_account_name': 'bankAccountName', + 'account_holder_type': 'accountHolderType', + 'email_tokenization_id': 'emailTokenizationID' + } + + def __init__(self, created=None, organization_id=None, account_id=None, default_payment_method=None, routing_number=None, account_number=None, stripe_customer_id=None, holder_name=None, bank_account_name=None, account_holder_type=None, email_tokenization_id=None): # noqa: E501 + """StripeACHCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._account_id = None + self._default_payment_method = None + self._routing_number = None + self._account_number = None + self._stripe_customer_id = None + self._holder_name = None + self._bank_account_name = None + self._account_holder_type = None + self._email_tokenization_id = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if default_payment_method is not None: + self.default_payment_method = default_payment_method + if routing_number is not None: + self.routing_number = routing_number + if account_number is not None: + self.account_number = account_number + if stripe_customer_id is not None: + self.stripe_customer_id = stripe_customer_id + if holder_name is not None: + self.holder_name = holder_name + if bank_account_name is not None: + self.bank_account_name = bank_account_name + if account_holder_type is not None: + self.account_holder_type = account_holder_type + if email_tokenization_id is not None: + self.email_tokenization_id = email_tokenization_id + + @property + def created(self): + """Gets the created of this StripeACHCaptureRequest. # noqa: E501 + + + :return: The created of this StripeACHCaptureRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this StripeACHCaptureRequest. + + + :param created: The created of this StripeACHCaptureRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this StripeACHCaptureRequest. # noqa: E501 + + + :return: The organization_id of this StripeACHCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this StripeACHCaptureRequest. + + + :param organization_id: The organization_id of this StripeACHCaptureRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_id(self): + """Gets the account_id of this StripeACHCaptureRequest. # noqa: E501 + + + :return: The account_id of this StripeACHCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this StripeACHCaptureRequest. + + + :param account_id: The account_id of this StripeACHCaptureRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def default_payment_method(self): + """Gets the default_payment_method of this StripeACHCaptureRequest. # noqa: E501 + + + :return: The default_payment_method of this StripeACHCaptureRequest. # noqa: E501 + :rtype: bool + """ + return self._default_payment_method + + @default_payment_method.setter + def default_payment_method(self, default_payment_method): + """Sets the default_payment_method of this StripeACHCaptureRequest. + + + :param default_payment_method: The default_payment_method of this StripeACHCaptureRequest. # noqa: E501 + :type: bool + """ + + self._default_payment_method = default_payment_method + + @property + def routing_number(self): + """Gets the routing_number of this StripeACHCaptureRequest. # noqa: E501 + + + :return: The routing_number of this StripeACHCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._routing_number + + @routing_number.setter + def routing_number(self, routing_number): + """Sets the routing_number of this StripeACHCaptureRequest. + + + :param routing_number: The routing_number of this StripeACHCaptureRequest. # noqa: E501 + :type: str + """ + + self._routing_number = routing_number + + @property + def account_number(self): + """Gets the account_number of this StripeACHCaptureRequest. # noqa: E501 + + + :return: The account_number of this StripeACHCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._account_number + + @account_number.setter + def account_number(self, account_number): + """Sets the account_number of this StripeACHCaptureRequest. + + + :param account_number: The account_number of this StripeACHCaptureRequest. # noqa: E501 + :type: str + """ + + self._account_number = account_number + + @property + def stripe_customer_id(self): + """Gets the stripe_customer_id of this StripeACHCaptureRequest. # noqa: E501 + + + :return: The stripe_customer_id of this StripeACHCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._stripe_customer_id + + @stripe_customer_id.setter + def stripe_customer_id(self, stripe_customer_id): + """Sets the stripe_customer_id of this StripeACHCaptureRequest. + + + :param stripe_customer_id: The stripe_customer_id of this StripeACHCaptureRequest. # noqa: E501 + :type: str + """ + + self._stripe_customer_id = stripe_customer_id + + @property + def holder_name(self): + """Gets the holder_name of this StripeACHCaptureRequest. # noqa: E501 + + + :return: The holder_name of this StripeACHCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._holder_name + + @holder_name.setter + def holder_name(self, holder_name): + """Sets the holder_name of this StripeACHCaptureRequest. + + + :param holder_name: The holder_name of this StripeACHCaptureRequest. # noqa: E501 + :type: str + """ + + self._holder_name = holder_name + + @property + def bank_account_name(self): + """Gets the bank_account_name of this StripeACHCaptureRequest. # noqa: E501 + + + :return: The bank_account_name of this StripeACHCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._bank_account_name + + @bank_account_name.setter + def bank_account_name(self, bank_account_name): + """Sets the bank_account_name of this StripeACHCaptureRequest. + + + :param bank_account_name: The bank_account_name of this StripeACHCaptureRequest. # noqa: E501 + :type: str + """ + + self._bank_account_name = bank_account_name + + @property + def account_holder_type(self): + """Gets the account_holder_type of this StripeACHCaptureRequest. # noqa: E501 + + + :return: The account_holder_type of this StripeACHCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._account_holder_type + + @account_holder_type.setter + def account_holder_type(self, account_holder_type): + """Sets the account_holder_type of this StripeACHCaptureRequest. + + + :param account_holder_type: The account_holder_type of this StripeACHCaptureRequest. # noqa: E501 + :type: str + """ + + self._account_holder_type = account_holder_type + + @property + def email_tokenization_id(self): + """Gets the email_tokenization_id of this StripeACHCaptureRequest. # noqa: E501 + + + :return: The email_tokenization_id of this StripeACHCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._email_tokenization_id + + @email_tokenization_id.setter + def email_tokenization_id(self, email_tokenization_id): + """Sets the email_tokenization_id of this StripeACHCaptureRequest. + + + :param email_tokenization_id: The email_tokenization_id of this StripeACHCaptureRequest. # noqa: E501 + :type: str + """ + + self._email_tokenization_id = email_tokenization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(StripeACHCaptureRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, StripeACHCaptureRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/stripe_ach_payment.py b/billforward/models/stripe_ach_payment.py new file mode 100644 index 0000000..722ce70 --- /dev/null +++ b/billforward/models/stripe_ach_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class StripeACHPayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """StripeACHPayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(StripeACHPayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, StripeACHPayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/stripe_ach_token.py b/billforward/models/stripe_ach_token.py new file mode 100644 index 0000000..a081dff --- /dev/null +++ b/billforward/models/stripe_ach_token.py @@ -0,0 +1,374 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class StripeAchToken(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'account_id': 'str', + 'organization_id': 'str', + 'stripe_customer_id': 'str', + 'stripe_bank_account_id': 'str', + 'verified': 'bool', + 'deleted': 'bool', + 'bank_account': 'BankAccount' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'account_id': 'accountID', + 'organization_id': 'organizationID', + 'stripe_customer_id': 'stripeCustomerID', + 'stripe_bank_account_id': 'stripeBankAccountID', + 'verified': 'verified', + 'deleted': 'deleted', + 'bank_account': 'bankAccount' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, organization_id=None, stripe_customer_id=None, stripe_bank_account_id=None, verified=None, deleted=None, bank_account=None): # noqa: E501 + """StripeAchToken - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._account_id = None + self._organization_id = None + self._stripe_customer_id = None + self._stripe_bank_account_id = None + self._verified = None + self._deleted = None + self._bank_account = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.account_id = account_id + self.organization_id = organization_id + self.stripe_customer_id = stripe_customer_id + if stripe_bank_account_id is not None: + self.stripe_bank_account_id = stripe_bank_account_id + if verified is not None: + self.verified = verified + self.deleted = deleted + if bank_account is not None: + self.bank_account = bank_account + + @property + def created(self): + """Gets the created of this StripeAchToken. # noqa: E501 + + + :return: The created of this StripeAchToken. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this StripeAchToken. + + + :param created: The created of this StripeAchToken. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this StripeAchToken. # noqa: E501 + + + :return: The changed_by of this StripeAchToken. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this StripeAchToken. + + + :param changed_by: The changed_by of this StripeAchToken. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this StripeAchToken. # noqa: E501 + + + :return: The updated of this StripeAchToken. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this StripeAchToken. + + + :param updated: The updated of this StripeAchToken. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this StripeAchToken. # noqa: E501 + + + :return: The id of this StripeAchToken. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this StripeAchToken. + + + :param id: The id of this StripeAchToken. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def account_id(self): + """Gets the account_id of this StripeAchToken. # noqa: E501 + + + :return: The account_id of this StripeAchToken. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this StripeAchToken. + + + :param account_id: The account_id of this StripeAchToken. # noqa: E501 + :type: str + """ + if account_id is None: + raise ValueError("Invalid value for `account_id`, must not be `None`") # noqa: E501 + + self._account_id = account_id + + @property + def organization_id(self): + """Gets the organization_id of this StripeAchToken. # noqa: E501 + + + :return: The organization_id of this StripeAchToken. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this StripeAchToken. + + + :param organization_id: The organization_id of this StripeAchToken. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def stripe_customer_id(self): + """Gets the stripe_customer_id of this StripeAchToken. # noqa: E501 + + + :return: The stripe_customer_id of this StripeAchToken. # noqa: E501 + :rtype: str + """ + return self._stripe_customer_id + + @stripe_customer_id.setter + def stripe_customer_id(self, stripe_customer_id): + """Sets the stripe_customer_id of this StripeAchToken. + + + :param stripe_customer_id: The stripe_customer_id of this StripeAchToken. # noqa: E501 + :type: str + """ + if stripe_customer_id is None: + raise ValueError("Invalid value for `stripe_customer_id`, must not be `None`") # noqa: E501 + + self._stripe_customer_id = stripe_customer_id + + @property + def stripe_bank_account_id(self): + """Gets the stripe_bank_account_id of this StripeAchToken. # noqa: E501 + + + :return: The stripe_bank_account_id of this StripeAchToken. # noqa: E501 + :rtype: str + """ + return self._stripe_bank_account_id + + @stripe_bank_account_id.setter + def stripe_bank_account_id(self, stripe_bank_account_id): + """Sets the stripe_bank_account_id of this StripeAchToken. + + + :param stripe_bank_account_id: The stripe_bank_account_id of this StripeAchToken. # noqa: E501 + :type: str + """ + + self._stripe_bank_account_id = stripe_bank_account_id + + @property + def verified(self): + """Gets the verified of this StripeAchToken. # noqa: E501 + + + :return: The verified of this StripeAchToken. # noqa: E501 + :rtype: bool + """ + return self._verified + + @verified.setter + def verified(self, verified): + """Sets the verified of this StripeAchToken. + + + :param verified: The verified of this StripeAchToken. # noqa: E501 + :type: bool + """ + + self._verified = verified + + @property + def deleted(self): + """Gets the deleted of this StripeAchToken. # noqa: E501 + + + :return: The deleted of this StripeAchToken. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this StripeAchToken. + + + :param deleted: The deleted of this StripeAchToken. # noqa: E501 + :type: bool + """ + if deleted is None: + raise ValueError("Invalid value for `deleted`, must not be `None`") # noqa: E501 + + self._deleted = deleted + + @property + def bank_account(self): + """Gets the bank_account of this StripeAchToken. # noqa: E501 + + + :return: The bank_account of this StripeAchToken. # noqa: E501 + :rtype: BankAccount + """ + return self._bank_account + + @bank_account.setter + def bank_account(self, bank_account): + """Sets the bank_account of this StripeAchToken. + + + :param bank_account: The bank_account of this StripeAchToken. # noqa: E501 + :type: BankAccount + """ + + self._bank_account = bank_account + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(StripeAchToken, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, StripeAchToken): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/stripe_ach_token_paged_metadata.py b/billforward/models/stripe_ach_token_paged_metadata.py deleted file mode 100644 index 81f7b25..0000000 --- a/billforward/models/stripe_ach_token_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class StripeACHTokenPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - StripeACHTokenPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this StripeACHTokenPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this StripeACHTokenPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this StripeACHTokenPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this StripeACHTokenPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this StripeACHTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this StripeACHTokenPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this StripeACHTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this StripeACHTokenPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this StripeACHTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this StripeACHTokenPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this StripeACHTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this StripeACHTokenPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this StripeACHTokenPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this StripeACHTokenPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this StripeACHTokenPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this StripeACHTokenPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this StripeACHTokenPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this StripeACHTokenPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this StripeACHTokenPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this StripeACHTokenPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this StripeACHTokenPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this StripeACHTokenPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this StripeACHTokenPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this StripeACHTokenPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this StripeACHTokenPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this StripeACHTokenPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this StripeACHTokenPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this StripeACHTokenPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/stripe_additional_data.py b/billforward/models/stripe_additional_data.py new file mode 100644 index 0000000..f3f1ddb --- /dev/null +++ b/billforward/models/stripe_additional_data.py @@ -0,0 +1,142 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.additional_data import AdditionalData # noqa: F401,E501 + +class StripeAdditionalData(AdditionalData): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'setup_intent_client_secret': 'str', + 'setup_intent_status': 'str' + } + if hasattr(AdditionalData, "swagger_types"): + swagger_types.update(AdditionalData.swagger_types) + + attribute_map = { + 'setup_intent_client_secret': 'setupIntentClientSecret', + 'setup_intent_status': 'setupIntentStatus' + } + if hasattr(AdditionalData, "attribute_map"): + attribute_map.update(AdditionalData.attribute_map) + + def __init__(self, setup_intent_client_secret=None, setup_intent_status=None, *args, **kwargs): # noqa: E501 + """StripeAdditionalData - a model defined in Swagger""" # noqa: E501 + self._setup_intent_client_secret = None + self._setup_intent_status = None + self.discriminator = None + if setup_intent_client_secret is not None: + self.setup_intent_client_secret = setup_intent_client_secret + if setup_intent_status is not None: + self.setup_intent_status = setup_intent_status + AdditionalData.__init__(self, *args, **kwargs) + + @property + def setup_intent_client_secret(self): + """Gets the setup_intent_client_secret of this StripeAdditionalData. # noqa: E501 + + + :return: The setup_intent_client_secret of this StripeAdditionalData. # noqa: E501 + :rtype: str + """ + return self._setup_intent_client_secret + + @setup_intent_client_secret.setter + def setup_intent_client_secret(self, setup_intent_client_secret): + """Sets the setup_intent_client_secret of this StripeAdditionalData. + + + :param setup_intent_client_secret: The setup_intent_client_secret of this StripeAdditionalData. # noqa: E501 + :type: str + """ + + self._setup_intent_client_secret = setup_intent_client_secret + + @property + def setup_intent_status(self): + """Gets the setup_intent_status of this StripeAdditionalData. # noqa: E501 + + + :return: The setup_intent_status of this StripeAdditionalData. # noqa: E501 + :rtype: str + """ + return self._setup_intent_status + + @setup_intent_status.setter + def setup_intent_status(self, setup_intent_status): + """Sets the setup_intent_status of this StripeAdditionalData. + + + :param setup_intent_status: The setup_intent_status of this StripeAdditionalData. # noqa: E501 + :type: str + """ + + self._setup_intent_status = setup_intent_status + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(StripeAdditionalData, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, StripeAdditionalData): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/stripe_auth_capture_request.py b/billforward/models/stripe_auth_capture_request.py index b5065b9..86a1013 100644 --- a/billforward/models/stripe_auth_capture_request.py +++ b/billforward/models/stripe_auth_capture_request.py @@ -1,374 +1,106 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.auth_capture_request import AuthCaptureRequest # noqa: F401,E501 + +class StripeAuthCaptureRequest(AuthCaptureRequest): + """NOTE: This class is auto generated by the swagger code generator program. -class StripeAuthCaptureRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, type=None, account_id=None, gateway=None, company_name=None, email=None, first_name=None, last_name=None, mobile=None, default_payment_method=False, organization_id=None, stripe_token=None, card_id=None, customer_id=None): - """ - StripeAuthCaptureRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'type': 'str', - 'account_id': 'str', - 'gateway': 'str', - 'company_name': 'str', - 'email': 'str', - 'first_name': 'str', - 'last_name': 'str', - 'mobile': 'str', - 'default_payment_method': 'bool', - 'organization_id': 'str', - 'stripe_token': 'str', - 'card_id': 'str', - 'customer_id': 'str' - } - - self.attribute_map = { - 'type': '@type', - 'account_id': 'accountID', - 'gateway': 'gateway', - 'company_name': 'companyName', - 'email': 'email', - 'first_name': 'firstName', - 'last_name': 'lastName', - 'mobile': 'mobile', - 'default_payment_method': 'defaultPaymentMethod', - 'organization_id': 'organizationID', - 'stripe_token': 'stripeToken', - 'card_id': 'cardID', - 'customer_id': 'customerID' - } - - self._type = type - self._account_id = account_id - self._gateway = gateway - self._company_name = company_name - self._email = email - self._first_name = first_name - self._last_name = last_name - self._mobile = mobile - self._default_payment_method = default_payment_method - self._organization_id = organization_id - self._stripe_token = stripe_token - self._card_id = card_id - self._customer_id = customer_id - - @property - def type(self): - """ - Gets the type of this StripeAuthCaptureRequest. - - - :return: The type of this StripeAuthCaptureRequest. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this StripeAuthCaptureRequest. - - - :param type: The type of this StripeAuthCaptureRequest. - :type: str - """ - allowed_values = ["StripeAuthCaptureRequest"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def account_id(self): - """ - Gets the account_id of this StripeAuthCaptureRequest. - {\"description\":\"ID of the BillForward Account with which you would like to associate the created payment method.
If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.\",\"verbs\":[\"POST\"]} - - :return: The account_id of this StripeAuthCaptureRequest. - :rtype: str - """ - return self._account_id - - @account_id.setter - def account_id(self, account_id): - """ - Sets the account_id of this StripeAuthCaptureRequest. - {\"description\":\"ID of the BillForward Account with which you would like to associate the created payment method.
If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.\",\"verbs\":[\"POST\"]} - - :param account_id: The account_id of this StripeAuthCaptureRequest. - :type: str - """ - - self._account_id = account_id - - @property - def gateway(self): - """ - Gets the gateway of this StripeAuthCaptureRequest. - {\"description\":\"The gateway with which your funding instrument has been vaulted.\",\"verbs\":[\"POST\"]} - - :return: The gateway of this StripeAuthCaptureRequest. - :rtype: str - """ - return self._gateway - - @gateway.setter - def gateway(self, gateway): - """ - Sets the gateway of this StripeAuthCaptureRequest. - {\"description\":\"The gateway with which your funding instrument has been vaulted.\",\"verbs\":[\"POST\"]} - - :param gateway: The gateway of this StripeAuthCaptureRequest. - :type: str - """ - allowed_values = ["Balanced", "Braintree", "Cybersource", "Paypal", "Stripe", "AuthorizeNet", "Spreedly", "SagePay", "TrustCommerce", "Payvision", "Kash"] - if gateway not in allowed_values: - raise ValueError( - "Invalid value for `gateway` ({0}), must be one of {1}" - .format(gateway, allowed_values) - ) - - self._gateway = gateway - - @property - def company_name(self): - """ - Gets the company_name of this StripeAuthCaptureRequest. - {\"description\":\"The name of the company of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :return: The company_name of this StripeAuthCaptureRequest. - :rtype: str - """ - return self._company_name - - @company_name.setter - def company_name(self, company_name): - """ - Sets the company_name of this StripeAuthCaptureRequest. - {\"description\":\"The name of the company of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :param company_name: The company_name of this StripeAuthCaptureRequest. - :type: str - """ - - self._company_name = company_name - - @property - def email(self): - """ - Gets the email of this StripeAuthCaptureRequest. - {\"description\":\"The email address of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :return: The email of this StripeAuthCaptureRequest. - :rtype: str - """ - return self._email - - @email.setter - def email(self, email): - """ - Sets the email of this StripeAuthCaptureRequest. - {\"description\":\"The email address of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :param email: The email of this StripeAuthCaptureRequest. - :type: str - """ - - self._email = email - - @property - def first_name(self): - """ - Gets the first_name of this StripeAuthCaptureRequest. - {\"description\":\"The first name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :return: The first_name of this StripeAuthCaptureRequest. - :rtype: str - """ - return self._first_name - - @first_name.setter - def first_name(self, first_name): - """ - Sets the first_name of this StripeAuthCaptureRequest. - {\"description\":\"The first name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :param first_name: The first_name of this StripeAuthCaptureRequest. - :type: str - """ - - self._first_name = first_name - - @property - def last_name(self): - """ - Gets the last_name of this StripeAuthCaptureRequest. - {\"description\":\"The last name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :return: The last_name of this StripeAuthCaptureRequest. - :rtype: str - """ - return self._last_name - - @last_name.setter - def last_name(self, last_name): - """ - Sets the last_name of this StripeAuthCaptureRequest. - {\"description\":\"The last name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :param last_name: The last_name of this StripeAuthCaptureRequest. - :type: str - """ - - self._last_name = last_name - - @property - def mobile(self): - """ - Gets the mobile of this StripeAuthCaptureRequest. - {\"description\":\"The mobile phone number of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :return: The mobile of this StripeAuthCaptureRequest. - :rtype: str - """ - return self._mobile - - @mobile.setter - def mobile(self, mobile): - """ - Sets the mobile of this StripeAuthCaptureRequest. - {\"description\":\"The mobile phone number of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile — should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} - - :param mobile: The mobile of this StripeAuthCaptureRequest. - :type: str - """ - - self._mobile = mobile - - @property - def default_payment_method(self): - """ - Gets the default_payment_method of this StripeAuthCaptureRequest. - {\"default\":false,\"description\":\"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).\",\"verbs\":[\"POST\"]} - - :return: The default_payment_method of this StripeAuthCaptureRequest. - :rtype: bool - """ - return self._default_payment_method - - @default_payment_method.setter - def default_payment_method(self, default_payment_method): - """ - Sets the default_payment_method of this StripeAuthCaptureRequest. - {\"default\":false,\"description\":\"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).\",\"verbs\":[\"POST\"]} - - :param default_payment_method: The default_payment_method of this StripeAuthCaptureRequest. - :type: bool - """ - - self._default_payment_method = default_payment_method - - @property - def organization_id(self): - """ - Gets the organization_id of this StripeAuthCaptureRequest. - {\"description\":\"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} - - :return: The organization_id of this StripeAuthCaptureRequest. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this StripeAuthCaptureRequest. - {\"description\":\"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} - - :param organization_id: The organization_id of this StripeAuthCaptureRequest. - :type: str - """ - - self._organization_id = organization_id + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'stripe_token': 'str', + 'card_id': 'str', + 'customer_id': 'str', + 'requires_setup_intent': 'bool' + } + if hasattr(AuthCaptureRequest, "swagger_types"): + swagger_types.update(AuthCaptureRequest.swagger_types) + + attribute_map = { + 'stripe_token': 'stripeToken', + 'card_id': 'cardID', + 'customer_id': 'customerID', + 'requires_setup_intent': 'requiresSetupIntent' + } + if hasattr(AuthCaptureRequest, "attribute_map"): + attribute_map.update(AuthCaptureRequest.attribute_map) + + def __init__(self, stripe_token=None, card_id=None, customer_id=None, requires_setup_intent=None, *args, **kwargs): # noqa: E501 + """StripeAuthCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._stripe_token = None + self._card_id = None + self._customer_id = None + self._requires_setup_intent = None + self.discriminator = None + self.stripe_token = stripe_token + if card_id is not None: + self.card_id = card_id + if customer_id is not None: + self.customer_id = customer_id + if requires_setup_intent is not None: + self.requires_setup_intent = requires_setup_intent + AuthCaptureRequest.__init__(self, *args, **kwargs) @property def stripe_token(self): - """ - Gets the stripe_token of this StripeAuthCaptureRequest. - {\"description\":\"Single-use token provided by Stripe's client-side card capture SDK, in response to your capturing a card into the Stripe vault. This token will be used by BillForward to find the tokenized card within the Stripe vault — precursory to linking a BillForward PaymentMethod to that tokenized card.\",\"verbs\":[\"POST\"]} + """Gets the stripe_token of this StripeAuthCaptureRequest. # noqa: E501 - :return: The stripe_token of this StripeAuthCaptureRequest. + + :return: The stripe_token of this StripeAuthCaptureRequest. # noqa: E501 :rtype: str """ return self._stripe_token @stripe_token.setter def stripe_token(self, stripe_token): - """ - Sets the stripe_token of this StripeAuthCaptureRequest. - {\"description\":\"Single-use token provided by Stripe's client-side card capture SDK, in response to your capturing a card into the Stripe vault. This token will be used by BillForward to find the tokenized card within the Stripe vault — precursory to linking a BillForward PaymentMethod to that tokenized card.\",\"verbs\":[\"POST\"]} + """Sets the stripe_token of this StripeAuthCaptureRequest. + - :param stripe_token: The stripe_token of this StripeAuthCaptureRequest. + :param stripe_token: The stripe_token of this StripeAuthCaptureRequest. # noqa: E501 :type: str """ + if stripe_token is None: + raise ValueError("Invalid value for `stripe_token`, must not be `None`") # noqa: E501 self._stripe_token = stripe_token @property def card_id(self): - """ - Gets the card_id of this StripeAuthCaptureRequest. - {\"description\":\"ID of the captured Card in Stripe. This can be provided as well as — or instead of — the one-use `stripeToken`, to lead BillForward to the card tokenized within the Stripe vault.\",\"verbs\":[\"POST\"]} + """Gets the card_id of this StripeAuthCaptureRequest. # noqa: E501 + - :return: The card_id of this StripeAuthCaptureRequest. + :return: The card_id of this StripeAuthCaptureRequest. # noqa: E501 :rtype: str """ return self._card_id @card_id.setter def card_id(self, card_id): - """ - Sets the card_id of this StripeAuthCaptureRequest. - {\"description\":\"ID of the captured Card in Stripe. This can be provided as well as — or instead of — the one-use `stripeToken`, to lead BillForward to the card tokenized within the Stripe vault.\",\"verbs\":[\"POST\"]} + """Sets the card_id of this StripeAuthCaptureRequest. + - :param card_id: The card_id of this StripeAuthCaptureRequest. + :param card_id: The card_id of this StripeAuthCaptureRequest. # noqa: E501 :type: str """ @@ -376,34 +108,51 @@ def card_id(self, card_id): @property def customer_id(self): - """ - Gets the customer_id of this StripeAuthCaptureRequest. + """Gets the customer_id of this StripeAuthCaptureRequest. # noqa: E501 - :return: The customer_id of this StripeAuthCaptureRequest. + :return: The customer_id of this StripeAuthCaptureRequest. # noqa: E501 :rtype: str """ return self._customer_id @customer_id.setter def customer_id(self, customer_id): - """ - Sets the customer_id of this StripeAuthCaptureRequest. + """Sets the customer_id of this StripeAuthCaptureRequest. - :param customer_id: The customer_id of this StripeAuthCaptureRequest. + :param customer_id: The customer_id of this StripeAuthCaptureRequest. # noqa: E501 :type: str """ self._customer_id = customer_id - def to_dict(self): + @property + def requires_setup_intent(self): + """Gets the requires_setup_intent of this StripeAuthCaptureRequest. # noqa: E501 + + + :return: The requires_setup_intent of this StripeAuthCaptureRequest. # noqa: E501 + :rtype: bool """ - Returns the model properties as a dict + return self._requires_setup_intent + + @requires_setup_intent.setter + def requires_setup_intent(self, requires_setup_intent): + """Sets the requires_setup_intent of this StripeAuthCaptureRequest. + + + :param requires_setup_intent: The requires_setup_intent of this StripeAuthCaptureRequest. # noqa: E501 + :type: bool """ + + self._requires_setup_intent = requires_setup_intent + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -420,29 +169,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(StripeAuthCaptureRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, StripeAuthCaptureRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/stripe_card_payment.py b/billforward/models/stripe_card_payment.py new file mode 100644 index 0000000..820a620 --- /dev/null +++ b/billforward/models/stripe_card_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class StripeCardPayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """StripeCardPayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(StripeCardPayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, StripeCardPayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/stripe_configuration.py b/billforward/models/stripe_configuration.py new file mode 100644 index 0000000..1501c62 --- /dev/null +++ b/billforward/models/stripe_configuration.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class StripeConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """StripeConfiguration - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + APIConfiguration.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(StripeConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, StripeConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/stripe_object.py b/billforward/models/stripe_object.py deleted file mode 100644 index 7e23c18..0000000 --- a/billforward/models/stripe_object.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class StripeObject(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self): - """ - StripeObject - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - - } - - self.attribute_map = { - - } - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/stripe_pre_auth_request.py b/billforward/models/stripe_pre_auth_request.py new file mode 100644 index 0000000..eb37057 --- /dev/null +++ b/billforward/models/stripe_pre_auth_request.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.tokenization_pre_auth_request import TokenizationPreAuthRequest # noqa: F401,E501 + +class StripePreAuthRequest(TokenizationPreAuthRequest): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(TokenizationPreAuthRequest, "swagger_types"): + swagger_types.update(TokenizationPreAuthRequest.swagger_types) + + attribute_map = { + } + if hasattr(TokenizationPreAuthRequest, "attribute_map"): + attribute_map.update(TokenizationPreAuthRequest.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """StripePreAuthRequest - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + TokenizationPreAuthRequest.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(StripePreAuthRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, StripePreAuthRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/stripe_token.py b/billforward/models/stripe_token.py new file mode 100644 index 0000000..24143b7 --- /dev/null +++ b/billforward/models/stripe_token.py @@ -0,0 +1,355 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class StripeToken(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'account_id': 'str', + 'card_details_id': 'str', + 'organization_id': 'str', + 'stripe_customer_id': 'str', + 'status': 'str', + 'deleted': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'account_id': 'accountID', + 'card_details_id': 'cardDetailsID', + 'organization_id': 'organizationID', + 'stripe_customer_id': 'stripeCustomerID', + 'status': 'status', + 'deleted': 'deleted' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, card_details_id=None, organization_id=None, stripe_customer_id=None, status=None, deleted=None): # noqa: E501 + """StripeToken - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._account_id = None + self._card_details_id = None + self._organization_id = None + self._stripe_customer_id = None + self._status = None + self._deleted = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.account_id = account_id + if card_details_id is not None: + self.card_details_id = card_details_id + self.organization_id = organization_id + self.stripe_customer_id = stripe_customer_id + self.status = status + self.deleted = deleted + + @property + def created(self): + """Gets the created of this StripeToken. # noqa: E501 + + + :return: The created of this StripeToken. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this StripeToken. + + + :param created: The created of this StripeToken. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this StripeToken. # noqa: E501 + + + :return: The changed_by of this StripeToken. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this StripeToken. + + + :param changed_by: The changed_by of this StripeToken. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this StripeToken. # noqa: E501 + + + :return: The updated of this StripeToken. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this StripeToken. + + + :param updated: The updated of this StripeToken. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this StripeToken. # noqa: E501 + + + :return: The id of this StripeToken. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this StripeToken. + + + :param id: The id of this StripeToken. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def account_id(self): + """Gets the account_id of this StripeToken. # noqa: E501 + + + :return: The account_id of this StripeToken. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this StripeToken. + + + :param account_id: The account_id of this StripeToken. # noqa: E501 + :type: str + """ + if account_id is None: + raise ValueError("Invalid value for `account_id`, must not be `None`") # noqa: E501 + + self._account_id = account_id + + @property + def card_details_id(self): + """Gets the card_details_id of this StripeToken. # noqa: E501 + + + :return: The card_details_id of this StripeToken. # noqa: E501 + :rtype: str + """ + return self._card_details_id + + @card_details_id.setter + def card_details_id(self, card_details_id): + """Sets the card_details_id of this StripeToken. + + + :param card_details_id: The card_details_id of this StripeToken. # noqa: E501 + :type: str + """ + + self._card_details_id = card_details_id + + @property + def organization_id(self): + """Gets the organization_id of this StripeToken. # noqa: E501 + + + :return: The organization_id of this StripeToken. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this StripeToken. + + + :param organization_id: The organization_id of this StripeToken. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def stripe_customer_id(self): + """Gets the stripe_customer_id of this StripeToken. # noqa: E501 + + + :return: The stripe_customer_id of this StripeToken. # noqa: E501 + :rtype: str + """ + return self._stripe_customer_id + + @stripe_customer_id.setter + def stripe_customer_id(self, stripe_customer_id): + """Sets the stripe_customer_id of this StripeToken. + + + :param stripe_customer_id: The stripe_customer_id of this StripeToken. # noqa: E501 + :type: str + """ + if stripe_customer_id is None: + raise ValueError("Invalid value for `stripe_customer_id`, must not be `None`") # noqa: E501 + + self._stripe_customer_id = stripe_customer_id + + @property + def status(self): + """Gets the status of this StripeToken. # noqa: E501 + + + :return: The status of this StripeToken. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this StripeToken. + + + :param status: The status of this StripeToken. # noqa: E501 + :type: str + """ + if status is None: + raise ValueError("Invalid value for `status`, must not be `None`") # noqa: E501 + allowed_values = ["Awaiting3dsVerification", "Verified", "DoesNotRequireVerification"] # noqa: E501 + if status not in allowed_values: + raise ValueError( + "Invalid value for `status` ({0}), must be one of {1}" # noqa: E501 + .format(status, allowed_values) + ) + + self._status = status + + @property + def deleted(self): + """Gets the deleted of this StripeToken. # noqa: E501 + + + :return: The deleted of this StripeToken. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this StripeToken. + + + :param deleted: The deleted of this StripeToken. # noqa: E501 + :type: bool + """ + if deleted is None: + raise ValueError("Invalid value for `deleted`, must not be `None`") # noqa: E501 + + self._deleted = deleted + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(StripeToken, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, StripeToken): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/stripe_token_paged_metadata.py b/billforward/models/stripe_token_paged_metadata.py deleted file mode 100644 index 70b56c3..0000000 --- a/billforward/models/stripe_token_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class StripeTokenPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - StripeTokenPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this StripeTokenPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this StripeTokenPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this StripeTokenPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this StripeTokenPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this StripeTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this StripeTokenPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this StripeTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this StripeTokenPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this StripeTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this StripeTokenPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this StripeTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this StripeTokenPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this StripeTokenPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this StripeTokenPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this StripeTokenPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this StripeTokenPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this StripeTokenPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this StripeTokenPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this StripeTokenPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this StripeTokenPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this StripeTokenPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this StripeTokenPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this StripeTokenPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this StripeTokenPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this StripeTokenPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this StripeTokenPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this StripeTokenPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this StripeTokenPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/subscription.py b/billforward/models/subscription.py index 77a9d43..b01a999 100644 --- a/billforward/models/subscription.py +++ b/billforward/models/subscription.py @@ -1,190 +1,301 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class Subscription(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, metadata=None, id=None, version_id=None, crm_id=None, account_id=None, organization_id=None, product_id=None, product_rate_plan_id=None, parent_id=None, name=None, description=None, type=None, state=None, current_period_start=None, current_period_end=None, contract_start=None, subscription_end=None, current_period_end_explicit=None, initial_period_start=None, successful_periods=None, total_periods=None, trial_end=None, dunning=False, locked=None, managed_by=None, version_start=None, version_end=None, version_number=None, credit_enabled=False, aggregate_all_subscriptions_on_account=False, pricing_component_values=None, payment_method_subscription_links=None, fixed_terms=None, current_time=None, time_offset=None, payment_terms=None, failed_payment_behaviour=None): - """ - Subscription - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'metadata': 'DynamicMetadata', - 'id': 'str', - 'version_id': 'str', - 'crm_id': 'str', - 'account_id': 'str', - 'organization_id': 'str', - 'product_id': 'str', - 'product_rate_plan_id': 'str', - 'parent_id': 'str', - 'name': 'str', - 'description': 'str', - 'type': 'str', - 'state': 'str', - 'current_period_start': 'datetime', - 'current_period_end': 'datetime', - 'contract_start': 'datetime', - 'subscription_end': 'datetime', - 'current_period_end_explicit': 'datetime', - 'initial_period_start': 'datetime', - 'successful_periods': 'int', - 'total_periods': 'int', - 'trial_end': 'datetime', - 'dunning': 'bool', - 'locked': 'str', - 'managed_by': 'str', - 'version_start': 'datetime', - 'version_end': 'datetime', - 'version_number': 'int', - 'credit_enabled': 'bool', - 'aggregate_all_subscriptions_on_account': 'bool', - 'pricing_component_values': 'list[PricingComponentValue]', - 'payment_method_subscription_links': 'list[PaymentMethodSubscriptionLink]', - 'fixed_terms': 'list[FixedTerm]', - 'current_time': 'datetime', - 'time_offset': 'int', - 'payment_terms': 'int', - 'failed_payment_behaviour': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'metadata': 'metadata', - 'id': 'id', - 'version_id': 'versionID', - 'crm_id': 'crmID', - 'account_id': 'accountID', - 'organization_id': 'organizationID', - 'product_id': 'productID', - 'product_rate_plan_id': 'productRatePlanID', - 'parent_id': 'parentID', - 'name': 'name', - 'description': 'description', - 'type': 'type', - 'state': 'state', - 'current_period_start': 'currentPeriodStart', - 'current_period_end': 'currentPeriodEnd', - 'contract_start': 'contractStart', - 'subscription_end': 'subscriptionEnd', - 'current_period_end_explicit': 'currentPeriodEndExplicit', - 'initial_period_start': 'initialPeriodStart', - 'successful_periods': 'successfulPeriods', - 'total_periods': 'totalPeriods', - 'trial_end': 'trialEnd', - 'dunning': 'dunning', - 'locked': 'locked', - 'managed_by': 'managedBy', - 'version_start': 'versionStart', - 'version_end': 'versionEnd', - 'version_number': 'versionNumber', - 'credit_enabled': 'creditEnabled', - 'aggregate_all_subscriptions_on_account': 'aggregateAllSubscriptionsOnAccount', - 'pricing_component_values': 'pricingComponentValues', - 'payment_method_subscription_links': 'paymentMethodSubscriptionLinks', - 'fixed_terms': 'fixedTerms', - 'current_time': 'currentTime', - 'time_offset': 'timeOffset', - 'payment_terms': 'paymentTerms', - 'failed_payment_behaviour': 'failedPaymentBehaviour' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._metadata = metadata - self._id = id - self._version_id = version_id - self._crm_id = crm_id - self._account_id = account_id - self._organization_id = organization_id - self._product_id = product_id - self._product_rate_plan_id = product_rate_plan_id - self._parent_id = parent_id - self._name = name - self._description = description - self._type = type - self._state = state - self._current_period_start = current_period_start - self._current_period_end = current_period_end - self._contract_start = contract_start - self._subscription_end = subscription_end - self._current_period_end_explicit = current_period_end_explicit - self._initial_period_start = initial_period_start - self._successful_periods = successful_periods - self._total_periods = total_periods - self._trial_end = trial_end - self._dunning = dunning - self._locked = locked - self._managed_by = managed_by - self._version_start = version_start - self._version_end = version_end - self._version_number = version_number - self._credit_enabled = credit_enabled - self._aggregate_all_subscriptions_on_account = aggregate_all_subscriptions_on_account - self._pricing_component_values = pricing_component_values - self._payment_method_subscription_links = payment_method_subscription_links - self._fixed_terms = fixed_terms - self._current_time = current_time - self._time_offset = time_offset - self._payment_terms = payment_terms - self._failed_payment_behaviour = failed_payment_behaviour + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'metadata': 'dict(str, object)', + 'id': 'str', + 'version_id': 'str', + 'crm_id': 'str', + 'account_id': 'str', + 'organization_id': 'str', + 'product_id': 'str', + 'product_rate_plan_id': 'str', + 'parent_id': 'str', + 'name': 'str', + 'description': 'str', + 'type': 'str', + 'version': 'str', + 'state': 'str', + 'active': 'bool', + 'current_period_start': 'datetime', + 'current_period_end': 'datetime', + 'contract_start': 'datetime', + 'subscription_end': 'datetime', + 'current_period_end_explicit': 'datetime', + 'initial_period_start': 'datetime', + 'successful_periods': 'int', + 'total_periods': 'int', + 'total_version_periods': 'int', + 'trial_end': 'datetime', + 'dunning': 'bool', + 'locked': 'str', + 'managed_by': 'str', + 'version_start': 'datetime', + 'version_end': 'datetime', + 'version_number': 'int', + 'credit_enabled': 'bool', + 'aggregate_all_subscriptions_on_account': 'bool', + 'failed_payment_behaviour': 'str', + 'pricing_component_values': 'list[PricingComponentValue]', + 'payment_method_subscription_links': 'list[PaymentMethodSubscriptionLink]', + 'fixed_terms': 'list[FixedTerm]', + 'contracts': 'list[Contract]', + 'square_subscription': 'SquareSubscription', + 'execution_info': 'ExecutionResponse', + 'current_time': 'datetime', + 'time_offset': 'int', + 'revive': 'SubscriptionRevivePartialRequest', + 'payment_terms': 'int', + 'purchase_order': 'str', + 'affiliate_subscription_relationship': 'list[AffiliateSubscriptionRelationship]', + 'fixed_term': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'metadata': 'metadata', + 'id': 'id', + 'version_id': 'versionID', + 'crm_id': 'crmID', + 'account_id': 'accountID', + 'organization_id': 'organizationID', + 'product_id': 'productID', + 'product_rate_plan_id': 'productRatePlanID', + 'parent_id': 'parentID', + 'name': 'name', + 'description': 'description', + 'type': 'type', + 'version': 'version', + 'state': 'state', + 'active': 'active', + 'current_period_start': 'currentPeriodStart', + 'current_period_end': 'currentPeriodEnd', + 'contract_start': 'contractStart', + 'subscription_end': 'subscriptionEnd', + 'current_period_end_explicit': 'currentPeriodEndExplicit', + 'initial_period_start': 'initialPeriodStart', + 'successful_periods': 'successfulPeriods', + 'total_periods': 'totalPeriods', + 'total_version_periods': 'totalVersionPeriods', + 'trial_end': 'trialEnd', + 'dunning': 'dunning', + 'locked': 'locked', + 'managed_by': 'managedBy', + 'version_start': 'versionStart', + 'version_end': 'versionEnd', + 'version_number': 'versionNumber', + 'credit_enabled': 'creditEnabled', + 'aggregate_all_subscriptions_on_account': 'aggregateAllSubscriptionsOnAccount', + 'failed_payment_behaviour': 'failedPaymentBehaviour', + 'pricing_component_values': 'pricingComponentValues', + 'payment_method_subscription_links': 'paymentMethodSubscriptionLinks', + 'fixed_terms': 'fixedTerms', + 'contracts': 'contracts', + 'square_subscription': 'squareSubscription', + 'execution_info': 'executionInfo', + 'current_time': 'currentTime', + 'time_offset': 'timeOffset', + 'revive': 'revive', + 'payment_terms': 'paymentTerms', + 'purchase_order': 'purchaseOrder', + 'affiliate_subscription_relationship': 'affiliateSubscriptionRelationship', + 'fixed_term': 'fixedTerm' + } + + def __init__(self, created=None, changed_by=None, updated=None, metadata=None, id=None, version_id=None, crm_id=None, account_id=None, organization_id=None, product_id=None, product_rate_plan_id=None, parent_id=None, name=None, description=None, type=None, version=None, state=None, active=None, current_period_start=None, current_period_end=None, contract_start=None, subscription_end=None, current_period_end_explicit=None, initial_period_start=None, successful_periods=None, total_periods=None, total_version_periods=None, trial_end=None, dunning=None, locked=None, managed_by=None, version_start=None, version_end=None, version_number=None, credit_enabled=None, aggregate_all_subscriptions_on_account=None, failed_payment_behaviour=None, pricing_component_values=None, payment_method_subscription_links=None, fixed_terms=None, contracts=None, square_subscription=None, execution_info=None, current_time=None, time_offset=None, revive=None, payment_terms=None, purchase_order=None, affiliate_subscription_relationship=None, fixed_term=None): # noqa: E501 + """Subscription - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._metadata = None + self._id = None + self._version_id = None + self._crm_id = None + self._account_id = None + self._organization_id = None + self._product_id = None + self._product_rate_plan_id = None + self._parent_id = None + self._name = None + self._description = None + self._type = None + self._version = None + self._state = None + self._active = None + self._current_period_start = None + self._current_period_end = None + self._contract_start = None + self._subscription_end = None + self._current_period_end_explicit = None + self._initial_period_start = None + self._successful_periods = None + self._total_periods = None + self._total_version_periods = None + self._trial_end = None + self._dunning = None + self._locked = None + self._managed_by = None + self._version_start = None + self._version_end = None + self._version_number = None + self._credit_enabled = None + self._aggregate_all_subscriptions_on_account = None + self._failed_payment_behaviour = None + self._pricing_component_values = None + self._payment_method_subscription_links = None + self._fixed_terms = None + self._contracts = None + self._square_subscription = None + self._execution_info = None + self._current_time = None + self._time_offset = None + self._revive = None + self._payment_terms = None + self._purchase_order = None + self._affiliate_subscription_relationship = None + self._fixed_term = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if metadata is not None: + self.metadata = metadata + self.id = id + if version_id is not None: + self.version_id = version_id + if crm_id is not None: + self.crm_id = crm_id + self.account_id = account_id + self.organization_id = organization_id + if product_id is not None: + self.product_id = product_id + if product_rate_plan_id is not None: + self.product_rate_plan_id = product_rate_plan_id + if parent_id is not None: + self.parent_id = parent_id + self.name = name + if description is not None: + self.description = description + if type is not None: + self.type = type + if version is not None: + self.version = version + self.state = state + if active is not None: + self.active = active + if current_period_start is not None: + self.current_period_start = current_period_start + if current_period_end is not None: + self.current_period_end = current_period_end + if contract_start is not None: + self.contract_start = contract_start + if subscription_end is not None: + self.subscription_end = subscription_end + if current_period_end_explicit is not None: + self.current_period_end_explicit = current_period_end_explicit + if initial_period_start is not None: + self.initial_period_start = initial_period_start + if successful_periods is not None: + self.successful_periods = successful_periods + if total_periods is not None: + self.total_periods = total_periods + if total_version_periods is not None: + self.total_version_periods = total_version_periods + if trial_end is not None: + self.trial_end = trial_end + if dunning is not None: + self.dunning = dunning + if locked is not None: + self.locked = locked + if managed_by is not None: + self.managed_by = managed_by + self.version_start = version_start + if version_end is not None: + self.version_end = version_end + self.version_number = version_number + if credit_enabled is not None: + self.credit_enabled = credit_enabled + if aggregate_all_subscriptions_on_account is not None: + self.aggregate_all_subscriptions_on_account = aggregate_all_subscriptions_on_account + if failed_payment_behaviour is not None: + self.failed_payment_behaviour = failed_payment_behaviour + if pricing_component_values is not None: + self.pricing_component_values = pricing_component_values + if payment_method_subscription_links is not None: + self.payment_method_subscription_links = payment_method_subscription_links + if fixed_terms is not None: + self.fixed_terms = fixed_terms + if contracts is not None: + self.contracts = contracts + if square_subscription is not None: + self.square_subscription = square_subscription + if execution_info is not None: + self.execution_info = execution_info + if current_time is not None: + self.current_time = current_time + if time_offset is not None: + self.time_offset = time_offset + if revive is not None: + self.revive = revive + if payment_terms is not None: + self.payment_terms = payment_terms + if purchase_order is not None: + self.purchase_order = purchase_order + if affiliate_subscription_relationship is not None: + self.affiliate_subscription_relationship = affiliate_subscription_relationship + if fixed_term is not None: + self.fixed_term = fixed_term @property def created(self): - """ - Gets the created of this Subscription. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this Subscription. # noqa: E501 - :return: The created of this Subscription. + + :return: The created of this Subscription. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this Subscription. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this Subscription. + - :param created: The created of this Subscription. + :param created: The created of this Subscription. # noqa: E501 :type: datetime """ @@ -192,22 +303,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this Subscription. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this Subscription. # noqa: E501 + - :return: The changed_by of this Subscription. + :return: The changed_by of this Subscription. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this Subscription. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this Subscription. + - :param changed_by: The changed_by of this Subscription. + :param changed_by: The changed_by of this Subscription. # noqa: E501 :type: str """ @@ -215,22 +324,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this Subscription. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this Subscription. # noqa: E501 - :return: The updated of this Subscription. + + :return: The updated of this Subscription. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this Subscription. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this Subscription. + - :param updated: The updated of this Subscription. + :param updated: The updated of this Subscription. # noqa: E501 :type: datetime """ @@ -238,68 +345,64 @@ def updated(self, updated): @property def metadata(self): - """ - Gets the metadata of this Subscription. - { \"description\" : \"Add metadata.\", \"verbs\":[\"POST\"] } + """Gets the metadata of this Subscription. # noqa: E501 + - :return: The metadata of this Subscription. - :rtype: DynamicMetadata + :return: The metadata of this Subscription. # noqa: E501 + :rtype: dict(str, object) """ return self._metadata @metadata.setter def metadata(self, metadata): - """ - Sets the metadata of this Subscription. - { \"description\" : \"Add metadata.\", \"verbs\":[\"POST\"] } + """Sets the metadata of this Subscription. - :param metadata: The metadata of this Subscription. - :type: DynamicMetadata + + :param metadata: The metadata of this Subscription. # noqa: E501 + :type: dict(str, object) """ self._metadata = metadata @property def id(self): - """ - Gets the id of this Subscription. - {\"description\":\"\",\"verbs\":[\"GET\"]} + """Gets the id of this Subscription. # noqa: E501 - :return: The id of this Subscription. + + :return: The id of this Subscription. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this Subscription. - {\"description\":\"\",\"verbs\":[\"GET\"]} + """Sets the id of this Subscription. + - :param id: The id of this Subscription. + :param id: The id of this Subscription. # noqa: E501 :type: str """ + if id is None: + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 self._id = id @property def version_id(self): - """ - Gets the version_id of this Subscription. - {\"description\":\"\",\"verbs\":[\"GET\"]} + """Gets the version_id of this Subscription. # noqa: E501 + - :return: The version_id of this Subscription. + :return: The version_id of this Subscription. # noqa: E501 :rtype: str """ return self._version_id @version_id.setter def version_id(self, version_id): - """ - Sets the version_id of this Subscription. - {\"description\":\"\",\"verbs\":[\"GET\"]} + """Sets the version_id of this Subscription. - :param version_id: The version_id of this Subscription. + + :param version_id: The version_id of this Subscription. # noqa: E501 :type: str """ @@ -307,22 +410,20 @@ def version_id(self, version_id): @property def crm_id(self): - """ - Gets the crm_id of this Subscription. - {\"description\":\"\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the crm_id of this Subscription. # noqa: E501 + - :return: The crm_id of this Subscription. + :return: The crm_id of this Subscription. # noqa: E501 :rtype: str """ return self._crm_id @crm_id.setter def crm_id(self, crm_id): - """ - Sets the crm_id of this Subscription. - {\"description\":\"\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the crm_id of this Subscription. + - :param crm_id: The crm_id of this Subscription. + :param crm_id: The crm_id of this Subscription. # noqa: E501 :type: str """ @@ -330,68 +431,66 @@ def crm_id(self, crm_id): @property def account_id(self): - """ - Gets the account_id of this Subscription. - {\"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the account_id of this Subscription. # noqa: E501 + - :return: The account_id of this Subscription. + :return: The account_id of this Subscription. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this Subscription. - {\"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the account_id of this Subscription. - :param account_id: The account_id of this Subscription. + + :param account_id: The account_id of this Subscription. # noqa: E501 :type: str """ + if account_id is None: + raise ValueError("Invalid value for `account_id`, must not be `None`") # noqa: E501 self._account_id = account_id @property def organization_id(self): - """ - Gets the organization_id of this Subscription. - {\"description\":\"Organization associated with the subscription.\",\"verbs\":[]} + """Gets the organization_id of this Subscription. # noqa: E501 - :return: The organization_id of this Subscription. + + :return: The organization_id of this Subscription. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this Subscription. - {\"description\":\"Organization associated with the subscription.\",\"verbs\":[]} + """Sets the organization_id of this Subscription. + - :param organization_id: The organization_id of this Subscription. + :param organization_id: The organization_id of this Subscription. # noqa: E501 :type: str """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 self._organization_id = organization_id @property def product_id(self): - """ - Gets the product_id of this Subscription. - {\"description\":\"\",\"verbs\":[\"GET\"]} + """Gets the product_id of this Subscription. # noqa: E501 + - :return: The product_id of this Subscription. + :return: The product_id of this Subscription. # noqa: E501 :rtype: str """ return self._product_id @product_id.setter def product_id(self, product_id): - """ - Sets the product_id of this Subscription. - {\"description\":\"\",\"verbs\":[\"GET\"]} + """Sets the product_id of this Subscription. + - :param product_id: The product_id of this Subscription. + :param product_id: The product_id of this Subscription. # noqa: E501 :type: str """ @@ -399,22 +498,20 @@ def product_id(self, product_id): @property def product_rate_plan_id(self): - """ - Gets the product_rate_plan_id of this Subscription. - {\"description\":\"Identifier of the rate-plan being billed for.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the product_rate_plan_id of this Subscription. # noqa: E501 - :return: The product_rate_plan_id of this Subscription. + + :return: The product_rate_plan_id of this Subscription. # noqa: E501 :rtype: str """ return self._product_rate_plan_id @product_rate_plan_id.setter def product_rate_plan_id(self, product_rate_plan_id): - """ - Sets the product_rate_plan_id of this Subscription. - {\"description\":\"Identifier of the rate-plan being billed for.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the product_rate_plan_id of this Subscription. + - :param product_rate_plan_id: The product_rate_plan_id of this Subscription. + :param product_rate_plan_id: The product_rate_plan_id of this Subscription. # noqa: E501 :type: str """ @@ -422,22 +519,20 @@ def product_rate_plan_id(self, product_rate_plan_id): @property def parent_id(self): - """ - Gets the parent_id of this Subscription. - {\"description\":\"\",\"verbs\":[\"GET\"]} + """Gets the parent_id of this Subscription. # noqa: E501 + - :return: The parent_id of this Subscription. + :return: The parent_id of this Subscription. # noqa: E501 :rtype: str """ return self._parent_id @parent_id.setter def parent_id(self, parent_id): - """ - Sets the parent_id of this Subscription. - {\"description\":\"\",\"verbs\":[\"GET\"]} + """Sets the parent_id of this Subscription. - :param parent_id: The parent_id of this Subscription. + + :param parent_id: The parent_id of this Subscription. # noqa: E501 :type: str """ @@ -445,45 +540,43 @@ def parent_id(self, parent_id): @property def name(self): - """ - Gets the name of this Subscription. - {\"description\":\"User definable friendly name for the subscription.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the name of this Subscription. # noqa: E501 - :return: The name of this Subscription. + + :return: The name of this Subscription. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this Subscription. - {\"description\":\"User definable friendly name for the subscription.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the name of this Subscription. + - :param name: The name of this Subscription. + :param name: The name of this Subscription. # noqa: E501 :type: str """ + if name is None: + raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501 self._name = name @property def description(self): - """ - Gets the description of this Subscription. - {\"description\":\"\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the description of this Subscription. # noqa: E501 + - :return: The description of this Subscription. + :return: The description of this Subscription. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this Subscription. - {\"description\":\"\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the description of this Subscription. - :param description: The description of this Subscription. + + :param description: The description of this Subscription. # noqa: E501 :type: str """ @@ -491,80 +584,124 @@ def description(self, description): @property def type(self): - """ - Gets the type of this Subscription. - {\"default\":\"dependent on product\", \"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the type of this Subscription. # noqa: E501 + - :return: The type of this Subscription. + :return: The type of this Subscription. # noqa: E501 :rtype: str """ return self._type @type.setter def type(self, type): - """ - Sets the type of this Subscription. - {\"default\":\"dependent on product\", \"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the type of this Subscription. + - :param type: The type of this Subscription. + :param type: The type of this Subscription. # noqa: E501 :type: str """ - allowed_values = ["Subscription", "FixedTerm", "Trial"] + allowed_values = ["Subscription", "Trial", "FixedTerm"] # noqa: E501 if type not in allowed_values: raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 .format(type, allowed_values) ) self._type = type @property - def state(self): + def version(self): + """Gets the version of this Subscription. # noqa: E501 + + + :return: The version of this Subscription. # noqa: E501 + :rtype: str """ - Gets the state of this Subscription. - {\"PUT_description\":\"A Provisioned subscription can be updated to either Trial or AwaitingPayment, this will start the subscription. Any updates to the state of a non-Provisioned will be ignored. To cancel or otherwise amend a subscription please use the explict amendment calls.\", \"description\":\"A Provisioned subscription will not begin until marked as Trial or AwaitingPayment. Trial subscriptions transition to AwaitingPayment when the trial period is over. On subscription renewal the state becomes AwaitingPayment. Once outstanding invoices are paid the state changes to Paid. A subscription is set as either Failed or left as AwaitingPayment, depending on the rate-plan configuration. If a subscription is non-recurring or fixed-term and ends naturally, it will be marked as Expired. If all payment attempts have failed a subscription is marked as Cancelled if it has been manually ended. Once a subscription is marked as Failed, Expired, or Cancelled no invoices other than a final invoice will be issued. Note: Updating account card details will not lead to BillForward automatically retrying payment, manual payment attempts can be made.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + return self._version + + @version.setter + def version(self, version): + """Sets the version of this Subscription. + + + :param version: The version of this Subscription. # noqa: E501 + :type: str + """ + allowed_values = ["V1", "V2"] # noqa: E501 + if version not in allowed_values: + raise ValueError( + "Invalid value for `version` ({0}), must be one of {1}" # noqa: E501 + .format(version, allowed_values) + ) - :return: The state of this Subscription. + self._version = version + + @property + def state(self): + """Gets the state of this Subscription. # noqa: E501 + + + :return: The state of this Subscription. # noqa: E501 :rtype: str """ return self._state @state.setter def state(self, state): - """ - Sets the state of this Subscription. - {\"PUT_description\":\"A Provisioned subscription can be updated to either Trial or AwaitingPayment, this will start the subscription. Any updates to the state of a non-Provisioned will be ignored. To cancel or otherwise amend a subscription please use the explict amendment calls.\", \"description\":\"A Provisioned subscription will not begin until marked as Trial or AwaitingPayment. Trial subscriptions transition to AwaitingPayment when the trial period is over. On subscription renewal the state becomes AwaitingPayment. Once outstanding invoices are paid the state changes to Paid. A subscription is set as either Failed or left as AwaitingPayment, depending on the rate-plan configuration. If a subscription is non-recurring or fixed-term and ends naturally, it will be marked as Expired. If all payment attempts have failed a subscription is marked as Cancelled if it has been manually ended. Once a subscription is marked as Failed, Expired, or Cancelled no invoices other than a final invoice will be issued. Note: Updating account card details will not lead to BillForward automatically retrying payment, manual payment attempts can be made.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the state of this Subscription. + - :param state: The state of this Subscription. + :param state: The state of this Subscription. # noqa: E501 :type: str """ - allowed_values = ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"] + if state is None: + raise ValueError("Invalid value for `state`, must not be `None`") # noqa: E501 + allowed_values = ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"] # noqa: E501 if state not in allowed_values: raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 .format(state, allowed_values) ) self._state = state @property - def current_period_start(self): + def active(self): + """Gets the active of this Subscription. # noqa: E501 + + + :return: The active of this Subscription. # noqa: E501 + :rtype: bool + """ + return self._active + + @active.setter + def active(self, active): + """Sets the active of this Subscription. + + + :param active: The active of this Subscription. # noqa: E501 + :type: bool """ - Gets the current_period_start of this Subscription. - {\"description\":\"Start of the current invoice period. At the end of this period, a new new invoice will be generated\",\"verbs\":[\"POST\",\"GET\"]} - :return: The current_period_start of this Subscription. + self._active = active + + @property + def current_period_start(self): + """Gets the current_period_start of this Subscription. # noqa: E501 + + + :return: The current_period_start of this Subscription. # noqa: E501 :rtype: datetime """ return self._current_period_start @current_period_start.setter def current_period_start(self, current_period_start): - """ - Sets the current_period_start of this Subscription. - {\"description\":\"Start of the current invoice period. At the end of this period, a new new invoice will be generated\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the current_period_start of this Subscription. + - :param current_period_start: The current_period_start of this Subscription. + :param current_period_start: The current_period_start of this Subscription. # noqa: E501 :type: datetime """ @@ -572,22 +709,20 @@ def current_period_start(self, current_period_start): @property def current_period_end(self): - """ - Gets the current_period_end of this Subscription. - {\"description\":\"End of the current period invoiced for. This can be manually updated to extend trials or delay invoice generation.\",\"verbs\":[\"PUT\",\"GET\"]} + """Gets the current_period_end of this Subscription. # noqa: E501 - :return: The current_period_end of this Subscription. + + :return: The current_period_end of this Subscription. # noqa: E501 :rtype: datetime """ return self._current_period_end @current_period_end.setter def current_period_end(self, current_period_end): - """ - Sets the current_period_end of this Subscription. - {\"description\":\"End of the current period invoiced for. This can be manually updated to extend trials or delay invoice generation.\",\"verbs\":[\"PUT\",\"GET\"]} + """Sets the current_period_end of this Subscription. + - :param current_period_end: The current_period_end of this Subscription. + :param current_period_end: The current_period_end of this Subscription. # noqa: E501 :type: datetime """ @@ -595,22 +730,20 @@ def current_period_end(self, current_period_end): @property def contract_start(self): - """ - Gets the contract_start of this Subscription. - {\"description\":\"start of the contracted period. This will be after a trial, if one exists\",\"verbs\":[\"GET\"]} + """Gets the contract_start of this Subscription. # noqa: E501 + - :return: The contract_start of this Subscription. + :return: The contract_start of this Subscription. # noqa: E501 :rtype: datetime """ return self._contract_start @contract_start.setter def contract_start(self, contract_start): - """ - Sets the contract_start of this Subscription. - {\"description\":\"start of the contracted period. This will be after a trial, if one exists\",\"verbs\":[\"GET\"]} + """Sets the contract_start of this Subscription. - :param contract_start: The contract_start of this Subscription. + + :param contract_start: The contract_start of this Subscription. # noqa: E501 :type: datetime """ @@ -618,22 +751,20 @@ def contract_start(self, contract_start): @property def subscription_end(self): - """ - Gets the subscription_end of this Subscription. - {\"description\":\"When a subscription will end. This may be in the future if the cancellation is at the end of the current period.\",\"verbs\":[\"GET\"]} + """Gets the subscription_end of this Subscription. # noqa: E501 - :return: The subscription_end of this Subscription. + + :return: The subscription_end of this Subscription. # noqa: E501 :rtype: datetime """ return self._subscription_end @subscription_end.setter def subscription_end(self, subscription_end): - """ - Sets the subscription_end of this Subscription. - {\"description\":\"When a subscription will end. This may be in the future if the cancellation is at the end of the current period.\",\"verbs\":[\"GET\"]} + """Sets the subscription_end of this Subscription. + - :param subscription_end: The subscription_end of this Subscription. + :param subscription_end: The subscription_end of this Subscription. # noqa: E501 :type: datetime """ @@ -641,22 +772,20 @@ def subscription_end(self, subscription_end): @property def current_period_end_explicit(self): - """ - Gets the current_period_end_explicit of this Subscription. - {\"description\":\"Override for the initial subscription period. Allows periods to align to a date or time regardless of purchase date/time.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the current_period_end_explicit of this Subscription. # noqa: E501 + - :return: The current_period_end_explicit of this Subscription. + :return: The current_period_end_explicit of this Subscription. # noqa: E501 :rtype: datetime """ return self._current_period_end_explicit @current_period_end_explicit.setter def current_period_end_explicit(self, current_period_end_explicit): - """ - Sets the current_period_end_explicit of this Subscription. - {\"description\":\"Override for the initial subscription period. Allows periods to align to a date or time regardless of purchase date/time.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the current_period_end_explicit of this Subscription. - :param current_period_end_explicit: The current_period_end_explicit of this Subscription. + + :param current_period_end_explicit: The current_period_end_explicit of this Subscription. # noqa: E501 :type: datetime """ @@ -664,22 +793,20 @@ def current_period_end_explicit(self, current_period_end_explicit): @property def initial_period_start(self): - """ - Gets the initial_period_start of this Subscription. - {\"description\":\"Start of the first successful period\",\"verbs\":[\"GET\"]} + """Gets the initial_period_start of this Subscription. # noqa: E501 + - :return: The initial_period_start of this Subscription. + :return: The initial_period_start of this Subscription. # noqa: E501 :rtype: datetime """ return self._initial_period_start @initial_period_start.setter def initial_period_start(self, initial_period_start): - """ - Sets the initial_period_start of this Subscription. - {\"description\":\"Start of the first successful period\",\"verbs\":[\"GET\"]} + """Sets the initial_period_start of this Subscription. + - :param initial_period_start: The initial_period_start of this Subscription. + :param initial_period_start: The initial_period_start of this Subscription. # noqa: E501 :type: datetime """ @@ -687,22 +814,20 @@ def initial_period_start(self, initial_period_start): @property def successful_periods(self): - """ - Gets the successful_periods of this Subscription. - {\"description\":\"Number of paid-for periods billing, excluding trials, since the subscription started.\",\"verbs\":[\"GET\"]} + """Gets the successful_periods of this Subscription. # noqa: E501 + - :return: The successful_periods of this Subscription. + :return: The successful_periods of this Subscription. # noqa: E501 :rtype: int """ return self._successful_periods @successful_periods.setter def successful_periods(self, successful_periods): - """ - Sets the successful_periods of this Subscription. - {\"description\":\"Number of paid-for periods billing, excluding trials, since the subscription started.\",\"verbs\":[\"GET\"]} + """Sets the successful_periods of this Subscription. - :param successful_periods: The successful_periods of this Subscription. + + :param successful_periods: The successful_periods of this Subscription. # noqa: E501 :type: int """ @@ -710,45 +835,62 @@ def successful_periods(self, successful_periods): @property def total_periods(self): - """ - Gets the total_periods of this Subscription. - {\"description\":\"Total number of subscription periods.\",\"verbs\":[\"GET\"]} + """Gets the total_periods of this Subscription. # noqa: E501 - :return: The total_periods of this Subscription. + + :return: The total_periods of this Subscription. # noqa: E501 :rtype: int """ return self._total_periods @total_periods.setter def total_periods(self, total_periods): - """ - Sets the total_periods of this Subscription. - {\"description\":\"Total number of subscription periods.\",\"verbs\":[\"GET\"]} + """Sets the total_periods of this Subscription. + - :param total_periods: The total_periods of this Subscription. + :param total_periods: The total_periods of this Subscription. # noqa: E501 :type: int """ self._total_periods = total_periods @property - def trial_end(self): + def total_version_periods(self): + """Gets the total_version_periods of this Subscription. # noqa: E501 + + + :return: The total_version_periods of this Subscription. # noqa: E501 + :rtype: int """ - Gets the trial_end of this Subscription. - {\"description\":\"The end time of the trial period, if one existed\",\"verbs\":[\"GET\"]} + return self._total_version_periods + + @total_version_periods.setter + def total_version_periods(self, total_version_periods): + """Sets the total_version_periods of this Subscription. + + + :param total_version_periods: The total_version_periods of this Subscription. # noqa: E501 + :type: int + """ + + self._total_version_periods = total_version_periods + + @property + def trial_end(self): + """Gets the trial_end of this Subscription. # noqa: E501 - :return: The trial_end of this Subscription. + + :return: The trial_end of this Subscription. # noqa: E501 :rtype: datetime """ return self._trial_end @trial_end.setter def trial_end(self, trial_end): - """ - Sets the trial_end of this Subscription. - {\"description\":\"The end time of the trial period, if one existed\",\"verbs\":[\"GET\"]} + """Sets the trial_end of this Subscription. + - :param trial_end: The trial_end of this Subscription. + :param trial_end: The trial_end of this Subscription. # noqa: E501 :type: datetime """ @@ -756,22 +898,20 @@ def trial_end(self, trial_end): @property def dunning(self): - """ - Gets the dunning of this Subscription. - { \"default\":\"false\", \"description\":\"Are there outstanding invoices which are currently in dunning.\",\"verbs\":[\"GET\", \"PUT\", \"POST\"]} + """Gets the dunning of this Subscription. # noqa: E501 + - :return: The dunning of this Subscription. + :return: The dunning of this Subscription. # noqa: E501 :rtype: bool """ return self._dunning @dunning.setter def dunning(self, dunning): - """ - Sets the dunning of this Subscription. - { \"default\":\"false\", \"description\":\"Are there outstanding invoices which are currently in dunning.\",\"verbs\":[\"GET\", \"PUT\", \"POST\"]} + """Sets the dunning of this Subscription. - :param dunning: The dunning of this Subscription. + + :param dunning: The dunning of this Subscription. # noqa: E501 :type: bool """ @@ -779,22 +919,20 @@ def dunning(self, dunning): @property def locked(self): - """ - Gets the locked of this Subscription. - {\"description\":\"If the subscription is locked, it will not be processed by the system\",\"verbs\":[]} + """Gets the locked of this Subscription. # noqa: E501 + - :return: The locked of this Subscription. + :return: The locked of this Subscription. # noqa: E501 :rtype: str """ return self._locked @locked.setter def locked(self, locked): - """ - Sets the locked of this Subscription. - {\"description\":\"If the subscription is locked, it will not be processed by the system\",\"verbs\":[]} + """Sets the locked of this Subscription. + - :param locked: The locked of this Subscription. + :param locked: The locked of this Subscription. # noqa: E501 :type: str """ @@ -802,28 +940,26 @@ def locked(self, locked): @property def managed_by(self): - """ - Gets the managed_by of this Subscription. - {\"description\":\"Which system is responsible for managing the subscription.\",\"verbs\":[]} + """Gets the managed_by of this Subscription. # noqa: E501 + - :return: The managed_by of this Subscription. + :return: The managed_by of this Subscription. # noqa: E501 :rtype: str """ return self._managed_by @managed_by.setter def managed_by(self, managed_by): - """ - Sets the managed_by of this Subscription. - {\"description\":\"Which system is responsible for managing the subscription.\",\"verbs\":[]} + """Sets the managed_by of this Subscription. - :param managed_by: The managed_by of this Subscription. + + :param managed_by: The managed_by of this Subscription. # noqa: E501 :type: str """ - allowed_values = ["BillForward", "Stripe"] + allowed_values = ["BillForward", "Stripe"] # noqa: E501 if managed_by not in allowed_values: raise ValueError( - "Invalid value for `managed_by` ({0}), must be one of {1}" + "Invalid value for `managed_by` ({0}), must be one of {1}" # noqa: E501 .format(managed_by, allowed_values) ) @@ -831,45 +967,43 @@ def managed_by(self, managed_by): @property def version_start(self): - """ - Gets the version_start of this Subscription. - {\"description\":\"When the current version of the subscription started.\",\"verbs\":[\"GET\"]} + """Gets the version_start of this Subscription. # noqa: E501 + - :return: The version_start of this Subscription. + :return: The version_start of this Subscription. # noqa: E501 :rtype: datetime """ return self._version_start @version_start.setter def version_start(self, version_start): - """ - Sets the version_start of this Subscription. - {\"description\":\"When the current version of the subscription started.\",\"verbs\":[\"GET\"]} + """Sets the version_start of this Subscription. + - :param version_start: The version_start of this Subscription. + :param version_start: The version_start of this Subscription. # noqa: E501 :type: datetime """ + if version_start is None: + raise ValueError("Invalid value for `version_start`, must not be `None`") # noqa: E501 self._version_start = version_start @property def version_end(self): - """ - Gets the version_end of this Subscription. - {\"description\":\"When the current version of the subscription ended, null indicates current version.\",\"verbs\":[\"GET\"]} + """Gets the version_end of this Subscription. # noqa: E501 - :return: The version_end of this Subscription. + + :return: The version_end of this Subscription. # noqa: E501 :rtype: datetime """ return self._version_end @version_end.setter def version_end(self, version_end): - """ - Sets the version_end of this Subscription. - {\"description\":\"When the current version of the subscription ended, null indicates current version.\",\"verbs\":[\"GET\"]} + """Sets the version_end of this Subscription. - :param version_end: The version_end of this Subscription. + + :param version_end: The version_end of this Subscription. # noqa: E501 :type: datetime """ @@ -877,45 +1011,43 @@ def version_end(self, version_end): @property def version_number(self): - """ - Gets the version_number of this Subscription. - {\"description\":\"Incremental version number of the subscription, starts at 1.\",\"verbs\":[\"GET\"]} + """Gets the version_number of this Subscription. # noqa: E501 + - :return: The version_number of this Subscription. + :return: The version_number of this Subscription. # noqa: E501 :rtype: int """ return self._version_number @version_number.setter def version_number(self, version_number): - """ - Sets the version_number of this Subscription. - {\"description\":\"Incremental version number of the subscription, starts at 1.\",\"verbs\":[\"GET\"]} + """Sets the version_number of this Subscription. + - :param version_number: The version_number of this Subscription. + :param version_number: The version_number of this Subscription. # noqa: E501 :type: int """ + if version_number is None: + raise ValueError("Invalid value for `version_number`, must not be `None`") # noqa: E501 self._version_number = version_number @property def credit_enabled(self): - """ - Gets the credit_enabled of this Subscription. - { \"default\":\"true\", \"description\":\"Can credit-notes be used to pay outstanding invoices for this subscription.\",\"verbs\":[\"GET\", \"PUT\", \"POST\"]} + """Gets the credit_enabled of this Subscription. # noqa: E501 + - :return: The credit_enabled of this Subscription. + :return: The credit_enabled of this Subscription. # noqa: E501 :rtype: bool """ return self._credit_enabled @credit_enabled.setter def credit_enabled(self, credit_enabled): - """ - Sets the credit_enabled of this Subscription. - { \"default\":\"true\", \"description\":\"Can credit-notes be used to pay outstanding invoices for this subscription.\",\"verbs\":[\"GET\", \"PUT\", \"POST\"]} + """Sets the credit_enabled of this Subscription. - :param credit_enabled: The credit_enabled of this Subscription. + + :param credit_enabled: The credit_enabled of this Subscription. # noqa: E501 :type: bool """ @@ -923,45 +1055,68 @@ def credit_enabled(self, credit_enabled): @property def aggregate_all_subscriptions_on_account(self): - """ - Gets the aggregate_all_subscriptions_on_account of this Subscription. - { \"default\":\"true\", \"description\":\"Whether the subscription will aggregate all other subscriptions on the account.\",\"verbs\":[\"GET\", \"PUT\", \"POST\"]} + """Gets the aggregate_all_subscriptions_on_account of this Subscription. # noqa: E501 - :return: The aggregate_all_subscriptions_on_account of this Subscription. + + :return: The aggregate_all_subscriptions_on_account of this Subscription. # noqa: E501 :rtype: bool """ return self._aggregate_all_subscriptions_on_account @aggregate_all_subscriptions_on_account.setter def aggregate_all_subscriptions_on_account(self, aggregate_all_subscriptions_on_account): - """ - Sets the aggregate_all_subscriptions_on_account of this Subscription. - { \"default\":\"true\", \"description\":\"Whether the subscription will aggregate all other subscriptions on the account.\",\"verbs\":[\"GET\", \"PUT\", \"POST\"]} + """Sets the aggregate_all_subscriptions_on_account of this Subscription. + - :param aggregate_all_subscriptions_on_account: The aggregate_all_subscriptions_on_account of this Subscription. + :param aggregate_all_subscriptions_on_account: The aggregate_all_subscriptions_on_account of this Subscription. # noqa: E501 :type: bool """ self._aggregate_all_subscriptions_on_account = aggregate_all_subscriptions_on_account @property - def pricing_component_values(self): + def failed_payment_behaviour(self): + """Gets the failed_payment_behaviour of this Subscription. # noqa: E501 + + + :return: The failed_payment_behaviour of this Subscription. # noqa: E501 + :rtype: str + """ + return self._failed_payment_behaviour + + @failed_payment_behaviour.setter + def failed_payment_behaviour(self, failed_payment_behaviour): + """Sets the failed_payment_behaviour of this Subscription. + + + :param failed_payment_behaviour: The failed_payment_behaviour of this Subscription. # noqa: E501 + :type: str """ - Gets the pricing_component_values of this Subscription. - {\"description\":\"The quantities for each pricing component of the rate-plan. Values should be set for all pricing components of the rate-plan apart from the usage components. Usage components should be added when the usage is known, this is often after the end of the current billing cycle.\",\"verbs\":[\"GET\", \"POST\"]} + allowed_values = ["CancelSubscription", "None"] # noqa: E501 + if failed_payment_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `failed_payment_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(failed_payment_behaviour, allowed_values) + ) + + self._failed_payment_behaviour = failed_payment_behaviour - :return: The pricing_component_values of this Subscription. + @property + def pricing_component_values(self): + """Gets the pricing_component_values of this Subscription. # noqa: E501 + + + :return: The pricing_component_values of this Subscription. # noqa: E501 :rtype: list[PricingComponentValue] """ return self._pricing_component_values @pricing_component_values.setter def pricing_component_values(self, pricing_component_values): - """ - Sets the pricing_component_values of this Subscription. - {\"description\":\"The quantities for each pricing component of the rate-plan. Values should be set for all pricing components of the rate-plan apart from the usage components. Usage components should be added when the usage is known, this is often after the end of the current billing cycle.\",\"verbs\":[\"GET\", \"POST\"]} + """Sets the pricing_component_values of this Subscription. + - :param pricing_component_values: The pricing_component_values of this Subscription. + :param pricing_component_values: The pricing_component_values of this Subscription. # noqa: E501 :type: list[PricingComponentValue] """ @@ -969,22 +1124,20 @@ def pricing_component_values(self, pricing_component_values): @property def payment_method_subscription_links(self): - """ - Gets the payment_method_subscription_links of this Subscription. + """Gets the payment_method_subscription_links of this Subscription. # noqa: E501 - :return: The payment_method_subscription_links of this Subscription. + :return: The payment_method_subscription_links of this Subscription. # noqa: E501 :rtype: list[PaymentMethodSubscriptionLink] """ return self._payment_method_subscription_links @payment_method_subscription_links.setter def payment_method_subscription_links(self, payment_method_subscription_links): - """ - Sets the payment_method_subscription_links of this Subscription. + """Sets the payment_method_subscription_links of this Subscription. - :param payment_method_subscription_links: The payment_method_subscription_links of this Subscription. + :param payment_method_subscription_links: The payment_method_subscription_links of this Subscription. # noqa: E501 :type: list[PaymentMethodSubscriptionLink] """ @@ -992,45 +1145,104 @@ def payment_method_subscription_links(self, payment_method_subscription_links): @property def fixed_terms(self): - """ - Gets the fixed_terms of this Subscription. - {\"description\":\"List of fixed terms that have been or are applied to the subscription\",\"verbs\":[\"GET\"]} + """Gets the fixed_terms of this Subscription. # noqa: E501 - :return: The fixed_terms of this Subscription. + + :return: The fixed_terms of this Subscription. # noqa: E501 :rtype: list[FixedTerm] """ return self._fixed_terms @fixed_terms.setter def fixed_terms(self, fixed_terms): - """ - Sets the fixed_terms of this Subscription. - {\"description\":\"List of fixed terms that have been or are applied to the subscription\",\"verbs\":[\"GET\"]} + """Sets the fixed_terms of this Subscription. - :param fixed_terms: The fixed_terms of this Subscription. + + :param fixed_terms: The fixed_terms of this Subscription. # noqa: E501 :type: list[FixedTerm] """ self._fixed_terms = fixed_terms @property - def current_time(self): + def contracts(self): + """Gets the contracts of this Subscription. # noqa: E501 + + + :return: The contracts of this Subscription. # noqa: E501 + :rtype: list[Contract] + """ + return self._contracts + + @contracts.setter + def contracts(self, contracts): + """Sets the contracts of this Subscription. + + + :param contracts: The contracts of this Subscription. # noqa: E501 + :type: list[Contract] """ - Gets the current_time of this Subscription. - {\"description\":\"The current time — from the point of view of the subscription.\",\"verbs\":[\"GET\"]} - :return: The current_time of this Subscription. + self._contracts = contracts + + @property + def square_subscription(self): + """Gets the square_subscription of this Subscription. # noqa: E501 + + + :return: The square_subscription of this Subscription. # noqa: E501 + :rtype: SquareSubscription + """ + return self._square_subscription + + @square_subscription.setter + def square_subscription(self, square_subscription): + """Sets the square_subscription of this Subscription. + + + :param square_subscription: The square_subscription of this Subscription. # noqa: E501 + :type: SquareSubscription + """ + + self._square_subscription = square_subscription + + @property + def execution_info(self): + """Gets the execution_info of this Subscription. # noqa: E501 + + + :return: The execution_info of this Subscription. # noqa: E501 + :rtype: ExecutionResponse + """ + return self._execution_info + + @execution_info.setter + def execution_info(self, execution_info): + """Sets the execution_info of this Subscription. + + + :param execution_info: The execution_info of this Subscription. # noqa: E501 + :type: ExecutionResponse + """ + + self._execution_info = execution_info + + @property + def current_time(self): + """Gets the current_time of this Subscription. # noqa: E501 + + + :return: The current_time of this Subscription. # noqa: E501 :rtype: datetime """ return self._current_time @current_time.setter def current_time(self, current_time): - """ - Sets the current_time of this Subscription. - {\"description\":\"The current time — from the point of view of the subscription.\",\"verbs\":[\"GET\"]} + """Sets the current_time of this Subscription. + - :param current_time: The current_time of this Subscription. + :param current_time: The current_time of this Subscription. # noqa: E501 :type: datetime """ @@ -1038,86 +1250,135 @@ def current_time(self, current_time): @property def time_offset(self): - """ - Gets the time_offset of this Subscription. - {\"description\":\"How far in the future is the entity (in seconds) compared to the BillForward server's time.\",\"verbs\":[\"GET\"]} + """Gets the time_offset of this Subscription. # noqa: E501 + - :return: The time_offset of this Subscription. + :return: The time_offset of this Subscription. # noqa: E501 :rtype: int """ return self._time_offset @time_offset.setter def time_offset(self, time_offset): - """ - Sets the time_offset of this Subscription. - {\"description\":\"How far in the future is the entity (in seconds) compared to the BillForward server's time.\",\"verbs\":[\"GET\"]} + """Sets the time_offset of this Subscription. - :param time_offset: The time_offset of this Subscription. + + :param time_offset: The time_offset of this Subscription. # noqa: E501 :type: int """ self._time_offset = time_offset @property - def payment_terms(self): + def revive(self): + """Gets the revive of this Subscription. # noqa: E501 + + + :return: The revive of this Subscription. # noqa: E501 + :rtype: SubscriptionRevivePartialRequest """ - Gets the payment_terms of this Subscription. + return self._revive + + @revive.setter + def revive(self, revive): + """Sets the revive of this Subscription. - :return: The payment_terms of this Subscription. + :param revive: The revive of this Subscription. # noqa: E501 + :type: SubscriptionRevivePartialRequest + """ + + self._revive = revive + + @property + def payment_terms(self): + """Gets the payment_terms of this Subscription. # noqa: E501 + + + :return: The payment_terms of this Subscription. # noqa: E501 :rtype: int """ return self._payment_terms @payment_terms.setter def payment_terms(self, payment_terms): - """ - Sets the payment_terms of this Subscription. + """Sets the payment_terms of this Subscription. - :param payment_terms: The payment_terms of this Subscription. + :param payment_terms: The payment_terms of this Subscription. # noqa: E501 :type: int """ self._payment_terms = payment_terms @property - def failed_payment_behaviour(self): - """ - Gets the failed_payment_behaviour of this Subscription. - {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.
CancelSubscription — Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.
None — The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles — or when manual invoice remediation is common — None is recommended.
In a heavily-automated SaaS environment, automatic cancellation via CancelSubscription is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + def purchase_order(self): + """Gets the purchase_order of this Subscription. # noqa: E501 - :return: The failed_payment_behaviour of this Subscription. + + :return: The purchase_order of this Subscription. # noqa: E501 :rtype: str """ - return self._failed_payment_behaviour + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this Subscription. - @failed_payment_behaviour.setter - def failed_payment_behaviour(self, failed_payment_behaviour): - """ - Sets the failed_payment_behaviour of this Subscription. - {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.
CancelSubscription — Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.
None — The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles — or when manual invoice remediation is common — None is recommended.
In a heavily-automated SaaS environment, automatic cancellation via CancelSubscription is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - :param failed_payment_behaviour: The failed_payment_behaviour of this Subscription. + :param purchase_order: The purchase_order of this Subscription. # noqa: E501 :type: str """ - allowed_values = ["CancelSubscription", "None"] - if failed_payment_behaviour not in allowed_values: - raise ValueError( - "Invalid value for `failed_payment_behaviour` ({0}), must be one of {1}" - .format(failed_payment_behaviour, allowed_values) - ) - self._failed_payment_behaviour = failed_payment_behaviour + self._purchase_order = purchase_order - def to_dict(self): + @property + def affiliate_subscription_relationship(self): + """Gets the affiliate_subscription_relationship of this Subscription. # noqa: E501 + + + :return: The affiliate_subscription_relationship of this Subscription. # noqa: E501 + :rtype: list[AffiliateSubscriptionRelationship] + """ + return self._affiliate_subscription_relationship + + @affiliate_subscription_relationship.setter + def affiliate_subscription_relationship(self, affiliate_subscription_relationship): + """Sets the affiliate_subscription_relationship of this Subscription. + + + :param affiliate_subscription_relationship: The affiliate_subscription_relationship of this Subscription. # noqa: E501 + :type: list[AffiliateSubscriptionRelationship] + """ + + self._affiliate_subscription_relationship = affiliate_subscription_relationship + + @property + def fixed_term(self): + """Gets the fixed_term of this Subscription. # noqa: E501 + + + :return: The fixed_term of this Subscription. # noqa: E501 + :rtype: bool """ - Returns the model properties as a dict + return self._fixed_term + + @fixed_term.setter + def fixed_term(self, fixed_term): + """Sets the fixed_term of this Subscription. + + + :param fixed_term: The fixed_term of this Subscription. # noqa: E501 + :type: bool """ + + self._fixed_term = fixed_term + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -1134,29 +1395,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Subscription, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Subscription): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/subscription_cancellation.py b/billforward/models/subscription_cancellation.py new file mode 100644 index 0000000..f59bd2b --- /dev/null +++ b/billforward/models/subscription_cancellation.py @@ -0,0 +1,555 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SubscriptionCancellation(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'subscription_id': 'str', + 'organization_id': 'str', + 'source': 'str', + 'service_end': 'str', + 'revive': 'SubscriptionRevivePartialRequest', + 'cancellation_credit': 'str', + 'credit_note_description': 'str', + 'pre_cancellation_state': 'str', + 'state': 'str', + 'cancel_children': 'bool', + 'cancel_empty_parent': 'bool', + 'associated_refunds': 'list[Refund]', + 'discardable': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'subscription_id': 'subscriptionID', + 'organization_id': 'organizationID', + 'source': 'source', + 'service_end': 'serviceEnd', + 'revive': 'revive', + 'cancellation_credit': 'cancellationCredit', + 'credit_note_description': 'creditNoteDescription', + 'pre_cancellation_state': 'preCancellationState', + 'state': 'state', + 'cancel_children': 'cancelChildren', + 'cancel_empty_parent': 'cancelEmptyParent', + 'associated_refunds': 'associatedRefunds', + 'discardable': 'discardable' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, subscription_id=None, organization_id=None, source=None, service_end=None, revive=None, cancellation_credit=None, credit_note_description=None, pre_cancellation_state=None, state=None, cancel_children=None, cancel_empty_parent=None, associated_refunds=None, discardable=None): # noqa: E501 + """SubscriptionCancellation - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._subscription_id = None + self._organization_id = None + self._source = None + self._service_end = None + self._revive = None + self._cancellation_credit = None + self._credit_note_description = None + self._pre_cancellation_state = None + self._state = None + self._cancel_children = None + self._cancel_empty_parent = None + self._associated_refunds = None + self._discardable = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.subscription_id = subscription_id + self.organization_id = organization_id + if source is not None: + self.source = source + self.service_end = service_end + if revive is not None: + self.revive = revive + self.cancellation_credit = cancellation_credit + if credit_note_description is not None: + self.credit_note_description = credit_note_description + if pre_cancellation_state is not None: + self.pre_cancellation_state = pre_cancellation_state + self.state = state + if cancel_children is not None: + self.cancel_children = cancel_children + if cancel_empty_parent is not None: + self.cancel_empty_parent = cancel_empty_parent + if associated_refunds is not None: + self.associated_refunds = associated_refunds + if discardable is not None: + self.discardable = discardable + + @property + def created(self): + """Gets the created of this SubscriptionCancellation. # noqa: E501 + + + :return: The created of this SubscriptionCancellation. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this SubscriptionCancellation. + + + :param created: The created of this SubscriptionCancellation. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this SubscriptionCancellation. # noqa: E501 + + + :return: The changed_by of this SubscriptionCancellation. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this SubscriptionCancellation. + + + :param changed_by: The changed_by of this SubscriptionCancellation. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this SubscriptionCancellation. # noqa: E501 + + + :return: The updated of this SubscriptionCancellation. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this SubscriptionCancellation. + + + :param updated: The updated of this SubscriptionCancellation. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this SubscriptionCancellation. # noqa: E501 + + + :return: The id of this SubscriptionCancellation. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this SubscriptionCancellation. + + + :param id: The id of this SubscriptionCancellation. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def subscription_id(self): + """Gets the subscription_id of this SubscriptionCancellation. # noqa: E501 + + + :return: The subscription_id of this SubscriptionCancellation. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this SubscriptionCancellation. + + + :param subscription_id: The subscription_id of this SubscriptionCancellation. # noqa: E501 + :type: str + """ + if subscription_id is None: + raise ValueError("Invalid value for `subscription_id`, must not be `None`") # noqa: E501 + + self._subscription_id = subscription_id + + @property + def organization_id(self): + """Gets the organization_id of this SubscriptionCancellation. # noqa: E501 + + + :return: The organization_id of this SubscriptionCancellation. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SubscriptionCancellation. + + + :param organization_id: The organization_id of this SubscriptionCancellation. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def source(self): + """Gets the source of this SubscriptionCancellation. # noqa: E501 + + + :return: The source of this SubscriptionCancellation. # noqa: E501 + :rtype: str + """ + return self._source + + @source.setter + def source(self, source): + """Sets the source of this SubscriptionCancellation. + + + :param source: The source of this SubscriptionCancellation. # noqa: E501 + :type: str + """ + + self._source = source + + @property + def service_end(self): + """Gets the service_end of this SubscriptionCancellation. # noqa: E501 + + + :return: The service_end of this SubscriptionCancellation. # noqa: E501 + :rtype: str + """ + return self._service_end + + @service_end.setter + def service_end(self, service_end): + """Sets the service_end of this SubscriptionCancellation. + + + :param service_end: The service_end of this SubscriptionCancellation. # noqa: E501 + :type: str + """ + if service_end is None: + raise ValueError("Invalid value for `service_end`, must not be `None`") # noqa: E501 + allowed_values = ["Immediate", "AtPeriodEnd"] # noqa: E501 + if service_end not in allowed_values: + raise ValueError( + "Invalid value for `service_end` ({0}), must be one of {1}" # noqa: E501 + .format(service_end, allowed_values) + ) + + self._service_end = service_end + + @property + def revive(self): + """Gets the revive of this SubscriptionCancellation. # noqa: E501 + + + :return: The revive of this SubscriptionCancellation. # noqa: E501 + :rtype: SubscriptionRevivePartialRequest + """ + return self._revive + + @revive.setter + def revive(self, revive): + """Sets the revive of this SubscriptionCancellation. + + + :param revive: The revive of this SubscriptionCancellation. # noqa: E501 + :type: SubscriptionRevivePartialRequest + """ + + self._revive = revive + + @property + def cancellation_credit(self): + """Gets the cancellation_credit of this SubscriptionCancellation. # noqa: E501 + + + :return: The cancellation_credit of this SubscriptionCancellation. # noqa: E501 + :rtype: str + """ + return self._cancellation_credit + + @cancellation_credit.setter + def cancellation_credit(self, cancellation_credit): + """Sets the cancellation_credit of this SubscriptionCancellation. + + + :param cancellation_credit: The cancellation_credit of this SubscriptionCancellation. # noqa: E501 + :type: str + """ + if cancellation_credit is None: + raise ValueError("Invalid value for `cancellation_credit`, must not be `None`") # noqa: E501 + allowed_values = ["Refund", "Credit", "None"] # noqa: E501 + if cancellation_credit not in allowed_values: + raise ValueError( + "Invalid value for `cancellation_credit` ({0}), must be one of {1}" # noqa: E501 + .format(cancellation_credit, allowed_values) + ) + + self._cancellation_credit = cancellation_credit + + @property + def credit_note_description(self): + """Gets the credit_note_description of this SubscriptionCancellation. # noqa: E501 + + + :return: The credit_note_description of this SubscriptionCancellation. # noqa: E501 + :rtype: str + """ + return self._credit_note_description + + @credit_note_description.setter + def credit_note_description(self, credit_note_description): + """Sets the credit_note_description of this SubscriptionCancellation. + + + :param credit_note_description: The credit_note_description of this SubscriptionCancellation. # noqa: E501 + :type: str + """ + + self._credit_note_description = credit_note_description + + @property + def pre_cancellation_state(self): + """Gets the pre_cancellation_state of this SubscriptionCancellation. # noqa: E501 + + + :return: The pre_cancellation_state of this SubscriptionCancellation. # noqa: E501 + :rtype: str + """ + return self._pre_cancellation_state + + @pre_cancellation_state.setter + def pre_cancellation_state(self, pre_cancellation_state): + """Sets the pre_cancellation_state of this SubscriptionCancellation. + + + :param pre_cancellation_state: The pre_cancellation_state of this SubscriptionCancellation. # noqa: E501 + :type: str + """ + allowed_values = ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"] # noqa: E501 + if pre_cancellation_state not in allowed_values: + raise ValueError( + "Invalid value for `pre_cancellation_state` ({0}), must be one of {1}" # noqa: E501 + .format(pre_cancellation_state, allowed_values) + ) + + self._pre_cancellation_state = pre_cancellation_state + + @property + def state(self): + """Gets the state of this SubscriptionCancellation. # noqa: E501 + + + :return: The state of this SubscriptionCancellation. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this SubscriptionCancellation. + + + :param state: The state of this SubscriptionCancellation. # noqa: E501 + :type: str + """ + if state is None: + raise ValueError("Invalid value for `state`, must not be `None`") # noqa: E501 + allowed_values = ["Pending", "Completed", "Cancelled", "Voided"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def cancel_children(self): + """Gets the cancel_children of this SubscriptionCancellation. # noqa: E501 + + + :return: The cancel_children of this SubscriptionCancellation. # noqa: E501 + :rtype: bool + """ + return self._cancel_children + + @cancel_children.setter + def cancel_children(self, cancel_children): + """Sets the cancel_children of this SubscriptionCancellation. + + + :param cancel_children: The cancel_children of this SubscriptionCancellation. # noqa: E501 + :type: bool + """ + + self._cancel_children = cancel_children + + @property + def cancel_empty_parent(self): + """Gets the cancel_empty_parent of this SubscriptionCancellation. # noqa: E501 + + + :return: The cancel_empty_parent of this SubscriptionCancellation. # noqa: E501 + :rtype: bool + """ + return self._cancel_empty_parent + + @cancel_empty_parent.setter + def cancel_empty_parent(self, cancel_empty_parent): + """Sets the cancel_empty_parent of this SubscriptionCancellation. + + + :param cancel_empty_parent: The cancel_empty_parent of this SubscriptionCancellation. # noqa: E501 + :type: bool + """ + + self._cancel_empty_parent = cancel_empty_parent + + @property + def associated_refunds(self): + """Gets the associated_refunds of this SubscriptionCancellation. # noqa: E501 + + + :return: The associated_refunds of this SubscriptionCancellation. # noqa: E501 + :rtype: list[Refund] + """ + return self._associated_refunds + + @associated_refunds.setter + def associated_refunds(self, associated_refunds): + """Sets the associated_refunds of this SubscriptionCancellation. + + + :param associated_refunds: The associated_refunds of this SubscriptionCancellation. # noqa: E501 + :type: list[Refund] + """ + + self._associated_refunds = associated_refunds + + @property + def discardable(self): + """Gets the discardable of this SubscriptionCancellation. # noqa: E501 + + + :return: The discardable of this SubscriptionCancellation. # noqa: E501 + :rtype: bool + """ + return self._discardable + + @discardable.setter + def discardable(self, discardable): + """Sets the discardable of this SubscriptionCancellation. + + + :param discardable: The discardable of this SubscriptionCancellation. # noqa: E501 + :type: bool + """ + + self._discardable = discardable + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SubscriptionCancellation, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SubscriptionCancellation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/subscription_cancellation_paged_metadata.py b/billforward/models/subscription_cancellation_paged_metadata.py deleted file mode 100644 index 23ec631..0000000 --- a/billforward/models/subscription_cancellation_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class SubscriptionCancellationPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - SubscriptionCancellationPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this SubscriptionCancellationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this SubscriptionCancellationPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this SubscriptionCancellationPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this SubscriptionCancellationPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this SubscriptionCancellationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this SubscriptionCancellationPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this SubscriptionCancellationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this SubscriptionCancellationPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this SubscriptionCancellationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this SubscriptionCancellationPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this SubscriptionCancellationPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this SubscriptionCancellationPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this SubscriptionCancellationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this SubscriptionCancellationPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this SubscriptionCancellationPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this SubscriptionCancellationPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this SubscriptionCancellationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this SubscriptionCancellationPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this SubscriptionCancellationPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this SubscriptionCancellationPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this SubscriptionCancellationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this SubscriptionCancellationPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this SubscriptionCancellationPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this SubscriptionCancellationPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this SubscriptionCancellationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this SubscriptionCancellationPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this SubscriptionCancellationPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this SubscriptionCancellationPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/subscription_charge.py b/billforward/models/subscription_charge.py index 15777b7..ef47772 100644 --- a/billforward/models/subscription_charge.py +++ b/billforward/models/subscription_charge.py @@ -1,145 +1,227 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class SubscriptionCharge(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, crm_id=None, account_id=None, subscription_id=None, subscription_version_id=None, invoice_id=None, name=None, description=None, amount=None, amount_excluding_tax=None, currency=None, period_start=None, period_end=None, type=None, invoicing_type=None, state=None, charge_type=None, calculation=None, remaining_credit_behaviour=None, trial=False, version_id=None, version_number=None): - """ - SubscriptionCharge - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'crm_id': 'str', - 'account_id': 'str', - 'subscription_id': 'str', - 'subscription_version_id': 'str', - 'invoice_id': 'str', - 'name': 'str', - 'description': 'str', - 'amount': 'float', - 'amount_excluding_tax': 'float', - 'currency': 'str', - 'period_start': 'datetime', - 'period_end': 'datetime', - 'type': 'str', - 'invoicing_type': 'str', - 'state': 'str', - 'charge_type': 'str', - 'calculation': 'str', - 'remaining_credit_behaviour': 'str', - 'trial': 'bool', - 'version_id': 'str', - 'version_number': 'int' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'crm_id': 'crmID', - 'account_id': 'accountID', - 'subscription_id': 'subscriptionID', - 'subscription_version_id': 'subscriptionVersionID', - 'invoice_id': 'invoiceID', - 'name': 'name', - 'description': 'description', - 'amount': 'amount', - 'amount_excluding_tax': 'amountExcludingTax', - 'currency': 'currency', - 'period_start': 'periodStart', - 'period_end': 'periodEnd', - 'type': 'type', - 'invoicing_type': 'invoicingType', - 'state': 'state', - 'charge_type': 'chargeType', - 'calculation': 'calculation', - 'remaining_credit_behaviour': 'remainingCreditBehaviour', - 'trial': 'trial', - 'version_id': 'versionID', - 'version_number': 'versionNumber' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._crm_id = crm_id - self._account_id = account_id - self._subscription_id = subscription_id - self._subscription_version_id = subscription_version_id - self._invoice_id = invoice_id - self._name = name - self._description = description - self._amount = amount - self._amount_excluding_tax = amount_excluding_tax - self._currency = currency - self._period_start = period_start - self._period_end = period_end - self._type = type - self._invoicing_type = invoicing_type - self._state = state - self._charge_type = charge_type - self._calculation = calculation - self._remaining_credit_behaviour = remaining_credit_behaviour - self._trial = trial - self._version_id = version_id - self._version_number = version_number + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'account_id': 'str', + 'subscription_id': 'str', + 'subscription_version_id': 'str', + 'invoice_id': 'str', + 'organization_id': 'str', + 'name': 'str', + 'description': 'str', + 'tax_code': 'str', + 'amount': 'float', + 'amount_excluding_tax': 'float', + 'currency': 'CreditNoteCurrency', + 'period_start': 'datetime', + 'period_end': 'datetime', + 'type': 'str', + 'invoicing_type': 'str', + 'state': 'str', + 'charge_type': 'str', + 'calculation': 'str', + 'remaining_credit_behaviour': 'str', + 'trial': 'bool', + 'version_id': 'str', + 'version_number': 'int', + 'linked_charge_id': 'str', + 'percentage_of_original': 'float', + 'original_charge_id': 'str', + 'group_name': 'str', + 'outer_period_start': 'datetime', + 'crm_id': 'str', + 'type': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'account_id': 'accountID', + 'subscription_id': 'subscriptionID', + 'subscription_version_id': 'subscriptionVersionID', + 'invoice_id': 'invoiceID', + 'organization_id': 'organizationID', + 'name': 'name', + 'description': 'description', + 'tax_code': 'taxCode', + 'amount': 'amount', + 'amount_excluding_tax': 'amountExcludingTax', + 'currency': 'currency', + 'period_start': 'periodStart', + 'period_end': 'periodEnd', + 'type': 'type', + 'invoicing_type': 'invoicingType', + 'state': 'state', + 'charge_type': 'chargeType', + 'calculation': 'calculation', + 'remaining_credit_behaviour': 'remainingCreditBehaviour', + 'trial': 'trial', + 'version_id': 'versionID', + 'version_number': 'versionNumber', + 'linked_charge_id': 'linkedChargeID', + 'percentage_of_original': 'percentageOfOriginal', + 'original_charge_id': 'originalChargeID', + 'group_name': 'groupName', + 'outer_period_start': 'outerPeriodStart', + 'crm_id': 'crmID', + 'type': '@type' + } + + discriminator_value_class_map = { + 'ProductRatePlanMigrationCharge': 'ProductRatePlanMigrationCharge', +'CouponCharge': 'CouponCharge', +'ManualCharge': 'ManualCharge', +'PrepaymentCharge': 'PrepaymentCharge', +'SetupCharge': 'SetupCharge', +'AffiliateCommissionCharge': 'AffiliateCommissionCharge', +'ArrearsCharge': 'ArrearsCharge', +'UpgradeCharge': 'UpgradeCharge', +'PricingComponentCharge': 'PricingComponentCharge' } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, subscription_id=None, subscription_version_id=None, invoice_id=None, organization_id=None, name=None, description=None, tax_code=None, amount=None, amount_excluding_tax=None, currency=None, period_start=None, period_end=None, type=None, invoicing_type=None, state=None, charge_type=None, calculation=None, remaining_credit_behaviour=None, trial=None, version_id=None, version_number=None, linked_charge_id=None, percentage_of_original=None, original_charge_id=None, group_name=None, outer_period_start=None, crm_id=None, type=None): # noqa: E501 + """SubscriptionCharge - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._account_id = None + self._subscription_id = None + self._subscription_version_id = None + self._invoice_id = None + self._organization_id = None + self._name = None + self._description = None + self._tax_code = None + self._amount = None + self._amount_excluding_tax = None + self._currency = None + self._period_start = None + self._period_end = None + self._type = None + self._invoicing_type = None + self._state = None + self._charge_type = None + self._calculation = None + self._remaining_credit_behaviour = None + self._trial = None + self._version_id = None + self._version_number = None + self._linked_charge_id = None + self._percentage_of_original = None + self._original_charge_id = None + self._group_name = None + self._outer_period_start = None + self._crm_id = None + self._type = None + self.discriminator = '@type' + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if account_id is not None: + self.account_id = account_id + if subscription_id is not None: + self.subscription_id = subscription_id + if subscription_version_id is not None: + self.subscription_version_id = subscription_version_id + if invoice_id is not None: + self.invoice_id = invoice_id + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if description is not None: + self.description = description + if tax_code is not None: + self.tax_code = tax_code + if amount is not None: + self.amount = amount + if amount_excluding_tax is not None: + self.amount_excluding_tax = amount_excluding_tax + if currency is not None: + self.currency = currency + if period_start is not None: + self.period_start = period_start + if period_end is not None: + self.period_end = period_end + self.type = type + self.invoicing_type = invoicing_type + self.state = state + self.charge_type = charge_type + if calculation is not None: + self.calculation = calculation + self.remaining_credit_behaviour = remaining_credit_behaviour + if trial is not None: + self.trial = trial + if version_id is not None: + self.version_id = version_id + self.version_number = version_number + if linked_charge_id is not None: + self.linked_charge_id = linked_charge_id + if percentage_of_original is not None: + self.percentage_of_original = percentage_of_original + if original_charge_id is not None: + self.original_charge_id = original_charge_id + if group_name is not None: + self.group_name = group_name + if outer_period_start is not None: + self.outer_period_start = outer_period_start + if crm_id is not None: + self.crm_id = crm_id + self.type = type @property def created(self): - """ - Gets the created of this SubscriptionCharge. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this SubscriptionCharge. # noqa: E501 + - :return: The created of this SubscriptionCharge. + :return: The created of this SubscriptionCharge. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this SubscriptionCharge. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this SubscriptionCharge. + - :param created: The created of this SubscriptionCharge. + :param created: The created of this SubscriptionCharge. # noqa: E501 :type: datetime """ @@ -147,22 +229,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this SubscriptionCharge. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this SubscriptionCharge. # noqa: E501 - :return: The changed_by of this SubscriptionCharge. + + :return: The changed_by of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this SubscriptionCharge. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this SubscriptionCharge. - :param changed_by: The changed_by of this SubscriptionCharge. + + :param changed_by: The changed_by of this SubscriptionCharge. # noqa: E501 :type: str """ @@ -170,22 +250,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this SubscriptionCharge. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this SubscriptionCharge. # noqa: E501 - :return: The updated of this SubscriptionCharge. + + :return: The updated of this SubscriptionCharge. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this SubscriptionCharge. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this SubscriptionCharge. - :param updated: The updated of this SubscriptionCharge. + + :param updated: The updated of this SubscriptionCharge. # noqa: E501 :type: datetime """ @@ -193,68 +271,41 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this SubscriptionCharge. - {\"description\":\"The ID of the charge.\",\"verbs\":[\"GET\"]} + """Gets the id of this SubscriptionCharge. # noqa: E501 - :return: The id of this SubscriptionCharge. + + :return: The id of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this SubscriptionCharge. - {\"description\":\"The ID of the charge.\",\"verbs\":[\"GET\"]} - - :param id: The id of this SubscriptionCharge. - :type: str - """ - - self._id = id + """Sets the id of this SubscriptionCharge. - @property - def crm_id(self): - """ - Gets the crm_id of this SubscriptionCharge. - {\"description\":\"Customer-relationship-management ID of the charge.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - :return: The crm_id of this SubscriptionCharge. - :rtype: str - """ - return self._crm_id - - @crm_id.setter - def crm_id(self, crm_id): - """ - Sets the crm_id of this SubscriptionCharge. - {\"description\":\"Customer-relationship-management ID of the charge.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param crm_id: The crm_id of this SubscriptionCharge. + :param id: The id of this SubscriptionCharge. # noqa: E501 :type: str """ - self._crm_id = crm_id + self._id = id @property def account_id(self): - """ - Gets the account_id of this SubscriptionCharge. - {\"description\":\"ID of the account owning the subscription for which the charge was generated.\",\"verbs\":[\"GET\",\"POST\"]} + """Gets the account_id of this SubscriptionCharge. # noqa: E501 - :return: The account_id of this SubscriptionCharge. + + :return: The account_id of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._account_id @account_id.setter def account_id(self, account_id): - """ - Sets the account_id of this SubscriptionCharge. - {\"description\":\"ID of the account owning the subscription for which the charge was generated.\",\"verbs\":[\"GET\",\"POST\"]} + """Sets the account_id of this SubscriptionCharge. - :param account_id: The account_id of this SubscriptionCharge. + + :param account_id: The account_id of this SubscriptionCharge. # noqa: E501 :type: str """ @@ -262,22 +313,20 @@ def account_id(self, account_id): @property def subscription_id(self): - """ - Gets the subscription_id of this SubscriptionCharge. - {\"description\":\"ID of the subscription for which the charge was generated.\",\"verbs\":[\"GET\",\"POST\"]} + """Gets the subscription_id of this SubscriptionCharge. # noqa: E501 + - :return: The subscription_id of this SubscriptionCharge. + :return: The subscription_id of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._subscription_id @subscription_id.setter def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this SubscriptionCharge. - {\"description\":\"ID of the subscription for which the charge was generated.\",\"verbs\":[\"GET\",\"POST\"]} + """Sets the subscription_id of this SubscriptionCharge. + - :param subscription_id: The subscription_id of this SubscriptionCharge. + :param subscription_id: The subscription_id of this SubscriptionCharge. # noqa: E501 :type: str """ @@ -285,22 +334,20 @@ def subscription_id(self, subscription_id): @property def subscription_version_id(self): - """ - Gets the subscription_version_id of this SubscriptionCharge. - {\"description\":\"Version ID of the subscription for which the charge was generated.\",\"verbs\":[\"GET\",\"POST\"]} + """Gets the subscription_version_id of this SubscriptionCharge. # noqa: E501 + - :return: The subscription_version_id of this SubscriptionCharge. + :return: The subscription_version_id of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._subscription_version_id @subscription_version_id.setter def subscription_version_id(self, subscription_version_id): - """ - Sets the subscription_version_id of this SubscriptionCharge. - {\"description\":\"Version ID of the subscription for which the charge was generated.\",\"verbs\":[\"GET\",\"POST\"]} + """Sets the subscription_version_id of this SubscriptionCharge. + - :param subscription_version_id: The subscription_version_id of this SubscriptionCharge. + :param subscription_version_id: The subscription_version_id of this SubscriptionCharge. # noqa: E501 :type: str """ @@ -308,45 +355,62 @@ def subscription_version_id(self, subscription_version_id): @property def invoice_id(self): - """ - Gets the invoice_id of this SubscriptionCharge. - {\"description\":\"ID of the invoice to which this charge applies (if the charge targets a specific invoice).\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the invoice_id of this SubscriptionCharge. # noqa: E501 + - :return: The invoice_id of this SubscriptionCharge. + :return: The invoice_id of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._invoice_id @invoice_id.setter def invoice_id(self, invoice_id): - """ - Sets the invoice_id of this SubscriptionCharge. - {\"description\":\"ID of the invoice to which this charge applies (if the charge targets a specific invoice).\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the invoice_id of this SubscriptionCharge. - :param invoice_id: The invoice_id of this SubscriptionCharge. + + :param invoice_id: The invoice_id of this SubscriptionCharge. # noqa: E501 :type: str """ self._invoice_id = invoice_id @property - def name(self): + def organization_id(self): + """Gets the organization_id of this SubscriptionCharge. # noqa: E501 + + + :return: The organization_id of this SubscriptionCharge. # noqa: E501 + :rtype: str """ - Gets the name of this SubscriptionCharge. - {\"description\":\"Friendly name given to the charge to help identify it.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SubscriptionCharge. - :return: The name of this SubscriptionCharge. + + :param organization_id: The organization_id of this SubscriptionCharge. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def name(self): + """Gets the name of this SubscriptionCharge. # noqa: E501 + + + :return: The name of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this SubscriptionCharge. - {\"description\":\"Friendly name given to the charge to help identify it.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} + """Sets the name of this SubscriptionCharge. + - :param name: The name of this SubscriptionCharge. + :param name: The name of this SubscriptionCharge. # noqa: E501 :type: str """ @@ -354,45 +418,62 @@ def name(self, name): @property def description(self): - """ - Gets the description of this SubscriptionCharge. - {\"description\":\"Description given to the charge.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} + """Gets the description of this SubscriptionCharge. # noqa: E501 + - :return: The description of this SubscriptionCharge. + :return: The description of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this SubscriptionCharge. - {\"description\":\"Description given to the charge.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} + """Sets the description of this SubscriptionCharge. + - :param description: The description of this SubscriptionCharge. + :param description: The description of this SubscriptionCharge. # noqa: E501 :type: str """ self._description = description @property - def amount(self): + def tax_code(self): + """Gets the tax_code of this SubscriptionCharge. # noqa: E501 + + + :return: The tax_code of this SubscriptionCharge. # noqa: E501 + :rtype: str """ - Gets the amount of this SubscriptionCharge. - {\"description\":\"Monetary amount of the charge — including any tax applied to the final amount.\",\"verbs\":[\"POST\",\"GET\"]} + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this SubscriptionCharge. - :return: The amount of this SubscriptionCharge. + + :param tax_code: The tax_code of this SubscriptionCharge. # noqa: E501 + :type: str + """ + + self._tax_code = tax_code + + @property + def amount(self): + """Gets the amount of this SubscriptionCharge. # noqa: E501 + + + :return: The amount of this SubscriptionCharge. # noqa: E501 :rtype: float """ return self._amount @amount.setter def amount(self, amount): - """ - Sets the amount of this SubscriptionCharge. - {\"description\":\"Monetary amount of the charge — including any tax applied to the final amount.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the amount of this SubscriptionCharge. - :param amount: The amount of this SubscriptionCharge. + + :param amount: The amount of this SubscriptionCharge. # noqa: E501 :type: float """ @@ -400,22 +481,20 @@ def amount(self, amount): @property def amount_excluding_tax(self): - """ - Gets the amount_excluding_tax of this SubscriptionCharge. - {\"description\":\"Monetary amount of the charge — excluding any tax applied to the final amount.\",\"verbs\":[\"GET\"]} + """Gets the amount_excluding_tax of this SubscriptionCharge. # noqa: E501 - :return: The amount_excluding_tax of this SubscriptionCharge. + + :return: The amount_excluding_tax of this SubscriptionCharge. # noqa: E501 :rtype: float """ return self._amount_excluding_tax @amount_excluding_tax.setter def amount_excluding_tax(self, amount_excluding_tax): - """ - Sets the amount_excluding_tax of this SubscriptionCharge. - {\"description\":\"Monetary amount of the charge — excluding any tax applied to the final amount.\",\"verbs\":[\"GET\"]} + """Sets the amount_excluding_tax of this SubscriptionCharge. - :param amount_excluding_tax: The amount_excluding_tax of this SubscriptionCharge. + + :param amount_excluding_tax: The amount_excluding_tax of this SubscriptionCharge. # noqa: E501 :type: float """ @@ -423,45 +502,41 @@ def amount_excluding_tax(self, amount_excluding_tax): @property def currency(self): - """ - Gets the currency of this SubscriptionCharge. - { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } + """Gets the currency of this SubscriptionCharge. # noqa: E501 - :return: The currency of this SubscriptionCharge. - :rtype: str + + :return: The currency of this SubscriptionCharge. # noqa: E501 + :rtype: CreditNoteCurrency """ return self._currency @currency.setter def currency(self, currency): - """ - Sets the currency of this SubscriptionCharge. - { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } + """Sets the currency of this SubscriptionCharge. - :param currency: The currency of this SubscriptionCharge. - :type: str + + :param currency: The currency of this SubscriptionCharge. # noqa: E501 + :type: CreditNoteCurrency """ self._currency = currency @property def period_start(self): - """ - Gets the period_start of this SubscriptionCharge. - {\"default\":\"(Now)\",\"description\":\"The time-beginning of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the period_start of this SubscriptionCharge. # noqa: E501 + - :return: The period_start of this SubscriptionCharge. + :return: The period_start of this SubscriptionCharge. # noqa: E501 :rtype: datetime """ return self._period_start @period_start.setter def period_start(self, period_start): - """ - Sets the period_start of this SubscriptionCharge. - {\"default\":\"(Now)\",\"description\":\"The time-beginning of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the period_start of this SubscriptionCharge. + - :param period_start: The period_start of this SubscriptionCharge. + :param period_start: The period_start of this SubscriptionCharge. # noqa: E501 :type: datetime """ @@ -469,22 +544,20 @@ def period_start(self, period_start): @property def period_end(self): - """ - Gets the period_end of this SubscriptionCharge. - {\"default\":\"(End of current period)\",\"description\":\"The time-ending of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the period_end of this SubscriptionCharge. # noqa: E501 + - :return: The period_end of this SubscriptionCharge. + :return: The period_end of this SubscriptionCharge. # noqa: E501 :rtype: datetime """ return self._period_end @period_end.setter def period_end(self, period_end): - """ - Sets the period_end of this SubscriptionCharge. - {\"default\":\"(End of current period)\",\"description\":\"The time-ending of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the period_end of this SubscriptionCharge. + - :param period_end: The period_end of this SubscriptionCharge. + :param period_end: The period_end of this SubscriptionCharge. # noqa: E501 :type: datetime """ @@ -492,28 +565,28 @@ def period_end(self, period_end): @property def type(self): - """ - Gets the type of this SubscriptionCharge. - {\"description\":\"A type describing the nature of the charge.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the type of this SubscriptionCharge. # noqa: E501 + - :return: The type of this SubscriptionCharge. + :return: The type of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._type @type.setter def type(self, type): - """ - Sets the type of this SubscriptionCharge. - {\"description\":\"A type describing the nature of the charge.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the type of this SubscriptionCharge. + - :param type: The type of this SubscriptionCharge. + :param type: The type of this SubscriptionCharge. # noqa: E501 :type: str """ - allowed_values = ["Setup", "Upgrade", "Manual", "ProductRatePlanMigration", "Arrears", "Advance", "Coupon", "Usage", "PricingComponent"] + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + allowed_values = ["Setup", "Upgrade", "Manual", "ProductRatePlanMigration", "Arrears", "Advance", "Coupon", "Usage", "PricingComponent", "Prepayment", "AffiliateCommission"] # noqa: E501 if type not in allowed_values: raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 .format(type, allowed_values) ) @@ -521,28 +594,28 @@ def type(self, type): @property def invoicing_type(self): - """ - Gets the invoicing_type of this SubscriptionCharge. - {\"default\":\"Aggregated\",\"description\":\"The strategy for how this charge will raise invoices.
Immediate — Generate straight-away an invoice containing this charge.
Aggregated — Add this charge to the next invoice which is generated naturally — i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the invoicing_type of this SubscriptionCharge. # noqa: E501 - :return: The invoicing_type of this SubscriptionCharge. + + :return: The invoicing_type of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._invoicing_type @invoicing_type.setter def invoicing_type(self, invoicing_type): - """ - Sets the invoicing_type of this SubscriptionCharge. - {\"default\":\"Aggregated\",\"description\":\"The strategy for how this charge will raise invoices.
Immediate — Generate straight-away an invoice containing this charge.
Aggregated — Add this charge to the next invoice which is generated naturally — i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the invoicing_type of this SubscriptionCharge. - :param invoicing_type: The invoicing_type of this SubscriptionCharge. + + :param invoicing_type: The invoicing_type of this SubscriptionCharge. # noqa: E501 :type: str """ - allowed_values = ["Immediate", "Aggregated"] + if invoicing_type is None: + raise ValueError("Invalid value for `invoicing_type`, must not be `None`") # noqa: E501 + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 if invoicing_type not in allowed_values: raise ValueError( - "Invalid value for `invoicing_type` ({0}), must be one of {1}" + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 .format(invoicing_type, allowed_values) ) @@ -550,28 +623,28 @@ def invoicing_type(self, invoicing_type): @property def state(self): - """ - Gets the state of this SubscriptionCharge. - {\"default\":\"Pending\",\"description\":\"The current state of the charge.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} + """Gets the state of this SubscriptionCharge. # noqa: E501 - :return: The state of this SubscriptionCharge. + + :return: The state of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._state @state.setter def state(self, state): - """ - Sets the state of this SubscriptionCharge. - {\"default\":\"Pending\",\"description\":\"The current state of the charge.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} + """Sets the state of this SubscriptionCharge. - :param state: The state of this SubscriptionCharge. + + :param state: The state of this SubscriptionCharge. # noqa: E501 :type: str """ - allowed_values = ["Voided", "Pending", "AwaitingPayment", "Paid", "Failed"] + if state is None: + raise ValueError("Invalid value for `state`, must not be `None`") # noqa: E501 + allowed_values = ["Voided", "Pending", "AwaitingPayment", "Paid", "Failed"] # noqa: E501 if state not in allowed_values: raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 .format(state, allowed_values) ) @@ -579,28 +652,28 @@ def state(self, state): @property def charge_type(self): - """ - Gets the charge_type of this SubscriptionCharge. - {\"default\":\"Debit\",\"description\":\"Whether this charge represents money given to or taken from the customer.
Credit — This is a charge for money given to the customer.
Debit — This is a charge for money taken from the customer.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the charge_type of this SubscriptionCharge. # noqa: E501 + - :return: The charge_type of this SubscriptionCharge. + :return: The charge_type of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._charge_type @charge_type.setter def charge_type(self, charge_type): - """ - Sets the charge_type of this SubscriptionCharge. - {\"default\":\"Debit\",\"description\":\"Whether this charge represents money given to or taken from the customer.
Credit — This is a charge for money given to the customer.
Debit — This is a charge for money taken from the customer.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the charge_type of this SubscriptionCharge. + - :param charge_type: The charge_type of this SubscriptionCharge. + :param charge_type: The charge_type of this SubscriptionCharge. # noqa: E501 :type: str """ - allowed_values = ["Credit", "Debit"] + if charge_type is None: + raise ValueError("Invalid value for `charge_type`, must not be `None`") # noqa: E501 + allowed_values = ["Credit", "Debit"] # noqa: E501 if charge_type not in allowed_values: raise ValueError( - "Invalid value for `charge_type` ({0}), must be one of {1}" + "Invalid value for `charge_type` ({0}), must be one of {1}" # noqa: E501 .format(charge_type, allowed_values) ) @@ -608,22 +681,20 @@ def charge_type(self, charge_type): @property def calculation(self): - """ - Gets the calculation of this SubscriptionCharge. - {\"default\":\"(Empty string)\",\"description\":\"A human-readable explanation of how the value of the charge was calculated.\",\"verbs\":[\"GET\"]} + """Gets the calculation of this SubscriptionCharge. # noqa: E501 + - :return: The calculation of this SubscriptionCharge. + :return: The calculation of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._calculation @calculation.setter def calculation(self, calculation): - """ - Sets the calculation of this SubscriptionCharge. - {\"default\":\"(Empty string)\",\"description\":\"A human-readable explanation of how the value of the charge was calculated.\",\"verbs\":[\"GET\"]} + """Sets the calculation of this SubscriptionCharge. + - :param calculation: The calculation of this SubscriptionCharge. + :param calculation: The calculation of this SubscriptionCharge. # noqa: E501 :type: str """ @@ -631,28 +702,28 @@ def calculation(self, calculation): @property def remaining_credit_behaviour(self): - """ - Gets the remaining_credit_behaviour of this SubscriptionCharge. - {\"default\":\"Rollover\",\"description\":\"Defines the behaviour applied to any outstanding credit resulting from the application of the charge..
Rollover — Outstanding credit is returned to the accounts credit pool.
Discard — Outstanding credit is lost.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the remaining_credit_behaviour of this SubscriptionCharge. # noqa: E501 + - :return: The remaining_credit_behaviour of this SubscriptionCharge. + :return: The remaining_credit_behaviour of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._remaining_credit_behaviour @remaining_credit_behaviour.setter def remaining_credit_behaviour(self, remaining_credit_behaviour): - """ - Sets the remaining_credit_behaviour of this SubscriptionCharge. - {\"default\":\"Rollover\",\"description\":\"Defines the behaviour applied to any outstanding credit resulting from the application of the charge..
Rollover — Outstanding credit is returned to the accounts credit pool.
Discard — Outstanding credit is lost.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the remaining_credit_behaviour of this SubscriptionCharge. - :param remaining_credit_behaviour: The remaining_credit_behaviour of this SubscriptionCharge. + + :param remaining_credit_behaviour: The remaining_credit_behaviour of this SubscriptionCharge. # noqa: E501 :type: str """ - allowed_values = ["Rollover", "Discard"] + if remaining_credit_behaviour is None: + raise ValueError("Invalid value for `remaining_credit_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["Rollover", "Discard"] # noqa: E501 if remaining_credit_behaviour not in allowed_values: raise ValueError( - "Invalid value for `remaining_credit_behaviour` ({0}), must be one of {1}" + "Invalid value for `remaining_credit_behaviour` ({0}), must be one of {1}" # noqa: E501 .format(remaining_credit_behaviour, allowed_values) ) @@ -660,22 +731,20 @@ def remaining_credit_behaviour(self, remaining_credit_behaviour): @property def trial(self): - """ - Gets the trial of this SubscriptionCharge. - {\"default\":\"false\",\"description\":\"(Applicable only if any of [`pricingComponentName`, `pricingComponentID`] are defined)
Whether the charge was created for a subscription whilst in a trial period.
false — This is a non-trial charge, so funds will be sought from the customer.
true — This is a trial charge, soThe charge can be considered 'Paid' without taking any funds from the customer.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the trial of this SubscriptionCharge. # noqa: E501 - :return: The trial of this SubscriptionCharge. + + :return: The trial of this SubscriptionCharge. # noqa: E501 :rtype: bool """ return self._trial @trial.setter def trial(self, trial): - """ - Sets the trial of this SubscriptionCharge. - {\"default\":\"false\",\"description\":\"(Applicable only if any of [`pricingComponentName`, `pricingComponentID`] are defined)
Whether the charge was created for a subscription whilst in a trial period.
false — This is a non-trial charge, so funds will be sought from the customer.
true — This is a trial charge, soThe charge can be considered 'Paid' without taking any funds from the customer.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the trial of this SubscriptionCharge. - :param trial: The trial of this SubscriptionCharge. + + :param trial: The trial of this SubscriptionCharge. # noqa: E501 :type: bool """ @@ -683,22 +752,20 @@ def trial(self, trial): @property def version_id(self): - """ - Gets the version_id of this SubscriptionCharge. - {\"description\":\"The version ID of the charge.\",\"verbs\":[\"GET\"]} + """Gets the version_id of this SubscriptionCharge. # noqa: E501 - :return: The version_id of this SubscriptionCharge. + + :return: The version_id of this SubscriptionCharge. # noqa: E501 :rtype: str """ return self._version_id @version_id.setter def version_id(self, version_id): - """ - Sets the version_id of this SubscriptionCharge. - {\"description\":\"The version ID of the charge.\",\"verbs\":[\"GET\"]} + """Sets the version_id of this SubscriptionCharge. - :param version_id: The version_id of this SubscriptionCharge. + + :param version_id: The version_id of this SubscriptionCharge. # noqa: E501 :type: str """ @@ -706,34 +773,186 @@ def version_id(self, version_id): @property def version_number(self): - """ - Gets the version_number of this SubscriptionCharge. - {\"description\":\"The version number of the charge. The first version of a charge is version number 1.\",\"verbs\":[\"GET\"]} + """Gets the version_number of this SubscriptionCharge. # noqa: E501 - :return: The version_number of this SubscriptionCharge. + + :return: The version_number of this SubscriptionCharge. # noqa: E501 :rtype: int """ return self._version_number @version_number.setter def version_number(self, version_number): - """ - Sets the version_number of this SubscriptionCharge. - {\"description\":\"The version number of the charge. The first version of a charge is version number 1.\",\"verbs\":[\"GET\"]} + """Sets the version_number of this SubscriptionCharge. - :param version_number: The version_number of this SubscriptionCharge. + + :param version_number: The version_number of this SubscriptionCharge. # noqa: E501 :type: int """ + if version_number is None: + raise ValueError("Invalid value for `version_number`, must not be `None`") # noqa: E501 self._version_number = version_number - def to_dict(self): + @property + def linked_charge_id(self): + """Gets the linked_charge_id of this SubscriptionCharge. # noqa: E501 + + + :return: The linked_charge_id of this SubscriptionCharge. # noqa: E501 + :rtype: str + """ + return self._linked_charge_id + + @linked_charge_id.setter + def linked_charge_id(self, linked_charge_id): + """Sets the linked_charge_id of this SubscriptionCharge. + + + :param linked_charge_id: The linked_charge_id of this SubscriptionCharge. # noqa: E501 + :type: str + """ + + self._linked_charge_id = linked_charge_id + + @property + def percentage_of_original(self): + """Gets the percentage_of_original of this SubscriptionCharge. # noqa: E501 + + + :return: The percentage_of_original of this SubscriptionCharge. # noqa: E501 + :rtype: float + """ + return self._percentage_of_original + + @percentage_of_original.setter + def percentage_of_original(self, percentage_of_original): + """Sets the percentage_of_original of this SubscriptionCharge. + + + :param percentage_of_original: The percentage_of_original of this SubscriptionCharge. # noqa: E501 + :type: float + """ + + self._percentage_of_original = percentage_of_original + + @property + def original_charge_id(self): + """Gets the original_charge_id of this SubscriptionCharge. # noqa: E501 + + + :return: The original_charge_id of this SubscriptionCharge. # noqa: E501 + :rtype: str + """ + return self._original_charge_id + + @original_charge_id.setter + def original_charge_id(self, original_charge_id): + """Sets the original_charge_id of this SubscriptionCharge. + + + :param original_charge_id: The original_charge_id of this SubscriptionCharge. # noqa: E501 + :type: str + """ + + self._original_charge_id = original_charge_id + + @property + def group_name(self): + """Gets the group_name of this SubscriptionCharge. # noqa: E501 + + + :return: The group_name of this SubscriptionCharge. # noqa: E501 + :rtype: str + """ + return self._group_name + + @group_name.setter + def group_name(self, group_name): + """Sets the group_name of this SubscriptionCharge. + + + :param group_name: The group_name of this SubscriptionCharge. # noqa: E501 + :type: str """ - Returns the model properties as a dict + + self._group_name = group_name + + @property + def outer_period_start(self): + """Gets the outer_period_start of this SubscriptionCharge. # noqa: E501 + + + :return: The outer_period_start of this SubscriptionCharge. # noqa: E501 + :rtype: datetime """ + return self._outer_period_start + + @outer_period_start.setter + def outer_period_start(self, outer_period_start): + """Sets the outer_period_start of this SubscriptionCharge. + + + :param outer_period_start: The outer_period_start of this SubscriptionCharge. # noqa: E501 + :type: datetime + """ + + self._outer_period_start = outer_period_start + + @property + def crm_id(self): + """Gets the crm_id of this SubscriptionCharge. # noqa: E501 + + + :return: The crm_id of this SubscriptionCharge. # noqa: E501 + :rtype: str + """ + return self._crm_id + + @crm_id.setter + def crm_id(self, crm_id): + """Sets the crm_id of this SubscriptionCharge. + + + :param crm_id: The crm_id of this SubscriptionCharge. # noqa: E501 + :type: str + """ + + self._crm_id = crm_id + + @property + def type(self): + """Gets the type of this SubscriptionCharge. # noqa: E501 + + + :return: The type of this SubscriptionCharge. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this SubscriptionCharge. + + + :param type: The type of this SubscriptionCharge. # noqa: E501 + :type: str + """ + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + + self._type = type + + def get_real_child_model(self, data): + """Returns the real base class specified by the discriminator""" + discriminator_value = data[self.discriminator].lower() + return self.discriminator_value_class_map.get(discriminator_value) + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -750,29 +969,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(SubscriptionCharge, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, SubscriptionCharge): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/subscription_charge_paged_metadata.py b/billforward/models/subscription_charge_paged_metadata.py deleted file mode 100644 index d593d0f..0000000 --- a/billforward/models/subscription_charge_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class SubscriptionChargePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - SubscriptionChargePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[SubscriptionCharge]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this SubscriptionChargePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this SubscriptionChargePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this SubscriptionChargePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this SubscriptionChargePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this SubscriptionChargePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this SubscriptionChargePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this SubscriptionChargePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this SubscriptionChargePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this SubscriptionChargePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this SubscriptionChargePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this SubscriptionChargePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this SubscriptionChargePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this SubscriptionChargePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this SubscriptionChargePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this SubscriptionChargePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this SubscriptionChargePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this SubscriptionChargePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this SubscriptionChargePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this SubscriptionChargePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this SubscriptionChargePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this SubscriptionChargePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this SubscriptionChargePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this SubscriptionChargePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this SubscriptionChargePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this SubscriptionChargePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this SubscriptionChargePagedMetadata. - :rtype: list[SubscriptionCharge] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this SubscriptionChargePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this SubscriptionChargePagedMetadata. - :type: list[SubscriptionCharge] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/subscription_checkout_action_request.py b/billforward/models/subscription_checkout_action_request.py new file mode 100644 index 0000000..01d0545 --- /dev/null +++ b/billforward/models/subscription_checkout_action_request.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SubscriptionCheckoutActionRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'checkout': 'str', + 'account_id': 'str', + 'start': 'datetime', + 'coupon_codes': 'list[str]', + 'organization_id': 'str' + } + + attribute_map = { + 'checkout': 'checkout', + 'account_id': 'accountID', + 'start': 'start', + 'coupon_codes': 'couponCodes', + 'organization_id': 'organizationID' + } + + def __init__(self, checkout=None, account_id=None, start=None, coupon_codes=None, organization_id=None): # noqa: E501 + """SubscriptionCheckoutActionRequest - a model defined in Swagger""" # noqa: E501 + self._checkout = None + self._account_id = None + self._start = None + self._coupon_codes = None + self._organization_id = None + self.discriminator = None + if checkout is not None: + self.checkout = checkout + if account_id is not None: + self.account_id = account_id + if start is not None: + self.start = start + if coupon_codes is not None: + self.coupon_codes = coupon_codes + if organization_id is not None: + self.organization_id = organization_id + + @property + def checkout(self): + """Gets the checkout of this SubscriptionCheckoutActionRequest. # noqa: E501 + + + :return: The checkout of this SubscriptionCheckoutActionRequest. # noqa: E501 + :rtype: str + """ + return self._checkout + + @checkout.setter + def checkout(self, checkout): + """Sets the checkout of this SubscriptionCheckoutActionRequest. + + + :param checkout: The checkout of this SubscriptionCheckoutActionRequest. # noqa: E501 + :type: str + """ + + self._checkout = checkout + + @property + def account_id(self): + """Gets the account_id of this SubscriptionCheckoutActionRequest. # noqa: E501 + + + :return: The account_id of this SubscriptionCheckoutActionRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this SubscriptionCheckoutActionRequest. + + + :param account_id: The account_id of this SubscriptionCheckoutActionRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def start(self): + """Gets the start of this SubscriptionCheckoutActionRequest. # noqa: E501 + + + :return: The start of this SubscriptionCheckoutActionRequest. # noqa: E501 + :rtype: datetime + """ + return self._start + + @start.setter + def start(self, start): + """Sets the start of this SubscriptionCheckoutActionRequest. + + + :param start: The start of this SubscriptionCheckoutActionRequest. # noqa: E501 + :type: datetime + """ + + self._start = start + + @property + def coupon_codes(self): + """Gets the coupon_codes of this SubscriptionCheckoutActionRequest. # noqa: E501 + + + :return: The coupon_codes of this SubscriptionCheckoutActionRequest. # noqa: E501 + :rtype: list[str] + """ + return self._coupon_codes + + @coupon_codes.setter + def coupon_codes(self, coupon_codes): + """Sets the coupon_codes of this SubscriptionCheckoutActionRequest. + + + :param coupon_codes: The coupon_codes of this SubscriptionCheckoutActionRequest. # noqa: E501 + :type: list[str] + """ + + self._coupon_codes = coupon_codes + + @property + def organization_id(self): + """Gets the organization_id of this SubscriptionCheckoutActionRequest. # noqa: E501 + + + :return: The organization_id of this SubscriptionCheckoutActionRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SubscriptionCheckoutActionRequest. + + + :param organization_id: The organization_id of this SubscriptionCheckoutActionRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SubscriptionCheckoutActionRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SubscriptionCheckoutActionRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/subscription_checkout_definition_description.py b/billforward/models/subscription_checkout_definition_description.py new file mode 100644 index 0000000..d257483 --- /dev/null +++ b/billforward/models/subscription_checkout_definition_description.py @@ -0,0 +1,266 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SubscriptionCheckoutDefinitionDescription(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'id': 'str', + 'plan_id': 'str', + 'plan_name': 'str', + 'plan_public_name': 'str', + 'path': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'id': 'id', + 'plan_id': 'planID', + 'plan_name': 'planName', + 'plan_public_name': 'planPublicName', + 'path': 'path', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, id=None, plan_id=None, plan_name=None, plan_public_name=None, path=None, organization_id=None): # noqa: E501 + """SubscriptionCheckoutDefinitionDescription - a model defined in Swagger""" # noqa: E501 + self._created = None + self._id = None + self._plan_id = None + self._plan_name = None + self._plan_public_name = None + self._path = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if id is not None: + self.id = id + if plan_id is not None: + self.plan_id = plan_id + if plan_name is not None: + self.plan_name = plan_name + if plan_public_name is not None: + self.plan_public_name = plan_public_name + if path is not None: + self.path = path + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + + + :return: The created of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this SubscriptionCheckoutDefinitionDescription. + + + :param created: The created of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def id(self): + """Gets the id of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + + + :return: The id of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this SubscriptionCheckoutDefinitionDescription. + + + :param id: The id of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def plan_id(self): + """Gets the plan_id of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + + + :return: The plan_id of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :rtype: str + """ + return self._plan_id + + @plan_id.setter + def plan_id(self, plan_id): + """Sets the plan_id of this SubscriptionCheckoutDefinitionDescription. + + + :param plan_id: The plan_id of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :type: str + """ + + self._plan_id = plan_id + + @property + def plan_name(self): + """Gets the plan_name of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + + + :return: The plan_name of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :rtype: str + """ + return self._plan_name + + @plan_name.setter + def plan_name(self, plan_name): + """Sets the plan_name of this SubscriptionCheckoutDefinitionDescription. + + + :param plan_name: The plan_name of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :type: str + """ + + self._plan_name = plan_name + + @property + def plan_public_name(self): + """Gets the plan_public_name of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + + + :return: The plan_public_name of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :rtype: str + """ + return self._plan_public_name + + @plan_public_name.setter + def plan_public_name(self, plan_public_name): + """Sets the plan_public_name of this SubscriptionCheckoutDefinitionDescription. + + + :param plan_public_name: The plan_public_name of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :type: str + """ + + self._plan_public_name = plan_public_name + + @property + def path(self): + """Gets the path of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + + + :return: The path of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :rtype: str + """ + return self._path + + @path.setter + def path(self, path): + """Sets the path of this SubscriptionCheckoutDefinitionDescription. + + + :param path: The path of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :type: str + """ + + self._path = path + + @property + def organization_id(self): + """Gets the organization_id of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + + + :return: The organization_id of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SubscriptionCheckoutDefinitionDescription. + + + :param organization_id: The organization_id of this SubscriptionCheckoutDefinitionDescription. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SubscriptionCheckoutDefinitionDescription, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SubscriptionCheckoutDefinitionDescription): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/subscription_checkout_response.py b/billforward/models/subscription_checkout_response.py new file mode 100644 index 0000000..c95ca63 --- /dev/null +++ b/billforward/models/subscription_checkout_response.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SubscriptionCheckoutResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'quote': 'ApiQuote', + 'plan_display_name': 'str', + 'path': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'quote': 'quote', + 'plan_display_name': 'planDisplayName', + 'path': 'path', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, quote=None, plan_display_name=None, path=None, organization_id=None): # noqa: E501 + """SubscriptionCheckoutResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._quote = None + self._plan_display_name = None + self._path = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if quote is not None: + self.quote = quote + if plan_display_name is not None: + self.plan_display_name = plan_display_name + if path is not None: + self.path = path + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this SubscriptionCheckoutResponse. # noqa: E501 + + + :return: The created of this SubscriptionCheckoutResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this SubscriptionCheckoutResponse. + + + :param created: The created of this SubscriptionCheckoutResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def quote(self): + """Gets the quote of this SubscriptionCheckoutResponse. # noqa: E501 + + + :return: The quote of this SubscriptionCheckoutResponse. # noqa: E501 + :rtype: ApiQuote + """ + return self._quote + + @quote.setter + def quote(self, quote): + """Sets the quote of this SubscriptionCheckoutResponse. + + + :param quote: The quote of this SubscriptionCheckoutResponse. # noqa: E501 + :type: ApiQuote + """ + + self._quote = quote + + @property + def plan_display_name(self): + """Gets the plan_display_name of this SubscriptionCheckoutResponse. # noqa: E501 + + + :return: The plan_display_name of this SubscriptionCheckoutResponse. # noqa: E501 + :rtype: str + """ + return self._plan_display_name + + @plan_display_name.setter + def plan_display_name(self, plan_display_name): + """Sets the plan_display_name of this SubscriptionCheckoutResponse. + + + :param plan_display_name: The plan_display_name of this SubscriptionCheckoutResponse. # noqa: E501 + :type: str + """ + + self._plan_display_name = plan_display_name + + @property + def path(self): + """Gets the path of this SubscriptionCheckoutResponse. # noqa: E501 + + + :return: The path of this SubscriptionCheckoutResponse. # noqa: E501 + :rtype: str + """ + return self._path + + @path.setter + def path(self, path): + """Sets the path of this SubscriptionCheckoutResponse. + + + :param path: The path of this SubscriptionCheckoutResponse. # noqa: E501 + :type: str + """ + + self._path = path + + @property + def organization_id(self): + """Gets the organization_id of this SubscriptionCheckoutResponse. # noqa: E501 + + + :return: The organization_id of this SubscriptionCheckoutResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SubscriptionCheckoutResponse. + + + :param organization_id: The organization_id of this SubscriptionCheckoutResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SubscriptionCheckoutResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SubscriptionCheckoutResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/subscription_ltv_result_paged_metadata.py b/billforward/models/subscription_ltv_result_paged_metadata.py deleted file mode 100644 index 29f9a79..0000000 --- a/billforward/models/subscription_ltv_result_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class SubscriptionLTVResultPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - SubscriptionLTVResultPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this SubscriptionLTVResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this SubscriptionLTVResultPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this SubscriptionLTVResultPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this SubscriptionLTVResultPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this SubscriptionLTVResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this SubscriptionLTVResultPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this SubscriptionLTVResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this SubscriptionLTVResultPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this SubscriptionLTVResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this SubscriptionLTVResultPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this SubscriptionLTVResultPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this SubscriptionLTVResultPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this SubscriptionLTVResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this SubscriptionLTVResultPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this SubscriptionLTVResultPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this SubscriptionLTVResultPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this SubscriptionLTVResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this SubscriptionLTVResultPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this SubscriptionLTVResultPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this SubscriptionLTVResultPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this SubscriptionLTVResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this SubscriptionLTVResultPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this SubscriptionLTVResultPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this SubscriptionLTVResultPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this SubscriptionLTVResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this SubscriptionLTVResultPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this SubscriptionLTVResultPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this SubscriptionLTVResultPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/subscription_paged_metadata.py b/billforward/models/subscription_paged_metadata.py deleted file mode 100644 index 0bbd6a0..0000000 --- a/billforward/models/subscription_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class SubscriptionPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - SubscriptionPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Subscription]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this SubscriptionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this SubscriptionPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this SubscriptionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this SubscriptionPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this SubscriptionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this SubscriptionPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this SubscriptionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this SubscriptionPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this SubscriptionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this SubscriptionPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this SubscriptionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this SubscriptionPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this SubscriptionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this SubscriptionPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this SubscriptionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this SubscriptionPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this SubscriptionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this SubscriptionPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this SubscriptionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this SubscriptionPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this SubscriptionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this SubscriptionPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this SubscriptionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this SubscriptionPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this SubscriptionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this SubscriptionPagedMetadata. - :rtype: list[Subscription] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this SubscriptionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this SubscriptionPagedMetadata. - :type: list[Subscription] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/subscription_revive_amendment.py b/billforward/models/subscription_revive_amendment.py new file mode 100644 index 0000000..9144c49 --- /dev/null +++ b/billforward/models/subscription_revive_amendment.py @@ -0,0 +1,148 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class SubscriptionReviveAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'revive_children': 'bool', + 'failed_payment_behaviour': 'str' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'revive_children': 'reviveChildren', + 'failed_payment_behaviour': 'failedPaymentBehaviour' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, revive_children=None, failed_payment_behaviour=None, *args, **kwargs): # noqa: E501 + """SubscriptionReviveAmendment - a model defined in Swagger""" # noqa: E501 + self._revive_children = None + self._failed_payment_behaviour = None + self.discriminator = None + if revive_children is not None: + self.revive_children = revive_children + if failed_payment_behaviour is not None: + self.failed_payment_behaviour = failed_payment_behaviour + Amendment.__init__(self, *args, **kwargs) + + @property + def revive_children(self): + """Gets the revive_children of this SubscriptionReviveAmendment. # noqa: E501 + + + :return: The revive_children of this SubscriptionReviveAmendment. # noqa: E501 + :rtype: bool + """ + return self._revive_children + + @revive_children.setter + def revive_children(self, revive_children): + """Sets the revive_children of this SubscriptionReviveAmendment. + + + :param revive_children: The revive_children of this SubscriptionReviveAmendment. # noqa: E501 + :type: bool + """ + + self._revive_children = revive_children + + @property + def failed_payment_behaviour(self): + """Gets the failed_payment_behaviour of this SubscriptionReviveAmendment. # noqa: E501 + + + :return: The failed_payment_behaviour of this SubscriptionReviveAmendment. # noqa: E501 + :rtype: str + """ + return self._failed_payment_behaviour + + @failed_payment_behaviour.setter + def failed_payment_behaviour(self, failed_payment_behaviour): + """Sets the failed_payment_behaviour of this SubscriptionReviveAmendment. + + + :param failed_payment_behaviour: The failed_payment_behaviour of this SubscriptionReviveAmendment. # noqa: E501 + :type: str + """ + allowed_values = ["CancelSubscription", "None"] # noqa: E501 + if failed_payment_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `failed_payment_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(failed_payment_behaviour, allowed_values) + ) + + self._failed_payment_behaviour = failed_payment_behaviour + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SubscriptionReviveAmendment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SubscriptionReviveAmendment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/subscription_revive_partial_request.py b/billforward/models/subscription_revive_partial_request.py new file mode 100644 index 0000000..4967264 --- /dev/null +++ b/billforward/models/subscription_revive_partial_request.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SubscriptionRevivePartialRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'resume': 'datetime' + } + + attribute_map = { + 'resume': 'resume' + } + + def __init__(self, resume=None): # noqa: E501 + """SubscriptionRevivePartialRequest - a model defined in Swagger""" # noqa: E501 + self._resume = None + self.discriminator = None + if resume is not None: + self.resume = resume + + @property + def resume(self): + """Gets the resume of this SubscriptionRevivePartialRequest. # noqa: E501 + + + :return: The resume of this SubscriptionRevivePartialRequest. # noqa: E501 + :rtype: datetime + """ + return self._resume + + @resume.setter + def resume(self, resume): + """Sets the resume of this SubscriptionRevivePartialRequest. + + + :param resume: The resume of this SubscriptionRevivePartialRequest. # noqa: E501 + :type: datetime + """ + + self._resume = resume + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SubscriptionRevivePartialRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SubscriptionRevivePartialRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/subscription_revive_request.py b/billforward/models/subscription_revive_request.py new file mode 100644 index 0000000..f7a400c --- /dev/null +++ b/billforward/models/subscription_revive_request.py @@ -0,0 +1,252 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SubscriptionReviveRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'subscription_id': 'str', + 'state': 'str', + 'start': 'datetime', + 'failed_payment_behaviour': 'str', + 'revive_children': 'bool' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'subscription_id': 'subscriptionID', + 'state': 'state', + 'start': 'start', + 'failed_payment_behaviour': 'failedPaymentBehaviour', + 'revive_children': 'reviveChildren' + } + + def __init__(self, organization_id=None, subscription_id=None, state=None, start=None, failed_payment_behaviour=None, revive_children=None): # noqa: E501 + """SubscriptionReviveRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._subscription_id = None + self._state = None + self._start = None + self._failed_payment_behaviour = None + self._revive_children = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if subscription_id is not None: + self.subscription_id = subscription_id + if state is not None: + self.state = state + if start is not None: + self.start = start + if failed_payment_behaviour is not None: + self.failed_payment_behaviour = failed_payment_behaviour + if revive_children is not None: + self.revive_children = revive_children + + @property + def organization_id(self): + """Gets the organization_id of this SubscriptionReviveRequest. # noqa: E501 + + + :return: The organization_id of this SubscriptionReviveRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SubscriptionReviveRequest. + + + :param organization_id: The organization_id of this SubscriptionReviveRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def subscription_id(self): + """Gets the subscription_id of this SubscriptionReviveRequest. # noqa: E501 + + + :return: The subscription_id of this SubscriptionReviveRequest. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this SubscriptionReviveRequest. + + + :param subscription_id: The subscription_id of this SubscriptionReviveRequest. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def state(self): + """Gets the state of this SubscriptionReviveRequest. # noqa: E501 + + + :return: The state of this SubscriptionReviveRequest. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this SubscriptionReviveRequest. + + + :param state: The state of this SubscriptionReviveRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Provisioned", "AwaitingPayment"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def start(self): + """Gets the start of this SubscriptionReviveRequest. # noqa: E501 + + + :return: The start of this SubscriptionReviveRequest. # noqa: E501 + :rtype: datetime + """ + return self._start + + @start.setter + def start(self, start): + """Sets the start of this SubscriptionReviveRequest. + + + :param start: The start of this SubscriptionReviveRequest. # noqa: E501 + :type: datetime + """ + + self._start = start + + @property + def failed_payment_behaviour(self): + """Gets the failed_payment_behaviour of this SubscriptionReviveRequest. # noqa: E501 + + + :return: The failed_payment_behaviour of this SubscriptionReviveRequest. # noqa: E501 + :rtype: str + """ + return self._failed_payment_behaviour + + @failed_payment_behaviour.setter + def failed_payment_behaviour(self, failed_payment_behaviour): + """Sets the failed_payment_behaviour of this SubscriptionReviveRequest. + + + :param failed_payment_behaviour: The failed_payment_behaviour of this SubscriptionReviveRequest. # noqa: E501 + :type: str + """ + allowed_values = ["CancelSubscription", "None"] # noqa: E501 + if failed_payment_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `failed_payment_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(failed_payment_behaviour, allowed_values) + ) + + self._failed_payment_behaviour = failed_payment_behaviour + + @property + def revive_children(self): + """Gets the revive_children of this SubscriptionReviveRequest. # noqa: E501 + + + :return: The revive_children of this SubscriptionReviveRequest. # noqa: E501 + :rtype: bool + """ + return self._revive_children + + @revive_children.setter + def revive_children(self, revive_children): + """Sets the revive_children of this SubscriptionReviveRequest. + + + :param revive_children: The revive_children of this SubscriptionReviveRequest. # noqa: E501 + :type: bool + """ + + self._revive_children = revive_children + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SubscriptionReviveRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SubscriptionReviveRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/swagger_type_list.py b/billforward/models/swagger_type_list.py deleted file mode 100644 index 66a8b35..0000000 --- a/billforward/models/swagger_type_list.py +++ /dev/null @@ -1,150 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class SwaggerTypeList(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, component_change=None, mappings=None): - """ - SwaggerTypeList - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'component_change': 'ComponentChange', - 'mappings': 'PricingComponentValueMigrationAmendmentMapping' - } - - self.attribute_map = { - 'component_change': 'componentChange', - 'mappings': 'mappings' - } - - self._component_change = component_change - self._mappings = mappings - - @property - def component_change(self): - """ - Gets the component_change of this SwaggerTypeList. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The component_change of this SwaggerTypeList. - :rtype: ComponentChange - """ - return self._component_change - - @component_change.setter - def component_change(self, component_change): - """ - Sets the component_change of this SwaggerTypeList. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param component_change: The component_change of this SwaggerTypeList. - :type: ComponentChange - """ - - self._component_change = component_change - - @property - def mappings(self): - """ - Gets the mappings of this SwaggerTypeList. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The mappings of this SwaggerTypeList. - :rtype: PricingComponentValueMigrationAmendmentMapping - """ - return self._mappings - - @mappings.setter - def mappings(self, mappings): - """ - Sets the mappings of this SwaggerTypeList. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param mappings: The mappings of this SwaggerTypeList. - :type: PricingComponentValueMigrationAmendmentMapping - """ - - self._mappings = mappings - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/swagger_type_list_inv.py b/billforward/models/swagger_type_list_inv.py index c238290..1b0097a 100644 --- a/billforward/models/swagger_type_list_inv.py +++ b/billforward/models/swagger_type_list_inv.py @@ -1,85 +1,73 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class SwaggerTypeListInv(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, payment_retry_request=None): - """ - SwaggerTypeListInv - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'payment_retry_request': 'PaymentRetryRequest' - } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'payment_retry_request': 'PaymentRetryRequest' + } - self.attribute_map = { - 'payment_retry_request': 'paymentRetryRequest' - } + attribute_map = { + 'payment_retry_request': 'paymentRetryRequest' + } - self._payment_retry_request = payment_retry_request + def __init__(self, payment_retry_request=None): # noqa: E501 + """SwaggerTypeListInv - a model defined in Swagger""" # noqa: E501 + self._payment_retry_request = None + self.discriminator = None + if payment_retry_request is not None: + self.payment_retry_request = payment_retry_request @property def payment_retry_request(self): - """ - Gets the payment_retry_request of this SwaggerTypeListInv. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the payment_retry_request of this SwaggerTypeListInv. # noqa: E501 + - :return: The payment_retry_request of this SwaggerTypeListInv. + :return: The payment_retry_request of this SwaggerTypeListInv. # noqa: E501 :rtype: PaymentRetryRequest """ return self._payment_retry_request @payment_retry_request.setter def payment_retry_request(self, payment_retry_request): - """ - Sets the payment_retry_request of this SwaggerTypeListInv. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the payment_retry_request of this SwaggerTypeListInv. + - :param payment_retry_request: The payment_retry_request of this SwaggerTypeListInv. + :param payment_retry_request: The payment_retry_request of this SwaggerTypeListInv. # noqa: E501 :type: PaymentRetryRequest """ self._payment_retry_request = payment_retry_request def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -96,29 +84,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(SwaggerTypeListInv, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, SwaggerTypeListInv): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/swagger_type_list_subs.py b/billforward/models/swagger_type_list_subs.py index 61ec656..960cede 100644 --- a/billforward/models/swagger_type_list_subs.py +++ b/billforward/models/swagger_type_list_subs.py @@ -1,76 +1,94 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class SwaggerTypeListSubs(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, credit_subscription_request=None, add_payment_method_request=None): - """ - SwaggerTypeListSubs - a model defined in Swagger + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'update_pricing_component_value_response': 'UpdatePricingComponentValueResponse', + 'credit_subscription_request': 'CreditSubscriptionRequest', + 'add_payment_method_request': 'AddPaymentMethodRequest' + } + + attribute_map = { + 'update_pricing_component_value_response': 'updatePricingComponentValueResponse', + 'credit_subscription_request': 'creditSubscriptionRequest', + 'add_payment_method_request': 'addPaymentMethodRequest' + } + + def __init__(self, update_pricing_component_value_response=None, credit_subscription_request=None, add_payment_method_request=None): # noqa: E501 + """SwaggerTypeListSubs - a model defined in Swagger""" # noqa: E501 + self._update_pricing_component_value_response = None + self._credit_subscription_request = None + self._add_payment_method_request = None + self.discriminator = None + if update_pricing_component_value_response is not None: + self.update_pricing_component_value_response = update_pricing_component_value_response + if credit_subscription_request is not None: + self.credit_subscription_request = credit_subscription_request + if add_payment_method_request is not None: + self.add_payment_method_request = add_payment_method_request + + @property + def update_pricing_component_value_response(self): + """Gets the update_pricing_component_value_response of this SwaggerTypeListSubs. # noqa: E501 + - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. + :return: The update_pricing_component_value_response of this SwaggerTypeListSubs. # noqa: E501 + :rtype: UpdatePricingComponentValueResponse """ - self.swagger_types = { - 'credit_subscription_request': 'CreditSubscriptionRequest', - 'add_payment_method_request': 'AddPaymentMethodRequest' - } + return self._update_pricing_component_value_response - self.attribute_map = { - 'credit_subscription_request': 'creditSubscriptionRequest', - 'add_payment_method_request': 'addPaymentMethodRequest' - } + @update_pricing_component_value_response.setter + def update_pricing_component_value_response(self, update_pricing_component_value_response): + """Sets the update_pricing_component_value_response of this SwaggerTypeListSubs. - self._credit_subscription_request = credit_subscription_request - self._add_payment_method_request = add_payment_method_request + + :param update_pricing_component_value_response: The update_pricing_component_value_response of this SwaggerTypeListSubs. # noqa: E501 + :type: UpdatePricingComponentValueResponse + """ + + self._update_pricing_component_value_response = update_pricing_component_value_response @property def credit_subscription_request(self): - """ - Gets the credit_subscription_request of this SwaggerTypeListSubs. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the credit_subscription_request of this SwaggerTypeListSubs. # noqa: E501 + - :return: The credit_subscription_request of this SwaggerTypeListSubs. + :return: The credit_subscription_request of this SwaggerTypeListSubs. # noqa: E501 :rtype: CreditSubscriptionRequest """ return self._credit_subscription_request @credit_subscription_request.setter def credit_subscription_request(self, credit_subscription_request): - """ - Sets the credit_subscription_request of this SwaggerTypeListSubs. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the credit_subscription_request of this SwaggerTypeListSubs. + - :param credit_subscription_request: The credit_subscription_request of this SwaggerTypeListSubs. + :param credit_subscription_request: The credit_subscription_request of this SwaggerTypeListSubs. # noqa: E501 :type: CreditSubscriptionRequest """ @@ -78,34 +96,30 @@ def credit_subscription_request(self, credit_subscription_request): @property def add_payment_method_request(self): - """ - Gets the add_payment_method_request of this SwaggerTypeListSubs. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the add_payment_method_request of this SwaggerTypeListSubs. # noqa: E501 - :return: The add_payment_method_request of this SwaggerTypeListSubs. + + :return: The add_payment_method_request of this SwaggerTypeListSubs. # noqa: E501 :rtype: AddPaymentMethodRequest """ return self._add_payment_method_request @add_payment_method_request.setter def add_payment_method_request(self, add_payment_method_request): - """ - Sets the add_payment_method_request of this SwaggerTypeListSubs. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the add_payment_method_request of this SwaggerTypeListSubs. - :param add_payment_method_request: The add_payment_method_request of this SwaggerTypeListSubs. + + :param add_payment_method_request: The add_payment_method_request of this SwaggerTypeListSubs. # noqa: E501 :type: AddPaymentMethodRequest """ self._add_payment_method_request = add_payment_method_request def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -122,29 +136,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(SwaggerTypeListSubs, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, SwaggerTypeListSubs): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/sync_action_request.py b/billforward/models/sync_action_request.py new file mode 100644 index 0000000..30367af --- /dev/null +++ b/billforward/models/sync_action_request.py @@ -0,0 +1,142 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class SyncActionRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'action': 'str' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'action': 'action' + } + + def __init__(self, organization_id=None, action=None): # noqa: E501 + """SyncActionRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._action = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if action is not None: + self.action = action + + @property + def organization_id(self): + """Gets the organization_id of this SyncActionRequest. # noqa: E501 + + + :return: The organization_id of this SyncActionRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this SyncActionRequest. + + + :param organization_id: The organization_id of this SyncActionRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def action(self): + """Gets the action of this SyncActionRequest. # noqa: E501 + + + :return: The action of this SyncActionRequest. # noqa: E501 + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """Sets the action of this SyncActionRequest. + + + :param action: The action of this SyncActionRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Restart", "Cancel"] # noqa: E501 + if action not in allowed_values: + raise ValueError( + "Invalid value for `action` ({0}), must be one of {1}" # noqa: E501 + .format(action, allowed_values) + ) + + self._action = action + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(SyncActionRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SyncActionRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/tax_line.py b/billforward/models/tax_line.py new file mode 100644 index 0000000..b013557 --- /dev/null +++ b/billforward/models/tax_line.py @@ -0,0 +1,349 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TaxLine(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'id': 'str', + 'invoice_id': 'str', + 'organization_id': 'str', + 'taxation_strategy_id': 'str', + 'name': 'str', + 'percentage': 'float', + 'amount': 'float', + 'linked_charge_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'id': 'id', + 'invoice_id': 'invoiceID', + 'organization_id': 'organizationID', + 'taxation_strategy_id': 'taxationStrategyID', + 'name': 'name', + 'percentage': 'percentage', + 'amount': 'amount', + 'linked_charge_id': 'linkedChargeID' + } + + def __init__(self, created=None, changed_by=None, id=None, invoice_id=None, organization_id=None, taxation_strategy_id=None, name=None, percentage=None, amount=None, linked_charge_id=None): # noqa: E501 + """TaxLine - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._id = None + self._invoice_id = None + self._organization_id = None + self._taxation_strategy_id = None + self._name = None + self._percentage = None + self._amount = None + self._linked_charge_id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if id is not None: + self.id = id + self.invoice_id = invoice_id + self.organization_id = organization_id + if taxation_strategy_id is not None: + self.taxation_strategy_id = taxation_strategy_id + self.name = name + self.percentage = percentage + self.amount = amount + if linked_charge_id is not None: + self.linked_charge_id = linked_charge_id + + @property + def created(self): + """Gets the created of this TaxLine. # noqa: E501 + + + :return: The created of this TaxLine. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this TaxLine. + + + :param created: The created of this TaxLine. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this TaxLine. # noqa: E501 + + + :return: The changed_by of this TaxLine. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this TaxLine. + + + :param changed_by: The changed_by of this TaxLine. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def id(self): + """Gets the id of this TaxLine. # noqa: E501 + + + :return: The id of this TaxLine. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this TaxLine. + + + :param id: The id of this TaxLine. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def invoice_id(self): + """Gets the invoice_id of this TaxLine. # noqa: E501 + + + :return: The invoice_id of this TaxLine. # noqa: E501 + :rtype: str + """ + return self._invoice_id + + @invoice_id.setter + def invoice_id(self, invoice_id): + """Sets the invoice_id of this TaxLine. + + + :param invoice_id: The invoice_id of this TaxLine. # noqa: E501 + :type: str + """ + if invoice_id is None: + raise ValueError("Invalid value for `invoice_id`, must not be `None`") # noqa: E501 + + self._invoice_id = invoice_id + + @property + def organization_id(self): + """Gets the organization_id of this TaxLine. # noqa: E501 + + + :return: The organization_id of this TaxLine. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this TaxLine. + + + :param organization_id: The organization_id of this TaxLine. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def taxation_strategy_id(self): + """Gets the taxation_strategy_id of this TaxLine. # noqa: E501 + + + :return: The taxation_strategy_id of this TaxLine. # noqa: E501 + :rtype: str + """ + return self._taxation_strategy_id + + @taxation_strategy_id.setter + def taxation_strategy_id(self, taxation_strategy_id): + """Sets the taxation_strategy_id of this TaxLine. + + + :param taxation_strategy_id: The taxation_strategy_id of this TaxLine. # noqa: E501 + :type: str + """ + + self._taxation_strategy_id = taxation_strategy_id + + @property + def name(self): + """Gets the name of this TaxLine. # noqa: E501 + + + :return: The name of this TaxLine. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this TaxLine. + + + :param name: The name of this TaxLine. # noqa: E501 + :type: str + """ + if name is None: + raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501 + + self._name = name + + @property + def percentage(self): + """Gets the percentage of this TaxLine. # noqa: E501 + + + :return: The percentage of this TaxLine. # noqa: E501 + :rtype: float + """ + return self._percentage + + @percentage.setter + def percentage(self, percentage): + """Sets the percentage of this TaxLine. + + + :param percentage: The percentage of this TaxLine. # noqa: E501 + :type: float + """ + if percentage is None: + raise ValueError("Invalid value for `percentage`, must not be `None`") # noqa: E501 + + self._percentage = percentage + + @property + def amount(self): + """Gets the amount of this TaxLine. # noqa: E501 + + + :return: The amount of this TaxLine. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this TaxLine. + + + :param amount: The amount of this TaxLine. # noqa: E501 + :type: float + """ + if amount is None: + raise ValueError("Invalid value for `amount`, must not be `None`") # noqa: E501 + + self._amount = amount + + @property + def linked_charge_id(self): + """Gets the linked_charge_id of this TaxLine. # noqa: E501 + + + :return: The linked_charge_id of this TaxLine. # noqa: E501 + :rtype: str + """ + return self._linked_charge_id + + @linked_charge_id.setter + def linked_charge_id(self, linked_charge_id): + """Sets the linked_charge_id of this TaxLine. + + + :param linked_charge_id: The linked_charge_id of this TaxLine. # noqa: E501 + :type: str + """ + + self._linked_charge_id = linked_charge_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TaxLine, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TaxLine): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/taxation_link_paged_metadata.py b/billforward/models/taxation_link_paged_metadata.py deleted file mode 100644 index a395299..0000000 --- a/billforward/models/taxation_link_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class TaxationLinkPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - TaxationLinkPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this TaxationLinkPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this TaxationLinkPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this TaxationLinkPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this TaxationLinkPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this TaxationLinkPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this TaxationLinkPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this TaxationLinkPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this TaxationLinkPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this TaxationLinkPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this TaxationLinkPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this TaxationLinkPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this TaxationLinkPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this TaxationLinkPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this TaxationLinkPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this TaxationLinkPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this TaxationLinkPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this TaxationLinkPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this TaxationLinkPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this TaxationLinkPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this TaxationLinkPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this TaxationLinkPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this TaxationLinkPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this TaxationLinkPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this TaxationLinkPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this TaxationLinkPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this TaxationLinkPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this TaxationLinkPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this TaxationLinkPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/taxation_strategy.py b/billforward/models/taxation_strategy.py new file mode 100644 index 0000000..a33df95 --- /dev/null +++ b/billforward/models/taxation_strategy.py @@ -0,0 +1,519 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TaxationStrategy(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'version_id': 'str', + 'organization_id': 'str', + 'country': 'str', + 'province': 'str', + 'currency': 'CreditNoteCurrency', + 'name': 'str', + 'percentage': 'float', + 'applied_at': 'str', + 'deleted': 'bool', + 'default_taxation_strategy': 'bool', + 'valid_from': 'datetime', + 'valid_till': 'datetime' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'version_id': 'versionID', + 'organization_id': 'organizationID', + 'country': 'country', + 'province': 'province', + 'currency': 'currency', + 'name': 'name', + 'percentage': 'percentage', + 'applied_at': 'appliedAt', + 'deleted': 'deleted', + 'default_taxation_strategy': 'defaultTaxationStrategy', + 'valid_from': 'validFrom', + 'valid_till': 'validTill' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, version_id=None, organization_id=None, country=None, province=None, currency=None, name=None, percentage=None, applied_at=None, deleted=None, default_taxation_strategy=None, valid_from=None, valid_till=None): # noqa: E501 + """TaxationStrategy - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._version_id = None + self._organization_id = None + self._country = None + self._province = None + self._currency = None + self._name = None + self._percentage = None + self._applied_at = None + self._deleted = None + self._default_taxation_strategy = None + self._valid_from = None + self._valid_till = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + self.id = id + if version_id is not None: + self.version_id = version_id + if organization_id is not None: + self.organization_id = organization_id + self.country = country + if province is not None: + self.province = province + self.currency = currency + self.name = name + self.percentage = percentage + if applied_at is not None: + self.applied_at = applied_at + self.deleted = deleted + if default_taxation_strategy is not None: + self.default_taxation_strategy = default_taxation_strategy + self.valid_from = valid_from + if valid_till is not None: + self.valid_till = valid_till + + @property + def created(self): + """Gets the created of this TaxationStrategy. # noqa: E501 + + + :return: The created of this TaxationStrategy. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this TaxationStrategy. + + + :param created: The created of this TaxationStrategy. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this TaxationStrategy. # noqa: E501 + + + :return: The changed_by of this TaxationStrategy. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this TaxationStrategy. + + + :param changed_by: The changed_by of this TaxationStrategy. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this TaxationStrategy. # noqa: E501 + + + :return: The updated of this TaxationStrategy. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this TaxationStrategy. + + + :param updated: The updated of this TaxationStrategy. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this TaxationStrategy. # noqa: E501 + + + :return: The id of this TaxationStrategy. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this TaxationStrategy. + + + :param id: The id of this TaxationStrategy. # noqa: E501 + :type: str + """ + if id is None: + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + @property + def version_id(self): + """Gets the version_id of this TaxationStrategy. # noqa: E501 + + + :return: The version_id of this TaxationStrategy. # noqa: E501 + :rtype: str + """ + return self._version_id + + @version_id.setter + def version_id(self, version_id): + """Sets the version_id of this TaxationStrategy. + + + :param version_id: The version_id of this TaxationStrategy. # noqa: E501 + :type: str + """ + + self._version_id = version_id + + @property + def organization_id(self): + """Gets the organization_id of this TaxationStrategy. # noqa: E501 + + + :return: The organization_id of this TaxationStrategy. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this TaxationStrategy. + + + :param organization_id: The organization_id of this TaxationStrategy. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def country(self): + """Gets the country of this TaxationStrategy. # noqa: E501 + + + :return: The country of this TaxationStrategy. # noqa: E501 + :rtype: str + """ + return self._country + + @country.setter + def country(self, country): + """Sets the country of this TaxationStrategy. + + + :param country: The country of this TaxationStrategy. # noqa: E501 + :type: str + """ + if country is None: + raise ValueError("Invalid value for `country`, must not be `None`") # noqa: E501 + allowed_values = ["UK", "USA", "Canada", "Mexico", "Brazil", "Argentina", "China", "France", "Germany", "Ireland", "Nigeria", "Bangladesh", "India", "Afghanistan", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AR", "AS", "AT", "AU", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"] # noqa: E501 + if country not in allowed_values: + raise ValueError( + "Invalid value for `country` ({0}), must be one of {1}" # noqa: E501 + .format(country, allowed_values) + ) + + self._country = country + + @property + def province(self): + """Gets the province of this TaxationStrategy. # noqa: E501 + + + :return: The province of this TaxationStrategy. # noqa: E501 + :rtype: str + """ + return self._province + + @province.setter + def province(self, province): + """Sets the province of this TaxationStrategy. + + + :param province: The province of this TaxationStrategy. # noqa: E501 + :type: str + """ + + self._province = province + + @property + def currency(self): + """Gets the currency of this TaxationStrategy. # noqa: E501 + + + :return: The currency of this TaxationStrategy. # noqa: E501 + :rtype: CreditNoteCurrency + """ + return self._currency + + @currency.setter + def currency(self, currency): + """Sets the currency of this TaxationStrategy. + + + :param currency: The currency of this TaxationStrategy. # noqa: E501 + :type: CreditNoteCurrency + """ + if currency is None: + raise ValueError("Invalid value for `currency`, must not be `None`") # noqa: E501 + + self._currency = currency + + @property + def name(self): + """Gets the name of this TaxationStrategy. # noqa: E501 + + + :return: The name of this TaxationStrategy. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this TaxationStrategy. + + + :param name: The name of this TaxationStrategy. # noqa: E501 + :type: str + """ + if name is None: + raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501 + + self._name = name + + @property + def percentage(self): + """Gets the percentage of this TaxationStrategy. # noqa: E501 + + + :return: The percentage of this TaxationStrategy. # noqa: E501 + :rtype: float + """ + return self._percentage + + @percentage.setter + def percentage(self, percentage): + """Sets the percentage of this TaxationStrategy. + + + :param percentage: The percentage of this TaxationStrategy. # noqa: E501 + :type: float + """ + if percentage is None: + raise ValueError("Invalid value for `percentage`, must not be `None`") # noqa: E501 + + self._percentage = percentage + + @property + def applied_at(self): + """Gets the applied_at of this TaxationStrategy. # noqa: E501 + + + :return: The applied_at of this TaxationStrategy. # noqa: E501 + :rtype: str + """ + return self._applied_at + + @applied_at.setter + def applied_at(self, applied_at): + """Sets the applied_at of this TaxationStrategy. + + + :param applied_at: The applied_at of this TaxationStrategy. # noqa: E501 + :type: str + """ + allowed_values = ["checkout", "immediate"] # noqa: E501 + if applied_at not in allowed_values: + raise ValueError( + "Invalid value for `applied_at` ({0}), must be one of {1}" # noqa: E501 + .format(applied_at, allowed_values) + ) + + self._applied_at = applied_at + + @property + def deleted(self): + """Gets the deleted of this TaxationStrategy. # noqa: E501 + + + :return: The deleted of this TaxationStrategy. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this TaxationStrategy. + + + :param deleted: The deleted of this TaxationStrategy. # noqa: E501 + :type: bool + """ + if deleted is None: + raise ValueError("Invalid value for `deleted`, must not be `None`") # noqa: E501 + + self._deleted = deleted + + @property + def default_taxation_strategy(self): + """Gets the default_taxation_strategy of this TaxationStrategy. # noqa: E501 + + + :return: The default_taxation_strategy of this TaxationStrategy. # noqa: E501 + :rtype: bool + """ + return self._default_taxation_strategy + + @default_taxation_strategy.setter + def default_taxation_strategy(self, default_taxation_strategy): + """Sets the default_taxation_strategy of this TaxationStrategy. + + + :param default_taxation_strategy: The default_taxation_strategy of this TaxationStrategy. # noqa: E501 + :type: bool + """ + + self._default_taxation_strategy = default_taxation_strategy + + @property + def valid_from(self): + """Gets the valid_from of this TaxationStrategy. # noqa: E501 + + + :return: The valid_from of this TaxationStrategy. # noqa: E501 + :rtype: datetime + """ + return self._valid_from + + @valid_from.setter + def valid_from(self, valid_from): + """Sets the valid_from of this TaxationStrategy. + + + :param valid_from: The valid_from of this TaxationStrategy. # noqa: E501 + :type: datetime + """ + if valid_from is None: + raise ValueError("Invalid value for `valid_from`, must not be `None`") # noqa: E501 + + self._valid_from = valid_from + + @property + def valid_till(self): + """Gets the valid_till of this TaxationStrategy. # noqa: E501 + + + :return: The valid_till of this TaxationStrategy. # noqa: E501 + :rtype: datetime + """ + return self._valid_till + + @valid_till.setter + def valid_till(self, valid_till): + """Sets the valid_till of this TaxationStrategy. + + + :param valid_till: The valid_till of this TaxationStrategy. # noqa: E501 + :type: datetime + """ + + self._valid_till = valid_till + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TaxationStrategy, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TaxationStrategy): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/taxation_strategy_paged_metadata.py b/billforward/models/taxation_strategy_paged_metadata.py deleted file mode 100644 index c0b57fa..0000000 --- a/billforward/models/taxation_strategy_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class TaxationStrategyPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - TaxationStrategyPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this TaxationStrategyPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this TaxationStrategyPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this TaxationStrategyPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this TaxationStrategyPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this TaxationStrategyPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this TaxationStrategyPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this TaxationStrategyPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this TaxationStrategyPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this TaxationStrategyPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this TaxationStrategyPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this TaxationStrategyPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this TaxationStrategyPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this TaxationStrategyPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this TaxationStrategyPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this TaxationStrategyPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this TaxationStrategyPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this TaxationStrategyPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this TaxationStrategyPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this TaxationStrategyPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this TaxationStrategyPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this TaxationStrategyPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this TaxationStrategyPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this TaxationStrategyPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this TaxationStrategyPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this TaxationStrategyPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this TaxationStrategyPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this TaxationStrategyPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this TaxationStrategyPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/tiered_advance_pricing_component.py b/billforward/models/tiered_advance_pricing_component.py new file mode 100644 index 0000000..aebc54c --- /dev/null +++ b/billforward/models/tiered_advance_pricing_component.py @@ -0,0 +1,330 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TieredAdvancePricingComponent(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'display_name': 'str', + 'upgrade_mode': 'str', + 'downgrade_mode': 'str', + 'unit': 'str', + 'default_quantity': 'int', + 'tiers': 'list[PricingTier]', + 'tax_code': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'display_name': 'displayName', + 'upgrade_mode': 'upgradeMode', + 'downgrade_mode': 'downgradeMode', + 'unit': 'unit', + 'default_quantity': 'defaultQuantity', + 'tiers': 'tiers', + 'tax_code': 'taxCode' + } + + def __init__(self, name=None, description=None, display_name=None, upgrade_mode=None, downgrade_mode=None, unit=None, default_quantity=None, tiers=None, tax_code=None): # noqa: E501 + """TieredAdvancePricingComponent - a model defined in Swagger""" # noqa: E501 + self._name = None + self._description = None + self._display_name = None + self._upgrade_mode = None + self._downgrade_mode = None + self._unit = None + self._default_quantity = None + self._tiers = None + self._tax_code = None + self.discriminator = None + if name is not None: + self.name = name + if description is not None: + self.description = description + if display_name is not None: + self.display_name = display_name + if upgrade_mode is not None: + self.upgrade_mode = upgrade_mode + if downgrade_mode is not None: + self.downgrade_mode = downgrade_mode + if unit is not None: + self.unit = unit + if default_quantity is not None: + self.default_quantity = default_quantity + if tiers is not None: + self.tiers = tiers + if tax_code is not None: + self.tax_code = tax_code + + @property + def name(self): + """Gets the name of this TieredAdvancePricingComponent. # noqa: E501 + + + :return: The name of this TieredAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this TieredAdvancePricingComponent. + + + :param name: The name of this TieredAdvancePricingComponent. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this TieredAdvancePricingComponent. # noqa: E501 + + + :return: The description of this TieredAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this TieredAdvancePricingComponent. + + + :param description: The description of this TieredAdvancePricingComponent. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def display_name(self): + """Gets the display_name of this TieredAdvancePricingComponent. # noqa: E501 + + + :return: The display_name of this TieredAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this TieredAdvancePricingComponent. + + + :param display_name: The display_name of this TieredAdvancePricingComponent. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def upgrade_mode(self): + """Gets the upgrade_mode of this TieredAdvancePricingComponent. # noqa: E501 + + + :return: The upgrade_mode of this TieredAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._upgrade_mode + + @upgrade_mode.setter + def upgrade_mode(self, upgrade_mode): + """Sets the upgrade_mode of this TieredAdvancePricingComponent. + + + :param upgrade_mode: The upgrade_mode of this TieredAdvancePricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["immediate", "delayed"] # noqa: E501 + if upgrade_mode not in allowed_values: + raise ValueError( + "Invalid value for `upgrade_mode` ({0}), must be one of {1}" # noqa: E501 + .format(upgrade_mode, allowed_values) + ) + + self._upgrade_mode = upgrade_mode + + @property + def downgrade_mode(self): + """Gets the downgrade_mode of this TieredAdvancePricingComponent. # noqa: E501 + + + :return: The downgrade_mode of this TieredAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._downgrade_mode + + @downgrade_mode.setter + def downgrade_mode(self, downgrade_mode): + """Sets the downgrade_mode of this TieredAdvancePricingComponent. + + + :param downgrade_mode: The downgrade_mode of this TieredAdvancePricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["immediate", "delayed"] # noqa: E501 + if downgrade_mode not in allowed_values: + raise ValueError( + "Invalid value for `downgrade_mode` ({0}), must be one of {1}" # noqa: E501 + .format(downgrade_mode, allowed_values) + ) + + self._downgrade_mode = downgrade_mode + + @property + def unit(self): + """Gets the unit of this TieredAdvancePricingComponent. # noqa: E501 + + + :return: The unit of this TieredAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._unit + + @unit.setter + def unit(self, unit): + """Sets the unit of this TieredAdvancePricingComponent. + + + :param unit: The unit of this TieredAdvancePricingComponent. # noqa: E501 + :type: str + """ + + self._unit = unit + + @property + def default_quantity(self): + """Gets the default_quantity of this TieredAdvancePricingComponent. # noqa: E501 + + + :return: The default_quantity of this TieredAdvancePricingComponent. # noqa: E501 + :rtype: int + """ + return self._default_quantity + + @default_quantity.setter + def default_quantity(self, default_quantity): + """Sets the default_quantity of this TieredAdvancePricingComponent. + + + :param default_quantity: The default_quantity of this TieredAdvancePricingComponent. # noqa: E501 + :type: int + """ + + self._default_quantity = default_quantity + + @property + def tiers(self): + """Gets the tiers of this TieredAdvancePricingComponent. # noqa: E501 + + + :return: The tiers of this TieredAdvancePricingComponent. # noqa: E501 + :rtype: list[PricingTier] + """ + return self._tiers + + @tiers.setter + def tiers(self, tiers): + """Sets the tiers of this TieredAdvancePricingComponent. + + + :param tiers: The tiers of this TieredAdvancePricingComponent. # noqa: E501 + :type: list[PricingTier] + """ + + self._tiers = tiers + + @property + def tax_code(self): + """Gets the tax_code of this TieredAdvancePricingComponent. # noqa: E501 + + + :return: The tax_code of this TieredAdvancePricingComponent. # noqa: E501 + :rtype: str + """ + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this TieredAdvancePricingComponent. + + + :param tax_code: The tax_code of this TieredAdvancePricingComponent. # noqa: E501 + :type: str + """ + + self._tax_code = tax_code + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TieredAdvancePricingComponent, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TieredAdvancePricingComponent): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/tiered_arrears_pricing_component.py b/billforward/models/tiered_arrears_pricing_component.py new file mode 100644 index 0000000..590b98f --- /dev/null +++ b/billforward/models/tiered_arrears_pricing_component.py @@ -0,0 +1,330 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TieredArrearsPricingComponent(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'display_name': 'str', + 'upgrade_mode': 'str', + 'downgrade_mode': 'str', + 'unit': 'str', + 'default_quantity': 'int', + 'tiers': 'list[PricingTier]', + 'tax_code': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'display_name': 'displayName', + 'upgrade_mode': 'upgradeMode', + 'downgrade_mode': 'downgradeMode', + 'unit': 'unit', + 'default_quantity': 'defaultQuantity', + 'tiers': 'tiers', + 'tax_code': 'taxCode' + } + + def __init__(self, name=None, description=None, display_name=None, upgrade_mode=None, downgrade_mode=None, unit=None, default_quantity=None, tiers=None, tax_code=None): # noqa: E501 + """TieredArrearsPricingComponent - a model defined in Swagger""" # noqa: E501 + self._name = None + self._description = None + self._display_name = None + self._upgrade_mode = None + self._downgrade_mode = None + self._unit = None + self._default_quantity = None + self._tiers = None + self._tax_code = None + self.discriminator = None + if name is not None: + self.name = name + if description is not None: + self.description = description + if display_name is not None: + self.display_name = display_name + if upgrade_mode is not None: + self.upgrade_mode = upgrade_mode + if downgrade_mode is not None: + self.downgrade_mode = downgrade_mode + if unit is not None: + self.unit = unit + if default_quantity is not None: + self.default_quantity = default_quantity + if tiers is not None: + self.tiers = tiers + if tax_code is not None: + self.tax_code = tax_code + + @property + def name(self): + """Gets the name of this TieredArrearsPricingComponent. # noqa: E501 + + + :return: The name of this TieredArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this TieredArrearsPricingComponent. + + + :param name: The name of this TieredArrearsPricingComponent. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this TieredArrearsPricingComponent. # noqa: E501 + + + :return: The description of this TieredArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this TieredArrearsPricingComponent. + + + :param description: The description of this TieredArrearsPricingComponent. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def display_name(self): + """Gets the display_name of this TieredArrearsPricingComponent. # noqa: E501 + + + :return: The display_name of this TieredArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this TieredArrearsPricingComponent. + + + :param display_name: The display_name of this TieredArrearsPricingComponent. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def upgrade_mode(self): + """Gets the upgrade_mode of this TieredArrearsPricingComponent. # noqa: E501 + + + :return: The upgrade_mode of this TieredArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._upgrade_mode + + @upgrade_mode.setter + def upgrade_mode(self, upgrade_mode): + """Sets the upgrade_mode of this TieredArrearsPricingComponent. + + + :param upgrade_mode: The upgrade_mode of this TieredArrearsPricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["immediate", "delayed"] # noqa: E501 + if upgrade_mode not in allowed_values: + raise ValueError( + "Invalid value for `upgrade_mode` ({0}), must be one of {1}" # noqa: E501 + .format(upgrade_mode, allowed_values) + ) + + self._upgrade_mode = upgrade_mode + + @property + def downgrade_mode(self): + """Gets the downgrade_mode of this TieredArrearsPricingComponent. # noqa: E501 + + + :return: The downgrade_mode of this TieredArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._downgrade_mode + + @downgrade_mode.setter + def downgrade_mode(self, downgrade_mode): + """Sets the downgrade_mode of this TieredArrearsPricingComponent. + + + :param downgrade_mode: The downgrade_mode of this TieredArrearsPricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["immediate", "delayed"] # noqa: E501 + if downgrade_mode not in allowed_values: + raise ValueError( + "Invalid value for `downgrade_mode` ({0}), must be one of {1}" # noqa: E501 + .format(downgrade_mode, allowed_values) + ) + + self._downgrade_mode = downgrade_mode + + @property + def unit(self): + """Gets the unit of this TieredArrearsPricingComponent. # noqa: E501 + + + :return: The unit of this TieredArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._unit + + @unit.setter + def unit(self, unit): + """Sets the unit of this TieredArrearsPricingComponent. + + + :param unit: The unit of this TieredArrearsPricingComponent. # noqa: E501 + :type: str + """ + + self._unit = unit + + @property + def default_quantity(self): + """Gets the default_quantity of this TieredArrearsPricingComponent. # noqa: E501 + + + :return: The default_quantity of this TieredArrearsPricingComponent. # noqa: E501 + :rtype: int + """ + return self._default_quantity + + @default_quantity.setter + def default_quantity(self, default_quantity): + """Sets the default_quantity of this TieredArrearsPricingComponent. + + + :param default_quantity: The default_quantity of this TieredArrearsPricingComponent. # noqa: E501 + :type: int + """ + + self._default_quantity = default_quantity + + @property + def tiers(self): + """Gets the tiers of this TieredArrearsPricingComponent. # noqa: E501 + + + :return: The tiers of this TieredArrearsPricingComponent. # noqa: E501 + :rtype: list[PricingTier] + """ + return self._tiers + + @tiers.setter + def tiers(self, tiers): + """Sets the tiers of this TieredArrearsPricingComponent. + + + :param tiers: The tiers of this TieredArrearsPricingComponent. # noqa: E501 + :type: list[PricingTier] + """ + + self._tiers = tiers + + @property + def tax_code(self): + """Gets the tax_code of this TieredArrearsPricingComponent. # noqa: E501 + + + :return: The tax_code of this TieredArrearsPricingComponent. # noqa: E501 + :rtype: str + """ + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this TieredArrearsPricingComponent. + + + :param tax_code: The tax_code of this TieredArrearsPricingComponent. # noqa: E501 + :type: str + """ + + self._tax_code = tax_code + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TieredArrearsPricingComponent, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TieredArrearsPricingComponent): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/tiered_pricing_component.py b/billforward/models/tiered_pricing_component.py index a356c16..17a7286 100644 --- a/billforward/models/tiered_pricing_component.py +++ b/billforward/models/tiered_pricing_component.py @@ -1,745 +1,53 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.pricing_component import PricingComponent # noqa: F401,E501 + +class TieredPricingComponent(PricingComponent): + """NOTE: This class is auto generated by the swagger code generator program. -class TieredPricingComponent(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, version_id=None, crm_id=None, id=None, product_rate_plan_id=None, unit_of_measure_id=None, organization_id=None, name=None, public_name=None, description=None, charge_type=None, invoicing_type=None, charge_model=None, upgrade_mode=None, downgrade_mode=None, default_quantity=None, min_quantity=None, max_quantity=None, valid_from=None, valid_till=None, tiers=None, unit_of_measure=None): - """ - TieredPricingComponent - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'version_id': 'str', - 'crm_id': 'str', - 'id': 'str', - 'product_rate_plan_id': 'str', - 'unit_of_measure_id': 'str', - 'organization_id': 'str', - 'name': 'str', - 'public_name': 'str', - 'description': 'str', - 'charge_type': 'str', - 'invoicing_type': 'str', - 'charge_model': 'str', - 'upgrade_mode': 'str', - 'downgrade_mode': 'str', - 'default_quantity': 'int', - 'min_quantity': 'int', - 'max_quantity': 'int', - 'valid_from': 'datetime', - 'valid_till': 'datetime', - 'tiers': 'list[PricingComponentTier]', - 'unit_of_measure': 'UnitOfMeasure' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'version_id': 'versionID', - 'crm_id': 'crmID', - 'id': 'id', - 'product_rate_plan_id': 'productRatePlanID', - 'unit_of_measure_id': 'unitOfMeasureID', - 'organization_id': 'organizationID', - 'name': 'name', - 'public_name': 'publicName', - 'description': 'description', - 'charge_type': 'chargeType', - 'invoicing_type': 'invoicingType', - 'charge_model': 'chargeModel', - 'upgrade_mode': 'upgradeMode', - 'downgrade_mode': 'downgradeMode', - 'default_quantity': 'defaultQuantity', - 'min_quantity': 'minQuantity', - 'max_quantity': 'maxQuantity', - 'valid_from': 'validFrom', - 'valid_till': 'validTill', - 'tiers': 'tiers', - 'unit_of_measure': 'unitOfMeasure' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._version_id = version_id - self._crm_id = crm_id - self._id = id - self._product_rate_plan_id = product_rate_plan_id - self._unit_of_measure_id = unit_of_measure_id - self._organization_id = organization_id - self._name = name - self._public_name = public_name - self._description = description - self._charge_type = charge_type - self._invoicing_type = invoicing_type - self._charge_model = charge_model - self._upgrade_mode = upgrade_mode - self._downgrade_mode = downgrade_mode - self._default_quantity = default_quantity - self._min_quantity = min_quantity - self._max_quantity = max_quantity - self._valid_from = valid_from - self._valid_till = valid_till - self._tiers = tiers - self._unit_of_measure = unit_of_measure - - @property - def created(self): - """ - Gets the created of this TieredPricingComponent. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this TieredPricingComponent. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this TieredPricingComponent. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this TieredPricingComponent. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this TieredPricingComponent. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this TieredPricingComponent. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this TieredPricingComponent. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this TieredPricingComponent. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this TieredPricingComponent. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this TieredPricingComponent. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this TieredPricingComponent. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this TieredPricingComponent. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this TieredPricingComponent. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this TieredPricingComponent. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this TieredPricingComponent. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this TieredPricingComponent. - :type: str - """ - allowed_values = ["tieredPricingComponent", "flatPricingComponent", "tieredVolumePricingComponent"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def version_id(self): - """ - Gets the version_id of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The version_id of this TieredPricingComponent. - :rtype: str - """ - return self._version_id - - @version_id.setter - def version_id(self, version_id): - """ - Sets the version_id of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param version_id: The version_id of this TieredPricingComponent. - :type: str - """ - - self._version_id = version_id - - @property - def crm_id(self): - """ - Gets the crm_id of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The crm_id of this TieredPricingComponent. - :rtype: str - """ - return self._crm_id - - @crm_id.setter - def crm_id(self, crm_id): - """ - Sets the crm_id of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param crm_id: The crm_id of this TieredPricingComponent. - :type: str - """ - - self._crm_id = crm_id - - @property - def id(self): - """ - Gets the id of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } When associating a pricing component with a product rate plan, this ID should be used. - - :return: The id of this TieredPricingComponent. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } When associating a pricing component with a product rate plan, this ID should be used. - - :param id: The id of this TieredPricingComponent. - :type: str - """ - - self._id = id - - @property - def product_rate_plan_id(self): - """ - Gets the product_rate_plan_id of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The product_rate_plan_id of this TieredPricingComponent. - :rtype: str - """ - return self._product_rate_plan_id - - @product_rate_plan_id.setter - def product_rate_plan_id(self, product_rate_plan_id): - """ - Sets the product_rate_plan_id of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param product_rate_plan_id: The product_rate_plan_id of this TieredPricingComponent. - :type: str - """ - - self._product_rate_plan_id = product_rate_plan_id - - @property - def unit_of_measure_id(self): - """ - Gets the unit_of_measure_id of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The unit_of_measure_id of this TieredPricingComponent. - :rtype: str - """ - return self._unit_of_measure_id - - @unit_of_measure_id.setter - def unit_of_measure_id(self, unit_of_measure_id): - """ - Sets the unit_of_measure_id of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param unit_of_measure_id: The unit_of_measure_id of this TieredPricingComponent. - :type: str - """ - - self._unit_of_measure_id = unit_of_measure_id - - @property - def organization_id(self): - """ - Gets the organization_id of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[] } - - :return: The organization_id of this TieredPricingComponent. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[] } - - :param organization_id: The organization_id of this TieredPricingComponent. - :type: str - """ - - self._organization_id = organization_id - - @property - def name(self): - """ - Gets the name of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The name of this TieredPricingComponent. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param name: The name of this TieredPricingComponent. - :type: str - """ - - self._name = name - - @property - def public_name(self): - """ - Gets the public_name of this TieredPricingComponent. - {\"description\":\"A friendly non-unique name used to identify this pricing-component\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The public_name of this TieredPricingComponent. - :rtype: str - """ - return self._public_name - - @public_name.setter - def public_name(self, public_name): - """ - Sets the public_name of this TieredPricingComponent. - {\"description\":\"A friendly non-unique name used to identify this pricing-component\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param public_name: The public_name of this TieredPricingComponent. - :type: str - """ - - self._public_name = public_name - - @property - def description(self): - """ - Gets the description of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The description of this TieredPricingComponent. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this TieredPricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param description: The description of this TieredPricingComponent. - :type: str - """ - - self._description = description - - @property - def charge_type(self): - """ - Gets the charge_type of this TieredPricingComponent. - { \"description\" : \"The charge type of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The charge_type of this TieredPricingComponent. - :rtype: str - """ - return self._charge_type - - @charge_type.setter - def charge_type(self, charge_type): - """ - Sets the charge_type of this TieredPricingComponent. - { \"description\" : \"The charge type of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param charge_type: The charge_type of this TieredPricingComponent. - :type: str - """ - allowed_values = ["setup", "subscription", "arrears", "usage"] - if charge_type not in allowed_values: - raise ValueError( - "Invalid value for `charge_type` ({0}), must be one of {1}" - .format(charge_type, allowed_values) - ) - - self._charge_type = charge_type - - @property - def invoicing_type(self): - """ - Gets the invoicing_type of this TieredPricingComponent. - { \"default\" : \"Aggregated\", \"description\" : \"For setup pricing components Immediate invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. Aggregated invoicing will add a charge to the first invoice of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The invoicing_type of this TieredPricingComponent. - :rtype: str - """ - return self._invoicing_type - - @invoicing_type.setter - def invoicing_type(self, invoicing_type): - """ - Sets the invoicing_type of this TieredPricingComponent. - { \"default\" : \"Aggregated\", \"description\" : \"For setup pricing components Immediate invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. Aggregated invoicing will add a charge to the first invoice of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param invoicing_type: The invoicing_type of this TieredPricingComponent. - :type: str - """ - allowed_values = ["Immediate", "Aggregated"] - if invoicing_type not in allowed_values: - raise ValueError( - "Invalid value for `invoicing_type` ({0}), must be one of {1}" - .format(invoicing_type, allowed_values) - ) - - self._invoicing_type = invoicing_type - - @property - def charge_model(self): - """ - Gets the charge_model of this TieredPricingComponent. - { \"description\" : \"The charge model of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The charge_model of this TieredPricingComponent. - :rtype: str - """ - return self._charge_model - - @charge_model.setter - def charge_model(self, charge_model): - """ - Sets the charge_model of this TieredPricingComponent. - { \"description\" : \"The charge model of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param charge_model: The charge_model of this TieredPricingComponent. - :type: str - """ - allowed_values = ["flat", "tiered", "tiered_volume"] - if charge_model not in allowed_values: - raise ValueError( - "Invalid value for `charge_model` ({0}), must be one of {1}" - .format(charge_model, allowed_values) - ) - - self._charge_model = charge_model - - @property - def upgrade_mode(self): - """ - Gets the upgrade_mode of this TieredPricingComponent. - {\"default\":\"immediate\",\"description\":\"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Upgrade will apply at the time the request is made.
delayed — Upgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The upgrade_mode of this TieredPricingComponent. - :rtype: str - """ - return self._upgrade_mode - - @upgrade_mode.setter - def upgrade_mode(self, upgrade_mode): - """ - Sets the upgrade_mode of this TieredPricingComponent. - {\"default\":\"immediate\",\"description\":\"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Upgrade will apply at the time the request is made.
delayed — Upgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} - - :param upgrade_mode: The upgrade_mode of this TieredPricingComponent. - :type: str - """ - allowed_values = ["immediate", "delayed"] - if upgrade_mode not in allowed_values: - raise ValueError( - "Invalid value for `upgrade_mode` ({0}), must be one of {1}" - .format(upgrade_mode, allowed_values) - ) - - self._upgrade_mode = upgrade_mode - - @property - def downgrade_mode(self): - """ - Gets the downgrade_mode of this TieredPricingComponent. - {\"default\":\"delayed\",\"description\":\"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Downgrade will apply at the time the request is made.
delayed — Downgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The downgrade_mode of this TieredPricingComponent. - :rtype: str - """ - return self._downgrade_mode - - @downgrade_mode.setter - def downgrade_mode(self, downgrade_mode): - """ - Sets the downgrade_mode of this TieredPricingComponent. - {\"default\":\"delayed\",\"description\":\"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Downgrade will apply at the time the request is made.
delayed — Downgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} - - :param downgrade_mode: The downgrade_mode of this TieredPricingComponent. - :type: str - """ - allowed_values = ["immediate", "delayed"] - if downgrade_mode not in allowed_values: - raise ValueError( - "Invalid value for `downgrade_mode` ({0}), must be one of {1}" - .format(downgrade_mode, allowed_values) - ) - - self._downgrade_mode = downgrade_mode - - @property - def default_quantity(self): - """ - Gets the default_quantity of this TieredPricingComponent. - { \"description\" : \"The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The default_quantity of this TieredPricingComponent. - :rtype: int - """ - return self._default_quantity - - @default_quantity.setter - def default_quantity(self, default_quantity): - """ - Sets the default_quantity of this TieredPricingComponent. - { \"description\" : \"The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param default_quantity: The default_quantity of this TieredPricingComponent. - :type: int - """ - - self._default_quantity = default_quantity - - @property - def min_quantity(self): - """ - Gets the min_quantity of this TieredPricingComponent. - { \"default\" : \"0\", \"description\" : \"The minimum quantity of the pricing-component.\", \"verbs\":[] } - - :return: The min_quantity of this TieredPricingComponent. - :rtype: int - """ - return self._min_quantity - - @min_quantity.setter - def min_quantity(self, min_quantity): - """ - Sets the min_quantity of this TieredPricingComponent. - { \"default\" : \"0\", \"description\" : \"The minimum quantity of the pricing-component.\", \"verbs\":[] } - - :param min_quantity: The min_quantity of this TieredPricingComponent. - :type: int - """ - - self._min_quantity = min_quantity - - @property - def max_quantity(self): - """ - Gets the max_quantity of this TieredPricingComponent. - { \"description\" : \"The maximum quantity of the pricing-component.\", \"verbs\":[] } - - :return: The max_quantity of this TieredPricingComponent. - :rtype: int - """ - return self._max_quantity - - @max_quantity.setter - def max_quantity(self, max_quantity): - """ - Sets the max_quantity of this TieredPricingComponent. - { \"description\" : \"The maximum quantity of the pricing-component.\", \"verbs\":[] } - - :param max_quantity: The max_quantity of this TieredPricingComponent. - :type: int - """ - - self._max_quantity = max_quantity - - @property - def valid_from(self): - """ - Gets the valid_from of this TieredPricingComponent. - { \"default\" : \"current time\", \"description\" : \"The DateTime specifying when the pricing-component is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The valid_from of this TieredPricingComponent. - :rtype: datetime - """ - return self._valid_from - - @valid_from.setter - def valid_from(self, valid_from): - """ - Sets the valid_from of this TieredPricingComponent. - { \"default\" : \"current time\", \"description\" : \"The DateTime specifying when the pricing-component is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param valid_from: The valid_from of this TieredPricingComponent. - :type: datetime - """ - - self._valid_from = valid_from - - @property - def valid_till(self): - """ - Gets the valid_till of this TieredPricingComponent. - { \"default\" : \"null\", \"description\" : \"The UTC DateTime specifying when the pricing-component is valid till.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The valid_till of this TieredPricingComponent. - :rtype: datetime - """ - return self._valid_till - - @valid_till.setter - def valid_till(self, valid_till): - """ - Sets the valid_till of this TieredPricingComponent. - { \"default\" : \"null\", \"description\" : \"The UTC DateTime specifying when the pricing-component is valid till.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param valid_till: The valid_till of this TieredPricingComponent. - :type: datetime - """ - - self._valid_till = valid_till - - @property - def tiers(self): - """ - Gets the tiers of this TieredPricingComponent. - { \"default\" : \"[]\", \"description\" : \"The pricing-component-tiers associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The tiers of this TieredPricingComponent. - :rtype: list[PricingComponentTier] - """ - return self._tiers - - @tiers.setter - def tiers(self, tiers): - """ - Sets the tiers of this TieredPricingComponent. - { \"default\" : \"[]\", \"description\" : \"The pricing-component-tiers associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param tiers: The tiers of this TieredPricingComponent. - :type: list[PricingComponentTier] - """ - - self._tiers = tiers - - @property - def unit_of_measure(self): - """ - Gets the unit_of_measure of this TieredPricingComponent. - { \"description\" : \"The unit-of-measure associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The unit_of_measure of this TieredPricingComponent. - :rtype: UnitOfMeasure - """ - return self._unit_of_measure - - @unit_of_measure.setter - def unit_of_measure(self, unit_of_measure): - """ - Sets the unit_of_measure of this TieredPricingComponent. - { \"description\" : \"The unit-of-measure associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(PricingComponent, "swagger_types"): + swagger_types.update(PricingComponent.swagger_types) - :param unit_of_measure: The unit_of_measure of this TieredPricingComponent. - :type: UnitOfMeasure - """ + attribute_map = { + } + if hasattr(PricingComponent, "attribute_map"): + attribute_map.update(PricingComponent.attribute_map) - self._unit_of_measure = unit_of_measure + def __init__(self, *args, **kwargs): # noqa: E501 + """TieredPricingComponent - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + PricingComponent.__init__(self, *args, **kwargs) def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -756,29 +64,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(TieredPricingComponent, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, TieredPricingComponent): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/tiered_setup_pricing_component.py b/billforward/models/tiered_setup_pricing_component.py new file mode 100644 index 0000000..1bb0ece --- /dev/null +++ b/billforward/models/tiered_setup_pricing_component.py @@ -0,0 +1,298 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TieredSetupPricingComponent(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'display_name': 'str', + 'unit': 'str', + 'invoicing_type': 'str', + 'default_quantity': 'int', + 'tiers': 'list[PricingTier]', + 'tax_code': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'display_name': 'displayName', + 'unit': 'unit', + 'invoicing_type': 'invoicingType', + 'default_quantity': 'defaultQuantity', + 'tiers': 'tiers', + 'tax_code': 'taxCode' + } + + def __init__(self, name=None, description=None, display_name=None, unit=None, invoicing_type=None, default_quantity=None, tiers=None, tax_code=None): # noqa: E501 + """TieredSetupPricingComponent - a model defined in Swagger""" # noqa: E501 + self._name = None + self._description = None + self._display_name = None + self._unit = None + self._invoicing_type = None + self._default_quantity = None + self._tiers = None + self._tax_code = None + self.discriminator = None + if name is not None: + self.name = name + if description is not None: + self.description = description + if display_name is not None: + self.display_name = display_name + if unit is not None: + self.unit = unit + if invoicing_type is not None: + self.invoicing_type = invoicing_type + if default_quantity is not None: + self.default_quantity = default_quantity + if tiers is not None: + self.tiers = tiers + if tax_code is not None: + self.tax_code = tax_code + + @property + def name(self): + """Gets the name of this TieredSetupPricingComponent. # noqa: E501 + + + :return: The name of this TieredSetupPricingComponent. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this TieredSetupPricingComponent. + + + :param name: The name of this TieredSetupPricingComponent. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this TieredSetupPricingComponent. # noqa: E501 + + + :return: The description of this TieredSetupPricingComponent. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this TieredSetupPricingComponent. + + + :param description: The description of this TieredSetupPricingComponent. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def display_name(self): + """Gets the display_name of this TieredSetupPricingComponent. # noqa: E501 + + + :return: The display_name of this TieredSetupPricingComponent. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this TieredSetupPricingComponent. + + + :param display_name: The display_name of this TieredSetupPricingComponent. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def unit(self): + """Gets the unit of this TieredSetupPricingComponent. # noqa: E501 + + + :return: The unit of this TieredSetupPricingComponent. # noqa: E501 + :rtype: str + """ + return self._unit + + @unit.setter + def unit(self, unit): + """Sets the unit of this TieredSetupPricingComponent. + + + :param unit: The unit of this TieredSetupPricingComponent. # noqa: E501 + :type: str + """ + + self._unit = unit + + @property + def invoicing_type(self): + """Gets the invoicing_type of this TieredSetupPricingComponent. # noqa: E501 + + + :return: The invoicing_type of this TieredSetupPricingComponent. # noqa: E501 + :rtype: str + """ + return self._invoicing_type + + @invoicing_type.setter + def invoicing_type(self, invoicing_type): + """Sets the invoicing_type of this TieredSetupPricingComponent. + + + :param invoicing_type: The invoicing_type of this TieredSetupPricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["Immediate", "Aggregated"] # noqa: E501 + if invoicing_type not in allowed_values: + raise ValueError( + "Invalid value for `invoicing_type` ({0}), must be one of {1}" # noqa: E501 + .format(invoicing_type, allowed_values) + ) + + self._invoicing_type = invoicing_type + + @property + def default_quantity(self): + """Gets the default_quantity of this TieredSetupPricingComponent. # noqa: E501 + + + :return: The default_quantity of this TieredSetupPricingComponent. # noqa: E501 + :rtype: int + """ + return self._default_quantity + + @default_quantity.setter + def default_quantity(self, default_quantity): + """Sets the default_quantity of this TieredSetupPricingComponent. + + + :param default_quantity: The default_quantity of this TieredSetupPricingComponent. # noqa: E501 + :type: int + """ + + self._default_quantity = default_quantity + + @property + def tiers(self): + """Gets the tiers of this TieredSetupPricingComponent. # noqa: E501 + + + :return: The tiers of this TieredSetupPricingComponent. # noqa: E501 + :rtype: list[PricingTier] + """ + return self._tiers + + @tiers.setter + def tiers(self, tiers): + """Sets the tiers of this TieredSetupPricingComponent. + + + :param tiers: The tiers of this TieredSetupPricingComponent. # noqa: E501 + :type: list[PricingTier] + """ + + self._tiers = tiers + + @property + def tax_code(self): + """Gets the tax_code of this TieredSetupPricingComponent. # noqa: E501 + + + :return: The tax_code of this TieredSetupPricingComponent. # noqa: E501 + :rtype: str + """ + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this TieredSetupPricingComponent. + + + :param tax_code: The tax_code of this TieredSetupPricingComponent. # noqa: E501 + :type: str + """ + + self._tax_code = tax_code + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TieredSetupPricingComponent, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TieredSetupPricingComponent): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/tiered_usage_pricing_component.py b/billforward/models/tiered_usage_pricing_component.py new file mode 100644 index 0000000..2bb1180 --- /dev/null +++ b/billforward/models/tiered_usage_pricing_component.py @@ -0,0 +1,304 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TieredUsagePricingComponent(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'description': 'str', + 'display_name': 'str', + 'upgrade_mode': 'str', + 'downgrade_mode': 'str', + 'unit': 'str', + 'tiers': 'list[PricingTier]', + 'tax_code': 'str' + } + + attribute_map = { + 'name': 'name', + 'description': 'description', + 'display_name': 'displayName', + 'upgrade_mode': 'upgradeMode', + 'downgrade_mode': 'downgradeMode', + 'unit': 'unit', + 'tiers': 'tiers', + 'tax_code': 'taxCode' + } + + def __init__(self, name=None, description=None, display_name=None, upgrade_mode=None, downgrade_mode=None, unit=None, tiers=None, tax_code=None): # noqa: E501 + """TieredUsagePricingComponent - a model defined in Swagger""" # noqa: E501 + self._name = None + self._description = None + self._display_name = None + self._upgrade_mode = None + self._downgrade_mode = None + self._unit = None + self._tiers = None + self._tax_code = None + self.discriminator = None + if name is not None: + self.name = name + if description is not None: + self.description = description + if display_name is not None: + self.display_name = display_name + if upgrade_mode is not None: + self.upgrade_mode = upgrade_mode + if downgrade_mode is not None: + self.downgrade_mode = downgrade_mode + if unit is not None: + self.unit = unit + if tiers is not None: + self.tiers = tiers + if tax_code is not None: + self.tax_code = tax_code + + @property + def name(self): + """Gets the name of this TieredUsagePricingComponent. # noqa: E501 + + + :return: The name of this TieredUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this TieredUsagePricingComponent. + + + :param name: The name of this TieredUsagePricingComponent. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this TieredUsagePricingComponent. # noqa: E501 + + + :return: The description of this TieredUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this TieredUsagePricingComponent. + + + :param description: The description of this TieredUsagePricingComponent. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def display_name(self): + """Gets the display_name of this TieredUsagePricingComponent. # noqa: E501 + + + :return: The display_name of this TieredUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this TieredUsagePricingComponent. + + + :param display_name: The display_name of this TieredUsagePricingComponent. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def upgrade_mode(self): + """Gets the upgrade_mode of this TieredUsagePricingComponent. # noqa: E501 + + + :return: The upgrade_mode of this TieredUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._upgrade_mode + + @upgrade_mode.setter + def upgrade_mode(self, upgrade_mode): + """Sets the upgrade_mode of this TieredUsagePricingComponent. + + + :param upgrade_mode: The upgrade_mode of this TieredUsagePricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["immediate", "delayed"] # noqa: E501 + if upgrade_mode not in allowed_values: + raise ValueError( + "Invalid value for `upgrade_mode` ({0}), must be one of {1}" # noqa: E501 + .format(upgrade_mode, allowed_values) + ) + + self._upgrade_mode = upgrade_mode + + @property + def downgrade_mode(self): + """Gets the downgrade_mode of this TieredUsagePricingComponent. # noqa: E501 + + + :return: The downgrade_mode of this TieredUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._downgrade_mode + + @downgrade_mode.setter + def downgrade_mode(self, downgrade_mode): + """Sets the downgrade_mode of this TieredUsagePricingComponent. + + + :param downgrade_mode: The downgrade_mode of this TieredUsagePricingComponent. # noqa: E501 + :type: str + """ + allowed_values = ["immediate", "delayed"] # noqa: E501 + if downgrade_mode not in allowed_values: + raise ValueError( + "Invalid value for `downgrade_mode` ({0}), must be one of {1}" # noqa: E501 + .format(downgrade_mode, allowed_values) + ) + + self._downgrade_mode = downgrade_mode + + @property + def unit(self): + """Gets the unit of this TieredUsagePricingComponent. # noqa: E501 + + + :return: The unit of this TieredUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._unit + + @unit.setter + def unit(self, unit): + """Sets the unit of this TieredUsagePricingComponent. + + + :param unit: The unit of this TieredUsagePricingComponent. # noqa: E501 + :type: str + """ + + self._unit = unit + + @property + def tiers(self): + """Gets the tiers of this TieredUsagePricingComponent. # noqa: E501 + + + :return: The tiers of this TieredUsagePricingComponent. # noqa: E501 + :rtype: list[PricingTier] + """ + return self._tiers + + @tiers.setter + def tiers(self, tiers): + """Sets the tiers of this TieredUsagePricingComponent. + + + :param tiers: The tiers of this TieredUsagePricingComponent. # noqa: E501 + :type: list[PricingTier] + """ + + self._tiers = tiers + + @property + def tax_code(self): + """Gets the tax_code of this TieredUsagePricingComponent. # noqa: E501 + + + :return: The tax_code of this TieredUsagePricingComponent. # noqa: E501 + :rtype: str + """ + return self._tax_code + + @tax_code.setter + def tax_code(self, tax_code): + """Sets the tax_code of this TieredUsagePricingComponent. + + + :param tax_code: The tax_code of this TieredUsagePricingComponent. # noqa: E501 + :type: str + """ + + self._tax_code = tax_code + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TieredUsagePricingComponent, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TieredUsagePricingComponent): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/tiered_volume_pricing_component.py b/billforward/models/tiered_volume_pricing_component.py index 7941c54..800a9ad 100644 --- a/billforward/models/tiered_volume_pricing_component.py +++ b/billforward/models/tiered_volume_pricing_component.py @@ -1,745 +1,53 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.pricing_component import PricingComponent # noqa: F401,E501 + +class TieredVolumePricingComponent(PricingComponent): + """NOTE: This class is auto generated by the swagger code generator program. -class TieredVolumePricingComponent(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, version_id=None, crm_id=None, id=None, product_rate_plan_id=None, unit_of_measure_id=None, organization_id=None, name=None, public_name=None, description=None, charge_type=None, invoicing_type=None, charge_model=None, upgrade_mode=None, downgrade_mode=None, default_quantity=None, min_quantity=None, max_quantity=None, valid_from=None, valid_till=None, tiers=None, unit_of_measure=None): - """ - TieredVolumePricingComponent - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'version_id': 'str', - 'crm_id': 'str', - 'id': 'str', - 'product_rate_plan_id': 'str', - 'unit_of_measure_id': 'str', - 'organization_id': 'str', - 'name': 'str', - 'public_name': 'str', - 'description': 'str', - 'charge_type': 'str', - 'invoicing_type': 'str', - 'charge_model': 'str', - 'upgrade_mode': 'str', - 'downgrade_mode': 'str', - 'default_quantity': 'int', - 'min_quantity': 'int', - 'max_quantity': 'int', - 'valid_from': 'datetime', - 'valid_till': 'datetime', - 'tiers': 'list[PricingComponentTier]', - 'unit_of_measure': 'UnitOfMeasure' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'version_id': 'versionID', - 'crm_id': 'crmID', - 'id': 'id', - 'product_rate_plan_id': 'productRatePlanID', - 'unit_of_measure_id': 'unitOfMeasureID', - 'organization_id': 'organizationID', - 'name': 'name', - 'public_name': 'publicName', - 'description': 'description', - 'charge_type': 'chargeType', - 'invoicing_type': 'invoicingType', - 'charge_model': 'chargeModel', - 'upgrade_mode': 'upgradeMode', - 'downgrade_mode': 'downgradeMode', - 'default_quantity': 'defaultQuantity', - 'min_quantity': 'minQuantity', - 'max_quantity': 'maxQuantity', - 'valid_from': 'validFrom', - 'valid_till': 'validTill', - 'tiers': 'tiers', - 'unit_of_measure': 'unitOfMeasure' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._version_id = version_id - self._crm_id = crm_id - self._id = id - self._product_rate_plan_id = product_rate_plan_id - self._unit_of_measure_id = unit_of_measure_id - self._organization_id = organization_id - self._name = name - self._public_name = public_name - self._description = description - self._charge_type = charge_type - self._invoicing_type = invoicing_type - self._charge_model = charge_model - self._upgrade_mode = upgrade_mode - self._downgrade_mode = downgrade_mode - self._default_quantity = default_quantity - self._min_quantity = min_quantity - self._max_quantity = max_quantity - self._valid_from = valid_from - self._valid_till = valid_till - self._tiers = tiers - self._unit_of_measure = unit_of_measure - - @property - def created(self): - """ - Gets the created of this TieredVolumePricingComponent. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this TieredVolumePricingComponent. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this TieredVolumePricingComponent. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this TieredVolumePricingComponent. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this TieredVolumePricingComponent. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this TieredVolumePricingComponent. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this TieredVolumePricingComponent. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this TieredVolumePricingComponent. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this TieredVolumePricingComponent. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this TieredVolumePricingComponent. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this TieredVolumePricingComponent. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this TieredVolumePricingComponent. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this TieredVolumePricingComponent. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this TieredVolumePricingComponent. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this TieredVolumePricingComponent. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this TieredVolumePricingComponent. - :type: str - """ - allowed_values = ["tieredPricingComponent", "flatPricingComponent", "tieredVolumePricingComponent"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def version_id(self): - """ - Gets the version_id of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The version_id of this TieredVolumePricingComponent. - :rtype: str - """ - return self._version_id - - @version_id.setter - def version_id(self, version_id): - """ - Sets the version_id of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param version_id: The version_id of this TieredVolumePricingComponent. - :type: str - """ - - self._version_id = version_id - - @property - def crm_id(self): - """ - Gets the crm_id of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The crm_id of this TieredVolumePricingComponent. - :rtype: str - """ - return self._crm_id - - @crm_id.setter - def crm_id(self, crm_id): - """ - Sets the crm_id of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param crm_id: The crm_id of this TieredVolumePricingComponent. - :type: str - """ - - self._crm_id = crm_id - - @property - def id(self): - """ - Gets the id of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } When associating a pricing component with a product rate plan, this ID should be used. - - :return: The id of this TieredVolumePricingComponent. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"GET\"] } When associating a pricing component with a product rate plan, this ID should be used. - - :param id: The id of this TieredVolumePricingComponent. - :type: str - """ - - self._id = id - - @property - def product_rate_plan_id(self): - """ - Gets the product_rate_plan_id of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The product_rate_plan_id of this TieredVolumePricingComponent. - :rtype: str - """ - return self._product_rate_plan_id - - @product_rate_plan_id.setter - def product_rate_plan_id(self, product_rate_plan_id): - """ - Sets the product_rate_plan_id of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param product_rate_plan_id: The product_rate_plan_id of this TieredVolumePricingComponent. - :type: str - """ - - self._product_rate_plan_id = product_rate_plan_id - - @property - def unit_of_measure_id(self): - """ - Gets the unit_of_measure_id of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The unit_of_measure_id of this TieredVolumePricingComponent. - :rtype: str - """ - return self._unit_of_measure_id - - @unit_of_measure_id.setter - def unit_of_measure_id(self, unit_of_measure_id): - """ - Sets the unit_of_measure_id of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param unit_of_measure_id: The unit_of_measure_id of this TieredVolumePricingComponent. - :type: str - """ - - self._unit_of_measure_id = unit_of_measure_id - - @property - def organization_id(self): - """ - Gets the organization_id of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[] } - - :return: The organization_id of this TieredVolumePricingComponent. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[] } - - :param organization_id: The organization_id of this TieredVolumePricingComponent. - :type: str - """ - - self._organization_id = organization_id - - @property - def name(self): - """ - Gets the name of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The name of this TieredVolumePricingComponent. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param name: The name of this TieredVolumePricingComponent. - :type: str - """ - - self._name = name - - @property - def public_name(self): - """ - Gets the public_name of this TieredVolumePricingComponent. - {\"description\":\"A friendly non-unique name used to identify this pricing-component\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :return: The public_name of this TieredVolumePricingComponent. - :rtype: str - """ - return self._public_name - - @public_name.setter - def public_name(self, public_name): - """ - Sets the public_name of this TieredVolumePricingComponent. - {\"description\":\"A friendly non-unique name used to identify this pricing-component\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - - :param public_name: The public_name of this TieredVolumePricingComponent. - :type: str - """ - - self._public_name = public_name - - @property - def description(self): - """ - Gets the description of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The description of this TieredVolumePricingComponent. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this TieredVolumePricingComponent. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param description: The description of this TieredVolumePricingComponent. - :type: str - """ - - self._description = description - - @property - def charge_type(self): - """ - Gets the charge_type of this TieredVolumePricingComponent. - { \"description\" : \"The charge type of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The charge_type of this TieredVolumePricingComponent. - :rtype: str - """ - return self._charge_type - - @charge_type.setter - def charge_type(self, charge_type): - """ - Sets the charge_type of this TieredVolumePricingComponent. - { \"description\" : \"The charge type of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param charge_type: The charge_type of this TieredVolumePricingComponent. - :type: str - """ - allowed_values = ["setup", "subscription", "arrears", "usage"] - if charge_type not in allowed_values: - raise ValueError( - "Invalid value for `charge_type` ({0}), must be one of {1}" - .format(charge_type, allowed_values) - ) - - self._charge_type = charge_type - - @property - def invoicing_type(self): - """ - Gets the invoicing_type of this TieredVolumePricingComponent. - { \"default\" : \"Aggregated\", \"description\" : \"For setup pricing components Immediate invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. Aggregated invoicing will add a charge to the first invoice of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The invoicing_type of this TieredVolumePricingComponent. - :rtype: str - """ - return self._invoicing_type - - @invoicing_type.setter - def invoicing_type(self, invoicing_type): - """ - Sets the invoicing_type of this TieredVolumePricingComponent. - { \"default\" : \"Aggregated\", \"description\" : \"For setup pricing components Immediate invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. Aggregated invoicing will add a charge to the first invoice of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param invoicing_type: The invoicing_type of this TieredVolumePricingComponent. - :type: str - """ - allowed_values = ["Immediate", "Aggregated"] - if invoicing_type not in allowed_values: - raise ValueError( - "Invalid value for `invoicing_type` ({0}), must be one of {1}" - .format(invoicing_type, allowed_values) - ) - - self._invoicing_type = invoicing_type - - @property - def charge_model(self): - """ - Gets the charge_model of this TieredVolumePricingComponent. - { \"description\" : \"The charge model of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The charge_model of this TieredVolumePricingComponent. - :rtype: str - """ - return self._charge_model - - @charge_model.setter - def charge_model(self, charge_model): - """ - Sets the charge_model of this TieredVolumePricingComponent. - { \"description\" : \"The charge model of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param charge_model: The charge_model of this TieredVolumePricingComponent. - :type: str - """ - allowed_values = ["flat", "tiered", "tiered_volume"] - if charge_model not in allowed_values: - raise ValueError( - "Invalid value for `charge_model` ({0}), must be one of {1}" - .format(charge_model, allowed_values) - ) - - self._charge_model = charge_model - - @property - def upgrade_mode(self): - """ - Gets the upgrade_mode of this TieredVolumePricingComponent. - {\"default\":\"immediate\",\"description\":\"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Upgrade will apply at the time the request is made.
delayed — Upgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The upgrade_mode of this TieredVolumePricingComponent. - :rtype: str - """ - return self._upgrade_mode - - @upgrade_mode.setter - def upgrade_mode(self, upgrade_mode): - """ - Sets the upgrade_mode of this TieredVolumePricingComponent. - {\"default\":\"immediate\",\"description\":\"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Upgrade will apply at the time the request is made.
delayed — Upgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} - - :param upgrade_mode: The upgrade_mode of this TieredVolumePricingComponent. - :type: str - """ - allowed_values = ["immediate", "delayed"] - if upgrade_mode not in allowed_values: - raise ValueError( - "Invalid value for `upgrade_mode` ({0}), must be one of {1}" - .format(upgrade_mode, allowed_values) - ) - - self._upgrade_mode = upgrade_mode - - @property - def downgrade_mode(self): - """ - Gets the downgrade_mode of this TieredVolumePricingComponent. - {\"default\":\"delayed\",\"description\":\"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Downgrade will apply at the time the request is made.
delayed — Downgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} - - :return: The downgrade_mode of this TieredVolumePricingComponent. - :rtype: str - """ - return self._downgrade_mode - - @downgrade_mode.setter - def downgrade_mode(self, downgrade_mode): - """ - Sets the downgrade_mode of this TieredVolumePricingComponent. - {\"default\":\"delayed\",\"description\":\"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.
immediate — Downgrade will apply at the time the request is made.
delayed — Downgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} - - :param downgrade_mode: The downgrade_mode of this TieredVolumePricingComponent. - :type: str - """ - allowed_values = ["immediate", "delayed"] - if downgrade_mode not in allowed_values: - raise ValueError( - "Invalid value for `downgrade_mode` ({0}), must be one of {1}" - .format(downgrade_mode, allowed_values) - ) - - self._downgrade_mode = downgrade_mode - - @property - def default_quantity(self): - """ - Gets the default_quantity of this TieredVolumePricingComponent. - { \"description\" : \"The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The default_quantity of this TieredVolumePricingComponent. - :rtype: int - """ - return self._default_quantity - - @default_quantity.setter - def default_quantity(self, default_quantity): - """ - Sets the default_quantity of this TieredVolumePricingComponent. - { \"description\" : \"The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param default_quantity: The default_quantity of this TieredVolumePricingComponent. - :type: int - """ - - self._default_quantity = default_quantity - - @property - def min_quantity(self): - """ - Gets the min_quantity of this TieredVolumePricingComponent. - { \"default\" : \"0\", \"description\" : \"The minimum quantity of the pricing-component.\", \"verbs\":[] } - - :return: The min_quantity of this TieredVolumePricingComponent. - :rtype: int - """ - return self._min_quantity - - @min_quantity.setter - def min_quantity(self, min_quantity): - """ - Sets the min_quantity of this TieredVolumePricingComponent. - { \"default\" : \"0\", \"description\" : \"The minimum quantity of the pricing-component.\", \"verbs\":[] } - - :param min_quantity: The min_quantity of this TieredVolumePricingComponent. - :type: int - """ - - self._min_quantity = min_quantity - - @property - def max_quantity(self): - """ - Gets the max_quantity of this TieredVolumePricingComponent. - { \"description\" : \"The maximum quantity of the pricing-component.\", \"verbs\":[] } - - :return: The max_quantity of this TieredVolumePricingComponent. - :rtype: int - """ - return self._max_quantity - - @max_quantity.setter - def max_quantity(self, max_quantity): - """ - Sets the max_quantity of this TieredVolumePricingComponent. - { \"description\" : \"The maximum quantity of the pricing-component.\", \"verbs\":[] } - - :param max_quantity: The max_quantity of this TieredVolumePricingComponent. - :type: int - """ - - self._max_quantity = max_quantity - - @property - def valid_from(self): - """ - Gets the valid_from of this TieredVolumePricingComponent. - { \"default\" : \"current time\", \"description\" : \"The DateTime specifying when the pricing-component is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The valid_from of this TieredVolumePricingComponent. - :rtype: datetime - """ - return self._valid_from - - @valid_from.setter - def valid_from(self, valid_from): - """ - Sets the valid_from of this TieredVolumePricingComponent. - { \"default\" : \"current time\", \"description\" : \"The DateTime specifying when the pricing-component is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param valid_from: The valid_from of this TieredVolumePricingComponent. - :type: datetime - """ - - self._valid_from = valid_from - - @property - def valid_till(self): - """ - Gets the valid_till of this TieredVolumePricingComponent. - { \"default\" : \"null\", \"description\" : \"The UTC DateTime specifying when the pricing-component is valid till.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The valid_till of this TieredVolumePricingComponent. - :rtype: datetime - """ - return self._valid_till - - @valid_till.setter - def valid_till(self, valid_till): - """ - Sets the valid_till of this TieredVolumePricingComponent. - { \"default\" : \"null\", \"description\" : \"The UTC DateTime specifying when the pricing-component is valid till.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param valid_till: The valid_till of this TieredVolumePricingComponent. - :type: datetime - """ - - self._valid_till = valid_till - - @property - def tiers(self): - """ - Gets the tiers of this TieredVolumePricingComponent. - { \"default\" : \"[]\", \"description\" : \"The pricing-component-tiers associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The tiers of this TieredVolumePricingComponent. - :rtype: list[PricingComponentTier] - """ - return self._tiers - - @tiers.setter - def tiers(self, tiers): - """ - Sets the tiers of this TieredVolumePricingComponent. - { \"default\" : \"[]\", \"description\" : \"The pricing-component-tiers associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param tiers: The tiers of this TieredVolumePricingComponent. - :type: list[PricingComponentTier] - """ - - self._tiers = tiers - - @property - def unit_of_measure(self): - """ - Gets the unit_of_measure of this TieredVolumePricingComponent. - { \"description\" : \"The unit-of-measure associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The unit_of_measure of this TieredVolumePricingComponent. - :rtype: UnitOfMeasure - """ - return self._unit_of_measure - - @unit_of_measure.setter - def unit_of_measure(self, unit_of_measure): - """ - Sets the unit_of_measure of this TieredVolumePricingComponent. - { \"description\" : \"The unit-of-measure associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(PricingComponent, "swagger_types"): + swagger_types.update(PricingComponent.swagger_types) - :param unit_of_measure: The unit_of_measure of this TieredVolumePricingComponent. - :type: UnitOfMeasure - """ + attribute_map = { + } + if hasattr(PricingComponent, "attribute_map"): + attribute_map.update(PricingComponent.attribute_map) - self._unit_of_measure = unit_of_measure + def __init__(self, *args, **kwargs): # noqa: E501 + """TieredVolumePricingComponent - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + PricingComponent.__init__(self, *args, **kwargs) def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -756,29 +64,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(TieredVolumePricingComponent, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, TieredVolumePricingComponent): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/time_request.py b/billforward/models/time_request.py index 5ea6a5f..95b041b 100644 --- a/billforward/models/time_request.py +++ b/billforward/models/time_request.py @@ -1,97 +1,118 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class TimeRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, periods=None, to=None, dry_run=False, skip_intermediate_periods=False, handle_amendments=False, execution_strategy=None, freeze_on_completion=False, advance_inclusively=False): - """ - TimeRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'periods': 'int', - 'to': 'datetime', - 'dry_run': 'bool', - 'skip_intermediate_periods': 'bool', - 'handle_amendments': 'bool', - 'execution_strategy': 'str', - 'freeze_on_completion': 'bool', - 'advance_inclusively': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'periods': 'periods', - 'to': 'to', - 'dry_run': 'dryRun', - 'skip_intermediate_periods': 'skipIntermediatePeriods', - 'handle_amendments': 'handleAmendments', - 'execution_strategy': 'executionStrategy', - 'freeze_on_completion': 'freezeOnCompletion', - 'advance_inclusively': 'advanceInclusively' - } - - self._created = created - self._periods = periods - self._to = to - self._dry_run = dry_run - self._skip_intermediate_periods = skip_intermediate_periods - self._handle_amendments = handle_amendments - self._execution_strategy = execution_strategy - self._freeze_on_completion = freeze_on_completion - self._advance_inclusively = advance_inclusively + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'periods': 'int', + 'to': 'datetime', + 'dry_run': 'bool', + 'skip_intermediate_periods': 'bool', + 'handle_child_subscriptions': 'bool', + 'handle_amendments': 'bool', + 'execution_strategy': 'str', + 'freeze_on_completion': 'bool', + 'organization_id': 'str', + 'subscription_id': 'str', + 'advance_inclusively': 'bool' + } + + attribute_map = { + 'created': 'created', + 'periods': 'periods', + 'to': 'to', + 'dry_run': 'dryRun', + 'skip_intermediate_periods': 'skipIntermediatePeriods', + 'handle_child_subscriptions': 'handleChildSubscriptions', + 'handle_amendments': 'handleAmendments', + 'execution_strategy': 'executionStrategy', + 'freeze_on_completion': 'freezeOnCompletion', + 'organization_id': 'organizationID', + 'subscription_id': 'subscriptionID', + 'advance_inclusively': 'advanceInclusively' + } + + def __init__(self, created=None, periods=None, to=None, dry_run=None, skip_intermediate_periods=None, handle_child_subscriptions=None, handle_amendments=None, execution_strategy=None, freeze_on_completion=None, organization_id=None, subscription_id=None, advance_inclusively=None): # noqa: E501 + """TimeRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._periods = None + self._to = None + self._dry_run = None + self._skip_intermediate_periods = None + self._handle_child_subscriptions = None + self._handle_amendments = None + self._execution_strategy = None + self._freeze_on_completion = None + self._organization_id = None + self._subscription_id = None + self._advance_inclusively = None + self.discriminator = None + if created is not None: + self.created = created + if periods is not None: + self.periods = periods + if to is not None: + self.to = to + if dry_run is not None: + self.dry_run = dry_run + if skip_intermediate_periods is not None: + self.skip_intermediate_periods = skip_intermediate_periods + if handle_child_subscriptions is not None: + self.handle_child_subscriptions = handle_child_subscriptions + if handle_amendments is not None: + self.handle_amendments = handle_amendments + if execution_strategy is not None: + self.execution_strategy = execution_strategy + if freeze_on_completion is not None: + self.freeze_on_completion = freeze_on_completion + if organization_id is not None: + self.organization_id = organization_id + if subscription_id is not None: + self.subscription_id = subscription_id + if advance_inclusively is not None: + self.advance_inclusively = advance_inclusively @property def created(self): - """ - Gets the created of this TimeRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this TimeRequest. # noqa: E501 + - :return: The created of this TimeRequest. + :return: The created of this TimeRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this TimeRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this TimeRequest. - :param created: The created of this TimeRequest. + + :param created: The created of this TimeRequest. # noqa: E501 :type: datetime """ @@ -99,22 +120,20 @@ def created(self, created): @property def periods(self): - """ - Gets the periods of this TimeRequest. - {\"description\":\"(Required: one of [`periods`, `to`])
The number of period boundaries up to which the subscription should advance. A 1-value advances the subscription to the end of its current service period. Higher values advance the subscription to subsequent period boundaries.\"verbs\":[\"POST\",\"GET\"]} + """Gets the periods of this TimeRequest. # noqa: E501 + - :return: The periods of this TimeRequest. + :return: The periods of this TimeRequest. # noqa: E501 :rtype: int """ return self._periods @periods.setter def periods(self, periods): - """ - Sets the periods of this TimeRequest. - {\"description\":\"(Required: one of [`periods`, `to`])
The number of period boundaries up to which the subscription should advance. A 1-value advances the subscription to the end of its current service period. Higher values advance the subscription to subsequent period boundaries.\"verbs\":[\"POST\",\"GET\"]} + """Sets the periods of this TimeRequest. + - :param periods: The periods of this TimeRequest. + :param periods: The periods of this TimeRequest. # noqa: E501 :type: int """ @@ -122,22 +141,20 @@ def periods(self, periods): @property def to(self): - """ - Gets the to of this TimeRequest. - {\"description\":\"(Required: one of [`periods`, `to`])
The time up until which the subscription should be fast-forwarded.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the to of this TimeRequest. # noqa: E501 + - :return: The to of this TimeRequest. + :return: The to of this TimeRequest. # noqa: E501 :rtype: datetime """ return self._to @to.setter def to(self, to): - """ - Sets the to of this TimeRequest. - {\"description\":\"(Required: one of [`periods`, `to`])
The time up until which the subscription should be fast-forwarded.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the to of this TimeRequest. + - :param to: The to of this TimeRequest. + :param to: The to of this TimeRequest. # noqa: E501 :type: datetime """ @@ -145,22 +162,20 @@ def to(self, to): @property def dry_run(self): - """ - Gets the dry_run of this TimeRequest. - {\"default\":false,\"description\":\"Changes described in the response:
true — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.
false — Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the dry_run of this TimeRequest. # noqa: E501 - :return: The dry_run of this TimeRequest. + + :return: The dry_run of this TimeRequest. # noqa: E501 :rtype: bool """ return self._dry_run @dry_run.setter def dry_run(self, dry_run): - """ - Sets the dry_run of this TimeRequest. - {\"default\":false,\"description\":\"Changes described in the response:
true — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.
false — Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the dry_run of this TimeRequest. + - :param dry_run: The dry_run of this TimeRequest. + :param dry_run: The dry_run of this TimeRequest. # noqa: E501 :type: bool """ @@ -168,45 +183,62 @@ def dry_run(self, dry_run): @property def skip_intermediate_periods(self): - """ - Gets the skip_intermediate_periods of this TimeRequest. - {\"default\":false,\"description\":\"As time scrubs forward:
true — Raise no invoice upon advancing over a period boundary.
false — Raise invoices for any period that is entered.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the skip_intermediate_periods of this TimeRequest. # noqa: E501 + - :return: The skip_intermediate_periods of this TimeRequest. + :return: The skip_intermediate_periods of this TimeRequest. # noqa: E501 :rtype: bool """ return self._skip_intermediate_periods @skip_intermediate_periods.setter def skip_intermediate_periods(self, skip_intermediate_periods): - """ - Sets the skip_intermediate_periods of this TimeRequest. - {\"default\":false,\"description\":\"As time scrubs forward:
true — Raise no invoice upon advancing over a period boundary.
false — Raise invoices for any period that is entered.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the skip_intermediate_periods of this TimeRequest. - :param skip_intermediate_periods: The skip_intermediate_periods of this TimeRequest. + + :param skip_intermediate_periods: The skip_intermediate_periods of this TimeRequest. # noqa: E501 :type: bool """ self._skip_intermediate_periods = skip_intermediate_periods @property - def handle_amendments(self): + def handle_child_subscriptions(self): + """Gets the handle_child_subscriptions of this TimeRequest. # noqa: E501 + + + :return: The handle_child_subscriptions of this TimeRequest. # noqa: E501 + :rtype: bool """ - Gets the handle_amendments of this TimeRequest. - {\"default\":true,\"description\":\"As time scrubs forward:
true — Run any amendments that were scheduled to action.
false — Do not run any amendments that were scheduled to action.\",\"verbs\":[\"POST\",\"GET\"]} + return self._handle_child_subscriptions + + @handle_child_subscriptions.setter + def handle_child_subscriptions(self, handle_child_subscriptions): + """Sets the handle_child_subscriptions of this TimeRequest. + - :return: The handle_amendments of this TimeRequest. + :param handle_child_subscriptions: The handle_child_subscriptions of this TimeRequest. # noqa: E501 + :type: bool + """ + + self._handle_child_subscriptions = handle_child_subscriptions + + @property + def handle_amendments(self): + """Gets the handle_amendments of this TimeRequest. # noqa: E501 + + + :return: The handle_amendments of this TimeRequest. # noqa: E501 :rtype: bool """ return self._handle_amendments @handle_amendments.setter def handle_amendments(self, handle_amendments): - """ - Sets the handle_amendments of this TimeRequest. - {\"default\":true,\"description\":\"As time scrubs forward:
true — Run any amendments that were scheduled to action.
false — Do not run any amendments that were scheduled to action.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the handle_amendments of this TimeRequest. + - :param handle_amendments: The handle_amendments of this TimeRequest. + :param handle_amendments: The handle_amendments of this TimeRequest. # noqa: E501 :type: bool """ @@ -214,28 +246,26 @@ def handle_amendments(self, handle_amendments): @property def execution_strategy(self): - """ - Gets the execution_strategy of this TimeRequest. - {\"default\":\"SingleAttempt\",\"description\":\"What strategy to use when executing any invoices raised as time advances:
SingleAttempt — Execute any invoice just once.
FollowDunning — Apply the existing dunning strategy when executing invoices.
None: Do not execute invoices.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the execution_strategy of this TimeRequest. # noqa: E501 + - :return: The execution_strategy of this TimeRequest. + :return: The execution_strategy of this TimeRequest. # noqa: E501 :rtype: str """ return self._execution_strategy @execution_strategy.setter def execution_strategy(self, execution_strategy): - """ - Sets the execution_strategy of this TimeRequest. - {\"default\":\"SingleAttempt\",\"description\":\"What strategy to use when executing any invoices raised as time advances:
SingleAttempt — Execute any invoice just once.
FollowDunning — Apply the existing dunning strategy when executing invoices.
None: Do not execute invoices.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the execution_strategy of this TimeRequest. - :param execution_strategy: The execution_strategy of this TimeRequest. + + :param execution_strategy: The execution_strategy of this TimeRequest. # noqa: E501 :type: str """ - allowed_values = ["SingleAttempt", "FollowDunning", "None"] + allowed_values = ["SingleAttempt", "FollowDunning", "None"] # noqa: E501 if execution_strategy not in allowed_values: raise ValueError( - "Invalid value for `execution_strategy` ({0}), must be one of {1}" + "Invalid value for `execution_strategy` ({0}), must be one of {1}" # noqa: E501 .format(execution_strategy, allowed_values) ) @@ -243,57 +273,93 @@ def execution_strategy(self, execution_strategy): @property def freeze_on_completion(self): - """ - Gets the freeze_on_completion of this TimeRequest. - {\"default\":false,\"description\":\"Once the subscription is advanced through time:
true — Freeze the subscription.
false — Do not freeze the subscription.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the freeze_on_completion of this TimeRequest. # noqa: E501 + - :return: The freeze_on_completion of this TimeRequest. + :return: The freeze_on_completion of this TimeRequest. # noqa: E501 :rtype: bool """ return self._freeze_on_completion @freeze_on_completion.setter def freeze_on_completion(self, freeze_on_completion): - """ - Sets the freeze_on_completion of this TimeRequest. - {\"default\":false,\"description\":\"Once the subscription is advanced through time:
true — Freeze the subscription.
false — Do not freeze the subscription.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the freeze_on_completion of this TimeRequest. + - :param freeze_on_completion: The freeze_on_completion of this TimeRequest. + :param freeze_on_completion: The freeze_on_completion of this TimeRequest. # noqa: E501 :type: bool """ self._freeze_on_completion = freeze_on_completion @property - def advance_inclusively(self): + def organization_id(self): + """Gets the organization_id of this TimeRequest. # noqa: E501 + + + :return: The organization_id of this TimeRequest. # noqa: E501 + :rtype: str """ - Gets the advance_inclusively of this TimeRequest. - {\"default\":true,\"description\":\"When advancing onto an instant in time:
true — Action the events scheduled for your destination time. Amendments scheduled at your destined time will be actioned during this time travel. Advancing to a period boundary will promote your subscription to the period on the future side of that boundary.
false — Do not action events scheduled for your destination time. Amendments scheduled at your destined time will not be actioned during this time travel. Advancing to a period boundary will result in your subscription's remaining within the period on the past side of that boundary.\",\"verbs\":[\"POST\",\"GET\"]} + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this TimeRequest. - :return: The advance_inclusively of this TimeRequest. + + :param organization_id: The organization_id of this TimeRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def subscription_id(self): + """Gets the subscription_id of this TimeRequest. # noqa: E501 + + + :return: The subscription_id of this TimeRequest. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this TimeRequest. + + + :param subscription_id: The subscription_id of this TimeRequest. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def advance_inclusively(self): + """Gets the advance_inclusively of this TimeRequest. # noqa: E501 + + + :return: The advance_inclusively of this TimeRequest. # noqa: E501 :rtype: bool """ return self._advance_inclusively @advance_inclusively.setter def advance_inclusively(self, advance_inclusively): - """ - Sets the advance_inclusively of this TimeRequest. - {\"default\":true,\"description\":\"When advancing onto an instant in time:
true — Action the events scheduled for your destination time. Amendments scheduled at your destined time will be actioned during this time travel. Advancing to a period boundary will promote your subscription to the period on the future side of that boundary.
false — Do not action events scheduled for your destination time. Amendments scheduled at your destined time will not be actioned during this time travel. Advancing to a period boundary will result in your subscription's remaining within the period on the past side of that boundary.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the advance_inclusively of this TimeRequest. - :param advance_inclusively: The advance_inclusively of this TimeRequest. + + :param advance_inclusively: The advance_inclusively of this TimeRequest. # noqa: E501 :type: bool """ self._advance_inclusively = advance_inclusively def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -310,29 +376,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(TimeRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, TimeRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/time_response.py b/billforward/models/time_response.py index 718e785..73d6f04 100644 --- a/billforward/models/time_response.py +++ b/billforward/models/time_response.py @@ -1,103 +1,128 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class TimeResponse(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, periods=None, to=None, dry_run=False, skip_intermediate_periods=False, handle_amendments=False, execution_strategy=None, freeze_on_completion=False, advance_inclusively=False, subscriptions=None, invoices=None): - """ - TimeResponse - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'periods': 'int', - 'to': 'datetime', - 'dry_run': 'bool', - 'skip_intermediate_periods': 'bool', - 'handle_amendments': 'bool', - 'execution_strategy': 'str', - 'freeze_on_completion': 'bool', - 'advance_inclusively': 'bool', - 'subscriptions': 'list[Subscription]', - 'invoices': 'list[Invoice]' - } - - self.attribute_map = { - 'created': 'created', - 'periods': 'periods', - 'to': 'to', - 'dry_run': 'dryRun', - 'skip_intermediate_periods': 'skipIntermediatePeriods', - 'handle_amendments': 'handleAmendments', - 'execution_strategy': 'executionStrategy', - 'freeze_on_completion': 'freezeOnCompletion', - 'advance_inclusively': 'advanceInclusively', - 'subscriptions': 'subscriptions', - 'invoices': 'invoices' - } - - self._created = created - self._periods = periods - self._to = to - self._dry_run = dry_run - self._skip_intermediate_periods = skip_intermediate_periods - self._handle_amendments = handle_amendments - self._execution_strategy = execution_strategy - self._freeze_on_completion = freeze_on_completion - self._advance_inclusively = advance_inclusively - self._subscriptions = subscriptions - self._invoices = invoices + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'periods': 'int', + 'to': 'datetime', + 'dry_run': 'bool', + 'skip_intermediate_periods': 'bool', + 'handle_child_subscriptions': 'bool', + 'handle_amendments': 'bool', + 'execution_strategy': 'str', + 'freeze_on_completion': 'bool', + 'organization_id': 'str', + 'subscription_id': 'str', + 'advance_inclusively': 'bool', + 'subscriptions': 'list[Subscription]', + 'invoices': 'list[Invoice]' + } + + attribute_map = { + 'created': 'created', + 'periods': 'periods', + 'to': 'to', + 'dry_run': 'dryRun', + 'skip_intermediate_periods': 'skipIntermediatePeriods', + 'handle_child_subscriptions': 'handleChildSubscriptions', + 'handle_amendments': 'handleAmendments', + 'execution_strategy': 'executionStrategy', + 'freeze_on_completion': 'freezeOnCompletion', + 'organization_id': 'organizationID', + 'subscription_id': 'subscriptionID', + 'advance_inclusively': 'advanceInclusively', + 'subscriptions': 'subscriptions', + 'invoices': 'invoices' + } + + def __init__(self, created=None, periods=None, to=None, dry_run=None, skip_intermediate_periods=None, handle_child_subscriptions=None, handle_amendments=None, execution_strategy=None, freeze_on_completion=None, organization_id=None, subscription_id=None, advance_inclusively=None, subscriptions=None, invoices=None): # noqa: E501 + """TimeResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._periods = None + self._to = None + self._dry_run = None + self._skip_intermediate_periods = None + self._handle_child_subscriptions = None + self._handle_amendments = None + self._execution_strategy = None + self._freeze_on_completion = None + self._organization_id = None + self._subscription_id = None + self._advance_inclusively = None + self._subscriptions = None + self._invoices = None + self.discriminator = None + if created is not None: + self.created = created + if periods is not None: + self.periods = periods + if to is not None: + self.to = to + if dry_run is not None: + self.dry_run = dry_run + if skip_intermediate_periods is not None: + self.skip_intermediate_periods = skip_intermediate_periods + if handle_child_subscriptions is not None: + self.handle_child_subscriptions = handle_child_subscriptions + if handle_amendments is not None: + self.handle_amendments = handle_amendments + if execution_strategy is not None: + self.execution_strategy = execution_strategy + if freeze_on_completion is not None: + self.freeze_on_completion = freeze_on_completion + if organization_id is not None: + self.organization_id = organization_id + if subscription_id is not None: + self.subscription_id = subscription_id + if advance_inclusively is not None: + self.advance_inclusively = advance_inclusively + if subscriptions is not None: + self.subscriptions = subscriptions + if invoices is not None: + self.invoices = invoices @property def created(self): - """ - Gets the created of this TimeResponse. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this TimeResponse. # noqa: E501 - :return: The created of this TimeResponse. + + :return: The created of this TimeResponse. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this TimeResponse. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this TimeResponse. - :param created: The created of this TimeResponse. + + :param created: The created of this TimeResponse. # noqa: E501 :type: datetime """ @@ -105,22 +130,20 @@ def created(self, created): @property def periods(self): - """ - Gets the periods of this TimeResponse. - {\"description\":\"(Required: one of [`periods`, `to`])
The number of period boundaries up to which the subscription should advance. A 1-value advances the subscription to the end of its current service period. Higher values advance the subscription to subsequent period boundaries.\"verbs\":[\"POST\",\"GET\"]} + """Gets the periods of this TimeResponse. # noqa: E501 + - :return: The periods of this TimeResponse. + :return: The periods of this TimeResponse. # noqa: E501 :rtype: int """ return self._periods @periods.setter def periods(self, periods): - """ - Sets the periods of this TimeResponse. - {\"description\":\"(Required: one of [`periods`, `to`])
The number of period boundaries up to which the subscription should advance. A 1-value advances the subscription to the end of its current service period. Higher values advance the subscription to subsequent period boundaries.\"verbs\":[\"POST\",\"GET\"]} + """Sets the periods of this TimeResponse. + - :param periods: The periods of this TimeResponse. + :param periods: The periods of this TimeResponse. # noqa: E501 :type: int """ @@ -128,22 +151,20 @@ def periods(self, periods): @property def to(self): - """ - Gets the to of this TimeResponse. - {\"description\":\"(Required: one of [`periods`, `to`])
The time up until which the subscription should be fast-forwarded.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the to of this TimeResponse. # noqa: E501 + - :return: The to of this TimeResponse. + :return: The to of this TimeResponse. # noqa: E501 :rtype: datetime """ return self._to @to.setter def to(self, to): - """ - Sets the to of this TimeResponse. - {\"description\":\"(Required: one of [`periods`, `to`])
The time up until which the subscription should be fast-forwarded.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the to of this TimeResponse. + - :param to: The to of this TimeResponse. + :param to: The to of this TimeResponse. # noqa: E501 :type: datetime """ @@ -151,22 +172,20 @@ def to(self, to): @property def dry_run(self): - """ - Gets the dry_run of this TimeResponse. - {\"default\":false,\"description\":\"Changes described in the response:
true — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.
false — Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the dry_run of this TimeResponse. # noqa: E501 - :return: The dry_run of this TimeResponse. + + :return: The dry_run of this TimeResponse. # noqa: E501 :rtype: bool """ return self._dry_run @dry_run.setter def dry_run(self, dry_run): - """ - Sets the dry_run of this TimeResponse. - {\"default\":false,\"description\":\"Changes described in the response:
true — Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.
false — Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the dry_run of this TimeResponse. - :param dry_run: The dry_run of this TimeResponse. + + :param dry_run: The dry_run of this TimeResponse. # noqa: E501 :type: bool """ @@ -174,45 +193,62 @@ def dry_run(self, dry_run): @property def skip_intermediate_periods(self): - """ - Gets the skip_intermediate_periods of this TimeResponse. - {\"default\":false,\"description\":\"As time scrubs forward:
true — Raise no invoice upon advancing over a period boundary.
false — Raise invoices for any period that is entered.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the skip_intermediate_periods of this TimeResponse. # noqa: E501 - :return: The skip_intermediate_periods of this TimeResponse. + + :return: The skip_intermediate_periods of this TimeResponse. # noqa: E501 :rtype: bool """ return self._skip_intermediate_periods @skip_intermediate_periods.setter def skip_intermediate_periods(self, skip_intermediate_periods): - """ - Sets the skip_intermediate_periods of this TimeResponse. - {\"default\":false,\"description\":\"As time scrubs forward:
true — Raise no invoice upon advancing over a period boundary.
false — Raise invoices for any period that is entered.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the skip_intermediate_periods of this TimeResponse. + - :param skip_intermediate_periods: The skip_intermediate_periods of this TimeResponse. + :param skip_intermediate_periods: The skip_intermediate_periods of this TimeResponse. # noqa: E501 :type: bool """ self._skip_intermediate_periods = skip_intermediate_periods @property - def handle_amendments(self): + def handle_child_subscriptions(self): + """Gets the handle_child_subscriptions of this TimeResponse. # noqa: E501 + + + :return: The handle_child_subscriptions of this TimeResponse. # noqa: E501 + :rtype: bool """ - Gets the handle_amendments of this TimeResponse. - {\"default\":true,\"description\":\"As time scrubs forward:
true — Run any amendments that were scheduled to action.
false — Do not run any amendments that were scheduled to action.\",\"verbs\":[\"POST\",\"GET\"]} + return self._handle_child_subscriptions + + @handle_child_subscriptions.setter + def handle_child_subscriptions(self, handle_child_subscriptions): + """Sets the handle_child_subscriptions of this TimeResponse. + + + :param handle_child_subscriptions: The handle_child_subscriptions of this TimeResponse. # noqa: E501 + :type: bool + """ + + self._handle_child_subscriptions = handle_child_subscriptions + + @property + def handle_amendments(self): + """Gets the handle_amendments of this TimeResponse. # noqa: E501 - :return: The handle_amendments of this TimeResponse. + + :return: The handle_amendments of this TimeResponse. # noqa: E501 :rtype: bool """ return self._handle_amendments @handle_amendments.setter def handle_amendments(self, handle_amendments): - """ - Sets the handle_amendments of this TimeResponse. - {\"default\":true,\"description\":\"As time scrubs forward:
true — Run any amendments that were scheduled to action.
false — Do not run any amendments that were scheduled to action.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the handle_amendments of this TimeResponse. - :param handle_amendments: The handle_amendments of this TimeResponse. + + :param handle_amendments: The handle_amendments of this TimeResponse. # noqa: E501 :type: bool """ @@ -220,28 +256,26 @@ def handle_amendments(self, handle_amendments): @property def execution_strategy(self): - """ - Gets the execution_strategy of this TimeResponse. - {\"default\":\"SingleAttempt\",\"description\":\"What strategy to use when executing any invoices raised as time advances:
SingleAttempt — Execute any invoice just once.
FollowDunning — Apply the existing dunning strategy when executing invoices.
None: Do not execute invoices.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the execution_strategy of this TimeResponse. # noqa: E501 - :return: The execution_strategy of this TimeResponse. + + :return: The execution_strategy of this TimeResponse. # noqa: E501 :rtype: str """ return self._execution_strategy @execution_strategy.setter def execution_strategy(self, execution_strategy): - """ - Sets the execution_strategy of this TimeResponse. - {\"default\":\"SingleAttempt\",\"description\":\"What strategy to use when executing any invoices raised as time advances:
SingleAttempt — Execute any invoice just once.
FollowDunning — Apply the existing dunning strategy when executing invoices.
None: Do not execute invoices.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the execution_strategy of this TimeResponse. + - :param execution_strategy: The execution_strategy of this TimeResponse. + :param execution_strategy: The execution_strategy of this TimeResponse. # noqa: E501 :type: str """ - allowed_values = ["SingleAttempt", "FollowDunning", "None"] + allowed_values = ["SingleAttempt", "FollowDunning", "None"] # noqa: E501 if execution_strategy not in allowed_values: raise ValueError( - "Invalid value for `execution_strategy` ({0}), must be one of {1}" + "Invalid value for `execution_strategy` ({0}), must be one of {1}" # noqa: E501 .format(execution_strategy, allowed_values) ) @@ -249,45 +283,83 @@ def execution_strategy(self, execution_strategy): @property def freeze_on_completion(self): - """ - Gets the freeze_on_completion of this TimeResponse. - {\"default\":false,\"description\":\"Once the subscription is advanced through time:
true — Freeze the subscription.
false — Do not freeze the subscription.\",\"verbs\":[\"POST\",\"GET\"]} + """Gets the freeze_on_completion of this TimeResponse. # noqa: E501 + - :return: The freeze_on_completion of this TimeResponse. + :return: The freeze_on_completion of this TimeResponse. # noqa: E501 :rtype: bool """ return self._freeze_on_completion @freeze_on_completion.setter def freeze_on_completion(self, freeze_on_completion): - """ - Sets the freeze_on_completion of this TimeResponse. - {\"default\":false,\"description\":\"Once the subscription is advanced through time:
true — Freeze the subscription.
false — Do not freeze the subscription.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the freeze_on_completion of this TimeResponse. + - :param freeze_on_completion: The freeze_on_completion of this TimeResponse. + :param freeze_on_completion: The freeze_on_completion of this TimeResponse. # noqa: E501 :type: bool """ self._freeze_on_completion = freeze_on_completion @property - def advance_inclusively(self): + def organization_id(self): + """Gets the organization_id of this TimeResponse. # noqa: E501 + + + :return: The organization_id of this TimeResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this TimeResponse. + + + :param organization_id: The organization_id of this TimeResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def subscription_id(self): + """Gets the subscription_id of this TimeResponse. # noqa: E501 + + + :return: The subscription_id of this TimeResponse. # noqa: E501 + :rtype: str """ - Gets the advance_inclusively of this TimeResponse. - {\"default\":true,\"description\":\"When advancing onto an instant in time:
true — Action the events scheduled for your destination time. Amendments scheduled at your destined time will be actioned during this time travel. Advancing to a period boundary will promote your subscription to the period on the future side of that boundary.
false — Do not action events scheduled for your destination time. Amendments scheduled at your destined time will not be actioned during this time travel. Advancing to a period boundary will result in your subscription's remaining within the period on the past side of that boundary.\",\"verbs\":[\"POST\",\"GET\"]} + return self._subscription_id - :return: The advance_inclusively of this TimeResponse. + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this TimeResponse. + + + :param subscription_id: The subscription_id of this TimeResponse. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def advance_inclusively(self): + """Gets the advance_inclusively of this TimeResponse. # noqa: E501 + + + :return: The advance_inclusively of this TimeResponse. # noqa: E501 :rtype: bool """ return self._advance_inclusively @advance_inclusively.setter def advance_inclusively(self, advance_inclusively): - """ - Sets the advance_inclusively of this TimeResponse. - {\"default\":true,\"description\":\"When advancing onto an instant in time:
true — Action the events scheduled for your destination time. Amendments scheduled at your destined time will be actioned during this time travel. Advancing to a period boundary will promote your subscription to the period on the future side of that boundary.
false — Do not action events scheduled for your destination time. Amendments scheduled at your destined time will not be actioned during this time travel. Advancing to a period boundary will result in your subscription's remaining within the period on the past side of that boundary.\",\"verbs\":[\"POST\",\"GET\"]} + """Sets the advance_inclusively of this TimeResponse. - :param advance_inclusively: The advance_inclusively of this TimeResponse. + + :param advance_inclusively: The advance_inclusively of this TimeResponse. # noqa: E501 :type: bool """ @@ -295,22 +367,20 @@ def advance_inclusively(self, advance_inclusively): @property def subscriptions(self): - """ - Gets the subscriptions of this TimeResponse. + """Gets the subscriptions of this TimeResponse. # noqa: E501 - :return: The subscriptions of this TimeResponse. + :return: The subscriptions of this TimeResponse. # noqa: E501 :rtype: list[Subscription] """ return self._subscriptions @subscriptions.setter def subscriptions(self, subscriptions): - """ - Sets the subscriptions of this TimeResponse. + """Sets the subscriptions of this TimeResponse. - :param subscriptions: The subscriptions of this TimeResponse. + :param subscriptions: The subscriptions of this TimeResponse. # noqa: E501 :type: list[Subscription] """ @@ -318,34 +388,30 @@ def subscriptions(self, subscriptions): @property def invoices(self): - """ - Gets the invoices of this TimeResponse. + """Gets the invoices of this TimeResponse. # noqa: E501 - :return: The invoices of this TimeResponse. + :return: The invoices of this TimeResponse. # noqa: E501 :rtype: list[Invoice] """ return self._invoices @invoices.setter def invoices(self, invoices): - """ - Sets the invoices of this TimeResponse. + """Sets the invoices of this TimeResponse. - :param invoices: The invoices of this TimeResponse. + :param invoices: The invoices of this TimeResponse. # noqa: E501 :type: list[Invoice] """ self._invoices = invoices def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -362,29 +428,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(TimeResponse, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, TimeResponse): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/time_response_paged_metadata.py b/billforward/models/time_response_paged_metadata.py deleted file mode 100644 index 3266075..0000000 --- a/billforward/models/time_response_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class TimeResponsePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - TimeResponsePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[TimeResponse]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this TimeResponsePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this TimeResponsePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this TimeResponsePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this TimeResponsePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this TimeResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this TimeResponsePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this TimeResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this TimeResponsePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this TimeResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this TimeResponsePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this TimeResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this TimeResponsePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this TimeResponsePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this TimeResponsePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this TimeResponsePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this TimeResponsePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this TimeResponsePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this TimeResponsePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this TimeResponsePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this TimeResponsePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this TimeResponsePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this TimeResponsePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this TimeResponsePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this TimeResponsePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this TimeResponsePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this TimeResponsePagedMetadata. - :rtype: list[TimeResponse] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this TimeResponsePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this TimeResponsePagedMetadata. - :type: list[TimeResponse] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/time_zone.py b/billforward/models/time_zone.py deleted file mode 100644 index 4c78013..0000000 --- a/billforward/models/time_zone.py +++ /dev/null @@ -1,202 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class TimeZone(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, display_name=None, id=None, dstsavings=None, raw_offset=None): - """ - TimeZone - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'display_name': 'str', - 'id': 'str', - 'dstsavings': 'int', - 'raw_offset': 'int' - } - - self.attribute_map = { - 'display_name': 'displayName', - 'id': 'id', - 'dstsavings': 'dstsavings', - 'raw_offset': 'rawOffset' - } - - self._display_name = display_name - self._id = id - self._dstsavings = dstsavings - self._raw_offset = raw_offset - - @property - def display_name(self): - """ - Gets the display_name of this TimeZone. - - - :return: The display_name of this TimeZone. - :rtype: str - """ - return self._display_name - - @display_name.setter - def display_name(self, display_name): - """ - Sets the display_name of this TimeZone. - - - :param display_name: The display_name of this TimeZone. - :type: str - """ - - self._display_name = display_name - - @property - def id(self): - """ - Gets the id of this TimeZone. - - - :return: The id of this TimeZone. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this TimeZone. - - - :param id: The id of this TimeZone. - :type: str - """ - - self._id = id - - @property - def dstsavings(self): - """ - Gets the dstsavings of this TimeZone. - - - :return: The dstsavings of this TimeZone. - :rtype: int - """ - return self._dstsavings - - @dstsavings.setter - def dstsavings(self, dstsavings): - """ - Sets the dstsavings of this TimeZone. - - - :param dstsavings: The dstsavings of this TimeZone. - :type: int - """ - - self._dstsavings = dstsavings - - @property - def raw_offset(self): - """ - Gets the raw_offset of this TimeZone. - - - :return: The raw_offset of this TimeZone. - :rtype: int - """ - return self._raw_offset - - @raw_offset.setter - def raw_offset(self, raw_offset): - """ - Sets the raw_offset of this TimeZone. - - - :param raw_offset: The raw_offset of this TimeZone. - :type: int - """ - - self._raw_offset = raw_offset - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/timer_amendment.py b/billforward/models/timer_amendment.py index 8291df4..be70b83 100644 --- a/billforward/models/timer_amendment.py +++ b/billforward/models/timer_amendment.py @@ -1,421 +1,99 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class TimerAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class TimerAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False, entity_id=None, entity=None, offset_direction=None, offset_period=None, offset_duration=None, original_event_date=None, timer_event=None): - """ - TimerAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool', - 'entity_id': 'str', - 'entity': 'str', - 'offset_direction': 'str', - 'offset_period': 'str', - 'offset_duration': 'int', - 'original_event_date': 'datetime', - 'timer_event': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted', - 'entity_id': 'entityID', - 'entity': 'entity', - 'offset_direction': 'offsetDirection', - 'offset_period': 'offsetPeriod', - 'offset_duration': 'offsetDuration', - 'original_event_date': 'originalEventDate', - 'timer_event': 'timerEvent' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - self._entity_id = entity_id - self._entity = entity - self._offset_direction = offset_direction - self._offset_period = offset_period - self._offset_duration = offset_duration - self._original_event_date = original_event_date - self._timer_event = timer_event - - @property - def created(self): - """ - Gets the created of this TimerAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this TimerAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this TimerAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this TimerAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this TimerAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this TimerAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this TimerAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this TimerAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this TimerAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this TimerAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this TimerAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this TimerAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this TimerAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this TimerAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this TimerAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this TimerAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def id(self): - """ - Gets the id of this TimerAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this TimerAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this TimerAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this TimerAmendment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this TimerAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this TimerAmendment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this TimerAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this TimerAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this TimerAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this TimerAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this TimerAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this TimerAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this TimerAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this TimerAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this TimerAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this TimerAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this TimerAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this TimerAmendment. - :rtype: datetime - """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this TimerAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actioning_time: The actioning_time of this TimerAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this TimerAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this TimerAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this TimerAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :param actioned_time: The actioned_time of this TimerAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this TimerAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this TimerAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this TimerAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this TimerAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this TimerAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this TimerAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this TimerAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this TimerAmendment. - :type: bool - """ - - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_id': 'str', + 'entity': 'str', + 'offset_duration': 'int', + 'offset_period': 'str', + 'offset_direction': 'str', + 'original_event_date': 'datetime', + 'timer_event': 'str' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'entity_id': 'entityID', + 'entity': 'entity', + 'offset_duration': 'offsetDuration', + 'offset_period': 'offsetPeriod', + 'offset_direction': 'offsetDirection', + 'original_event_date': 'originalEventDate', + 'timer_event': 'timerEvent' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, entity_id=None, entity=None, offset_duration=None, offset_period=None, offset_direction=None, original_event_date=None, timer_event=None, *args, **kwargs): # noqa: E501 + """TimerAmendment - a model defined in Swagger""" # noqa: E501 + self._entity_id = None + self._entity = None + self._offset_duration = None + self._offset_period = None + self._offset_direction = None + self._original_event_date = None + self._timer_event = None + self.discriminator = None + if entity_id is not None: + self.entity_id = entity_id + if entity is not None: + self.entity = entity + if offset_duration is not None: + self.offset_duration = offset_duration + if offset_period is not None: + self.offset_period = offset_period + if offset_direction is not None: + self.offset_direction = offset_direction + if original_event_date is not None: + self.original_event_date = original_event_date + if timer_event is not None: + self.timer_event = timer_event + Amendment.__init__(self, *args, **kwargs) @property def entity_id(self): - """ - Gets the entity_id of this TimerAmendment. + """Gets the entity_id of this TimerAmendment. # noqa: E501 - :return: The entity_id of this TimerAmendment. + :return: The entity_id of this TimerAmendment. # noqa: E501 :rtype: str """ return self._entity_id @entity_id.setter def entity_id(self, entity_id): - """ - Sets the entity_id of this TimerAmendment. + """Sets the entity_id of this TimerAmendment. - :param entity_id: The entity_id of this TimerAmendment. + :param entity_id: The entity_id of this TimerAmendment. # noqa: E501 :type: str """ @@ -423,132 +101,122 @@ def entity_id(self, entity_id): @property def entity(self): - """ - Gets the entity of this TimerAmendment. + """Gets the entity of this TimerAmendment. # noqa: E501 - :return: The entity of this TimerAmendment. + :return: The entity of this TimerAmendment. # noqa: E501 :rtype: str """ return self._entity @entity.setter def entity(self, entity): - """ - Sets the entity of this TimerAmendment. + """Sets the entity of this TimerAmendment. - :param entity: The entity of this TimerAmendment. + :param entity: The entity of this TimerAmendment. # noqa: E501 :type: str """ - allowed_values = ["Notification", "Organization", "OrganizationGateway", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "PaypalSimplePaymentReconciliation", "FreePaymentReconciliation", "LocustworldPaymentReconciliation", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "SearchResult", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "BalancedToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "GatewayRevenue", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "CassResult", "CassPaymentResult", "CassProductRatePlanResult", "CassChurnResult", "CassUpgradeResult", "SubscriptionCharge", "CassPaymentPProductResult", "ProductPaymentsArgs", "StripeACHToken", "UsageAmount", "UsageSession", "Usage", "UsagePeriod", "Period", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "FreePayment", "BraintreePayment", "BalancedPayment", "CybersourcePayment", "PaypalPayment", "PaypalSimplePayment", "LocustWorldPayment", "StripeOnlyPayment", "ProductPaymentsResult", "StripeACHPayment", "AuthorizeNetPayment", "CompoundUsageSession", "CompoundUsage", "UsageRoundingStrategies", "BillforwardManagedPaymentsResult", "PricingComponentValueMigrationChargeAmendmentMapping", "SubscriptionLTVResult", "AccountLTVResult", "ProductRatePlanPaymentsResult", "DebtsResult", "AccountPaymentsResult", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "AggregationLink", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "RevenueAttribution"] + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 if entity not in allowed_values: raise ValueError( - "Invalid value for `entity` ({0}), must be one of {1}" + "Invalid value for `entity` ({0}), must be one of {1}" # noqa: E501 .format(entity, allowed_values) ) self._entity = entity @property - def offset_direction(self): - """ - Gets the offset_direction of this TimerAmendment. + def offset_duration(self): + """Gets the offset_duration of this TimerAmendment. # noqa: E501 - :return: The offset_direction of this TimerAmendment. - :rtype: str + :return: The offset_duration of this TimerAmendment. # noqa: E501 + :rtype: int """ - return self._offset_direction + return self._offset_duration - @offset_direction.setter - def offset_direction(self, offset_direction): - """ - Sets the offset_direction of this TimerAmendment. + @offset_duration.setter + def offset_duration(self, offset_duration): + """Sets the offset_duration of this TimerAmendment. - :param offset_direction: The offset_direction of this TimerAmendment. - :type: str + :param offset_duration: The offset_duration of this TimerAmendment. # noqa: E501 + :type: int """ - allowed_values = ["Before", "After"] - if offset_direction not in allowed_values: - raise ValueError( - "Invalid value for `offset_direction` ({0}), must be one of {1}" - .format(offset_direction, allowed_values) - ) - self._offset_direction = offset_direction + self._offset_duration = offset_duration @property def offset_period(self): - """ - Gets the offset_period of this TimerAmendment. + """Gets the offset_period of this TimerAmendment. # noqa: E501 - :return: The offset_period of this TimerAmendment. + :return: The offset_period of this TimerAmendment. # noqa: E501 :rtype: str """ return self._offset_period @offset_period.setter def offset_period(self, offset_period): - """ - Sets the offset_period of this TimerAmendment. + """Sets the offset_period of this TimerAmendment. - :param offset_period: The offset_period of this TimerAmendment. + :param offset_period: The offset_period of this TimerAmendment. # noqa: E501 :type: str """ - allowed_values = ["Minutes", "Hours", "Days"] + allowed_values = ["Minutes", "Hours", "Days"] # noqa: E501 if offset_period not in allowed_values: raise ValueError( - "Invalid value for `offset_period` ({0}), must be one of {1}" + "Invalid value for `offset_period` ({0}), must be one of {1}" # noqa: E501 .format(offset_period, allowed_values) ) self._offset_period = offset_period @property - def offset_duration(self): - """ - Gets the offset_duration of this TimerAmendment. + def offset_direction(self): + """Gets the offset_direction of this TimerAmendment. # noqa: E501 - :return: The offset_duration of this TimerAmendment. - :rtype: int + :return: The offset_direction of this TimerAmendment. # noqa: E501 + :rtype: str """ - return self._offset_duration + return self._offset_direction - @offset_duration.setter - def offset_duration(self, offset_duration): - """ - Sets the offset_duration of this TimerAmendment. + @offset_direction.setter + def offset_direction(self, offset_direction): + """Sets the offset_direction of this TimerAmendment. - :param offset_duration: The offset_duration of this TimerAmendment. - :type: int + :param offset_direction: The offset_direction of this TimerAmendment. # noqa: E501 + :type: str """ + allowed_values = ["Before", "After"] # noqa: E501 + if offset_direction not in allowed_values: + raise ValueError( + "Invalid value for `offset_direction` ({0}), must be one of {1}" # noqa: E501 + .format(offset_direction, allowed_values) + ) - self._offset_duration = offset_duration + self._offset_direction = offset_direction @property def original_event_date(self): - """ - Gets the original_event_date of this TimerAmendment. + """Gets the original_event_date of this TimerAmendment. # noqa: E501 - :return: The original_event_date of this TimerAmendment. + :return: The original_event_date of this TimerAmendment. # noqa: E501 :rtype: datetime """ return self._original_event_date @original_event_date.setter def original_event_date(self, original_event_date): - """ - Sets the original_event_date of this TimerAmendment. + """Sets the original_event_date of this TimerAmendment. - :param original_event_date: The original_event_date of this TimerAmendment. + :param original_event_date: The original_event_date of this TimerAmendment. # noqa: E501 :type: datetime """ @@ -556,40 +224,36 @@ def original_event_date(self, original_event_date): @property def timer_event(self): - """ - Gets the timer_event of this TimerAmendment. + """Gets the timer_event of this TimerAmendment. # noqa: E501 - :return: The timer_event of this TimerAmendment. + :return: The timer_event of this TimerAmendment. # noqa: E501 :rtype: str """ return self._timer_event @timer_event.setter def timer_event(self, timer_event): - """ - Sets the timer_event of this TimerAmendment. + """Sets the timer_event of this TimerAmendment. - :param timer_event: The timer_event of this TimerAmendment. + :param timer_event: The timer_event of this TimerAmendment. # noqa: E501 :type: str """ - allowed_values = ["TrialExpiry", "SubscriptionExpiry", "PeriodEnd"] + allowed_values = ["TrialExpiry", "SubscriptionExpiry", "PeriodEnd"] # noqa: E501 if timer_event not in allowed_values: raise ValueError( - "Invalid value for `timer_event` ({0}), must be one of {1}" + "Invalid value for `timer_event` ({0}), must be one of {1}" # noqa: E501 .format(timer_event, allowed_values) ) self._timer_event = timer_event def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -606,29 +270,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(TimerAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, TimerAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/tokenization_epxredirect_body.py b/billforward/models/tokenization_epxredirect_body.py new file mode 100644 index 0000000..eeae190 --- /dev/null +++ b/billforward/models/tokenization_epxredirect_body.py @@ -0,0 +1,916 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TokenizationEpxredirectBody(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'cust_nbr': 'str', + 'merch_nbr': 'str', + 'dba_nbr': 'str', + 'terminal_nbr': 'str', + 'tran_code': 'str', + 'amount': 'str', + 'auth_account': 'str', + 'first_name': 'str', + 'last_name': 'str', + 'exp_date': 'str', + 'bp_resp_code': 'str', + 'bp_resp_text': 'str', + 'bp_field_errors': 'str', + 'msg_version': 'str', + 'tran_type': 'str', + 'tran_nbr': 'str', + 'local_date': 'str', + 'local_time': 'str', + 'auth_guid': 'str', + 'auth_resp': 'str', + 'auth_code': 'str', + 'auth_cvv2': 'str', + 'auth_resp_text': 'str', + 'auth_card_type': 'str', + 'auth_tran_date_gmt': 'str', + 'auth_amount_requested': 'str', + 'auth_amount': 'str', + 'auth_currency_code': 'str', + 'network_response': 'str', + 'auth_masked_account_nbr': 'str', + 'user_data_9': 'str', + 'user_data_10': 'str' + } + + attribute_map = { + 'cust_nbr': 'CUST_NBR', + 'merch_nbr': 'MERCH_NBR', + 'dba_nbr': 'DBA_NBR', + 'terminal_nbr': 'TERMINAL_NBR', + 'tran_code': 'TRAN_CODE', + 'amount': 'AMOUNT', + 'auth_account': 'AUTH_ACCOUNT', + 'first_name': 'FIRST_NAME', + 'last_name': 'LAST_NAME', + 'exp_date': 'EXP_DATE', + 'bp_resp_code': 'BP_RESP_CODE', + 'bp_resp_text': 'BP_RESP_TEXT', + 'bp_field_errors': 'BP_FIELD_ERRORS', + 'msg_version': 'MSG_VERSION', + 'tran_type': 'TRAN_TYPE', + 'tran_nbr': 'TRAN_NBR', + 'local_date': 'LOCAL_DATE', + 'local_time': 'LOCAL_TIME', + 'auth_guid': 'AUTH_GUID', + 'auth_resp': 'AUTH_RESP', + 'auth_code': 'AUTH_CODE', + 'auth_cvv2': 'AUTH_CVV2', + 'auth_resp_text': 'AUTH_RESP_TEXT', + 'auth_card_type': 'AUTH_CARD_TYPE', + 'auth_tran_date_gmt': 'AUTH_TRAN_DATE_GMT', + 'auth_amount_requested': 'AUTH_AMOUNT_REQUESTED', + 'auth_amount': 'AUTH_AMOUNT', + 'auth_currency_code': 'AUTH_CURRENCY_CODE', + 'network_response': 'NETWORK_RESPONSE', + 'auth_masked_account_nbr': 'AUTH_MASKED_ACCOUNT_NBR', + 'user_data_9': 'USER_DATA_9', + 'user_data_10': 'USER_DATA_10' + } + + def __init__(self, cust_nbr=None, merch_nbr=None, dba_nbr=None, terminal_nbr=None, tran_code=None, amount=None, auth_account=None, first_name=None, last_name=None, exp_date=None, bp_resp_code=None, bp_resp_text=None, bp_field_errors=None, msg_version=None, tran_type=None, tran_nbr=None, local_date=None, local_time=None, auth_guid=None, auth_resp=None, auth_code=None, auth_cvv2=None, auth_resp_text=None, auth_card_type=None, auth_tran_date_gmt=None, auth_amount_requested=None, auth_amount=None, auth_currency_code=None, network_response=None, auth_masked_account_nbr=None, user_data_9=None, user_data_10=None): # noqa: E501 + """TokenizationEpxredirectBody - a model defined in Swagger""" # noqa: E501 + self._cust_nbr = None + self._merch_nbr = None + self._dba_nbr = None + self._terminal_nbr = None + self._tran_code = None + self._amount = None + self._auth_account = None + self._first_name = None + self._last_name = None + self._exp_date = None + self._bp_resp_code = None + self._bp_resp_text = None + self._bp_field_errors = None + self._msg_version = None + self._tran_type = None + self._tran_nbr = None + self._local_date = None + self._local_time = None + self._auth_guid = None + self._auth_resp = None + self._auth_code = None + self._auth_cvv2 = None + self._auth_resp_text = None + self._auth_card_type = None + self._auth_tran_date_gmt = None + self._auth_amount_requested = None + self._auth_amount = None + self._auth_currency_code = None + self._network_response = None + self._auth_masked_account_nbr = None + self._user_data_9 = None + self._user_data_10 = None + self.discriminator = None + if cust_nbr is not None: + self.cust_nbr = cust_nbr + if merch_nbr is not None: + self.merch_nbr = merch_nbr + if dba_nbr is not None: + self.dba_nbr = dba_nbr + if terminal_nbr is not None: + self.terminal_nbr = terminal_nbr + if tran_code is not None: + self.tran_code = tran_code + if amount is not None: + self.amount = amount + if auth_account is not None: + self.auth_account = auth_account + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if exp_date is not None: + self.exp_date = exp_date + if bp_resp_code is not None: + self.bp_resp_code = bp_resp_code + if bp_resp_text is not None: + self.bp_resp_text = bp_resp_text + if bp_field_errors is not None: + self.bp_field_errors = bp_field_errors + if msg_version is not None: + self.msg_version = msg_version + if tran_type is not None: + self.tran_type = tran_type + if tran_nbr is not None: + self.tran_nbr = tran_nbr + if local_date is not None: + self.local_date = local_date + if local_time is not None: + self.local_time = local_time + if auth_guid is not None: + self.auth_guid = auth_guid + if auth_resp is not None: + self.auth_resp = auth_resp + if auth_code is not None: + self.auth_code = auth_code + if auth_cvv2 is not None: + self.auth_cvv2 = auth_cvv2 + if auth_resp_text is not None: + self.auth_resp_text = auth_resp_text + if auth_card_type is not None: + self.auth_card_type = auth_card_type + if auth_tran_date_gmt is not None: + self.auth_tran_date_gmt = auth_tran_date_gmt + if auth_amount_requested is not None: + self.auth_amount_requested = auth_amount_requested + if auth_amount is not None: + self.auth_amount = auth_amount + if auth_currency_code is not None: + self.auth_currency_code = auth_currency_code + if network_response is not None: + self.network_response = network_response + if auth_masked_account_nbr is not None: + self.auth_masked_account_nbr = auth_masked_account_nbr + if user_data_9 is not None: + self.user_data_9 = user_data_9 + if user_data_10 is not None: + self.user_data_10 = user_data_10 + + @property + def cust_nbr(self): + """Gets the cust_nbr of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The cust_nbr of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._cust_nbr + + @cust_nbr.setter + def cust_nbr(self, cust_nbr): + """Sets the cust_nbr of this TokenizationEpxredirectBody. + + + :param cust_nbr: The cust_nbr of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._cust_nbr = cust_nbr + + @property + def merch_nbr(self): + """Gets the merch_nbr of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The merch_nbr of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._merch_nbr + + @merch_nbr.setter + def merch_nbr(self, merch_nbr): + """Sets the merch_nbr of this TokenizationEpxredirectBody. + + + :param merch_nbr: The merch_nbr of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._merch_nbr = merch_nbr + + @property + def dba_nbr(self): + """Gets the dba_nbr of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The dba_nbr of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._dba_nbr + + @dba_nbr.setter + def dba_nbr(self, dba_nbr): + """Sets the dba_nbr of this TokenizationEpxredirectBody. + + + :param dba_nbr: The dba_nbr of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._dba_nbr = dba_nbr + + @property + def terminal_nbr(self): + """Gets the terminal_nbr of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The terminal_nbr of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._terminal_nbr + + @terminal_nbr.setter + def terminal_nbr(self, terminal_nbr): + """Sets the terminal_nbr of this TokenizationEpxredirectBody. + + + :param terminal_nbr: The terminal_nbr of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._terminal_nbr = terminal_nbr + + @property + def tran_code(self): + """Gets the tran_code of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The tran_code of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._tran_code + + @tran_code.setter + def tran_code(self, tran_code): + """Sets the tran_code of this TokenizationEpxredirectBody. + + + :param tran_code: The tran_code of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._tran_code = tran_code + + @property + def amount(self): + """Gets the amount of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The amount of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this TokenizationEpxredirectBody. + + + :param amount: The amount of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._amount = amount + + @property + def auth_account(self): + """Gets the auth_account of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The auth_account of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._auth_account + + @auth_account.setter + def auth_account(self, auth_account): + """Sets the auth_account of this TokenizationEpxredirectBody. + + + :param auth_account: The auth_account of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._auth_account = auth_account + + @property + def first_name(self): + """Gets the first_name of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The first_name of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """Sets the first_name of this TokenizationEpxredirectBody. + + + :param first_name: The first_name of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._first_name = first_name + + @property + def last_name(self): + """Gets the last_name of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The last_name of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """Sets the last_name of this TokenizationEpxredirectBody. + + + :param last_name: The last_name of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._last_name = last_name + + @property + def exp_date(self): + """Gets the exp_date of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The exp_date of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._exp_date + + @exp_date.setter + def exp_date(self, exp_date): + """Sets the exp_date of this TokenizationEpxredirectBody. + + + :param exp_date: The exp_date of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._exp_date = exp_date + + @property + def bp_resp_code(self): + """Gets the bp_resp_code of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The bp_resp_code of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._bp_resp_code + + @bp_resp_code.setter + def bp_resp_code(self, bp_resp_code): + """Sets the bp_resp_code of this TokenizationEpxredirectBody. + + + :param bp_resp_code: The bp_resp_code of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._bp_resp_code = bp_resp_code + + @property + def bp_resp_text(self): + """Gets the bp_resp_text of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The bp_resp_text of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._bp_resp_text + + @bp_resp_text.setter + def bp_resp_text(self, bp_resp_text): + """Sets the bp_resp_text of this TokenizationEpxredirectBody. + + + :param bp_resp_text: The bp_resp_text of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._bp_resp_text = bp_resp_text + + @property + def bp_field_errors(self): + """Gets the bp_field_errors of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The bp_field_errors of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._bp_field_errors + + @bp_field_errors.setter + def bp_field_errors(self, bp_field_errors): + """Sets the bp_field_errors of this TokenizationEpxredirectBody. + + + :param bp_field_errors: The bp_field_errors of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._bp_field_errors = bp_field_errors + + @property + def msg_version(self): + """Gets the msg_version of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The msg_version of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._msg_version + + @msg_version.setter + def msg_version(self, msg_version): + """Sets the msg_version of this TokenizationEpxredirectBody. + + + :param msg_version: The msg_version of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._msg_version = msg_version + + @property + def tran_type(self): + """Gets the tran_type of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The tran_type of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._tran_type + + @tran_type.setter + def tran_type(self, tran_type): + """Sets the tran_type of this TokenizationEpxredirectBody. + + + :param tran_type: The tran_type of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._tran_type = tran_type + + @property + def tran_nbr(self): + """Gets the tran_nbr of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The tran_nbr of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._tran_nbr + + @tran_nbr.setter + def tran_nbr(self, tran_nbr): + """Sets the tran_nbr of this TokenizationEpxredirectBody. + + + :param tran_nbr: The tran_nbr of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._tran_nbr = tran_nbr + + @property + def local_date(self): + """Gets the local_date of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The local_date of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._local_date + + @local_date.setter + def local_date(self, local_date): + """Sets the local_date of this TokenizationEpxredirectBody. + + + :param local_date: The local_date of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._local_date = local_date + + @property + def local_time(self): + """Gets the local_time of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The local_time of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._local_time + + @local_time.setter + def local_time(self, local_time): + """Sets the local_time of this TokenizationEpxredirectBody. + + + :param local_time: The local_time of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._local_time = local_time + + @property + def auth_guid(self): + """Gets the auth_guid of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The auth_guid of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._auth_guid + + @auth_guid.setter + def auth_guid(self, auth_guid): + """Sets the auth_guid of this TokenizationEpxredirectBody. + + + :param auth_guid: The auth_guid of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._auth_guid = auth_guid + + @property + def auth_resp(self): + """Gets the auth_resp of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The auth_resp of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._auth_resp + + @auth_resp.setter + def auth_resp(self, auth_resp): + """Sets the auth_resp of this TokenizationEpxredirectBody. + + + :param auth_resp: The auth_resp of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._auth_resp = auth_resp + + @property + def auth_code(self): + """Gets the auth_code of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The auth_code of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._auth_code + + @auth_code.setter + def auth_code(self, auth_code): + """Sets the auth_code of this TokenizationEpxredirectBody. + + + :param auth_code: The auth_code of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._auth_code = auth_code + + @property + def auth_cvv2(self): + """Gets the auth_cvv2 of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The auth_cvv2 of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._auth_cvv2 + + @auth_cvv2.setter + def auth_cvv2(self, auth_cvv2): + """Sets the auth_cvv2 of this TokenizationEpxredirectBody. + + + :param auth_cvv2: The auth_cvv2 of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._auth_cvv2 = auth_cvv2 + + @property + def auth_resp_text(self): + """Gets the auth_resp_text of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The auth_resp_text of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._auth_resp_text + + @auth_resp_text.setter + def auth_resp_text(self, auth_resp_text): + """Sets the auth_resp_text of this TokenizationEpxredirectBody. + + + :param auth_resp_text: The auth_resp_text of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._auth_resp_text = auth_resp_text + + @property + def auth_card_type(self): + """Gets the auth_card_type of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The auth_card_type of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._auth_card_type + + @auth_card_type.setter + def auth_card_type(self, auth_card_type): + """Sets the auth_card_type of this TokenizationEpxredirectBody. + + + :param auth_card_type: The auth_card_type of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._auth_card_type = auth_card_type + + @property + def auth_tran_date_gmt(self): + """Gets the auth_tran_date_gmt of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The auth_tran_date_gmt of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._auth_tran_date_gmt + + @auth_tran_date_gmt.setter + def auth_tran_date_gmt(self, auth_tran_date_gmt): + """Sets the auth_tran_date_gmt of this TokenizationEpxredirectBody. + + + :param auth_tran_date_gmt: The auth_tran_date_gmt of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._auth_tran_date_gmt = auth_tran_date_gmt + + @property + def auth_amount_requested(self): + """Gets the auth_amount_requested of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The auth_amount_requested of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._auth_amount_requested + + @auth_amount_requested.setter + def auth_amount_requested(self, auth_amount_requested): + """Sets the auth_amount_requested of this TokenizationEpxredirectBody. + + + :param auth_amount_requested: The auth_amount_requested of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._auth_amount_requested = auth_amount_requested + + @property + def auth_amount(self): + """Gets the auth_amount of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The auth_amount of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._auth_amount + + @auth_amount.setter + def auth_amount(self, auth_amount): + """Sets the auth_amount of this TokenizationEpxredirectBody. + + + :param auth_amount: The auth_amount of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._auth_amount = auth_amount + + @property + def auth_currency_code(self): + """Gets the auth_currency_code of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The auth_currency_code of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._auth_currency_code + + @auth_currency_code.setter + def auth_currency_code(self, auth_currency_code): + """Sets the auth_currency_code of this TokenizationEpxredirectBody. + + + :param auth_currency_code: The auth_currency_code of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._auth_currency_code = auth_currency_code + + @property + def network_response(self): + """Gets the network_response of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The network_response of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._network_response + + @network_response.setter + def network_response(self, network_response): + """Sets the network_response of this TokenizationEpxredirectBody. + + + :param network_response: The network_response of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._network_response = network_response + + @property + def auth_masked_account_nbr(self): + """Gets the auth_masked_account_nbr of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The auth_masked_account_nbr of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._auth_masked_account_nbr + + @auth_masked_account_nbr.setter + def auth_masked_account_nbr(self, auth_masked_account_nbr): + """Sets the auth_masked_account_nbr of this TokenizationEpxredirectBody. + + + :param auth_masked_account_nbr: The auth_masked_account_nbr of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._auth_masked_account_nbr = auth_masked_account_nbr + + @property + def user_data_9(self): + """Gets the user_data_9 of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The user_data_9 of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._user_data_9 + + @user_data_9.setter + def user_data_9(self, user_data_9): + """Sets the user_data_9 of this TokenizationEpxredirectBody. + + + :param user_data_9: The user_data_9 of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._user_data_9 = user_data_9 + + @property + def user_data_10(self): + """Gets the user_data_10 of this TokenizationEpxredirectBody. # noqa: E501 + + + :return: The user_data_10 of this TokenizationEpxredirectBody. # noqa: E501 + :rtype: str + """ + return self._user_data_10 + + @user_data_10.setter + def user_data_10(self, user_data_10): + """Sets the user_data_10 of this TokenizationEpxredirectBody. + + + :param user_data_10: The user_data_10 of this TokenizationEpxredirectBody. # noqa: E501 + :type: str + """ + + self._user_data_10 = user_data_10 + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TokenizationEpxredirectBody, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TokenizationEpxredirectBody): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/tokenization_payvisionshoutv1_body.py b/billforward/models/tokenization_payvisionshoutv1_body.py new file mode 100644 index 0000000..6973d21 --- /dev/null +++ b/billforward/models/tokenization_payvisionshoutv1_body.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TokenizationPayvisionshoutv1Body(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + '_resource_path': 'str', + 'id': 'str' + } + + attribute_map = { + '_resource_path': 'resourcePath', + 'id': 'id' + } + + def __init__(self, _resource_path=None, id=None): # noqa: E501 + """TokenizationPayvisionshoutv1Body - a model defined in Swagger""" # noqa: E501 + self.__resource_path = None + self._id = None + self.discriminator = None + if _resource_path is not None: + self._resource_path = _resource_path + if id is not None: + self.id = id + + @property + def _resource_path(self): + """Gets the _resource_path of this TokenizationPayvisionshoutv1Body. # noqa: E501 + + + :return: The _resource_path of this TokenizationPayvisionshoutv1Body. # noqa: E501 + :rtype: str + """ + return self.__resource_path + + @_resource_path.setter + def _resource_path(self, _resource_path): + """Sets the _resource_path of this TokenizationPayvisionshoutv1Body. + + + :param _resource_path: The _resource_path of this TokenizationPayvisionshoutv1Body. # noqa: E501 + :type: str + """ + + self.__resource_path = _resource_path + + @property + def id(self): + """Gets the id of this TokenizationPayvisionshoutv1Body. # noqa: E501 + + + :return: The id of this TokenizationPayvisionshoutv1Body. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this TokenizationPayvisionshoutv1Body. + + + :param id: The id of this TokenizationPayvisionshoutv1Body. # noqa: E501 + :type: str + """ + + self._id = id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TokenizationPayvisionshoutv1Body, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TokenizationPayvisionshoutv1Body): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/tokenization_pre_auth.py b/billforward/models/tokenization_pre_auth.py new file mode 100644 index 0000000..b66dc2d --- /dev/null +++ b/billforward/models/tokenization_pre_auth.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TokenizationPreAuth(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, organization_id=None): # noqa: E501 + """TokenizationPreAuth - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this TokenizationPreAuth. # noqa: E501 + + + :return: The created of this TokenizationPreAuth. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this TokenizationPreAuth. + + + :param created: The created of this TokenizationPreAuth. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this TokenizationPreAuth. # noqa: E501 + + + :return: The organization_id of this TokenizationPreAuth. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this TokenizationPreAuth. + + + :param organization_id: The organization_id of this TokenizationPreAuth. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TokenizationPreAuth, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TokenizationPreAuth): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/tokenization_pre_auth_paged_metadata.py b/billforward/models/tokenization_pre_auth_paged_metadata.py deleted file mode 100644 index 7be6d32..0000000 --- a/billforward/models/tokenization_pre_auth_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class TokenizationPreAuthPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - TokenizationPreAuthPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this TokenizationPreAuthPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this TokenizationPreAuthPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this TokenizationPreAuthPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this TokenizationPreAuthPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this TokenizationPreAuthPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this TokenizationPreAuthPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this TokenizationPreAuthPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this TokenizationPreAuthPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this TokenizationPreAuthPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this TokenizationPreAuthPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this TokenizationPreAuthPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this TokenizationPreAuthPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this TokenizationPreAuthPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this TokenizationPreAuthPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this TokenizationPreAuthPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this TokenizationPreAuthPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this TokenizationPreAuthPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this TokenizationPreAuthPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this TokenizationPreAuthPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this TokenizationPreAuthPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this TokenizationPreAuthPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this TokenizationPreAuthPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this TokenizationPreAuthPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this TokenizationPreAuthPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this TokenizationPreAuthPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this TokenizationPreAuthPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this TokenizationPreAuthPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this TokenizationPreAuthPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/tokenization_pre_auth_request.py b/billforward/models/tokenization_pre_auth_request.py new file mode 100644 index 0000000..6498be9 --- /dev/null +++ b/billforward/models/tokenization_pre_auth_request.py @@ -0,0 +1,364 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TokenizationPreAuthRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'gateway_id': 'str', + 'gateway': 'str', + 'organization_id': 'str', + 'bill_forward_url': 'str', + 'bill_forward_public_token': 'str', + 'email_tokenization_id': 'str', + 'id': 'str', + 'type': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'gateway_id': 'gatewayID', + 'gateway': 'gateway', + 'organization_id': 'organizationID', + 'bill_forward_url': 'billForwardURL', + 'bill_forward_public_token': 'billForwardPublicToken', + 'email_tokenization_id': 'emailTokenizationID', + 'id': 'id', + 'type': '@type' + } + + discriminator_value_class_map = { + 'SpreedlyPreAuthRequest': 'SpreedlyPreAuthRequest', +'SagePayPreAuthRequest': 'SagePayPreAuthRequest', +'StripePreAuthRequest': 'StripePreAuthRequest', +'PayVisionPreAuthRequest': 'PayVisionPreAuthRequest', +'BraintreePreAuthRequest': 'BraintreePreAuthRequest', +'ShuttlePreAuthRequest': 'ShuttlePreAuthRequest' } + + def __init__(self, created=None, changed_by=None, gateway_id=None, gateway=None, organization_id=None, bill_forward_url=None, bill_forward_public_token=None, email_tokenization_id=None, id=None, type=None): # noqa: E501 + """TokenizationPreAuthRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._gateway_id = None + self._gateway = None + self._organization_id = None + self._bill_forward_url = None + self._bill_forward_public_token = None + self._email_tokenization_id = None + self._id = None + self._type = None + self.discriminator = '@type' + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if gateway_id is not None: + self.gateway_id = gateway_id + if gateway is not None: + self.gateway = gateway + if organization_id is not None: + self.organization_id = organization_id + if bill_forward_url is not None: + self.bill_forward_url = bill_forward_url + if bill_forward_public_token is not None: + self.bill_forward_public_token = bill_forward_public_token + if email_tokenization_id is not None: + self.email_tokenization_id = email_tokenization_id + if id is not None: + self.id = id + self.type = type + + @property + def created(self): + """Gets the created of this TokenizationPreAuthRequest. # noqa: E501 + + + :return: The created of this TokenizationPreAuthRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this TokenizationPreAuthRequest. + + + :param created: The created of this TokenizationPreAuthRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this TokenizationPreAuthRequest. # noqa: E501 + + + :return: The changed_by of this TokenizationPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this TokenizationPreAuthRequest. + + + :param changed_by: The changed_by of this TokenizationPreAuthRequest. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def gateway_id(self): + """Gets the gateway_id of this TokenizationPreAuthRequest. # noqa: E501 + + + :return: The gateway_id of this TokenizationPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._gateway_id + + @gateway_id.setter + def gateway_id(self, gateway_id): + """Sets the gateway_id of this TokenizationPreAuthRequest. + + + :param gateway_id: The gateway_id of this TokenizationPreAuthRequest. # noqa: E501 + :type: str + """ + + self._gateway_id = gateway_id + + @property + def gateway(self): + """Gets the gateway of this TokenizationPreAuthRequest. # noqa: E501 + + + :return: The gateway of this TokenizationPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._gateway + + @gateway.setter + def gateway(self, gateway): + """Sets the gateway of this TokenizationPreAuthRequest. + + + :param gateway: The gateway of this TokenizationPreAuthRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Balanced", "Braintree", "Cybersource", "Paypal", "Stripe", "Shuttle", "AuthorizeNet", "Spreedly", "SagePay", "GoCardless", "TrustCommerce", "Payvision", "Epx", "Kash", "Zooz", "Square", "CardConnect", "EBANX"] # noqa: E501 + if gateway not in allowed_values: + raise ValueError( + "Invalid value for `gateway` ({0}), must be one of {1}" # noqa: E501 + .format(gateway, allowed_values) + ) + + self._gateway = gateway + + @property + def organization_id(self): + """Gets the organization_id of this TokenizationPreAuthRequest. # noqa: E501 + + + :return: The organization_id of this TokenizationPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this TokenizationPreAuthRequest. + + + :param organization_id: The organization_id of this TokenizationPreAuthRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def bill_forward_url(self): + """Gets the bill_forward_url of this TokenizationPreAuthRequest. # noqa: E501 + + + :return: The bill_forward_url of this TokenizationPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._bill_forward_url + + @bill_forward_url.setter + def bill_forward_url(self, bill_forward_url): + """Sets the bill_forward_url of this TokenizationPreAuthRequest. + + + :param bill_forward_url: The bill_forward_url of this TokenizationPreAuthRequest. # noqa: E501 + :type: str + """ + + self._bill_forward_url = bill_forward_url + + @property + def bill_forward_public_token(self): + """Gets the bill_forward_public_token of this TokenizationPreAuthRequest. # noqa: E501 + + + :return: The bill_forward_public_token of this TokenizationPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._bill_forward_public_token + + @bill_forward_public_token.setter + def bill_forward_public_token(self, bill_forward_public_token): + """Sets the bill_forward_public_token of this TokenizationPreAuthRequest. + + + :param bill_forward_public_token: The bill_forward_public_token of this TokenizationPreAuthRequest. # noqa: E501 + :type: str + """ + + self._bill_forward_public_token = bill_forward_public_token + + @property + def email_tokenization_id(self): + """Gets the email_tokenization_id of this TokenizationPreAuthRequest. # noqa: E501 + + + :return: The email_tokenization_id of this TokenizationPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._email_tokenization_id + + @email_tokenization_id.setter + def email_tokenization_id(self, email_tokenization_id): + """Sets the email_tokenization_id of this TokenizationPreAuthRequest. + + + :param email_tokenization_id: The email_tokenization_id of this TokenizationPreAuthRequest. # noqa: E501 + :type: str + """ + + self._email_tokenization_id = email_tokenization_id + + @property + def id(self): + """Gets the id of this TokenizationPreAuthRequest. # noqa: E501 + + + :return: The id of this TokenizationPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this TokenizationPreAuthRequest. + + + :param id: The id of this TokenizationPreAuthRequest. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def type(self): + """Gets the type of this TokenizationPreAuthRequest. # noqa: E501 + + + :return: The type of this TokenizationPreAuthRequest. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this TokenizationPreAuthRequest. + + + :param type: The type of this TokenizationPreAuthRequest. # noqa: E501 + :type: str + """ + if type is None: + raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + + self._type = type + + def get_real_child_model(self, data): + """Returns the real base class specified by the discriminator""" + discriminator_value = data[self.discriminator].lower() + return self.discriminator_value_class_map.get(discriminator_value) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TokenizationPreAuthRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TokenizationPreAuthRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/tokenization_sagepaynotifyv300_body.py b/billforward/models/tokenization_sagepaynotifyv300_body.py new file mode 100644 index 0000000..33c9c14 --- /dev/null +++ b/billforward/models/tokenization_sagepaynotifyv300_body.py @@ -0,0 +1,370 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TokenizationSagepaynotifyv300Body(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'vps_protocol': 'str', + 'tx_type': 'str', + 'vendor_tx_code': 'str', + 'status': 'str', + 'vps_tx_id': 'str', + 'card_type': 'str', + 'token': 'str', + 'status_detail': 'str', + 'last4_digits': 'str', + 'vps_signature': 'str', + 'expiry_date': 'str' + } + + attribute_map = { + 'vps_protocol': 'VPSProtocol', + 'tx_type': 'TxType', + 'vendor_tx_code': 'VendorTxCode', + 'status': 'Status', + 'vps_tx_id': 'VPSTxId', + 'card_type': 'CardType', + 'token': 'Token', + 'status_detail': 'StatusDetail', + 'last4_digits': 'Last4Digits', + 'vps_signature': 'VPSSignature', + 'expiry_date': 'ExpiryDate' + } + + def __init__(self, vps_protocol=None, tx_type=None, vendor_tx_code=None, status=None, vps_tx_id=None, card_type=None, token=None, status_detail=None, last4_digits=None, vps_signature=None, expiry_date=None): # noqa: E501 + """TokenizationSagepaynotifyv300Body - a model defined in Swagger""" # noqa: E501 + self._vps_protocol = None + self._tx_type = None + self._vendor_tx_code = None + self._status = None + self._vps_tx_id = None + self._card_type = None + self._token = None + self._status_detail = None + self._last4_digits = None + self._vps_signature = None + self._expiry_date = None + self.discriminator = None + if vps_protocol is not None: + self.vps_protocol = vps_protocol + if tx_type is not None: + self.tx_type = tx_type + if vendor_tx_code is not None: + self.vendor_tx_code = vendor_tx_code + if status is not None: + self.status = status + if vps_tx_id is not None: + self.vps_tx_id = vps_tx_id + if card_type is not None: + self.card_type = card_type + if token is not None: + self.token = token + if status_detail is not None: + self.status_detail = status_detail + if last4_digits is not None: + self.last4_digits = last4_digits + if vps_signature is not None: + self.vps_signature = vps_signature + if expiry_date is not None: + self.expiry_date = expiry_date + + @property + def vps_protocol(self): + """Gets the vps_protocol of this TokenizationSagepaynotifyv300Body. # noqa: E501 + + + :return: The vps_protocol of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :rtype: str + """ + return self._vps_protocol + + @vps_protocol.setter + def vps_protocol(self, vps_protocol): + """Sets the vps_protocol of this TokenizationSagepaynotifyv300Body. + + + :param vps_protocol: The vps_protocol of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :type: str + """ + + self._vps_protocol = vps_protocol + + @property + def tx_type(self): + """Gets the tx_type of this TokenizationSagepaynotifyv300Body. # noqa: E501 + + + :return: The tx_type of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :rtype: str + """ + return self._tx_type + + @tx_type.setter + def tx_type(self, tx_type): + """Sets the tx_type of this TokenizationSagepaynotifyv300Body. + + + :param tx_type: The tx_type of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :type: str + """ + + self._tx_type = tx_type + + @property + def vendor_tx_code(self): + """Gets the vendor_tx_code of this TokenizationSagepaynotifyv300Body. # noqa: E501 + + + :return: The vendor_tx_code of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :rtype: str + """ + return self._vendor_tx_code + + @vendor_tx_code.setter + def vendor_tx_code(self, vendor_tx_code): + """Sets the vendor_tx_code of this TokenizationSagepaynotifyv300Body. + + + :param vendor_tx_code: The vendor_tx_code of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :type: str + """ + + self._vendor_tx_code = vendor_tx_code + + @property + def status(self): + """Gets the status of this TokenizationSagepaynotifyv300Body. # noqa: E501 + + + :return: The status of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """Sets the status of this TokenizationSagepaynotifyv300Body. + + + :param status: The status of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :type: str + """ + + self._status = status + + @property + def vps_tx_id(self): + """Gets the vps_tx_id of this TokenizationSagepaynotifyv300Body. # noqa: E501 + + + :return: The vps_tx_id of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :rtype: str + """ + return self._vps_tx_id + + @vps_tx_id.setter + def vps_tx_id(self, vps_tx_id): + """Sets the vps_tx_id of this TokenizationSagepaynotifyv300Body. + + + :param vps_tx_id: The vps_tx_id of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :type: str + """ + + self._vps_tx_id = vps_tx_id + + @property + def card_type(self): + """Gets the card_type of this TokenizationSagepaynotifyv300Body. # noqa: E501 + + + :return: The card_type of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :rtype: str + """ + return self._card_type + + @card_type.setter + def card_type(self, card_type): + """Sets the card_type of this TokenizationSagepaynotifyv300Body. + + + :param card_type: The card_type of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :type: str + """ + + self._card_type = card_type + + @property + def token(self): + """Gets the token of this TokenizationSagepaynotifyv300Body. # noqa: E501 + + + :return: The token of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :rtype: str + """ + return self._token + + @token.setter + def token(self, token): + """Sets the token of this TokenizationSagepaynotifyv300Body. + + + :param token: The token of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :type: str + """ + + self._token = token + + @property + def status_detail(self): + """Gets the status_detail of this TokenizationSagepaynotifyv300Body. # noqa: E501 + + + :return: The status_detail of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :rtype: str + """ + return self._status_detail + + @status_detail.setter + def status_detail(self, status_detail): + """Sets the status_detail of this TokenizationSagepaynotifyv300Body. + + + :param status_detail: The status_detail of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :type: str + """ + + self._status_detail = status_detail + + @property + def last4_digits(self): + """Gets the last4_digits of this TokenizationSagepaynotifyv300Body. # noqa: E501 + + + :return: The last4_digits of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :rtype: str + """ + return self._last4_digits + + @last4_digits.setter + def last4_digits(self, last4_digits): + """Sets the last4_digits of this TokenizationSagepaynotifyv300Body. + + + :param last4_digits: The last4_digits of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :type: str + """ + + self._last4_digits = last4_digits + + @property + def vps_signature(self): + """Gets the vps_signature of this TokenizationSagepaynotifyv300Body. # noqa: E501 + + + :return: The vps_signature of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :rtype: str + """ + return self._vps_signature + + @vps_signature.setter + def vps_signature(self, vps_signature): + """Sets the vps_signature of this TokenizationSagepaynotifyv300Body. + + + :param vps_signature: The vps_signature of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :type: str + """ + + self._vps_signature = vps_signature + + @property + def expiry_date(self): + """Gets the expiry_date of this TokenizationSagepaynotifyv300Body. # noqa: E501 + + + :return: The expiry_date of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :rtype: str + """ + return self._expiry_date + + @expiry_date.setter + def expiry_date(self, expiry_date): + """Sets the expiry_date of this TokenizationSagepaynotifyv300Body. + + + :param expiry_date: The expiry_date of this TokenizationSagepaynotifyv300Body. # noqa: E501 + :type: str + """ + + self._expiry_date = expiry_date + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TokenizationSagepaynotifyv300Body, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TokenizationSagepaynotifyv300Body): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/tokens_response.py b/billforward/models/tokens_response.py new file mode 100644 index 0000000..d84f7e5 --- /dev/null +++ b/billforward/models/tokens_response.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TokensResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'private_token': 'OAuthToken', + 'public_token': 'OAuthToken' + } + + attribute_map = { + 'private_token': 'privateToken', + 'public_token': 'publicToken' + } + + def __init__(self, private_token=None, public_token=None): # noqa: E501 + """TokensResponse - a model defined in Swagger""" # noqa: E501 + self._private_token = None + self._public_token = None + self.discriminator = None + if private_token is not None: + self.private_token = private_token + if public_token is not None: + self.public_token = public_token + + @property + def private_token(self): + """Gets the private_token of this TokensResponse. # noqa: E501 + + + :return: The private_token of this TokensResponse. # noqa: E501 + :rtype: OAuthToken + """ + return self._private_token + + @private_token.setter + def private_token(self, private_token): + """Sets the private_token of this TokensResponse. + + + :param private_token: The private_token of this TokensResponse. # noqa: E501 + :type: OAuthToken + """ + + self._private_token = private_token + + @property + def public_token(self): + """Gets the public_token of this TokensResponse. # noqa: E501 + + + :return: The public_token of this TokensResponse. # noqa: E501 + :rtype: OAuthToken + """ + return self._public_token + + @public_token.setter + def public_token(self, public_token): + """Sets the public_token of this TokensResponse. + + + :param public_token: The public_token of this TokensResponse. # noqa: E501 + :type: OAuthToken + """ + + self._public_token = public_token + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TokensResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TokensResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/trust_commerce_configuration.py b/billforward/models/trust_commerce_configuration.py new file mode 100644 index 0000000..6e04abe --- /dev/null +++ b/billforward/models/trust_commerce_configuration.py @@ -0,0 +1,142 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class TrustCommerceConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'password': 'str', + 'cust_id': 'str' + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + 'password': 'password', + 'cust_id': 'custID' + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, password=None, cust_id=None, *args, **kwargs): # noqa: E501 + """TrustCommerceConfiguration - a model defined in Swagger""" # noqa: E501 + self._password = None + self._cust_id = None + self.discriminator = None + if password is not None: + self.password = password + if cust_id is not None: + self.cust_id = cust_id + APIConfiguration.__init__(self, *args, **kwargs) + + @property + def password(self): + """Gets the password of this TrustCommerceConfiguration. # noqa: E501 + + + :return: The password of this TrustCommerceConfiguration. # noqa: E501 + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """Sets the password of this TrustCommerceConfiguration. + + + :param password: The password of this TrustCommerceConfiguration. # noqa: E501 + :type: str + """ + + self._password = password + + @property + def cust_id(self): + """Gets the cust_id of this TrustCommerceConfiguration. # noqa: E501 + + + :return: The cust_id of this TrustCommerceConfiguration. # noqa: E501 + :rtype: str + """ + return self._cust_id + + @cust_id.setter + def cust_id(self, cust_id): + """Sets the cust_id of this TrustCommerceConfiguration. + + + :param cust_id: The cust_id of this TrustCommerceConfiguration. # noqa: E501 + :type: str + """ + + self._cust_id = cust_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TrustCommerceConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TrustCommerceConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/trust_commerce_token.py b/billforward/models/trust_commerce_token.py new file mode 100644 index 0000000..c10a887 --- /dev/null +++ b/billforward/models/trust_commerce_token.py @@ -0,0 +1,322 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TrustCommerceToken(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'account_id': 'str', + 'card_details_id': 'str', + 'organization_id': 'str', + 'token_id': 'str', + 'deleted': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'account_id': 'accountID', + 'card_details_id': 'cardDetailsID', + 'organization_id': 'organizationID', + 'token_id': 'tokenID', + 'deleted': 'deleted' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, card_details_id=None, organization_id=None, token_id=None, deleted=None): # noqa: E501 + """TrustCommerceToken - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._account_id = None + self._card_details_id = None + self._organization_id = None + self._token_id = None + self._deleted = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.account_id = account_id + if card_details_id is not None: + self.card_details_id = card_details_id + self.organization_id = organization_id + self.token_id = token_id + self.deleted = deleted + + @property + def created(self): + """Gets the created of this TrustCommerceToken. # noqa: E501 + + + :return: The created of this TrustCommerceToken. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this TrustCommerceToken. + + + :param created: The created of this TrustCommerceToken. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this TrustCommerceToken. # noqa: E501 + + + :return: The changed_by of this TrustCommerceToken. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this TrustCommerceToken. + + + :param changed_by: The changed_by of this TrustCommerceToken. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this TrustCommerceToken. # noqa: E501 + + + :return: The updated of this TrustCommerceToken. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this TrustCommerceToken. + + + :param updated: The updated of this TrustCommerceToken. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this TrustCommerceToken. # noqa: E501 + + + :return: The id of this TrustCommerceToken. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this TrustCommerceToken. + + + :param id: The id of this TrustCommerceToken. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def account_id(self): + """Gets the account_id of this TrustCommerceToken. # noqa: E501 + + + :return: The account_id of this TrustCommerceToken. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this TrustCommerceToken. + + + :param account_id: The account_id of this TrustCommerceToken. # noqa: E501 + :type: str + """ + if account_id is None: + raise ValueError("Invalid value for `account_id`, must not be `None`") # noqa: E501 + + self._account_id = account_id + + @property + def card_details_id(self): + """Gets the card_details_id of this TrustCommerceToken. # noqa: E501 + + + :return: The card_details_id of this TrustCommerceToken. # noqa: E501 + :rtype: str + """ + return self._card_details_id + + @card_details_id.setter + def card_details_id(self, card_details_id): + """Sets the card_details_id of this TrustCommerceToken. + + + :param card_details_id: The card_details_id of this TrustCommerceToken. # noqa: E501 + :type: str + """ + + self._card_details_id = card_details_id + + @property + def organization_id(self): + """Gets the organization_id of this TrustCommerceToken. # noqa: E501 + + + :return: The organization_id of this TrustCommerceToken. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this TrustCommerceToken. + + + :param organization_id: The organization_id of this TrustCommerceToken. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def token_id(self): + """Gets the token_id of this TrustCommerceToken. # noqa: E501 + + + :return: The token_id of this TrustCommerceToken. # noqa: E501 + :rtype: str + """ + return self._token_id + + @token_id.setter + def token_id(self, token_id): + """Sets the token_id of this TrustCommerceToken. + + + :param token_id: The token_id of this TrustCommerceToken. # noqa: E501 + :type: str + """ + if token_id is None: + raise ValueError("Invalid value for `token_id`, must not be `None`") # noqa: E501 + + self._token_id = token_id + + @property + def deleted(self): + """Gets the deleted of this TrustCommerceToken. # noqa: E501 + + + :return: The deleted of this TrustCommerceToken. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this TrustCommerceToken. + + + :param deleted: The deleted of this TrustCommerceToken. # noqa: E501 + :type: bool + """ + if deleted is None: + raise ValueError("Invalid value for `deleted`, must not be `None`") # noqa: E501 + + self._deleted = deleted + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TrustCommerceToken, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TrustCommerceToken): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/trust_commerce_token_paged_metadata.py b/billforward/models/trust_commerce_token_paged_metadata.py deleted file mode 100644 index 1d80101..0000000 --- a/billforward/models/trust_commerce_token_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class TrustCommerceTokenPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - TrustCommerceTokenPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this TrustCommerceTokenPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this TrustCommerceTokenPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this TrustCommerceTokenPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this TrustCommerceTokenPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this TrustCommerceTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this TrustCommerceTokenPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this TrustCommerceTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this TrustCommerceTokenPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this TrustCommerceTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this TrustCommerceTokenPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this TrustCommerceTokenPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this TrustCommerceTokenPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this TrustCommerceTokenPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this TrustCommerceTokenPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this TrustCommerceTokenPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this TrustCommerceTokenPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this TrustCommerceTokenPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this TrustCommerceTokenPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this TrustCommerceTokenPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this TrustCommerceTokenPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this TrustCommerceTokenPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this TrustCommerceTokenPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this TrustCommerceTokenPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this TrustCommerceTokenPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this TrustCommerceTokenPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this TrustCommerceTokenPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this TrustCommerceTokenPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this TrustCommerceTokenPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/typed_query_result_wrapper_account.py b/billforward/models/typed_query_result_wrapper_account.py new file mode 100644 index 0000000..fbcfee2 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_account.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperAccount(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Account', + 'typed_results': 'list[Account]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperAccount - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperAccount. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperAccount. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperAccount. + + + :param total_records: The total_records of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperAccount. + + + :param results: The results of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperAccount. + + + :param arguments: The arguments of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperAccount. + + + :param organizations: The organizations of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperAccount. + + + :param types: The types of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperAccount. + + + :param offset: The offset of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperAccount. + + + :param records: The records of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperAccount. + + + :param order_by: The order_by of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperAccount. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperAccount. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperAccount. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperAccount. + + + :param entity: The entity of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: Account + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperAccount. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: Account + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: list[Account] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperAccount. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: list[Account] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperAccount. + + + :param single_result: The single_result of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperAccount, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperAccount): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_address.py b/billforward/models/typed_query_result_wrapper_address.py new file mode 100644 index 0000000..94aea13 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_address.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperAddress(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Address', + 'typed_results': 'list[Address]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperAddress - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperAddress. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperAddress. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperAddress. + + + :param total_records: The total_records of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperAddress. + + + :param results: The results of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperAddress. + + + :param arguments: The arguments of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperAddress. + + + :param organizations: The organizations of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperAddress. + + + :param types: The types of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperAddress. + + + :param offset: The offset of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperAddress. + + + :param records: The records of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperAddress. + + + :param order_by: The order_by of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperAddress. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperAddress. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperAddress. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperAddress. + + + :param entity: The entity of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: Address + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperAddress. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: Address + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: list[Address] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperAddress. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: list[Address] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperAddress. + + + :param single_result: The single_result of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperAddress, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperAddress): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_amendment.py b/billforward/models/typed_query_result_wrapper_amendment.py new file mode 100644 index 0000000..6467416 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_amendment.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperAmendment(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Amendment', + 'typed_results': 'list[Amendment]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperAmendment - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperAmendment. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperAmendment. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperAmendment. + + + :param total_records: The total_records of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperAmendment. + + + :param results: The results of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperAmendment. + + + :param arguments: The arguments of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperAmendment. + + + :param organizations: The organizations of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperAmendment. + + + :param types: The types of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperAmendment. + + + :param offset: The offset of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperAmendment. + + + :param records: The records of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperAmendment. + + + :param order_by: The order_by of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperAmendment. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperAmendment. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperAmendment. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperAmendment. + + + :param entity: The entity of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: Amendment + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperAmendment. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: Amendment + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: list[Amendment] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperAmendment. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: list[Amendment] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperAmendment. + + + :param single_result: The single_result of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperAmendment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperAmendment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_api_quote.py b/billforward/models/typed_query_result_wrapper_api_quote.py new file mode 100644 index 0000000..0c29f71 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_api_quote.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperAPIQuote(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'ApiQuote', + 'typed_results': 'list[ApiQuote]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperAPIQuote - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperAPIQuote. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperAPIQuote. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperAPIQuote. + + + :param total_records: The total_records of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperAPIQuote. + + + :param results: The results of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperAPIQuote. + + + :param arguments: The arguments of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperAPIQuote. + + + :param organizations: The organizations of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperAPIQuote. + + + :param types: The types of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperAPIQuote. + + + :param offset: The offset of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperAPIQuote. + + + :param records: The records of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperAPIQuote. + + + :param order_by: The order_by of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperAPIQuote. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperAPIQuote. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperAPIQuote. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperAPIQuote. + + + :param entity: The entity of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: ApiQuote + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperAPIQuote. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: ApiQuote + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: list[ApiQuote] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperAPIQuote. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: list[ApiQuote] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperAPIQuote. + + + :param single_result: The single_result of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperAPIQuote, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperAPIQuote): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_avatax_configuration.py b/billforward/models/typed_query_result_wrapper_avatax_configuration.py new file mode 100644 index 0000000..60c3822 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_avatax_configuration.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperAvataxConfiguration(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'AvataxConfiguration', + 'typed_results': 'list[AvataxConfiguration]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperAvataxConfiguration - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperAvataxConfiguration. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperAvataxConfiguration. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperAvataxConfiguration. + + + :param total_records: The total_records of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperAvataxConfiguration. + + + :param results: The results of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperAvataxConfiguration. + + + :param arguments: The arguments of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperAvataxConfiguration. + + + :param organizations: The organizations of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperAvataxConfiguration. + + + :param types: The types of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperAvataxConfiguration. + + + :param offset: The offset of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperAvataxConfiguration. + + + :param records: The records of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperAvataxConfiguration. + + + :param order_by: The order_by of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperAvataxConfiguration. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperAvataxConfiguration. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperAvataxConfiguration. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperAvataxConfiguration. + + + :param entity: The entity of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: AvataxConfiguration + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperAvataxConfiguration. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: AvataxConfiguration + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: list[AvataxConfiguration] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperAvataxConfiguration. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: list[AvataxConfiguration] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperAvataxConfiguration. + + + :param single_result: The single_result of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperAvataxConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperAvataxConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_bf_permission.py b/billforward/models/typed_query_result_wrapper_bf_permission.py new file mode 100644 index 0000000..7fbd8ed --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_bf_permission.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperBFPermission(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'BFPermission', + 'typed_results': 'list[BFPermission]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperBFPermission - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperBFPermission. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperBFPermission. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperBFPermission. + + + :param total_records: The total_records of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperBFPermission. + + + :param results: The results of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperBFPermission. + + + :param arguments: The arguments of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperBFPermission. + + + :param organizations: The organizations of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperBFPermission. + + + :param types: The types of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperBFPermission. + + + :param offset: The offset of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperBFPermission. + + + :param records: The records of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperBFPermission. + + + :param order_by: The order_by of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperBFPermission. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperBFPermission. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperBFPermission. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperBFPermission. + + + :param entity: The entity of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: BFPermission + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperBFPermission. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: BFPermission + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: list[BFPermission] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperBFPermission. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: list[BFPermission] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperBFPermission. + + + :param single_result: The single_result of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperBFPermission, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperBFPermission): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_braintree_token.py b/billforward/models/typed_query_result_wrapper_braintree_token.py new file mode 100644 index 0000000..1e2517f --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_braintree_token.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperBraintreeToken(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'BraintreeToken', + 'typed_results': 'list[BraintreeToken]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperBraintreeToken - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperBraintreeToken. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperBraintreeToken. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperBraintreeToken. + + + :param total_records: The total_records of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperBraintreeToken. + + + :param results: The results of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperBraintreeToken. + + + :param arguments: The arguments of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperBraintreeToken. + + + :param organizations: The organizations of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperBraintreeToken. + + + :param types: The types of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperBraintreeToken. + + + :param offset: The offset of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperBraintreeToken. + + + :param records: The records of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperBraintreeToken. + + + :param order_by: The order_by of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperBraintreeToken. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperBraintreeToken. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperBraintreeToken. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperBraintreeToken. + + + :param entity: The entity of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: BraintreeToken + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperBraintreeToken. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: BraintreeToken + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: list[BraintreeToken] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperBraintreeToken. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: list[BraintreeToken] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperBraintreeToken. + + + :param single_result: The single_result of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperBraintreeToken, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperBraintreeToken): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_contract.py b/billforward/models/typed_query_result_wrapper_contract.py new file mode 100644 index 0000000..4a344e7 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_contract.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperContract(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Contract', + 'typed_results': 'list[Contract]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperContract - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperContract. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperContract. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperContract. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperContract. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperContract. + + + :param total_records: The total_records of this TypedQueryResultWrapperContract. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperContract. + + + :param results: The results of this TypedQueryResultWrapperContract. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperContract. + + + :param arguments: The arguments of this TypedQueryResultWrapperContract. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperContract. + + + :param organizations: The organizations of this TypedQueryResultWrapperContract. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperContract. + + + :param types: The types of this TypedQueryResultWrapperContract. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperContract. + + + :param offset: The offset of this TypedQueryResultWrapperContract. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperContract. + + + :param records: The records of this TypedQueryResultWrapperContract. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperContract. + + + :param order_by: The order_by of this TypedQueryResultWrapperContract. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperContract. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperContract. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperContract. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperContract. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperContract. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperContract. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperContract. + + + :param entity: The entity of this TypedQueryResultWrapperContract. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: Contract + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperContract. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperContract. # noqa: E501 + :type: Contract + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: list[Contract] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperContract. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperContract. # noqa: E501 + :type: list[Contract] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperContract. + + + :param single_result: The single_result of this TypedQueryResultWrapperContract. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperContract, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperContract): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_coupon.py b/billforward/models/typed_query_result_wrapper_coupon.py new file mode 100644 index 0000000..4cf6d1e --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_coupon.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperCoupon(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Coupon', + 'typed_results': 'list[Coupon]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperCoupon - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperCoupon. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperCoupon. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperCoupon. + + + :param total_records: The total_records of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperCoupon. + + + :param results: The results of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperCoupon. + + + :param arguments: The arguments of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperCoupon. + + + :param organizations: The organizations of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperCoupon. + + + :param types: The types of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperCoupon. + + + :param offset: The offset of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperCoupon. + + + :param records: The records of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperCoupon. + + + :param order_by: The order_by of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperCoupon. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperCoupon. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperCoupon. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperCoupon. + + + :param entity: The entity of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: Coupon + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperCoupon. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: Coupon + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: list[Coupon] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperCoupon. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: list[Coupon] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperCoupon. + + + :param single_result: The single_result of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperCoupon, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperCoupon): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_credit_note.py b/billforward/models/typed_query_result_wrapper_credit_note.py new file mode 100644 index 0000000..561782e --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_credit_note.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperCreditNote(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'CreditNote', + 'typed_results': 'list[CreditNote]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperCreditNote - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperCreditNote. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperCreditNote. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperCreditNote. + + + :param total_records: The total_records of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperCreditNote. + + + :param results: The results of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperCreditNote. + + + :param arguments: The arguments of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperCreditNote. + + + :param organizations: The organizations of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperCreditNote. + + + :param types: The types of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperCreditNote. + + + :param offset: The offset of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperCreditNote. + + + :param records: The records of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperCreditNote. + + + :param order_by: The order_by of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperCreditNote. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperCreditNote. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperCreditNote. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperCreditNote. + + + :param entity: The entity of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: CreditNote + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperCreditNote. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: CreditNote + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: list[CreditNote] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperCreditNote. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: list[CreditNote] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperCreditNote. + + + :param single_result: The single_result of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperCreditNote, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperCreditNote): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_data_sync_job_response.py b/billforward/models/typed_query_result_wrapper_data_sync_job_response.py new file mode 100644 index 0000000..a3168eb --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_data_sync_job_response.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperDataSyncJobResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'DataSyncJobResponse', + 'typed_results': 'list[DataSyncJobResponse]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperDataSyncJobResponse - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param total_records: The total_records of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param results: The results of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param arguments: The arguments of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param organizations: The organizations of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param types: The types of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param offset: The offset of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param records: The records of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param order_by: The order_by of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param entity: The entity of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: DataSyncJobResponse + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: DataSyncJobResponse + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: list[DataSyncJobResponse] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: list[DataSyncJobResponse] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param single_result: The single_result of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperDataSyncJobResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperDataSyncJobResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_dunning_line.py b/billforward/models/typed_query_result_wrapper_dunning_line.py new file mode 100644 index 0000000..de6b18b --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_dunning_line.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperDunningLine(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'DunningLine', + 'typed_results': 'list[DunningLine]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperDunningLine - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperDunningLine. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperDunningLine. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperDunningLine. + + + :param total_records: The total_records of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperDunningLine. + + + :param results: The results of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperDunningLine. + + + :param arguments: The arguments of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperDunningLine. + + + :param organizations: The organizations of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperDunningLine. + + + :param types: The types of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperDunningLine. + + + :param offset: The offset of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperDunningLine. + + + :param records: The records of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperDunningLine. + + + :param order_by: The order_by of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperDunningLine. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperDunningLine. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperDunningLine. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperDunningLine. + + + :param entity: The entity of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: DunningLine + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperDunningLine. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: DunningLine + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: list[DunningLine] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperDunningLine. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: list[DunningLine] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperDunningLine. + + + :param single_result: The single_result of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperDunningLine, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperDunningLine): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_invoice.py b/billforward/models/typed_query_result_wrapper_invoice.py new file mode 100644 index 0000000..54a6d28 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_invoice.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperInvoice(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Invoice', + 'typed_results': 'list[Invoice]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperInvoice - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperInvoice. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperInvoice. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperInvoice. + + + :param total_records: The total_records of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperInvoice. + + + :param results: The results of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperInvoice. + + + :param arguments: The arguments of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperInvoice. + + + :param organizations: The organizations of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperInvoice. + + + :param types: The types of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperInvoice. + + + :param offset: The offset of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperInvoice. + + + :param records: The records of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperInvoice. + + + :param order_by: The order_by of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperInvoice. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperInvoice. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperInvoice. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperInvoice. + + + :param entity: The entity of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: Invoice + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperInvoice. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: Invoice + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: list[Invoice] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperInvoice. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: list[Invoice] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperInvoice. + + + :param single_result: The single_result of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperInvoice, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperInvoice): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_invoice_line_payment.py b/billforward/models/typed_query_result_wrapper_invoice_line_payment.py new file mode 100644 index 0000000..db45866 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_invoice_line_payment.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperInvoiceLinePayment(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'InvoiceLinePayments', + 'typed_results': 'list[InvoiceLinePayments]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperInvoiceLinePayment - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param total_records: The total_records of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param results: The results of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param arguments: The arguments of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param organizations: The organizations of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param types: The types of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param offset: The offset of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param records: The records of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param order_by: The order_by of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param entity: The entity of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: InvoiceLinePayments + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: InvoiceLinePayments + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: list[InvoiceLinePayments] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: list[InvoiceLinePayments] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param single_result: The single_result of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperInvoiceLinePayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperInvoiceLinePayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_notification.py b/billforward/models/typed_query_result_wrapper_notification.py new file mode 100644 index 0000000..de77bd8 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_notification.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperNotification(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Notifications', + 'typed_results': 'list[Notifications]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperNotification - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperNotification. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperNotification. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperNotification. + + + :param total_records: The total_records of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperNotification. + + + :param results: The results of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperNotification. + + + :param arguments: The arguments of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperNotification. + + + :param organizations: The organizations of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperNotification. + + + :param types: The types of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperNotification. + + + :param offset: The offset of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperNotification. + + + :param records: The records of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperNotification. + + + :param order_by: The order_by of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperNotification. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperNotification. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperNotification. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperNotification. + + + :param entity: The entity of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: Notifications + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperNotification. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: Notifications + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: list[Notifications] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperNotification. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: list[Notifications] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperNotification. + + + :param single_result: The single_result of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperNotification, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperNotification): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_payment.py b/billforward/models/typed_query_result_wrapper_payment.py new file mode 100644 index 0000000..6cbdaa7 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_payment.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperPayment(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Payment', + 'typed_results': 'list[Payment]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperPayment - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperPayment. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperPayment. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperPayment. + + + :param total_records: The total_records of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperPayment. + + + :param results: The results of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperPayment. + + + :param arguments: The arguments of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperPayment. + + + :param organizations: The organizations of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperPayment. + + + :param types: The types of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperPayment. + + + :param offset: The offset of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperPayment. + + + :param records: The records of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperPayment. + + + :param order_by: The order_by of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperPayment. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperPayment. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperPayment. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperPayment. + + + :param entity: The entity of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: Payment + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperPayment. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: Payment + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: list[Payment] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperPayment. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: list[Payment] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperPayment. + + + :param single_result: The single_result of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperPayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperPayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_payment_method.py b/billforward/models/typed_query_result_wrapper_payment_method.py new file mode 100644 index 0000000..9021a0b --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_payment_method.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperPaymentMethod(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'PaymentMethod', + 'typed_results': 'list[PaymentMethod]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperPaymentMethod - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperPaymentMethod. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperPaymentMethod. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperPaymentMethod. + + + :param total_records: The total_records of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperPaymentMethod. + + + :param results: The results of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperPaymentMethod. + + + :param arguments: The arguments of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperPaymentMethod. + + + :param organizations: The organizations of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperPaymentMethod. + + + :param types: The types of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperPaymentMethod. + + + :param offset: The offset of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperPaymentMethod. + + + :param records: The records of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperPaymentMethod. + + + :param order_by: The order_by of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperPaymentMethod. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperPaymentMethod. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperPaymentMethod. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperPaymentMethod. + + + :param entity: The entity of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: PaymentMethod + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperPaymentMethod. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: PaymentMethod + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: list[PaymentMethod] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperPaymentMethod. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: list[PaymentMethod] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperPaymentMethod. + + + :param single_result: The single_result of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperPaymentMethod, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperPaymentMethod): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_plan_response.py b/billforward/models/typed_query_result_wrapper_plan_response.py new file mode 100644 index 0000000..cc9c706 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_plan_response.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperPlanResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'PlanResponse', + 'typed_results': 'list[PlanResponse]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperPlanResponse - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperPlanResponse. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperPlanResponse. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperPlanResponse. + + + :param total_records: The total_records of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperPlanResponse. + + + :param results: The results of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperPlanResponse. + + + :param arguments: The arguments of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperPlanResponse. + + + :param organizations: The organizations of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperPlanResponse. + + + :param types: The types of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperPlanResponse. + + + :param offset: The offset of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperPlanResponse. + + + :param records: The records of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperPlanResponse. + + + :param order_by: The order_by of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperPlanResponse. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperPlanResponse. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperPlanResponse. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperPlanResponse. + + + :param entity: The entity of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: PlanResponse + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperPlanResponse. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: PlanResponse + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: list[PlanResponse] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperPlanResponse. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: list[PlanResponse] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperPlanResponse. + + + :param single_result: The single_result of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperPlanResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperPlanResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_profile.py b/billforward/models/typed_query_result_wrapper_profile.py new file mode 100644 index 0000000..b3d2de7 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_profile.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperProfile(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Profile', + 'typed_results': 'list[Profile]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperProfile - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperProfile. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperProfile. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperProfile. + + + :param total_records: The total_records of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperProfile. + + + :param results: The results of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperProfile. + + + :param arguments: The arguments of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperProfile. + + + :param organizations: The organizations of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperProfile. + + + :param types: The types of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperProfile. + + + :param offset: The offset of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperProfile. + + + :param records: The records of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperProfile. + + + :param order_by: The order_by of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperProfile. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperProfile. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperProfile. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperProfile. + + + :param entity: The entity of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: Profile + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperProfile. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: Profile + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: list[Profile] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperProfile. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: list[Profile] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperProfile. + + + :param single_result: The single_result of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperProfile, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperProfile): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_receipt.py b/billforward/models/typed_query_result_wrapper_receipt.py new file mode 100644 index 0000000..d44acd7 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_receipt.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperReceipt(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Receipt', + 'typed_results': 'list[Receipt]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperReceipt - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperReceipt. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperReceipt. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperReceipt. + + + :param total_records: The total_records of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperReceipt. + + + :param results: The results of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperReceipt. + + + :param arguments: The arguments of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperReceipt. + + + :param organizations: The organizations of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperReceipt. + + + :param types: The types of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperReceipt. + + + :param offset: The offset of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperReceipt. + + + :param records: The records of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperReceipt. + + + :param order_by: The order_by of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperReceipt. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperReceipt. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperReceipt. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperReceipt. + + + :param entity: The entity of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: Receipt + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperReceipt. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: Receipt + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: list[Receipt] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperReceipt. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: list[Receipt] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperReceipt. + + + :param single_result: The single_result of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperReceipt, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperReceipt): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_refund.py b/billforward/models/typed_query_result_wrapper_refund.py new file mode 100644 index 0000000..da43b94 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_refund.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperRefund(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Refund', + 'typed_results': 'list[Refund]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperRefund - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperRefund. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperRefund. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperRefund. + + + :param total_records: The total_records of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperRefund. + + + :param results: The results of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperRefund. + + + :param arguments: The arguments of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperRefund. + + + :param organizations: The organizations of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperRefund. + + + :param types: The types of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperRefund. + + + :param offset: The offset of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperRefund. + + + :param records: The records of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperRefund. + + + :param order_by: The order_by of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperRefund. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperRefund. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperRefund. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperRefund. + + + :param entity: The entity of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: Refund + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperRefund. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: Refund + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: list[Refund] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperRefund. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: list[Refund] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperRefund. + + + :param single_result: The single_result of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperRefund, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperRefund): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_revenue_attribution.py b/billforward/models/typed_query_result_wrapper_revenue_attribution.py new file mode 100644 index 0000000..c84e9fa --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_revenue_attribution.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperRevenueAttribution(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'RevenueAttributions', + 'typed_results': 'list[RevenueAttributions]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperRevenueAttribution - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperRevenueAttribution. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperRevenueAttribution. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperRevenueAttribution. + + + :param total_records: The total_records of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperRevenueAttribution. + + + :param results: The results of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperRevenueAttribution. + + + :param arguments: The arguments of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperRevenueAttribution. + + + :param organizations: The organizations of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperRevenueAttribution. + + + :param types: The types of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperRevenueAttribution. + + + :param offset: The offset of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperRevenueAttribution. + + + :param records: The records of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperRevenueAttribution. + + + :param order_by: The order_by of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperRevenueAttribution. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperRevenueAttribution. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperRevenueAttribution. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperRevenueAttribution. + + + :param entity: The entity of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: RevenueAttributions + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperRevenueAttribution. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: RevenueAttributions + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: list[RevenueAttributions] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperRevenueAttribution. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: list[RevenueAttributions] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperRevenueAttribution. + + + :param single_result: The single_result of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperRevenueAttribution, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperRevenueAttribution): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_role.py b/billforward/models/typed_query_result_wrapper_role.py new file mode 100644 index 0000000..a065c77 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_role.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperRole(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Role', + 'typed_results': 'list[Role]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperRole - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperRole. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperRole. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperRole. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperRole. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperRole. + + + :param total_records: The total_records of this TypedQueryResultWrapperRole. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperRole. + + + :param results: The results of this TypedQueryResultWrapperRole. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperRole. + + + :param arguments: The arguments of this TypedQueryResultWrapperRole. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperRole. + + + :param organizations: The organizations of this TypedQueryResultWrapperRole. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperRole. + + + :param types: The types of this TypedQueryResultWrapperRole. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperRole. + + + :param offset: The offset of this TypedQueryResultWrapperRole. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperRole. + + + :param records: The records of this TypedQueryResultWrapperRole. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperRole. + + + :param order_by: The order_by of this TypedQueryResultWrapperRole. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperRole. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperRole. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperRole. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperRole. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperRole. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperRole. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperRole. + + + :param entity: The entity of this TypedQueryResultWrapperRole. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: Role + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperRole. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperRole. # noqa: E501 + :type: Role + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: list[Role] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperRole. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperRole. # noqa: E501 + :type: list[Role] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperRole. + + + :param single_result: The single_result of this TypedQueryResultWrapperRole. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperRole, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperRole): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_stripe_ach_token.py b/billforward/models/typed_query_result_wrapper_stripe_ach_token.py new file mode 100644 index 0000000..02ee5ba --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_stripe_ach_token.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperStripeACHToken(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'StripeAchToken', + 'typed_results': 'list[StripeAchToken]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperStripeACHToken - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperStripeACHToken. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperStripeACHToken. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperStripeACHToken. + + + :param total_records: The total_records of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperStripeACHToken. + + + :param results: The results of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperStripeACHToken. + + + :param arguments: The arguments of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperStripeACHToken. + + + :param organizations: The organizations of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperStripeACHToken. + + + :param types: The types of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperStripeACHToken. + + + :param offset: The offset of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperStripeACHToken. + + + :param records: The records of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperStripeACHToken. + + + :param order_by: The order_by of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperStripeACHToken. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperStripeACHToken. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperStripeACHToken. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperStripeACHToken. + + + :param entity: The entity of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: StripeAchToken + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperStripeACHToken. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: StripeAchToken + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: list[StripeAchToken] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperStripeACHToken. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: list[StripeAchToken] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperStripeACHToken. + + + :param single_result: The single_result of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperStripeACHToken, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperStripeACHToken): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_stripe_token.py b/billforward/models/typed_query_result_wrapper_stripe_token.py new file mode 100644 index 0000000..1a64871 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_stripe_token.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperStripeToken(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'StripeToken', + 'typed_results': 'list[StripeToken]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperStripeToken - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperStripeToken. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperStripeToken. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperStripeToken. + + + :param total_records: The total_records of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperStripeToken. + + + :param results: The results of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperStripeToken. + + + :param arguments: The arguments of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperStripeToken. + + + :param organizations: The organizations of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperStripeToken. + + + :param types: The types of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperStripeToken. + + + :param offset: The offset of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperStripeToken. + + + :param records: The records of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperStripeToken. + + + :param order_by: The order_by of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperStripeToken. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperStripeToken. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperStripeToken. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperStripeToken. + + + :param entity: The entity of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: StripeToken + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperStripeToken. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: StripeToken + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: list[StripeToken] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperStripeToken. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: list[StripeToken] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperStripeToken. + + + :param single_result: The single_result of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperStripeToken, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperStripeToken): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_subscription.py b/billforward/models/typed_query_result_wrapper_subscription.py new file mode 100644 index 0000000..36e5332 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_subscription.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperSubscription(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Subscription', + 'typed_results': 'list[Subscription]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperSubscription - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperSubscription. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperSubscription. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperSubscription. + + + :param total_records: The total_records of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperSubscription. + + + :param results: The results of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperSubscription. + + + :param arguments: The arguments of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperSubscription. + + + :param organizations: The organizations of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperSubscription. + + + :param types: The types of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperSubscription. + + + :param offset: The offset of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperSubscription. + + + :param records: The records of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperSubscription. + + + :param order_by: The order_by of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperSubscription. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperSubscription. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperSubscription. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperSubscription. + + + :param entity: The entity of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: Subscription + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperSubscription. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: Subscription + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: list[Subscription] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperSubscription. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: list[Subscription] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperSubscription. + + + :param single_result: The single_result of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperSubscription, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperSubscription): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_subscription_charge.py b/billforward/models/typed_query_result_wrapper_subscription_charge.py new file mode 100644 index 0000000..2fe9699 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_subscription_charge.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperSubscriptionCharge(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'SubscriptionCharge', + 'typed_results': 'list[SubscriptionCharge]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperSubscriptionCharge - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperSubscriptionCharge. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperSubscriptionCharge. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperSubscriptionCharge. + + + :param total_records: The total_records of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperSubscriptionCharge. + + + :param results: The results of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperSubscriptionCharge. + + + :param arguments: The arguments of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperSubscriptionCharge. + + + :param organizations: The organizations of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperSubscriptionCharge. + + + :param types: The types of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperSubscriptionCharge. + + + :param offset: The offset of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperSubscriptionCharge. + + + :param records: The records of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperSubscriptionCharge. + + + :param order_by: The order_by of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperSubscriptionCharge. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperSubscriptionCharge. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperSubscriptionCharge. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperSubscriptionCharge. + + + :param entity: The entity of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: SubscriptionCharge + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperSubscriptionCharge. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: SubscriptionCharge + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: list[SubscriptionCharge] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperSubscriptionCharge. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: list[SubscriptionCharge] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperSubscriptionCharge. + + + :param single_result: The single_result of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperSubscriptionCharge, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperSubscriptionCharge): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_taxation_strategy.py b/billforward/models/typed_query_result_wrapper_taxation_strategy.py new file mode 100644 index 0000000..eacd721 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_taxation_strategy.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperTaxationStrategy(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'TaxationStrategy', + 'typed_results': 'list[TaxationStrategy]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperTaxationStrategy - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperTaxationStrategy. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperTaxationStrategy. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperTaxationStrategy. + + + :param total_records: The total_records of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperTaxationStrategy. + + + :param results: The results of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperTaxationStrategy. + + + :param arguments: The arguments of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperTaxationStrategy. + + + :param organizations: The organizations of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperTaxationStrategy. + + + :param types: The types of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperTaxationStrategy. + + + :param offset: The offset of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperTaxationStrategy. + + + :param records: The records of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperTaxationStrategy. + + + :param order_by: The order_by of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperTaxationStrategy. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperTaxationStrategy. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperTaxationStrategy. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperTaxationStrategy. + + + :param entity: The entity of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: TaxationStrategy + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperTaxationStrategy. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: TaxationStrategy + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: list[TaxationStrategy] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperTaxationStrategy. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: list[TaxationStrategy] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperTaxationStrategy. + + + :param single_result: The single_result of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperTaxationStrategy, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperTaxationStrategy): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_user_response.py b/billforward/models/typed_query_result_wrapper_user_response.py new file mode 100644 index 0000000..a4eb669 --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_user_response.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperUserResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'UserResponse', + 'typed_results': 'list[UserResponse]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperUserResponse - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperUserResponse. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperUserResponse. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperUserResponse. + + + :param total_records: The total_records of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperUserResponse. + + + :param results: The results of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperUserResponse. + + + :param arguments: The arguments of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperUserResponse. + + + :param organizations: The organizations of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperUserResponse. + + + :param types: The types of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperUserResponse. + + + :param offset: The offset of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperUserResponse. + + + :param records: The records of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperUserResponse. + + + :param order_by: The order_by of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperUserResponse. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperUserResponse. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperUserResponse. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperUserResponse. + + + :param entity: The entity of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: UserResponse + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperUserResponse. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: UserResponse + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: list[UserResponse] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperUserResponse. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: list[UserResponse] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperUserResponse. + + + :param single_result: The single_result of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperUserResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperUserResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/typed_query_result_wrapper_webhook.py b/billforward/models/typed_query_result_wrapper_webhook.py new file mode 100644 index 0000000..1c6cbfe --- /dev/null +++ b/billforward/models/typed_query_result_wrapper_webhook.py @@ -0,0 +1,538 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class TypedQueryResultWrapperWebhook(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'entity_name': 'str', + 'total_records_returned': 'int', + 'total_records': 'int', + 'results': 'list[BillingEntityBase]', + 'arguments': 'list[str]', + 'organizations': 'list[str]', + 'types': 'list[str]', + 'offset': 'int', + 'records': 'int', + 'order_by': 'str', + 'order_direction': 'str', + 'include_retired': 'bool', + 'wildcard': 'bool', + 'entity': 'bool', + 'typed_single_result': 'Webhook', + 'typed_results': 'list[Webhook]', + 'single_result': 'BillingEntityBase' + } + + attribute_map = { + 'entity_name': 'entityName', + 'total_records_returned': 'totalRecordsReturned', + 'total_records': 'totalRecords', + 'results': 'results', + 'arguments': 'arguments', + 'organizations': 'organizations', + 'types': 'types', + 'offset': 'offset', + 'records': 'records', + 'order_by': 'orderBy', + 'order_direction': 'orderDirection', + 'include_retired': 'includeRetired', + 'wildcard': 'wildcard', + 'entity': 'entity', + 'typed_single_result': 'typedSingleResult', + 'typed_results': 'typedResults', + 'single_result': 'singleResult' + } + + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + """TypedQueryResultWrapperWebhook - a model defined in Swagger""" # noqa: E501 + self._entity_name = None + self._total_records_returned = None + self._total_records = None + self._results = None + self._arguments = None + self._organizations = None + self._types = None + self._offset = None + self._records = None + self._order_by = None + self._order_direction = None + self._include_retired = None + self._wildcard = None + self._entity = None + self._typed_single_result = None + self._typed_results = None + self._single_result = None + self.discriminator = None + if entity_name is not None: + self.entity_name = entity_name + if total_records_returned is not None: + self.total_records_returned = total_records_returned + if total_records is not None: + self.total_records = total_records + if results is not None: + self.results = results + if arguments is not None: + self.arguments = arguments + if organizations is not None: + self.organizations = organizations + if types is not None: + self.types = types + if offset is not None: + self.offset = offset + if records is not None: + self.records = records + if order_by is not None: + self.order_by = order_by + if order_direction is not None: + self.order_direction = order_direction + if include_retired is not None: + self.include_retired = include_retired + if wildcard is not None: + self.wildcard = wildcard + if entity is not None: + self.entity = entity + if typed_single_result is not None: + self.typed_single_result = typed_single_result + if typed_results is not None: + self.typed_results = typed_results + if single_result is not None: + self.single_result = single_result + + @property + def entity_name(self): + """Gets the entity_name of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The entity_name of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: str + """ + return self._entity_name + + @entity_name.setter + def entity_name(self, entity_name): + """Sets the entity_name of this TypedQueryResultWrapperWebhook. + + + :param entity_name: The entity_name of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: str + """ + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if entity_name not in allowed_values: + raise ValueError( + "Invalid value for `entity_name` ({0}), must be one of {1}" # noqa: E501 + .format(entity_name, allowed_values) + ) + + self._entity_name = entity_name + + @property + def total_records_returned(self): + """Gets the total_records_returned of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The total_records_returned of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: int + """ + return self._total_records_returned + + @total_records_returned.setter + def total_records_returned(self, total_records_returned): + """Sets the total_records_returned of this TypedQueryResultWrapperWebhook. + + + :param total_records_returned: The total_records_returned of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: int + """ + + self._total_records_returned = total_records_returned + + @property + def total_records(self): + """Gets the total_records of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The total_records of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this TypedQueryResultWrapperWebhook. + + + :param total_records: The total_records of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: int + """ + + self._total_records = total_records + + @property + def results(self): + """Gets the results of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The results of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: list[BillingEntityBase] + """ + return self._results + + @results.setter + def results(self, results): + """Sets the results of this TypedQueryResultWrapperWebhook. + + + :param results: The results of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: list[BillingEntityBase] + """ + + self._results = results + + @property + def arguments(self): + """Gets the arguments of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The arguments of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: list[str] + """ + return self._arguments + + @arguments.setter + def arguments(self, arguments): + """Sets the arguments of this TypedQueryResultWrapperWebhook. + + + :param arguments: The arguments of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: list[str] + """ + + self._arguments = arguments + + @property + def organizations(self): + """Gets the organizations of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The organizations of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: list[str] + """ + return self._organizations + + @organizations.setter + def organizations(self, organizations): + """Sets the organizations of this TypedQueryResultWrapperWebhook. + + + :param organizations: The organizations of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: list[str] + """ + + self._organizations = organizations + + @property + def types(self): + """Gets the types of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The types of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: list[str] + """ + return self._types + + @types.setter + def types(self, types): + """Sets the types of this TypedQueryResultWrapperWebhook. + + + :param types: The types of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: list[str] + """ + + self._types = types + + @property + def offset(self): + """Gets the offset of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The offset of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: int + """ + return self._offset + + @offset.setter + def offset(self, offset): + """Sets the offset of this TypedQueryResultWrapperWebhook. + + + :param offset: The offset of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: int + """ + + self._offset = offset + + @property + def records(self): + """Gets the records of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The records of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: int + """ + return self._records + + @records.setter + def records(self, records): + """Sets the records of this TypedQueryResultWrapperWebhook. + + + :param records: The records of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: int + """ + + self._records = records + + @property + def order_by(self): + """Gets the order_by of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The order_by of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: str + """ + return self._order_by + + @order_by.setter + def order_by(self, order_by): + """Sets the order_by of this TypedQueryResultWrapperWebhook. + + + :param order_by: The order_by of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: str + """ + + self._order_by = order_by + + @property + def order_direction(self): + """Gets the order_direction of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The order_direction of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: str + """ + return self._order_direction + + @order_direction.setter + def order_direction(self, order_direction): + """Sets the order_direction of this TypedQueryResultWrapperWebhook. + + + :param order_direction: The order_direction of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: str + """ + allowed_values = ["ASC", "DESC"] # noqa: E501 + if order_direction not in allowed_values: + raise ValueError( + "Invalid value for `order_direction` ({0}), must be one of {1}" # noqa: E501 + .format(order_direction, allowed_values) + ) + + self._order_direction = order_direction + + @property + def include_retired(self): + """Gets the include_retired of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The include_retired of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: bool + """ + return self._include_retired + + @include_retired.setter + def include_retired(self, include_retired): + """Sets the include_retired of this TypedQueryResultWrapperWebhook. + + + :param include_retired: The include_retired of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: bool + """ + + self._include_retired = include_retired + + @property + def wildcard(self): + """Gets the wildcard of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The wildcard of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: bool + """ + return self._wildcard + + @wildcard.setter + def wildcard(self, wildcard): + """Sets the wildcard of this TypedQueryResultWrapperWebhook. + + + :param wildcard: The wildcard of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: bool + """ + + self._wildcard = wildcard + + @property + def entity(self): + """Gets the entity of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The entity of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: bool + """ + return self._entity + + @entity.setter + def entity(self, entity): + """Sets the entity of this TypedQueryResultWrapperWebhook. + + + :param entity: The entity of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: bool + """ + + self._entity = entity + + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: Webhook + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperWebhook. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: Webhook + """ + + self._typed_single_result = typed_single_result + + @property + def typed_results(self): + """Gets the typed_results of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The typed_results of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: list[Webhook] + """ + return self._typed_results + + @typed_results.setter + def typed_results(self, typed_results): + """Sets the typed_results of this TypedQueryResultWrapperWebhook. + + + :param typed_results: The typed_results of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: list[Webhook] + """ + + self._typed_results = typed_results + + @property + def single_result(self): + """Gets the single_result of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The single_result of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: BillingEntityBase + """ + return self._single_result + + @single_result.setter + def single_result(self, single_result): + """Sets the single_result of this TypedQueryResultWrapperWebhook. + + + :param single_result: The single_result of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: BillingEntityBase + """ + + self._single_result = single_result + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(TypedQueryResultWrapperWebhook, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, TypedQueryResultWrapperWebhook): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/unit_discount.py b/billforward/models/unit_discount.py deleted file mode 100644 index ad865a8..0000000 --- a/billforward/models/unit_discount.py +++ /dev/null @@ -1,202 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class UnitDiscount(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, unit_value=None, tier_id=None, unaltered_value=None, discount_value=None): - """ - UnitDiscount - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'unit_value': 'int', - 'tier_id': 'str', - 'unaltered_value': 'float', - 'discount_value': 'float' - } - - self.attribute_map = { - 'unit_value': 'unitValue', - 'tier_id': 'tierID', - 'unaltered_value': 'unalteredValue', - 'discount_value': 'discountValue' - } - - self._unit_value = unit_value - self._tier_id = tier_id - self._unaltered_value = unaltered_value - self._discount_value = discount_value - - @property - def unit_value(self): - """ - Gets the unit_value of this UnitDiscount. - - - :return: The unit_value of this UnitDiscount. - :rtype: int - """ - return self._unit_value - - @unit_value.setter - def unit_value(self, unit_value): - """ - Sets the unit_value of this UnitDiscount. - - - :param unit_value: The unit_value of this UnitDiscount. - :type: int - """ - - self._unit_value = unit_value - - @property - def tier_id(self): - """ - Gets the tier_id of this UnitDiscount. - - - :return: The tier_id of this UnitDiscount. - :rtype: str - """ - return self._tier_id - - @tier_id.setter - def tier_id(self, tier_id): - """ - Sets the tier_id of this UnitDiscount. - - - :param tier_id: The tier_id of this UnitDiscount. - :type: str - """ - - self._tier_id = tier_id - - @property - def unaltered_value(self): - """ - Gets the unaltered_value of this UnitDiscount. - - - :return: The unaltered_value of this UnitDiscount. - :rtype: float - """ - return self._unaltered_value - - @unaltered_value.setter - def unaltered_value(self, unaltered_value): - """ - Sets the unaltered_value of this UnitDiscount. - - - :param unaltered_value: The unaltered_value of this UnitDiscount. - :type: float - """ - - self._unaltered_value = unaltered_value - - @property - def discount_value(self): - """ - Gets the discount_value of this UnitDiscount. - - - :return: The discount_value of this UnitDiscount. - :rtype: float - """ - return self._discount_value - - @discount_value.setter - def discount_value(self, discount_value): - """ - Sets the discount_value of this UnitDiscount. - - - :param discount_value: The discount_value of this UnitDiscount. - :type: float - """ - - self._discount_value = discount_value - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/unit_of_measure.py b/billforward/models/unit_of_measure.py index 75ab0d3..4ee2ae4 100644 --- a/billforward/models/unit_of_measure.py +++ b/billforward/models/unit_of_measure.py @@ -1,97 +1,104 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class UnitOfMeasure(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, crm_id=None, name=None, organization_id=None, displayed_as=None, deleted=False): - """ - UnitOfMeasure - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'crm_id': 'str', - 'name': 'str', - 'organization_id': 'str', - 'displayed_as': 'str', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'crm_id': 'crmID', - 'name': 'name', - 'organization_id': 'organizationID', - 'displayed_as': 'displayedAs', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._crm_id = crm_id - self._name = name - self._organization_id = organization_id - self._displayed_as = displayed_as - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'crm_id': 'str', + 'name': 'str', + 'organization_id': 'str', + 'displayed_as': 'str', + 'deleted': 'bool', + 'rounding': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'crm_id': 'crmID', + 'name': 'name', + 'organization_id': 'organizationID', + 'displayed_as': 'displayedAs', + 'deleted': 'deleted', + 'rounding': 'rounding' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, crm_id=None, name=None, organization_id=None, displayed_as=None, deleted=None, rounding=None): # noqa: E501 + """UnitOfMeasure - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._crm_id = None + self._name = None + self._organization_id = None + self._displayed_as = None + self._deleted = None + self._rounding = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if crm_id is not None: + self.crm_id = crm_id + self.name = name + self.organization_id = organization_id + self.displayed_as = displayed_as + self.deleted = deleted + if rounding is not None: + self.rounding = rounding @property def created(self): - """ - Gets the created of this UnitOfMeasure. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this UnitOfMeasure. # noqa: E501 + - :return: The created of this UnitOfMeasure. + :return: The created of this UnitOfMeasure. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this UnitOfMeasure. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this UnitOfMeasure. - :param created: The created of this UnitOfMeasure. + + :param created: The created of this UnitOfMeasure. # noqa: E501 :type: datetime """ @@ -99,22 +106,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this UnitOfMeasure. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this UnitOfMeasure. # noqa: E501 - :return: The changed_by of this UnitOfMeasure. + + :return: The changed_by of this UnitOfMeasure. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this UnitOfMeasure. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this UnitOfMeasure. + - :param changed_by: The changed_by of this UnitOfMeasure. + :param changed_by: The changed_by of this UnitOfMeasure. # noqa: E501 :type: str """ @@ -122,22 +127,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this UnitOfMeasure. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this UnitOfMeasure. # noqa: E501 + - :return: The updated of this UnitOfMeasure. + :return: The updated of this UnitOfMeasure. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this UnitOfMeasure. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this UnitOfMeasure. + - :param updated: The updated of this UnitOfMeasure. + :param updated: The updated of this UnitOfMeasure. # noqa: E501 :type: datetime """ @@ -145,22 +148,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this UnitOfMeasure. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the id of this UnitOfMeasure. # noqa: E501 - :return: The id of this UnitOfMeasure. + + :return: The id of this UnitOfMeasure. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this UnitOfMeasure. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the id of this UnitOfMeasure. - :param id: The id of this UnitOfMeasure. + + :param id: The id of this UnitOfMeasure. # noqa: E501 :type: str """ @@ -168,22 +169,20 @@ def id(self, id): @property def crm_id(self): - """ - Gets the crm_id of this UnitOfMeasure. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the crm_id of this UnitOfMeasure. # noqa: E501 - :return: The crm_id of this UnitOfMeasure. + + :return: The crm_id of this UnitOfMeasure. # noqa: E501 :rtype: str """ return self._crm_id @crm_id.setter def crm_id(self, crm_id): - """ - Sets the crm_id of this UnitOfMeasure. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the crm_id of this UnitOfMeasure. - :param crm_id: The crm_id of this UnitOfMeasure. + + :param crm_id: The crm_id of this UnitOfMeasure. # noqa: E501 :type: str """ @@ -191,103 +190,128 @@ def crm_id(self, crm_id): @property def name(self): - """ - Gets the name of this UnitOfMeasure. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the name of this UnitOfMeasure. # noqa: E501 + - :return: The name of this UnitOfMeasure. + :return: The name of this UnitOfMeasure. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this UnitOfMeasure. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the name of this UnitOfMeasure. + - :param name: The name of this UnitOfMeasure. + :param name: The name of this UnitOfMeasure. # noqa: E501 :type: str """ + if name is None: + raise ValueError("Invalid value for `name`, must not be `None`") # noqa: E501 self._name = name @property def organization_id(self): - """ - Gets the organization_id of this UnitOfMeasure. - { \"description\" : \"\", \"verbs\":[] } + """Gets the organization_id of this UnitOfMeasure. # noqa: E501 + - :return: The organization_id of this UnitOfMeasure. + :return: The organization_id of this UnitOfMeasure. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this UnitOfMeasure. - { \"description\" : \"\", \"verbs\":[] } + """Sets the organization_id of this UnitOfMeasure. - :param organization_id: The organization_id of this UnitOfMeasure. + + :param organization_id: The organization_id of this UnitOfMeasure. # noqa: E501 :type: str """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 self._organization_id = organization_id @property def displayed_as(self): - """ - Gets the displayed_as of this UnitOfMeasure. - { \"description\" : \"Unit of measurement, such as users, pounds, minutes.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the displayed_as of this UnitOfMeasure. # noqa: E501 - :return: The displayed_as of this UnitOfMeasure. + + :return: The displayed_as of this UnitOfMeasure. # noqa: E501 :rtype: str """ return self._displayed_as @displayed_as.setter def displayed_as(self, displayed_as): - """ - Sets the displayed_as of this UnitOfMeasure. - { \"description\" : \"Unit of measurement, such as users, pounds, minutes.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the displayed_as of this UnitOfMeasure. + - :param displayed_as: The displayed_as of this UnitOfMeasure. + :param displayed_as: The displayed_as of this UnitOfMeasure. # noqa: E501 :type: str """ + if displayed_as is None: + raise ValueError("Invalid value for `displayed_as`, must not be `None`") # noqa: E501 self._displayed_as = displayed_as @property def deleted(self): - """ - Gets the deleted of this UnitOfMeasure. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Gets the deleted of this UnitOfMeasure. # noqa: E501 + - :return: The deleted of this UnitOfMeasure. + :return: The deleted of this UnitOfMeasure. # noqa: E501 :rtype: bool """ return self._deleted @deleted.setter def deleted(self, deleted): - """ - Sets the deleted of this UnitOfMeasure. - { \"description\" : \"\", \"verbs\":[\"GET\"] } + """Sets the deleted of this UnitOfMeasure. + - :param deleted: The deleted of this UnitOfMeasure. + :param deleted: The deleted of this UnitOfMeasure. # noqa: E501 :type: bool """ + if deleted is None: + raise ValueError("Invalid value for `deleted`, must not be `None`") # noqa: E501 self._deleted = deleted - def to_dict(self): + @property + def rounding(self): + """Gets the rounding of this UnitOfMeasure. # noqa: E501 + + + :return: The rounding of this UnitOfMeasure. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._rounding + + @rounding.setter + def rounding(self, rounding): + """Sets the rounding of this UnitOfMeasure. + + + :param rounding: The rounding of this UnitOfMeasure. # noqa: E501 + :type: str """ + allowed_values = ["UP", "DOWN", "HALF_EVEN", "HALF_ODD"] # noqa: E501 + if rounding not in allowed_values: + raise ValueError( + "Invalid value for `rounding` ({0}), must be one of {1}" # noqa: E501 + .format(rounding, allowed_values) + ) + + self._rounding = rounding + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -304,29 +328,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(UnitOfMeasure, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, UnitOfMeasure): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/unit_of_measure_coupon_modifier.py b/billforward/models/unit_of_measure_coupon_modifier.py deleted file mode 100644 index 7f5f3b8..0000000 --- a/billforward/models/unit_of_measure_coupon_modifier.py +++ /dev/null @@ -1,506 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class UnitOfMeasureCouponModifier(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, coupon_definition_id=None, effect_amount=None, operand=None, effect=None, effect_additional=False, specifier_amount=None, domain=None, specifier=None, precedence=None, deleted=False): - """ - UnitOfMeasureCouponModifier - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'coupon_definition_id': 'str', - 'effect_amount': 'float', - 'operand': 'str', - 'effect': 'str', - 'effect_additional': 'bool', - 'specifier_amount': 'int', - 'domain': 'str', - 'specifier': 'str', - 'precedence': 'int', - 'deleted': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'coupon_definition_id': 'couponDefinitionID', - 'effect_amount': 'effectAmount', - 'operand': 'operand', - 'effect': 'effect', - 'effect_additional': 'effectAdditional', - 'specifier_amount': 'specifierAmount', - 'domain': 'domain', - 'specifier': 'specifier', - 'precedence': 'precedence', - 'deleted': 'deleted' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._coupon_definition_id = coupon_definition_id - self._effect_amount = effect_amount - self._operand = operand - self._effect = effect - self._effect_additional = effect_additional - self._specifier_amount = specifier_amount - self._domain = domain - self._specifier = specifier - self._precedence = precedence - self._deleted = deleted - - @property - def created(self): - """ - Gets the created of this UnitOfMeasureCouponModifier. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this UnitOfMeasureCouponModifier. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this UnitOfMeasureCouponModifier. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this UnitOfMeasureCouponModifier. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this UnitOfMeasureCouponModifier. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this UnitOfMeasureCouponModifier. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this UnitOfMeasureCouponModifier. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this UnitOfMeasureCouponModifier. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this UnitOfMeasureCouponModifier. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this UnitOfMeasureCouponModifier. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this UnitOfMeasureCouponModifier. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this UnitOfMeasureCouponModifier. - :type: datetime - """ - - self._updated = updated - - @property - def id(self): - """ - Gets the id of this UnitOfMeasureCouponModifier. - { \"description\" : \"ID of the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The id of this UnitOfMeasureCouponModifier. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this UnitOfMeasureCouponModifier. - { \"description\" : \"ID of the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param id: The id of this UnitOfMeasureCouponModifier. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this UnitOfMeasureCouponModifier. - { \"description\" : \"ID of the organization associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this UnitOfMeasureCouponModifier. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this UnitOfMeasureCouponModifier. - { \"description\" : \"ID of the organization associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this UnitOfMeasureCouponModifier. - :type: str - """ - - self._organization_id = organization_id - - @property - def coupon_definition_id(self): - """ - Gets the coupon_definition_id of this UnitOfMeasureCouponModifier. - { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The coupon_definition_id of this UnitOfMeasureCouponModifier. - :rtype: str - """ - return self._coupon_definition_id - - @coupon_definition_id.setter - def coupon_definition_id(self, coupon_definition_id): - """ - Sets the coupon_definition_id of this UnitOfMeasureCouponModifier. - { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param coupon_definition_id: The coupon_definition_id of this UnitOfMeasureCouponModifier. - :type: str - """ - - self._coupon_definition_id = coupon_definition_id - - @property - def effect_amount(self): - """ - Gets the effect_amount of this UnitOfMeasureCouponModifier. - { \"description\" : \"The effect amount for the coupon-modifier. This is affected by the operand field.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The effect_amount of this UnitOfMeasureCouponModifier. - :rtype: float - """ - return self._effect_amount - - @effect_amount.setter - def effect_amount(self, effect_amount): - """ - Sets the effect_amount of this UnitOfMeasureCouponModifier. - { \"description\" : \"The effect amount for the coupon-modifier. This is affected by the operand field.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param effect_amount: The effect_amount of this UnitOfMeasureCouponModifier. - :type: float - """ - - self._effect_amount = effect_amount - - @property - def operand(self): - """ - Gets the operand of this UnitOfMeasureCouponModifier. - { \"description\" : \"The operand field affects the effect amount of the coupon-modifier. If the operand is fixed, it is an exact amount of the currency defined by the coupon-definition. If the operand is percent, this means the coupon will be affecting a percentage of the unaltered cost. E.g. a 25% modifier will apply a 25% discount on a subscription or a pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The operand of this UnitOfMeasureCouponModifier. - :rtype: str - """ - return self._operand - - @operand.setter - def operand(self, operand): - """ - Sets the operand of this UnitOfMeasureCouponModifier. - { \"description\" : \"The operand field affects the effect amount of the coupon-modifier. If the operand is fixed, it is an exact amount of the currency defined by the coupon-definition. If the operand is percent, this means the coupon will be affecting a percentage of the unaltered cost. E.g. a 25% modifier will apply a 25% discount on a subscription or a pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param operand: The operand of this UnitOfMeasureCouponModifier. - :type: str - """ - allowed_values = ["fixed", "percent", "instance_fixed", "instance_percent"] - if operand not in allowed_values: - raise ValueError( - "Invalid value for `operand` ({0}), must be one of {1}" - .format(operand, allowed_values) - ) - - self._operand = operand - - @property - def effect(self): - """ - Gets the effect of this UnitOfMeasureCouponModifier. - { \"description\" : \"The effect of the coupon-modifier. The coupon-modifier can affect first, last, and cheapest value of a specific unit-of-measure-id for a subscription. The coupon-modifier can also affect all of the values for a unit-of-measure-id, or can affect all of the subscription cost.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The effect of this UnitOfMeasureCouponModifier. - :rtype: str - """ - return self._effect - - @effect.setter - def effect(self, effect): - """ - Sets the effect of this UnitOfMeasureCouponModifier. - { \"description\" : \"The effect of the coupon-modifier. The coupon-modifier can affect first, last, and cheapest value of a specific unit-of-measure-id for a subscription. The coupon-modifier can also affect all of the values for a unit-of-measure-id, or can affect all of the subscription cost.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param effect: The effect of this UnitOfMeasureCouponModifier. - :type: str - """ - allowed_values = ["discount_first_units", "discount_last_units", "discount_cheapest_units", "discount_all"] - if effect not in allowed_values: - raise ValueError( - "Invalid value for `effect` ({0}), must be one of {1}" - .format(effect, allowed_values) - ) - - self._effect = effect - - @property - def effect_additional(self): - """ - Gets the effect_additional of this UnitOfMeasureCouponModifier. - { \"description\" : \"Specifies whether the coupon-modifier will be affecting only additional units. If this field is set, the coupon-instance-existing-values for the coupon-instance are observed, and any units of the unit-of-measure-id defined by the modifier below the coupon-instance-existing-values for that unit-of-measure-id will be ignored.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The effect_additional of this UnitOfMeasureCouponModifier. - :rtype: bool - """ - return self._effect_additional - - @effect_additional.setter - def effect_additional(self, effect_additional): - """ - Sets the effect_additional of this UnitOfMeasureCouponModifier. - { \"description\" : \"Specifies whether the coupon-modifier will be affecting only additional units. If this field is set, the coupon-instance-existing-values for the coupon-instance are observed, and any units of the unit-of-measure-id defined by the modifier below the coupon-instance-existing-values for that unit-of-measure-id will be ignored.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param effect_additional: The effect_additional of this UnitOfMeasureCouponModifier. - :type: bool - """ - - self._effect_additional = effect_additional - - @property - def specifier_amount(self): - """ - Gets the specifier_amount of this UnitOfMeasureCouponModifier. - { \"description\" : \"The number of units that will be affected by the coupon-modifier, if the domain is set to uom\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The specifier_amount of this UnitOfMeasureCouponModifier. - :rtype: int - """ - return self._specifier_amount - - @specifier_amount.setter - def specifier_amount(self, specifier_amount): - """ - Sets the specifier_amount of this UnitOfMeasureCouponModifier. - { \"description\" : \"The number of units that will be affected by the coupon-modifier, if the domain is set to uom\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param specifier_amount: The specifier_amount of this UnitOfMeasureCouponModifier. - :type: int - """ - - self._specifier_amount = specifier_amount - - @property - def domain(self): - """ - Gets the domain of this UnitOfMeasureCouponModifier. - { \"description\" : \"The domain of the coupon-modifier\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The domain of this UnitOfMeasureCouponModifier. - :rtype: str - """ - return self._domain - - @domain.setter - def domain(self, domain): - """ - Sets the domain of this UnitOfMeasureCouponModifier. - { \"description\" : \"The domain of the coupon-modifier\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param domain: The domain of this UnitOfMeasureCouponModifier. - :type: str - """ - allowed_values = ["product", "uom", "PricingComponent"] - if domain not in allowed_values: - raise ValueError( - "Invalid value for `domain` ({0}), must be one of {1}" - .format(domain, allowed_values) - ) - - self._domain = domain - - @property - def specifier(self): - """ - Gets the specifier of this UnitOfMeasureCouponModifier. - { \"description\" : \"The specifier is domain-specific. If the domain is uom, this field is used to limit the coupon-modifier to a specific unit-of-measure-id.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The specifier of this UnitOfMeasureCouponModifier. - :rtype: str - """ - return self._specifier - - @specifier.setter - def specifier(self, specifier): - """ - Sets the specifier of this UnitOfMeasureCouponModifier. - { \"description\" : \"The specifier is domain-specific. If the domain is uom, this field is used to limit the coupon-modifier to a specific unit-of-measure-id.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param specifier: The specifier of this UnitOfMeasureCouponModifier. - :type: str - """ - - self._specifier = specifier - - @property - def precedence(self): - """ - Gets the precedence of this UnitOfMeasureCouponModifier. - { \"description\" : \"The precedence of the coupon-modifier. This is used to order application of coupon-modifiers. Higher precedence means the coupon-modifier will be applied before others.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The precedence of this UnitOfMeasureCouponModifier. - :rtype: int - """ - return self._precedence - - @precedence.setter - def precedence(self, precedence): - """ - Sets the precedence of this UnitOfMeasureCouponModifier. - { \"description\" : \"The precedence of the coupon-modifier. This is used to order application of coupon-modifiers. Higher precedence means the coupon-modifier will be applied before others.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param precedence: The precedence of this UnitOfMeasureCouponModifier. - :type: int - """ - - self._precedence = precedence - - @property - def deleted(self): - """ - Gets the deleted of this UnitOfMeasureCouponModifier. - { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The deleted of this UnitOfMeasureCouponModifier. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this UnitOfMeasureCouponModifier. - { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param deleted: The deleted of this UnitOfMeasureCouponModifier. - :type: bool - """ - - self._deleted = deleted - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/unit_of_measure_paged_metadata.py b/billforward/models/unit_of_measure_paged_metadata.py deleted file mode 100644 index 01e5208..0000000 --- a/billforward/models/unit_of_measure_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class UnitOfMeasurePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - UnitOfMeasurePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[UnitOfMeasure]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this UnitOfMeasurePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this UnitOfMeasurePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this UnitOfMeasurePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this UnitOfMeasurePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this UnitOfMeasurePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this UnitOfMeasurePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this UnitOfMeasurePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this UnitOfMeasurePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this UnitOfMeasurePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this UnitOfMeasurePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this UnitOfMeasurePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this UnitOfMeasurePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this UnitOfMeasurePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this UnitOfMeasurePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this UnitOfMeasurePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this UnitOfMeasurePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this UnitOfMeasurePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this UnitOfMeasurePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this UnitOfMeasurePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this UnitOfMeasurePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this UnitOfMeasurePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this UnitOfMeasurePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this UnitOfMeasurePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this UnitOfMeasurePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this UnitOfMeasurePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this UnitOfMeasurePagedMetadata. - :rtype: list[UnitOfMeasure] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this UnitOfMeasurePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this UnitOfMeasurePagedMetadata. - :type: list[UnitOfMeasure] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/update_address_request.py b/billforward/models/update_address_request.py deleted file mode 100644 index 9e5f6f8..0000000 --- a/billforward/models/update_address_request.py +++ /dev/null @@ -1,384 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class UpdateAddressRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, id=None, profile_id=None, address_line1=None, address_line2=None, address_line3=None, city=None, province=None, country=None, postcode=None, landline=None, primary_address=False): - """ - UpdateAddressRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'id': 'str', - 'profile_id': 'str', - 'address_line1': 'str', - 'address_line2': 'str', - 'address_line3': 'str', - 'city': 'str', - 'province': 'str', - 'country': 'str', - 'postcode': 'str', - 'landline': 'str', - 'primary_address': 'bool' - } - - self.attribute_map = { - 'id': 'id', - 'profile_id': 'profileID', - 'address_line1': 'addressLine1', - 'address_line2': 'addressLine2', - 'address_line3': 'addressLine3', - 'city': 'city', - 'province': 'province', - 'country': 'country', - 'postcode': 'postcode', - 'landline': 'landline', - 'primary_address': 'primaryAddress' - } - - self._id = id - self._profile_id = profile_id - self._address_line1 = address_line1 - self._address_line2 = address_line2 - self._address_line3 = address_line3 - self._city = city - self._province = province - self._country = country - self._postcode = postcode - self._landline = landline - self._primary_address = primary_address - - @property - def id(self): - """ - Gets the id of this UpdateAddressRequest. - - - :return: The id of this UpdateAddressRequest. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this UpdateAddressRequest. - - - :param id: The id of this UpdateAddressRequest. - :type: str - """ - - self._id = id - - @property - def profile_id(self): - """ - Gets the profile_id of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The profile_id of this UpdateAddressRequest. - :rtype: str - """ - return self._profile_id - - @profile_id.setter - def profile_id(self, profile_id): - """ - Sets the profile_id of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param profile_id: The profile_id of this UpdateAddressRequest. - :type: str - """ - - self._profile_id = profile_id - - @property - def address_line1(self): - """ - Gets the address_line1 of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The address_line1 of this UpdateAddressRequest. - :rtype: str - """ - return self._address_line1 - - @address_line1.setter - def address_line1(self, address_line1): - """ - Sets the address_line1 of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param address_line1: The address_line1 of this UpdateAddressRequest. - :type: str - """ - - self._address_line1 = address_line1 - - @property - def address_line2(self): - """ - Gets the address_line2 of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The address_line2 of this UpdateAddressRequest. - :rtype: str - """ - return self._address_line2 - - @address_line2.setter - def address_line2(self, address_line2): - """ - Sets the address_line2 of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param address_line2: The address_line2 of this UpdateAddressRequest. - :type: str - """ - - self._address_line2 = address_line2 - - @property - def address_line3(self): - """ - Gets the address_line3 of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The address_line3 of this UpdateAddressRequest. - :rtype: str - """ - return self._address_line3 - - @address_line3.setter - def address_line3(self, address_line3): - """ - Sets the address_line3 of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param address_line3: The address_line3 of this UpdateAddressRequest. - :type: str - """ - - self._address_line3 = address_line3 - - @property - def city(self): - """ - Gets the city of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The city of this UpdateAddressRequest. - :rtype: str - """ - return self._city - - @city.setter - def city(self, city): - """ - Sets the city of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param city: The city of this UpdateAddressRequest. - :type: str - """ - - self._city = city - - @property - def province(self): - """ - Gets the province of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The province of this UpdateAddressRequest. - :rtype: str - """ - return self._province - - @province.setter - def province(self, province): - """ - Sets the province of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param province: The province of this UpdateAddressRequest. - :type: str - """ - - self._province = province - - @property - def country(self): - """ - Gets the country of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The country of this UpdateAddressRequest. - :rtype: str - """ - return self._country - - @country.setter - def country(self, country): - """ - Sets the country of this UpdateAddressRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param country: The country of this UpdateAddressRequest. - :type: str - """ - - self._country = country - - @property - def postcode(self): - """ - Gets the postcode of this UpdateAddressRequest. - { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The postcode of this UpdateAddressRequest. - :rtype: str - """ - return self._postcode - - @postcode.setter - def postcode(self, postcode): - """ - Sets the postcode of this UpdateAddressRequest. - { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param postcode: The postcode of this UpdateAddressRequest. - :type: str - """ - - self._postcode = postcode - - @property - def landline(self): - """ - Gets the landline of this UpdateAddressRequest. - { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The landline of this UpdateAddressRequest. - :rtype: str - """ - return self._landline - - @landline.setter - def landline(self, landline): - """ - Sets the landline of this UpdateAddressRequest. - { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param landline: The landline of this UpdateAddressRequest. - :type: str - """ - - self._landline = landline - - @property - def primary_address(self): - """ - Gets the primary_address of this UpdateAddressRequest. - { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The primary_address of this UpdateAddressRequest. - :rtype: bool - """ - return self._primary_address - - @primary_address.setter - def primary_address(self, primary_address): - """ - Sets the primary_address of this UpdateAddressRequest. - { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param primary_address: The primary_address of this UpdateAddressRequest. - :type: bool - """ - - self._primary_address = primary_address - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/update_component_value_amendment.py b/billforward/models/update_component_value_amendment.py index c2d9595..e58b86d 100644 --- a/billforward/models/update_component_value_amendment.py +++ b/billforward/models/update_component_value_amendment.py @@ -1,435 +1,104 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six +from billforward.models.amendment import Amendment # noqa: F401,E501 + +class UpdateComponentValueAmendment(Amendment): + """NOTE: This class is auto generated by the swagger code generator program. -class UpdateComponentValueAmendment(object): - """ - NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, type=None, id=None, organization_id=None, subscription_id=None, amendment_type=None, actioning_time=None, actioned_time=None, state=None, deleted=False, pricing_component_value_id=None, pricing_component_value_change_id=None, pricing_component_id=None, value=None): - """ - UpdateComponentValueAmendment - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'type': 'str', - 'id': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'amendment_type': 'str', - 'actioning_time': 'datetime', - 'actioned_time': 'datetime', - 'state': 'str', - 'deleted': 'bool', - 'pricing_component_value_id': 'str', - 'pricing_component_value_change_id': 'str', - 'pricing_component_id': 'str', - 'value': 'int' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'type': '@type', - 'id': 'id', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'amendment_type': 'amendmentType', - 'actioning_time': 'actioningTime', - 'actioned_time': 'actionedTime', - 'state': 'state', - 'deleted': 'deleted', - 'pricing_component_value_id': 'pricingComponentValueID', - 'pricing_component_value_change_id': 'pricingComponentValueChangeID', - 'pricing_component_id': 'pricingComponentID', - 'value': 'value' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._type = type - self._id = id - self._organization_id = organization_id - self._subscription_id = subscription_id - self._amendment_type = amendment_type - self._actioning_time = actioning_time - self._actioned_time = actioned_time - self._state = state - self._deleted = deleted - self._pricing_component_value_id = pricing_component_value_id - self._pricing_component_value_change_id = pricing_component_value_change_id - self._pricing_component_id = pricing_component_id - self._value = value - - @property - def created(self): - """ - Gets the created of this UpdateComponentValueAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this UpdateComponentValueAmendment. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this UpdateComponentValueAmendment. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this UpdateComponentValueAmendment. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this UpdateComponentValueAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this UpdateComponentValueAmendment. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this UpdateComponentValueAmendment. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this UpdateComponentValueAmendment. - :type: str - """ - - self._changed_by = changed_by - - @property - def updated(self): - """ - Gets the updated of this UpdateComponentValueAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :return: The updated of this UpdateComponentValueAmendment. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this UpdateComponentValueAmendment. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } - - :param updated: The updated of this UpdateComponentValueAmendment. - :type: datetime - """ - - self._updated = updated - - @property - def type(self): - """ - Gets the type of this UpdateComponentValueAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The type of this UpdateComponentValueAmendment. - :rtype: str - """ - return self._type - - @type.setter - def type(self, type): - """ - Sets the type of this UpdateComponentValueAmendment. - { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } - - :param type: The type of this UpdateComponentValueAmendment. - :type: str - """ - allowed_values = ["InvoiceOutstandingChargesAmendment", "IssueInvoiceAmendment", "PricingComponentValueAmendment", "InvoiceRecalculationAmendment", "CancellationAmendment", "InvoiceNextExecutionAttemptAmendment", "FixedTermExpiryAmendment", "EndTrialAmendment", "ProductRatePlanMigrationAmendment", "AmendmentDiscardAmendment", "UpdateComponentValueAmendment", "ServiceEndAmendment", "ResumeSubscriptionAmendment", "CreateSubscriptionChargeAmendment", "TimerAmendment"] - if type not in allowed_values: - raise ValueError( - "Invalid value for `type` ({0}), must be one of {1}" - .format(type, allowed_values) - ) - - self._type = type - - @property - def id(self): - """ - Gets the id of this UpdateComponentValueAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The id of this UpdateComponentValueAmendment. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this UpdateComponentValueAmendment. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param id: The id of this UpdateComponentValueAmendment. - :type: str - """ - - self._id = id - - @property - def organization_id(self): - """ - Gets the organization_id of this UpdateComponentValueAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :return: The organization_id of this UpdateComponentValueAmendment. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this UpdateComponentValueAmendment. - { \"description\" : \"\", \"verbs\":[\"\"] } - - :param organization_id: The organization_id of this UpdateComponentValueAmendment. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this UpdateComponentValueAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this UpdateComponentValueAmendment. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this UpdateComponentValueAmendment. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this UpdateComponentValueAmendment. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def amendment_type(self): - """ - Gets the amendment_type of this UpdateComponentValueAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :return: The amendment_type of this UpdateComponentValueAmendment. - :rtype: str - """ - return self._amendment_type - - @amendment_type.setter - def amendment_type(self, amendment_type): - """ - Sets the amendment_type of this UpdateComponentValueAmendment. - { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } - - :param amendment_type: The amendment_type of this UpdateComponentValueAmendment. - :type: str - """ - allowed_values = ["InvoiceNextExecutionAttempt", "Cancellation", "PricingComponentValue", "AmendmentDiscard", "Compound", "FixedTermExpiry", "InvoiceRecalculation", "EndTrial", "InvoiceOutstandingCharges", "IssueInvoice", "ProductRatePlanMigration", "UpdateComponentValue", "ServiceEnd", "ResumeSubscription", "CreateSubscriptionCharge", "Timer"] - if amendment_type not in allowed_values: - raise ValueError( - "Invalid value for `amendment_type` ({0}), must be one of {1}" - .format(amendment_type, allowed_values) - ) - - self._amendment_type = amendment_type - - @property - def actioning_time(self): - """ - Gets the actioning_time of this UpdateComponentValueAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The actioning_time of this UpdateComponentValueAmendment. - :rtype: datetime - """ - return self._actioning_time - - @actioning_time.setter - def actioning_time(self, actioning_time): - """ - Sets the actioning_time of this UpdateComponentValueAmendment. - { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param actioning_time: The actioning_time of this UpdateComponentValueAmendment. - :type: datetime - """ - - self._actioning_time = actioning_time - - @property - def actioned_time(self): - """ - Gets the actioned_time of this UpdateComponentValueAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :return: The actioned_time of this UpdateComponentValueAmendment. - :rtype: datetime - """ - return self._actioned_time - - @actioned_time.setter - def actioned_time(self, actioned_time): - """ - Sets the actioned_time of this UpdateComponentValueAmendment. - { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } - - :param actioned_time: The actioned_time of this UpdateComponentValueAmendment. - :type: datetime - """ - - self._actioned_time = actioned_time - - @property - def state(self): - """ - Gets the state of this UpdateComponentValueAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :return: The state of this UpdateComponentValueAmendment. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this UpdateComponentValueAmendment. - Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending - - :param state: The state of this UpdateComponentValueAmendment. - :type: str - """ - allowed_values = ["Pending", "Succeeded", "Failed", "Discarded"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def deleted(self): - """ - Gets the deleted of this UpdateComponentValueAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :return: The deleted of this UpdateComponentValueAmendment. - :rtype: bool - """ - return self._deleted - - @deleted.setter - def deleted(self, deleted): - """ - Sets the deleted of this UpdateComponentValueAmendment. - { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } - - :param deleted: The deleted of this UpdateComponentValueAmendment. - :type: bool - """ - - self._deleted = deleted + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'pricing_component_value_id': 'str', + 'pricing_component_value_change_id': 'str', + 'pricing_component_id': 'str', + 'value': 'int' + } + if hasattr(Amendment, "swagger_types"): + swagger_types.update(Amendment.swagger_types) + + attribute_map = { + 'pricing_component_value_id': 'pricingComponentValueID', + 'pricing_component_value_change_id': 'pricingComponentValueChangeID', + 'pricing_component_id': 'pricingComponentID', + 'value': 'value' + } + if hasattr(Amendment, "attribute_map"): + attribute_map.update(Amendment.attribute_map) + + def __init__(self, pricing_component_value_id=None, pricing_component_value_change_id=None, pricing_component_id=None, value=None, *args, **kwargs): # noqa: E501 + """UpdateComponentValueAmendment - a model defined in Swagger""" # noqa: E501 + self._pricing_component_value_id = None + self._pricing_component_value_change_id = None + self._pricing_component_id = None + self._value = None + self.discriminator = None + self.pricing_component_value_id = pricing_component_value_id + if pricing_component_value_change_id is not None: + self.pricing_component_value_change_id = pricing_component_value_change_id + self.pricing_component_id = pricing_component_id + self.value = value + Amendment.__init__(self, *args, **kwargs) @property def pricing_component_value_id(self): - """ - Gets the pricing_component_value_id of this UpdateComponentValueAmendment. - { \"description\" : \"The consistent ID of the associated pricing-component-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the pricing_component_value_id of this UpdateComponentValueAmendment. # noqa: E501 - :return: The pricing_component_value_id of this UpdateComponentValueAmendment. + + :return: The pricing_component_value_id of this UpdateComponentValueAmendment. # noqa: E501 :rtype: str """ return self._pricing_component_value_id @pricing_component_value_id.setter def pricing_component_value_id(self, pricing_component_value_id): - """ - Sets the pricing_component_value_id of this UpdateComponentValueAmendment. - { \"description\" : \"The consistent ID of the associated pricing-component-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the pricing_component_value_id of this UpdateComponentValueAmendment. + - :param pricing_component_value_id: The pricing_component_value_id of this UpdateComponentValueAmendment. + :param pricing_component_value_id: The pricing_component_value_id of this UpdateComponentValueAmendment. # noqa: E501 :type: str """ + if pricing_component_value_id is None: + raise ValueError("Invalid value for `pricing_component_value_id`, must not be `None`") # noqa: E501 self._pricing_component_value_id = pricing_component_value_id @property def pricing_component_value_change_id(self): - """ - Gets the pricing_component_value_change_id of this UpdateComponentValueAmendment. - { \"description\" : \"The unique ID of the associated pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the pricing_component_value_change_id of this UpdateComponentValueAmendment. # noqa: E501 + - :return: The pricing_component_value_change_id of this UpdateComponentValueAmendment. + :return: The pricing_component_value_change_id of this UpdateComponentValueAmendment. # noqa: E501 :rtype: str """ return self._pricing_component_value_change_id @pricing_component_value_change_id.setter def pricing_component_value_change_id(self, pricing_component_value_change_id): - """ - Sets the pricing_component_value_change_id of this UpdateComponentValueAmendment. - { \"description\" : \"The unique ID of the associated pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the pricing_component_value_change_id of this UpdateComponentValueAmendment. + - :param pricing_component_value_change_id: The pricing_component_value_change_id of this UpdateComponentValueAmendment. + :param pricing_component_value_change_id: The pricing_component_value_change_id of this UpdateComponentValueAmendment. # noqa: E501 :type: str """ @@ -437,57 +106,55 @@ def pricing_component_value_change_id(self, pricing_component_value_change_id): @property def pricing_component_id(self): - """ - Gets the pricing_component_id of this UpdateComponentValueAmendment. - { \"description\" : \"The consistent ID of the associated pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the pricing_component_id of this UpdateComponentValueAmendment. # noqa: E501 - :return: The pricing_component_id of this UpdateComponentValueAmendment. + + :return: The pricing_component_id of this UpdateComponentValueAmendment. # noqa: E501 :rtype: str """ return self._pricing_component_id @pricing_component_id.setter def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this UpdateComponentValueAmendment. - { \"description\" : \"The consistent ID of the associated pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the pricing_component_id of this UpdateComponentValueAmendment. + - :param pricing_component_id: The pricing_component_id of this UpdateComponentValueAmendment. + :param pricing_component_id: The pricing_component_id of this UpdateComponentValueAmendment. # noqa: E501 :type: str """ + if pricing_component_id is None: + raise ValueError("Invalid value for `pricing_component_id`, must not be `None`") # noqa: E501 self._pricing_component_id = pricing_component_id @property def value(self): - """ - Gets the value of this UpdateComponentValueAmendment. - { \"description\" : \"The new value of the pricing-component-value\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the value of this UpdateComponentValueAmendment. # noqa: E501 + - :return: The value of this UpdateComponentValueAmendment. + :return: The value of this UpdateComponentValueAmendment. # noqa: E501 :rtype: int """ return self._value @value.setter def value(self, value): - """ - Sets the value of this UpdateComponentValueAmendment. - { \"description\" : \"The new value of the pricing-component-value\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the value of this UpdateComponentValueAmendment. - :param value: The value of this UpdateComponentValueAmendment. + + :param value: The value of this UpdateComponentValueAmendment. # noqa: E501 :type: int """ + if value is None: + raise ValueError("Invalid value for `value`, must not be `None`") # noqa: E501 self._value = value def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -504,29 +171,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(UpdateComponentValueAmendment, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, UpdateComponentValueAmendment): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/update_contract_request.py b/billforward/models/update_contract_request.py new file mode 100644 index 0000000..7d9c717 --- /dev/null +++ b/billforward/models/update_contract_request.py @@ -0,0 +1,326 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UpdateContractRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'contract': 'str', + 'organization_id': 'str', + 'name': 'str', + 'description': 'str', + 'start': 'datetime', + 'contract_end_behaviour': 'str', + 'valid_from': 'datetime', + 'valid_till': 'datetime' + } + + attribute_map = { + 'created': 'created', + 'contract': 'contract', + 'organization_id': 'organizationID', + 'name': 'name', + 'description': 'description', + 'start': 'start', + 'contract_end_behaviour': 'contractEndBehaviour', + 'valid_from': 'validFrom', + 'valid_till': 'validTill' + } + + def __init__(self, created=None, contract=None, organization_id=None, name=None, description=None, start=None, contract_end_behaviour=None, valid_from=None, valid_till=None): # noqa: E501 + """UpdateContractRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._contract = None + self._organization_id = None + self._name = None + self._description = None + self._start = None + self._contract_end_behaviour = None + self._valid_from = None + self._valid_till = None + self.discriminator = None + if created is not None: + self.created = created + if contract is not None: + self.contract = contract + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if description is not None: + self.description = description + if start is not None: + self.start = start + self.contract_end_behaviour = contract_end_behaviour + self.valid_from = valid_from + if valid_till is not None: + self.valid_till = valid_till + + @property + def created(self): + """Gets the created of this UpdateContractRequest. # noqa: E501 + + + :return: The created of this UpdateContractRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this UpdateContractRequest. + + + :param created: The created of this UpdateContractRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def contract(self): + """Gets the contract of this UpdateContractRequest. # noqa: E501 + + + :return: The contract of this UpdateContractRequest. # noqa: E501 + :rtype: str + """ + return self._contract + + @contract.setter + def contract(self, contract): + """Sets the contract of this UpdateContractRequest. + + + :param contract: The contract of this UpdateContractRequest. # noqa: E501 + :type: str + """ + + self._contract = contract + + @property + def organization_id(self): + """Gets the organization_id of this UpdateContractRequest. # noqa: E501 + + + :return: The organization_id of this UpdateContractRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UpdateContractRequest. + + + :param organization_id: The organization_id of this UpdateContractRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def name(self): + """Gets the name of this UpdateContractRequest. # noqa: E501 + + + :return: The name of this UpdateContractRequest. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this UpdateContractRequest. + + + :param name: The name of this UpdateContractRequest. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this UpdateContractRequest. # noqa: E501 + + + :return: The description of this UpdateContractRequest. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this UpdateContractRequest. + + + :param description: The description of this UpdateContractRequest. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def start(self): + """Gets the start of this UpdateContractRequest. # noqa: E501 + + + :return: The start of this UpdateContractRequest. # noqa: E501 + :rtype: datetime + """ + return self._start + + @start.setter + def start(self, start): + """Sets the start of this UpdateContractRequest. + + + :param start: The start of this UpdateContractRequest. # noqa: E501 + :type: datetime + """ + + self._start = start + + @property + def contract_end_behaviour(self): + """Gets the contract_end_behaviour of this UpdateContractRequest. # noqa: E501 + + + :return: The contract_end_behaviour of this UpdateContractRequest. # noqa: E501 + :rtype: str + """ + return self._contract_end_behaviour + + @contract_end_behaviour.setter + def contract_end_behaviour(self, contract_end_behaviour): + """Sets the contract_end_behaviour of this UpdateContractRequest. + + + :param contract_end_behaviour: The contract_end_behaviour of this UpdateContractRequest. # noqa: E501 + :type: str + """ + if contract_end_behaviour is None: + raise ValueError("Invalid value for `contract_end_behaviour`, must not be `None`") # noqa: E501 + allowed_values = ["ExpireSubscription", "EvergreenSubscription"] # noqa: E501 + if contract_end_behaviour not in allowed_values: + raise ValueError( + "Invalid value for `contract_end_behaviour` ({0}), must be one of {1}" # noqa: E501 + .format(contract_end_behaviour, allowed_values) + ) + + self._contract_end_behaviour = contract_end_behaviour + + @property + def valid_from(self): + """Gets the valid_from of this UpdateContractRequest. # noqa: E501 + + + :return: The valid_from of this UpdateContractRequest. # noqa: E501 + :rtype: datetime + """ + return self._valid_from + + @valid_from.setter + def valid_from(self, valid_from): + """Sets the valid_from of this UpdateContractRequest. + + + :param valid_from: The valid_from of this UpdateContractRequest. # noqa: E501 + :type: datetime + """ + if valid_from is None: + raise ValueError("Invalid value for `valid_from`, must not be `None`") # noqa: E501 + + self._valid_from = valid_from + + @property + def valid_till(self): + """Gets the valid_till of this UpdateContractRequest. # noqa: E501 + + + :return: The valid_till of this UpdateContractRequest. # noqa: E501 + :rtype: datetime + """ + return self._valid_till + + @valid_till.setter + def valid_till(self, valid_till): + """Sets the valid_till of this UpdateContractRequest. + + + :param valid_till: The valid_till of this UpdateContractRequest. # noqa: E501 + :type: datetime + """ + + self._valid_till = valid_till + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UpdateContractRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdateContractRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/update_email_request.py b/billforward/models/update_email_request.py new file mode 100644 index 0000000..4079a0e --- /dev/null +++ b/billforward/models/update_email_request.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UpdateEmailRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'password': 'str', + 'new_email': 'str', + 'confirm_new_email': 'str', + 'revoke_old_access_tokens': 'bool', + 'organization_id': 'str' + } + + attribute_map = { + 'password': 'password', + 'new_email': 'newEmail', + 'confirm_new_email': 'confirmNewEmail', + 'revoke_old_access_tokens': 'revokeOldAccessTokens', + 'organization_id': 'organizationID' + } + + def __init__(self, password=None, new_email=None, confirm_new_email=None, revoke_old_access_tokens=None, organization_id=None): # noqa: E501 + """UpdateEmailRequest - a model defined in Swagger""" # noqa: E501 + self._password = None + self._new_email = None + self._confirm_new_email = None + self._revoke_old_access_tokens = None + self._organization_id = None + self.discriminator = None + if password is not None: + self.password = password + if new_email is not None: + self.new_email = new_email + if confirm_new_email is not None: + self.confirm_new_email = confirm_new_email + if revoke_old_access_tokens is not None: + self.revoke_old_access_tokens = revoke_old_access_tokens + if organization_id is not None: + self.organization_id = organization_id + + @property + def password(self): + """Gets the password of this UpdateEmailRequest. # noqa: E501 + + + :return: The password of this UpdateEmailRequest. # noqa: E501 + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """Sets the password of this UpdateEmailRequest. + + + :param password: The password of this UpdateEmailRequest. # noqa: E501 + :type: str + """ + + self._password = password + + @property + def new_email(self): + """Gets the new_email of this UpdateEmailRequest. # noqa: E501 + + + :return: The new_email of this UpdateEmailRequest. # noqa: E501 + :rtype: str + """ + return self._new_email + + @new_email.setter + def new_email(self, new_email): + """Sets the new_email of this UpdateEmailRequest. + + + :param new_email: The new_email of this UpdateEmailRequest. # noqa: E501 + :type: str + """ + + self._new_email = new_email + + @property + def confirm_new_email(self): + """Gets the confirm_new_email of this UpdateEmailRequest. # noqa: E501 + + + :return: The confirm_new_email of this UpdateEmailRequest. # noqa: E501 + :rtype: str + """ + return self._confirm_new_email + + @confirm_new_email.setter + def confirm_new_email(self, confirm_new_email): + """Sets the confirm_new_email of this UpdateEmailRequest. + + + :param confirm_new_email: The confirm_new_email of this UpdateEmailRequest. # noqa: E501 + :type: str + """ + + self._confirm_new_email = confirm_new_email + + @property + def revoke_old_access_tokens(self): + """Gets the revoke_old_access_tokens of this UpdateEmailRequest. # noqa: E501 + + + :return: The revoke_old_access_tokens of this UpdateEmailRequest. # noqa: E501 + :rtype: bool + """ + return self._revoke_old_access_tokens + + @revoke_old_access_tokens.setter + def revoke_old_access_tokens(self, revoke_old_access_tokens): + """Sets the revoke_old_access_tokens of this UpdateEmailRequest. + + + :param revoke_old_access_tokens: The revoke_old_access_tokens of this UpdateEmailRequest. # noqa: E501 + :type: bool + """ + + self._revoke_old_access_tokens = revoke_old_access_tokens + + @property + def organization_id(self): + """Gets the organization_id of this UpdateEmailRequest. # noqa: E501 + + + :return: The organization_id of this UpdateEmailRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UpdateEmailRequest. + + + :param organization_id: The organization_id of this UpdateEmailRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UpdateEmailRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdateEmailRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/update_invoice_request.py b/billforward/models/update_invoice_request.py new file mode 100644 index 0000000..e72d271 --- /dev/null +++ b/billforward/models/update_invoice_request.py @@ -0,0 +1,350 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UpdateInvoiceRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'id': 'str', + 'version_id': 'str', + 'state': 'str', + 'name': 'str', + 'description': 'str', + 'purchase_order': 'str', + 'payment_terms': 'int', + 'payment_amount': 'float', + 'due': 'datetime' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'id': 'id', + 'version_id': 'versionID', + 'state': 'state', + 'name': 'name', + 'description': 'description', + 'purchase_order': 'purchaseOrder', + 'payment_terms': 'paymentTerms', + 'payment_amount': 'paymentAmount', + 'due': 'due' + } + + def __init__(self, organization_id=None, id=None, version_id=None, state=None, name=None, description=None, purchase_order=None, payment_terms=None, payment_amount=None, due=None): # noqa: E501 + """UpdateInvoiceRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._id = None + self._version_id = None + self._state = None + self._name = None + self._description = None + self._purchase_order = None + self._payment_terms = None + self._payment_amount = None + self._due = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if id is not None: + self.id = id + if version_id is not None: + self.version_id = version_id + if state is not None: + self.state = state + if name is not None: + self.name = name + if description is not None: + self.description = description + if purchase_order is not None: + self.purchase_order = purchase_order + if payment_terms is not None: + self.payment_terms = payment_terms + if payment_amount is not None: + self.payment_amount = payment_amount + if due is not None: + self.due = due + + @property + def organization_id(self): + """Gets the organization_id of this UpdateInvoiceRequest. # noqa: E501 + + + :return: The organization_id of this UpdateInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UpdateInvoiceRequest. + + + :param organization_id: The organization_id of this UpdateInvoiceRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def id(self): + """Gets the id of this UpdateInvoiceRequest. # noqa: E501 + + + :return: The id of this UpdateInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this UpdateInvoiceRequest. + + + :param id: The id of this UpdateInvoiceRequest. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def version_id(self): + """Gets the version_id of this UpdateInvoiceRequest. # noqa: E501 + + + :return: The version_id of this UpdateInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._version_id + + @version_id.setter + def version_id(self, version_id): + """Sets the version_id of this UpdateInvoiceRequest. + + + :param version_id: The version_id of this UpdateInvoiceRequest. # noqa: E501 + :type: str + """ + + self._version_id = version_id + + @property + def state(self): + """Gets the state of this UpdateInvoiceRequest. # noqa: E501 + + + :return: The state of this UpdateInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this UpdateInvoiceRequest. + + + :param state: The state of this UpdateInvoiceRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Unpaid", "Pending"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + @property + def name(self): + """Gets the name of this UpdateInvoiceRequest. # noqa: E501 + + + :return: The name of this UpdateInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this UpdateInvoiceRequest. + + + :param name: The name of this UpdateInvoiceRequest. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def description(self): + """Gets the description of this UpdateInvoiceRequest. # noqa: E501 + + + :return: The description of this UpdateInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """Sets the description of this UpdateInvoiceRequest. + + + :param description: The description of this UpdateInvoiceRequest. # noqa: E501 + :type: str + """ + + self._description = description + + @property + def purchase_order(self): + """Gets the purchase_order of this UpdateInvoiceRequest. # noqa: E501 + + + :return: The purchase_order of this UpdateInvoiceRequest. # noqa: E501 + :rtype: str + """ + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this UpdateInvoiceRequest. + + + :param purchase_order: The purchase_order of this UpdateInvoiceRequest. # noqa: E501 + :type: str + """ + + self._purchase_order = purchase_order + + @property + def payment_terms(self): + """Gets the payment_terms of this UpdateInvoiceRequest. # noqa: E501 + + + :return: The payment_terms of this UpdateInvoiceRequest. # noqa: E501 + :rtype: int + """ + return self._payment_terms + + @payment_terms.setter + def payment_terms(self, payment_terms): + """Sets the payment_terms of this UpdateInvoiceRequest. + + + :param payment_terms: The payment_terms of this UpdateInvoiceRequest. # noqa: E501 + :type: int + """ + + self._payment_terms = payment_terms + + @property + def payment_amount(self): + """Gets the payment_amount of this UpdateInvoiceRequest. # noqa: E501 + + + :return: The payment_amount of this UpdateInvoiceRequest. # noqa: E501 + :rtype: float + """ + return self._payment_amount + + @payment_amount.setter + def payment_amount(self, payment_amount): + """Sets the payment_amount of this UpdateInvoiceRequest. + + + :param payment_amount: The payment_amount of this UpdateInvoiceRequest. # noqa: E501 + :type: float + """ + + self._payment_amount = payment_amount + + @property + def due(self): + """Gets the due of this UpdateInvoiceRequest. # noqa: E501 + + + :return: The due of this UpdateInvoiceRequest. # noqa: E501 + :rtype: datetime + """ + return self._due + + @due.setter + def due(self, due): + """Sets the due of this UpdateInvoiceRequest. + + + :param due: The due of this UpdateInvoiceRequest. # noqa: E501 + :type: datetime + """ + + self._due = due + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UpdateInvoiceRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdateInvoiceRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/update_invoice_template_request.py b/billforward/models/update_invoice_template_request.py new file mode 100644 index 0000000..009f8dc --- /dev/null +++ b/billforward/models/update_invoice_template_request.py @@ -0,0 +1,440 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UpdateInvoiceTemplateRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'representing_account_id': 'str', + 'tier_breakdown': 'bool', + 'inclusive_end': 'bool', + 'show_zero_cost': 'bool', + 'show_plan_only_when_ambiguous': 'bool', + 'include_footer': 'bool', + 'invoice_header_display': 'str', + 'group_invoice_line_items_by': 'str', + 'hide_tax_if_zero': 'bool', + 'show_unit_price': 'str', + 'company_address_on_top': 'bool', + 'upgrade_duration_wording': 'bool' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'representing_account_id': 'representingAccountID', + 'tier_breakdown': 'tierBreakdown', + 'inclusive_end': 'inclusiveEnd', + 'show_zero_cost': 'showZeroCost', + 'show_plan_only_when_ambiguous': 'showPlanOnlyWhenAmbiguous', + 'include_footer': 'includeFooter', + 'invoice_header_display': 'invoiceHeaderDisplay', + 'group_invoice_line_items_by': 'groupInvoiceLineItemsBy', + 'hide_tax_if_zero': 'hideTaxIfZero', + 'show_unit_price': 'showUnitPrice', + 'company_address_on_top': 'companyAddressOnTop', + 'upgrade_duration_wording': 'upgradeDurationWording' + } + + def __init__(self, organization_id=None, representing_account_id=None, tier_breakdown=None, inclusive_end=None, show_zero_cost=None, show_plan_only_when_ambiguous=None, include_footer=None, invoice_header_display=None, group_invoice_line_items_by=None, hide_tax_if_zero=None, show_unit_price=None, company_address_on_top=None, upgrade_duration_wording=None): # noqa: E501 + """UpdateInvoiceTemplateRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._representing_account_id = None + self._tier_breakdown = None + self._inclusive_end = None + self._show_zero_cost = None + self._show_plan_only_when_ambiguous = None + self._include_footer = None + self._invoice_header_display = None + self._group_invoice_line_items_by = None + self._hide_tax_if_zero = None + self._show_unit_price = None + self._company_address_on_top = None + self._upgrade_duration_wording = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if representing_account_id is not None: + self.representing_account_id = representing_account_id + if tier_breakdown is not None: + self.tier_breakdown = tier_breakdown + if inclusive_end is not None: + self.inclusive_end = inclusive_end + if show_zero_cost is not None: + self.show_zero_cost = show_zero_cost + if show_plan_only_when_ambiguous is not None: + self.show_plan_only_when_ambiguous = show_plan_only_when_ambiguous + if include_footer is not None: + self.include_footer = include_footer + if invoice_header_display is not None: + self.invoice_header_display = invoice_header_display + if group_invoice_line_items_by is not None: + self.group_invoice_line_items_by = group_invoice_line_items_by + if hide_tax_if_zero is not None: + self.hide_tax_if_zero = hide_tax_if_zero + if show_unit_price is not None: + self.show_unit_price = show_unit_price + if company_address_on_top is not None: + self.company_address_on_top = company_address_on_top + if upgrade_duration_wording is not None: + self.upgrade_duration_wording = upgrade_duration_wording + + @property + def organization_id(self): + """Gets the organization_id of this UpdateInvoiceTemplateRequest. # noqa: E501 + + + :return: The organization_id of this UpdateInvoiceTemplateRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UpdateInvoiceTemplateRequest. + + + :param organization_id: The organization_id of this UpdateInvoiceTemplateRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def representing_account_id(self): + """Gets the representing_account_id of this UpdateInvoiceTemplateRequest. # noqa: E501 + + + :return: The representing_account_id of this UpdateInvoiceTemplateRequest. # noqa: E501 + :rtype: str + """ + return self._representing_account_id + + @representing_account_id.setter + def representing_account_id(self, representing_account_id): + """Sets the representing_account_id of this UpdateInvoiceTemplateRequest. + + + :param representing_account_id: The representing_account_id of this UpdateInvoiceTemplateRequest. # noqa: E501 + :type: str + """ + + self._representing_account_id = representing_account_id + + @property + def tier_breakdown(self): + """Gets the tier_breakdown of this UpdateInvoiceTemplateRequest. # noqa: E501 + + + :return: The tier_breakdown of this UpdateInvoiceTemplateRequest. # noqa: E501 + :rtype: bool + """ + return self._tier_breakdown + + @tier_breakdown.setter + def tier_breakdown(self, tier_breakdown): + """Sets the tier_breakdown of this UpdateInvoiceTemplateRequest. + + + :param tier_breakdown: The tier_breakdown of this UpdateInvoiceTemplateRequest. # noqa: E501 + :type: bool + """ + + self._tier_breakdown = tier_breakdown + + @property + def inclusive_end(self): + """Gets the inclusive_end of this UpdateInvoiceTemplateRequest. # noqa: E501 + + + :return: The inclusive_end of this UpdateInvoiceTemplateRequest. # noqa: E501 + :rtype: bool + """ + return self._inclusive_end + + @inclusive_end.setter + def inclusive_end(self, inclusive_end): + """Sets the inclusive_end of this UpdateInvoiceTemplateRequest. + + + :param inclusive_end: The inclusive_end of this UpdateInvoiceTemplateRequest. # noqa: E501 + :type: bool + """ + + self._inclusive_end = inclusive_end + + @property + def show_zero_cost(self): + """Gets the show_zero_cost of this UpdateInvoiceTemplateRequest. # noqa: E501 + + + :return: The show_zero_cost of this UpdateInvoiceTemplateRequest. # noqa: E501 + :rtype: bool + """ + return self._show_zero_cost + + @show_zero_cost.setter + def show_zero_cost(self, show_zero_cost): + """Sets the show_zero_cost of this UpdateInvoiceTemplateRequest. + + + :param show_zero_cost: The show_zero_cost of this UpdateInvoiceTemplateRequest. # noqa: E501 + :type: bool + """ + + self._show_zero_cost = show_zero_cost + + @property + def show_plan_only_when_ambiguous(self): + """Gets the show_plan_only_when_ambiguous of this UpdateInvoiceTemplateRequest. # noqa: E501 + + + :return: The show_plan_only_when_ambiguous of this UpdateInvoiceTemplateRequest. # noqa: E501 + :rtype: bool + """ + return self._show_plan_only_when_ambiguous + + @show_plan_only_when_ambiguous.setter + def show_plan_only_when_ambiguous(self, show_plan_only_when_ambiguous): + """Sets the show_plan_only_when_ambiguous of this UpdateInvoiceTemplateRequest. + + + :param show_plan_only_when_ambiguous: The show_plan_only_when_ambiguous of this UpdateInvoiceTemplateRequest. # noqa: E501 + :type: bool + """ + + self._show_plan_only_when_ambiguous = show_plan_only_when_ambiguous + + @property + def include_footer(self): + """Gets the include_footer of this UpdateInvoiceTemplateRequest. # noqa: E501 + + + :return: The include_footer of this UpdateInvoiceTemplateRequest. # noqa: E501 + :rtype: bool + """ + return self._include_footer + + @include_footer.setter + def include_footer(self, include_footer): + """Sets the include_footer of this UpdateInvoiceTemplateRequest. + + + :param include_footer: The include_footer of this UpdateInvoiceTemplateRequest. # noqa: E501 + :type: bool + """ + + self._include_footer = include_footer + + @property + def invoice_header_display(self): + """Gets the invoice_header_display of this UpdateInvoiceTemplateRequest. # noqa: E501 + + + :return: The invoice_header_display of this UpdateInvoiceTemplateRequest. # noqa: E501 + :rtype: str + """ + return self._invoice_header_display + + @invoice_header_display.setter + def invoice_header_display(self, invoice_header_display): + """Sets the invoice_header_display of this UpdateInvoiceTemplateRequest. + + + :param invoice_header_display: The invoice_header_display of this UpdateInvoiceTemplateRequest. # noqa: E501 + :type: str + """ + allowed_values = ["ID_LEFT", "ID_RIGHT"] # noqa: E501 + if invoice_header_display not in allowed_values: + raise ValueError( + "Invalid value for `invoice_header_display` ({0}), must be one of {1}" # noqa: E501 + .format(invoice_header_display, allowed_values) + ) + + self._invoice_header_display = invoice_header_display + + @property + def group_invoice_line_items_by(self): + """Gets the group_invoice_line_items_by of this UpdateInvoiceTemplateRequest. # noqa: E501 + + + :return: The group_invoice_line_items_by of this UpdateInvoiceTemplateRequest. # noqa: E501 + :rtype: str + """ + return self._group_invoice_line_items_by + + @group_invoice_line_items_by.setter + def group_invoice_line_items_by(self, group_invoice_line_items_by): + """Sets the group_invoice_line_items_by of this UpdateInvoiceTemplateRequest. + + + :param group_invoice_line_items_by: The group_invoice_line_items_by of this UpdateInvoiceTemplateRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Product", "RatePlan", "ProductAndRatePlan"] # noqa: E501 + if group_invoice_line_items_by not in allowed_values: + raise ValueError( + "Invalid value for `group_invoice_line_items_by` ({0}), must be one of {1}" # noqa: E501 + .format(group_invoice_line_items_by, allowed_values) + ) + + self._group_invoice_line_items_by = group_invoice_line_items_by + + @property + def hide_tax_if_zero(self): + """Gets the hide_tax_if_zero of this UpdateInvoiceTemplateRequest. # noqa: E501 + + + :return: The hide_tax_if_zero of this UpdateInvoiceTemplateRequest. # noqa: E501 + :rtype: bool + """ + return self._hide_tax_if_zero + + @hide_tax_if_zero.setter + def hide_tax_if_zero(self, hide_tax_if_zero): + """Sets the hide_tax_if_zero of this UpdateInvoiceTemplateRequest. + + + :param hide_tax_if_zero: The hide_tax_if_zero of this UpdateInvoiceTemplateRequest. # noqa: E501 + :type: bool + """ + + self._hide_tax_if_zero = hide_tax_if_zero + + @property + def show_unit_price(self): + """Gets the show_unit_price of this UpdateInvoiceTemplateRequest. # noqa: E501 + + + :return: The show_unit_price of this UpdateInvoiceTemplateRequest. # noqa: E501 + :rtype: str + """ + return self._show_unit_price + + @show_unit_price.setter + def show_unit_price(self, show_unit_price): + """Sets the show_unit_price of this UpdateInvoiceTemplateRequest. + + + :param show_unit_price: The show_unit_price of this UpdateInvoiceTemplateRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Hidden", "Column", "Inline"] # noqa: E501 + if show_unit_price not in allowed_values: + raise ValueError( + "Invalid value for `show_unit_price` ({0}), must be one of {1}" # noqa: E501 + .format(show_unit_price, allowed_values) + ) + + self._show_unit_price = show_unit_price + + @property + def company_address_on_top(self): + """Gets the company_address_on_top of this UpdateInvoiceTemplateRequest. # noqa: E501 + + + :return: The company_address_on_top of this UpdateInvoiceTemplateRequest. # noqa: E501 + :rtype: bool + """ + return self._company_address_on_top + + @company_address_on_top.setter + def company_address_on_top(self, company_address_on_top): + """Sets the company_address_on_top of this UpdateInvoiceTemplateRequest. + + + :param company_address_on_top: The company_address_on_top of this UpdateInvoiceTemplateRequest. # noqa: E501 + :type: bool + """ + + self._company_address_on_top = company_address_on_top + + @property + def upgrade_duration_wording(self): + """Gets the upgrade_duration_wording of this UpdateInvoiceTemplateRequest. # noqa: E501 + + + :return: The upgrade_duration_wording of this UpdateInvoiceTemplateRequest. # noqa: E501 + :rtype: bool + """ + return self._upgrade_duration_wording + + @upgrade_duration_wording.setter + def upgrade_duration_wording(self, upgrade_duration_wording): + """Sets the upgrade_duration_wording of this UpdateInvoiceTemplateRequest. + + + :param upgrade_duration_wording: The upgrade_duration_wording of this UpdateInvoiceTemplateRequest. # noqa: E501 + :type: bool + """ + + self._upgrade_duration_wording = upgrade_duration_wording + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UpdateInvoiceTemplateRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdateInvoiceTemplateRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/update_password_request.py b/billforward/models/update_password_request.py new file mode 100644 index 0000000..0ae65da --- /dev/null +++ b/billforward/models/update_password_request.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UpdatePasswordRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'old_password': 'str', + 'new_password': 'str', + 'confirm_new_password': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'old_password': 'oldPassword', + 'new_password': 'newPassword', + 'confirm_new_password': 'confirmNewPassword', + 'organization_id': 'organizationID' + } + + def __init__(self, old_password=None, new_password=None, confirm_new_password=None, organization_id=None): # noqa: E501 + """UpdatePasswordRequest - a model defined in Swagger""" # noqa: E501 + self._old_password = None + self._new_password = None + self._confirm_new_password = None + self._organization_id = None + self.discriminator = None + if old_password is not None: + self.old_password = old_password + if new_password is not None: + self.new_password = new_password + if confirm_new_password is not None: + self.confirm_new_password = confirm_new_password + if organization_id is not None: + self.organization_id = organization_id + + @property + def old_password(self): + """Gets the old_password of this UpdatePasswordRequest. # noqa: E501 + + + :return: The old_password of this UpdatePasswordRequest. # noqa: E501 + :rtype: str + """ + return self._old_password + + @old_password.setter + def old_password(self, old_password): + """Sets the old_password of this UpdatePasswordRequest. + + + :param old_password: The old_password of this UpdatePasswordRequest. # noqa: E501 + :type: str + """ + + self._old_password = old_password + + @property + def new_password(self): + """Gets the new_password of this UpdatePasswordRequest. # noqa: E501 + + + :return: The new_password of this UpdatePasswordRequest. # noqa: E501 + :rtype: str + """ + return self._new_password + + @new_password.setter + def new_password(self, new_password): + """Sets the new_password of this UpdatePasswordRequest. + + + :param new_password: The new_password of this UpdatePasswordRequest. # noqa: E501 + :type: str + """ + + self._new_password = new_password + + @property + def confirm_new_password(self): + """Gets the confirm_new_password of this UpdatePasswordRequest. # noqa: E501 + + + :return: The confirm_new_password of this UpdatePasswordRequest. # noqa: E501 + :rtype: str + """ + return self._confirm_new_password + + @confirm_new_password.setter + def confirm_new_password(self, confirm_new_password): + """Sets the confirm_new_password of this UpdatePasswordRequest. + + + :param confirm_new_password: The confirm_new_password of this UpdatePasswordRequest. # noqa: E501 + :type: str + """ + + self._confirm_new_password = confirm_new_password + + @property + def organization_id(self): + """Gets the organization_id of this UpdatePasswordRequest. # noqa: E501 + + + :return: The organization_id of this UpdatePasswordRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UpdatePasswordRequest. + + + :param organization_id: The organization_id of this UpdatePasswordRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UpdatePasswordRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdatePasswordRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/update_password_response.py b/billforward/models/update_password_response.py new file mode 100644 index 0000000..90c47ef --- /dev/null +++ b/billforward/models/update_password_response.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UpdatePasswordResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'id': 'str', + 'username': 'list[UsernameResponse]', + 'organization_id': 'str', + 'password_reset_valid_till': 'datetime' + } + + attribute_map = { + 'created': 'created', + 'id': 'id', + 'username': 'username', + 'organization_id': 'organizationID', + 'password_reset_valid_till': 'passwordResetValidTill' + } + + def __init__(self, created=None, id=None, username=None, organization_id=None, password_reset_valid_till=None): # noqa: E501 + """UpdatePasswordResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._id = None + self._username = None + self._organization_id = None + self._password_reset_valid_till = None + self.discriminator = None + if created is not None: + self.created = created + if id is not None: + self.id = id + if username is not None: + self.username = username + if organization_id is not None: + self.organization_id = organization_id + if password_reset_valid_till is not None: + self.password_reset_valid_till = password_reset_valid_till + + @property + def created(self): + """Gets the created of this UpdatePasswordResponse. # noqa: E501 + + + :return: The created of this UpdatePasswordResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this UpdatePasswordResponse. + + + :param created: The created of this UpdatePasswordResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def id(self): + """Gets the id of this UpdatePasswordResponse. # noqa: E501 + + + :return: The id of this UpdatePasswordResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this UpdatePasswordResponse. + + + :param id: The id of this UpdatePasswordResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def username(self): + """Gets the username of this UpdatePasswordResponse. # noqa: E501 + + + :return: The username of this UpdatePasswordResponse. # noqa: E501 + :rtype: list[UsernameResponse] + """ + return self._username + + @username.setter + def username(self, username): + """Sets the username of this UpdatePasswordResponse. + + + :param username: The username of this UpdatePasswordResponse. # noqa: E501 + :type: list[UsernameResponse] + """ + + self._username = username + + @property + def organization_id(self): + """Gets the organization_id of this UpdatePasswordResponse. # noqa: E501 + + + :return: The organization_id of this UpdatePasswordResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UpdatePasswordResponse. + + + :param organization_id: The organization_id of this UpdatePasswordResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def password_reset_valid_till(self): + """Gets the password_reset_valid_till of this UpdatePasswordResponse. # noqa: E501 + + + :return: The password_reset_valid_till of this UpdatePasswordResponse. # noqa: E501 + :rtype: datetime + """ + return self._password_reset_valid_till + + @password_reset_valid_till.setter + def password_reset_valid_till(self, password_reset_valid_till): + """Sets the password_reset_valid_till of this UpdatePasswordResponse. + + + :param password_reset_valid_till: The password_reset_valid_till of this UpdatePasswordResponse. # noqa: E501 + :type: datetime + """ + + self._password_reset_valid_till = password_reset_valid_till + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UpdatePasswordResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdatePasswordResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/update_pricing_component_value_change_result.py b/billforward/models/update_pricing_component_value_change_result.py new file mode 100644 index 0000000..d23e1bc --- /dev/null +++ b/billforward/models/update_pricing_component_value_change_result.py @@ -0,0 +1,414 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UpdatePricingComponentValueChangeResult(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'pricing_component_id': 'str', + 'pricing_component_name': 'str', + 'pricing_component_public_name': 'str', + 'new_value': 'int', + 'old_value': 'int', + 'type': 'str', + 'subscription_id': 'str', + 'amount': 'float', + 'charge_type': 'str', + 'charge': 'SubscriptionCharge', + 'amendment': 'Amendment', + 'state': 'str' + } + + attribute_map = { + 'pricing_component_id': 'pricingComponentID', + 'pricing_component_name': 'pricingComponentName', + 'pricing_component_public_name': 'pricingComponentPublicName', + 'new_value': 'newValue', + 'old_value': 'oldValue', + 'type': 'type', + 'subscription_id': 'subscriptionID', + 'amount': 'amount', + 'charge_type': 'chargeType', + 'charge': 'charge', + 'amendment': 'amendment', + 'state': 'state' + } + + def __init__(self, pricing_component_id=None, pricing_component_name=None, pricing_component_public_name=None, new_value=None, old_value=None, type=None, subscription_id=None, amount=None, charge_type=None, charge=None, amendment=None, state=None): # noqa: E501 + """UpdatePricingComponentValueChangeResult - a model defined in Swagger""" # noqa: E501 + self._pricing_component_id = None + self._pricing_component_name = None + self._pricing_component_public_name = None + self._new_value = None + self._old_value = None + self._type = None + self._subscription_id = None + self._amount = None + self._charge_type = None + self._charge = None + self._amendment = None + self._state = None + self.discriminator = None + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if pricing_component_public_name is not None: + self.pricing_component_public_name = pricing_component_public_name + if new_value is not None: + self.new_value = new_value + if old_value is not None: + self.old_value = old_value + if type is not None: + self.type = type + if subscription_id is not None: + self.subscription_id = subscription_id + if amount is not None: + self.amount = amount + if charge_type is not None: + self.charge_type = charge_type + if charge is not None: + self.charge = charge + if amendment is not None: + self.amendment = amendment + if state is not None: + self.state = state + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this UpdatePricingComponentValueChangeResult. # noqa: E501 + + + :return: The pricing_component_id of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this UpdatePricingComponentValueChangeResult. + + + :param pricing_component_id: The pricing_component_id of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :type: str + """ + + self._pricing_component_id = pricing_component_id + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this UpdatePricingComponentValueChangeResult. # noqa: E501 + + + :return: The pricing_component_name of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :rtype: str + """ + return self._pricing_component_name + + @pricing_component_name.setter + def pricing_component_name(self, pricing_component_name): + """Sets the pricing_component_name of this UpdatePricingComponentValueChangeResult. + + + :param pricing_component_name: The pricing_component_name of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :type: str + """ + + self._pricing_component_name = pricing_component_name + + @property + def pricing_component_public_name(self): + """Gets the pricing_component_public_name of this UpdatePricingComponentValueChangeResult. # noqa: E501 + + + :return: The pricing_component_public_name of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :rtype: str + """ + return self._pricing_component_public_name + + @pricing_component_public_name.setter + def pricing_component_public_name(self, pricing_component_public_name): + """Sets the pricing_component_public_name of this UpdatePricingComponentValueChangeResult. + + + :param pricing_component_public_name: The pricing_component_public_name of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :type: str + """ + + self._pricing_component_public_name = pricing_component_public_name + + @property + def new_value(self): + """Gets the new_value of this UpdatePricingComponentValueChangeResult. # noqa: E501 + + + :return: The new_value of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :rtype: int + """ + return self._new_value + + @new_value.setter + def new_value(self, new_value): + """Sets the new_value of this UpdatePricingComponentValueChangeResult. + + + :param new_value: The new_value of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :type: int + """ + + self._new_value = new_value + + @property + def old_value(self): + """Gets the old_value of this UpdatePricingComponentValueChangeResult. # noqa: E501 + + + :return: The old_value of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :rtype: int + """ + return self._old_value + + @old_value.setter + def old_value(self, old_value): + """Sets the old_value of this UpdatePricingComponentValueChangeResult. + + + :param old_value: The old_value of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :type: int + """ + + self._old_value = old_value + + @property + def type(self): + """Gets the type of this UpdatePricingComponentValueChangeResult. # noqa: E501 + + + :return: The type of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this UpdatePricingComponentValueChangeResult. + + + :param type: The type of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :type: str + """ + allowed_values = ["Upgrade", "Downgrade", "NoChange"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def subscription_id(self): + """Gets the subscription_id of this UpdatePricingComponentValueChangeResult. # noqa: E501 + + + :return: The subscription_id of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this UpdatePricingComponentValueChangeResult. + + + :param subscription_id: The subscription_id of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :type: str + """ + + self._subscription_id = subscription_id + + @property + def amount(self): + """Gets the amount of this UpdatePricingComponentValueChangeResult. # noqa: E501 + + + :return: The amount of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :rtype: float + """ + return self._amount + + @amount.setter + def amount(self, amount): + """Sets the amount of this UpdatePricingComponentValueChangeResult. + + + :param amount: The amount of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :type: float + """ + + self._amount = amount + + @property + def charge_type(self): + """Gets the charge_type of this UpdatePricingComponentValueChangeResult. # noqa: E501 + + + :return: The charge_type of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :rtype: str + """ + return self._charge_type + + @charge_type.setter + def charge_type(self, charge_type): + """Sets the charge_type of this UpdatePricingComponentValueChangeResult. + + + :param charge_type: The charge_type of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :type: str + """ + allowed_values = ["Credit", "Debit"] # noqa: E501 + if charge_type not in allowed_values: + raise ValueError( + "Invalid value for `charge_type` ({0}), must be one of {1}" # noqa: E501 + .format(charge_type, allowed_values) + ) + + self._charge_type = charge_type + + @property + def charge(self): + """Gets the charge of this UpdatePricingComponentValueChangeResult. # noqa: E501 + + + :return: The charge of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :rtype: SubscriptionCharge + """ + return self._charge + + @charge.setter + def charge(self, charge): + """Sets the charge of this UpdatePricingComponentValueChangeResult. + + + :param charge: The charge of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :type: SubscriptionCharge + """ + + self._charge = charge + + @property + def amendment(self): + """Gets the amendment of this UpdatePricingComponentValueChangeResult. # noqa: E501 + + + :return: The amendment of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :rtype: Amendment + """ + return self._amendment + + @amendment.setter + def amendment(self, amendment): + """Sets the amendment of this UpdatePricingComponentValueChangeResult. + + + :param amendment: The amendment of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :type: Amendment + """ + + self._amendment = amendment + + @property + def state(self): + """Gets the state of this UpdatePricingComponentValueChangeResult. # noqa: E501 + + + :return: The state of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :rtype: str + """ + return self._state + + @state.setter + def state(self, state): + """Sets the state of this UpdatePricingComponentValueChangeResult. + + + :param state: The state of this UpdatePricingComponentValueChangeResult. # noqa: E501 + :type: str + """ + allowed_values = ["Failed", "Succeeded", "Pending"] # noqa: E501 + if state not in allowed_values: + raise ValueError( + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 + .format(state, allowed_values) + ) + + self._state = state + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UpdatePricingComponentValueChangeResult, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdatePricingComponentValueChangeResult): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/update_pricing_component_value_request.py b/billforward/models/update_pricing_component_value_request.py new file mode 100644 index 0000000..79a3d64 --- /dev/null +++ b/billforward/models/update_pricing_component_value_request.py @@ -0,0 +1,196 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UpdatePricingComponentValueRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'pricing_component': 'str', + 'value': 'int', + 'change_mode': 'str', + 'prorate': 'bool' + } + + attribute_map = { + 'pricing_component': 'pricingComponent', + 'value': 'value', + 'change_mode': 'changeMode', + 'prorate': 'prorate' + } + + def __init__(self, pricing_component=None, value=None, change_mode=None, prorate=None): # noqa: E501 + """UpdatePricingComponentValueRequest - a model defined in Swagger""" # noqa: E501 + self._pricing_component = None + self._value = None + self._change_mode = None + self._prorate = None + self.discriminator = None + self.pricing_component = pricing_component + self.value = value + if change_mode is not None: + self.change_mode = change_mode + if prorate is not None: + self.prorate = prorate + + @property + def pricing_component(self): + """Gets the pricing_component of this UpdatePricingComponentValueRequest. # noqa: E501 + + + :return: The pricing_component of this UpdatePricingComponentValueRequest. # noqa: E501 + :rtype: str + """ + return self._pricing_component + + @pricing_component.setter + def pricing_component(self, pricing_component): + """Sets the pricing_component of this UpdatePricingComponentValueRequest. + + + :param pricing_component: The pricing_component of this UpdatePricingComponentValueRequest. # noqa: E501 + :type: str + """ + if pricing_component is None: + raise ValueError("Invalid value for `pricing_component`, must not be `None`") # noqa: E501 + + self._pricing_component = pricing_component + + @property + def value(self): + """Gets the value of this UpdatePricingComponentValueRequest. # noqa: E501 + + + :return: The value of this UpdatePricingComponentValueRequest. # noqa: E501 + :rtype: int + """ + return self._value + + @value.setter + def value(self, value): + """Sets the value of this UpdatePricingComponentValueRequest. + + + :param value: The value of this UpdatePricingComponentValueRequest. # noqa: E501 + :type: int + """ + if value is None: + raise ValueError("Invalid value for `value`, must not be `None`") # noqa: E501 + + self._value = value + + @property + def change_mode(self): + """Gets the change_mode of this UpdatePricingComponentValueRequest. # noqa: E501 + + + :return: The change_mode of this UpdatePricingComponentValueRequest. # noqa: E501 + :rtype: str + """ + return self._change_mode + + @change_mode.setter + def change_mode(self, change_mode): + """Sets the change_mode of this UpdatePricingComponentValueRequest. + + + :param change_mode: The change_mode of this UpdatePricingComponentValueRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Default", "Immediate", "AtPeriodEnd"] # noqa: E501 + if change_mode not in allowed_values: + raise ValueError( + "Invalid value for `change_mode` ({0}), must be one of {1}" # noqa: E501 + .format(change_mode, allowed_values) + ) + + self._change_mode = change_mode + + @property + def prorate(self): + """Gets the prorate of this UpdatePricingComponentValueRequest. # noqa: E501 + + + :return: The prorate of this UpdatePricingComponentValueRequest. # noqa: E501 + :rtype: bool + """ + return self._prorate + + @prorate.setter + def prorate(self, prorate): + """Sets the prorate of this UpdatePricingComponentValueRequest. + + + :param prorate: The prorate of this UpdatePricingComponentValueRequest. # noqa: E501 + :type: bool + """ + + self._prorate = prorate + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UpdatePricingComponentValueRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdatePricingComponentValueRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/update_pricing_component_value_response.py b/billforward/models/update_pricing_component_value_response.py new file mode 100644 index 0000000..e4c9511 --- /dev/null +++ b/billforward/models/update_pricing_component_value_response.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UpdatePricingComponentValueResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'changes': 'list[UpdatePricingComponentValueChangeResult]', + 'invoice': 'Invoice' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'changes': 'changes', + 'invoice': 'invoice' + } + + def __init__(self, created=None, organization_id=None, changes=None, invoice=None): # noqa: E501 + """UpdatePricingComponentValueResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._changes = None + self._invoice = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if changes is not None: + self.changes = changes + if invoice is not None: + self.invoice = invoice + + @property + def created(self): + """Gets the created of this UpdatePricingComponentValueResponse. # noqa: E501 + + + :return: The created of this UpdatePricingComponentValueResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this UpdatePricingComponentValueResponse. + + + :param created: The created of this UpdatePricingComponentValueResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this UpdatePricingComponentValueResponse. # noqa: E501 + + + :return: The organization_id of this UpdatePricingComponentValueResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UpdatePricingComponentValueResponse. + + + :param organization_id: The organization_id of this UpdatePricingComponentValueResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def changes(self): + """Gets the changes of this UpdatePricingComponentValueResponse. # noqa: E501 + + + :return: The changes of this UpdatePricingComponentValueResponse. # noqa: E501 + :rtype: list[UpdatePricingComponentValueChangeResult] + """ + return self._changes + + @changes.setter + def changes(self, changes): + """Sets the changes of this UpdatePricingComponentValueResponse. + + + :param changes: The changes of this UpdatePricingComponentValueResponse. # noqa: E501 + :type: list[UpdatePricingComponentValueChangeResult] + """ + + self._changes = changes + + @property + def invoice(self): + """Gets the invoice of this UpdatePricingComponentValueResponse. # noqa: E501 + + + :return: The invoice of this UpdatePricingComponentValueResponse. # noqa: E501 + :rtype: Invoice + """ + return self._invoice + + @invoice.setter + def invoice(self, invoice): + """Sets the invoice of this UpdatePricingComponentValueResponse. + + + :param invoice: The invoice of this UpdatePricingComponentValueResponse. # noqa: E501 + :type: Invoice + """ + + self._invoice = invoice + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UpdatePricingComponentValueResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdatePricingComponentValueResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/update_profile_request.py b/billforward/models/update_profile_request.py deleted file mode 100644 index 8e5bbb4..0000000 --- a/billforward/models/update_profile_request.py +++ /dev/null @@ -1,488 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class UpdateProfileRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, id=None, account_id=None, organization_id=None, email=None, first_name=None, last_name=None, company_name=None, logo_url=None, addresses=None, mobile=None, landline=None, fax=None, dob=None, vat_number=None, additional_information=None): - """ - UpdateProfileRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'id': 'str', - 'account_id': 'str', - 'organization_id': 'str', - 'email': 'str', - 'first_name': 'str', - 'last_name': 'str', - 'company_name': 'str', - 'logo_url': 'str', - 'addresses': 'list[Address]', - 'mobile': 'str', - 'landline': 'str', - 'fax': 'str', - 'dob': 'datetime', - 'vat_number': 'str', - 'additional_information': 'str' - } - - self.attribute_map = { - 'id': 'id', - 'account_id': 'accountID', - 'organization_id': 'organizationID', - 'email': 'email', - 'first_name': 'firstName', - 'last_name': 'lastName', - 'company_name': 'companyName', - 'logo_url': 'logoURL', - 'addresses': 'addresses', - 'mobile': 'mobile', - 'landline': 'landline', - 'fax': 'fax', - 'dob': 'dob', - 'vat_number': 'vatNumber', - 'additional_information': 'additionalInformation' - } - - self._id = id - self._account_id = account_id - self._organization_id = organization_id - self._email = email - self._first_name = first_name - self._last_name = last_name - self._company_name = company_name - self._logo_url = logo_url - self._addresses = addresses - self._mobile = mobile - self._landline = landline - self._fax = fax - self._dob = dob - self._vat_number = vat_number - self._additional_information = additional_information - - @property - def id(self): - """ - Gets the id of this UpdateProfileRequest. - - - :return: The id of this UpdateProfileRequest. - :rtype: str - """ - return self._id - - @id.setter - def id(self, id): - """ - Sets the id of this UpdateProfileRequest. - - - :param id: The id of this UpdateProfileRequest. - :type: str - """ - - self._id = id - - @property - def account_id(self): - """ - Gets the account_id of this UpdateProfileRequest. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :return: The account_id of this UpdateProfileRequest. - :rtype: str - """ - return self._account_id - - @account_id.setter - def account_id(self, account_id): - """ - Sets the account_id of this UpdateProfileRequest. - { \"description\" : \"\", \"verbs\":[\"GET\"] } - - :param account_id: The account_id of this UpdateProfileRequest. - :type: str - """ - - self._account_id = account_id - - @property - def organization_id(self): - """ - Gets the organization_id of this UpdateProfileRequest. - { \"description\" : \"\", \"verbs\":[] } - - :return: The organization_id of this UpdateProfileRequest. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this UpdateProfileRequest. - { \"description\" : \"\", \"verbs\":[] } - - :param organization_id: The organization_id of this UpdateProfileRequest. - :type: str - """ - - self._organization_id = organization_id - - @property - def email(self): - """ - Gets the email of this UpdateProfileRequest. - { \"description\" : \"E-mail address\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The email of this UpdateProfileRequest. - :rtype: str - """ - return self._email - - @email.setter - def email(self, email): - """ - Sets the email of this UpdateProfileRequest. - { \"description\" : \"E-mail address\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param email: The email of this UpdateProfileRequest. - :type: str - """ - - self._email = email - - @property - def first_name(self): - """ - Gets the first_name of this UpdateProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The first_name of this UpdateProfileRequest. - :rtype: str - """ - return self._first_name - - @first_name.setter - def first_name(self, first_name): - """ - Sets the first_name of this UpdateProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param first_name: The first_name of this UpdateProfileRequest. - :type: str - """ - - self._first_name = first_name - - @property - def last_name(self): - """ - Gets the last_name of this UpdateProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The last_name of this UpdateProfileRequest. - :rtype: str - """ - return self._last_name - - @last_name.setter - def last_name(self, last_name): - """ - Sets the last_name of this UpdateProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param last_name: The last_name of this UpdateProfileRequest. - :type: str - """ - - self._last_name = last_name - - @property - def company_name(self): - """ - Gets the company_name of this UpdateProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The company_name of this UpdateProfileRequest. - :rtype: str - """ - return self._company_name - - @company_name.setter - def company_name(self, company_name): - """ - Sets the company_name of this UpdateProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param company_name: The company_name of this UpdateProfileRequest. - :type: str - """ - - self._company_name = company_name - - @property - def logo_url(self): - """ - Gets the logo_url of this UpdateProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The logo_url of this UpdateProfileRequest. - :rtype: str - """ - return self._logo_url - - @logo_url.setter - def logo_url(self, logo_url): - """ - Sets the logo_url of this UpdateProfileRequest. - { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param logo_url: The logo_url of this UpdateProfileRequest. - :type: str - """ - - self._logo_url = logo_url - - @property - def addresses(self): - """ - Gets the addresses of this UpdateProfileRequest. - { \"description\" : \"Address associated with the profile\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The addresses of this UpdateProfileRequest. - :rtype: list[Address] - """ - return self._addresses - - @addresses.setter - def addresses(self, addresses): - """ - Sets the addresses of this UpdateProfileRequest. - { \"description\" : \"Address associated with the profile\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param addresses: The addresses of this UpdateProfileRequest. - :type: list[Address] - """ - - self._addresses = addresses - - @property - def mobile(self): - """ - Gets the mobile of this UpdateProfileRequest. - { \"description\" : \"Mobile telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The mobile of this UpdateProfileRequest. - :rtype: str - """ - return self._mobile - - @mobile.setter - def mobile(self, mobile): - """ - Sets the mobile of this UpdateProfileRequest. - { \"description\" : \"Mobile telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param mobile: The mobile of this UpdateProfileRequest. - :type: str - """ - - self._mobile = mobile - - @property - def landline(self): - """ - Gets the landline of this UpdateProfileRequest. - { \"description\" : \"Home telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The landline of this UpdateProfileRequest. - :rtype: str - """ - return self._landline - - @landline.setter - def landline(self, landline): - """ - Sets the landline of this UpdateProfileRequest. - { \"description\" : \"Home telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param landline: The landline of this UpdateProfileRequest. - :type: str - """ - - self._landline = landline - - @property - def fax(self): - """ - Gets the fax of this UpdateProfileRequest. - { \"description\" : \"Fax number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The fax of this UpdateProfileRequest. - :rtype: str - """ - return self._fax - - @fax.setter - def fax(self, fax): - """ - Sets the fax of this UpdateProfileRequest. - { \"description\" : \"Fax number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param fax: The fax of this UpdateProfileRequest. - :type: str - """ - - self._fax = fax - - @property - def dob(self): - """ - Gets the dob of this UpdateProfileRequest. - { \"description\" : \"Date of birth in YYYY-MM-DD format\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The dob of this UpdateProfileRequest. - :rtype: datetime - """ - return self._dob - - @dob.setter - def dob(self, dob): - """ - Sets the dob of this UpdateProfileRequest. - { \"description\" : \"Date of birth in YYYY-MM-DD format\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param dob: The dob of this UpdateProfileRequest. - :type: datetime - """ - - self._dob = dob - - @property - def vat_number(self): - """ - Gets the vat_number of this UpdateProfileRequest. - { \"description\" : \"VAT number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The vat_number of this UpdateProfileRequest. - :rtype: str - """ - return self._vat_number - - @vat_number.setter - def vat_number(self, vat_number): - """ - Sets the vat_number of this UpdateProfileRequest. - { \"description\" : \"VAT number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param vat_number: The vat_number of this UpdateProfileRequest. - :type: str - """ - - self._vat_number = vat_number - - @property - def additional_information(self): - """ - Gets the additional_information of this UpdateProfileRequest. - { \"description\" : \"Any additional information\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The additional_information of this UpdateProfileRequest. - :rtype: str - """ - return self._additional_information - - @additional_information.setter - def additional_information(self, additional_information): - """ - Sets the additional_information of this UpdateProfileRequest. - { \"description\" : \"Any additional information\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param additional_information: The additional_information of this UpdateProfileRequest. - :type: str - """ - - self._additional_information = additional_information - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/update_rate_plan_affiliate_request.py b/billforward/models/update_rate_plan_affiliate_request.py new file mode 100644 index 0000000..4ee262a --- /dev/null +++ b/billforward/models/update_rate_plan_affiliate_request.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UpdateRatePlanAffiliateRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'id': 'str', + 'start_date': 'datetime', + 'end_date': 'datetime' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'id': 'id', + 'start_date': 'startDate', + 'end_date': 'endDate' + } + + def __init__(self, organization_id=None, id=None, start_date=None, end_date=None): # noqa: E501 + """UpdateRatePlanAffiliateRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._id = None + self._start_date = None + self._end_date = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if id is not None: + self.id = id + if start_date is not None: + self.start_date = start_date + if end_date is not None: + self.end_date = end_date + + @property + def organization_id(self): + """Gets the organization_id of this UpdateRatePlanAffiliateRequest. # noqa: E501 + + + :return: The organization_id of this UpdateRatePlanAffiliateRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UpdateRatePlanAffiliateRequest. + + + :param organization_id: The organization_id of this UpdateRatePlanAffiliateRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def id(self): + """Gets the id of this UpdateRatePlanAffiliateRequest. # noqa: E501 + + + :return: The id of this UpdateRatePlanAffiliateRequest. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this UpdateRatePlanAffiliateRequest. + + + :param id: The id of this UpdateRatePlanAffiliateRequest. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def start_date(self): + """Gets the start_date of this UpdateRatePlanAffiliateRequest. # noqa: E501 + + + :return: The start_date of this UpdateRatePlanAffiliateRequest. # noqa: E501 + :rtype: datetime + """ + return self._start_date + + @start_date.setter + def start_date(self, start_date): + """Sets the start_date of this UpdateRatePlanAffiliateRequest. + + + :param start_date: The start_date of this UpdateRatePlanAffiliateRequest. # noqa: E501 + :type: datetime + """ + + self._start_date = start_date + + @property + def end_date(self): + """Gets the end_date of this UpdateRatePlanAffiliateRequest. # noqa: E501 + + + :return: The end_date of this UpdateRatePlanAffiliateRequest. # noqa: E501 + :rtype: datetime + """ + return self._end_date + + @end_date.setter + def end_date(self, end_date): + """Sets the end_date of this UpdateRatePlanAffiliateRequest. + + + :param end_date: The end_date of this UpdateRatePlanAffiliateRequest. # noqa: E501 + :type: datetime + """ + + self._end_date = end_date + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UpdateRatePlanAffiliateRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdateRatePlanAffiliateRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/update_role_request.py b/billforward/models/update_role_request.py index b1b1ab6..1edb028 100644 --- a/billforward/models/update_role_request.py +++ b/billforward/models/update_role_request.py @@ -1,88 +1,88 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class UpdateRoleRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, organization_id=None, id=None, name=None, description=None, default_role=False): - """ - UpdateRoleRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'organization_id': 'str', - 'id': 'str', - 'name': 'str', - 'description': 'str', - 'default_role': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'organization_id': 'organizationID', - 'id': 'id', - 'name': 'name', - 'description': 'description', - 'default_role': 'defaultRole' - } - - self._created = created - self._organization_id = organization_id - self._id = id - self._name = name - self._description = description - self._default_role = default_role + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'id': 'str', + 'name': 'str', + 'description': 'str', + 'default_role': 'bool' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'id': 'id', + 'name': 'name', + 'description': 'description', + 'default_role': 'defaultRole' + } + + def __init__(self, created=None, organization_id=None, id=None, name=None, description=None, default_role=None): # noqa: E501 + """UpdateRoleRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._id = None + self._name = None + self._description = None + self._default_role = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if id is not None: + self.id = id + if name is not None: + self.name = name + if description is not None: + self.description = description + if default_role is not None: + self.default_role = default_role @property def created(self): - """ - Gets the created of this UpdateRoleRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this UpdateRoleRequest. # noqa: E501 + - :return: The created of this UpdateRoleRequest. + :return: The created of this UpdateRoleRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this UpdateRoleRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this UpdateRoleRequest. - :param created: The created of this UpdateRoleRequest. + + :param created: The created of this UpdateRoleRequest. # noqa: E501 :type: datetime """ @@ -90,22 +90,20 @@ def created(self, created): @property def organization_id(self): - """ - Gets the organization_id of this UpdateRoleRequest. - { \"description\" : \"\", \"verbs\":[\"\"] } + """Gets the organization_id of this UpdateRoleRequest. # noqa: E501 + - :return: The organization_id of this UpdateRoleRequest. + :return: The organization_id of this UpdateRoleRequest. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this UpdateRoleRequest. - { \"description\" : \"\", \"verbs\":[\"\"] } + """Sets the organization_id of this UpdateRoleRequest. + - :param organization_id: The organization_id of this UpdateRoleRequest. + :param organization_id: The organization_id of this UpdateRoleRequest. # noqa: E501 :type: str """ @@ -113,22 +111,20 @@ def organization_id(self, organization_id): @property def id(self): - """ - Gets the id of this UpdateRoleRequest. - { \"description\" : \"\", \"verbs\":[\"GET\", \"PUT\"] } + """Gets the id of this UpdateRoleRequest. # noqa: E501 - :return: The id of this UpdateRoleRequest. + + :return: The id of this UpdateRoleRequest. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this UpdateRoleRequest. - { \"description\" : \"\", \"verbs\":[\"GET\", \"PUT\"] } + """Sets the id of this UpdateRoleRequest. - :param id: The id of this UpdateRoleRequest. + + :param id: The id of this UpdateRoleRequest. # noqa: E501 :type: str """ @@ -136,22 +132,20 @@ def id(self, id): @property def name(self): - """ - Gets the name of this UpdateRoleRequest. - { \"description\" : \"Friendly name of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the name of this UpdateRoleRequest. # noqa: E501 - :return: The name of this UpdateRoleRequest. + + :return: The name of this UpdateRoleRequest. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this UpdateRoleRequest. - { \"description\" : \"Friendly name of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the name of this UpdateRoleRequest. + - :param name: The name of this UpdateRoleRequest. + :param name: The name of this UpdateRoleRequest. # noqa: E501 :type: str """ @@ -159,22 +153,20 @@ def name(self, name): @property def description(self): - """ - Gets the description of this UpdateRoleRequest. - { \"description\" : \"Friendly description of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the description of this UpdateRoleRequest. # noqa: E501 + - :return: The description of this UpdateRoleRequest. + :return: The description of this UpdateRoleRequest. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this UpdateRoleRequest. - { \"description\" : \"Friendly description of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the description of this UpdateRoleRequest. - :param description: The description of this UpdateRoleRequest. + + :param description: The description of this UpdateRoleRequest. # noqa: E501 :type: str """ @@ -182,34 +174,30 @@ def description(self, description): @property def default_role(self): - """ - Gets the default_role of this UpdateRoleRequest. - { \"description\" : \"If set this role will become the default role for the organization unsetting any existing role. Any accounts without an explicitly set role will have this applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Gets the default_role of this UpdateRoleRequest. # noqa: E501 + - :return: The default_role of this UpdateRoleRequest. + :return: The default_role of this UpdateRoleRequest. # noqa: E501 :rtype: bool """ return self._default_role @default_role.setter def default_role(self, default_role): - """ - Sets the default_role of this UpdateRoleRequest. - { \"description\" : \"If set this role will become the default role for the organization unsetting any existing role. Any accounts without an explicitly set role will have this applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } + """Sets the default_role of this UpdateRoleRequest. + - :param default_role: The default_role of this UpdateRoleRequest. + :param default_role: The default_role of this UpdateRoleRequest. # noqa: E501 :type: bool """ self._default_role = default_role def to_dict(self): - """ - Returns the model properties as a dict - """ + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -226,29 +214,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(UpdateRoleRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, UpdateRoleRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/update_salesforce_configuration_request.py b/billforward/models/update_salesforce_configuration_request.py new file mode 100644 index 0000000..859e777 --- /dev/null +++ b/billforward/models/update_salesforce_configuration_request.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UpdateSalesforceConfigurationRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'organization_id': 'str', + 'user_role': 'str', + 'notification_email_addresses': 'str' + } + + attribute_map = { + 'organization_id': 'organizationID', + 'user_role': 'userRole', + 'notification_email_addresses': 'notificationEmailAddresses' + } + + def __init__(self, organization_id=None, user_role=None, notification_email_addresses=None): # noqa: E501 + """UpdateSalesforceConfigurationRequest - a model defined in Swagger""" # noqa: E501 + self._organization_id = None + self._user_role = None + self._notification_email_addresses = None + self.discriminator = None + if organization_id is not None: + self.organization_id = organization_id + if user_role is not None: + self.user_role = user_role + if notification_email_addresses is not None: + self.notification_email_addresses = notification_email_addresses + + @property + def organization_id(self): + """Gets the organization_id of this UpdateSalesforceConfigurationRequest. # noqa: E501 + + + :return: The organization_id of this UpdateSalesforceConfigurationRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UpdateSalesforceConfigurationRequest. + + + :param organization_id: The organization_id of this UpdateSalesforceConfigurationRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def user_role(self): + """Gets the user_role of this UpdateSalesforceConfigurationRequest. # noqa: E501 + + + :return: The user_role of this UpdateSalesforceConfigurationRequest. # noqa: E501 + :rtype: str + """ + return self._user_role + + @user_role.setter + def user_role(self, user_role): + """Sets the user_role of this UpdateSalesforceConfigurationRequest. + + + :param user_role: The user_role of this UpdateSalesforceConfigurationRequest. # noqa: E501 + :type: str + """ + + self._user_role = user_role + + @property + def notification_email_addresses(self): + """Gets the notification_email_addresses of this UpdateSalesforceConfigurationRequest. # noqa: E501 + + + :return: The notification_email_addresses of this UpdateSalesforceConfigurationRequest. # noqa: E501 + :rtype: str + """ + return self._notification_email_addresses + + @notification_email_addresses.setter + def notification_email_addresses(self, notification_email_addresses): + """Sets the notification_email_addresses of this UpdateSalesforceConfigurationRequest. + + + :param notification_email_addresses: The notification_email_addresses of this UpdateSalesforceConfigurationRequest. # noqa: E501 + :type: str + """ + + self._notification_email_addresses = notification_email_addresses + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UpdateSalesforceConfigurationRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdateSalesforceConfigurationRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/update_subscription_request.py b/billforward/models/update_subscription_request.py index f1c584f..d758f0a 100644 --- a/billforward/models/update_subscription_request.py +++ b/billforward/models/update_subscription_request.py @@ -1,120 +1,226 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class UpdateSubscriptionRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, id=None, name=None, description=None, start=None, end=None, state=None, parent_id=None, aggregate_all_subscriptions_on_account=False, failed_payment_behaviour=None): - """ - UpdateSubscriptionRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'id': 'str', - 'name': 'str', - 'description': 'str', - 'start': 'datetime', - 'end': 'datetime', - 'state': 'str', - 'parent_id': 'str', - 'aggregate_all_subscriptions_on_account': 'bool', - 'failed_payment_behaviour': 'str' - } - - self.attribute_map = { - 'id': 'id', - 'name': 'name', - 'description': 'description', - 'start': 'start', - 'end': 'end', - 'state': 'state', - 'parent_id': 'parentID', - 'aggregate_all_subscriptions_on_account': 'aggregateAllSubscriptionsOnAccount', - 'failed_payment_behaviour': 'failedPaymentBehaviour' - } + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'name': 'str', + 'description': 'str', + 'contract_start': 'datetime', + 'start': 'datetime', + 'end': 'datetime', + 'trial_end': 'datetime', + 'type': 'str', + 'state': 'str', + 'parent_id': 'str', + 'exclude_from_auto_aggregation': 'bool', + 'failed_payment_behaviour': 'str', + 'payment_terms': 'int', + 'align_period_with_aggregating_subscription': 'bool', + 'ignore_first_period_usage': 'bool', + 'extras': 'Extras', + 'purchase_order': 'str', + 'subscription_id': 'str', + 'dry_run': 'bool' + } + + attribute_map = { + 'created': 'created', + 'id': 'id', + 'organization_id': 'organizationID', + 'name': 'name', + 'description': 'description', + 'contract_start': 'contractStart', + 'start': 'start', + 'end': 'end', + 'trial_end': 'trialEnd', + 'type': 'type', + 'state': 'state', + 'parent_id': 'parentID', + 'exclude_from_auto_aggregation': 'excludeFromAutoAggregation', + 'failed_payment_behaviour': 'failedPaymentBehaviour', + 'payment_terms': 'paymentTerms', + 'align_period_with_aggregating_subscription': 'alignPeriodWithAggregatingSubscription', + 'ignore_first_period_usage': 'ignoreFirstPeriodUsage', + 'extras': 'extras', + 'purchase_order': 'purchaseOrder', + 'subscription_id': 'subscriptionID', + 'dry_run': 'dryRun' + } + + def __init__(self, created=None, id=None, organization_id=None, name=None, description=None, contract_start=None, start=None, end=None, trial_end=None, type=None, state=None, parent_id=None, exclude_from_auto_aggregation=None, failed_payment_behaviour=None, payment_terms=None, align_period_with_aggregating_subscription=None, ignore_first_period_usage=None, extras=None, purchase_order=None, subscription_id=None, dry_run=None): # noqa: E501 + """UpdateSubscriptionRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._id = None + self._organization_id = None + self._name = None + self._description = None + self._contract_start = None + self._start = None + self._end = None + self._trial_end = None + self._type = None + self._state = None + self._parent_id = None + self._exclude_from_auto_aggregation = None + self._failed_payment_behaviour = None + self._payment_terms = None + self._align_period_with_aggregating_subscription = None + self._ignore_first_period_usage = None + self._extras = None + self._purchase_order = None + self._subscription_id = None + self._dry_run = None + self.discriminator = None + if created is not None: + self.created = created + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if description is not None: + self.description = description + if contract_start is not None: + self.contract_start = contract_start + if start is not None: + self.start = start + if end is not None: + self.end = end + if trial_end is not None: + self.trial_end = trial_end + if type is not None: + self.type = type + if state is not None: + self.state = state + if parent_id is not None: + self.parent_id = parent_id + if exclude_from_auto_aggregation is not None: + self.exclude_from_auto_aggregation = exclude_from_auto_aggregation + if failed_payment_behaviour is not None: + self.failed_payment_behaviour = failed_payment_behaviour + if payment_terms is not None: + self.payment_terms = payment_terms + if align_period_with_aggregating_subscription is not None: + self.align_period_with_aggregating_subscription = align_period_with_aggregating_subscription + if ignore_first_period_usage is not None: + self.ignore_first_period_usage = ignore_first_period_usage + if extras is not None: + self.extras = extras + if purchase_order is not None: + self.purchase_order = purchase_order + if subscription_id is not None: + self.subscription_id = subscription_id + if dry_run is not None: + self.dry_run = dry_run - self._id = id - self._name = name - self._description = description - self._start = start - self._end = end - self._state = state - self._parent_id = parent_id - self._aggregate_all_subscriptions_on_account = aggregate_all_subscriptions_on_account - self._failed_payment_behaviour = failed_payment_behaviour + @property + def created(self): + """Gets the created of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The created of this UpdateSubscriptionRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this UpdateSubscriptionRequest. + + + :param created: The created of this UpdateSubscriptionRequest. # noqa: E501 + :type: datetime + """ + + self._created = created @property def id(self): - """ - Gets the id of this UpdateSubscriptionRequest. - {\"description\":\"ID of the Subscription you wish to update.\",\"verbs\":[\"POST\"]} + """Gets the id of this UpdateSubscriptionRequest. # noqa: E501 + - :return: The id of this UpdateSubscriptionRequest. + :return: The id of this UpdateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this UpdateSubscriptionRequest. - {\"description\":\"ID of the Subscription you wish to update.\",\"verbs\":[\"POST\"]} + """Sets the id of this UpdateSubscriptionRequest. + - :param id: The id of this UpdateSubscriptionRequest. + :param id: The id of this UpdateSubscriptionRequest. # noqa: E501 :type: str """ self._id = id @property - def name(self): + def organization_id(self): + """Gets the organization_id of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The organization_id of this UpdateSubscriptionRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UpdateSubscriptionRequest. + + + :param organization_id: The organization_id of this UpdateSubscriptionRequest. # noqa: E501 + :type: str """ - Gets the name of this UpdateSubscriptionRequest. - {\"description\":\"New name to assign to the updated subscription. This is primarily for your benefit — for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'Customer 1425, guy@mail.com, Premium membership').\",\"verbs\":[\"POST\"]} - :return: The name of this UpdateSubscriptionRequest. + self._organization_id = organization_id + + @property + def name(self): + """Gets the name of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The name of this UpdateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): - """ - Sets the name of this UpdateSubscriptionRequest. - {\"description\":\"New name to assign to the updated subscription. This is primarily for your benefit — for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'Customer 1425, guy@mail.com, Premium membership').\",\"verbs\":[\"POST\"]} + """Sets the name of this UpdateSubscriptionRequest. - :param name: The name of this UpdateSubscriptionRequest. + + :param name: The name of this UpdateSubscriptionRequest. # noqa: E501 :type: str """ @@ -122,45 +228,62 @@ def name(self, name): @property def description(self): - """ - Gets the description of this UpdateSubscriptionRequest. - {\"description\":\"New description to assign to the updated subscription. This is primarily for your benefit — for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Customer obtained through Lazy Wednesdays promotion').\",\"verbs\":[\"POST\"]} + """Gets the description of this UpdateSubscriptionRequest. # noqa: E501 + - :return: The description of this UpdateSubscriptionRequest. + :return: The description of this UpdateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._description @description.setter def description(self, description): - """ - Sets the description of this UpdateSubscriptionRequest. - {\"description\":\"New description to assign to the updated subscription. This is primarily for your benefit — for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Customer obtained through Lazy Wednesdays promotion').\",\"verbs\":[\"POST\"]} + """Sets the description of this UpdateSubscriptionRequest. + - :param description: The description of this UpdateSubscriptionRequest. + :param description: The description of this UpdateSubscriptionRequest. # noqa: E501 :type: str """ self._description = description @property - def start(self): + def contract_start(self): + """Gets the contract_start of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The contract_start of this UpdateSubscriptionRequest. # noqa: E501 + :rtype: datetime """ - Gets the start of this UpdateSubscriptionRequest. - {\"description\":\"[Can only be changed if subscription is still in Provisioned state] ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.\",\"verbs\":[\"POST\"]} + return self._contract_start + + @contract_start.setter + def contract_start(self, contract_start): + """Sets the contract_start of this UpdateSubscriptionRequest. + + + :param contract_start: The contract_start of this UpdateSubscriptionRequest. # noqa: E501 + :type: datetime + """ + + self._contract_start = contract_start + + @property + def start(self): + """Gets the start of this UpdateSubscriptionRequest. # noqa: E501 + - :return: The start of this UpdateSubscriptionRequest. + :return: The start of this UpdateSubscriptionRequest. # noqa: E501 :rtype: datetime """ return self._start @start.setter def start(self, start): - """ - Sets the start of this UpdateSubscriptionRequest. - {\"description\":\"[Can only be changed if subscription is still in Provisioned state] ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.\",\"verbs\":[\"POST\"]} + """Sets the start of this UpdateSubscriptionRequest. + - :param start: The start of this UpdateSubscriptionRequest. + :param start: The start of this UpdateSubscriptionRequest. # noqa: E501 :type: datetime """ @@ -168,51 +291,95 @@ def start(self, start): @property def end(self): - """ - Gets the end of this UpdateSubscriptionRequest. - {\"description\":\"[Can only be changed if subscription is still in Provisioned state] ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should finish its first service period.\",\"verbs\":[\"POST\"]} + """Gets the end of this UpdateSubscriptionRequest. # noqa: E501 - :return: The end of this UpdateSubscriptionRequest. + + :return: The end of this UpdateSubscriptionRequest. # noqa: E501 :rtype: datetime """ return self._end @end.setter def end(self, end): - """ - Sets the end of this UpdateSubscriptionRequest. - {\"description\":\"[Can only be changed if subscription is still in Provisioned state] ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should finish its first service period.\",\"verbs\":[\"POST\"]} + """Sets the end of this UpdateSubscriptionRequest. + - :param end: The end of this UpdateSubscriptionRequest. + :param end: The end of this UpdateSubscriptionRequest. # noqa: E501 :type: datetime """ self._end = end @property - def state(self): + def trial_end(self): + """Gets the trial_end of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The trial_end of this UpdateSubscriptionRequest. # noqa: E501 + :rtype: datetime + """ + return self._trial_end + + @trial_end.setter + def trial_end(self, trial_end): + """Sets the trial_end of this UpdateSubscriptionRequest. + + + :param trial_end: The trial_end of this UpdateSubscriptionRequest. # noqa: E501 + :type: datetime """ - Gets the state of this UpdateSubscriptionRequest. - {\"description\":\"[Can only be changed if subscription is still in Provisioned state] The state into which you wish to move the updated subscription.
AwaitingPayment — The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.\",\"verbs\":[\"POST\"]} - :return: The state of this UpdateSubscriptionRequest. + self._trial_end = trial_end + + @property + def type(self): + """Gets the type of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The type of this UpdateSubscriptionRequest. # noqa: E501 + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """Sets the type of this UpdateSubscriptionRequest. + + + :param type: The type of this UpdateSubscriptionRequest. # noqa: E501 + :type: str + """ + allowed_values = ["Subscription", "Trial", "FixedTerm"] # noqa: E501 + if type not in allowed_values: + raise ValueError( + "Invalid value for `type` ({0}), must be one of {1}" # noqa: E501 + .format(type, allowed_values) + ) + + self._type = type + + @property + def state(self): + """Gets the state of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The state of this UpdateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._state @state.setter def state(self, state): - """ - Sets the state of this UpdateSubscriptionRequest. - {\"description\":\"[Can only be changed if subscription is still in Provisioned state] The state into which you wish to move the updated subscription.
AwaitingPayment — The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.\",\"verbs\":[\"POST\"]} + """Sets the state of this UpdateSubscriptionRequest. + - :param state: The state of this UpdateSubscriptionRequest. + :param state: The state of this UpdateSubscriptionRequest. # noqa: E501 :type: str """ - allowed_values = ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"] + allowed_values = ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"] # noqa: E501 if state not in allowed_values: raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" + "Invalid value for `state` ({0}), must be one of {1}" # noqa: E501 .format(state, allowed_values) ) @@ -220,86 +387,225 @@ def state(self, state): @property def parent_id(self): - """ - Gets the parent_id of this UpdateSubscriptionRequest. - {\"description\":\"ID of a parent subscription which will collect the charges raised by this subscription. The parent becomes responsible for paying those charges.\",\"verbs\":[\"POST\"]} + """Gets the parent_id of this UpdateSubscriptionRequest. # noqa: E501 - :return: The parent_id of this UpdateSubscriptionRequest. + + :return: The parent_id of this UpdateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._parent_id @parent_id.setter def parent_id(self, parent_id): - """ - Sets the parent_id of this UpdateSubscriptionRequest. - {\"description\":\"ID of a parent subscription which will collect the charges raised by this subscription. The parent becomes responsible for paying those charges.\",\"verbs\":[\"POST\"]} + """Sets the parent_id of this UpdateSubscriptionRequest. - :param parent_id: The parent_id of this UpdateSubscriptionRequest. + + :param parent_id: The parent_id of this UpdateSubscriptionRequest. # noqa: E501 :type: str """ self._parent_id = parent_id @property - def aggregate_all_subscriptions_on_account(self): - """ - Gets the aggregate_all_subscriptions_on_account of this UpdateSubscriptionRequest. - {\"description\":\"Whether this subscription should become an 'aggregating subscription', collecting charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.\",\"verbs\":[\"POST\"]} + def exclude_from_auto_aggregation(self): + """Gets the exclude_from_auto_aggregation of this UpdateSubscriptionRequest. # noqa: E501 - :return: The aggregate_all_subscriptions_on_account of this UpdateSubscriptionRequest. + + :return: The exclude_from_auto_aggregation of this UpdateSubscriptionRequest. # noqa: E501 :rtype: bool """ - return self._aggregate_all_subscriptions_on_account + return self._exclude_from_auto_aggregation + + @exclude_from_auto_aggregation.setter + def exclude_from_auto_aggregation(self, exclude_from_auto_aggregation): + """Sets the exclude_from_auto_aggregation of this UpdateSubscriptionRequest. - @aggregate_all_subscriptions_on_account.setter - def aggregate_all_subscriptions_on_account(self, aggregate_all_subscriptions_on_account): - """ - Sets the aggregate_all_subscriptions_on_account of this UpdateSubscriptionRequest. - {\"description\":\"Whether this subscription should become an 'aggregating subscription', collecting charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.\",\"verbs\":[\"POST\"]} - :param aggregate_all_subscriptions_on_account: The aggregate_all_subscriptions_on_account of this UpdateSubscriptionRequest. + :param exclude_from_auto_aggregation: The exclude_from_auto_aggregation of this UpdateSubscriptionRequest. # noqa: E501 :type: bool """ - self._aggregate_all_subscriptions_on_account = aggregate_all_subscriptions_on_account + self._exclude_from_auto_aggregation = exclude_from_auto_aggregation @property def failed_payment_behaviour(self): - """ - Gets the failed_payment_behaviour of this UpdateSubscriptionRequest. - {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.
CancelSubscription — Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.
None — The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles — or when manual invoice remediation is common — None is recommended.
In a heavily-automated SaaS environment, automatic cancellation via CancelSubscription is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the failed_payment_behaviour of this UpdateSubscriptionRequest. # noqa: E501 + - :return: The failed_payment_behaviour of this UpdateSubscriptionRequest. + :return: The failed_payment_behaviour of this UpdateSubscriptionRequest. # noqa: E501 :rtype: str """ return self._failed_payment_behaviour @failed_payment_behaviour.setter def failed_payment_behaviour(self, failed_payment_behaviour): - """ - Sets the failed_payment_behaviour of this UpdateSubscriptionRequest. - {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.
CancelSubscription — Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.
None — The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles — or when manual invoice remediation is common — None is recommended.
In a heavily-automated SaaS environment, automatic cancellation via CancelSubscription is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the failed_payment_behaviour of this UpdateSubscriptionRequest. - :param failed_payment_behaviour: The failed_payment_behaviour of this UpdateSubscriptionRequest. + + :param failed_payment_behaviour: The failed_payment_behaviour of this UpdateSubscriptionRequest. # noqa: E501 :type: str """ - allowed_values = ["CancelSubscription", "None"] + allowed_values = ["CancelSubscription", "None"] # noqa: E501 if failed_payment_behaviour not in allowed_values: raise ValueError( - "Invalid value for `failed_payment_behaviour` ({0}), must be one of {1}" + "Invalid value for `failed_payment_behaviour` ({0}), must be one of {1}" # noqa: E501 .format(failed_payment_behaviour, allowed_values) ) self._failed_payment_behaviour = failed_payment_behaviour - def to_dict(self): + @property + def payment_terms(self): + """Gets the payment_terms of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The payment_terms of this UpdateSubscriptionRequest. # noqa: E501 + :rtype: int + """ + return self._payment_terms + + @payment_terms.setter + def payment_terms(self, payment_terms): + """Sets the payment_terms of this UpdateSubscriptionRequest. + + + :param payment_terms: The payment_terms of this UpdateSubscriptionRequest. # noqa: E501 + :type: int + """ + + self._payment_terms = payment_terms + + @property + def align_period_with_aggregating_subscription(self): + """Gets the align_period_with_aggregating_subscription of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The align_period_with_aggregating_subscription of this UpdateSubscriptionRequest. # noqa: E501 + :rtype: bool + """ + return self._align_period_with_aggregating_subscription + + @align_period_with_aggregating_subscription.setter + def align_period_with_aggregating_subscription(self, align_period_with_aggregating_subscription): + """Sets the align_period_with_aggregating_subscription of this UpdateSubscriptionRequest. + + + :param align_period_with_aggregating_subscription: The align_period_with_aggregating_subscription of this UpdateSubscriptionRequest. # noqa: E501 + :type: bool + """ + + self._align_period_with_aggregating_subscription = align_period_with_aggregating_subscription + + @property + def ignore_first_period_usage(self): + """Gets the ignore_first_period_usage of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The ignore_first_period_usage of this UpdateSubscriptionRequest. # noqa: E501 + :rtype: bool + """ + return self._ignore_first_period_usage + + @ignore_first_period_usage.setter + def ignore_first_period_usage(self, ignore_first_period_usage): + """Sets the ignore_first_period_usage of this UpdateSubscriptionRequest. + + + :param ignore_first_period_usage: The ignore_first_period_usage of this UpdateSubscriptionRequest. # noqa: E501 + :type: bool + """ + + self._ignore_first_period_usage = ignore_first_period_usage + + @property + def extras(self): + """Gets the extras of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The extras of this UpdateSubscriptionRequest. # noqa: E501 + :rtype: Extras + """ + return self._extras + + @extras.setter + def extras(self, extras): + """Sets the extras of this UpdateSubscriptionRequest. + + + :param extras: The extras of this UpdateSubscriptionRequest. # noqa: E501 + :type: Extras + """ + + self._extras = extras + + @property + def purchase_order(self): + """Gets the purchase_order of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The purchase_order of this UpdateSubscriptionRequest. # noqa: E501 + :rtype: str + """ + return self._purchase_order + + @purchase_order.setter + def purchase_order(self, purchase_order): + """Sets the purchase_order of this UpdateSubscriptionRequest. + + + :param purchase_order: The purchase_order of this UpdateSubscriptionRequest. # noqa: E501 + :type: str + """ + + self._purchase_order = purchase_order + + @property + def subscription_id(self): + """Gets the subscription_id of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The subscription_id of this UpdateSubscriptionRequest. # noqa: E501 + :rtype: str + """ + return self._subscription_id + + @subscription_id.setter + def subscription_id(self, subscription_id): + """Sets the subscription_id of this UpdateSubscriptionRequest. + + + :param subscription_id: The subscription_id of this UpdateSubscriptionRequest. # noqa: E501 + :type: str """ - Returns the model properties as a dict + + self._subscription_id = subscription_id + + @property + def dry_run(self): + """Gets the dry_run of this UpdateSubscriptionRequest. # noqa: E501 + + + :return: The dry_run of this UpdateSubscriptionRequest. # noqa: E501 + :rtype: bool + """ + return self._dry_run + + @dry_run.setter + def dry_run(self, dry_run): + """Sets the dry_run of this UpdateSubscriptionRequest. + + + :param dry_run: The dry_run of this UpdateSubscriptionRequest. # noqa: E501 + :type: bool """ + + self._dry_run = dry_run + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -316,29 +622,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(UpdateSubscriptionRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, UpdateSubscriptionRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/update_user_info_request.py b/billforward/models/update_user_info_request.py new file mode 100644 index 0000000..e144ec6 --- /dev/null +++ b/billforward/models/update_user_info_request.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UpdateUserInfoRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'first_name': 'str', + 'last_name': 'str', + 'organization_id': 'str' + } + + attribute_map = { + 'first_name': 'firstName', + 'last_name': 'lastName', + 'organization_id': 'organizationID' + } + + def __init__(self, first_name=None, last_name=None, organization_id=None): # noqa: E501 + """UpdateUserInfoRequest - a model defined in Swagger""" # noqa: E501 + self._first_name = None + self._last_name = None + self._organization_id = None + self.discriminator = None + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if organization_id is not None: + self.organization_id = organization_id + + @property + def first_name(self): + """Gets the first_name of this UpdateUserInfoRequest. # noqa: E501 + + + :return: The first_name of this UpdateUserInfoRequest. # noqa: E501 + :rtype: str + """ + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """Sets the first_name of this UpdateUserInfoRequest. + + + :param first_name: The first_name of this UpdateUserInfoRequest. # noqa: E501 + :type: str + """ + + self._first_name = first_name + + @property + def last_name(self): + """Gets the last_name of this UpdateUserInfoRequest. # noqa: E501 + + + :return: The last_name of this UpdateUserInfoRequest. # noqa: E501 + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """Sets the last_name of this UpdateUserInfoRequest. + + + :param last_name: The last_name of this UpdateUserInfoRequest. # noqa: E501 + :type: str + """ + + self._last_name = last_name + + @property + def organization_id(self): + """Gets the organization_id of this UpdateUserInfoRequest. # noqa: E501 + + + :return: The organization_id of this UpdateUserInfoRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UpdateUserInfoRequest. + + + :param organization_id: The organization_id of this UpdateUserInfoRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UpdateUserInfoRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpdateUserInfoRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/upgrade_charge.py b/billforward/models/upgrade_charge.py new file mode 100644 index 0000000..dfc500b --- /dev/null +++ b/billforward/models/upgrade_charge.py @@ -0,0 +1,194 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.subscription_charge import SubscriptionCharge # noqa: F401,E501 + +class UpgradeCharge(SubscriptionCharge): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'pricing_component_value_change': 'PricingComponentValueChange', + 'pricing_component_name': 'str', + 'public_pricing_component_name': 'str', + 'pricing_component_id': 'str' + } + if hasattr(SubscriptionCharge, "swagger_types"): + swagger_types.update(SubscriptionCharge.swagger_types) + + attribute_map = { + 'pricing_component_value_change': 'pricingComponentValueChange', + 'pricing_component_name': 'pricingComponentName', + 'public_pricing_component_name': 'publicPricingComponentName', + 'pricing_component_id': 'pricingComponentID' + } + if hasattr(SubscriptionCharge, "attribute_map"): + attribute_map.update(SubscriptionCharge.attribute_map) + + def __init__(self, pricing_component_value_change=None, pricing_component_name=None, public_pricing_component_name=None, pricing_component_id=None, *args, **kwargs): # noqa: E501 + """UpgradeCharge - a model defined in Swagger""" # noqa: E501 + self._pricing_component_value_change = None + self._pricing_component_name = None + self._public_pricing_component_name = None + self._pricing_component_id = None + self.discriminator = None + if pricing_component_value_change is not None: + self.pricing_component_value_change = pricing_component_value_change + if pricing_component_name is not None: + self.pricing_component_name = pricing_component_name + if public_pricing_component_name is not None: + self.public_pricing_component_name = public_pricing_component_name + if pricing_component_id is not None: + self.pricing_component_id = pricing_component_id + SubscriptionCharge.__init__(self, *args, **kwargs) + + @property + def pricing_component_value_change(self): + """Gets the pricing_component_value_change of this UpgradeCharge. # noqa: E501 + + + :return: The pricing_component_value_change of this UpgradeCharge. # noqa: E501 + :rtype: PricingComponentValueChange + """ + return self._pricing_component_value_change + + @pricing_component_value_change.setter + def pricing_component_value_change(self, pricing_component_value_change): + """Sets the pricing_component_value_change of this UpgradeCharge. + + + :param pricing_component_value_change: The pricing_component_value_change of this UpgradeCharge. # noqa: E501 + :type: PricingComponentValueChange + """ + + self._pricing_component_value_change = pricing_component_value_change + + @property + def pricing_component_name(self): + """Gets the pricing_component_name of this UpgradeCharge. # noqa: E501 + + + :return: The pricing_component_name of this UpgradeCharge. # noqa: E501 + :rtype: str + """ + return self._pricing_component_name + + @pricing_component_name.setter + def pricing_component_name(self, pricing_component_name): + """Sets the pricing_component_name of this UpgradeCharge. + + + :param pricing_component_name: The pricing_component_name of this UpgradeCharge. # noqa: E501 + :type: str + """ + + self._pricing_component_name = pricing_component_name + + @property + def public_pricing_component_name(self): + """Gets the public_pricing_component_name of this UpgradeCharge. # noqa: E501 + + + :return: The public_pricing_component_name of this UpgradeCharge. # noqa: E501 + :rtype: str + """ + return self._public_pricing_component_name + + @public_pricing_component_name.setter + def public_pricing_component_name(self, public_pricing_component_name): + """Sets the public_pricing_component_name of this UpgradeCharge. + + + :param public_pricing_component_name: The public_pricing_component_name of this UpgradeCharge. # noqa: E501 + :type: str + """ + + self._public_pricing_component_name = public_pricing_component_name + + @property + def pricing_component_id(self): + """Gets the pricing_component_id of this UpgradeCharge. # noqa: E501 + + + :return: The pricing_component_id of this UpgradeCharge. # noqa: E501 + :rtype: str + """ + return self._pricing_component_id + + @pricing_component_id.setter + def pricing_component_id(self, pricing_component_id): + """Sets the pricing_component_id of this UpgradeCharge. + + + :param pricing_component_id: The pricing_component_id of this UpgradeCharge. # noqa: E501 + :type: str + """ + + self._pricing_component_id = pricing_component_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UpgradeCharge, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UpgradeCharge): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/usage.py b/billforward/models/usage.py deleted file mode 100644 index ac10aeb..0000000 --- a/billforward/models/usage.py +++ /dev/null @@ -1,598 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class Usage(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, session_id=None, subscription_id=None, pricing_component_id=None, pricing_component_name=None, uom=None, organization_id=None, usage_period=None, usage_duration=None, usage_type=None, usage_value=None, detailed=False, created_by=None, updated_by=None, start=None, stop=None, updated=None, occurred_on=None, billing_date=None): - """ - Usage - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'session_id': 'str', - 'subscription_id': 'str', - 'pricing_component_id': 'str', - 'pricing_component_name': 'str', - 'uom': 'str', - 'organization_id': 'str', - 'usage_period': 'int', - 'usage_duration': 'int', - 'usage_type': 'str', - 'usage_value': 'int', - 'detailed': 'bool', - 'created_by': 'str', - 'updated_by': 'str', - 'start': 'datetime', - 'stop': 'datetime', - 'updated': 'datetime', - 'occurred_on': 'datetime', - 'billing_date': 'datetime' - } - - self.attribute_map = { - 'created': 'created', - 'session_id': 'sessionID', - 'subscription_id': 'subscriptionID', - 'pricing_component_id': 'pricingComponentID', - 'pricing_component_name': 'pricingComponentName', - 'uom': 'uom', - 'organization_id': 'organizationID', - 'usage_period': 'usagePeriod', - 'usage_duration': 'usageDuration', - 'usage_type': 'usageType', - 'usage_value': 'usageValue', - 'detailed': 'detailed', - 'created_by': 'createdBy', - 'updated_by': 'updatedBy', - 'start': 'start', - 'stop': 'stop', - 'updated': 'updated', - 'occurred_on': 'occurred_on', - 'billing_date': 'billing_date' - } - - self._created = created - self._session_id = session_id - self._subscription_id = subscription_id - self._pricing_component_id = pricing_component_id - self._pricing_component_name = pricing_component_name - self._uom = uom - self._organization_id = organization_id - self._usage_period = usage_period - self._usage_duration = usage_duration - self._usage_type = usage_type - self._usage_value = usage_value - self._detailed = detailed - self._created_by = created_by - self._updated_by = updated_by - self._start = start - self._stop = stop - self._updated = updated - self._occurred_on = occurred_on - self._billing_date = billing_date - - @property - def created(self): - """ - Gets the created of this Usage. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The created of this Usage. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this Usage. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param created: The created of this Usage. - :type: datetime - """ - - self._created = created - - @property - def session_id(self): - """ - Gets the session_id of this Usage. - { \"description\" : \"A (not guaranteed unique) identifier for the session from which this usage was generated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The session_id of this Usage. - :rtype: str - """ - return self._session_id - - @session_id.setter - def session_id(self, session_id): - """ - Sets the session_id of this Usage. - { \"description\" : \"A (not guaranteed unique) identifier for the session from which this usage was generated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param session_id: The session_id of this Usage. - :type: str - """ - - self._session_id = session_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this Usage. - { \"description\" : \"ID of the subscription to which this usage instance pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this Usage. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this Usage. - { \"description\" : \"ID of the subscription to which this usage instance pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this Usage. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def pricing_component_id(self): - """ - Gets the pricing_component_id of this Usage. - { \"description\" : \"The ID of the pricing component this usage is for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The pricing_component_id of this Usage. - :rtype: str - """ - return self._pricing_component_id - - @pricing_component_id.setter - def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this Usage. - { \"description\" : \"The ID of the pricing component this usage is for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param pricing_component_id: The pricing_component_id of this Usage. - :type: str - """ - - self._pricing_component_id = pricing_component_id - - @property - def pricing_component_name(self): - """ - Gets the pricing_component_name of this Usage. - { \"description\" : \"The name of the pricing component this usage is for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The pricing_component_name of this Usage. - :rtype: str - """ - return self._pricing_component_name - - @pricing_component_name.setter - def pricing_component_name(self, pricing_component_name): - """ - Sets the pricing_component_name of this Usage. - { \"description\" : \"The name of the pricing component this usage is for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param pricing_component_name: The pricing_component_name of this Usage. - :type: str - """ - - self._pricing_component_name = pricing_component_name - - @property - def uom(self): - """ - Gets the uom of this Usage. - { \"description\" : \"The unit-of-measure that this usage is for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The uom of this Usage. - :rtype: str - """ - return self._uom - - @uom.setter - def uom(self, uom): - """ - Sets the uom of this Usage. - { \"description\" : \"The unit-of-measure that this usage is for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param uom: The uom of this Usage. - :type: str - """ - - self._uom = uom - - @property - def organization_id(self): - """ - Gets the organization_id of this Usage. - { \"description\" : \"The organization associated with this usage instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this Usage. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this Usage. - { \"description\" : \"The organization associated with this usage instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this Usage. - :type: str - """ - - self._organization_id = organization_id - - @property - def usage_period(self): - """ - Gets the usage_period of this Usage. - { \"description\" : \"The usage period during which this usage occurred.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The usage_period of this Usage. - :rtype: int - """ - return self._usage_period - - @usage_period.setter - def usage_period(self, usage_period): - """ - Sets the usage_period of this Usage. - { \"description\" : \"The usage period during which this usage occurred.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param usage_period: The usage_period of this Usage. - :type: int - """ - - self._usage_period = usage_period - - @property - def usage_duration(self): - """ - Gets the usage_duration of this Usage. - { \"description\" : \"The amount of time over which usage occurred (in milliseconds?). Relevant for 'temporal' usage only.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The usage_duration of this Usage. - :rtype: int - """ - return self._usage_duration - - @usage_duration.setter - def usage_duration(self, usage_duration): - """ - Sets the usage_duration of this Usage. - { \"description\" : \"The amount of time over which usage occurred (in milliseconds?). Relevant for 'temporal' usage only.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param usage_duration: The usage_duration of this Usage. - :type: int - """ - - self._usage_duration = usage_duration - - @property - def usage_type(self): - """ - Gets the usage_type of this Usage. - { \"description\" : \"The type of usage ('Temporal' or 'Itemized').\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The usage_type of this Usage. - :rtype: str - """ - return self._usage_type - - @usage_type.setter - def usage_type(self, usage_type): - """ - Sets the usage_type of this Usage. - { \"description\" : \"The type of usage ('Temporal' or 'Itemized').\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param usage_type: The usage_type of this Usage. - :type: str - """ - allowed_values = ["Temporal", "Itemized"] - if usage_type not in allowed_values: - raise ValueError( - "Invalid value for `usage_type` ({0}), must be one of {1}" - .format(usage_type, allowed_values) - ) - - self._usage_type = usage_type - - @property - def usage_value(self): - """ - Gets the usage_value of this Usage. - { \"description\" : \"The quantity of product consumed by this usage. Relevant for 'itemized' usage only.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The usage_value of this Usage. - :rtype: int - """ - return self._usage_value - - @usage_value.setter - def usage_value(self, usage_value): - """ - Sets the usage_value of this Usage. - { \"description\" : \"The quantity of product consumed by this usage. Relevant for 'itemized' usage only.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param usage_value: The usage_value of this Usage. - :type: int - """ - - self._usage_value = usage_value - - @property - def detailed(self): - """ - Gets the detailed of this Usage. - { \"description\" : \"Is this usage a detailed entry?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The detailed of this Usage. - :rtype: bool - """ - return self._detailed - - @detailed.setter - def detailed(self, detailed): - """ - Sets the detailed of this Usage. - { \"description\" : \"Is this usage a detailed entry?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param detailed: The detailed of this Usage. - :type: bool - """ - - self._detailed = detailed - - @property - def created_by(self): - """ - Gets the created_by of this Usage. - { \"description\" : \"Some identifying information about who created this object.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The created_by of this Usage. - :rtype: str - """ - return self._created_by - - @created_by.setter - def created_by(self, created_by): - """ - Sets the created_by of this Usage. - { \"description\" : \"Some identifying information about who created this object.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param created_by: The created_by of this Usage. - :type: str - """ - - self._created_by = created_by - - @property - def updated_by(self): - """ - Gets the updated_by of this Usage. - { \"description\" : \"Some identifying information about who updated this object.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The updated_by of this Usage. - :rtype: str - """ - return self._updated_by - - @updated_by.setter - def updated_by(self, updated_by): - """ - Sets the updated_by of this Usage. - { \"description\" : \"Some identifying information about who updated this object.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param updated_by: The updated_by of this Usage. - :type: str - """ - - self._updated_by = updated_by - - @property - def start(self): - """ - Gets the start of this Usage. - { \"description\" : \"The start date of this usage instance, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The start of this Usage. - :rtype: datetime - """ - return self._start - - @start.setter - def start(self, start): - """ - Sets the start of this Usage. - { \"description\" : \"The start date of this usage instance, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param start: The start of this Usage. - :type: datetime - """ - - self._start = start - - @property - def stop(self): - """ - Gets the stop of this Usage. - { \"description\" : \"The end date of this usage instance, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The stop of this Usage. - :rtype: datetime - """ - return self._stop - - @stop.setter - def stop(self, stop): - """ - Sets the stop of this Usage. - { \"description\" : \"The end date of this usage instance, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param stop: The stop of this Usage. - :type: datetime - """ - - self._stop = stop - - @property - def updated(self): - """ - Gets the updated of this Usage. - { \"description\" : \"The UTC DateTime when the object was updated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The updated of this Usage. - :rtype: datetime - """ - return self._updated - - @updated.setter - def updated(self, updated): - """ - Sets the updated of this Usage. - { \"description\" : \"The UTC DateTime when the object was updated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param updated: The updated of this Usage. - :type: datetime - """ - - self._updated = updated - - @property - def occurred_on(self): - """ - Gets the occurred_on of this Usage. - { \"description\" : \"The UTC DateTime when the usage occurred.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The occurred_on of this Usage. - :rtype: datetime - """ - return self._occurred_on - - @occurred_on.setter - def occurred_on(self, occurred_on): - """ - Sets the occurred_on of this Usage. - { \"description\" : \"The UTC DateTime when the usage occurred.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param occurred_on: The occurred_on of this Usage. - :type: datetime - """ - - self._occurred_on = occurred_on - - @property - def billing_date(self): - """ - Gets the billing_date of this Usage. - { \"description\" : \"The UTC DateTime when the usage is to be billed.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The billing_date of this Usage. - :rtype: datetime - """ - return self._billing_date - - @billing_date.setter - def billing_date(self, billing_date): - """ - Sets the billing_date of this Usage. - { \"description\" : \"The UTC DateTime when the usage is to be billed.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param billing_date: The billing_date of this Usage. - :type: datetime - """ - - self._billing_date = billing_date - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/usage_paged_metadata.py b/billforward/models/usage_paged_metadata.py deleted file mode 100644 index 9a5af9b..0000000 --- a/billforward/models/usage_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class UsagePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - UsagePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Usage]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this UsagePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this UsagePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this UsagePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this UsagePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this UsagePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this UsagePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this UsagePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this UsagePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this UsagePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this UsagePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this UsagePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this UsagePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this UsagePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this UsagePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this UsagePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this UsagePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this UsagePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this UsagePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this UsagePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this UsagePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this UsagePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this UsagePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this UsagePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this UsagePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this UsagePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this UsagePagedMetadata. - :rtype: list[Usage] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this UsagePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this UsagePagedMetadata. - :type: list[Usage] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/usage_period_paged_metadata.py b/billforward/models/usage_period_paged_metadata.py deleted file mode 100644 index 1108128..0000000 --- a/billforward/models/usage_period_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class UsagePeriodPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - UsagePeriodPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[BillingEntityBase]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this UsagePeriodPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this UsagePeriodPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this UsagePeriodPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this UsagePeriodPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this UsagePeriodPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this UsagePeriodPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this UsagePeriodPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this UsagePeriodPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this UsagePeriodPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this UsagePeriodPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this UsagePeriodPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this UsagePeriodPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this UsagePeriodPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this UsagePeriodPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this UsagePeriodPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this UsagePeriodPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this UsagePeriodPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this UsagePeriodPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this UsagePeriodPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this UsagePeriodPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this UsagePeriodPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this UsagePeriodPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this UsagePeriodPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this UsagePeriodPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this UsagePeriodPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this UsagePeriodPagedMetadata. - :rtype: list[BillingEntityBase] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this UsagePeriodPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this UsagePeriodPagedMetadata. - :type: list[BillingEntityBase] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/usage_pricing_components_by_charge_model.py b/billforward/models/usage_pricing_components_by_charge_model.py new file mode 100644 index 0000000..c5d9589 --- /dev/null +++ b/billforward/models/usage_pricing_components_by_charge_model.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UsagePricingComponentsByChargeModel(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'flat': 'list[FlatUsagePricingComponent]', + 'tiered': 'list[TieredUsagePricingComponent]', + 'volume': 'list[TieredUsagePricingComponent]' + } + + attribute_map = { + 'flat': 'flat', + 'tiered': 'tiered', + 'volume': 'volume' + } + + def __init__(self, flat=None, tiered=None, volume=None): # noqa: E501 + """UsagePricingComponentsByChargeModel - a model defined in Swagger""" # noqa: E501 + self._flat = None + self._tiered = None + self._volume = None + self.discriminator = None + if flat is not None: + self.flat = flat + if tiered is not None: + self.tiered = tiered + if volume is not None: + self.volume = volume + + @property + def flat(self): + """Gets the flat of this UsagePricingComponentsByChargeModel. # noqa: E501 + + + :return: The flat of this UsagePricingComponentsByChargeModel. # noqa: E501 + :rtype: list[FlatUsagePricingComponent] + """ + return self._flat + + @flat.setter + def flat(self, flat): + """Sets the flat of this UsagePricingComponentsByChargeModel. + + + :param flat: The flat of this UsagePricingComponentsByChargeModel. # noqa: E501 + :type: list[FlatUsagePricingComponent] + """ + + self._flat = flat + + @property + def tiered(self): + """Gets the tiered of this UsagePricingComponentsByChargeModel. # noqa: E501 + + + :return: The tiered of this UsagePricingComponentsByChargeModel. # noqa: E501 + :rtype: list[TieredUsagePricingComponent] + """ + return self._tiered + + @tiered.setter + def tiered(self, tiered): + """Sets the tiered of this UsagePricingComponentsByChargeModel. + + + :param tiered: The tiered of this UsagePricingComponentsByChargeModel. # noqa: E501 + :type: list[TieredUsagePricingComponent] + """ + + self._tiered = tiered + + @property + def volume(self): + """Gets the volume of this UsagePricingComponentsByChargeModel. # noqa: E501 + + + :return: The volume of this UsagePricingComponentsByChargeModel. # noqa: E501 + :rtype: list[TieredUsagePricingComponent] + """ + return self._volume + + @volume.setter + def volume(self, volume): + """Sets the volume of this UsagePricingComponentsByChargeModel. + + + :param volume: The volume of this UsagePricingComponentsByChargeModel. # noqa: E501 + :type: list[TieredUsagePricingComponent] + """ + + self._volume = volume + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UsagePricingComponentsByChargeModel, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UsagePricingComponentsByChargeModel): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/usage_rounding_strategy_paged_metadata.py b/billforward/models/usage_rounding_strategy_paged_metadata.py deleted file mode 100644 index d7b1efe..0000000 --- a/billforward/models/usage_rounding_strategy_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class UsageRoundingStrategyPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - UsageRoundingStrategyPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this UsageRoundingStrategyPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this UsageRoundingStrategyPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this UsageRoundingStrategyPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this UsageRoundingStrategyPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this UsageRoundingStrategyPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this UsageRoundingStrategyPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this UsageRoundingStrategyPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this UsageRoundingStrategyPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this UsageRoundingStrategyPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this UsageRoundingStrategyPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this UsageRoundingStrategyPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this UsageRoundingStrategyPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this UsageRoundingStrategyPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this UsageRoundingStrategyPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this UsageRoundingStrategyPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this UsageRoundingStrategyPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this UsageRoundingStrategyPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this UsageRoundingStrategyPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this UsageRoundingStrategyPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this UsageRoundingStrategyPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this UsageRoundingStrategyPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this UsageRoundingStrategyPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this UsageRoundingStrategyPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this UsageRoundingStrategyPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this UsageRoundingStrategyPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this UsageRoundingStrategyPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this UsageRoundingStrategyPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this UsageRoundingStrategyPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/usage_session.py b/billforward/models/usage_session.py deleted file mode 100644 index d915a9e..0000000 --- a/billforward/models/usage_session.py +++ /dev/null @@ -1,468 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class UsageSession(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, created=None, changed_by=None, organization_id=None, subscription_id=None, session_id=None, pricing_component_id=None, pricing_component_name=None, uom=None, description=None, sessionix=None, start=None, stop=None, state=None, uduration=None): - """ - UsageSession - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'organization_id': 'str', - 'subscription_id': 'str', - 'session_id': 'str', - 'pricing_component_id': 'str', - 'pricing_component_name': 'str', - 'uom': 'str', - 'description': 'str', - 'sessionix': 'int', - 'start': 'datetime', - 'stop': 'datetime', - 'state': 'str', - 'uduration': 'int' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'organization_id': 'organizationID', - 'subscription_id': 'subscriptionID', - 'session_id': 'sessionID', - 'pricing_component_id': 'pricingComponentID', - 'pricing_component_name': 'pricingComponentName', - 'uom': 'uom', - 'description': 'description', - 'sessionix': 'sessionix', - 'start': 'start', - 'stop': 'stop', - 'state': 'state', - 'uduration': 'uduration' - } - - self._created = created - self._changed_by = changed_by - self._organization_id = organization_id - self._subscription_id = subscription_id - self._session_id = session_id - self._pricing_component_id = pricing_component_id - self._pricing_component_name = pricing_component_name - self._uom = uom - self._description = description - self._sessionix = sessionix - self._start = start - self._stop = stop - self._state = state - self._uduration = uduration - - @property - def created(self): - """ - Gets the created of this UsageSession. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :return: The created of this UsageSession. - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """ - Sets the created of this UsageSession. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } - - :param created: The created of this UsageSession. - :type: datetime - """ - - self._created = created - - @property - def changed_by(self): - """ - Gets the changed_by of this UsageSession. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :return: The changed_by of this UsageSession. - :rtype: str - """ - return self._changed_by - - @changed_by.setter - def changed_by(self, changed_by): - """ - Sets the changed_by of this UsageSession. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } - - :param changed_by: The changed_by of this UsageSession. - :type: str - """ - - self._changed_by = changed_by - - @property - def organization_id(self): - """ - Gets the organization_id of this UsageSession. - { \"description\" : \"Organization associated with this session.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The organization_id of this UsageSession. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this UsageSession. - { \"description\" : \"Organization associated with this session.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param organization_id: The organization_id of this UsageSession. - :type: str - """ - - self._organization_id = organization_id - - @property - def subscription_id(self): - """ - Gets the subscription_id of this UsageSession. - { \"description\" : \"ID of the subscription to which this session pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The subscription_id of this UsageSession. - :rtype: str - """ - return self._subscription_id - - @subscription_id.setter - def subscription_id(self, subscription_id): - """ - Sets the subscription_id of this UsageSession. - { \"description\" : \"ID of the subscription to which this session pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param subscription_id: The subscription_id of this UsageSession. - :type: str - """ - - self._subscription_id = subscription_id - - @property - def session_id(self): - """ - Gets the session_id of this UsageSession. - { \"description\" : \"A (not guaranteed unique) identifier for this session, provided by the user. This, when combined with the subscription ID and unit of measure, uniquely identify a session.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The session_id of this UsageSession. - :rtype: str - """ - return self._session_id - - @session_id.setter - def session_id(self, session_id): - """ - Sets the session_id of this UsageSession. - { \"description\" : \"A (not guaranteed unique) identifier for this session, provided by the user. This, when combined with the subscription ID and unit of measure, uniquely identify a session.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param session_id: The session_id of this UsageSession. - :type: str - """ - - self._session_id = session_id - - @property - def pricing_component_id(self): - """ - Gets the pricing_component_id of this UsageSession. - { \"description\" : \"ID of the pricing-component to which this usage session applies\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The pricing_component_id of this UsageSession. - :rtype: str - """ - return self._pricing_component_id - - @pricing_component_id.setter - def pricing_component_id(self, pricing_component_id): - """ - Sets the pricing_component_id of this UsageSession. - { \"description\" : \"ID of the pricing-component to which this usage session applies\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param pricing_component_id: The pricing_component_id of this UsageSession. - :type: str - """ - - self._pricing_component_id = pricing_component_id - - @property - def pricing_component_name(self): - """ - Gets the pricing_component_name of this UsageSession. - { \"description\" : \"Name of the pricing-component to which this usage session applies\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The pricing_component_name of this UsageSession. - :rtype: str - """ - return self._pricing_component_name - - @pricing_component_name.setter - def pricing_component_name(self, pricing_component_name): - """ - Sets the pricing_component_name of this UsageSession. - { \"description\" : \"Name of the pricing-component to which this usage session applies\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param pricing_component_name: The pricing_component_name of this UsageSession. - :type: str - """ - - self._pricing_component_name = pricing_component_name - - @property - def uom(self): - """ - Gets the uom of this UsageSession. - { \"description\" : \"Unit-of-measure to which this usage session applies\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The uom of this UsageSession. - :rtype: str - """ - return self._uom - - @uom.setter - def uom(self, uom): - """ - Sets the uom of this UsageSession. - { \"description\" : \"Unit-of-measure to which this usage session applies\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param uom: The uom of this UsageSession. - :type: str - """ - - self._uom = uom - - @property - def description(self): - """ - Gets the description of this UsageSession. - { \"description\" : \"A description provided by the user, to record details about this session.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The description of this UsageSession. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this UsageSession. - { \"description\" : \"A description provided by the user, to record details about this session.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param description: The description of this UsageSession. - :type: str - """ - - self._description = description - - @property - def sessionix(self): - """ - Gets the sessionix of this UsageSession. - { \"description\" : \"The current incarnation of the session. Initially 0, this number increments every time the session is 'cut' without ending. For example, a cut is taken of a session if it outlasts the end date of the billing period it started in. The session reincarnates with an incremented sessionix, in the next billing period (that is, if some period indeed follows the current one).\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The sessionix of this UsageSession. - :rtype: int - """ - return self._sessionix - - @sessionix.setter - def sessionix(self, sessionix): - """ - Sets the sessionix of this UsageSession. - { \"description\" : \"The current incarnation of the session. Initially 0, this number increments every time the session is 'cut' without ending. For example, a cut is taken of a session if it outlasts the end date of the billing period it started in. The session reincarnates with an incremented sessionix, in the next billing period (that is, if some period indeed follows the current one).\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param sessionix: The sessionix of this UsageSession. - :type: int - """ - - self._sessionix = sessionix - - @property - def start(self): - """ - Gets the start of this UsageSession. - { \"description\" : \"The start date of this session, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The start of this UsageSession. - :rtype: datetime - """ - return self._start - - @start.setter - def start(self, start): - """ - Sets the start of this UsageSession. - { \"description\" : \"The start date of this session, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param start: The start of this UsageSession. - :type: datetime - """ - - self._start = start - - @property - def stop(self): - """ - Gets the stop of this UsageSession. - { \"description\" : \"The end date of this session, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The stop of this UsageSession. - :rtype: datetime - """ - return self._stop - - @stop.setter - def stop(self, stop): - """ - Sets the stop of this UsageSession. - { \"description\" : \"The end date of this session, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param stop: The stop of this UsageSession. - :type: datetime - """ - - self._stop = stop - - @property - def state(self): - """ - Gets the state of this UsageSession. - { \"description\" : \"The type of usage measured within this billing period. Options are '\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] }Active', Which refers to a session that is currently running 'Historic', Which refers to a session that has terminated. - - :return: The state of this UsageSession. - :rtype: str - """ - return self._state - - @state.setter - def state(self, state): - """ - Sets the state of this UsageSession. - { \"description\" : \"The type of usage measured within this billing period. Options are '\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] }Active', Which refers to a session that is currently running 'Historic', Which refers to a session that has terminated. - - :param state: The state of this UsageSession. - :type: str - """ - allowed_values = ["Active", "Historic"] - if state not in allowed_values: - raise ValueError( - "Invalid value for `state` ({0}), must be one of {1}" - .format(state, allowed_values) - ) - - self._state = state - - @property - def uduration(self): - """ - Gets the uduration of this UsageSession. - { \"description\" : \"The amount of time that elapsed (in milliseconds?) during this session. Initially 0. Presently updated only when a cut is taken of the session (for example if the session or billnig period ends).\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :return: The uduration of this UsageSession. - :rtype: int - """ - return self._uduration - - @uduration.setter - def uduration(self, uduration): - """ - Sets the uduration of this UsageSession. - { \"description\" : \"The amount of time that elapsed (in milliseconds?) during this session. Initially 0. Presently updated only when a cut is taken of the session (for example if the session or billnig period ends).\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } - - :param uduration: The uduration of this UsageSession. - :type: int - """ - - self._uduration = uduration - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/usage_session_paged_metadata.py b/billforward/models/usage_session_paged_metadata.py deleted file mode 100644 index f294be1..0000000 --- a/billforward/models/usage_session_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class UsageSessionPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - UsageSessionPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[UsageSession]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this UsageSessionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this UsageSessionPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this UsageSessionPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this UsageSessionPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this UsageSessionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this UsageSessionPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this UsageSessionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this UsageSessionPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this UsageSessionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this UsageSessionPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this UsageSessionPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this UsageSessionPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this UsageSessionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this UsageSessionPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this UsageSessionPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this UsageSessionPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this UsageSessionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this UsageSessionPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this UsageSessionPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this UsageSessionPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this UsageSessionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this UsageSessionPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this UsageSessionPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this UsageSessionPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this UsageSessionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this UsageSessionPagedMetadata. - :rtype: list[UsageSession] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this UsageSessionPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this UsageSessionPagedMetadata. - :type: list[UsageSession] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/user.py b/billforward/models/user.py index 6181927..ad350e0 100644 --- a/billforward/models/user.py +++ b/billforward/models/user.py @@ -1,112 +1,159 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class User(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, password=None, username=None, password_reset_valid_till=None, bf_admin=False, account_non_expired=False, account_non_locked=False, credentials_non_expired=False, enabled=False, timezone=None): - """ - User - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'updated': 'datetime', - 'id': 'str', - 'organization_id': 'str', - 'password': 'list[Password]', - 'username': 'list[Username]', - 'password_reset_valid_till': 'datetime', - 'bf_admin': 'bool', - 'account_non_expired': 'bool', - 'account_non_locked': 'bool', - 'credentials_non_expired': 'bool', - 'enabled': 'bool', - 'timezone': 'TimeZone' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'updated': 'updated', - 'id': 'id', - 'organization_id': 'organizationID', - 'password': 'password', - 'username': 'username', - 'password_reset_valid_till': 'passwordResetValidTill', - 'bf_admin': 'bfAdmin', - 'account_non_expired': 'accountNonExpired', - 'account_non_locked': 'accountNonLocked', - 'credentials_non_expired': 'credentialsNonExpired', - 'enabled': 'enabled', - 'timezone': 'timezone' - } - - self._created = created - self._changed_by = changed_by - self._updated = updated - self._id = id - self._organization_id = organization_id - self._password = password - self._username = username - self._password_reset_valid_till = password_reset_valid_till - self._bf_admin = bf_admin - self._account_non_expired = account_non_expired - self._account_non_locked = account_non_locked - self._credentials_non_expired = credentials_non_expired - self._enabled = enabled - self._timezone = timezone + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'password': 'list[Password]', + 'username': 'list[Username]', + 'open_id_identifier': 'str', + 'password_reset_code': 'str', + 'password_reset_attempts': 'int', + 'password_reset_valid_till': 'datetime', + 'last_successful_login': 'datetime', + 'successful_logins': 'int', + 'bf_admin': 'bool', + 'enabled': 'bool', + 'timezone': 'UserTimezone', + 'flexcheck_user': 'bool', + 'two_fa': 'bool', + 'main_username': 'Username', + 'active_usernames': 'list[str]', + 'email': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'password': 'password', + 'username': 'username', + 'open_id_identifier': 'openIDIdentifier', + 'password_reset_code': 'passwordResetCode', + 'password_reset_attempts': 'passwordResetAttempts', + 'password_reset_valid_till': 'passwordResetValidTill', + 'last_successful_login': 'lastSuccessfulLogin', + 'successful_logins': 'successfulLogins', + 'bf_admin': 'bfAdmin', + 'enabled': 'enabled', + 'timezone': 'timezone', + 'flexcheck_user': 'flexcheckUser', + 'two_fa': 'twoFA', + 'main_username': 'mainUsername', + 'active_usernames': 'activeUsernames', + 'email': 'email' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, password=None, username=None, open_id_identifier=None, password_reset_code=None, password_reset_attempts=None, password_reset_valid_till=None, last_successful_login=None, successful_logins=None, bf_admin=None, enabled=None, timezone=None, flexcheck_user=None, two_fa=None, main_username=None, active_usernames=None, email=None): # noqa: E501 + """User - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._password = None + self._username = None + self._open_id_identifier = None + self._password_reset_code = None + self._password_reset_attempts = None + self._password_reset_valid_till = None + self._last_successful_login = None + self._successful_logins = None + self._bf_admin = None + self._enabled = None + self._timezone = None + self._flexcheck_user = None + self._two_fa = None + self._main_username = None + self._active_usernames = None + self._email = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + self.organization_id = organization_id + if password is not None: + self.password = password + if username is not None: + self.username = username + if open_id_identifier is not None: + self.open_id_identifier = open_id_identifier + if password_reset_code is not None: + self.password_reset_code = password_reset_code + if password_reset_attempts is not None: + self.password_reset_attempts = password_reset_attempts + if password_reset_valid_till is not None: + self.password_reset_valid_till = password_reset_valid_till + if last_successful_login is not None: + self.last_successful_login = last_successful_login + if successful_logins is not None: + self.successful_logins = successful_logins + if bf_admin is not None: + self.bf_admin = bf_admin + self.enabled = enabled + self.timezone = timezone + self.flexcheck_user = flexcheck_user + if two_fa is not None: + self.two_fa = two_fa + if main_username is not None: + self.main_username = main_username + if active_usernames is not None: + self.active_usernames = active_usernames + if email is not None: + self.email = email @property def created(self): - """ - Gets the created of this User. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this User. # noqa: E501 + - :return: The created of this User. + :return: The created of this User. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this User. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this User. + - :param created: The created of this User. + :param created: The created of this User. # noqa: E501 :type: datetime """ @@ -114,22 +161,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this User. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this User. # noqa: E501 + - :return: The changed_by of this User. + :return: The changed_by of this User. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this User. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this User. - :param changed_by: The changed_by of this User. + + :param changed_by: The changed_by of this User. # noqa: E501 :type: str """ @@ -137,22 +182,20 @@ def changed_by(self, changed_by): @property def updated(self): - """ - Gets the updated of this User. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Gets the updated of this User. # noqa: E501 + - :return: The updated of this User. + :return: The updated of this User. # noqa: E501 :rtype: datetime """ return self._updated @updated.setter def updated(self, updated): - """ - Sets the updated of this User. - { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } + """Sets the updated of this User. + - :param updated: The updated of this User. + :param updated: The updated of this User. # noqa: E501 :type: datetime """ @@ -160,22 +203,20 @@ def updated(self, updated): @property def id(self): - """ - Gets the id of this User. - {\"description\":\"ID of the user\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the id of this User. # noqa: E501 - :return: The id of this User. + + :return: The id of this User. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this User. - {\"description\":\"ID of the user\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the id of this User. - :param id: The id of this User. + + :param id: The id of this User. # noqa: E501 :type: str """ @@ -183,45 +224,43 @@ def id(self, id): @property def organization_id(self): - """ - Gets the organization_id of this User. - {\"description\":\"ID of the Organization to which the User belongs.\",\"verbs\":[\"GET\",\"POST\"]} + """Gets the organization_id of this User. # noqa: E501 + - :return: The organization_id of this User. + :return: The organization_id of this User. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this User. - {\"description\":\"ID of the Organization to which the User belongs.\",\"verbs\":[\"GET\",\"POST\"]} + """Sets the organization_id of this User. + - :param organization_id: The organization_id of this User. + :param organization_id: The organization_id of this User. # noqa: E501 :type: str """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 self._organization_id = organization_id @property def password(self): - """ - Gets the password of this User. - {\"description\":\"Passwords associated with the user. A user must have one currently active password to login.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the password of this User. # noqa: E501 - :return: The password of this User. + + :return: The password of this User. # noqa: E501 :rtype: list[Password] """ return self._password @password.setter def password(self, password): - """ - Sets the password of this User. - {\"description\":\"Passwords associated with the user. A user must have one currently active password to login.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the password of this User. + - :param password: The password of this User. + :param password: The password of this User. # noqa: E501 :type: list[Password] """ @@ -229,195 +268,330 @@ def password(self, password): @property def username(self): - """ - Gets the username of this User. - {\"description\":\"Usernames associated with the user. A user may have more than one username currently active. Usernames are enforced to be formatted as e-mail addresses.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the username of this User. # noqa: E501 + - :return: The username of this User. + :return: The username of this User. # noqa: E501 :rtype: list[Username] """ return self._username @username.setter def username(self, username): - """ - Sets the username of this User. - {\"description\":\"Usernames associated with the user. A user may have more than one username currently active. Usernames are enforced to be formatted as e-mail addresses.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the username of this User. + - :param username: The username of this User. + :param username: The username of this User. # noqa: E501 :type: list[Username] """ self._username = username @property - def password_reset_valid_till(self): + def open_id_identifier(self): + """Gets the open_id_identifier of this User. # noqa: E501 + + + :return: The open_id_identifier of this User. # noqa: E501 + :rtype: str + """ + return self._open_id_identifier + + @open_id_identifier.setter + def open_id_identifier(self, open_id_identifier): + """Sets the open_id_identifier of this User. + + + :param open_id_identifier: The open_id_identifier of this User. # noqa: E501 + :type: str + """ + + self._open_id_identifier = open_id_identifier + + @property + def password_reset_code(self): + """Gets the password_reset_code of this User. # noqa: E501 + + + :return: The password_reset_code of this User. # noqa: E501 + :rtype: str + """ + return self._password_reset_code + + @password_reset_code.setter + def password_reset_code(self, password_reset_code): + """Sets the password_reset_code of this User. + + + :param password_reset_code: The password_reset_code of this User. # noqa: E501 + :type: str + """ + + self._password_reset_code = password_reset_code + + @property + def password_reset_attempts(self): + """Gets the password_reset_attempts of this User. # noqa: E501 + + + :return: The password_reset_attempts of this User. # noqa: E501 + :rtype: int + """ + return self._password_reset_attempts + + @password_reset_attempts.setter + def password_reset_attempts(self, password_reset_attempts): + """Sets the password_reset_attempts of this User. + + + :param password_reset_attempts: The password_reset_attempts of this User. # noqa: E501 + :type: int """ - Gets the password_reset_valid_till of this User. - {\"description\":\"The UTC DateTime when a password reset would no longer be valid with the current code.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} - :return: The password_reset_valid_till of this User. + self._password_reset_attempts = password_reset_attempts + + @property + def password_reset_valid_till(self): + """Gets the password_reset_valid_till of this User. # noqa: E501 + + + :return: The password_reset_valid_till of this User. # noqa: E501 :rtype: datetime """ return self._password_reset_valid_till @password_reset_valid_till.setter def password_reset_valid_till(self, password_reset_valid_till): - """ - Sets the password_reset_valid_till of this User. - {\"description\":\"The UTC DateTime when a password reset would no longer be valid with the current code.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the password_reset_valid_till of this User. - :param password_reset_valid_till: The password_reset_valid_till of this User. + + :param password_reset_valid_till: The password_reset_valid_till of this User. # noqa: E501 :type: datetime """ self._password_reset_valid_till = password_reset_valid_till @property - def bf_admin(self): + def last_successful_login(self): + """Gets the last_successful_login of this User. # noqa: E501 + + + :return: The last_successful_login of this User. # noqa: E501 + :rtype: datetime """ - Gets the bf_admin of this User. + return self._last_successful_login + @last_successful_login.setter + def last_successful_login(self, last_successful_login): + """Sets the last_successful_login of this User. - :return: The bf_admin of this User. + + :param last_successful_login: The last_successful_login of this User. # noqa: E501 + :type: datetime + """ + + self._last_successful_login = last_successful_login + + @property + def successful_logins(self): + """Gets the successful_logins of this User. # noqa: E501 + + + :return: The successful_logins of this User. # noqa: E501 + :rtype: int + """ + return self._successful_logins + + @successful_logins.setter + def successful_logins(self, successful_logins): + """Sets the successful_logins of this User. + + + :param successful_logins: The successful_logins of this User. # noqa: E501 + :type: int + """ + + self._successful_logins = successful_logins + + @property + def bf_admin(self): + """Gets the bf_admin of this User. # noqa: E501 + + + :return: The bf_admin of this User. # noqa: E501 :rtype: bool """ return self._bf_admin @bf_admin.setter def bf_admin(self, bf_admin): - """ - Sets the bf_admin of this User. + """Sets the bf_admin of this User. - :param bf_admin: The bf_admin of this User. + :param bf_admin: The bf_admin of this User. # noqa: E501 :type: bool """ self._bf_admin = bf_admin @property - def account_non_expired(self): - """ - Gets the account_non_expired of this User. - {\"description\":\"Whether the User has expired.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"] } + def enabled(self): + """Gets the enabled of this User. # noqa: E501 + - :return: The account_non_expired of this User. + :return: The enabled of this User. # noqa: E501 :rtype: bool """ - return self._account_non_expired + return self._enabled + + @enabled.setter + def enabled(self, enabled): + """Sets the enabled of this User. - @account_non_expired.setter - def account_non_expired(self, account_non_expired): - """ - Sets the account_non_expired of this User. - {\"description\":\"Whether the User has expired.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"] } - :param account_non_expired: The account_non_expired of this User. + :param enabled: The enabled of this User. # noqa: E501 :type: bool """ + if enabled is None: + raise ValueError("Invalid value for `enabled`, must not be `None`") # noqa: E501 - self._account_non_expired = account_non_expired + self._enabled = enabled @property - def account_non_locked(self): - """ - Gets the account_non_locked of this User. - {\"description\":\"Is the User locked.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + def timezone(self): + """Gets the timezone of this User. # noqa: E501 - :return: The account_non_locked of this User. - :rtype: bool - """ - return self._account_non_locked - @account_non_locked.setter - def account_non_locked(self, account_non_locked): + :return: The timezone of this User. # noqa: E501 + :rtype: UserTimezone """ - Sets the account_non_locked of this User. - {\"description\":\"Is the User locked.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + return self._timezone - :param account_non_locked: The account_non_locked of this User. - :type: bool + @timezone.setter + def timezone(self, timezone): + """Sets the timezone of this User. + + + :param timezone: The timezone of this User. # noqa: E501 + :type: UserTimezone """ + if timezone is None: + raise ValueError("Invalid value for `timezone`, must not be `None`") # noqa: E501 - self._account_non_locked = account_non_locked + self._timezone = timezone @property - def credentials_non_expired(self): - """ - Gets the credentials_non_expired of this User. - {\"description\":\"Are the User credentials expired.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + def flexcheck_user(self): + """Gets the flexcheck_user of this User. # noqa: E501 + - :return: The credentials_non_expired of this User. + :return: The flexcheck_user of this User. # noqa: E501 :rtype: bool """ - return self._credentials_non_expired + return self._flexcheck_user - @credentials_non_expired.setter - def credentials_non_expired(self, credentials_non_expired): - """ - Sets the credentials_non_expired of this User. - {\"description\":\"Are the User credentials expired.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + @flexcheck_user.setter + def flexcheck_user(self, flexcheck_user): + """Sets the flexcheck_user of this User. - :param credentials_non_expired: The credentials_non_expired of this User. + + :param flexcheck_user: The flexcheck_user of this User. # noqa: E501 :type: bool """ + if flexcheck_user is None: + raise ValueError("Invalid value for `flexcheck_user`, must not be `None`") # noqa: E501 - self._credentials_non_expired = credentials_non_expired + self._flexcheck_user = flexcheck_user @property - def enabled(self): - """ - Gets the enabled of this User. - {\"description\":\"Is the User enabled.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + def two_fa(self): + """Gets the two_fa of this User. # noqa: E501 + - :return: The enabled of this User. + :return: The two_fa of this User. # noqa: E501 :rtype: bool """ - return self._enabled + return self._two_fa - @enabled.setter - def enabled(self, enabled): - """ - Sets the enabled of this User. - {\"description\":\"Is the User enabled.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + @two_fa.setter + def two_fa(self, two_fa): + """Sets the two_fa of this User. - :param enabled: The enabled of this User. + + :param two_fa: The two_fa of this User. # noqa: E501 :type: bool """ - self._enabled = enabled + self._two_fa = two_fa @property - def timezone(self): + def main_username(self): + """Gets the main_username of this User. # noqa: E501 + + + :return: The main_username of this User. # noqa: E501 + :rtype: Username """ - Gets the timezone of this User. - {\"description\":\"The timezone used when displaying time series data to the user.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + return self._main_username - :return: The timezone of this User. - :rtype: TimeZone + @main_username.setter + def main_username(self, main_username): + """Sets the main_username of this User. + + + :param main_username: The main_username of this User. # noqa: E501 + :type: Username """ - return self._timezone - @timezone.setter - def timezone(self, timezone): + self._main_username = main_username + + @property + def active_usernames(self): + """Gets the active_usernames of this User. # noqa: E501 + + + :return: The active_usernames of this User. # noqa: E501 + :rtype: list[str] """ - Sets the timezone of this User. - {\"description\":\"The timezone used when displaying time series data to the user.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + return self._active_usernames + + @active_usernames.setter + def active_usernames(self, active_usernames): + """Sets the active_usernames of this User. + - :param timezone: The timezone of this User. - :type: TimeZone + :param active_usernames: The active_usernames of this User. # noqa: E501 + :type: list[str] """ - self._timezone = timezone + self._active_usernames = active_usernames - def to_dict(self): + @property + def email(self): + """Gets the email of this User. # noqa: E501 + + + :return: The email of this User. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._email + + @email.setter + def email(self, email): + """Sets the email of this User. + + + :param email: The email of this User. # noqa: E501 + :type: str """ + + self._email = email + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -434,29 +608,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(User, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, User): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/user_create_request.py b/billforward/models/user_create_request.py new file mode 100644 index 0000000..4d6fd0a --- /dev/null +++ b/billforward/models/user_create_request.py @@ -0,0 +1,370 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UserCreateRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'organization_id': 'str', + 'email': 'str', + 'first_name': 'str', + 'last_name': 'str', + 'company_name': 'str', + 'password': 'str', + 'roles': 'list[str]', + 'send_email': 'bool', + 'id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'organization_id': 'organizationID', + 'email': 'email', + 'first_name': 'firstName', + 'last_name': 'lastName', + 'company_name': 'companyName', + 'password': 'password', + 'roles': 'roles', + 'send_email': 'sendEmail', + 'id': 'id' + } + + def __init__(self, created=None, changed_by=None, organization_id=None, email=None, first_name=None, last_name=None, company_name=None, password=None, roles=None, send_email=None, id=None): # noqa: E501 + """UserCreateRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._organization_id = None + self._email = None + self._first_name = None + self._last_name = None + self._company_name = None + self._password = None + self._roles = None + self._send_email = None + self._id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if organization_id is not None: + self.organization_id = organization_id + if email is not None: + self.email = email + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if company_name is not None: + self.company_name = company_name + if password is not None: + self.password = password + if roles is not None: + self.roles = roles + if send_email is not None: + self.send_email = send_email + if id is not None: + self.id = id + + @property + def created(self): + """Gets the created of this UserCreateRequest. # noqa: E501 + + + :return: The created of this UserCreateRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this UserCreateRequest. + + + :param created: The created of this UserCreateRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this UserCreateRequest. # noqa: E501 + + + :return: The changed_by of this UserCreateRequest. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this UserCreateRequest. + + + :param changed_by: The changed_by of this UserCreateRequest. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def organization_id(self): + """Gets the organization_id of this UserCreateRequest. # noqa: E501 + + + :return: The organization_id of this UserCreateRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UserCreateRequest. + + + :param organization_id: The organization_id of this UserCreateRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def email(self): + """Gets the email of this UserCreateRequest. # noqa: E501 + + + :return: The email of this UserCreateRequest. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this UserCreateRequest. + + + :param email: The email of this UserCreateRequest. # noqa: E501 + :type: str + """ + + self._email = email + + @property + def first_name(self): + """Gets the first_name of this UserCreateRequest. # noqa: E501 + + + :return: The first_name of this UserCreateRequest. # noqa: E501 + :rtype: str + """ + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """Sets the first_name of this UserCreateRequest. + + + :param first_name: The first_name of this UserCreateRequest. # noqa: E501 + :type: str + """ + + self._first_name = first_name + + @property + def last_name(self): + """Gets the last_name of this UserCreateRequest. # noqa: E501 + + + :return: The last_name of this UserCreateRequest. # noqa: E501 + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """Sets the last_name of this UserCreateRequest. + + + :param last_name: The last_name of this UserCreateRequest. # noqa: E501 + :type: str + """ + + self._last_name = last_name + + @property + def company_name(self): + """Gets the company_name of this UserCreateRequest. # noqa: E501 + + + :return: The company_name of this UserCreateRequest. # noqa: E501 + :rtype: str + """ + return self._company_name + + @company_name.setter + def company_name(self, company_name): + """Sets the company_name of this UserCreateRequest. + + + :param company_name: The company_name of this UserCreateRequest. # noqa: E501 + :type: str + """ + + self._company_name = company_name + + @property + def password(self): + """Gets the password of this UserCreateRequest. # noqa: E501 + + + :return: The password of this UserCreateRequest. # noqa: E501 + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """Sets the password of this UserCreateRequest. + + + :param password: The password of this UserCreateRequest. # noqa: E501 + :type: str + """ + + self._password = password + + @property + def roles(self): + """Gets the roles of this UserCreateRequest. # noqa: E501 + + + :return: The roles of this UserCreateRequest. # noqa: E501 + :rtype: list[str] + """ + return self._roles + + @roles.setter + def roles(self, roles): + """Sets the roles of this UserCreateRequest. + + + :param roles: The roles of this UserCreateRequest. # noqa: E501 + :type: list[str] + """ + + self._roles = roles + + @property + def send_email(self): + """Gets the send_email of this UserCreateRequest. # noqa: E501 + + + :return: The send_email of this UserCreateRequest. # noqa: E501 + :rtype: bool + """ + return self._send_email + + @send_email.setter + def send_email(self, send_email): + """Sets the send_email of this UserCreateRequest. + + + :param send_email: The send_email of this UserCreateRequest. # noqa: E501 + :type: bool + """ + + self._send_email = send_email + + @property + def id(self): + """Gets the id of this UserCreateRequest. # noqa: E501 + + + :return: The id of this UserCreateRequest. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this UserCreateRequest. + + + :param id: The id of this UserCreateRequest. # noqa: E501 + :type: str + """ + + self._id = id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UserCreateRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UserCreateRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/user_creation_request.py b/billforward/models/user_creation_request.py index 0f88eaa..aa4a783 100644 --- a/billforward/models/user_creation_request.py +++ b/billforward/models/user_creation_request.py @@ -1,100 +1,118 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class UserCreationRequest(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, organization_id=None, email=None, first_name=None, last_name=None, company_name=None, password=None, roles=None, send_email=False): - """ - UserCreationRequest - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'organization_id': 'str', - 'email': 'str', - 'first_name': 'str', - 'last_name': 'str', - 'company_name': 'str', - 'password': 'str', - 'roles': 'list[str]', - 'send_email': 'bool' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'organization_id': 'organizationID', - 'email': 'email', - 'first_name': 'firstName', - 'last_name': 'lastName', - 'company_name': 'companyName', - 'password': 'password', - 'roles': 'roles', - 'send_email': 'sendEmail' - } - - self._created = created - self._changed_by = changed_by - self._organization_id = organization_id - self._email = email - self._first_name = first_name - self._last_name = last_name - self._company_name = company_name - self._password = password - self._roles = roles - self._send_email = send_email + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'organization_id': 'str', + 'email': 'str', + 'first_name': 'str', + 'last_name': 'str', + 'company_name': 'str', + 'password': 'str', + 'roles': 'list[str]', + 'send_email': 'bool', + 'user_present': 'bool', + 'id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'organization_id': 'organizationID', + 'email': 'email', + 'first_name': 'firstName', + 'last_name': 'lastName', + 'company_name': 'companyName', + 'password': 'password', + 'roles': 'roles', + 'send_email': 'sendEmail', + 'user_present': 'userPresent', + 'id': 'id' + } + + def __init__(self, created=None, changed_by=None, organization_id=None, email=None, first_name=None, last_name=None, company_name=None, password=None, roles=None, send_email=None, user_present=None, id=None): # noqa: E501 + """UserCreationRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._organization_id = None + self._email = None + self._first_name = None + self._last_name = None + self._company_name = None + self._password = None + self._roles = None + self._send_email = None + self._user_present = None + self._id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if organization_id is not None: + self.organization_id = organization_id + if email is not None: + self.email = email + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if company_name is not None: + self.company_name = company_name + if password is not None: + self.password = password + if roles is not None: + self.roles = roles + if send_email is not None: + self.send_email = send_email + if user_present is not None: + self.user_present = user_present + if id is not None: + self.id = id @property def created(self): - """ - Gets the created of this UserCreationRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this UserCreationRequest. # noqa: E501 + - :return: The created of this UserCreationRequest. + :return: The created of this UserCreationRequest. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this UserCreationRequest. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this UserCreationRequest. - :param created: The created of this UserCreationRequest. + + :param created: The created of this UserCreationRequest. # noqa: E501 :type: datetime """ @@ -102,22 +120,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this UserCreationRequest. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this UserCreationRequest. # noqa: E501 + - :return: The changed_by of this UserCreationRequest. + :return: The changed_by of this UserCreationRequest. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this UserCreationRequest. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this UserCreationRequest. + - :param changed_by: The changed_by of this UserCreationRequest. + :param changed_by: The changed_by of this UserCreationRequest. # noqa: E501 :type: str """ @@ -125,22 +141,20 @@ def changed_by(self, changed_by): @property def organization_id(self): - """ - Gets the organization_id of this UserCreationRequest. - {\"description\":\"Organization for which the User is created.\",\"verbs\":[\"GET\",\"POST\"]} + """Gets the organization_id of this UserCreationRequest. # noqa: E501 - :return: The organization_id of this UserCreationRequest. + + :return: The organization_id of this UserCreationRequest. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this UserCreationRequest. - {\"description\":\"Organization for which the User is created.\",\"verbs\":[\"GET\",\"POST\"]} + """Sets the organization_id of this UserCreationRequest. + - :param organization_id: The organization_id of this UserCreationRequest. + :param organization_id: The organization_id of this UserCreationRequest. # noqa: E501 :type: str """ @@ -148,22 +162,20 @@ def organization_id(self, organization_id): @property def email(self): - """ - Gets the email of this UserCreationRequest. - {\"description\":\"Login E-mail address of the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the email of this UserCreationRequest. # noqa: E501 + - :return: The email of this UserCreationRequest. + :return: The email of this UserCreationRequest. # noqa: E501 :rtype: str """ return self._email @email.setter def email(self, email): - """ - Sets the email of this UserCreationRequest. - {\"description\":\"Login E-mail address of the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the email of this UserCreationRequest. - :param email: The email of this UserCreationRequest. + + :param email: The email of this UserCreationRequest. # noqa: E501 :type: str """ @@ -171,22 +183,20 @@ def email(self, email): @property def first_name(self): - """ - Gets the first_name of this UserCreationRequest. - {\"description\":\"First Name of the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the first_name of this UserCreationRequest. # noqa: E501 + - :return: The first_name of this UserCreationRequest. + :return: The first_name of this UserCreationRequest. # noqa: E501 :rtype: str """ return self._first_name @first_name.setter def first_name(self, first_name): - """ - Sets the first_name of this UserCreationRequest. - {\"description\":\"First Name of the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the first_name of this UserCreationRequest. + - :param first_name: The first_name of this UserCreationRequest. + :param first_name: The first_name of this UserCreationRequest. # noqa: E501 :type: str """ @@ -194,22 +204,20 @@ def first_name(self, first_name): @property def last_name(self): - """ - Gets the last_name of this UserCreationRequest. - {\"description\":\"Last Name of the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the last_name of this UserCreationRequest. # noqa: E501 - :return: The last_name of this UserCreationRequest. + + :return: The last_name of this UserCreationRequest. # noqa: E501 :rtype: str """ return self._last_name @last_name.setter def last_name(self, last_name): - """ - Sets the last_name of this UserCreationRequest. - {\"description\":\"Last Name of the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the last_name of this UserCreationRequest. + - :param last_name: The last_name of this UserCreationRequest. + :param last_name: The last_name of this UserCreationRequest. # noqa: E501 :type: str """ @@ -217,22 +225,20 @@ def last_name(self, last_name): @property def company_name(self): - """ - Gets the company_name of this UserCreationRequest. - {\"description\":\"User's Company.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the company_name of this UserCreationRequest. # noqa: E501 + - :return: The company_name of this UserCreationRequest. + :return: The company_name of this UserCreationRequest. # noqa: E501 :rtype: str """ return self._company_name @company_name.setter def company_name(self, company_name): - """ - Sets the company_name of this UserCreationRequest. - {\"description\":\"User's Company.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the company_name of this UserCreationRequest. + - :param company_name: The company_name of this UserCreationRequest. + :param company_name: The company_name of this UserCreationRequest. # noqa: E501 :type: str """ @@ -240,22 +246,20 @@ def company_name(self, company_name): @property def password(self): - """ - Gets the password of this UserCreationRequest. - {\"description\":\"Login Password for the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the password of this UserCreationRequest. # noqa: E501 - :return: The password of this UserCreationRequest. + + :return: The password of this UserCreationRequest. # noqa: E501 :rtype: str """ return self._password @password.setter def password(self, password): - """ - Sets the password of this UserCreationRequest. - {\"description\":\"Login Password for the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the password of this UserCreationRequest. + - :param password: The password of this UserCreationRequest. + :param password: The password of this UserCreationRequest. # noqa: E501 :type: str """ @@ -263,22 +267,20 @@ def password(self, password): @property def roles(self): - """ - Gets the roles of this UserCreationRequest. - {\"description\":\"The permission groups the user will belong to.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the roles of this UserCreationRequest. # noqa: E501 + - :return: The roles of this UserCreationRequest. + :return: The roles of this UserCreationRequest. # noqa: E501 :rtype: list[str] """ return self._roles @roles.setter def roles(self, roles): - """ - Sets the roles of this UserCreationRequest. - {\"description\":\"The permission groups the user will belong to.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the roles of this UserCreationRequest. - :param roles: The roles of this UserCreationRequest. + + :param roles: The roles of this UserCreationRequest. # noqa: E501 :type: list[str] """ @@ -286,34 +288,72 @@ def roles(self, roles): @property def send_email(self): - """ - Gets the send_email of this UserCreationRequest. - {\"description\":\"When an email should be sent upon creation.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Gets the send_email of this UserCreationRequest. # noqa: E501 + - :return: The send_email of this UserCreationRequest. + :return: The send_email of this UserCreationRequest. # noqa: E501 :rtype: bool """ return self._send_email @send_email.setter def send_email(self, send_email): - """ - Sets the send_email of this UserCreationRequest. - {\"description\":\"When an email should be sent upon creation.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} + """Sets the send_email of this UserCreationRequest. + - :param send_email: The send_email of this UserCreationRequest. + :param send_email: The send_email of this UserCreationRequest. # noqa: E501 :type: bool """ self._send_email = send_email - def to_dict(self): + @property + def user_present(self): + """Gets the user_present of this UserCreationRequest. # noqa: E501 + + + :return: The user_present of this UserCreationRequest. # noqa: E501 + :rtype: bool """ - Returns the model properties as a dict + return self._user_present + + @user_present.setter + def user_present(self, user_present): + """Sets the user_present of this UserCreationRequest. + + + :param user_present: The user_present of this UserCreationRequest. # noqa: E501 + :type: bool """ + + self._user_present = user_present + + @property + def id(self): + """Gets the id of this UserCreationRequest. # noqa: E501 + + + :return: The id of this UserCreationRequest. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this UserCreationRequest. + + + :param id: The id of this UserCreationRequest. # noqa: E501 + :type: str + """ + + self._id = id + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -330,29 +370,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(UserCreationRequest, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, UserCreationRequest): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/user_creation_response.py b/billforward/models/user_creation_response.py new file mode 100644 index 0000000..6e11060 --- /dev/null +++ b/billforward/models/user_creation_response.py @@ -0,0 +1,448 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UserCreationResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'organization_id': 'str', + 'email': 'str', + 'first_name': 'str', + 'last_name': 'str', + 'company_name': 'str', + 'roles': 'list[str]', + 'email_sent': 'bool', + 'account_id': 'str', + 'account': 'Account', + 'user': 'User', + 'request': 'UserCreationRequest', + 'id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'organization_id': 'organizationID', + 'email': 'email', + 'first_name': 'firstName', + 'last_name': 'lastName', + 'company_name': 'companyName', + 'roles': 'roles', + 'email_sent': 'emailSent', + 'account_id': 'accountID', + 'account': 'account', + 'user': 'user', + 'request': 'request', + 'id': 'id' + } + + def __init__(self, created=None, changed_by=None, organization_id=None, email=None, first_name=None, last_name=None, company_name=None, roles=None, email_sent=None, account_id=None, account=None, user=None, request=None, id=None): # noqa: E501 + """UserCreationResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._organization_id = None + self._email = None + self._first_name = None + self._last_name = None + self._company_name = None + self._roles = None + self._email_sent = None + self._account_id = None + self._account = None + self._user = None + self._request = None + self._id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if organization_id is not None: + self.organization_id = organization_id + if email is not None: + self.email = email + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if company_name is not None: + self.company_name = company_name + if roles is not None: + self.roles = roles + if email_sent is not None: + self.email_sent = email_sent + if account_id is not None: + self.account_id = account_id + if account is not None: + self.account = account + if user is not None: + self.user = user + if request is not None: + self.request = request + if id is not None: + self.id = id + + @property + def created(self): + """Gets the created of this UserCreationResponse. # noqa: E501 + + + :return: The created of this UserCreationResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this UserCreationResponse. + + + :param created: The created of this UserCreationResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this UserCreationResponse. # noqa: E501 + + + :return: The changed_by of this UserCreationResponse. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this UserCreationResponse. + + + :param changed_by: The changed_by of this UserCreationResponse. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def organization_id(self): + """Gets the organization_id of this UserCreationResponse. # noqa: E501 + + + :return: The organization_id of this UserCreationResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UserCreationResponse. + + + :param organization_id: The organization_id of this UserCreationResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def email(self): + """Gets the email of this UserCreationResponse. # noqa: E501 + + + :return: The email of this UserCreationResponse. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this UserCreationResponse. + + + :param email: The email of this UserCreationResponse. # noqa: E501 + :type: str + """ + + self._email = email + + @property + def first_name(self): + """Gets the first_name of this UserCreationResponse. # noqa: E501 + + + :return: The first_name of this UserCreationResponse. # noqa: E501 + :rtype: str + """ + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """Sets the first_name of this UserCreationResponse. + + + :param first_name: The first_name of this UserCreationResponse. # noqa: E501 + :type: str + """ + + self._first_name = first_name + + @property + def last_name(self): + """Gets the last_name of this UserCreationResponse. # noqa: E501 + + + :return: The last_name of this UserCreationResponse. # noqa: E501 + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """Sets the last_name of this UserCreationResponse. + + + :param last_name: The last_name of this UserCreationResponse. # noqa: E501 + :type: str + """ + + self._last_name = last_name + + @property + def company_name(self): + """Gets the company_name of this UserCreationResponse. # noqa: E501 + + + :return: The company_name of this UserCreationResponse. # noqa: E501 + :rtype: str + """ + return self._company_name + + @company_name.setter + def company_name(self, company_name): + """Sets the company_name of this UserCreationResponse. + + + :param company_name: The company_name of this UserCreationResponse. # noqa: E501 + :type: str + """ + + self._company_name = company_name + + @property + def roles(self): + """Gets the roles of this UserCreationResponse. # noqa: E501 + + + :return: The roles of this UserCreationResponse. # noqa: E501 + :rtype: list[str] + """ + return self._roles + + @roles.setter + def roles(self, roles): + """Sets the roles of this UserCreationResponse. + + + :param roles: The roles of this UserCreationResponse. # noqa: E501 + :type: list[str] + """ + + self._roles = roles + + @property + def email_sent(self): + """Gets the email_sent of this UserCreationResponse. # noqa: E501 + + + :return: The email_sent of this UserCreationResponse. # noqa: E501 + :rtype: bool + """ + return self._email_sent + + @email_sent.setter + def email_sent(self, email_sent): + """Sets the email_sent of this UserCreationResponse. + + + :param email_sent: The email_sent of this UserCreationResponse. # noqa: E501 + :type: bool + """ + + self._email_sent = email_sent + + @property + def account_id(self): + """Gets the account_id of this UserCreationResponse. # noqa: E501 + + + :return: The account_id of this UserCreationResponse. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this UserCreationResponse. + + + :param account_id: The account_id of this UserCreationResponse. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def account(self): + """Gets the account of this UserCreationResponse. # noqa: E501 + + + :return: The account of this UserCreationResponse. # noqa: E501 + :rtype: Account + """ + return self._account + + @account.setter + def account(self, account): + """Sets the account of this UserCreationResponse. + + + :param account: The account of this UserCreationResponse. # noqa: E501 + :type: Account + """ + + self._account = account + + @property + def user(self): + """Gets the user of this UserCreationResponse. # noqa: E501 + + + :return: The user of this UserCreationResponse. # noqa: E501 + :rtype: User + """ + return self._user + + @user.setter + def user(self, user): + """Sets the user of this UserCreationResponse. + + + :param user: The user of this UserCreationResponse. # noqa: E501 + :type: User + """ + + self._user = user + + @property + def request(self): + """Gets the request of this UserCreationResponse. # noqa: E501 + + + :return: The request of this UserCreationResponse. # noqa: E501 + :rtype: UserCreationRequest + """ + return self._request + + @request.setter + def request(self, request): + """Sets the request of this UserCreationResponse. + + + :param request: The request of this UserCreationResponse. # noqa: E501 + :type: UserCreationRequest + """ + + self._request = request + + @property + def id(self): + """Gets the id of this UserCreationResponse. # noqa: E501 + + + :return: The id of this UserCreationResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this UserCreationResponse. + + + :param id: The id of this UserCreationResponse. # noqa: E501 + :type: str + """ + + self._id = id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UserCreationResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UserCreationResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/user_creation_response_paged_metadata.py b/billforward/models/user_creation_response_paged_metadata.py deleted file mode 100644 index 18be8bf..0000000 --- a/billforward/models/user_creation_response_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class UserCreationResponsePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - UserCreationResponsePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[UserCreationRequest]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this UserCreationResponsePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this UserCreationResponsePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this UserCreationResponsePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this UserCreationResponsePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this UserCreationResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this UserCreationResponsePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this UserCreationResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this UserCreationResponsePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this UserCreationResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this UserCreationResponsePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this UserCreationResponsePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this UserCreationResponsePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this UserCreationResponsePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this UserCreationResponsePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this UserCreationResponsePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this UserCreationResponsePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this UserCreationResponsePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this UserCreationResponsePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this UserCreationResponsePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this UserCreationResponsePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this UserCreationResponsePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this UserCreationResponsePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this UserCreationResponsePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this UserCreationResponsePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this UserCreationResponsePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this UserCreationResponsePagedMetadata. - :rtype: list[UserCreationRequest] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this UserCreationResponsePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this UserCreationResponsePagedMetadata. - :type: list[UserCreationRequest] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/user_invite_request.py b/billforward/models/user_invite_request.py new file mode 100644 index 0000000..402f959 --- /dev/null +++ b/billforward/models/user_invite_request.py @@ -0,0 +1,318 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UserInviteRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'organization_id': 'str', + 'email': 'str', + 'first_name': 'str', + 'last_name': 'str', + 'company_name': 'str', + 'roles': 'list[str]', + 'id': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'organization_id': 'organizationID', + 'email': 'email', + 'first_name': 'firstName', + 'last_name': 'lastName', + 'company_name': 'companyName', + 'roles': 'roles', + 'id': 'id' + } + + def __init__(self, created=None, changed_by=None, organization_id=None, email=None, first_name=None, last_name=None, company_name=None, roles=None, id=None): # noqa: E501 + """UserInviteRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._organization_id = None + self._email = None + self._first_name = None + self._last_name = None + self._company_name = None + self._roles = None + self._id = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if organization_id is not None: + self.organization_id = organization_id + if email is not None: + self.email = email + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if company_name is not None: + self.company_name = company_name + if roles is not None: + self.roles = roles + if id is not None: + self.id = id + + @property + def created(self): + """Gets the created of this UserInviteRequest. # noqa: E501 + + + :return: The created of this UserInviteRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this UserInviteRequest. + + + :param created: The created of this UserInviteRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this UserInviteRequest. # noqa: E501 + + + :return: The changed_by of this UserInviteRequest. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this UserInviteRequest. + + + :param changed_by: The changed_by of this UserInviteRequest. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def organization_id(self): + """Gets the organization_id of this UserInviteRequest. # noqa: E501 + + + :return: The organization_id of this UserInviteRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UserInviteRequest. + + + :param organization_id: The organization_id of this UserInviteRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def email(self): + """Gets the email of this UserInviteRequest. # noqa: E501 + + + :return: The email of this UserInviteRequest. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this UserInviteRequest. + + + :param email: The email of this UserInviteRequest. # noqa: E501 + :type: str + """ + + self._email = email + + @property + def first_name(self): + """Gets the first_name of this UserInviteRequest. # noqa: E501 + + + :return: The first_name of this UserInviteRequest. # noqa: E501 + :rtype: str + """ + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """Sets the first_name of this UserInviteRequest. + + + :param first_name: The first_name of this UserInviteRequest. # noqa: E501 + :type: str + """ + + self._first_name = first_name + + @property + def last_name(self): + """Gets the last_name of this UserInviteRequest. # noqa: E501 + + + :return: The last_name of this UserInviteRequest. # noqa: E501 + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """Sets the last_name of this UserInviteRequest. + + + :param last_name: The last_name of this UserInviteRequest. # noqa: E501 + :type: str + """ + + self._last_name = last_name + + @property + def company_name(self): + """Gets the company_name of this UserInviteRequest. # noqa: E501 + + + :return: The company_name of this UserInviteRequest. # noqa: E501 + :rtype: str + """ + return self._company_name + + @company_name.setter + def company_name(self, company_name): + """Sets the company_name of this UserInviteRequest. + + + :param company_name: The company_name of this UserInviteRequest. # noqa: E501 + :type: str + """ + + self._company_name = company_name + + @property + def roles(self): + """Gets the roles of this UserInviteRequest. # noqa: E501 + + + :return: The roles of this UserInviteRequest. # noqa: E501 + :rtype: list[str] + """ + return self._roles + + @roles.setter + def roles(self, roles): + """Sets the roles of this UserInviteRequest. + + + :param roles: The roles of this UserInviteRequest. # noqa: E501 + :type: list[str] + """ + + self._roles = roles + + @property + def id(self): + """Gets the id of this UserInviteRequest. # noqa: E501 + + + :return: The id of this UserInviteRequest. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this UserInviteRequest. + + + :param id: The id of this UserInviteRequest. # noqa: E501 + :type: str + """ + + self._id = id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UserInviteRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UserInviteRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/user_paged_metadata.py b/billforward/models/user_paged_metadata.py deleted file mode 100644 index 8ce7332..0000000 --- a/billforward/models/user_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class UserPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - UserPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[User]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this UserPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this UserPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this UserPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this UserPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this UserPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this UserPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this UserPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this UserPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this UserPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this UserPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this UserPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this UserPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this UserPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this UserPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this UserPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this UserPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this UserPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this UserPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this UserPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this UserPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this UserPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this UserPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this UserPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this UserPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this UserPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this UserPagedMetadata. - :rtype: list[User] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this UserPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this UserPagedMetadata. - :type: list[User] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/user_private_permanent_token_refresh_request.py b/billforward/models/user_private_permanent_token_refresh_request.py new file mode 100644 index 0000000..9932231 --- /dev/null +++ b/billforward/models/user_private_permanent_token_refresh_request.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UserPrivatePermanentTokenRefreshRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'password': 'str', + 'refresh_token': 'str' + } + + attribute_map = { + 'password': 'password', + 'refresh_token': 'refreshToken' + } + + def __init__(self, password=None, refresh_token=None): # noqa: E501 + """UserPrivatePermanentTokenRefreshRequest - a model defined in Swagger""" # noqa: E501 + self._password = None + self._refresh_token = None + self.discriminator = None + if password is not None: + self.password = password + if refresh_token is not None: + self.refresh_token = refresh_token + + @property + def password(self): + """Gets the password of this UserPrivatePermanentTokenRefreshRequest. # noqa: E501 + + + :return: The password of this UserPrivatePermanentTokenRefreshRequest. # noqa: E501 + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """Sets the password of this UserPrivatePermanentTokenRefreshRequest. + + + :param password: The password of this UserPrivatePermanentTokenRefreshRequest. # noqa: E501 + :type: str + """ + + self._password = password + + @property + def refresh_token(self): + """Gets the refresh_token of this UserPrivatePermanentTokenRefreshRequest. # noqa: E501 + + + :return: The refresh_token of this UserPrivatePermanentTokenRefreshRequest. # noqa: E501 + :rtype: str + """ + return self._refresh_token + + @refresh_token.setter + def refresh_token(self, refresh_token): + """Sets the refresh_token of this UserPrivatePermanentTokenRefreshRequest. + + + :param refresh_token: The refresh_token of this UserPrivatePermanentTokenRefreshRequest. # noqa: E501 + :type: str + """ + + self._refresh_token = refresh_token + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UserPrivatePermanentTokenRefreshRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UserPrivatePermanentTokenRefreshRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/user_private_permanent_token_request.py b/billforward/models/user_private_permanent_token_request.py new file mode 100644 index 0000000..eb96967 --- /dev/null +++ b/billforward/models/user_private_permanent_token_request.py @@ -0,0 +1,136 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UserPrivatePermanentTokenRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'password': 'str', + 'code': 'str' + } + + attribute_map = { + 'password': 'password', + 'code': 'code' + } + + def __init__(self, password=None, code=None): # noqa: E501 + """UserPrivatePermanentTokenRequest - a model defined in Swagger""" # noqa: E501 + self._password = None + self._code = None + self.discriminator = None + if password is not None: + self.password = password + if code is not None: + self.code = code + + @property + def password(self): + """Gets the password of this UserPrivatePermanentTokenRequest. # noqa: E501 + + + :return: The password of this UserPrivatePermanentTokenRequest. # noqa: E501 + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """Sets the password of this UserPrivatePermanentTokenRequest. + + + :param password: The password of this UserPrivatePermanentTokenRequest. # noqa: E501 + :type: str + """ + + self._password = password + + @property + def code(self): + """Gets the code of this UserPrivatePermanentTokenRequest. # noqa: E501 + + + :return: The code of this UserPrivatePermanentTokenRequest. # noqa: E501 + :rtype: str + """ + return self._code + + @code.setter + def code(self, code): + """Sets the code of this UserPrivatePermanentTokenRequest. + + + :param code: The code of this UserPrivatePermanentTokenRequest. # noqa: E501 + :type: str + """ + + self._code = code + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UserPrivatePermanentTokenRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UserPrivatePermanentTokenRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/user_response.py b/billforward/models/user_response.py new file mode 100644 index 0000000..e686d3f --- /dev/null +++ b/billforward/models/user_response.py @@ -0,0 +1,318 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UserResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'enabled': 'bool', + 'updated': 'datetime', + 'id': 'str', + 'username': 'list[UsernameResponse]', + 'password_reset_valid_till': 'datetime', + 'last_successful_login': 'datetime', + 'successful_logins': 'int', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'enabled': 'enabled', + 'updated': 'updated', + 'id': 'id', + 'username': 'username', + 'password_reset_valid_till': 'passwordResetValidTill', + 'last_successful_login': 'lastSuccessfulLogin', + 'successful_logins': 'successfulLogins', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, enabled=None, updated=None, id=None, username=None, password_reset_valid_till=None, last_successful_login=None, successful_logins=None, organization_id=None): # noqa: E501 + """UserResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._enabled = None + self._updated = None + self._id = None + self._username = None + self._password_reset_valid_till = None + self._last_successful_login = None + self._successful_logins = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if enabled is not None: + self.enabled = enabled + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if username is not None: + self.username = username + if password_reset_valid_till is not None: + self.password_reset_valid_till = password_reset_valid_till + if last_successful_login is not None: + self.last_successful_login = last_successful_login + if successful_logins is not None: + self.successful_logins = successful_logins + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this UserResponse. # noqa: E501 + + + :return: The created of this UserResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this UserResponse. + + + :param created: The created of this UserResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def enabled(self): + """Gets the enabled of this UserResponse. # noqa: E501 + + + :return: The enabled of this UserResponse. # noqa: E501 + :rtype: bool + """ + return self._enabled + + @enabled.setter + def enabled(self, enabled): + """Sets the enabled of this UserResponse. + + + :param enabled: The enabled of this UserResponse. # noqa: E501 + :type: bool + """ + + self._enabled = enabled + + @property + def updated(self): + """Gets the updated of this UserResponse. # noqa: E501 + + + :return: The updated of this UserResponse. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this UserResponse. + + + :param updated: The updated of this UserResponse. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this UserResponse. # noqa: E501 + + + :return: The id of this UserResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this UserResponse. + + + :param id: The id of this UserResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def username(self): + """Gets the username of this UserResponse. # noqa: E501 + + + :return: The username of this UserResponse. # noqa: E501 + :rtype: list[UsernameResponse] + """ + return self._username + + @username.setter + def username(self, username): + """Sets the username of this UserResponse. + + + :param username: The username of this UserResponse. # noqa: E501 + :type: list[UsernameResponse] + """ + + self._username = username + + @property + def password_reset_valid_till(self): + """Gets the password_reset_valid_till of this UserResponse. # noqa: E501 + + + :return: The password_reset_valid_till of this UserResponse. # noqa: E501 + :rtype: datetime + """ + return self._password_reset_valid_till + + @password_reset_valid_till.setter + def password_reset_valid_till(self, password_reset_valid_till): + """Sets the password_reset_valid_till of this UserResponse. + + + :param password_reset_valid_till: The password_reset_valid_till of this UserResponse. # noqa: E501 + :type: datetime + """ + + self._password_reset_valid_till = password_reset_valid_till + + @property + def last_successful_login(self): + """Gets the last_successful_login of this UserResponse. # noqa: E501 + + + :return: The last_successful_login of this UserResponse. # noqa: E501 + :rtype: datetime + """ + return self._last_successful_login + + @last_successful_login.setter + def last_successful_login(self, last_successful_login): + """Sets the last_successful_login of this UserResponse. + + + :param last_successful_login: The last_successful_login of this UserResponse. # noqa: E501 + :type: datetime + """ + + self._last_successful_login = last_successful_login + + @property + def successful_logins(self): + """Gets the successful_logins of this UserResponse. # noqa: E501 + + + :return: The successful_logins of this UserResponse. # noqa: E501 + :rtype: int + """ + return self._successful_logins + + @successful_logins.setter + def successful_logins(self, successful_logins): + """Sets the successful_logins of this UserResponse. + + + :param successful_logins: The successful_logins of this UserResponse. # noqa: E501 + :type: int + """ + + self._successful_logins = successful_logins + + @property + def organization_id(self): + """Gets the organization_id of this UserResponse. # noqa: E501 + + + :return: The organization_id of this UserResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UserResponse. + + + :param organization_id: The organization_id of this UserResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UserResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UserResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/user_timezone.py b/billforward/models/user_timezone.py new file mode 100644 index 0000000..421562b --- /dev/null +++ b/billforward/models/user_timezone.py @@ -0,0 +1,188 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UserTimezone(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'display_name': 'str', + 'id': 'str', + 'dstsavings': 'int', + 'raw_offset': 'int' + } + + attribute_map = { + 'display_name': 'displayName', + 'id': 'id', + 'dstsavings': 'dstsavings', + 'raw_offset': 'rawOffset' + } + + def __init__(self, display_name=None, id=None, dstsavings=None, raw_offset=None): # noqa: E501 + """UserTimezone - a model defined in Swagger""" # noqa: E501 + self._display_name = None + self._id = None + self._dstsavings = None + self._raw_offset = None + self.discriminator = None + if display_name is not None: + self.display_name = display_name + if id is not None: + self.id = id + if dstsavings is not None: + self.dstsavings = dstsavings + if raw_offset is not None: + self.raw_offset = raw_offset + + @property + def display_name(self): + """Gets the display_name of this UserTimezone. # noqa: E501 + + + :return: The display_name of this UserTimezone. # noqa: E501 + :rtype: str + """ + return self._display_name + + @display_name.setter + def display_name(self, display_name): + """Sets the display_name of this UserTimezone. + + + :param display_name: The display_name of this UserTimezone. # noqa: E501 + :type: str + """ + + self._display_name = display_name + + @property + def id(self): + """Gets the id of this UserTimezone. # noqa: E501 + + + :return: The id of this UserTimezone. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this UserTimezone. + + + :param id: The id of this UserTimezone. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def dstsavings(self): + """Gets the dstsavings of this UserTimezone. # noqa: E501 + + + :return: The dstsavings of this UserTimezone. # noqa: E501 + :rtype: int + """ + return self._dstsavings + + @dstsavings.setter + def dstsavings(self, dstsavings): + """Sets the dstsavings of this UserTimezone. + + + :param dstsavings: The dstsavings of this UserTimezone. # noqa: E501 + :type: int + """ + + self._dstsavings = dstsavings + + @property + def raw_offset(self): + """Gets the raw_offset of this UserTimezone. # noqa: E501 + + + :return: The raw_offset of this UserTimezone. # noqa: E501 + :rtype: int + """ + return self._raw_offset + + @raw_offset.setter + def raw_offset(self, raw_offset): + """Sets the raw_offset of this UserTimezone. + + + :param raw_offset: The raw_offset of this UserTimezone. # noqa: E501 + :type: int + """ + + self._raw_offset = raw_offset + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UserTimezone, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UserTimezone): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/username.py b/billforward/models/username.py index 358cf78..8d59032 100644 --- a/billforward/models/username.py +++ b/billforward/models/username.py @@ -1,88 +1,105 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -from pprint import pformat -from six import iteritems -import re +import pprint +import re # noqa: F401 +import six class Username(object): - """ - NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. """ - def __init__(self, created=None, changed_by=None, id=None, user_id=None, organization_id=None, username=None): - """ - Username - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'created': 'datetime', - 'changed_by': 'str', - 'id': 'str', - 'user_id': 'str', - 'organization_id': 'str', - 'username': 'str' - } - - self.attribute_map = { - 'created': 'created', - 'changed_by': 'changedBy', - 'id': 'id', - 'user_id': 'userID', - 'organization_id': 'organizationID', - 'username': 'username' - } - - self._created = created - self._changed_by = changed_by - self._id = id - self._user_id = user_id - self._organization_id = organization_id - self._username = username + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'id': 'str', + 'user_id': 'str', + 'organization_id': 'str', + 'username': 'str', + 'first_name': 'str', + 'last_name': 'str', + 'profile_picture': 'str', + 'email': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'id': 'id', + 'user_id': 'userID', + 'organization_id': 'organizationID', + 'username': 'username', + 'first_name': 'firstName', + 'last_name': 'lastName', + 'profile_picture': 'profilePicture', + 'email': 'email' + } + + def __init__(self, created=None, changed_by=None, id=None, user_id=None, organization_id=None, username=None, first_name=None, last_name=None, profile_picture=None, email=None): # noqa: E501 + """Username - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._id = None + self._user_id = None + self._organization_id = None + self._username = None + self._first_name = None + self._last_name = None + self._profile_picture = None + self._email = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if id is not None: + self.id = id + self.user_id = user_id + self.organization_id = organization_id + self.username = username + if first_name is not None: + self.first_name = first_name + if last_name is not None: + self.last_name = last_name + if profile_picture is not None: + self.profile_picture = profile_picture + if email is not None: + self.email = email @property def created(self): - """ - Gets the created of this Username. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Gets the created of this Username. # noqa: E501 - :return: The created of this Username. + + :return: The created of this Username. # noqa: E501 :rtype: datetime """ return self._created @created.setter def created(self, created): - """ - Sets the created of this Username. - { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } + """Sets the created of this Username. + - :param created: The created of this Username. + :param created: The created of this Username. # noqa: E501 :type: datetime """ @@ -90,22 +107,20 @@ def created(self, created): @property def changed_by(self): - """ - Gets the changed_by of this Username. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Gets the changed_by of this Username. # noqa: E501 + - :return: The changed_by of this Username. + :return: The changed_by of this Username. # noqa: E501 :rtype: str """ return self._changed_by @changed_by.setter def changed_by(self, changed_by): - """ - Sets the changed_by of this Username. - { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } + """Sets the changed_by of this Username. - :param changed_by: The changed_by of this Username. + + :param changed_by: The changed_by of this Username. # noqa: E501 :type: str """ @@ -113,22 +128,20 @@ def changed_by(self, changed_by): @property def id(self): - """ - Gets the id of this Username. - { \"description\" : \"id of the username.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the id of this Username. # noqa: E501 + - :return: The id of this Username. + :return: The id of this Username. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): - """ - Sets the id of this Username. - { \"description\" : \"id of the username.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the id of this Username. + - :param id: The id of this Username. + :param id: The id of this Username. # noqa: E501 :type: str """ @@ -136,80 +149,162 @@ def id(self, id): @property def user_id(self): - """ - Gets the user_id of this Username. - { \"description\" : \"User associated with the username.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the user_id of this Username. # noqa: E501 - :return: The user_id of this Username. + + :return: The user_id of this Username. # noqa: E501 :rtype: str """ return self._user_id @user_id.setter def user_id(self, user_id): - """ - Sets the user_id of this Username. - { \"description\" : \"User associated with the username.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the user_id of this Username. + - :param user_id: The user_id of this Username. + :param user_id: The user_id of this Username. # noqa: E501 :type: str """ + if user_id is None: + raise ValueError("Invalid value for `user_id`, must not be `None`") # noqa: E501 self._user_id = user_id @property def organization_id(self): - """ - Gets the organization_id of this Username. - { \"description\" : \"Organization associated of the user\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the organization_id of this Username. # noqa: E501 + - :return: The organization_id of this Username. + :return: The organization_id of this Username. # noqa: E501 :rtype: str """ return self._organization_id @organization_id.setter def organization_id(self, organization_id): - """ - Sets the organization_id of this Username. - { \"description\" : \"Organization associated of the user\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the organization_id of this Username. - :param organization_id: The organization_id of this Username. + + :param organization_id: The organization_id of this Username. # noqa: E501 :type: str """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 self._organization_id = organization_id @property def username(self): - """ - Gets the username of this Username. - { \"description\" : \"The username.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Gets the username of this Username. # noqa: E501 + - :return: The username of this Username. + :return: The username of this Username. # noqa: E501 :rtype: str """ return self._username @username.setter def username(self, username): - """ - Sets the username of this Username. - { \"description\" : \"The username.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } + """Sets the username of this Username. + - :param username: The username of this Username. + :param username: The username of this Username. # noqa: E501 :type: str """ + if username is None: + raise ValueError("Invalid value for `username`, must not be `None`") # noqa: E501 self._username = username - def to_dict(self): + @property + def first_name(self): + """Gets the first_name of this Username. # noqa: E501 + + + :return: The first_name of this Username. # noqa: E501 + :rtype: str """ - Returns the model properties as a dict + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """Sets the first_name of this Username. + + + :param first_name: The first_name of this Username. # noqa: E501 + :type: str """ + + self._first_name = first_name + + @property + def last_name(self): + """Gets the last_name of this Username. # noqa: E501 + + + :return: The last_name of this Username. # noqa: E501 + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """Sets the last_name of this Username. + + + :param last_name: The last_name of this Username. # noqa: E501 + :type: str + """ + + self._last_name = last_name + + @property + def profile_picture(self): + """Gets the profile_picture of this Username. # noqa: E501 + + + :return: The profile_picture of this Username. # noqa: E501 + :rtype: str + """ + return self._profile_picture + + @profile_picture.setter + def profile_picture(self, profile_picture): + """Sets the profile_picture of this Username. + + + :param profile_picture: The profile_picture of this Username. # noqa: E501 + :type: str + """ + + self._profile_picture = profile_picture + + @property + def email(self): + """Gets the email of this Username. # noqa: E501 + + + :return: The email of this Username. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this Username. + + + :param email: The email of this Username. # noqa: E501 + :type: str + """ + + self._email = email + + def to_dict(self): + """Returns the model properties as a dict""" result = {} - for attr, _ in iteritems(self.swagger_types): + for attr, _ in six.iteritems(self.swagger_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( @@ -226,29 +321,27 @@ def to_dict(self): )) else: result[attr] = value + if issubclass(Username, dict): + for key, value in self.items(): + result[key] = value return result def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) def __repr__(self): - """ - For `print` and `pprint` - """ + """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): - """ - Returns true if both objects are equal - """ + """Returns true if both objects are equal""" + if not isinstance(other, Username): + return False + return self.__dict__ == other.__dict__ def __ne__(self, other): - """ - Returns true if both objects are not equal - """ + """Returns true if both objects are not equal""" return not self == other diff --git a/billforward/models/username_paged_metadata.py b/billforward/models/username_paged_metadata.py deleted file mode 100644 index 8dd5631..0000000 --- a/billforward/models/username_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class UsernamePagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - UsernamePagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[Username]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this UsernamePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this UsernamePagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this UsernamePagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this UsernamePagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this UsernamePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this UsernamePagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this UsernamePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this UsernamePagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this UsernamePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this UsernamePagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this UsernamePagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this UsernamePagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this UsernamePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this UsernamePagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this UsernamePagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this UsernamePagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this UsernamePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this UsernamePagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this UsernamePagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this UsernamePagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this UsernamePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this UsernamePagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this UsernamePagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this UsernamePagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this UsernamePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this UsernamePagedMetadata. - :rtype: list[Username] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this UsernamePagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this UsernamePagedMetadata. - :type: list[Username] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/username_response.py b/billforward/models/username_response.py new file mode 100644 index 0000000..e3c2365 --- /dev/null +++ b/billforward/models/username_response.py @@ -0,0 +1,344 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class UsernameResponse(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'id': 'str', + 'username': 'str', + 'last_name': 'str', + 'user_id': 'str', + 'first_name': 'str', + 'email': 'str', + 'profile_picture': 'str', + 'organization_id': 'str', + 'two_fa': 'bool' + } + + attribute_map = { + 'created': 'created', + 'id': 'id', + 'username': 'username', + 'last_name': 'lastName', + 'user_id': 'userID', + 'first_name': 'firstName', + 'email': 'email', + 'profile_picture': 'profilePicture', + 'organization_id': 'organizationID', + 'two_fa': 'twoFA' + } + + def __init__(self, created=None, id=None, username=None, last_name=None, user_id=None, first_name=None, email=None, profile_picture=None, organization_id=None, two_fa=None): # noqa: E501 + """UsernameResponse - a model defined in Swagger""" # noqa: E501 + self._created = None + self._id = None + self._username = None + self._last_name = None + self._user_id = None + self._first_name = None + self._email = None + self._profile_picture = None + self._organization_id = None + self._two_fa = None + self.discriminator = None + if created is not None: + self.created = created + if id is not None: + self.id = id + if username is not None: + self.username = username + if last_name is not None: + self.last_name = last_name + if user_id is not None: + self.user_id = user_id + if first_name is not None: + self.first_name = first_name + if email is not None: + self.email = email + if profile_picture is not None: + self.profile_picture = profile_picture + if organization_id is not None: + self.organization_id = organization_id + if two_fa is not None: + self.two_fa = two_fa + + @property + def created(self): + """Gets the created of this UsernameResponse. # noqa: E501 + + + :return: The created of this UsernameResponse. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this UsernameResponse. + + + :param created: The created of this UsernameResponse. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def id(self): + """Gets the id of this UsernameResponse. # noqa: E501 + + + :return: The id of this UsernameResponse. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this UsernameResponse. + + + :param id: The id of this UsernameResponse. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def username(self): + """Gets the username of this UsernameResponse. # noqa: E501 + + + :return: The username of this UsernameResponse. # noqa: E501 + :rtype: str + """ + return self._username + + @username.setter + def username(self, username): + """Sets the username of this UsernameResponse. + + + :param username: The username of this UsernameResponse. # noqa: E501 + :type: str + """ + + self._username = username + + @property + def last_name(self): + """Gets the last_name of this UsernameResponse. # noqa: E501 + + + :return: The last_name of this UsernameResponse. # noqa: E501 + :rtype: str + """ + return self._last_name + + @last_name.setter + def last_name(self, last_name): + """Sets the last_name of this UsernameResponse. + + + :param last_name: The last_name of this UsernameResponse. # noqa: E501 + :type: str + """ + + self._last_name = last_name + + @property + def user_id(self): + """Gets the user_id of this UsernameResponse. # noqa: E501 + + + :return: The user_id of this UsernameResponse. # noqa: E501 + :rtype: str + """ + return self._user_id + + @user_id.setter + def user_id(self, user_id): + """Sets the user_id of this UsernameResponse. + + + :param user_id: The user_id of this UsernameResponse. # noqa: E501 + :type: str + """ + + self._user_id = user_id + + @property + def first_name(self): + """Gets the first_name of this UsernameResponse. # noqa: E501 + + + :return: The first_name of this UsernameResponse. # noqa: E501 + :rtype: str + """ + return self._first_name + + @first_name.setter + def first_name(self, first_name): + """Sets the first_name of this UsernameResponse. + + + :param first_name: The first_name of this UsernameResponse. # noqa: E501 + :type: str + """ + + self._first_name = first_name + + @property + def email(self): + """Gets the email of this UsernameResponse. # noqa: E501 + + + :return: The email of this UsernameResponse. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this UsernameResponse. + + + :param email: The email of this UsernameResponse. # noqa: E501 + :type: str + """ + + self._email = email + + @property + def profile_picture(self): + """Gets the profile_picture of this UsernameResponse. # noqa: E501 + + + :return: The profile_picture of this UsernameResponse. # noqa: E501 + :rtype: str + """ + return self._profile_picture + + @profile_picture.setter + def profile_picture(self, profile_picture): + """Sets the profile_picture of this UsernameResponse. + + + :param profile_picture: The profile_picture of this UsernameResponse. # noqa: E501 + :type: str + """ + + self._profile_picture = profile_picture + + @property + def organization_id(self): + """Gets the organization_id of this UsernameResponse. # noqa: E501 + + + :return: The organization_id of this UsernameResponse. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this UsernameResponse. + + + :param organization_id: The organization_id of this UsernameResponse. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def two_fa(self): + """Gets the two_fa of this UsernameResponse. # noqa: E501 + + + :return: The two_fa of this UsernameResponse. # noqa: E501 + :rtype: bool + """ + return self._two_fa + + @two_fa.setter + def two_fa(self, two_fa): + """Sets the two_fa of this UsernameResponse. + + + :param two_fa: The two_fa of this UsernameResponse. # noqa: E501 + :type: bool + """ + + self._two_fa = two_fa + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(UsernameResponse, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, UsernameResponse): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/value_increment.py b/billforward/models/value_increment.py new file mode 100644 index 0000000..3e85590 --- /dev/null +++ b/billforward/models/value_increment.py @@ -0,0 +1,138 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class ValueIncrement(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'pricing_component': 'str', + 'increment_by': 'int' + } + + attribute_map = { + 'pricing_component': 'pricingComponent', + 'increment_by': 'incrementBy' + } + + def __init__(self, pricing_component=None, increment_by=None): # noqa: E501 + """ValueIncrement - a model defined in Swagger""" # noqa: E501 + self._pricing_component = None + self._increment_by = None + self.discriminator = None + self.pricing_component = pricing_component + self.increment_by = increment_by + + @property + def pricing_component(self): + """Gets the pricing_component of this ValueIncrement. # noqa: E501 + + + :return: The pricing_component of this ValueIncrement. # noqa: E501 + :rtype: str + """ + return self._pricing_component + + @pricing_component.setter + def pricing_component(self, pricing_component): + """Sets the pricing_component of this ValueIncrement. + + + :param pricing_component: The pricing_component of this ValueIncrement. # noqa: E501 + :type: str + """ + if pricing_component is None: + raise ValueError("Invalid value for `pricing_component`, must not be `None`") # noqa: E501 + + self._pricing_component = pricing_component + + @property + def increment_by(self): + """Gets the increment_by of this ValueIncrement. # noqa: E501 + + + :return: The increment_by of this ValueIncrement. # noqa: E501 + :rtype: int + """ + return self._increment_by + + @increment_by.setter + def increment_by(self, increment_by): + """Sets the increment_by of this ValueIncrement. + + + :param increment_by: The increment_by of this ValueIncrement. # noqa: E501 + :type: int + """ + if increment_by is None: + raise ValueError("Invalid value for `increment_by`, must not be `None`") # noqa: E501 + + self._increment_by = increment_by + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ValueIncrement, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ValueIncrement): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/verify_payment_method_request.py b/billforward/models/verify_payment_method_request.py new file mode 100644 index 0000000..3811c03 --- /dev/null +++ b/billforward/models/verify_payment_method_request.py @@ -0,0 +1,162 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class VerifyPaymentMethodRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'amounts': 'list[int]', + 'organization_id': 'str' + } + + attribute_map = { + 'created': 'created', + 'amounts': 'amounts', + 'organization_id': 'organizationID' + } + + def __init__(self, created=None, amounts=None, organization_id=None): # noqa: E501 + """VerifyPaymentMethodRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._amounts = None + self._organization_id = None + self.discriminator = None + if created is not None: + self.created = created + if amounts is not None: + self.amounts = amounts + if organization_id is not None: + self.organization_id = organization_id + + @property + def created(self): + """Gets the created of this VerifyPaymentMethodRequest. # noqa: E501 + + + :return: The created of this VerifyPaymentMethodRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this VerifyPaymentMethodRequest. + + + :param created: The created of this VerifyPaymentMethodRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def amounts(self): + """Gets the amounts of this VerifyPaymentMethodRequest. # noqa: E501 + + + :return: The amounts of this VerifyPaymentMethodRequest. # noqa: E501 + :rtype: list[int] + """ + return self._amounts + + @amounts.setter + def amounts(self, amounts): + """Sets the amounts of this VerifyPaymentMethodRequest. + + + :param amounts: The amounts of this VerifyPaymentMethodRequest. # noqa: E501 + :type: list[int] + """ + + self._amounts = amounts + + @property + def organization_id(self): + """Gets the organization_id of this VerifyPaymentMethodRequest. # noqa: E501 + + + :return: The organization_id of this VerifyPaymentMethodRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this VerifyPaymentMethodRequest. + + + :param organization_id: The organization_id of this VerifyPaymentMethodRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(VerifyPaymentMethodRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, VerifyPaymentMethodRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/webhook.py b/billforward/models/webhook.py new file mode 100644 index 0000000..a99b66e --- /dev/null +++ b/billforward/models/webhook.py @@ -0,0 +1,422 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class Webhook(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'organization_id': 'str', + 'name': 'str', + 'consecutive_failures': 'int', + 'deleted': 'bool', + 'temporarily_inactive_until': 'datetime', + 'inactive_level': 'int', + 'webhook_subscriptions': 'list[WebhookSubscription]', + 'url': 'str', + 'url': 'str' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'organization_id': 'organizationID', + 'name': 'name', + 'consecutive_failures': 'consecutiveFailures', + 'deleted': 'deleted', + 'temporarily_inactive_until': 'temporarilyInactiveUntil', + 'inactive_level': 'inactiveLevel', + 'webhook_subscriptions': 'webhookSubscriptions', + 'url': 'url', + 'url': 'URL' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, name=None, consecutive_failures=None, deleted=None, temporarily_inactive_until=None, inactive_level=None, webhook_subscriptions=None, url=None, url=None): # noqa: E501 + """Webhook - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._organization_id = None + self._name = None + self._consecutive_failures = None + self._deleted = None + self._temporarily_inactive_until = None + self._inactive_level = None + self._webhook_subscriptions = None + self._url = None + self._url = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + if id is not None: + self.id = id + if organization_id is not None: + self.organization_id = organization_id + if name is not None: + self.name = name + if consecutive_failures is not None: + self.consecutive_failures = consecutive_failures + if deleted is not None: + self.deleted = deleted + if temporarily_inactive_until is not None: + self.temporarily_inactive_until = temporarily_inactive_until + if inactive_level is not None: + self.inactive_level = inactive_level + if webhook_subscriptions is not None: + self.webhook_subscriptions = webhook_subscriptions + if url is not None: + self.url = url + if url is not None: + self.url = url + + @property + def created(self): + """Gets the created of this Webhook. # noqa: E501 + + + :return: The created of this Webhook. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this Webhook. + + + :param created: The created of this Webhook. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this Webhook. # noqa: E501 + + + :return: The changed_by of this Webhook. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this Webhook. + + + :param changed_by: The changed_by of this Webhook. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this Webhook. # noqa: E501 + + + :return: The updated of this Webhook. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this Webhook. + + + :param updated: The updated of this Webhook. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this Webhook. # noqa: E501 + + + :return: The id of this Webhook. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this Webhook. + + + :param id: The id of this Webhook. # noqa: E501 + :type: str + """ + + self._id = id + + @property + def organization_id(self): + """Gets the organization_id of this Webhook. # noqa: E501 + + + :return: The organization_id of this Webhook. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this Webhook. + + + :param organization_id: The organization_id of this Webhook. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def name(self): + """Gets the name of this Webhook. # noqa: E501 + + + :return: The name of this Webhook. # noqa: E501 + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """Sets the name of this Webhook. + + + :param name: The name of this Webhook. # noqa: E501 + :type: str + """ + + self._name = name + + @property + def consecutive_failures(self): + """Gets the consecutive_failures of this Webhook. # noqa: E501 + + + :return: The consecutive_failures of this Webhook. # noqa: E501 + :rtype: int + """ + return self._consecutive_failures + + @consecutive_failures.setter + def consecutive_failures(self, consecutive_failures): + """Sets the consecutive_failures of this Webhook. + + + :param consecutive_failures: The consecutive_failures of this Webhook. # noqa: E501 + :type: int + """ + + self._consecutive_failures = consecutive_failures + + @property + def deleted(self): + """Gets the deleted of this Webhook. # noqa: E501 + + + :return: The deleted of this Webhook. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this Webhook. + + + :param deleted: The deleted of this Webhook. # noqa: E501 + :type: bool + """ + + self._deleted = deleted + + @property + def temporarily_inactive_until(self): + """Gets the temporarily_inactive_until of this Webhook. # noqa: E501 + + + :return: The temporarily_inactive_until of this Webhook. # noqa: E501 + :rtype: datetime + """ + return self._temporarily_inactive_until + + @temporarily_inactive_until.setter + def temporarily_inactive_until(self, temporarily_inactive_until): + """Sets the temporarily_inactive_until of this Webhook. + + + :param temporarily_inactive_until: The temporarily_inactive_until of this Webhook. # noqa: E501 + :type: datetime + """ + + self._temporarily_inactive_until = temporarily_inactive_until + + @property + def inactive_level(self): + """Gets the inactive_level of this Webhook. # noqa: E501 + + + :return: The inactive_level of this Webhook. # noqa: E501 + :rtype: int + """ + return self._inactive_level + + @inactive_level.setter + def inactive_level(self, inactive_level): + """Sets the inactive_level of this Webhook. + + + :param inactive_level: The inactive_level of this Webhook. # noqa: E501 + :type: int + """ + + self._inactive_level = inactive_level + + @property + def webhook_subscriptions(self): + """Gets the webhook_subscriptions of this Webhook. # noqa: E501 + + + :return: The webhook_subscriptions of this Webhook. # noqa: E501 + :rtype: list[WebhookSubscription] + """ + return self._webhook_subscriptions + + @webhook_subscriptions.setter + def webhook_subscriptions(self, webhook_subscriptions): + """Sets the webhook_subscriptions of this Webhook. + + + :param webhook_subscriptions: The webhook_subscriptions of this Webhook. # noqa: E501 + :type: list[WebhookSubscription] + """ + + self._webhook_subscriptions = webhook_subscriptions + + @property + def url(self): + """Gets the url of this Webhook. # noqa: E501 + + + :return: The url of this Webhook. # noqa: E501 + :rtype: str + """ + return self._url + + @url.setter + def url(self, url): + """Sets the url of this Webhook. + + + :param url: The url of this Webhook. # noqa: E501 + :type: str + """ + + self._url = url + + @property + def url(self): + """Gets the url of this Webhook. # noqa: E501 + + + :return: The url of this Webhook. # noqa: E501 + :rtype: str + """ + return self._url + + @url.setter + def url(self, url): + """Sets the url of this Webhook. + + + :param url: The url of this Webhook. # noqa: E501 + :type: str + """ + + self._url = url + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(Webhook, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, Webhook): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/webhook_paged_metadata.py b/billforward/models/webhook_paged_metadata.py deleted file mode 100644 index 92d225f..0000000 --- a/billforward/models/webhook_paged_metadata.py +++ /dev/null @@ -1,280 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from pprint import pformat -from six import iteritems -import re - - -class WebhookPagedMetadata(object): - """ - NOTE: This class is auto generated by the swagger code generator program. - Do not edit the class manually. - """ - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, execution_time=None, results=None): - """ - WebhookPagedMetadata - a model defined in Swagger - - :param dict swaggerTypes: The key is attribute name - and the value is attribute type. - :param dict attributeMap: The key is attribute name - and the value is json key in definition. - """ - self.swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'execution_time': 'int', - 'results': 'list[MutableBillingEntity]' - } - - self.attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'execution_time': 'executionTime', - 'results': 'results' - } - - self._next_page = next_page - self._current_page = current_page - self._current_offset = current_offset - self._records_requested = records_requested - self._records_returned = records_returned - self._execution_time = execution_time - self._results = results - - @property - def next_page(self): - """ - Gets the next_page of this WebhookPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The next_page of this WebhookPagedMetadata. - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """ - Sets the next_page of this WebhookPagedMetadata. - {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param next_page: The next_page of this WebhookPagedMetadata. - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """ - Gets the current_page of this WebhookPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_page of this WebhookPagedMetadata. - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """ - Sets the current_page of this WebhookPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_page: The current_page of this WebhookPagedMetadata. - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """ - Gets the current_offset of this WebhookPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The current_offset of this WebhookPagedMetadata. - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """ - Sets the current_offset of this WebhookPagedMetadata. - {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param current_offset: The current_offset of this WebhookPagedMetadata. - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """ - Gets the records_requested of this WebhookPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_requested of this WebhookPagedMetadata. - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """ - Sets the records_requested of this WebhookPagedMetadata. - {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_requested: The records_requested of this WebhookPagedMetadata. - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """ - Gets the records_returned of this WebhookPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The records_returned of this WebhookPagedMetadata. - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """ - Sets the records_returned of this WebhookPagedMetadata. - {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param records_returned: The records_returned of this WebhookPagedMetadata. - :type: int - """ - - self._records_returned = records_returned - - @property - def execution_time(self): - """ - Gets the execution_time of this WebhookPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The execution_time of this WebhookPagedMetadata. - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """ - Sets the execution_time of this WebhookPagedMetadata. - {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param execution_time: The execution_time of this WebhookPagedMetadata. - :type: int - """ - - self._execution_time = execution_time - - @property - def results(self): - """ - Gets the results of this WebhookPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :return: The results of this WebhookPagedMetadata. - :rtype: list[MutableBillingEntity] - """ - return self._results - - @results.setter - def results(self, results): - """ - Sets the results of this WebhookPagedMetadata. - {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} - - :param results: The results of this WebhookPagedMetadata. - :type: list[MutableBillingEntity] - """ - - self._results = results - - def to_dict(self): - """ - Returns the model properties as a dict - """ - result = {} - - for attr, _ in iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - - return result - - def to_str(self): - """ - Returns the string representation of the model - """ - return pformat(self.to_dict()) - - def __repr__(self): - """ - For `print` and `pprint` - """ - return self.to_str() - - def __eq__(self, other): - """ - Returns true if both objects are equal - """ - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """ - Returns true if both objects are not equal - """ - return not self == other diff --git a/billforward/models/webhook_subscription.py b/billforward/models/webhook_subscription.py new file mode 100644 index 0000000..5e06df6 --- /dev/null +++ b/billforward/models/webhook_subscription.py @@ -0,0 +1,336 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class WebhookSubscription(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'changed_by': 'str', + 'updated': 'datetime', + 'id': 'str', + 'webhook_id': 'str', + 'organization_id': 'str', + 'domain': 'str', + 'action': 'str', + 'deleted': 'bool' + } + + attribute_map = { + 'created': 'created', + 'changed_by': 'changedBy', + 'updated': 'updated', + 'id': 'id', + 'webhook_id': 'webhookID', + 'organization_id': 'organizationID', + 'domain': 'domain', + 'action': 'action', + 'deleted': 'deleted' + } + + def __init__(self, created=None, changed_by=None, updated=None, id=None, webhook_id=None, organization_id=None, domain=None, action=None, deleted=None): # noqa: E501 + """WebhookSubscription - a model defined in Swagger""" # noqa: E501 + self._created = None + self._changed_by = None + self._updated = None + self._id = None + self._webhook_id = None + self._organization_id = None + self._domain = None + self._action = None + self._deleted = None + self.discriminator = None + if created is not None: + self.created = created + if changed_by is not None: + self.changed_by = changed_by + if updated is not None: + self.updated = updated + self.id = id + self.webhook_id = webhook_id + self.organization_id = organization_id + self.domain = domain + self.action = action + self.deleted = deleted + + @property + def created(self): + """Gets the created of this WebhookSubscription. # noqa: E501 + + + :return: The created of this WebhookSubscription. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this WebhookSubscription. + + + :param created: The created of this WebhookSubscription. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def changed_by(self): + """Gets the changed_by of this WebhookSubscription. # noqa: E501 + + + :return: The changed_by of this WebhookSubscription. # noqa: E501 + :rtype: str + """ + return self._changed_by + + @changed_by.setter + def changed_by(self, changed_by): + """Sets the changed_by of this WebhookSubscription. + + + :param changed_by: The changed_by of this WebhookSubscription. # noqa: E501 + :type: str + """ + + self._changed_by = changed_by + + @property + def updated(self): + """Gets the updated of this WebhookSubscription. # noqa: E501 + + + :return: The updated of this WebhookSubscription. # noqa: E501 + :rtype: datetime + """ + return self._updated + + @updated.setter + def updated(self, updated): + """Sets the updated of this WebhookSubscription. + + + :param updated: The updated of this WebhookSubscription. # noqa: E501 + :type: datetime + """ + + self._updated = updated + + @property + def id(self): + """Gets the id of this WebhookSubscription. # noqa: E501 + + + :return: The id of this WebhookSubscription. # noqa: E501 + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """Sets the id of this WebhookSubscription. + + + :param id: The id of this WebhookSubscription. # noqa: E501 + :type: str + """ + if id is None: + raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 + + self._id = id + + @property + def webhook_id(self): + """Gets the webhook_id of this WebhookSubscription. # noqa: E501 + + + :return: The webhook_id of this WebhookSubscription. # noqa: E501 + :rtype: str + """ + return self._webhook_id + + @webhook_id.setter + def webhook_id(self, webhook_id): + """Sets the webhook_id of this WebhookSubscription. + + + :param webhook_id: The webhook_id of this WebhookSubscription. # noqa: E501 + :type: str + """ + if webhook_id is None: + raise ValueError("Invalid value for `webhook_id`, must not be `None`") # noqa: E501 + + self._webhook_id = webhook_id + + @property + def organization_id(self): + """Gets the organization_id of this WebhookSubscription. # noqa: E501 + + + :return: The organization_id of this WebhookSubscription. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this WebhookSubscription. + + + :param organization_id: The organization_id of this WebhookSubscription. # noqa: E501 + :type: str + """ + if organization_id is None: + raise ValueError("Invalid value for `organization_id`, must not be `None`") # noqa: E501 + + self._organization_id = organization_id + + @property + def domain(self): + """Gets the domain of this WebhookSubscription. # noqa: E501 + + + :return: The domain of this WebhookSubscription. # noqa: E501 + :rtype: str + """ + return self._domain + + @domain.setter + def domain(self, domain): + """Sets the domain of this WebhookSubscription. + + + :param domain: The domain of this WebhookSubscription. # noqa: E501 + :type: str + """ + if domain is None: + raise ValueError("Invalid value for `domain`, must not be `None`") # noqa: E501 + allowed_values = ["AvataxConfiguration", "Notification", "Organization", "Product", "User", "Subscription", "Profile", "ProductRatePlan", "Client", "Invoice", "PricingComponentValue", "Account", "PricingComponentValueChange", "PricingComponentTier", "PricingComponent", "PricingCalculation", "CouponDefinition", "CouponInstance", "CouponModifier", "CouponRule", "CouponBookDefinition", "CouponBook", "InvoiceLine", "Webhook", "SubscriptionCancellation", "NotificationSnapshot", "InvoicePayment", "InvoiceLinePayment", "Payment", "PaymentMethod", "BankAccount", "PaymentMethodSubscriptionLink", "DunningLine", "CybersourceToken", "Card", "Alias", "CouponInstanceExistingValue", "TaxLine", "TaxationStrategy", "TaxationLink", "Address", "AmendmentPriceNTime", "Authority", "UnitOfMeasure", "Amendment", "AuditLog", "Password", "Username", "FixedTermDefinition", "FixedTerm", "Refund", "CreditNote", "Receipt", "AmendmentCompoundConstituent", "APIConfiguration", "StripeToken", "BraintreeToken", "PaypalToken", "AuthorizeNetToken", "SpreedlyToken", "AmendmentDiscardAmendment", "CancellationAmendment", "CompoundAmendment", "CompoundAmendmentConstituent", "FixedTermExpiryAmendment", "InvoiceNextExecutionAttemptAmendment", "PricingComponentValueAmendment", "BraintreeMerchantAccount", "WebhookSubscription", "Migration", "SubscriptionCharge", "StripeACHToken", "OfflinePayment", "CreditNotePayment", "CardVaultPayment", "BraintreePayment", "CybersourcePayment", "PaypalPayment", "StripeACHPayment", "AuthorizeNetPayment", "PricingComponentValueMigrationChargeAmendmentMapping", "ComponentChange", "QuoteRequest", "Quote", "CouponCharge", "CouponInstanceInvoiceLink", "Coupon", "CouponDiscount", "CouponUniqueCodesRequest", "CouponUniqueCodesResponse", "GetCouponsResponse", "AddCouponCodeRequest", "AddCouponCodeResponse", "RemoveCouponFromSubscriptionRequest", "TokenizationPreAuth", "StripeTokenizationPreAuth", "BraintreeTokenizationPreAuth", "SpreedlyTokenizationPreAuth", "SagePayTokenizationPreAuth", "PayVisionTokenizationPreAuth", "TokenizationPreAuthRequest", "AuthCaptureRequest", "StripeACHBankAccountVerification", "PasswordReset", "PricingRequest", "AmendmentPriceRequest", "AddTaxationStrategyRequest", "AddPaymentMethodRequest", "APIRequest", "SagePayToken", "SagePayNotificationRequest", "SagePayNotificationResponse", "SagePayOutstandingTransaction", "SagePayEnabledCardType", "TrustCommerceToken", "SagePayTransaction", "PricingComponentValueResponse", "MigrationResponse", "TimeResponse", "EntityTime", "Email", "MarketplaceConfiguration", "BFPermission", "Role", "PermissionLink", "PayVisionToken", "XeroConfiguration", "XeroMapping", "QuickBooksConfiguration", "QuickBooksWebhookEvent", "PayVisionTransaction", "KashToken", "EmailProvider", "DataSynchronizationJob", "DataSynchronizationJobError", "DataSynchronizationConfiguration", "DataSynchronizationAppConfiguration", "AggregationChildrenResponse", "MetadataKeyValue", "Metadata", "AggregatingComponent", "PricingComponentMigrationValue", "RegistrationResponse", "InvoiceRecalculationAmendment", "IssueInvoiceAmendment", "EmailSubscription", "SubscriptionCheckoutDefinition", "InvoiceCheckoutDefinition", "RevenueAttribution", "AddChargeToAccountResponse", "APIResponse", "PricingComponentUnitCredit", "CurrencyConfiguration", "SubscriptionNotificationConfiguration", "InvoiceTemplateConfig", "ChartMogulConfiguration", "BraintreeUpdateResult", "SubscriptionPricingComponentValueBatchUpdate", "InvoiceRender", "CouponWrapperResponse", "APIQuoteResponseQuantity", "APIQuote", "Contract", "HaltAggregationResponse", "ContractPeriod", "Affiliate", "AffiliateSubscriptionRelationship", "AffiliateRatePlanRelationship", "GoCardlessToken", "SetRatePlanAffiliateRequest", "CommissionStructure", "UserDefinableSalesforceObject", "EpxToken", "EpxPayment", "EpxApiConfiguration", "ZoozToken", "ZoozCustomer", "ZoozPayment", "EmailTokenization", "SubscriptionPlan", "SubscriptionGroup", "LoginAttempt", "InvoiceTemplateConfiguration", "OrganizationProfile", "PaymentMethodResponse", "ShuttleLink", "EmailNotification", "ShuttleHostedPayment", "EBANXPaymentMethod"] # noqa: E501 + if domain not in allowed_values: + raise ValueError( + "Invalid value for `domain` ({0}), must be one of {1}" # noqa: E501 + .format(domain, allowed_values) + ) + + self._domain = domain + + @property + def action(self): + """Gets the action of this WebhookSubscription. # noqa: E501 + + + :return: The action of this WebhookSubscription. # noqa: E501 + :rtype: str + """ + return self._action + + @action.setter + def action(self, action): + """Sets the action of this WebhookSubscription. + + + :param action: The action of this WebhookSubscription. # noqa: E501 + :type: str + """ + if action is None: + raise ValueError("Invalid value for `action`, must not be `None`") # noqa: E501 + allowed_values = ["Accept", "Active", "AwaitingPayment", "AwaitingRefund", "Cancelled", "Completed", "Created", "Current", "Error", "Expiring", "Expired", "Failed", "Migrated", "NeedsAmendments", "Paid", "Pending", "Provisioned", "Refunded", "Reject", "Restarted", "Trial", "Unknown", "Unpaid", "Updated", "Voided", "PaymentFailed", "ProcessingPayment", "ServiceEnded", "AdvanceNotification"] # noqa: E501 + if action not in allowed_values: + raise ValueError( + "Invalid value for `action` ({0}), must be one of {1}" # noqa: E501 + .format(action, allowed_values) + ) + + self._action = action + + @property + def deleted(self): + """Gets the deleted of this WebhookSubscription. # noqa: E501 + + + :return: The deleted of this WebhookSubscription. # noqa: E501 + :rtype: bool + """ + return self._deleted + + @deleted.setter + def deleted(self, deleted): + """Sets the deleted of this WebhookSubscription. + + + :param deleted: The deleted of this WebhookSubscription. # noqa: E501 + :type: bool + """ + if deleted is None: + raise ValueError("Invalid value for `deleted`, must not be `None`") # noqa: E501 + + self._deleted = deleted + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(WebhookSubscription, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, WebhookSubscription): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/zooz_capture_request.py b/billforward/models/zooz_capture_request.py new file mode 100644 index 0000000..2ad62ad --- /dev/null +++ b/billforward/models/zooz_capture_request.py @@ -0,0 +1,214 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six + +class ZoozCaptureRequest(object): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'created': 'datetime', + 'organization_id': 'str', + 'account_id': 'str', + 'default_payment_method': 'bool', + 'card_token': 'str' + } + + attribute_map = { + 'created': 'created', + 'organization_id': 'organizationID', + 'account_id': 'accountID', + 'default_payment_method': 'defaultPaymentMethod', + 'card_token': 'cardToken' + } + + def __init__(self, created=None, organization_id=None, account_id=None, default_payment_method=None, card_token=None): # noqa: E501 + """ZoozCaptureRequest - a model defined in Swagger""" # noqa: E501 + self._created = None + self._organization_id = None + self._account_id = None + self._default_payment_method = None + self._card_token = None + self.discriminator = None + if created is not None: + self.created = created + if organization_id is not None: + self.organization_id = organization_id + if account_id is not None: + self.account_id = account_id + if default_payment_method is not None: + self.default_payment_method = default_payment_method + if card_token is not None: + self.card_token = card_token + + @property + def created(self): + """Gets the created of this ZoozCaptureRequest. # noqa: E501 + + + :return: The created of this ZoozCaptureRequest. # noqa: E501 + :rtype: datetime + """ + return self._created + + @created.setter + def created(self, created): + """Sets the created of this ZoozCaptureRequest. + + + :param created: The created of this ZoozCaptureRequest. # noqa: E501 + :type: datetime + """ + + self._created = created + + @property + def organization_id(self): + """Gets the organization_id of this ZoozCaptureRequest. # noqa: E501 + + + :return: The organization_id of this ZoozCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """Sets the organization_id of this ZoozCaptureRequest. + + + :param organization_id: The organization_id of this ZoozCaptureRequest. # noqa: E501 + :type: str + """ + + self._organization_id = organization_id + + @property + def account_id(self): + """Gets the account_id of this ZoozCaptureRequest. # noqa: E501 + + + :return: The account_id of this ZoozCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this ZoozCaptureRequest. + + + :param account_id: The account_id of this ZoozCaptureRequest. # noqa: E501 + :type: str + """ + + self._account_id = account_id + + @property + def default_payment_method(self): + """Gets the default_payment_method of this ZoozCaptureRequest. # noqa: E501 + + + :return: The default_payment_method of this ZoozCaptureRequest. # noqa: E501 + :rtype: bool + """ + return self._default_payment_method + + @default_payment_method.setter + def default_payment_method(self, default_payment_method): + """Sets the default_payment_method of this ZoozCaptureRequest. + + + :param default_payment_method: The default_payment_method of this ZoozCaptureRequest. # noqa: E501 + :type: bool + """ + + self._default_payment_method = default_payment_method + + @property + def card_token(self): + """Gets the card_token of this ZoozCaptureRequest. # noqa: E501 + + + :return: The card_token of this ZoozCaptureRequest. # noqa: E501 + :rtype: str + """ + return self._card_token + + @card_token.setter + def card_token(self, card_token): + """Sets the card_token of this ZoozCaptureRequest. + + + :param card_token: The card_token of this ZoozCaptureRequest. # noqa: E501 + :type: str + """ + + self._card_token = card_token + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ZoozCaptureRequest, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ZoozCaptureRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/zooz_configuration.py b/billforward/models/zooz_configuration.py new file mode 100644 index 0000000..5ab6a59 --- /dev/null +++ b/billforward/models/zooz_configuration.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.api_configuration import APIConfiguration # noqa: F401,E501 + +class ZoozConfiguration(APIConfiguration): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(APIConfiguration, "swagger_types"): + swagger_types.update(APIConfiguration.swagger_types) + + attribute_map = { + } + if hasattr(APIConfiguration, "attribute_map"): + attribute_map.update(APIConfiguration.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """ZoozConfiguration - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + APIConfiguration.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ZoozConfiguration, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ZoozConfiguration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/models/zooz_payment.py b/billforward/models/zooz_payment.py new file mode 100644 index 0000000..6f86d67 --- /dev/null +++ b/billforward/models/zooz_payment.py @@ -0,0 +1,90 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +import pprint +import re # noqa: F401 + +import six +from billforward.models.payment import Payment # noqa: F401,E501 + +class ZoozPayment(Payment): + """NOTE: This class is auto generated by the swagger code generator program. + + Do not edit the class manually. + """ + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + } + if hasattr(Payment, "swagger_types"): + swagger_types.update(Payment.swagger_types) + + attribute_map = { + } + if hasattr(Payment, "attribute_map"): + attribute_map.update(Payment.attribute_map) + + def __init__(self, *args, **kwargs): # noqa: E501 + """ZoozPayment - a model defined in Swagger""" # noqa: E501 + self.discriminator = None + Payment.__init__(self, *args, **kwargs) + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + if issubclass(ZoozPayment, dict): + for key, value in self.items(): + result[key] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, ZoozPayment): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other diff --git a/billforward/rest.py b/billforward/rest.py index 4ff0afd..0a31d18 100644 --- a/billforward/rest.py +++ b/billforward/rest.py @@ -1,53 +1,33 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import sys import io import json -import ssl -import certifi import logging import re +import ssl +import certifi # python 2 and python 3 compatibility library -from six import iteritems - -from .configuration import Configuration +import six +from six.moves.urllib.parse import urlencode try: import urllib3 except ImportError: raise ImportError('Swagger python client requires urllib3.') -try: - # for python3 - from urllib.parse import urlencode -except ImportError: - # for python2 - from urllib import urlencode - logger = logging.getLogger(__name__) @@ -61,69 +41,93 @@ def __init__(self, resp): self.data = resp.data def getheaders(self): - """ - Returns a dictionary of the response headers. - """ + """Returns a dictionary of the response headers.""" return self.urllib3_response.getheaders() def getheader(self, name, default=None): - """ - Returns a given response header. - """ + """Returns a given response header.""" return self.urllib3_response.getheader(name, default) class RESTClientObject(object): - def __init__(self, pools_size=4): + def __init__(self, configuration, pools_size=4, maxsize=None): # urllib3.PoolManager will pass all kw parameters to connectionpool - # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 - # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 - # ca_certs vs cert_file vs key_file - # http://stackoverflow.com/a/23957365/2985775 + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 + # maxsize is the number of requests to host that are allowed in parallel # noqa: E501 + # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 # cert_reqs - if Configuration().verify_ssl: + if configuration.verify_ssl: cert_reqs = ssl.CERT_REQUIRED else: cert_reqs = ssl.CERT_NONE # ca_certs - if Configuration().ssl_ca_cert: - ca_certs = Configuration().ssl_ca_cert + if configuration.ssl_ca_cert: + ca_certs = configuration.ssl_ca_cert else: # if not set certificate file, use Mozilla's root certificates. ca_certs = certifi.where() - # cert_file - cert_file = Configuration().cert_file + addition_pool_args = {} + if configuration.assert_hostname is not None: + addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501 - # key file - key_file = Configuration().key_file + if maxsize is None: + if configuration.connection_pool_maxsize is not None: + maxsize = configuration.connection_pool_maxsize + else: + maxsize = 4 # https pool manager - self.pool_manager = urllib3.PoolManager( - num_pools=pools_size, - cert_reqs=cert_reqs, - ca_certs=ca_certs, - cert_file=cert_file, - key_file=key_file - ) + if configuration.proxy: + self.pool_manager = urllib3.ProxyManager( + num_pools=pools_size, + maxsize=maxsize, + cert_reqs=cert_reqs, + ca_certs=ca_certs, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + proxy_url=configuration.proxy, + **addition_pool_args + ) + else: + self.pool_manager = urllib3.PoolManager( + num_pools=pools_size, + maxsize=maxsize, + cert_reqs=cert_reqs, + ca_certs=ca_certs, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + **addition_pool_args + ) def request(self, method, url, query_params=None, headers=None, - body=None, post_params=None): - """ + body=None, post_params=None, _preload_content=True, + _request_timeout=None): + """Perform requests. + :param method: http request method :param url: http request url :param query_params: query parameters in the url :param headers: http request headers :param body: request json body, for `application/json` :param post_params: request post parameters, - `application/x-www-form-urlencode` + `application/x-www-form-urlencoded` and `multipart/form-data` + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. """ method = method.upper() - assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', 'PATCH', 'OPTIONS'] + assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', + 'PATCH', 'OPTIONS'] if post_params and body: raise ValueError( @@ -133,6 +137,15 @@ def request(self, method, url, query_params=None, headers=None, post_params = post_params or {} headers = headers or {} + timeout = None + if _request_timeout: + if isinstance(_request_timeout, (int, ) if six.PY3 else (int, long)): # noqa: E501,F821 + timeout = urllib3.Timeout(total=_request_timeout) + elif (isinstance(_request_timeout, tuple) and + len(_request_timeout) == 2): + timeout = urllib3.Timeout( + connect=_request_timeout[0], read=_request_timeout[1]) + if 'Content-Type' not in headers: headers['Content-Type'] = 'application/json' @@ -142,91 +155,137 @@ def request(self, method, url, query_params=None, headers=None, if query_params: url += '?' + urlencode(query_params) if re.search('json', headers['Content-Type'], re.IGNORECASE): - request_body = None - if body: + request_body = '{}' + if body is not None: request_body = json.dumps(body) - r = self.pool_manager.request(method, url, - body=request_body, - headers=headers) - if headers['Content-Type'] == 'application/x-www-form-urlencoded': - r = self.pool_manager.request(method, url, - fields=post_params, - encode_multipart=False, - headers=headers) - if headers['Content-Type'] == 'multipart/form-data': - # must del headers['Content-Type'], or the correct Content-Type - # which generated by urllib3 will be overwritten. + r = self.pool_manager.request( + method, url, + body=request_body, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 + r = self.pool_manager.request( + method, url, + fields=post_params, + encode_multipart=False, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + elif headers['Content-Type'] == 'multipart/form-data': + # must del headers['Content-Type'], or the correct + # Content-Type which generated by urllib3 will be + # overwritten. del headers['Content-Type'] - r = self.pool_manager.request(method, url, - fields=post_params, - encode_multipart=True, - headers=headers) + r = self.pool_manager.request( + method, url, + fields=post_params, + encode_multipart=True, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + # Pass a `string` parameter directly in the body to support + # other content types than Json when `body` argument is + # provided in serialized form + elif isinstance(body, str): + request_body = body + r = self.pool_manager.request( + method, url, + body=request_body, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + else: + # Cannot generate the request from given parameters + msg = """Cannot prepare a request message for provided + arguments. Please check that your arguments match + declared content type.""" + raise ApiException(status=0, reason=msg) # For `GET`, `HEAD` else: r = self.pool_manager.request(method, url, fields=query_params, + preload_content=_preload_content, + timeout=timeout, headers=headers) except urllib3.exceptions.SSLError as e: msg = "{0}\n{1}".format(type(e).__name__, str(e)) raise ApiException(status=0, reason=msg) - r = RESTResponse(r) + if _preload_content: + r = RESTResponse(r) - # In the python 3, the response.data is bytes. - # we need to decode it to string. - if sys.version_info > (3,): - r.data = r.data.decode('utf8') + # log response body + logger.debug("response body: %s", r.data) - # log response body - logger.debug("response body: %s" % r.data) - - if r.status not in range(200, 206): + if not 200 <= r.status <= 299: raise ApiException(http_resp=r) return r - def GET(self, url, headers=None, query_params=None): + def GET(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): return self.request("GET", url, headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, query_params=query_params) - def HEAD(self, url, headers=None, query_params=None): + def HEAD(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): return self.request("HEAD", url, headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, query_params=query_params) - def OPTIONS(self, url, headers=None, query_params=None, post_params=None, body=None): + def OPTIONS(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): return self.request("OPTIONS", url, headers=headers, query_params=query_params, post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, body=body) - def DELETE(self, url, headers=None, query_params=None, body=None): + def DELETE(self, url, headers=None, query_params=None, body=None, + _preload_content=True, _request_timeout=None): return self.request("DELETE", url, headers=headers, query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, body=body) - def POST(self, url, headers=None, query_params=None, post_params=None, body=None): + def POST(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): return self.request("POST", url, headers=headers, query_params=query_params, post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, body=body) - def PUT(self, url, headers=None, query_params=None, post_params=None, body=None): + def PUT(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): return self.request("PUT", url, headers=headers, query_params=query_params, post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, body=body) - def PATCH(self, url, headers=None, query_params=None, post_params=None, body=None): + def PATCH(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): return self.request("PATCH", url, headers=headers, query_params=query_params, post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, body=body) @@ -245,13 +304,12 @@ def __init__(self, status=None, reason=None, http_resp=None): self.headers = None def __str__(self): - """ - Custom error messages for exception - """ + """Custom error messages for exception""" error_message = "({0})\n"\ "Reason: {1}\n".format(self.status, self.reason) if self.headers: - error_message += "HTTP response headers: {0}\n".format(self.headers) + error_message += "HTTP response headers: {0}\n".format( + self.headers) if self.body: error_message += "HTTP response body: {0}\n".format(self.body) diff --git a/docs/APIConfiguration.md b/docs/APIConfiguration.md new file mode 100644 index 0000000..28094bf --- /dev/null +++ b/docs/APIConfiguration.md @@ -0,0 +1,33 @@ +# APIConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**type** | **str** | | [optional] +**environment** | **str** | | [optional] +**merchant_id** | **str** | | [optional] +**public_key** | **str** | | [optional] +**private_key** | **str** | | [optional] +**endpoint** | **str** | | [optional] +**client_id** | **str** | | [optional] +**client_secret** | **str** | | [optional] +**gateway_account_id** | **str** | | [optional] +**refresh_token** | **str** | | [optional] +**deleted** | **bool** | | +**api_login_id** | **str** | | [optional] +**transaction_key** | **str** | | [optional] +**expires_at** | **datetime** | | [optional] +**migrations** | [**list[Migration]**](Migration.md) | | [optional] +**gateway_type** | **str** | | [optional] +**environment_type** | **str** | | [optional] +**production** | **bool** | | [optional] +**apilogin_id** | **str** | | [optional] +**apikey** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/APIConfigurationPagedMetadata.md b/docs/APIConfigurationPagedMetadata.md deleted file mode 100644 index b459c37..0000000 --- a/docs/APIConfigurationPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# APIConfigurationPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/APIQuote.md b/docs/APIQuote.md index 79e919e..f1b158e 100644 --- a/docs/APIQuote.md +++ b/docs/APIQuote.md @@ -1,38 +1,40 @@ -# APIQuote +# ApiQuote ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**subtotal** | **float** | {\"description\":\"The cost &mdash; including tax, but excluding discounts &mdash; of all items described in the quote.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**subtotal_excluding_tax** | **float** | {\"description\":\"The cost &mdash; excluding tax, and excluding discounts &mdash; of all items described in the quote.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**total** | **float** | {\"description\":\"The cost &mdash; including tax, and with discounts (themselves including tax) applied &mdash; of all items described in the quote.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**total_excluding_tax** | **float** | {\"description\":\"The cost &mdash; excluding tax, and with discounts (themselves excluding tax) applied &mdash; of all items described in the quote.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**tax** | **float** | {\"description\":\"The portion of this quote's cost which is comprised of tax.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**discount** | **float** | {\"description\":\"Total amount deducted from price via discounts &mdash; includes any tax upon the discounts themselves.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**discount_excluding_tax** | **float** | {\"description\":\"Total amount deducted from price via discounts &mdash; excludes any tax upon the discounts themselves.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**currency** | **str** | {\"description\":\"The currency of any quoted prices &mdash; as specified by a three-character ISO 4217 currency code (i.e. USD).\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**product_name** | **str** | {\"description\":\"Name of the product for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**public_product_name** | **str** | {\"description\":\"Public name of the product for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**product_rate_plan_name** | **str** | {\"description\":\"Name of the rate plan (of some product) for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**public_product_rate_plan_name** | **str** | {\"description\":\"Public name of the rate plan (of some product) for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**product_id** | **str** | {\"description\":\"ID of the product for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**product_rate_plan_id** | **str** | {\"description\":\"ID of the rate plan (of some product) for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**subscription_id** | **str** | {\"description\":\"ID of the subscription for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**account_id** | **str** | {\"description\":\"ID of the account for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**quantities** | [**list[APIQuoteResponseQuantity]**](APIQuoteResponseQuantity.md) | {\"description\":\"A list of calculated prices for each pricing component described in the quote request.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**discounts** | [**list[CouponWrapperResponse]**](CouponWrapperResponse.md) | {\"description\":\"A list of discounts applied in calculating the quote.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**quote_for** | **str** | {\"default\":\"RecurringPeriod\",\"description\":\"Subscription scenario with which the quote is concerned.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**period_start** | **datetime** | {\"default\":\"(Time at which quote is requested)\",\"description\":\"The start date-time of the interval for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | -**period_end** | **datetime** | {\"default\":\"(End of period described in `periodStart`)\",\"description\":\"The end date-time of the interval for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | -**total_periods** | **float** | {\"default\":\"ZERO\",\"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**proration_enabled** | **bool** | {\"default\":true,\"description\":\"Whether consumption for fractions/multiples of periods is calculated as a fraction/multiple of the cost of consumption for a whole period.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**uplift** | **float** | {\"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**coupon_codes** | **list[str]** | {\"description\":\"A list of coupon codes to consider in calculating the quote.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**organization_id** | **str** | {\"description\":\"ID of the organization in whose name the quote was generated.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**same_product_period** | **bool** | {\"description\":\"If migration quote whether or not the rate plans have the same duration\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**subtotal** | **float** | | [optional] +**subtotal_excluding_tax** | **float** | | [optional] +**total** | **float** | | [optional] +**total_excluding_tax** | **float** | | [optional] +**tax** | **float** | | [optional] +**discount** | **float** | | [optional] +**discount_excluding_tax** | **float** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**product_name** | **str** | | [optional] +**public_product_name** | **str** | | [optional] +**product_rate_plan_name** | **str** | | [optional] +**public_product_rate_plan_name** | **str** | | [optional] +**product_id** | **str** | | [optional] +**product_rate_plan_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**quantities** | [**list[APIQuoteResponseQuantity]**](APIQuoteResponseQuantity.md) | | [optional] +**discounts** | [**list[CouponWrapperResponse]**](CouponWrapperResponse.md) | | [optional] +**quote_for** | **str** | | [optional] +**period_start** | **datetime** | | +**period_end** | **datetime** | | +**total_periods** | **float** | | [optional] +**proration_enabled** | **bool** | | [optional] +**uplift** | **float** | | [optional] +**coupon_codes** | **list[str]** | | [optional] +**organization_id** | **str** | | [optional] +**same_product_period** | **bool** | | [optional] +**purchase_order** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/APIQuotePagedMetadata.md b/docs/APIQuotePagedMetadata.md deleted file mode 100644 index d9d7aff..0000000 --- a/docs/APIQuotePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# APIQuotePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[APIQuote]**](APIQuote.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/APIQuoteResponseQuantity.md b/docs/APIQuoteResponseQuantity.md index 73a3083..75a5dc8 100644 --- a/docs/APIQuoteResponseQuantity.md +++ b/docs/APIQuoteResponseQuantity.md @@ -3,25 +3,32 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**pricing_component_name** | **str** | {\"description\":\"Name of the pricing component whose price was calculated.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**pricing_component_type** | **str** | {\"description\":\"Charge type of the pricing component whose price was calculated.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**pricing_component_id** | **str** | {\"description\":\"ID of the pricing component whose price was calculated.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**quantity** | **int** | {\"description\":\"Quantity of the pricing component whose price was calculated.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**existing_quantity** | **int** | {\"description\":\"Previous quantity of the pricing component. Price is calculated with respect to a delta from this quantity.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**final_cost** | **float** | {\"description\":\"The cost &mdash; including tax, and with discounts (themselves including tax) applied &mdash; contributed by consumption of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**final_cost_excluding_tax** | **float** | {\"description\":\"The cost &mdash; excluding tax, and with discounts (themselves excluding tax) applied &mdash; contributed by consumption of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**cost** | **float** | {\"description\":\"The cost &mdash; including tax, but excluding discounts &mdash; contributed by consumption of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**cost_excluding_tax** | **float** | {\"description\":\"The cost &mdash; excluding tax, and excluding discounts &mdash; contributed by consumption of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**tax** | **float** | {\"description\":\"The portion of this pricing component's cost which is comprised of tax.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**discount** | **float** | {\"description\":\"The discount &mdash; including tax &mdash; applied to this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**discount_excluding_tax** | **float** | {\"description\":\"The discount &mdash; excluding tax &mdash; applied to this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**unit_of_measure_id** | **str** | {\"description\":\"ID of the 'Unit of Measure' entity &mdash; in which this pricing component is measured.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**unit_of_measure_name** | **str** | {\"description\":\"Name of the 'Unit of Measure' entity &mdash; in which this pricing component is measured.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**unit_of_measure_display** | **str** | {\"description\":\"Displayable units of the 'Unit of Measure' entity &mdash; in which this pricing component is measured.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**unit_of_measure** | **str** | {\"description\":\"The 'Unit of Measure' entity used to measure this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**applies_from** | **datetime** | {\"description\":\"The date-time from which the pricing component's new value would apply.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**discounts** | [**list[CouponWrapperResponse]**](CouponWrapperResponse.md) | {\"description\":\"A list of discounts applied in calculating the price of this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**pricing_component_name** | **str** | | [optional] +**pricing_component_type** | **str** | | [optional] +**pricing_component_id** | **str** | | [optional] +**quantity** | **int** | | [optional] +**existing_quantity** | **int** | | [optional] +**final_cost** | **float** | | [optional] +**final_cost_excluding_tax** | **float** | | [optional] +**cost** | **float** | | [optional] +**cost_excluding_tax** | **float** | | [optional] +**tax** | **float** | | [optional] +**discount** | **float** | | [optional] +**discount_excluding_tax** | **float** | | [optional] +**percentage_discount** | **float** | | [optional] +**unit_of_measure_id** | **str** | | [optional] +**unit_of_measure_name** | **str** | | [optional] +**unit_of_measure_display** | **str** | | [optional] +**unit_of_measure** | **str** | | [optional] +**applies_from** | **datetime** | | [optional] +**charge_model** | **str** | | [optional] +**discounts** | [**list[CouponWrapperResponse]**](CouponWrapperResponse.md) | | [optional] +**price_breakdown** | [**PriceBreakdown**](PriceBreakdown.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Account.md b/docs/Account.md index 95b899b..3a639b8 100644 --- a/docs/Account.md +++ b/docs/Account.md @@ -3,21 +3,23 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**crm_id** | **str** | { \"description\" : \"CRM ID of the account.\", \"verbs\":[\"GET\"] } | [optional] -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**metadata** | [**DynamicMetadata**](DynamicMetadata.md) | { \"description\" : \"Add metadata.\", \"verbs\":[\"POST\"] } | [optional] -**id** | **str** | { \"description\" : \"ID of the account.\", \"verbs\":[\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"Organization associated with the account.\", \"verbs\":[] } | -**user_id** | **str** | { \"description\" : \"User associated with the account. If this is null, no user is currently assocaited with the account. A user is only set when an account is associated with a user account.\", \"verbs\":[] } | [optional] -**successful_subscriptions** | **int** | { \"description\" : \"Number of distinct, paid subscriptions associated with this account. Initially the value will be 0 when no successful subscriptions have been taken. A subscription cancelled whilst in trial is counted as successful.\", \"verbs\":[\"GET\"] } | [optional] -**aggregating_product_rate_plan_id** | **str** | { \"description\" : \"If present, this will be the product rate plan to use when creating an aggregating subscription. An account level aggregating subscription will be created when the first subscription is created against the account.\", \"verbs\":[] } | [optional] -**aggregating_subscription_id** | **str** | { \"description\" : \"The consistent ID of the account level aggregating subscription, if one exists.\", \"verbs\":[] } | [optional] -**deleted** | **bool** | { \"default\" : \"false\", \"description\" : \"Indicates if an account has been retired. If an account has been retired it can still be retrieved using the appropriate flag on API requests.\", \"verbs\":[\"GET\"] } | [optional] [default to False] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**metadata** | **dict(str, object)** | | [optional] +**id** | **str** | | [optional] +**crm_id** | **str** | | [optional] +**organization_id** | **str** | | +**user_id** | **str** | | [optional] +**successful_subscriptions** | **int** | | [optional] +**aggregating_product_rate_plan_id** | **str** | | [optional] +**aggregating_subscription_id** | **str** | | [optional] +**parent_id** | **str** | | [optional] +**deleted** | **bool** | | [optional] **profile** | [**Profile**](Profile.md) | | [optional] -**payment_methods** | [**list[PaymentMethod]**](PaymentMethod.md) | { \"description\" : \"The payment-methods associated with the account.\", \"verbs\":[\"GET\"] } | [optional] +**affiliate** | [**Affiliate**](Affiliate.md) | | [optional] +**payment_methods** | [**list[PaymentMethod]**](PaymentMethod.md) | | [optional] +**profile_from_request** | [**CreateProfileRequest**](CreateProfileRequest.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AccountLTVResultPagedMetadata.md b/docs/AccountLTVResultPagedMetadata.md deleted file mode 100644 index df1333f..0000000 --- a/docs/AccountLTVResultPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# AccountLTVResultPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AccountPagedMetadata.md b/docs/AccountPagedMetadata.md deleted file mode 100644 index 1797abb..0000000 --- a/docs/AccountPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# AccountPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Account]**](Account.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AccountPaymentsResultPagedMetadata.md b/docs/AccountPaymentsResultPagedMetadata.md deleted file mode 100644 index 0913323..0000000 --- a/docs/AccountPaymentsResultPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# AccountPaymentsResultPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AccountsApi.md b/docs/AccountsApi.md index e819226..28ceced 100644 --- a/docs/AccountsApi.md +++ b/docs/AccountsApi.md @@ -1,70 +1,117 @@ # billforward.AccountsApi -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**add_credit_note_to_account**](AccountsApi.md#add_credit_note_to_account) | **POST** /accounts/{account-ID}/credit | Creates a credit-note which may be used by any subscription of this account. -[**add_permission_to_account**](AccountsApi.md#add_permission_to_account) | **POST** /accounts/{account-ID}/roles/{role} | Add a role to the account -[**create_account**](AccountsApi.md#create_account) | **POST** /accounts | Create an Account. -[**delete_account**](AccountsApi.md#delete_account) | **DELETE** /accounts/{account-ID} | Delete the account specified by the account-ID parameter. -[**delete_metadata_for_account**](AccountsApi.md#delete_metadata_for_account) | **DELETE** /accounts/{account-ID}/metadata | Remove any associated metadata. -[**get_account_by_id**](AccountsApi.md#get_account_by_id) | **GET** /accounts/{account-ID} | Returns a single account, specified by the account-ID parameter. -[**get_accounts_by_created**](AccountsApi.md#get_accounts_by_created) | **GET** /accounts/created/{lower-threshold}/{upper-threshold} | Returns a collection of account objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**get_accounts_by_updated**](AccountsApi.md#get_accounts_by_updated) | **GET** /accounts/updated/{lower-threshold}/{upper-threshold} | Returns a collection of account objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**get_accounts_by_user_id**](AccountsApi.md#get_accounts_by_user_id) | **GET** /accounts/user/{user-ID} | Returns a collection of accounts, specified by the user-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_all_accounts**](AccountsApi.md#get_all_accounts) | **GET** /accounts | Returns a collection of all account objects. By default 10 values are returned. Records are returned in natural order. -[**get_available_credit_on_account**](AccountsApi.md#get_available_credit_on_account) | **GET** /accounts/{account-ID}/credit | Returns all available credit-notes for the specified account. By default 10 values are returned. Records are returned in natural order. -[**get_metadata_for_account**](AccountsApi.md#get_metadata_for_account) | **GET** /accounts/{account-ID}/metadata | Retrieve any associated metadata. -[**get_permissions_on_account**](AccountsApi.md#get_permissions_on_account) | **GET** /accounts/{account-ID}/roles | Retrieves a collection of roles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**remove_credit_from_account**](AccountsApi.md#remove_credit_from_account) | **DELETE** /accounts/{account-ID}/credit/{value} | Decrease the amount of credit by the value specified or entirely if no value provided. -[**remove_permission_from_account**](AccountsApi.md#remove_permission_from_account) | **DELETE** /accounts/{account-ID}/roles/{role} | Revoke the specified role. -[**set_metadata_for_account**](AccountsApi.md#set_metadata_for_account) | **POST** /accounts/{account-ID}/metadata | Remove any existing metadata keys and create the provided data. -[**update_account**](AccountsApi.md#update_account) | **PUT** /accounts | Update an Account. -[**upsert_metadata_for_account**](AccountsApi.md#upsert_metadata_for_account) | **PUT** /accounts/{account-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed. +[**add_charge_to_account**](AccountsApi.md#add_charge_to_account) | **POST** /accounts/{account-ID}/invoice | +[**add_credit_note_to_account**](AccountsApi.md#add_credit_note_to_account) | **POST** /accounts/{account-ID}/credit | +[**create_account**](AccountsApi.md#create_account) | **POST** /accounts | +[**create_address**](AccountsApi.md#create_address) | **POST** /addresses | +[**delete_account**](AccountsApi.md#delete_account) | **DELETE** /accounts/{account-ID} | +[**delete_metadata_for_account**](AccountsApi.md#delete_metadata_for_account) | **DELETE** /accounts/{account-ID}/metadata | +[**get_account_by_id**](AccountsApi.md#get_account_by_id) | **GET** /accounts/{account-ID} | +[**get_all_accounts**](AccountsApi.md#get_all_accounts) | **GET** /accounts | +[**get_available_credit_on_account**](AccountsApi.md#get_available_credit_on_account) | **GET** /accounts/{account-ID}/credit | +[**get_invoices_by_account_id**](AccountsApi.md#get_invoices_by_account_id) | **GET** /accounts/{account-ID}/invoices | +[**get_metadata_for_account**](AccountsApi.md#get_metadata_for_account) | **GET** /accounts/{account-ID}/metadata | +[**get_payment_method_by_account_id**](AccountsApi.md#get_payment_method_by_account_id) | **GET** /accounts/{account-ID}/payment-methods | +[**get_subscription_charges**](AccountsApi.md#get_subscription_charges) | **GET** /accounts/{account-ID}/charges | +[**halt_aggregation**](AccountsApi.md#halt_aggregation) | **POST** /accounts/{account-ID}/halt-aggregation | +[**remove_credit_from_account2**](AccountsApi.md#remove_credit_from_account2) | **DELETE** /accounts/{account-ID}/credit | +[**set_metadata_for_account**](AccountsApi.md#set_metadata_for_account) | **POST** /accounts/{account-ID}/metadata | +[**update_account**](AccountsApi.md#update_account) | **PUT** /accounts | +[**update_address**](AccountsApi.md#update_address) | **PUT** /addresses | +[**upsert_metadata_for_account**](AccountsApi.md#upsert_metadata_for_account) | **PUT** /accounts/{account-ID}/metadata | + +# **add_charge_to_account** +> InlineResponseDefault2 add_charge_to_account(account_id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +body = billforward.AddChargesToAccountAPIRequest() # AddChargesToAccountAPIRequest | (optional) + +try: + api_response = api_instance.add_charge_to_account(account_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AccountsApi->add_charge_to_account: %s\n" % e) +``` + +### Parameters +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| | + **body** | [**AddChargesToAccountAPIRequest**](AddChargesToAccountAPIRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault2**](InlineResponseDefault2.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **add_credit_note_to_account** -> CreditNotePagedMetadata add_credit_note_to_account(account_id, credit_note) +> InlineResponseDefault4 add_credit_note_to_account(account_id, body=body) -Creates a credit-note which may be used by any subscription of this account. -{\"nickname\":\"Add Credit\",\"request\":\"addCreditNoteToAccountRequest.html\", \"response\":\"addCreditNoteToAccount.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() -account_id = 'account_id_example' # str | ID of the account. -credit_note = billforward.CreditAccountRequest() # CreditAccountRequest | The credit-note request +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +body = billforward.CreditAccountRequest() # CreditAccountRequest | (optional) -try: - # Creates a credit-note which may be used by any subscription of this account. - api_response = api_instance.add_credit_note_to_account(account_id, credit_note) +try: + api_response = api_instance.add_credit_note_to_account(account_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->add_credit_note_to_account: %s\n" % e + print("Exception when calling AccountsApi->add_credit_note_to_account: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account_id** | **str**| ID of the account. | - **credit_note** | [**CreditAccountRequest**](CreditAccountRequest.md)| The credit-note request | + **account_id** | **str**| | + **body** | [**CreditAccountRequest**](CreditAccountRequest.md)| | [optional] ### Return type -[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md) +[**InlineResponseDefault4**](InlineResponseDefault4.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -73,49 +120,44 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **add_permission_to_account** -> RolePagedMetadata add_permission_to_account(account_id, role, organizations=organizations) +# **create_account** +> InlineResponseDefault6 create_account(body=body) -Add a role to the account -{\"nickname\":\"Add Role\",\"response\":\"addRoleToAccountResponse.html\",\"request\":\"addRoleToAccountRequest.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() -account_id = 'account_id_example' # str | ID of the account. -role = 'role_example' # str | ID or name of the role. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Add a role to the account - api_response = api_instance.add_permission_to_account(account_id, role, organizations=organizations) +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +body = billforward.Account() # Account | (optional) + +try: + api_response = api_instance.create_account(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->add_permission_to_account: %s\n" % e + print("Exception when calling AccountsApi->create_account: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account_id** | **str**| ID of the account. | - **role** | **str**| ID or name of the role. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **body** | [**Account**](Account.md)| | [optional] ### Return type -[**RolePagedMetadata**](RolePagedMetadata.md) +[**InlineResponseDefault6**](InlineResponseDefault6.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -124,79 +166,78 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_account** -> AccountPagedMetadata create_account(request) +# **create_address** +> InlineResponseDefault12 create_address(body=body) -Create an Account. -{\"nickname\":\"Create a new account\",\"response\":\"createAccountResponse.html\",\"request\":\"createAccountRequest.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() -request = billforward.CreateAccountRequest() # CreateAccountRequest | The account object to be created. +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +body = billforward.Address() # Address | (optional) -try: - # Create an Account. - api_response = api_instance.create_account(request) +try: + api_response = api_instance.create_address(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->create_account: %s\n" % e + print("Exception when calling AccountsApi->create_address: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **request** | [**CreateAccountRequest**](CreateAccountRequest.md)| The account object to be created. | + **body** | [**Address**](Address.md)| | [optional] ### Return type -[**AccountPagedMetadata**](AccountPagedMetadata.md) +[**InlineResponseDefault12**](InlineResponseDefault12.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_account** -> AccountPagedMetadata delete_account(account_id, delete_gateway_data, organizations) +> InlineResponseDefault6 delete_account(account_id, delete_gateway_data=delete_gateway_data, delete_personal_data=delete_personal_data, organizations=organizations) -Delete the account specified by the account-ID parameter. -{\"nickname\":\"Retire\",\"response\":\"deleteAccount.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) account_id = 'account_id_example' # str | -delete_gateway_data = 'delete_gateway_data_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. +delete_gateway_data = false # bool | (optional) (default to false) +delete_personal_data = false # bool | (optional) (default to false) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Delete the account specified by the account-ID parameter. - api_response = api_instance.delete_account(account_id, delete_gateway_data, organizations) +try: + api_response = api_instance.delete_account(account_id, delete_gateway_data=delete_gateway_data, delete_personal_data=delete_personal_data, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->delete_account: %s\n" % e + print("Exception when calling AccountsApi->delete_account: %s\n" % e) ``` ### Parameters @@ -204,49 +245,49 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| | - **delete_gateway_data** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | + **delete_gateway_data** | **bool**| | [optional] [default to false] + **delete_personal_data** | **bool**| | [optional] [default to false] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**AccountPagedMetadata**](AccountPagedMetadata.md) +[**InlineResponseDefault6**](InlineResponseDefault6.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_metadata_for_account** -> DynamicMetadata delete_metadata_for_account(account_id, organizations=organizations) +> InlineResponseDefault7 delete_metadata_for_account(account_id, organizations=organizations) -Remove any associated metadata. -{\"nickname\":\"Clear metadata from account\",\"request\" :\"deleteAccountMetadataRequest.html\",\"response\":\"deleteAccountMetadataResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) account_id = 'account_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Remove any associated metadata. +try: api_response = api_instance.delete_metadata_for_account(account_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->delete_metadata_for_account: %s\n" % e + print("Exception when calling AccountsApi->delete_metadata_for_account: %s\n" % e) ``` ### Parameters @@ -254,48 +295,47 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**DynamicMetadata**](DynamicMetadata.md) +[**InlineResponseDefault7**](InlineResponseDefault7.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_account_by_id** -> AccountPagedMetadata get_account_by_id(account_id, organizations=organizations) +> InlineResponseDefault6 get_account_by_id(account_id, organizations=organizations) -Returns a single account, specified by the account-ID parameter. -{\"nickname\":\"Retrieve an existing account\",\"response\":\"getAccountByID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) account_id = 'account_id_example' # str | organizations = ['organizations_example'] # list[str] | (optional) -try: - # Returns a single account, specified by the account-ID parameter. +try: api_response = api_instance.get_account_by_id(account_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->get_account_by_id: %s\n" % e + print("Exception when calling AccountsApi->get_account_by_id: %s\n" % e) ``` ### Parameters @@ -307,347 +347,320 @@ Name | Type | Description | Notes ### Return type -[**AccountPagedMetadata**](AccountPagedMetadata.md) +[**InlineResponseDefault6**](InlineResponseDefault6.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_accounts_by_created** -> AccountPagedMetadata get_accounts_by_created(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +# **get_all_accounts** +> InlineResponseDefault5 get_all_accounts(id=id, organizations=organizations, include_retired=include_retired, users_only=users_only, metadata=metadata) -Returns a collection of account objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by creation\",\"response\":\"getAccountByCreated.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of account objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_accounts_by_created(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +id = ['id_example'] # list[str] | (optional) +organizations = ['organizations_example'] # list[str] | (optional) +include_retired = true # bool | (optional) (default to true) +users_only = false # bool | (optional) (default to false) +metadata = 'metadata_example' # str | (optional) + +try: + api_response = api_instance.get_all_accounts(id=id, organizations=organizations, include_retired=include_retired, users_only=users_only, metadata=metadata) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->get_accounts_by_created: %s\n" % e + print("Exception when calling AccountsApi->get_all_accounts: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] + **id** | [**list[str]**](str.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **include_retired** | **bool**| | [optional] [default to true] + **users_only** | **bool**| | [optional] [default to false] + **metadata** | **str**| | [optional] ### Return type -[**AccountPagedMetadata**](AccountPagedMetadata.md) +[**InlineResponseDefault5**](InlineResponseDefault5.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_accounts_by_updated** -> AccountPagedMetadata get_accounts_by_updated(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +# **get_available_credit_on_account** +> InlineResponseDefault3 get_available_credit_on_account(account_id, organizations=organizations, include_retired=include_retired) -Returns a collection of account objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by updated\",\"response\":\"getAccountByUpdated.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of account objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_accounts_by_updated(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_available_credit_on_account(account_id, organizations=organizations, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->get_accounts_by_updated: %s\n" % e + print("Exception when calling AccountsApi->get_available_credit_on_account: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] + **account_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**AccountPagedMetadata**](AccountPagedMetadata.md) +[**InlineResponseDefault3**](InlineResponseDefault3.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_accounts_by_user_id** -> AccountPagedMetadata get_accounts_by_user_id(user_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +# **get_invoices_by_account_id** +> InlineResponseDefault8 get_invoices_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) -Returns a collection of accounts, specified by the user-ID parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by user\",\"response\":\"getAccountByUserID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() -user_id = 'user_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first account to return. (optional) (default to 0) -records = 10 # int | The maximum number of accounts to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of accounts, specified by the user-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_accounts_by_user_id(user_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) +exclude_children = true # bool | (optional) (default to true) + +try: + api_response = api_instance.get_invoices_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->get_accounts_by_user_id: %s\n" % e + print("Exception when calling AccountsApi->get_invoices_by_account_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first account to return. | [optional] [default to 0] - **records** | **int**| The maximum number of accounts to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] + **account_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + **exclude_children** | **bool**| | [optional] [default to true] ### Return type -[**AccountPagedMetadata**](AccountPagedMetadata.md) +[**InlineResponseDefault8**](InlineResponseDefault8.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_accounts** -> AccountPagedMetadata get_all_accounts(id=id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, users_only=users_only, metadata=metadata) +# **get_metadata_for_account** +> InlineResponseDefault7 get_metadata_for_account(account_id, organizations=organizations) -Returns a collection of all account objects. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Get all accounts\",\"response\":\"getAccountAll.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() -id = ['id_example'] # list[str] | A list of account IDs used to filter the output. (optional) -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) -users_only = false # bool | Whether only accounts have a user should be returned. (optional) (default to false) -metadata = 'metadata_example' # str | (optional) +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Returns a collection of all account objects. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_accounts(id=id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, users_only=users_only, metadata=metadata) +try: + api_response = api_instance.get_metadata_for_account(account_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->get_all_accounts: %s\n" % e + print("Exception when calling AccountsApi->get_metadata_for_account: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | [**list[str]**](str.md)| A list of account IDs used to filter the output. | [optional] - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - **users_only** | **bool**| Whether only accounts have a user should be returned. | [optional] [default to false] - **metadata** | **str**| | [optional] + **account_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**AccountPagedMetadata**](AccountPagedMetadata.md) +[**InlineResponseDefault7**](InlineResponseDefault7.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/plain, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_available_credit_on_account** -> CreditNotePagedMetadata get_available_credit_on_account(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +# **get_payment_method_by_account_id** +> InlineResponseDefault9 get_payment_method_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, default_only=default_only) -Returns all available credit-notes for the specified account. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Get available credit\",\"response\":\"getAvailableCreditAccount.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() -account_id = 'account_id_example' # str | The ID of the account -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Returns all available credit-notes for the specified account. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_available_credit_on_account(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) +default_only = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_payment_method_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, default_only=default_only) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->get_available_credit_on_account: %s\n" % e + print("Exception when calling AccountsApi->get_payment_method_by_account_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account_id** | **str**| The ID of the account | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **account_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to true] + **default_only** | **bool**| | [optional] [default to false] ### Return type -[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md) +[**InlineResponseDefault9**](InlineResponseDefault9.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_metadata_for_account** -> DynamicMetadata get_metadata_for_account(account_id, organizations=organizations) +# **get_subscription_charges** +> InlineResponseDefault10 get_subscription_charges(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieve any associated metadata. -{\"nickname\":\"Retrieve metadata on account\",\"request\":\"getAccountMetadataRequest.html\",\"response\":\"getAccountMetadataResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) account_id = 'account_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retrieve any associated metadata. - api_response = api_instance.get_metadata_for_account(account_id, organizations=organizations) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_subscription_charges(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->get_metadata_for_account: %s\n" % e + print("Exception when calling AccountsApi->get_subscription_charges: %s\n" % e) ``` ### Parameters @@ -655,53 +668,52 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**DynamicMetadata**](DynamicMetadata.md) +[**InlineResponseDefault10**](InlineResponseDefault10.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_permissions_on_account** -> RolePagedMetadata get_permissions_on_account(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +# **halt_aggregation** +> InlineResponseDefault11 halt_aggregation(account_id, body=body) -Retrieves a collection of roles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"List roles on account\",\"response\":\"getRoleByAccount.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) account_id = 'account_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Retrieves a collection of roles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_permissions_on_account(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +body = billforward.HaltAggregationRequest() # HaltAggregationRequest | (optional) + +try: + api_response = api_instance.halt_aggregation(account_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->get_permissions_on_account: %s\n" % e + print("Exception when calling AccountsApi->halt_aggregation: %s\n" % e) ``` ### Parameters @@ -709,54 +721,48 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **body** | [**HaltAggregationRequest**](HaltAggregationRequest.md)| | [optional] ### Return type -[**RolePagedMetadata**](RolePagedMetadata.md) +[**InlineResponseDefault11**](InlineResponseDefault11.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: */* - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **remove_credit_from_account** -> CreditNotePagedMetadata remove_credit_from_account(account_id, value, organizations=organizations) +# **remove_credit_from_account2** +> InlineResponseDefault4 remove_credit_from_account2(account_id, body=body, organizations=organizations) -Decrease the amount of credit by the value specified or entirely if no value provided. -{\"nickname\":\"Remove Credit\",\"response\":\"removeCreditForAccount.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) account_id = 'account_id_example' # str | -value = 'value_example' # str |

Either a credit note ID or a currency value.

If a credit note ID is provided any remaining credit will be removed from this credit note.

If a currency value is provided the format should be in the form of valueCurrency, where value is the value to remove. The currency should be an ISO 4217 Currency Code. For example setting the value as 10USD will reduce the credit on this account by $10 or 9.86USD would reduce the credit by $9.86. Note: the value will be reduced from any credit notes with available balance.

-organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +body = billforward.RemoveCreditAccountRequest() # RemoveCreditAccountRequest | (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Decrease the amount of credit by the value specified or entirely if no value provided. - api_response = api_instance.remove_credit_from_account(account_id, value, organizations=organizations) +try: + api_response = api_instance.remove_credit_from_account2(account_id, body=body, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->remove_credit_from_account: %s\n" % e + print("Exception when calling AccountsApi->remove_credit_from_account2: %s\n" % e) ``` ### Parameters @@ -764,50 +770,49 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| | - **value** | **str**| <p>Either a credit note ID or a currency value.</p><p>If a credit note ID is provided any remaining credit will be removed from this credit note.</p><p>If a currency value is provided the format should be in the form of valueCurrency, where value is the value to remove. The currency should be an ISO 4217 Currency Code. For example setting the value as 10USD will reduce the credit on this account by $10 or 9.86USD would reduce the credit by $9.86. Note: the value will be reduced from any credit notes with available balance.</p> | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **body** | [**RemoveCreditAccountRequest**](RemoveCreditAccountRequest.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md) +[**InlineResponseDefault4**](InlineResponseDefault4.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: */* - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **remove_permission_from_account** -> RolePagedMetadata remove_permission_from_account(account_id, role, organizations=organizations) +# **set_metadata_for_account** +> InlineResponseDefault7 set_metadata_for_account(account_id, body=body, organizations=organizations) -Revoke the specified role. -{\"nickname\":\"Remove Role\",\"response\":\"removeRoleFromAccount.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) account_id = 'account_id_example' # str | -role = 'role_example' # str | ID or name of the role. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +body = 'body_example' # str | (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Revoke the specified role. - api_response = api_instance.remove_permission_from_account(account_id, role, organizations=organizations) +try: + api_response = api_instance.set_metadata_for_account(account_id, body=body, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->remove_permission_from_account: %s\n" % e + print("Exception when calling AccountsApi->set_metadata_for_account: %s\n" % e) ``` ### Parameters @@ -815,67 +820,62 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| | - **role** | **str**| ID or name of the role. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **body** | [**str**](str.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**RolePagedMetadata**](RolePagedMetadata.md) +[**InlineResponseDefault7**](InlineResponseDefault7.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **set_metadata_for_account** -> DynamicMetadata set_metadata_for_account(metadata, account_id, organizations=organizations) +# **update_account** +> InlineResponseDefault6 update_account(body=body) -Remove any existing metadata keys and create the provided data. -{\"nickname\":\"Set metadata on account\",\"request\":\"setAccountMetadataRequest.html\",\"response\":\"setAccountMetadataResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() -metadata = billforward.DynamicMetadata() # DynamicMetadata | -account_id = 'account_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +body = billforward.Account() # Account | (optional) -try: - # Remove any existing metadata keys and create the provided data. - api_response = api_instance.set_metadata_for_account(metadata, account_id, organizations=organizations) +try: + api_response = api_instance.update_account(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->set_metadata_for_account: %s\n" % e + print("Exception when calling AccountsApi->update_account: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **metadata** | [**DynamicMetadata**](DynamicMetadata.md)| | - **account_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **body** | [**Account**](Account.md)| | [optional] ### Return type -[**DynamicMetadata**](DynamicMetadata.md) +[**InlineResponseDefault6**](InlineResponseDefault6.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -884,96 +884,94 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_account** -> AccountPagedMetadata update_account(account) +# **update_address** +> InlineResponseDefault12 update_address(body=body) -Update an Account. -{\"nickname\":\"Update an account\",\"response\":\"updateAccountResponse.html\",\"request\":\"updateAccountRequest.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() -account = billforward.Account() # Account | The account object to be created. +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) +body = billforward.Address() # Address | (optional) -try: - # Update an Account. - api_response = api_instance.update_account(account) +try: + api_response = api_instance.update_address(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->update_account: %s\n" % e + print("Exception when calling AccountsApi->update_address: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account** | [**Account**](Account.md)| The account object to be created. | + **body** | [**Address**](Address.md)| | [optional] ### Return type -[**AccountPagedMetadata**](AccountPagedMetadata.md) +[**InlineResponseDefault12**](InlineResponseDefault12.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **upsert_metadata_for_account** -> DynamicMetadata upsert_metadata_for_account(metadata, account_id, organizations=organizations) +> InlineResponseDefault7 upsert_metadata_for_account(account_id, body=body, organizations=organizations) -Update any existing metadata key-values and insert any new key-values, no keys will be removed. -{\"nickname\":\"Upsert metadata on account\",\"request\":\"upsertAccountMetadataRequest.html\",\"response\":\"upsertAccountMetadataResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.AccountsApi() -metadata = billforward.DynamicMetadata() # DynamicMetadata | +api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) account_id = 'account_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +body = 'body_example' # str | (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Update any existing metadata key-values and insert any new key-values, no keys will be removed. - api_response = api_instance.upsert_metadata_for_account(metadata, account_id, organizations=organizations) +try: + api_response = api_instance.upsert_metadata_for_account(account_id, body=body, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling AccountsApi->upsert_metadata_for_account: %s\n" % e + print("Exception when calling AccountsApi->upsert_metadata_for_account: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **metadata** | [**DynamicMetadata**](DynamicMetadata.md)| | **account_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **body** | [**str**](str.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**DynamicMetadata**](DynamicMetadata.md) +[**InlineResponseDefault7**](InlineResponseDefault7.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/AddChargeRequest.md b/docs/AddChargeRequest.md index ad01447..6ea447f 100644 --- a/docs/AddChargeRequest.md +++ b/docs/AddChargeRequest.md @@ -3,23 +3,25 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**id** | **str** | {\"description\":\"ID of an existing charge to add to the invoice \",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**name** | **str** | {\"description\":\"Friendly name given to the charge to help identify it.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**description** | **str** | {\"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**currency** | **str** | { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } | [optional] -**amount** | **float** | {\"description\":\"Monetary amount for which to charge. Used only for ad-hoc charges i.e charges not associated with any pricing component. Applicable if pricingComponent is NOT defined\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**tax_amount** | **bool** | {\"default\":false,\"description\":\"Applicable if amount is specified and indicates whether or not to apply tax in addition to the value specified.<br><span class=\\\"label label-default\\\">true</span> &mdash; Tax will be added on top of the nominal price specified in amount &mdash; in accordance with any taxation strategies you have defined.<br><span class=\\\"label label-default\\\">false</span> &mdash; No tax will be applied on top of the price specified in amount.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**period_start** | **datetime** | {\"default\":\"Now\",\"description\":\"Start of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods. Pro-rating the price of pricingComponents purchased\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**period_end** | **datetime** | {\"default\":\"(End of current period)\",\"description\":\"(Applicable only if `pricingComponent` is defined)<br>End of the interval to which the charge applies. Used in pro-rata calculation\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**invoicing_type** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">Aggregated</span>\",\"description\":\"Applicable if adding a charge to the subscription.<br><span class=\\\"label label-default\\\">Immediate</span> &mdash; Generate straight-away an invoice containing these charges.<br><span class=\\\"label label-default\\\">Aggregated</span> &mdash; Add these charges to the next invoice &mdash; for example the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**charge_type** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">Debit</span>\",\"description\":\"Whether this charge represents an increase or decrease in invoice cost<br><span class=\\\"label label-default\\\">Credit</span> &mdash; This results in a reduction to the invoice cost<br><span class=\\\"label label-default\\\">Debit</span> &mdash; This will increase the invoice cost\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**trial** | **bool** | {\"default\":\"false\",\"description\":\"Whether the charge is meant in the context of a trial.<br><span class=\\\"label label-default\\\">false</span> &mdash; This is a non-trial charge, so funds will be sought from the customer.<br><span class=\\\"label label-default\\\">true</span> &mdash; This is a trial charge, soThe charge can be considered 'Paid' without taking any funds from the customer.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**remaining_credit_behaviour** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">Rollover</span>\",\"description\":\"Defines the behaviour applied to any outstanding credit resulting from the application of the charge.<br><span class=\\\"label label-default\\\">Rollover</span> &mdash; Outstanding credit is returned to the accounts credit pool.<br><span class=\\\"label label-default\\\">Discard</span> &mdash; Outstanding credit is lost.\",\"verbs\":[\"POST\",\"GET\"]} | -**pricing_component** | **str** | {\"description\":\"Specifies that this charge is for consumption of some quantity of this pricing component (whose name or ID can be provided).<br>If left blank:<br>The charge will be created as 'ad-hoc'. That is: a monetary lump sum, associated with no pricing component\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**pricing_component_value** | **int** | {\"description\":\"The value consumed of the pricing component which this charge concerns.Required if pricingComponent is defined\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**dry_run** | **bool** | {\"default\":false,\"description\":\"Changes described in the response:<br><span class=\\\"label label-default\\\">true</span> &mdash; Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.<br><span class=\\\"label label-default\\\">false</span> &mdash; Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] +**created** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**amount** | **float** | | [optional] +**tax_amount** | **bool** | | [optional] +**period_start** | **datetime** | | [optional] +**period_end** | **datetime** | | [optional] +**invoicing_type** | **str** | | [optional] +**charge_type** | **str** | | [optional] +**trial** | **bool** | | [optional] +**remaining_credit_behaviour** | **str** | | +**pricing_component** | **str** | | [optional] +**pricing_component_value** | **int** | | [optional] +**dry_run** | **bool** | | [optional] +**invoice_state** | **str** | | [optional] +**void_on_failure** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AddChargeResponse.md b/docs/AddChargeResponse.md new file mode 100644 index 0000000..3bd32c9 --- /dev/null +++ b/docs/AddChargeResponse.md @@ -0,0 +1,13 @@ +# AddChargeResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**request** | [**AddChargeRequest**](AddChargeRequest.md) | | [optional] +**charges** | [**list[SubscriptionCharge]**](SubscriptionCharge.md) | | [optional] +**invoice** | [**Invoice**](Invoice.md) | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AddChargeToAccountResponse.md b/docs/AddChargeToAccountResponse.md new file mode 100644 index 0000000..d109365 --- /dev/null +++ b/docs/AddChargeToAccountResponse.md @@ -0,0 +1,12 @@ +# AddChargeToAccountResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**charges** | [**list[SubscriptionCharge]**](SubscriptionCharge.md) | | [optional] +**invoice** | [**Invoice**](Invoice.md) | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AddChargesToAccountAPIRequest.md b/docs/AddChargesToAccountAPIRequest.md new file mode 100644 index 0000000..f3ee63a --- /dev/null +++ b/docs/AddChargesToAccountAPIRequest.md @@ -0,0 +1,20 @@ +# AddChargesToAccountAPIRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**purchase_order** | **str** | | [optional] +**description** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**invoicing_type** | **str** | | [optional] +**payment_terms** | **int** | | [optional] +**remaining_credit_behaviour** | **str** | | +**invoice_state** | **str** | | [optional] +**charges** | [**list[NestedChargeRequest]**](NestedChargeRequest.md) | | [optional] +**adhoc_charges** | [**list[NestedAdhocChargeRequest]**](NestedAdhocChargeRequest.md) | | [optional] +**dry_run** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AddContractPeriodRequest.md b/docs/AddContractPeriodRequest.md new file mode 100644 index 0000000..50ed5fb --- /dev/null +++ b/docs/AddContractPeriodRequest.md @@ -0,0 +1,13 @@ +# AddContractPeriodRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**contract_period** | **int** | | [optional] +**subscription_periods** | **int** | | [optional] +**quote_id** | **str** | | [optional] +**purchase_order** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AddCouponCodeRequest.md b/docs/AddCouponCodeRequest.md index 6c899ba..0f20ce5 100644 --- a/docs/AddCouponCodeRequest.md +++ b/docs/AddCouponCodeRequest.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\"]} | [optional] -**coupon_code** | **str** | { \"description\" : \"The couponCode can be either a unique code or the master code of a coupon.\", \"verbs\":[\"POST\"]} | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**coupon_code** | **str** | | [optional] +**id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AddPaymentMethodRequest.md b/docs/AddPaymentMethodRequest.md index 7f7b7f7..ba2f32f 100644 --- a/docs/AddPaymentMethodRequest.md +++ b/docs/AddPaymentMethodRequest.md @@ -3,8 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | { \"description\" : \"ID of the payment method to add\", \"verbs\":[\"POST\",\"GET\"] } | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AddTaxationStrategyRequest.md b/docs/AddTaxationStrategyRequest.md deleted file mode 100644 index 389d5f7..0000000 --- a/docs/AddTaxationStrategyRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# AddTaxationStrategyRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the taxation strategy to add\", \"verbs\":[\"POST\",\"GET\"] } | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ReviveSubscriptionRequest.md b/docs/AdditionalData.md similarity index 80% rename from docs/ReviveSubscriptionRequest.md rename to docs/AdditionalData.md index 7a9bcce..4c9b3a7 100644 --- a/docs/ReviveSubscriptionRequest.md +++ b/docs/AdditionalData.md @@ -1,10 +1,9 @@ -# ReviveSubscriptionRequest +# AdditionalData ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**subscription_id** | **str** | | +**type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Address.md b/docs/Address.md index ccd302a..520a557 100644 --- a/docs/Address.md +++ b/docs/Address.md @@ -3,23 +3,24 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"PUT\",\"GET\"] } | [optional] -**profile_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | [optional] -**address_line1** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**address_line2** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**address_line3** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**city** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**province** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**country** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**postcode** | **str** | { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**landline** | **str** | { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**primary_address** | **bool** | { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] [default to False] -**deleted** | **bool** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] [default to False] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**profile_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**address_line1** | **str** | | [optional] +**address_line2** | **str** | | [optional] +**address_line3** | **str** | | [optional] +**city** | **str** | | [optional] +**province** | **str** | | [optional] +**country** | **str** | | [optional] +**postcode** | **str** | | [optional] +**landline** | **str** | | [optional] +**primary_address** | **bool** | | [optional] +**primary_shipping_address** | **bool** | | [optional] +**deleted** | **bool** | | [optional] +**validated** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AddressPagedMetadata.md b/docs/AddressPagedMetadata.md deleted file mode 100644 index 20d93c1..0000000 --- a/docs/AddressPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# AddressPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Address]**](Address.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AddressesApi.md b/docs/AddressesApi.md deleted file mode 100644 index 70efd67..0000000 --- a/docs/AddressesApi.md +++ /dev/null @@ -1,104 +0,0 @@ -# billforward.AddressesApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_address**](AddressesApi.md#create_address) | **POST** /addresses | Create -[**update_address**](AddressesApi.md#update_address) | **PUT** /addresses | Update - - -# **create_address** -> AddressPagedMetadata create_address(request) - -Create - -{\"nickname\":\"Create a new address\",\"response\":\"createAddressResponse.html\",\"request\":\"createAddressRequest.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AddressesApi() -request = billforward.CreateAddressRequest() # CreateAddressRequest | The address object to be created. - -try: - # Create - api_response = api_instance.create_address(request) - pprint(api_response) -except ApiException as e: - print "Exception when calling AddressesApi->create_address: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **request** | [**CreateAddressRequest**](CreateAddressRequest.md)| The address object to be created. | - -### Return type - -[**AddressPagedMetadata**](AddressPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_address** -> AddressPagedMetadata update_address(request) - -Update - -{\"nickname\":\"Update an address\",\"response\":\"updateAddressResponse.html\",\"request\":\"updateAddressRequest.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AddressesApi() -request = billforward.UpdateAddressRequest() # UpdateAddressRequest | The address object to be created. - -try: - # Update - api_response = api_instance.update_address(request) - pprint(api_response) -except ApiException as e: - print "Exception when calling AddressesApi->update_address: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **request** | [**UpdateAddressRequest**](UpdateAddressRequest.md)| The address object to be created. | - -### Return type - -[**AddressPagedMetadata**](AddressPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/AdvancePricingComponentsByChargeModel.md b/docs/AdvancePricingComponentsByChargeModel.md new file mode 100644 index 0000000..292eaba --- /dev/null +++ b/docs/AdvancePricingComponentsByChargeModel.md @@ -0,0 +1,11 @@ +# AdvancePricingComponentsByChargeModel + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**flat** | [**list[FlatAdvancePricingComponent]**](FlatAdvancePricingComponent.md) | | [optional] +**tiered** | [**list[TieredAdvancePricingComponent]**](TieredAdvancePricingComponent.md) | | [optional] +**volume** | [**list[TieredAdvancePricingComponent]**](TieredAdvancePricingComponent.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Affiliate.md b/docs/Affiliate.md new file mode 100644 index 0000000..2732fd3 --- /dev/null +++ b/docs/Affiliate.md @@ -0,0 +1,18 @@ +# Affiliate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**account_id** | **str** | | [optional] +**affiliate_subscription_relationships** | [**list[AffiliateSubscriptionRelationship]**](AffiliateSubscriptionRelationship.md) | | [optional] +**affiliate_rate_plan_relationships** | [**list[AffiliateRatePlanRelationships]**](AffiliateRatePlanRelationships.md) | | [optional] +**accumulated_commissions** | **dict(str, float)** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AffiliateCommissionCharge.md b/docs/AffiliateCommissionCharge.md new file mode 100644 index 0000000..f02868c --- /dev/null +++ b/docs/AffiliateCommissionCharge.md @@ -0,0 +1,11 @@ +# AffiliateCommissionCharge + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**affiliate_id** | **str** | | [optional] +**commission_invoice_id** | **str** | | [optional] +**raw_commission_structure** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AffiliateRatePlanRelationships.md b/docs/AffiliateRatePlanRelationships.md new file mode 100644 index 0000000..0e0d5b0 --- /dev/null +++ b/docs/AffiliateRatePlanRelationships.md @@ -0,0 +1,19 @@ +# AffiliateRatePlanRelationships + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**commission_structure** | [**CommissionStructure**](CommissionStructure.md) | | [optional] +**product_rate_plan_id** | **str** | | [optional] +**start_date** | **datetime** | | [optional] +**end_date** | **datetime** | | [optional] +**interval** | [**IntervalDate**](IntervalDate.md) | | [optional] +**account_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AffiliateSubscriptionRelationship.md b/docs/AffiliateSubscriptionRelationship.md new file mode 100644 index 0000000..7f2375c --- /dev/null +++ b/docs/AffiliateSubscriptionRelationship.md @@ -0,0 +1,16 @@ +# AffiliateSubscriptionRelationship + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**commission_structure** | [**CommissionStructure**](CommissionStructure.md) | | [optional] +**account_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AffiliationApi.md b/docs/AffiliationApi.md new file mode 100644 index 0000000..bd1248b --- /dev/null +++ b/docs/AffiliationApi.md @@ -0,0 +1,403 @@ +# billforward.AffiliationApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_invoice**](AffiliationApi.md#create_invoice) | **POST** /affiliate/{account-id}/invoice | +[**get_affiliate**](AffiliationApi.md#get_affiliate) | **GET** /product-rate-plans/{productRatePlanID}/affiliate | +[**get_affiliate1**](AffiliationApi.md#get_affiliate1) | **GET** /subscriptions/{subscriptionID}/affiliate | +[**quote_invoice**](AffiliationApi.md#quote_invoice) | **GET** /affiliate/{account-id}/quote/invoice/{invoice-id} | +[**quote_subscription**](AffiliationApi.md#quote_subscription) | **GET** /affiliate/{account-id}/quote/subscription/{subscription-id} | +[**set_affiliate**](AffiliationApi.md#set_affiliate) | **POST** /product-rate-plans/{product-rate-plan-ID}/affiliate | +[**set_affiliate1**](AffiliationApi.md#set_affiliate1) | **POST** /subscriptions/{subscriptionID}/affiliate | +[**update_affiliate**](AffiliationApi.md#update_affiliate) | **PUT** /product-rate-plans/{product-rate-plan-ID}/affiliate | + +# **create_invoice** +> InlineResponseDefault8 create_invoice(account_id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.AffiliationApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +body = billforward.CreateCommissionInvoiceRequest() # CreateCommissionInvoiceRequest | (optional) + +try: + api_response = api_instance.create_invoice(account_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AffiliationApi->create_invoice: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| | + **body** | [**CreateCommissionInvoiceRequest**](CreateCommissionInvoiceRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault8**](InlineResponseDefault8.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_affiliate** +> InlineResponseDefault48 get_affiliate(product_rate_plan_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.AffiliationApi(billforward.ApiClient(configuration)) +product_rate_plan_id = 'product_rate_plan_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_affiliate(product_rate_plan_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling AffiliationApi->get_affiliate: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **product_rate_plan_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault48**](InlineResponseDefault48.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_affiliate1** +> InlineResponseDefault66 get_affiliate1(subscription_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.AffiliationApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_affiliate1(subscription_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling AffiliationApi->get_affiliate1: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **subscription_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault66**](InlineResponseDefault66.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **quote_invoice** +> InlineResponseDefault13 quote_invoice(account_id, invoice_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.AffiliationApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +invoice_id = 'invoice_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.quote_invoice(account_id, invoice_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling AffiliationApi->quote_invoice: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| | + **invoice_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault13**](InlineResponseDefault13.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **quote_subscription** +> InlineResponseDefault13 quote_subscription(account_id, subscription_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.AffiliationApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +subscription_id = 'subscription_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.quote_subscription(account_id, subscription_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling AffiliationApi->quote_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| | + **subscription_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault13**](InlineResponseDefault13.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_affiliate** +> InlineResponseDefault49 set_affiliate(product_rate_plan_id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.AffiliationApi(billforward.ApiClient(configuration)) +product_rate_plan_id = 'product_rate_plan_id_example' # str | +body = billforward.SetRatePlanAffiliateRequest() # SetRatePlanAffiliateRequest | (optional) + +try: + api_response = api_instance.set_affiliate(product_rate_plan_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AffiliationApi->set_affiliate: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **product_rate_plan_id** | **str**| | + **body** | [**SetRatePlanAffiliateRequest**](SetRatePlanAffiliateRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault49**](InlineResponseDefault49.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_affiliate1** +> InlineResponseDefault67 set_affiliate1(subscription_id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.AffiliationApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +body = billforward.SetSubscriptionAffiliateRequest() # SetSubscriptionAffiliateRequest | (optional) + +try: + api_response = api_instance.set_affiliate1(subscription_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AffiliationApi->set_affiliate1: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **subscription_id** | **str**| | + **body** | [**SetSubscriptionAffiliateRequest**](SetSubscriptionAffiliateRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault67**](InlineResponseDefault67.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_affiliate** +> InlineResponseDefault49 update_affiliate(product_rate_plan_id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.AffiliationApi(billforward.ApiClient(configuration)) +product_rate_plan_id = 'product_rate_plan_id_example' # str | +body = billforward.UpdateRatePlanAffiliateRequest() # UpdateRatePlanAffiliateRequest | (optional) + +try: + api_response = api_instance.update_affiliate(product_rate_plan_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AffiliationApi->update_affiliate: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **product_rate_plan_id** | **str**| | + **body** | [**UpdateRatePlanAffiliateRequest**](UpdateRatePlanAffiliateRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault49**](InlineResponseDefault49.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/AggregatingComponent.md b/docs/AggregatingComponent.md deleted file mode 100644 index 57f9f35..0000000 --- a/docs/AggregatingComponent.md +++ /dev/null @@ -1,19 +0,0 @@ -# AggregatingComponent - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | {\"description\":\"Unique ID by which the AggregatingComponent can be looked up.\",\"verbs\":[\"GET\"]} | [optional] -**organization_id** | **str** | {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**product_rate_plan_id** | **str** | {\"description\":\"ID of the rate plan upon which this AggregatingComponent is defined.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**product_rate_plan_name** | **str** | {\"description\":\"Name of the rate plan upon which this AggregatingComponent is defined.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**pricing_component_id** | **str** | {\"description\":\"ID of the pricing component to which this AggregatingComponent's aggregation applies. The subscriber to the aggregating rate plan (which contains this AggregatingComponent), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches this ID. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge &mdash; to account for the more favourable price tiering that emerges when aggregating.\",\"verbs\":[\"POST\"]} | -**pricing_component_name** | **str** | {\"description\":\"Name of the pricing component to which this AggregatingComponent's aggregation applies. The subscriber to the aggregating rate plan (which contains this AggregatingComponent), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches this ID. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge &mdash; to account for the more favourable price tiering that emerges when aggregating.\",\"verbs\":[\"POST\"]} | -**deleted** | **bool** | {\"default\":false,\"description\":\"Whether the AggregatingComponent has been retired.\",\"verbs\":[\"GET\"]} | [optional] [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ComponentCost.md b/docs/AggregatingComponentDescription.md similarity index 84% rename from docs/ComponentCost.md rename to docs/AggregatingComponentDescription.md index cfb2934..a1f6e26 100644 --- a/docs/ComponentCost.md +++ b/docs/AggregatingComponentDescription.md @@ -1,11 +1,9 @@ -# ComponentCost +# AggregatingComponentDescription ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cost** | **float** | | [optional] **name** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Alias.md b/docs/Alias.md deleted file mode 100644 index c85ca34..0000000 --- a/docs/Alias.md +++ /dev/null @@ -1,16 +0,0 @@ -# Alias - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | { \"description\" : \"ID of the alias.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the alias.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**alias** | **str** | { \"description\" : \"A string representation of the alias.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"Has this alias been deleted?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AllowedWebhookSubscriptionValues.md b/docs/AllowedWebhookSubscriptionValues.md new file mode 100644 index 0000000..e89e11d --- /dev/null +++ b/docs/AllowedWebhookSubscriptionValues.md @@ -0,0 +1,12 @@ +# AllowedWebhookSubscriptionValues + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**domains** | **list[str]** | | [optional] +**actions** | **list[str]** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Amendment.md b/docs/Amendment.md index cc63859..f75889d 100644 --- a/docs/Amendment.md +++ b/docs/Amendment.md @@ -3,19 +3,21 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**dummy_field** | **str** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**description** | **str** | | [optional] +**actioning_time** | **datetime** | | [optional] +**actioned_time** | **datetime** | | [optional] +**state** | **str** | | +**deleted** | **bool** | | +**amendment_type** | **str** | | [optional] +**discardable_subsystem_object** | [**IDiscardable**](IDiscardable.md) | | [optional] +**type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AmendmentDiscardAmendment.md b/docs/AmendmentDiscardAmendment.md index ab89385..67f1c82 100644 --- a/docs/AmendmentDiscardAmendment.md +++ b/docs/AmendmentDiscardAmendment.md @@ -3,20 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] -**amendment_to_discard_id** | **str** | { \"description\" : \"ID of the amendment to discard.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | +**amendment_to_discard_id** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AmendmentPagedMetadata.md b/docs/AmendmentPagedMetadata.md deleted file mode 100644 index 958176b..0000000 --- a/docs/AmendmentPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# AmendmentPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Amendment]**](Amendment.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AmendmentPriceNTimePagedMetadata.md b/docs/AmendmentPriceNTimePagedMetadata.md deleted file mode 100644 index 0475573..0000000 --- a/docs/AmendmentPriceNTimePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# AmendmentPriceNTimePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AmendmentsApi.md b/docs/AmendmentsApi.md deleted file mode 100644 index 5b86af6..0000000 --- a/docs/AmendmentsApi.md +++ /dev/null @@ -1,620 +0,0 @@ -# billforward.AmendmentsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_amendment**](AmendmentsApi.md#create_amendment) | **POST** /amendments | Create an amendment. -[**get_all_amendments**](AmendmentsApi.md#get_all_amendments) | **GET** /amendments | Returns a collection of all amendments. By default 10 values are returned. Records are returned in natural order. -[**get_amendment_by_id**](AmendmentsApi.md#get_amendment_by_id) | **GET** /amendments/{amendment-ID} | Returns a single amendment, specified by the amendment-ID parameter. -[**get_amendment_by_state**](AmendmentsApi.md#get_amendment_by_state) | **GET** /amendments/state/{state} | Returns a collection of amendments, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -[**get_amendment_by_subscription_id**](AmendmentsApi.md#get_amendment_by_subscription_id) | **GET** /amendments/subscription/{subscription-ID} | Returns a collection of amendments, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_amendment_swagger**](AmendmentsApi.md#get_amendment_swagger) | **GET** /amendments/swagger-end-point/{query-string} | -[**get_amendments_by_actioning_time**](AmendmentsApi.md#get_amendments_by_actioning_time) | **GET** /amendments/actioning-time/{lower-threshold}/{upper-threshold} | Returns a collection of amendment objects with an actioning-time within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**get_amendments_by_created_date**](AmendmentsApi.md#get_amendments_by_created_date) | **GET** /amendments/created/{lower-threshold}/{upper-threshold} | Returns a collection of amendment objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**get_amendments_by_updated_date**](AmendmentsApi.md#get_amendments_by_updated_date) | **GET** /amendments/updated/{lower-threshold}/{upper-threshold} | Returns a collection of amendment objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**retire_amendment**](AmendmentsApi.md#retire_amendment) | **DELETE** /amendments/{amendment-ID} | Retires the amendment specified by the amendment-ID parameter. Retiring a amendment causes it to cancel based on the specificed retirement settings for the product. -[**update_amendment**](AmendmentsApi.md#update_amendment) | **PUT** /amendments | Update an amendment. - - -# **create_amendment** -> AmendmentPagedMetadata create_amendment(amendment) - -Create an amendment. - -{\"nickname\":\"Create a new amendment\",\"request\":\"createAmendmentRequest.html\",\"response\":\"createAmendmentResponse.html\" } - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AmendmentsApi() -amendment = billforward.Amendment() # Amendment | The amendment object to be created. - -try: - # Create an amendment. - api_response = api_instance.create_amendment(amendment) - pprint(api_response) -except ApiException as e: - print "Exception when calling AmendmentsApi->create_amendment: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **amendment** | [**Amendment**](Amendment.md)| The amendment object to be created. | - -### Return type - -[**AmendmentPagedMetadata**](AmendmentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_amendments** -> AmendmentPagedMetadata get_all_amendments(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, invoice_id=invoice_id, state=state, type=type) - -Returns a collection of all amendments. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all amendments\",\"response\":\"getAmendmentAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AmendmentsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 10 # int | The maximum number of amendments to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -invoice_id = 'invoice_id_example' # str | Ihe invoice ID associated with the amendment. (optional) -state = 'state_example' # str | Ihe state of the amendment. (optional) -type = 'type_example' # str | Ihe type of amendment. (optional) - -try: - # Returns a collection of all amendments. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_amendments(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, invoice_id=invoice_id, state=state, type=type) - pprint(api_response) -except ApiException as e: - print "Exception when calling AmendmentsApi->get_all_amendments: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **invoice_id** | **str**| Ihe invoice ID associated with the amendment. | [optional] - **state** | **str**| Ihe state of the amendment. | [optional] - **type** | **str**| Ihe type of amendment. | [optional] - -### Return type - -[**AmendmentPagedMetadata**](AmendmentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_amendment_by_id** -> AmendmentPagedMetadata get_amendment_by_id(amendment_id, organizations=organizations) - -Returns a single amendment, specified by the amendment-ID parameter. - -{\"nickname\":\"Retrieve an existing amendment\",\"response\":\"getAmendmentByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AmendmentsApi() -amendment_id = 'amendment_id_example' # str | The unique string-ID of the amendment. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single amendment, specified by the amendment-ID parameter. - api_response = api_instance.get_amendment_by_id(amendment_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling AmendmentsApi->get_amendment_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **amendment_id** | **str**| The unique string-ID of the amendment. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**AmendmentPagedMetadata**](AmendmentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_amendment_by_state** -> AmendmentPagedMetadata get_amendment_by_state(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of amendments, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by state\",\"response\":\"getAmendmentsByState.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AmendmentsApi() -state = 'state_example' # str | The current state of the amendment, either pending, succeeded, failed or discarded -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 10 # int | The maximum number of amendments to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of amendments, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_amendment_by_state(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling AmendmentsApi->get_amendment_by_state: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **state** | **str**| The current state of the amendment, either pending, succeeded, failed or discarded | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**AmendmentPagedMetadata**](AmendmentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_amendment_by_subscription_id** -> AmendmentPagedMetadata get_amendment_by_subscription_id(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of amendments, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by subscription\",\"response\":\"getAmendmentsBySubscription.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AmendmentsApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 10 # int | The maximum number of amendments to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of amendments, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_amendment_by_subscription_id(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling AmendmentsApi->get_amendment_by_subscription_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**AmendmentPagedMetadata**](AmendmentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_amendment_swagger** -> SwaggerTypeList get_amendment_swagger(query_string, organizations=organizations, offset=offset, records=records, wildcard=wildcard, entity=entity) - - - -{\"nickname\":\"\",\"response\":\"\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AmendmentsApi() -query_string = 'query_string_example' # str | The query string used to search. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The starting index of the search results. (optional) (default to 0) -records = 10 # int | The number of search results to return. (optional) (default to 10) -wildcard = false # bool | Toggle if we search for full words or whether a wildcard is used. (optional) (default to false) -entity = false # bool | Is an entity returned with the search results. (optional) (default to false) - -try: - # - api_response = api_instance.get_amendment_swagger(query_string, organizations=organizations, offset=offset, records=records, wildcard=wildcard, entity=entity) - pprint(api_response) -except ApiException as e: - print "Exception when calling AmendmentsApi->get_amendment_swagger: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **query_string** | **str**| The query string used to search. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The starting index of the search results. | [optional] [default to 0] - **records** | **int**| The number of search results to return. | [optional] [default to 10] - **wildcard** | **bool**| Toggle if we search for full words or whether a wildcard is used. | [optional] [default to false] - **entity** | **bool**| Is an entity returned with the search results. | [optional] [default to false] - -### Return type - -[**SwaggerTypeList**](SwaggerTypeList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_amendments_by_actioning_time** -> AmendmentPagedMetadata get_amendments_by_actioning_time(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of amendment objects with an actioning-time within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by actioning\",\"response\":\"getAmendmentByActioningTime.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AmendmentsApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 10 # int | The maximum number of amendments to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of amendment objects with an actioning-time within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_amendments_by_actioning_time(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling AmendmentsApi->get_amendments_by_actioning_time: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**AmendmentPagedMetadata**](AmendmentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_amendments_by_created_date** -> AmendmentPagedMetadata get_amendments_by_created_date(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of amendment objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by creation\",\"response\":\"getAmendmentByCreated.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AmendmentsApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 10 # int | The maximum number of amendments to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of amendment objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_amendments_by_created_date(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling AmendmentsApi->get_amendments_by_created_date: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**AmendmentPagedMetadata**](AmendmentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_amendments_by_updated_date** -> AmendmentPagedMetadata get_amendments_by_updated_date(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of amendment objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by updated\",\"response\":\"getAmendmentByUpdated.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AmendmentsApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 10 # int | The maximum number of amendments to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of amendment objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_amendments_by_updated_date(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling AmendmentsApi->get_amendments_by_updated_date: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**AmendmentPagedMetadata**](AmendmentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **retire_amendment** -> AmendmentPagedMetadata retire_amendment(amendment_id, organizations) - -Retires the amendment specified by the amendment-ID parameter. Retiring a amendment causes it to cancel based on the specificed retirement settings for the product. - -{\"nickname\":\"Delete an amendment\",\"response\":\"deleteAmendment.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AmendmentsApi() -amendment_id = 'amendment_id_example' # str | ID of the amendment. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. - -try: - # Retires the amendment specified by the amendment-ID parameter. Retiring a amendment causes it to cancel based on the specificed retirement settings for the product. - api_response = api_instance.retire_amendment(amendment_id, organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling AmendmentsApi->retire_amendment: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **amendment_id** | **str**| ID of the amendment. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | - -### Return type - -[**AmendmentPagedMetadata**](AmendmentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_amendment** -> AmendmentPagedMetadata update_amendment(amendment) - -Update an amendment. - -{\"nickname\":\"Update an amendment\",\"request\":\"updateAmendmentRequest.html\",\"response\":\"updateAmendmentResponse.html\" } - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AmendmentsApi() -amendment = billforward.Amendment() # Amendment | The amendment object to be updated. - -try: - # Update an amendment. - api_response = api_instance.update_amendment(amendment) - pprint(api_response) -except ApiException as e: - print "Exception when calling AmendmentsApi->update_amendment: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **amendment** | [**Amendment**](Amendment.md)| The amendment object to be updated. | - -### Return type - -[**AmendmentPagedMetadata**](AmendmentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/AnalyticsApi.md b/docs/AnalyticsApi.md deleted file mode 100644 index 8a34550..0000000 --- a/docs/AnalyticsApi.md +++ /dev/null @@ -1,620 +0,0 @@ -# billforward.AnalyticsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_account_debts**](AnalyticsApi.md#get_account_debts) | **POST** /analytics/payments/accounts/outstanding | Gets outstanding debts per account, within a date range. -[**get_account_ltv**](AnalyticsApi.md#get_account_ltv) | **GET** /analytics/account-ltv/{account-id}/{end-datetime} | Gets an account's life-time value, as of a given end date. -[**get_account_payments**](AnalyticsApi.md#get_account_payments) | **POST** /analytics/payments/accounts | Gets hourly payments per product, within a date range. -[**get_billforward_managed_payments**](AnalyticsApi.md#get_billforward_managed_payments) | **GET** /analytics/billforward-managed-payments/{start-datetime}/{end-datetime} | Gets all payments managed by BillForward, within a date range. -[**get_churn**](AnalyticsApi.md#get_churn) | **GET** /analytics/churn/{start-datetime}/{end-datetime} | Gets churn, within a date range. -[**get_debts**](AnalyticsApi.md#get_debts) | **GET** /analytics/payments/outstanding/{start-datetime}/{end-datetime} | Gets debts within a date range. -[**get_payments**](AnalyticsApi.md#get_payments) | **GET** /analytics/payments/{start-datetime}/{end-datetime} | Gets payments within a date range. -[**get_product_payments**](AnalyticsApi.md#get_product_payments) | **POST** /analytics/payments-per-product | Gets hourly payments per product, within a date range. -[**get_product_rate_plan_payments**](AnalyticsApi.md#get_product_rate_plan_payments) | **POST** /analytics/payments/product-rate-plan | Gets hourly payments per product, within a date range. -[**get_subscription_ltv**](AnalyticsApi.md#get_subscription_ltv) | **GET** /analytics/subscription-ltv/{subscription-id}/{end-datetime} | Gets a subscription's life-time value, as of a given end date. -[**get_upgrades**](AnalyticsApi.md#get_upgrades) | **GET** /analytics/upgrades/{start-datetime}/{end-datetime} | Gets upgrades, within a date range. - - -# **get_account_debts** -> AccountPaymentsResultPagedMetadata get_account_debts(debts_per_account) - -Gets outstanding debts per account, within a date range. - -{\"nickname\" : \"Get account debts\",\"response\" : \"getAccountDebts.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AnalyticsApi() -debts_per_account = billforward.BillingEntityBase() # BillingEntityBase | The payments-per-account object. - -try: - # Gets outstanding debts per account, within a date range. - api_response = api_instance.get_account_debts(debts_per_account) - pprint(api_response) -except ApiException as e: - print "Exception when calling AnalyticsApi->get_account_debts: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **debts_per_account** | [**BillingEntityBase**](BillingEntityBase.md)| The payments-per-account object. | - -### Return type - -[**AccountPaymentsResultPagedMetadata**](AccountPaymentsResultPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_account_ltv** -> AccountLTVResultPagedMetadata get_account_ltv(account_id, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Gets an account's life-time value, as of a given end date. - -{\"nickname\":\"Get account life-time value\",\"response\":\"getAccountLTV.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AnalyticsApi() -account_id = 'account_id_example' # str | The id of the account. -end_datetime = 'end_datetime_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Gets an account's life-time value, as of a given end date. - api_response = api_instance.get_account_ltv(account_id, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling AnalyticsApi->get_account_ltv: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **str**| The id of the account. | - **end_datetime** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**AccountLTVResultPagedMetadata**](AccountLTVResultPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_account_payments** -> AccountPaymentsResultPagedMetadata get_account_payments(payments_per_account) - -Gets hourly payments per product, within a date range. - -{\"nickname\" : \"Get payments per account\",\"response\" : \"getAccountPayments.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AnalyticsApi() -payments_per_account = billforward.BillingEntityBase() # BillingEntityBase | The payments-per-account object. - -try: - # Gets hourly payments per product, within a date range. - api_response = api_instance.get_account_payments(payments_per_account) - pprint(api_response) -except ApiException as e: - print "Exception when calling AnalyticsApi->get_account_payments: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payments_per_account** | [**BillingEntityBase**](BillingEntityBase.md)| The payments-per-account object. | - -### Return type - -[**AccountPaymentsResultPagedMetadata**](AccountPaymentsResultPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_billforward_managed_payments** -> BillforwardManagedPaymentsResultPagedMetadata get_billforward_managed_payments(start_datetime, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Gets all payments managed by BillForward, within a date range. - -{\"nickname\":\"Get managed payments\",\"response\":\"getManagedPayments.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AnalyticsApi() -start_datetime = 'start_datetime_example' # str | The UTC DateTime specifying the start of the result period. -end_datetime = 'end_datetime_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Gets all payments managed by BillForward, within a date range. - api_response = api_instance.get_billforward_managed_payments(start_datetime, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling AnalyticsApi->get_billforward_managed_payments: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **start_datetime** | **str**| The UTC DateTime specifying the start of the result period. | - **end_datetime** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**BillforwardManagedPaymentsResultPagedMetadata**](BillforwardManagedPaymentsResultPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_churn** -> CassChurnResultPagedMetadata get_churn(start_datetime, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Gets churn, within a date range. - -{\"nickname\":\"Get churn\",\"response\":\"getChurn.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AnalyticsApi() -start_datetime = 'start_datetime_example' # str | The UTC DateTime specifying the start of the result period. -end_datetime = 'end_datetime_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Gets churn, within a date range. - api_response = api_instance.get_churn(start_datetime, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling AnalyticsApi->get_churn: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **start_datetime** | **str**| The UTC DateTime specifying the start of the result period. | - **end_datetime** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**CassChurnResultPagedMetadata**](CassChurnResultPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_debts** -> DebtsResultPagedMetadata get_debts(start_datetime, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Gets debts within a date range. - -{\"nickname\":\"Get debts\",\"response\":\"getDebts.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AnalyticsApi() -start_datetime = 'start_datetime_example' # str | The UTC DateTime specifying the start of the result period. -end_datetime = 'end_datetime_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Gets debts within a date range. - api_response = api_instance.get_debts(start_datetime, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling AnalyticsApi->get_debts: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **start_datetime** | **str**| The UTC DateTime specifying the start of the result period. | - **end_datetime** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**DebtsResultPagedMetadata**](DebtsResultPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_payments** -> CassPaymentResultPagedMetadata get_payments(start_datetime, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Gets payments within a date range. - -{\"nickname\":\"Get all payments\",\"response\":\"getPayments.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AnalyticsApi() -start_datetime = 'start_datetime_example' # str | The UTC DateTime specifying the start of the result period. -end_datetime = 'end_datetime_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Gets payments within a date range. - api_response = api_instance.get_payments(start_datetime, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling AnalyticsApi->get_payments: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **start_datetime** | **str**| The UTC DateTime specifying the start of the result period. | - **end_datetime** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**CassPaymentResultPagedMetadata**](CassPaymentResultPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_product_payments** -> ProductPaymentsResultPagedMetadata get_product_payments(payments_per_product) - -Gets hourly payments per product, within a date range. - -{\"nickname\" : \"Get payments per product\",\"response\" : \"getProductPayments.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AnalyticsApi() -payments_per_product = billforward.BillingEntityBase() # BillingEntityBase | The payments-per-product object. - -try: - # Gets hourly payments per product, within a date range. - api_response = api_instance.get_product_payments(payments_per_product) - pprint(api_response) -except ApiException as e: - print "Exception when calling AnalyticsApi->get_product_payments: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payments_per_product** | [**BillingEntityBase**](BillingEntityBase.md)| The payments-per-product object. | - -### Return type - -[**ProductPaymentsResultPagedMetadata**](ProductPaymentsResultPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_product_rate_plan_payments** -> ProductRatePlanPaymentsResultPagedMetadata get_product_rate_plan_payments(payments_per_product_rate_plan) - -Gets hourly payments per product, within a date range. - -{\"nickname\" : \"Get payments per rate plan\",\"response\" : \"getRatePlanPayments.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AnalyticsApi() -payments_per_product_rate_plan = billforward.BillingEntityBase() # BillingEntityBase | The payments-per-product-rate-plan object. - -try: - # Gets hourly payments per product, within a date range. - api_response = api_instance.get_product_rate_plan_payments(payments_per_product_rate_plan) - pprint(api_response) -except ApiException as e: - print "Exception when calling AnalyticsApi->get_product_rate_plan_payments: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payments_per_product_rate_plan** | [**BillingEntityBase**](BillingEntityBase.md)| The payments-per-product-rate-plan object. | - -### Return type - -[**ProductRatePlanPaymentsResultPagedMetadata**](ProductRatePlanPaymentsResultPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_subscription_ltv** -> SubscriptionLTVResultPagedMetadata get_subscription_ltv(subscription_id, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Gets a subscription's life-time value, as of a given end date. - -{\"nickname\":\"Get sub life-time value\",\"response\":\"getSubscriptionLTV.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AnalyticsApi() -subscription_id = 'subscription_id_example' # str | The id of the subscription. -end_datetime = 'end_datetime_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Gets a subscription's life-time value, as of a given end date. - api_response = api_instance.get_subscription_ltv(subscription_id, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling AnalyticsApi->get_subscription_ltv: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| The id of the subscription. | - **end_datetime** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**SubscriptionLTVResultPagedMetadata**](SubscriptionLTVResultPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_upgrades** -> CassUpgradeResultPagedMetadata get_upgrades(start_datetime, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Gets upgrades, within a date range. - -{\"nickname\":\"Get upgrades\",\"response\":\"getUpgrades.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AnalyticsApi() -start_datetime = 'start_datetime_example' # str | The UTC DateTime specifying the start of the result period. -end_datetime = 'end_datetime_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Gets upgrades, within a date range. - api_response = api_instance.get_upgrades(start_datetime, end_datetime, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling AnalyticsApi->get_upgrades: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **start_datetime** | **str**| The UTC DateTime specifying the start of the result period. | - **end_datetime** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**CassUpgradeResultPagedMetadata**](CassUpgradeResultPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/ArrearsCharge.md b/docs/ArrearsCharge.md new file mode 100644 index 0000000..6c7b28c --- /dev/null +++ b/docs/ArrearsCharge.md @@ -0,0 +1,11 @@ +# ArrearsCharge + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pricing_component_id** | **str** | | +**unit_of_measure_id** | **str** | | +**pricing_component_value** | **int** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ArrearsPricingComponentsByChargeModel.md b/docs/ArrearsPricingComponentsByChargeModel.md new file mode 100644 index 0000000..df094c1 --- /dev/null +++ b/docs/ArrearsPricingComponentsByChargeModel.md @@ -0,0 +1,11 @@ +# ArrearsPricingComponentsByChargeModel + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**flat** | [**list[FlatArrearsPricingComponent]**](FlatArrearsPricingComponent.md) | | [optional] +**tiered** | [**list[TieredArrearsPricingComponent]**](TieredArrearsPricingComponent.md) | | [optional] +**volume** | [**list[TieredArrearsPricingComponent]**](TieredArrearsPricingComponent.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AuditEntry.md b/docs/AuditEntry.md deleted file mode 100644 index 685f78d..0000000 --- a/docs/AuditEntry.md +++ /dev/null @@ -1,19 +0,0 @@ -# AuditEntry - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**changed_by** | **str** | { \"description\" : \"ID of the user who made the change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**id** | **str** | { \"description\" : \"ID of the audit-entry.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the audit-entry.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**entity** | **str** | { \"description\" : \"The entity type.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**entity_id** | **str** | { \"description\" : \"ID of the entity.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**audit_action** | **str** | { \"description\" : \"update, insert\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**field_changes** | **list[str]** | { \"description\" : \"A description of the changes.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**new_entity** | **list[str]** | | -**state** | **str** | { \"description\" : \"The state of the audit entry.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AuditEntryPagedMetadata.md b/docs/AuditEntryPagedMetadata.md deleted file mode 100644 index 947bbbe..0000000 --- a/docs/AuditEntryPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# AuditEntryPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[AuditEntry]**](AuditEntry.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AuditlogsApi.md b/docs/AuditlogsApi.md deleted file mode 100644 index 25da376..0000000 --- a/docs/AuditlogsApi.md +++ /dev/null @@ -1,298 +0,0 @@ -# billforward.AuditlogsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_all_audit_entries**](AuditlogsApi.md#get_all_audit_entries) | **GET** /audit-logs | Returns a collection of all audit-log objects. By default 10 values are returned. Records are returned in natural order. -[**get_audit_entries_by_created_date**](AuditlogsApi.md#get_audit_entries_by_created_date) | **GET** /audit-logs/created/{lower-threshold}/{upper-threshold} | Returns a collection of audit-log objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**get_audit_entry_by_entity_id**](AuditlogsApi.md#get_audit_entry_by_entity_id) | **GET** /audit-logs/entity/{entity-ID} | Returns a collection of audit-log entries, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_audit_entry_by_entity_type**](AuditlogsApi.md#get_audit_entry_by_entity_type) | **GET** /audit-logs/entity-type/{entity-type} | Returns a collection of audit-log entries, specified by the entity-type parameter. By default 10 values are returned. Records are returned in natural order. -[**get_audit_entry_by_id**](AuditlogsApi.md#get_audit_entry_by_id) | **GET** /audit-logs/{audit-ID} | Returns a single audit-log entry, specified by the audit-ID parameter. - - -# **get_all_audit_entries** -> AuditEntryPagedMetadata get_all_audit_entries(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of all audit-log objects. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all\",\"response\":\"getAuditAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AuditlogsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first audit-log entry to return. (optional) (default to 0) -records = 10 # int | The maximum number of audit-log entry to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of all audit-log objects. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_audit_entries(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling AuditlogsApi->get_all_audit_entries: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first audit-log entry to return. | [optional] [default to 0] - **records** | **int**| The maximum number of audit-log entry to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**AuditEntryPagedMetadata**](AuditEntryPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_audit_entries_by_created_date** -> AuditEntryPagedMetadata get_audit_entries_by_created_date(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of audit-log objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by created time\",\"response\":\"getAuditByCreated.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AuditlogsApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first audit-log entry to return. (optional) (default to 0) -records = 10 # int | The maximum number of audit-log entry to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of audit-log objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_audit_entries_by_created_date(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling AuditlogsApi->get_audit_entries_by_created_date: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first audit-log entry to return. | [optional] [default to 0] - **records** | **int**| The maximum number of audit-log entry to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**AuditEntryPagedMetadata**](AuditEntryPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_audit_entry_by_entity_id** -> AuditEntryPagedMetadata get_audit_entry_by_entity_id(entity_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of audit-log entries, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by entity-ID\",\"response\":\"getAuditByEntityID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AuditlogsApi() -entity_id = 'entity_id_example' # str | The string ID of the entity whose changes are documented by the audit log. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first account to return. (optional) (default to 0) -records = 10 # int | The maximum number of accounts to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of audit-log entries, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_audit_entry_by_entity_id(entity_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling AuditlogsApi->get_audit_entry_by_entity_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **entity_id** | **str**| The string ID of the entity whose changes are documented by the audit log. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first account to return. | [optional] [default to 0] - **records** | **int**| The maximum number of accounts to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**AuditEntryPagedMetadata**](AuditEntryPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_audit_entry_by_entity_type** -> AuditEntryPagedMetadata get_audit_entry_by_entity_type(entity_type, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of audit-log entries, specified by the entity-type parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by entity type\",\"response\":\"getAuditByEntityType.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AuditlogsApi() -entity_type = 'entity_type_example' # str | The type of the entity whose changes are documented by the audit log. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first account to return. (optional) (default to 0) -records = 10 # int | The maximum number of accounts to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of audit-log entries, specified by the entity-type parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_audit_entry_by_entity_type(entity_type, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling AuditlogsApi->get_audit_entry_by_entity_type: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **entity_type** | **str**| The type of the entity whose changes are documented by the audit log. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first account to return. | [optional] [default to 0] - **records** | **int**| The maximum number of accounts to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**AuditEntryPagedMetadata**](AuditEntryPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_audit_entry_by_id** -> AuditEntryPagedMetadata get_audit_entry_by_id(audit_id, organizations=organizations) - -Returns a single audit-log entry, specified by the audit-ID parameter. - -{\"nickname\":\"Retrieve by id\",\"response\":\"getAuditByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.AuditlogsApi() -audit_id = 'audit_id_example' # str | The string ID of the audit-log entry. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 (optional) - -try: - # Returns a single audit-log entry, specified by the audit-ID parameter. - api_response = api_instance.get_audit_entry_by_id(audit_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling AuditlogsApi->get_audit_entry_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **audit_id** | **str**| The string ID of the audit-log entry. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 | [optional] - -### Return type - -[**AuditEntryPagedMetadata**](AuditEntryPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/AuthCaptureRequest.md b/docs/AuthCaptureRequest.md index 1039c3a..5a12baa 100644 --- a/docs/AuthCaptureRequest.md +++ b/docs/AuthCaptureRequest.md @@ -3,17 +3,22 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**account_id** | **str** | | [optional] +**gateway** | **str** | | +**company_name** | **str** | | [optional] +**email** | **str** | | [optional] +**first_name** | **str** | | [optional] +**last_name** | **str** | | [optional] +**mobile** | **str** | | [optional] +**default_payment_method** | **bool** | | [optional] +**organization_id** | **str** | | [optional] +**ip_address** | **str** | | [optional] +**ip_address_country** | **str** | | [optional] +**email_tokenization_id** | **str** | | [optional] +**id** | **str** | | [optional] **type** | **str** | | -**account_id** | **str** | {\"description\":\"ID of the BillForward Account with which you would like to associate the created payment method.<br>If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.\",\"verbs\":[\"POST\"]} | [optional] -**gateway** | **str** | {\"description\":\"The gateway with which your funding instrument has been vaulted.\",\"verbs\":[\"POST\"]} | [optional] -**company_name** | **str** | {\"description\":\"The name of the company of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**email** | **str** | {\"description\":\"The email address of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**first_name** | **str** | {\"description\":\"The first name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**last_name** | **str** | {\"description\":\"The last name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**mobile** | **str** | {\"description\":\"The mobile phone number of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**default_payment_method** | **bool** | {\"default\":false,\"description\":\"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).\",\"verbs\":[\"POST\"]} | [optional] [default to False] -**organization_id** | **str** | {\"description\":\"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/AuthorizeNetConfiguration.md b/docs/AuthorizeNetConfiguration.md new file mode 100644 index 0000000..8de2fb5 --- /dev/null +++ b/docs/AuthorizeNetConfiguration.md @@ -0,0 +1,9 @@ +# AuthorizeNetConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**authorize_net_environment** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AuthorizeNetPayment.md b/docs/AuthorizeNetPayment.md new file mode 100644 index 0000000..d877d8d --- /dev/null +++ b/docs/AuthorizeNetPayment.md @@ -0,0 +1,8 @@ +# AuthorizeNetPayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AuthorizeNetToken.md b/docs/AuthorizeNetToken.md new file mode 100644 index 0000000..85c9291 --- /dev/null +++ b/docs/AuthorizeNetToken.md @@ -0,0 +1,19 @@ +# AuthorizeNetToken + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**account_id** | **str** | | +**card_details_id** | **str** | | [optional] +**organization_id** | **str** | | +**deleted** | **bool** | | +**customer_profile_id** | **str** | | +**customer_payment_profile_id** | **str** | | +**last_four_digits** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AuthorizeNetTokenPagedMetadata.md b/docs/AuthorizeNetTokenPagedMetadata.md deleted file mode 100644 index 724e7c4..0000000 --- a/docs/AuthorizeNetTokenPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# AuthorizeNetTokenPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AvataxApi.md b/docs/AvataxApi.md new file mode 100644 index 0000000..80ba4a5 --- /dev/null +++ b/docs/AvataxApi.md @@ -0,0 +1,197 @@ +# billforward.AvataxApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_avatax_configuration**](AvataxApi.md#create_avatax_configuration) | **POST** /tax/avatax | +[**get_avatax_configuration**](AvataxApi.md#get_avatax_configuration) | **GET** /tax/avatax | +[**ping**](AvataxApi.md#ping) | **POST** /tax/avatax/ping | +[**update_avatax_configuration**](AvataxApi.md#update_avatax_configuration) | **PUT** /tax/avatax/{avatax-config-ID} | + +# **create_avatax_configuration** +> InlineResponseDefault75 create_avatax_configuration(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.AvataxApi(billforward.ApiClient(configuration)) +body = billforward.AvataxConfigRequest() # AvataxConfigRequest | (optional) + +try: + api_response = api_instance.create_avatax_configuration(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AvataxApi->create_avatax_configuration: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**AvataxConfigRequest**](AvataxConfigRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault75**](InlineResponseDefault75.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_avatax_configuration** +> InlineResponseDefault74 get_avatax_configuration(organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.AvataxApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_avatax_configuration(organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling AvataxApi->get_avatax_configuration: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault74**](InlineResponseDefault74.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **ping** +> InlineResponseDefault76 ping(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.AvataxApi(billforward.ApiClient(configuration)) +body = billforward.AvataxPingRequest() # AvataxPingRequest | (optional) + +try: + api_response = api_instance.ping(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AvataxApi->ping: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**AvataxPingRequest**](AvataxPingRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault76**](InlineResponseDefault76.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_avatax_configuration** +> InlineResponseDefault75 update_avatax_configuration(avatax_config_id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.AvataxApi(billforward.ApiClient(configuration)) +avatax_config_id = 'avatax_config_id_example' # str | +body = billforward.AvataxConfigRequest() # AvataxConfigRequest | (optional) + +try: + api_response = api_instance.update_avatax_configuration(avatax_config_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling AvataxApi->update_avatax_configuration: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **avatax_config_id** | **str**| | + **body** | [**AvataxConfigRequest**](AvataxConfigRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault75**](InlineResponseDefault75.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/AvataxConfigRequest.md b/docs/AvataxConfigRequest.md new file mode 100644 index 0000000..7f14be0 --- /dev/null +++ b/docs/AvataxConfigRequest.md @@ -0,0 +1,18 @@ +# AvataxConfigRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**account_number** | **str** | | [optional] +**licence_key** | **str** | | [optional] +**company_code** | **str** | | [optional] +**address_id** | **str** | | [optional] +**enabled** | **bool** | | [optional] +**enable_logging** | **bool** | | [optional] +**commit_transactions** | **bool** | | [optional] +**address_validation** | **bool** | | [optional] +**prod_env** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AvataxConfiguration.md b/docs/AvataxConfiguration.md new file mode 100644 index 0000000..d90f8e9 --- /dev/null +++ b/docs/AvataxConfiguration.md @@ -0,0 +1,23 @@ +# AvataxConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | +**account_number** | **str** | | +**licence_key** | **str** | | +**company_code** | **str** | | +**address_id** | **str** | | +**enabled** | **bool** | | +**enable_logging** | **bool** | | +**commit_transactions** | **bool** | | +**address_validation** | **bool** | | +**prod_env** | **bool** | | +**deleted** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AvataxPingRequest.md b/docs/AvataxPingRequest.md new file mode 100644 index 0000000..76c062f --- /dev/null +++ b/docs/AvataxPingRequest.md @@ -0,0 +1,14 @@ +# AvataxPingRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**license_key** | **str** | | [optional] +**prod_env** | **bool** | | [optional] +**enable_logging** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AvataxPingResponse.md b/docs/AvataxPingResponse.md new file mode 100644 index 0000000..d8426c3 --- /dev/null +++ b/docs/AvataxPingResponse.md @@ -0,0 +1,10 @@ +# AvataxPingResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BFError.md b/docs/BFError.md deleted file mode 100644 index a726d28..0000000 --- a/docs/BFError.md +++ /dev/null @@ -1,13 +0,0 @@ -# BFError - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error_type** | **str** | {\"description\":\"Enum categorizing the nature of the error.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | [optional] -**error_message** | **str** | {\"description\":\"Human-readable description of the reason for the error.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | [optional] -**error_code** | **int** | {\"description\":\"Code describing the nature of the error. Currently unused; prefer `errorType`.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | [optional] -**error_parameters** | **list[str]** | {\"description\":\"List of erroneous parameters found in your input (if applicable).\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/BFPermission.md b/docs/BFPermission.md index 4149709..c8dd478 100644 --- a/docs/BFPermission.md +++ b/docs/BFPermission.md @@ -3,17 +3,17 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**role_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\", \"POST\"] } | [optional] -**role_name** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\", \"POST\"] } | [optional] -**resource** | **str** | { \"description\" : \"BillForward resource associated with this permission.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] -**action** | **str** | { \"description\" : \"Action they may be performed on the associated resource.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] -**revoked** | **datetime** | { \"description\" : \"If a permission is deleted it is set as revoked from this date. The role with this permission will no longer have its applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] -**deleted** | **bool** | { \"default\" : \"false\", \"description\" : \"If a permission is deleted the role with this permission will no longer have its applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] [default to False] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**role_id** | **str** | | [optional] +**role_name** | **str** | | [optional] +**resource** | **str** | | [optional] +**action** | **str** | | [optional] +**revoked** | **datetime** | | [optional] +**deleted** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/BFPermissionPagedMetadata.md b/docs/BFPermissionPagedMetadata.md deleted file mode 100644 index 88120f7..0000000 --- a/docs/BFPermissionPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# BFPermissionPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BFPermission]**](BFPermission.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/BankAccount.md b/docs/BankAccount.md new file mode 100644 index 0000000..5ffec33 --- /dev/null +++ b/docs/BankAccount.md @@ -0,0 +1,21 @@ +# BankAccount + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**routing_number** | **str** | | +**account_number** | **str** | | +**payment_method_id** | **str** | | [optional] +**country** | **str** | | [optional] +**holder_name** | **str** | | [optional] +**account_holder_type** | **str** | | [optional] +**verification_status** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BankAccountVerificationPagedMetadata.md b/docs/BankAccountVerificationPagedMetadata.md deleted file mode 100644 index 786a722..0000000 --- a/docs/BankAccountVerificationPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# BankAccountVerificationPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/BatchIncrementValuesRequest.md b/docs/BatchIncrementValuesRequest.md new file mode 100644 index 0000000..0506e1c --- /dev/null +++ b/docs/BatchIncrementValuesRequest.md @@ -0,0 +1,10 @@ +# BatchIncrementValuesRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**values** | [**list[ValueIncrement]**](ValueIncrement.md) | | +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BatchUpdatePricingComponentValuesRequest.md b/docs/BatchUpdatePricingComponentValuesRequest.md new file mode 100644 index 0000000..6edb009 --- /dev/null +++ b/docs/BatchUpdatePricingComponentValuesRequest.md @@ -0,0 +1,11 @@ +# BatchUpdatePricingComponentValuesRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**values** | [**list[UpdatePricingComponentValueRequest]**](UpdatePricingComponentValueRequest.md) | | +**issue_invoice_mode** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BillforwardManagedPaymentsResultPagedMetadata.md b/docs/BillforwardManagedPaymentsResultPagedMetadata.md deleted file mode 100644 index b3c85e5..0000000 --- a/docs/BillforwardManagedPaymentsResultPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# BillforwardManagedPaymentsResultPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/BillingEntityBase.md b/docs/BillingEntityBase.md index 437ec25..09bc92c 100644 --- a/docs/BillingEntityBase.md +++ b/docs/BillingEntityBase.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/BraintreeAuthCaptureRequest.md b/docs/BraintreeAuthCaptureRequest.md index fc3d296..21ea174 100644 --- a/docs/BraintreeAuthCaptureRequest.md +++ b/docs/BraintreeAuthCaptureRequest.md @@ -3,19 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | | -**account_id** | **str** | {\"description\":\"ID of the BillForward Account with which you would like to associate the created payment method.<br>If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.\",\"verbs\":[\"POST\"]} | [optional] -**gateway** | **str** | {\"description\":\"The gateway with which your funding instrument has been vaulted.\",\"verbs\":[\"POST\"]} | [optional] -**company_name** | **str** | {\"description\":\"The name of the company of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**email** | **str** | {\"description\":\"The email address of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**first_name** | **str** | {\"description\":\"The first name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**last_name** | **str** | {\"description\":\"The last name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**mobile** | **str** | {\"description\":\"The mobile phone number of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**default_payment_method** | **bool** | {\"default\":false,\"description\":\"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).\",\"verbs\":[\"POST\"]} | [optional] [default to False] -**organization_id** | **str** | {\"description\":\"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional] -**payment_method_nonce** | **str** | {\"description\":\"One-use cryptographic nonce <a href=\\\"https://developers.braintreepayments.com/javascript+node/start/overview\\\">provided by Braintree's client-side card capture SDK</a>, in response to your capturing a card into the Braintree vault. This nonce will be used by BillForward to find the tokenized card within the Braintree vault &mdash; precursory to linking a BillForward PaymentMethod to that tokenized card\",\"verbs\":[\"POST\"]} | -**device_data** | **str** | {\"description\":\"(Required when vaulting a PayPal payment method; otherwise optional)<br>A JSON string providing information about the device your customer used to fill out the card capture form. This information is inserted into your form by <a href=\\\"https://developers.braintreepayments.com/javascript+node/guides/advanced-fraud-tools/client-side\\\">braintree-data.js</a> &mdash; if and only if you use Braintree's drop-in form integrations. You should ideally provide it if you have one (it aids with fraud detection), but it is only mandatory in the case of PayPal payment method vaulting.\",\"verbs\":[\"POST\"]} | [optional] +**payment_method_nonce** | **str** | | +**device_data** | **str** | | [optional] +**merchant_account_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/BraintreeCaptureRequest.md b/docs/BraintreeCaptureRequest.md index d2f4b4c..3866343 100644 --- a/docs/BraintreeCaptureRequest.md +++ b/docs/BraintreeCaptureRequest.md @@ -3,20 +3,19 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**organization_id** | **str** | {\"description\":\"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional] -**account_id** | **str** | {\"description\":\"ID of the BillForward Account with which you would like to associate the created payment method.<br>If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.\",\"verbs\":[\"POST\"]} | [optional] -**default_payment_method** | **bool** | {\"default\":false,\"description\":\"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).\",\"verbs\":[\"POST\"]} | [optional] [default to False] -**cardholder_name** | **str** | {\"description\":\"Name of the person who holds the credit card being captured.\",\"verbs\":[\"POST\"]} | -**card_number** | **str** | {\"description\":\"Number of the credit card being captured.\",\"verbs\":[\"POST\"]} | -**expiry_month** | **str** | {\"description\":\"Expiration month of the credit card being captured, formatted MM.\",\"verbs\":[\"POST\"]} | -**expiry_year** | **str** | {\"description\":\"Expiration year of the credit card being captured, formatted YYYY or YY.\",\"verbs\":[\"POST\"]} | -**cvv** | **str** | {\"description\":\"3 or 4 digit card verification value assigned to the credit card being captured.\",\"verbs\":[\"POST\"]} | -**device_data** | **str** | {\"description\":\"(Required when vaulting a PayPal payment method; otherwise optional)<br>A JSON string providing information about the device your customer used to fill out the card capture form. This information is inserted into your form by <a href=\\\"https://developers.braintreepayments.com/javascript+node/guides/advanced-fraud-tools/client-side\\\">braintree-data.js</a> &mdash; if and only if you use Braintree's drop-in form integrations. You should ideally provide it if you have one (it aids with fraud detection), but it is only mandatory in the case of PayPal payment method vaulting.\",\"verbs\":[\"POST\"]} | [optional] -**merchant_account_id** | **str** | {\"description\":\"Braintree <a href=\\\"https://articles.braintreepayments.com/control-panel/important-gateway-credentials\\\">Merchant account ID</a> with which you wish for the captured funding instrument to transact. Within your Braintree gateway, you can have multiple merchant accounts to process transactions for different businesses or currencies. If you have a single merchant account, it is not necessary to specify a merchant account ID in your API requests. If you have multiple merchant accounts and choose not to specify the merchant account ID, all requests will process through your default merchant account.\",\"verbs\":[\"POST\"]} | [optional] -**ip_address** | **str** | {\"description\":\"IP address of the customer providing the details of the credit card to be captured.\",\"verbs\":[\"POST\"]} | [optional] -**ip_address_country** | **str** | {\"description\":\"Country of the IP address of the customer providing the details of the credit card to be captured.\",\"verbs\":[\"POST\"]} | [optional] +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**default_payment_method** | **bool** | | [optional] +**cardholder_name** | **str** | | [optional] +**card_number** | **str** | | [optional] +**expiry_month** | **str** | | [optional] +**expiry_year** | **str** | | [optional] +**cvv** | **str** | | [optional] +**device_data** | **str** | | [optional] +**merchant_account_id** | **str** | | [optional] +**ip_address** | **str** | | [optional] +**ip_address_country** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/BraintreeConfiguration.md b/docs/BraintreeConfiguration.md new file mode 100644 index 0000000..7fe3cda --- /dev/null +++ b/docs/BraintreeConfiguration.md @@ -0,0 +1,9 @@ +# BraintreeConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_accounts** | [**list[BraintreeMerchantAccount]**](BraintreeMerchantAccount.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BraintreeMerchantAccount.md b/docs/BraintreeMerchantAccount.md new file mode 100644 index 0000000..a13c8b8 --- /dev/null +++ b/docs/BraintreeMerchantAccount.md @@ -0,0 +1,16 @@ +# BraintreeMerchantAccount + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**configuration_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**merchant_account_id** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/DynamicMetadata.md b/docs/BraintreePayment.md similarity index 93% rename from docs/DynamicMetadata.md rename to docs/BraintreePayment.md index 9d6f703..65dd7ea 100644 --- a/docs/DynamicMetadata.md +++ b/docs/BraintreePayment.md @@ -1,4 +1,4 @@ -# DynamicMetadata +# BraintreePayment ## Properties Name | Type | Description | Notes @@ -6,4 +6,3 @@ Name | Type | Description | Notes [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/BraintreePreAuthRequest.md b/docs/BraintreePreAuthRequest.md new file mode 100644 index 0000000..ab6ab46 --- /dev/null +++ b/docs/BraintreePreAuthRequest.md @@ -0,0 +1,9 @@ +# BraintreePreAuthRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BraintreeToken.md b/docs/BraintreeToken.md new file mode 100644 index 0000000..20c1e7c --- /dev/null +++ b/docs/BraintreeToken.md @@ -0,0 +1,20 @@ +# BraintreeToken + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**account_id** | **str** | | +**card_details_id** | **str** | | [optional] +**organization_id** | **str** | | +**customer_id** | **str** | | +**credit_card_id** | **str** | | +**device_data** | **str** | | [optional] +**merchant_account_id** | **str** | | [optional] +**deleted** | **bool** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BraintreeTokenPagedMetadata.md b/docs/BraintreeTokenPagedMetadata.md deleted file mode 100644 index 69b56a0..0000000 --- a/docs/BraintreeTokenPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# BraintreeTokenPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CalculatorResult.md b/docs/CalculatorResult.md new file mode 100644 index 0000000..aab3269 --- /dev/null +++ b/docs/CalculatorResult.md @@ -0,0 +1,10 @@ +# CalculatorResult + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **float** | | [optional] +**commission_structure** | [**CommissionStructure**](CommissionStructure.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CancelSubscriptionRequest.md b/docs/CancelSubscriptionRequest.md deleted file mode 100644 index 3a765d7..0000000 --- a/docs/CancelSubscriptionRequest.md +++ /dev/null @@ -1,16 +0,0 @@ -# CancelSubscriptionRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**subscription_id** | **str** | | -**state** | **str** | | [optional] -**source** | **str** | | -**service_end** | **str** | | [optional] -**cancellation_credit** | **str** | Specifies whether the service will end immediately on cancellation or if it will continue until the end of the current period. Default: AtPeriodEnd | [optional] -**cancel_children** | **bool** | | [optional] -**cancel_empty_parent** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CancellationAmendment.md b/docs/CancellationAmendment.md index 7125727..a177ddd 100644 --- a/docs/CancellationAmendment.md +++ b/docs/CancellationAmendment.md @@ -3,24 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] -**source** | **str** | { \"description\" : \"Explanation for cancellation\", \"default\" : \"API\", \"verbs\":[\"POST\",\"GET\"] } | -**subscription_cancellation_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | [optional] -**service_end** | **str** | { \"description\" : \"If the serviceEnd parameter is <span class=\\\"label label-default\\\">AtPeriodEnd</span> the cancellation will be delayed till the end of the current period.\", \"default\" : \"AtPeriodEnd\", \"verbs\":[\"POST\",\"GET\"] } | -**cancellation_credit** | **str** | Specifies whether the service will end immediately on cancellation or if it will continue until the end of the current period. Default: AtPeriodEnd | -**subscription_cancellation** | [**MutableBillingEntity**](MutableBillingEntity.md) | { \"description\" : \"\", \"verbs\":[] } | [optional] +**source** | **str** | | +**subscription_cancellation_id** | **str** | | [optional] +**service_end** | **str** | | +**cancellation_credit** | **str** | | +**subscription_cancellation** | [**SubscriptionCancellation**](SubscriptionCancellation.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CardConnectApi.md b/docs/CardConnectApi.md new file mode 100644 index 0000000..e38defc --- /dev/null +++ b/docs/CardConnectApi.md @@ -0,0 +1,150 @@ +# billforward.CardConnectApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete_configuration**](CardConnectApi.md#delete_configuration) | **DELETE** /cardconnect | +[**get_configuration**](CardConnectApi.md#get_configuration) | **GET** /cardconnect | +[**upsert_configuration**](CardConnectApi.md#upsert_configuration) | **POST** /cardconnect | + +# **delete_configuration** +> APIConfiguration delete_configuration(organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.CardConnectApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.delete_configuration(organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling CardConnectApi->delete_configuration: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**APIConfiguration**](APIConfiguration.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_configuration** +> InlineResponseDefault14 get_configuration(organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.CardConnectApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_configuration(organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling CardConnectApi->get_configuration: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault14**](InlineResponseDefault14.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **upsert_configuration** +> InlineResponseDefault14 upsert_configuration(body=body, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.CardConnectApi(billforward.ApiClient(configuration)) +body = billforward.CardConnectGatewayRequest() # CardConnectGatewayRequest | (optional) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.upsert_configuration(body=body, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling CardConnectApi->upsert_configuration: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CardConnectGatewayRequest**](CardConnectGatewayRequest.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault14**](InlineResponseDefault14.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/CardConnectAuthCaptureRequest.md b/docs/CardConnectAuthCaptureRequest.md new file mode 100644 index 0000000..49b84d3 --- /dev/null +++ b/docs/CardConnectAuthCaptureRequest.md @@ -0,0 +1,10 @@ +# CardConnectAuthCaptureRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tokenized_card_number** | **str** | | [optional] +**expiry** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CardConnectConfiguration.md b/docs/CardConnectConfiguration.md new file mode 100644 index 0000000..6ead4da --- /dev/null +++ b/docs/CardConnectConfiguration.md @@ -0,0 +1,8 @@ +# CardConnectConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CardConnectGatewayRequest.md b/docs/CardConnectGatewayRequest.md new file mode 100644 index 0000000..60d7c1c --- /dev/null +++ b/docs/CardConnectGatewayRequest.md @@ -0,0 +1,12 @@ +# CardConnectGatewayRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**username** | **str** | | [optional] +**password** | **str** | | [optional] +**site** | **str** | | [optional] +**mid** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CardConnectPayment.md b/docs/CardConnectPayment.md new file mode 100644 index 0000000..dd677db --- /dev/null +++ b/docs/CardConnectPayment.md @@ -0,0 +1,8 @@ +# CardConnectPayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CassChurnResultPagedMetadata.md b/docs/CassChurnResultPagedMetadata.md deleted file mode 100644 index 5b71267..0000000 --- a/docs/CassChurnResultPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# CassChurnResultPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CassPaymentResultPagedMetadata.md b/docs/CassPaymentResultPagedMetadata.md deleted file mode 100644 index 1a89c4e..0000000 --- a/docs/CassPaymentResultPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# CassPaymentResultPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CassUpgradeResultPagedMetadata.md b/docs/CassUpgradeResultPagedMetadata.md deleted file mode 100644 index 0939b90..0000000 --- a/docs/CassUpgradeResultPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# CassUpgradeResultPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ChargesApi.md b/docs/ChargesApi.md index 4e0d957..73fc34d 100644 --- a/docs/ChargesApi.md +++ b/docs/ChargesApi.md @@ -1,244 +1,119 @@ # billforward.ChargesApi -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_all_subscription_charges**](ChargesApi.md#get_all_subscription_charges) | **GET** /charges | Retrieves a collection of all charges. By default 10 values are returned. Records are returned in natural order. -[**get_subscription_charge_by_account_id**](ChargesApi.md#get_subscription_charge_by_account_id) | **GET** /charges/account/{account-ID} | Retrieves a collection of charges, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_subscription_charge_by_id**](ChargesApi.md#get_subscription_charge_by_id) | **GET** /charges/{charge-id} | Retrieves a single charge, specified by the charge-id parameter. -[**get_subscription_charge_by_state**](ChargesApi.md#get_subscription_charge_by_state) | **GET** /charges/state/{state} | Retrieves a collection of charges, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -[**get_subscription_charge_by_version_id**](ChargesApi.md#get_subscription_charge_by_version_id) | **GET** /charges/version/{version-ID} | Retrieves a single charge, specified by the version-ID parameter. -[**recalculate_subscription_charge**](ChargesApi.md#recalculate_subscription_charge) | **POST** /charges/{charge-ID}/recalculate | Recalculate a charge. -[**void_subscription_charge**](ChargesApi.md#void_subscription_charge) | **DELETE** /charges/{charge-id} | Void the charge with the specified charge-ID. +[**batch_recalculate_subscription_charge**](ChargesApi.md#batch_recalculate_subscription_charge) | **POST** /charges/recalculate | +[**get_all_subscription_charges**](ChargesApi.md#get_all_subscription_charges) | **GET** /charges | +[**get_subscription_charge_by_id**](ChargesApi.md#get_subscription_charge_by_id) | **GET** /charges/{charge-id} | +[**recalculate_subscription_charge**](ChargesApi.md#recalculate_subscription_charge) | **POST** /charges/{charge-ID}/recalculate | +[**void_subscription_charge**](ChargesApi.md#void_subscription_charge) | **DELETE** /charges/{charge-id} | +# **batch_recalculate_subscription_charge** +> InlineResponseDefault15 batch_recalculate_subscription_charge(body=body) -# **get_all_subscription_charges** -> SubscriptionChargePagedMetadata get_all_subscription_charges(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Retrieves a collection of all charges. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve all charges\",\"response\":\"getChargeAll.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint -# create an instance of the API class -api_instance = billforward.ChargesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Retrieves a collection of all charges. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_subscription_charges(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling ChargesApi->get_all_subscription_charges: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] - -### Return type - -[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_subscription_charge_by_account_id** -> SubscriptionChargePagedMetadata get_subscription_charge_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Retrieves a collection of charges, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by account\",\"response\":\"getChargeByAccount.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint # create an instance of the API class -api_instance = billforward.ChargesApi() -account_id = 'account_id_example' # str | The string ID of the account -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Retrieves a collection of charges, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_subscription_charge_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling ChargesApi->get_subscription_charge_by_account_id: %s\n" % e -``` - -### Parameters +api_instance = billforward.ChargesApi(billforward.ApiClient(configuration)) +body = billforward.RecalculateChargeBatchRequest() # RecalculateChargeBatchRequest | (optional) -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **str**| The string ID of the account | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] - -### Return type - -[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_subscription_charge_by_id** -> SubscriptionChargePagedMetadata get_subscription_charge_by_id(charge_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Retrieves a single charge, specified by the charge-id parameter. - -{\"nickname\":\"Retrieve a charge\",\"response\":\"getChargeByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ChargesApi() -charge_id = 'charge_id_example' # str | The unique string-ID of the subscription. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Retrieves a single charge, specified by the charge-id parameter. - api_response = api_instance.get_subscription_charge_by_id(charge_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +try: + api_response = api_instance.batch_recalculate_subscription_charge(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling ChargesApi->get_subscription_charge_by_id: %s\n" % e + print("Exception when calling ChargesApi->batch_recalculate_subscription_charge: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **charge_id** | **str**| The unique string-ID of the subscription. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **body** | [**RecalculateChargeBatchRequest**](RecalculateChargeBatchRequest.md)| | [optional] ### Return type -[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md) +[**InlineResponseDefault15**](InlineResponseDefault15.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_subscription_charge_by_state** -> SubscriptionChargePagedMetadata get_subscription_charge_by_state(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +# **get_all_subscription_charges** +> InlineResponseDefault10 get_all_subscription_charges(account_id=account_id, product_rate_plan=product_rate_plan, state=state, pricing_component_type=pricing_component_type, parent_invoice_id=parent_invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a collection of charges, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by state\",\"response\":\"getChargeByState.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.ChargesApi() -state = 'state_example' # str | The current state of the charge -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Retrieves a collection of charges, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_subscription_charge_by_state(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +api_instance = billforward.ChargesApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | (optional) +product_rate_plan = 'product_rate_plan_example' # str | (optional) +state = 'state_example' # str | (optional) +pricing_component_type = 'pricing_component_type_example' # str | (optional) +parent_invoice_id = ['parent_invoice_id_example'] # list[str] | (optional) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_all_subscription_charges(account_id=account_id, product_rate_plan=product_rate_plan, state=state, pricing_component_type=pricing_component_type, parent_invoice_id=parent_invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling ChargesApi->get_subscription_charge_by_state: %s\n" % e + print("Exception when calling ChargesApi->get_all_subscription_charges: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **state** | **str**| The current state of the charge | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **account_id** | **str**| | [optional] + **product_rate_plan** | **str**| | [optional] + **state** | **str**| | [optional] + **pricing_component_type** | **str**| | [optional] + **parent_invoice_id** | [**list[str]**](str.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md) +[**InlineResponseDefault10**](InlineResponseDefault10.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -247,145 +122,152 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_subscription_charge_by_version_id** -> SubscriptionChargePagedMetadata get_subscription_charge_by_version_id(version_id, organizations=organizations) +# **get_subscription_charge_by_id** +> InlineResponseDefault16 get_subscription_charge_by_id(charge_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a single charge, specified by the version-ID parameter. -{\"nickname\":\"Retrieve by version\",\"response\":\"getChargeByVersionID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint -# create an instance of the API class -api_instance = billforward.ChargesApi() -version_id = 'version_id_example' # str | The version-ID of the charge. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -try: - # Retrieves a single charge, specified by the version-ID parameter. - api_response = api_instance.get_subscription_charge_by_version_id(version_id, organizations=organizations) +# create an instance of the API class +api_instance = billforward.ChargesApi(billforward.ApiClient(configuration)) +charge_id = 'charge_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_subscription_charge_by_id(charge_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling ChargesApi->get_subscription_charge_by_version_id: %s\n" % e + print("Exception when calling ChargesApi->get_subscription_charge_by_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **version_id** | **str**| The version-ID of the charge. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **charge_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md) +[**InlineResponseDefault16**](InlineResponseDefault16.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **recalculate_subscription_charge** -> SubscriptionChargePagedMetadata recalculate_subscription_charge(charge_id, charge) +> InlineResponseDefault10 recalculate_subscription_charge(charge_id, body=body) -Recalculate a charge. -{\"nickname\":\"Re-calculate a charge\",\"request\":\"recalculateChargeRequest.html\",\"response\":\"recalculateChargeResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.ChargesApi() -charge_id = 'charge_id_example' # str | Unique id of the charge. -charge = billforward.RecalculateChargeRequest() # RecalculateChargeRequest | The charge to be re-calculated. +api_instance = billforward.ChargesApi(billforward.ApiClient(configuration)) +charge_id = 'charge_id_example' # str | +body = billforward.RecalculateChargeRequest() # RecalculateChargeRequest | (optional) -try: - # Recalculate a charge. - api_response = api_instance.recalculate_subscription_charge(charge_id, charge) +try: + api_response = api_instance.recalculate_subscription_charge(charge_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling ChargesApi->recalculate_subscription_charge: %s\n" % e + print("Exception when calling ChargesApi->recalculate_subscription_charge: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **charge_id** | **str**| Unique id of the charge. | - **charge** | [**RecalculateChargeRequest**](RecalculateChargeRequest.md)| The charge to be re-calculated. | + **charge_id** | **str**| | + **body** | [**RecalculateChargeRequest**](RecalculateChargeRequest.md)| | [optional] ### Return type -[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md) +[**InlineResponseDefault10**](InlineResponseDefault10.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **void_subscription_charge** -> SubscriptionChargePagedMetadata void_subscription_charge(charge_id, organizations=organizations) +> InlineResponseDefault16 void_subscription_charge(charge_id, organizations=organizations) -Void the charge with the specified charge-ID. -{\"nickname\":\"Void charge\",\"response\":\"deleteCharge.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.ChargesApi() -charge_id = 'charge_id_example' # str | Unique id of the charge. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +api_instance = billforward.ChargesApi(billforward.ApiClient(configuration)) +charge_id = 'charge_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Void the charge with the specified charge-ID. +try: api_response = api_instance.void_subscription_charge(charge_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling ChargesApi->void_subscription_charge: %s\n" % e + print("Exception when calling ChargesApi->void_subscription_charge: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **charge_id** | **str**| Unique id of the charge. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **charge_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md) +[**InlineResponseDefault16**](InlineResponseDefault16.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/CheckoutApi.md b/docs/CheckoutApi.md new file mode 100644 index 0000000..56e3ccf --- /dev/null +++ b/docs/CheckoutApi.md @@ -0,0 +1,246 @@ +# billforward.CheckoutApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**build_subscription_checkout**](CheckoutApi.md#build_subscription_checkout) | **GET** /public/checkouts/subscriptions/{checkout-definition-path} | +[**create_account1**](CheckoutApi.md#create_account1) | **POST** /public/accounts | +[**create_subscription_checkout_definition**](CheckoutApi.md#create_subscription_checkout_definition) | **POST** /checkouts/subscriptions | +[**get_subscription_checkout_definition**](CheckoutApi.md#get_subscription_checkout_definition) | **GET** /checkouts/subscriptions/{checkout-definition-path} | +[**subscription_checkout**](CheckoutApi.md#subscription_checkout) | **POST** /public/checkouts/subscriptions | + +# **build_subscription_checkout** +> InlineResponseDefault50 build_subscription_checkout(checkout_definition_path, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.CheckoutApi(billforward.ApiClient(configuration)) +checkout_definition_path = 'checkout_definition_path_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.build_subscription_checkout(checkout_definition_path, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling CheckoutApi->build_subscription_checkout: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **checkout_definition_path** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault50**](InlineResponseDefault50.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_account1** +> InlineResponseDefault6 create_account1(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.CheckoutApi(billforward.ApiClient(configuration)) +body = billforward.Account() # Account | (optional) + +try: + api_response = api_instance.create_account1(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling CheckoutApi->create_account1: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Account**](Account.md)| | [optional] + +### Return type + +[**InlineResponseDefault6**](InlineResponseDefault6.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_subscription_checkout_definition** +> InlineResponseDefault17 create_subscription_checkout_definition(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.CheckoutApi(billforward.ApiClient(configuration)) +body = billforward.CreateSubscriptionCheckoutDefinitionRequest() # CreateSubscriptionCheckoutDefinitionRequest | (optional) + +try: + api_response = api_instance.create_subscription_checkout_definition(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling CheckoutApi->create_subscription_checkout_definition: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateSubscriptionCheckoutDefinitionRequest**](CreateSubscriptionCheckoutDefinitionRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault17**](InlineResponseDefault17.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_subscription_checkout_definition** +> InlineResponseDefault17 get_subscription_checkout_definition(checkout_definition_path, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.CheckoutApi(billforward.ApiClient(configuration)) +checkout_definition_path = 'checkout_definition_path_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_subscription_checkout_definition(checkout_definition_path, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling CheckoutApi->get_subscription_checkout_definition: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **checkout_definition_path** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault17**](InlineResponseDefault17.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **subscription_checkout** +> InlineResponseDefault51 subscription_checkout(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.CheckoutApi(billforward.ApiClient(configuration)) +body = billforward.SubscriptionCheckoutActionRequest() # SubscriptionCheckoutActionRequest | (optional) + +try: + api_response = api_instance.subscription_checkout(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling CheckoutApi->subscription_checkout: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**SubscriptionCheckoutActionRequest**](SubscriptionCheckoutActionRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault51**](InlineResponseDefault51.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Client.md b/docs/Client.md deleted file mode 100644 index ed61fcd..0000000 --- a/docs/Client.md +++ /dev/null @@ -1,23 +0,0 @@ -# Client - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**client_id** | **str** | { \"description\" : \"ID of the OAuth2 client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**client_secret** | **str** | { \"description\" : \"Unique Client Secret of the client. This is used as the OAuth2 Client secret\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"Organization associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**scope** | **str** | { \"description\" : \"Scopes associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**resource_ids** | **str** | { \"description\" : \"Resources associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**authorized_grant_types** | **str** | { \"description\" : \"Oauth2 Grant Types which may be used when authenticating with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**registered_redirect_uris** | **str** | { \"description\" : \"Registered Redirect URIs associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**authorities** | **str** | { \"description\" : \"Authorities associated with the client.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**access_token_validity_seconds** | **int** | { \"description\" : \"The amount of time in seconds that an access token for the client is valid.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**refresh_token_validity_seconds** | **int** | { \"description\" : \"The amount of time in seconds that a refresh token for the client is valid.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"Indicates if a client has been retired. If a client has been retired it can still be retrieved using the appropriate flag on API requests.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ClientPagedMetadata.md b/docs/ClientPagedMetadata.md deleted file mode 100644 index cf5a18a..0000000 --- a/docs/ClientPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# ClientPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Client]**](Client.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ClientsApi.md b/docs/ClientsApi.md deleted file mode 100644 index 7dc796d..0000000 --- a/docs/ClientsApi.md +++ /dev/null @@ -1,212 +0,0 @@ -# billforward.ClientsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_client**](ClientsApi.md#create_client) | **POST** /clients | Create a client. -[**get_all_clients**](ClientsApi.md#get_all_clients) | **GET** /clients | Returns a collection of clients. -[**get_client_by_id**](ClientsApi.md#get_client_by_id) | **GET** /clients/{client-ID} | Returns a single client, specified by the client-ID parameter. -[**update_client**](ClientsApi.md#update_client) | **PUT** /clients | Update a client. - - -# **create_client** -> ClientPagedMetadata create_client(client) - -Create a client. - -{\"nickname\":\"Create\",\"request\":\"createClientRequest.html\",\"response\":\"createClientResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ClientsApi() -client = billforward.Client() # Client | The client object to be updated. - -try: - # Create a client. - api_response = api_instance.create_client(client) - pprint(api_response) -except ApiException as e: - print "Exception when calling ClientsApi->create_client: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **client** | [**Client**](Client.md)| The client object to be updated. | - -### Return type - -[**ClientPagedMetadata**](ClientPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_clients** -> ClientPagedMetadata get_all_clients(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of clients. - -{\"nickname\":\"Get All\",\"response\":\"getClientAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ClientsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first client to return. (optional) (default to 0) -records = 10 # int | The maximum number of clients to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of clients. - api_response = api_instance.get_all_clients(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling ClientsApi->get_all_clients: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first client to return. | [optional] [default to 0] - **records** | **int**| The maximum number of clients to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**ClientPagedMetadata**](ClientPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_client_by_id** -> ClientPagedMetadata get_client_by_id(client_id, organizations=organizations) - -Returns a single client, specified by the client-ID parameter. - -{\"nickname\":\"Retrieve by id\",\"response\":\"getClientByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ClientsApi() -client_id = 'client_id_example' # str | The string ID of the client. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single client, specified by the client-ID parameter. - api_response = api_instance.get_client_by_id(client_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling ClientsApi->get_client_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **client_id** | **str**| The string ID of the client. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**ClientPagedMetadata**](ClientPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_client** -> ClientPagedMetadata update_client(client) - -Update a client. - -{\"nickname\":\"Update\",\"request\":\"updateClientRequest.html\",\"response\":\"updateClientResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ClientsApi() -client = billforward.Client() # Client | The client object to be updated. - -try: - # Update a client. - api_response = api_instance.update_client(client) - pprint(api_response) -except ApiException as e: - print "Exception when calling ClientsApi->update_client: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **client** | [**Client**](Client.md)| The client object to be updated. | - -### Return type - -[**ClientPagedMetadata**](ClientPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/CommissionStructure.md b/docs/CommissionStructure.md new file mode 100644 index 0000000..ae02332 --- /dev/null +++ b/docs/CommissionStructure.md @@ -0,0 +1,17 @@ +# CommissionStructure + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**description** | **str** | | [optional] +**type** | **str** | | [optional] +**amount** | **float** | | [optional] +**pricing_component_name** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ComponentChange.md b/docs/ComponentChange.md index f56a6a2..b3e4160 100644 --- a/docs/ComponentChange.md +++ b/docs/ComponentChange.md @@ -3,20 +3,19 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | id | -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | -**amendment_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | -**update_pricing_component_value_id** | **str** | { \"description\" : \"ID of the updateComponentValueAmendment object that is responsible for actioning the change.\", \"verbs\":[\"GET\"] } | [optional] -**pricing_component_id** | **str** | { \"description\" : \"ID of the pricing component, that will not change with versioning. (Must be provided if pricingComponentName is empty)\", \"verbs\":[\"POST\",\"GET\"] } | -**pricing_component_name** | **str** | { \"description\" : \"Name of the pricing component. (Must be provided if pricingComponentID is empty)\", \"verbs\":[\"POST\",\"GET\"] } | -**state** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**change_mode** | **str** | { \"description\" : \"<span class=\\\"label label-default\\\">immediate</span> applies the changes to the subscription straight away. <span class=\\\"label label-default\\\">delayed</span> applies the changes to the subscription at the start of the next billing period\", \"verbs\":[\"POST\",\"GET\"] } | -**new_value** | **int** | { \"description\" : \"Value of the pricing component that the subscription is moving to\", \"verbs\":[\"POST\",\"GET\"] } | -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**value_effective** | **datetime** | { \"description\" : \"Date when the value becomes active. For example when an upgrade will come into effect.\", \"verbs\":[\"GET\"] } | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | +**organization_id** | **str** | | +**amendment_id** | **str** | | +**update_pricing_component_value_id** | **str** | | [optional] +**pricing_component_id** | **str** | | +**pricing_component_name** | **str** | | +**state** | **str** | | +**change_mode** | **str** | | +**value_effective** | **datetime** | | [optional] +**new_value** | **int** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CompoundUsage.md b/docs/CompoundUsage.md deleted file mode 100644 index ac242b8..0000000 --- a/docs/CompoundUsage.md +++ /dev/null @@ -1,13 +0,0 @@ -# CompoundUsage - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**usages** | [**list[Usage]**](Usage.md) | { \"description\" : \"Array of Usage objects that you wish to operate on.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"ID of the organization to which these usage instances belong.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CompoundUsageSession.md b/docs/CompoundUsageSession.md deleted file mode 100644 index 91bfb80..0000000 --- a/docs/CompoundUsageSession.md +++ /dev/null @@ -1,13 +0,0 @@ -# CompoundUsageSession - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**usage_sessions** | [**list[UsageSession]**](UsageSession.md) | { \"description\" : \"Array of Usage Sessions that you wish to operate on.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"ID of the organization to which these usage sessions belong.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ConfigurationsApi.md b/docs/ConfigurationsApi.md deleted file mode 100644 index eb6c0ac..0000000 --- a/docs/ConfigurationsApi.md +++ /dev/null @@ -1,218 +0,0 @@ -# billforward.ConfigurationsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_api_configuration**](ConfigurationsApi.md#create_api_configuration) | **POST** /configurations | Create a configuration. -[**get_all_api_configurations**](ConfigurationsApi.md#get_all_api_configurations) | **GET** /configurations | Returns a collection of configurations. By default 10 values are returned. Records are returned in natural order. -[**get_api_configurations_by_type**](ConfigurationsApi.md#get_api_configurations_by_type) | **GET** /configurations/type/{configuration-type} | Returns a single configuration, specified by the type parameter. -[**update_api_configuration**](ConfigurationsApi.md#update_api_configuration) | **PUT** /configurations | Update a configuration. - - -# **create_api_configuration** -> APIConfigurationPagedMetadata create_api_configuration(configuration) - -Create a configuration. - -{\"nickname\":\"Create a new configuration\",\"request\":\"createConfigurationRequest.html\",\"response\":\"createConfigurationResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ConfigurationsApi() -configuration = billforward.MutableBillingEntity() # MutableBillingEntity | The configuration object to be created. - -try: - # Create a configuration. - api_response = api_instance.create_api_configuration(configuration) - pprint(api_response) -except ApiException as e: - print "Exception when calling ConfigurationsApi->create_api_configuration: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **configuration** | [**MutableBillingEntity**](MutableBillingEntity.md)| The configuration object to be created. | - -### Return type - -[**APIConfigurationPagedMetadata**](APIConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_api_configurations** -> APIConfigurationPagedMetadata get_all_api_configurations(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of configurations. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all configurations\",\"response\":\"getConfigurationsAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ConfigurationsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-components to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of configurations. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_api_configurations(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling ConfigurationsApi->get_all_api_configurations: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-components to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**APIConfigurationPagedMetadata**](APIConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_api_configurations_by_type** -> APIConfigurationPagedMetadata get_api_configurations_by_type(configuration_type, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a single configuration, specified by the type parameter. - -{\"nickname\":\"Retrieve by payment gateway\",\"response\":\"getConfigurationByType.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ConfigurationsApi() -configuration_type = 'configuration_type_example' # str | The unique type of the configuration. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-components to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a single configuration, specified by the type parameter. - api_response = api_instance.get_api_configurations_by_type(configuration_type, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling ConfigurationsApi->get_api_configurations_by_type: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **configuration_type** | **str**| The unique type of the configuration. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-components to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**APIConfigurationPagedMetadata**](APIConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_api_configuration** -> APIConfigurationPagedMetadata update_api_configuration(configuration) - -Update a configuration. - -{\"nickname\":\"Update a configuration\",\"request\":\"updateConfigurationRequest.html\",\"response\":\"updateConfigurationResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ConfigurationsApi() -configuration = billforward.MutableBillingEntity() # MutableBillingEntity | The configuration object to be updated. - -try: - # Update a configuration. - api_response = api_instance.update_api_configuration(configuration) - pprint(api_response) -except ApiException as e: - print "Exception when calling ConfigurationsApi->update_api_configuration: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **configuration** | [**MutableBillingEntity**](MutableBillingEntity.md)| The configuration object to be updated. | - -### Return type - -[**APIConfigurationPagedMetadata**](APIConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/Contract.md b/docs/Contract.md new file mode 100644 index 0000000..8693289 --- /dev/null +++ b/docs/Contract.md @@ -0,0 +1,25 @@ +# Contract + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**state** | **str** | | +**start** | **datetime** | | [optional] +**contract_end_behaviour** | **str** | | +**valid_from** | **datetime** | | +**valid_till** | **datetime** | | [optional] +**contract_periods** | [**list[ContractPeriod]**](ContractPeriod.md) | | [optional] +**current_period** | [**ContractPeriod**](ContractPeriod.md) | | [optional] +**sorted_contract_periods** | [**list[ContractPeriod]**](ContractPeriod.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ContractPeriod.md b/docs/ContractPeriod.md new file mode 100644 index 0000000..8637b6e --- /dev/null +++ b/docs/ContractPeriod.md @@ -0,0 +1,20 @@ +# ContractPeriod + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**subscription_duration_period** | **int** | | [optional] +**subscription_duration_period_type** | **str** | | [optional] +**state** | **str** | | +**contract_period** | **int** | | [optional] +**subscription_periods** | **int** | | [optional] +**purchase_order** | **str** | | [optional] +**quote** | [**ApiQuote**](ApiQuote.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ContractsApi.md b/docs/ContractsApi.md new file mode 100644 index 0000000..faa22fc --- /dev/null +++ b/docs/ContractsApi.md @@ -0,0 +1,407 @@ +# billforward.ContractsApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_contract_period**](ContractsApi.md#add_contract_period) | **POST** /contracts/{contract}/period | +[**create_contract**](ContractsApi.md#create_contract) | **POST** /contracts | +[**get_all_contracts**](ContractsApi.md#get_all_contracts) | **GET** /contracts | +[**get_contract_by_id**](ContractsApi.md#get_contract_by_id) | **GET** /contracts/{contract} | +[**start_contract**](ContractsApi.md#start_contract) | **POST** /contracts/{contract}/start | +[**update_contract**](ContractsApi.md#update_contract) | **PUT** /contracts | +[**void_contract**](ContractsApi.md#void_contract) | **DELETE** /contracts/{contract} | +[**void_final_contract_period**](ContractsApi.md#void_final_contract_period) | **DELETE** /contracts/{contract}/period | + +# **add_contract_period** +> InlineResponseDefault19 add_contract_period(contract, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ContractsApi(billforward.ApiClient(configuration)) +contract = 'contract_example' # str | +body = billforward.AddContractPeriodRequest() # AddContractPeriodRequest | (optional) + +try: + api_response = api_instance.add_contract_period(contract, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling ContractsApi->add_contract_period: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **contract** | **str**| | + **body** | [**AddContractPeriodRequest**](AddContractPeriodRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault19**](InlineResponseDefault19.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_contract** +> InlineResponseDefault19 create_contract(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ContractsApi(billforward.ApiClient(configuration)) +body = billforward.CreateContractRequest() # CreateContractRequest | (optional) + +try: + api_response = api_instance.create_contract(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling ContractsApi->create_contract: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateContractRequest**](CreateContractRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault19**](InlineResponseDefault19.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_contracts** +> InlineResponseDefault20 get_all_contracts(state=state, account_id=account_id, subscription_id=subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ContractsApi(billforward.ApiClient(configuration)) +state = ['state_example'] # list[str] | (optional) +account_id = ['account_id_example'] # list[str] | (optional) +subscription_id = ['subscription_id_example'] # list[str] | (optional) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: + api_response = api_instance.get_all_contracts(state=state, account_id=account_id, subscription_id=subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) + pprint(api_response) +except ApiException as e: + print("Exception when calling ContractsApi->get_all_contracts: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **state** | [**list[str]**](str.md)| | [optional] + **account_id** | [**list[str]**](str.md)| | [optional] + **subscription_id** | [**list[str]**](str.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + +### Return type + +[**InlineResponseDefault20**](InlineResponseDefault20.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_contract_by_id** +> InlineResponseDefault19 get_contract_by_id(contract, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ContractsApi(billforward.ApiClient(configuration)) +contract = 'contract_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_contract_by_id(contract, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling ContractsApi->get_contract_by_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **contract** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault19**](InlineResponseDefault19.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **start_contract** +> InlineResponseDefault21 start_contract(contract, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ContractsApi(billforward.ApiClient(configuration)) +contract = 'contract_example' # str | +body = billforward.StartContractRequest() # StartContractRequest | (optional) + +try: + api_response = api_instance.start_contract(contract, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling ContractsApi->start_contract: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **contract** | **str**| | + **body** | [**StartContractRequest**](StartContractRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault21**](InlineResponseDefault21.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_contract** +> InlineResponseDefault19 update_contract(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ContractsApi(billforward.ApiClient(configuration)) +body = billforward.UpdateContractRequest() # UpdateContractRequest | (optional) + +try: + api_response = api_instance.update_contract(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling ContractsApi->update_contract: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**UpdateContractRequest**](UpdateContractRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault19**](InlineResponseDefault19.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **void_contract** +> InlineResponseDefault19 void_contract(contract, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ContractsApi(billforward.ApiClient(configuration)) +contract = 'contract_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.void_contract(contract, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling ContractsApi->void_contract: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **contract** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault19**](InlineResponseDefault19.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **void_final_contract_period** +> InlineResponseDefault19 void_final_contract_period(contract, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ContractsApi(billforward.ApiClient(configuration)) +contract = 'contract_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.void_final_contract_period(contract, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling ContractsApi->void_final_contract_period: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **contract** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault19**](InlineResponseDefault19.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Coupon.md b/docs/Coupon.md index ca9a8c2..f6eb05c 100644 --- a/docs/Coupon.md +++ b/docs/Coupon.md @@ -3,32 +3,33 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**coupon_code** | **str** | { \"description\" : \"Code used to identify this set of coupons. If unique codes are required this will be used as the prefix to generate individual coupon codes. When a unique code is returned the original couponCode is returned in the parentCouponCode property. For example a single coupon code SUMMER maybe be issued at an event to encourage sign-up, the same code can be redeemed by multiple accounts. In another example you may want to issue unique coupon codes per a customer, for example SUMMER-A4FC, SUMMER-BCQ4, each code can only be calimed once.\", \"verbs\":[\"POST\",\"GET\"] } | -**coupons** | **int** | { \"default\" : \"&infin;\", \"description\" : \"Number of times the coupon can be claimed. In the case of generating unique coupon codes this is the maximum quantity that can be genereated. For example set this value to 10 if you want to limit the total number of subscriptions that will use this code to 10.\", \"verbs\":[\"POST\",\"GET\"] } | -**uses** | **int** | { \"default\" : \"&infin;\", \"description\" : \"This specifies how many times a discount will be added to a subscription once the coupon is added. For example if the uses is set to 3 it will discount 3 times, set this to a large number, for example 9999999, to give infinite applications, .\", \"verbs\":[\"POST\",\"GET\"] } | -**product** | **str** | { \"description\" : \"Name or ID of the product this coupon applies to. Requires a specific rate-plan to be set.\", \"verbs\":[\"POST\"] } | [optional] -**product_name** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**product_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**product_rate_plan** | **str** | { \"description\" : \"Name or ID of the rate-plan this coupon applies to. \", \"verbs\":[\"POST\"] } | [optional] -**product_rate_plan_name** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**product_rate_plan_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**currency** | **str** | { \"description\" : \"If the coupon is not for a specific rate-plan, and can apply to any subscription, the currency should be provivded. Currency is specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**parent_coupon_code_redeemable** | **bool** | { \"default\" : \"true\", \"description\" : \"If true the coupon without postfix can be added to a subscription, for example if parentCouponCodeRedeemable is true and the coupon was created with code SUMMER customers could claim using SUMMER. If parentCouponCodeRedeemable is false then only unique coupon codes can be claimed, for example SUMMER-AB4C, SUMMER-YZB4.\", \"verbs\":[\"POST\",\"GET\"] } | [default to False] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**name** | **str** | | +**coupon_code** | **str** | | +**coupons** | **int** | | +**uses** | **int** | | +**product** | **str** | | [optional] +**product_name** | **str** | | [optional] +**product_id** | **str** | | [optional] +**product_rate_plan** | **str** | | [optional] +**product_rate_plan_name** | **str** | | [optional] +**product_rate_plan_id** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**parent_coupon_code_redeemable** | **bool** | | **organization_id** | **str** | | -**discounts** | [**list[CouponDiscount]**](CouponDiscount.md) | { \"description\" : \"For each discount item on the coupon, only one discount type should be set between cashDiscount, percentageDiscount and unitsFree. cashDiscount gives a fixed monetary discount, for example $10.00. percentageDiscount gives a percentage discount on the overall invoice cost. unitsFree discounts the pricing by the number of units specified for that component. All discounts are applied against the base cost or units. Discounts are not compound. Discounts will never exceed the value of a pricing component of the overall invoice - thus at most the discount will reduce the cost to zero. If no pricing component is specified the discount will apply to the total invoice cost.\", \"verbs\":[\"POST\",\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"If a coupon has been deleted, any subsequent attempts to add it to a subscription will fail. Note: This will not affect existing subscription using the coupon. Please see deleting a coupon for more details\", \"verbs\":[\"GET\"] } | [optional] [default to False] -**parent_coupon_code** | **str** | { \"description\" : \"For unique coupon codes this is the original coupon code, for example SUMMER\", \"verbs\":[\"GET\"] } | [optional] -**applies_to** | **str** | { \"description\" : \"For unique coupon codes this is what the coupon applies to, usually subscription.\", \"verbs\":[\"GET\"] } | [optional] -**applies_to_id** | **str** | { \"description\" : \"For a coupon added to a subscription this is the the ID of the subscription. This can be used to remove the coupon from the target.\", \"verbs\":[\"GET\"] } | [optional] -**remaining_uses** | **int** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**used** | **int** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**discount_value** | **float** | | [optional] -**valid_until** | **datetime** | { \"description\" : \"If the coupon was removed from the subscription this is the date and time from when it no ceased to be applied.\", \"verbs\":[\"GET\"] } | [optional] +**discounts** | [**list[CouponDiscount]**](CouponDiscount.md) | | [optional] +**deleted** | **bool** | | [optional] +**parent_coupon_code** | **str** | | [optional] +**applies_to** | **str** | | [optional] +**applies_to_id** | **str** | | [optional] +**remaining_uses** | **int** | | [optional] +**used** | **int** | | [optional] +**valid_until** | **datetime** | | [optional] +**instance_details** | [**CouponInstance**](CouponInstance.md) | | [optional] +**master_code_redeemable** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CouponBook.md b/docs/CouponBook.md deleted file mode 100644 index 34ac359..0000000 --- a/docs/CouponBook.md +++ /dev/null @@ -1,23 +0,0 @@ -# CouponBook - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**book_code** | **str** | { \"description\" : \"The book code for the coupon-book. This is used to create coupon-instances which are associated with subscriptions.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**crm_id** | **str** | { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"Organization associated with the the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**coupon_book_definition_id** | **str** | { \"description\" : \"ID of the coupon-book-definition associated with the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**name** | **str** | { \"description\" : \"The human readable name of the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**cost** | **float** | { \"description\" : \"The cost of the coupon-book. Can be used to keep track of coupon-book sales.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**remaining_coupons** | **int** | { \"description\" : \"The number of available coupon-instances left in the coupon-book.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**max_remaining_coupons** | **int** | { \"description\" : \"The original number of available coupon-instances that the coupon-book can hold.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**maximum_coupon_uses** | **int** | { \"description\" : \"The maximum number of uses each coupon-instance created from this coupon-book can have.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"Has the coupon book been deleted?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CouponBookDefinition.md b/docs/CouponBookDefinition.md deleted file mode 100644 index ba7ffdb..0000000 --- a/docs/CouponBookDefinition.md +++ /dev/null @@ -1,26 +0,0 @@ -# CouponBookDefinition - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**crm_id** | **str** | { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"Organization associated with the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**coupon_definition_id** | **str** | { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**name** | **str** | { \"description\" : \"The human readable name of the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**description** | **str** | { \"description\" : \"The human readable description of the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**minimum** | **int** | { \"description\" : \"The minimum number of coupon-instances a coupon-book can hold.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**maximum** | **int** | { \"description\" : \"The maximum number of coupon-instances a coupon-book can hold.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**step** | **int** | { \"description\" : \"The stepping parameter between the minimum and the maximum value. E.g. if the minimum is 100, the maximum is 150, and the step is 10, this means the coupon-books can hold 100, 110, 120, 130, 140 or 150 coupon-instances.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**definition_valid_from** | **datetime** | { \"description\" : \"The UTC DateTime that the coupon-book-definition is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**definition_valid_till** | **datetime** | { \"description\" : \"The UTC DateTime that the coupon-book-definition is valid until.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**instance_duration** | **int** | { \"description\" : \"Reserved for future use.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**instance_duration_period** | **str** | { \"description\" : \"Reserved for future use.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**state** | **str** | { \"description\" : \"The current state of the coupon-book-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CouponBookDefinitionPagedMetadata.md b/docs/CouponBookDefinitionPagedMetadata.md deleted file mode 100644 index f44192b..0000000 --- a/docs/CouponBookDefinitionPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# CouponBookDefinitionPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[CouponBookDefinition]**](CouponBookDefinition.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CouponBookPagedMetadata.md b/docs/CouponBookPagedMetadata.md deleted file mode 100644 index fb1bd15..0000000 --- a/docs/CouponBookPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# CouponBookPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[CouponBook]**](CouponBook.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CouponCharge.md b/docs/CouponCharge.md new file mode 100644 index 0000000..f209c28 --- /dev/null +++ b/docs/CouponCharge.md @@ -0,0 +1,19 @@ +# CouponCharge + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pricing_component_id** | **str** | | [optional] +**public_pricing_component_name** | **str** | | [optional] +**pricing_component_name** | **str** | | [optional] +**pricing_component_value** | **int** | | [optional] +**coupon_definition_id** | **str** | | [optional] +**coupon_instance_id** | **str** | | [optional] +**coupon_modifier_id** | **str** | | [optional] +**originating_charge_id** | **str** | | [optional] +**coupon_code** | **str** | | [optional] +**coupon_type** | **str** | | [optional] +**pricing_component_credit_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CouponCodeResponse.md b/docs/CouponCodeResponse.md new file mode 100644 index 0000000..f0b3afb --- /dev/null +++ b/docs/CouponCodeResponse.md @@ -0,0 +1,12 @@ +# CouponCodeResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**codes_yet_to_be_generated** | **int** | | [optional] +**organization_id** | **str** | | [optional] +**codes** | [**list[CouponUniqueCodesResponse]**](CouponUniqueCodesResponse.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CouponDefinition.md b/docs/CouponDefinition.md deleted file mode 100644 index 639d2b3..0000000 --- a/docs/CouponDefinition.md +++ /dev/null @@ -1,28 +0,0 @@ -# CouponDefinition - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**crm_id** | **str** | { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**name** | **str** | { \"description\" : \"The human readable name of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**description** | **str** | { \"description\" : \"The human readable description of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**customer_code** | **str** | { \"description\" : \"The customerCode associated with the organization.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**target** | **str** | { \"description\" : \"The target of the coupon-definition. Currently coupon-definitions can only target products.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**currency** | **str** | { \"description\" : \"The currency of the coupon-definition specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**definition_valid_from** | **datetime** | { \"description\" : \"The UTC DateTime that the coupon-definition is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**definition_valid_till** | **datetime** | { \"description\" : \"The UTC DateTime that the coupon-definition is valid until.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**instance_duration_period** | **str** | { \"description\" : \"instanceDurationPeriod\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**instance_duration** | **int** | { \"description\" : \"instanceDuration\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**fixed_end_date** | **datetime** | { \"description\" : \"The UTC DateTime specifying the fixed end date of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**state** | **str** | { \"description\" : \"The current state of the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**modifiers** | [**list[CouponModifierBase]**](CouponModifierBase.md) | { \"description\" : \"The collection of coupon-modifiers associated with the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**rules** | [**list[CouponRule]**](CouponRule.md) | { \"description\" : \"The collection of coupon-rules associated with the coupon-definition.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CouponDefinitionPagedMetadata.md b/docs/CouponDefinitionPagedMetadata.md deleted file mode 100644 index c290e3b..0000000 --- a/docs/CouponDefinitionPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# CouponDefinitionPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[CouponDefinition]**](CouponDefinition.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CouponDiscount.md b/docs/CouponDiscount.md index fba65d9..1883e96 100644 --- a/docs/CouponDiscount.md +++ b/docs/CouponDiscount.md @@ -3,18 +3,20 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**pricing_component** | **str** | { \"description\" : \"Name or ID of the pricing component to apply the discount to. If not set blank discount is applied at the invoice level.\", \"verbs\":[\"POST\"] } | [optional] -**pricing_component_name** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**pricing_component_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**pricing_component** | **str** | | [optional] +**pricing_component_name** | **str** | | [optional] +**pricing_component_id** | **str** | | [optional] **unit_of_measure_name** | **str** | | [optional] **unit_of_measure_id** | **str** | | [optional] -**units_free** | **int** | { \"description\" : \"Number of units that are free for a pricing-component.\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**percentage_discount** | **float** | { \"description\" : \"Percentage to be discounted\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**cash_discount** | **float** | { \"description\" : \"Fixed monetary amount to be discounted\", \"verbs\":[\"POST\",\"GET\"] } | [optional] +**units_free** | **int** | | [optional] +**percentage_discount** | **float** | | [optional] +**cash_discount** | **float** | | [optional] +**tax_code** | **str** | | [optional] +**organization_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CouponDiscountEstimate.md b/docs/CouponDiscountEstimate.md deleted file mode 100644 index e4b3184..0000000 --- a/docs/CouponDiscountEstimate.md +++ /dev/null @@ -1,15 +0,0 @@ -# CouponDiscountEstimate - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**unaltered_value** | **float** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**discount_value** | **float** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**affected_specifier_count** | **int** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**discount_start_value** | **int** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**discount_end_value** | **int** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**unit_discounts** | [**list[UnitDiscount]**](UnitDiscount.md) | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CouponInstance.md b/docs/CouponInstance.md index 58bf398..29f066b 100644 --- a/docs/CouponInstance.md +++ b/docs/CouponInstance.md @@ -3,26 +3,28 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**target_id** | **str** | { \"description\" : \"Target ID of the coupon-instance. If the target is subscription, this is the subscription's ID. If the target is account, this is the account's ID.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**coupon_code** | **str** | { \"description\" : \"Code for the coupon. This code can be used to apply coupon-instances to subscriptions or accounts.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**date_initialised** | **datetime** | { \"description\" : \"The UTC DateTime the coupon was initialised.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**valid_till** | **datetime** | { \"description\" : \"The UTC DateTime the coupon-instance is valid until.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the coupon-instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**crm_id** | **str** | { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"Organization associated with the\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**book_id** | **str** | { \"description\" : \"ID of the coupon-book associated with the coupon-instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**coupon_definition_id** | **str** | { \"description\" : \"ID of the coupon-definition associated with the coupon-instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**target** | **str** | { \"description\" : \"Ttype of the target for the coupon-instance. Used in combination with the targetID.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**periods_valid_for** | **int** | { \"description\" : \"Number of subscription periods the coupon is valid for. Unused.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**total_periods** | **int** | { \"description\" : \"Unused.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**remaining_uses** | **int** | { \"description\" : \"The number of remaining uses the coupon-instance has left.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**instance_discount_value** | **float** | { \"description\" : \"(Optional) The value to be used for dynamic price calculation, if the coupon definition has an 'instance' or 'instance_percent' coupon modifier. If it is not set, the effect amount of the coupon modifier will be used.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**max_remaining_uses** | **int** | { \"description\" : \"The number of remaining uses the coupon-instance had upon initialisation.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**coupon_instance_existing_values** | [**list[CouponInstanceExistingValue]**](CouponInstanceExistingValue.md) | { \"description\" : \"The collection of coupon-instance-existing-value objects associated with the coupon-instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**crm_id** | **str** | | [optional] +**organization_id** | **str** | | +**book_id** | **str** | | +**coupon_definition_id** | **str** | | +**target_id** | **str** | | [optional] +**target** | **str** | | +**coupon_code** | **str** | | [optional] +**issued_by** | **str** | | [optional] +**periods_valid_for** | **int** | | [optional] +**total_periods** | **int** | | [optional] +**date_initialised** | **datetime** | | +**valid_till** | **datetime** | | [optional] +**remaining_uses** | **int** | | [optional] +**instance_discount_value** | **float** | | [optional] +**max_remaining_uses** | **int** | | [optional] +**coupon_instance_existing_values** | [**list[CouponInstanceExistingValue]**](CouponInstanceExistingValue.md) | | [optional] +**final_period** | **int** | | [optional] +**current_period** | **int** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CouponInstanceExistingValue.md b/docs/CouponInstanceExistingValue.md index f8957ad..3b2dcb7 100644 --- a/docs/CouponInstanceExistingValue.md +++ b/docs/CouponInstanceExistingValue.md @@ -3,15 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the coupon-instance-existing-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the coupon-existing-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**coupon_instance_id** | **str** | { \"description\" : \"The string ID of the coupon-instance associated with the coupon-instance-existing-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**logical_component_id** | **str** | { \"description\" : \"The consistent string ID of the pricing-component associated with the coupon-instance-existing-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**existing_value** | **int** | { \"description\" : \"The existing value\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**coupon_instance_id** | **str** | | [optional] +**logical_component_id** | **str** | | +**existing_value** | **int** | | +**pricing_component** | [**PricingComponent**](PricingComponent.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CouponInstancePagedMetadata.md b/docs/CouponInstancePagedMetadata.md deleted file mode 100644 index 32e80ff..0000000 --- a/docs/CouponInstancePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# CouponInstancePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[CouponInstance]**](CouponInstance.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CouponModifierBase.md b/docs/CouponModifierBase.md deleted file mode 100644 index 6c503fd..0000000 --- a/docs/CouponModifierBase.md +++ /dev/null @@ -1,24 +0,0 @@ -# CouponModifierBase - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**coupon_definition_id** | **str** | { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**effect_amount** | **float** | { \"description\" : \"The effect amount for the coupon-modifier. This is affected by the operand field.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**operand** | **str** | { \"description\" : \"The operand field affects the effect amount of the coupon-modifier. If the operand is fixed, it is an exact amount of the currency defined by the coupon-definition. If the operand is percent, this means the coupon will be affecting a percentage of the unaltered cost. E.g. a 25% modifier will apply a 25% discount on a subscription or a pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**effect** | **str** | { \"description\" : \"The effect of the coupon-modifier. The coupon-modifier can affect first, last, and cheapest value of a specific unit-of-measure-id for a subscription. The coupon-modifier can also affect all of the values for a unit-of-measure-id, or can affect all of the subscription cost.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**effect_additional** | **bool** | { \"description\" : \"Specifies whether the coupon-modifier will be affecting only additional units. If this field is set, the coupon-instance-existing-values for the coupon-instance are observed, and any units of the unit-of-measure-id defined by the modifier below the coupon-instance-existing-values for that unit-of-measure-id will be ignored.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] -**specifier_amount** | **int** | { \"description\" : \"The number of units that will be affected by the coupon-modifier, if the domain is set to uom\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**domain** | **str** | { \"description\" : \"The domain of the coupon-modifier\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**specifier** | **str** | { \"description\" : \"The specifier is domain-specific. If the domain is uom, this field is used to limit the coupon-modifier to a specific unit-of-measure-id.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**precedence** | **int** | { \"description\" : \"The precedence of the coupon-modifier. This is used to order application of coupon-modifiers. Higher precedence means the coupon-modifier will be applied before others.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CouponModifierBasePagedMetadata.md b/docs/CouponModifierBasePagedMetadata.md deleted file mode 100644 index ff7d20f..0000000 --- a/docs/CouponModifierBasePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# CouponModifierBasePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[CouponModifierBase]**](CouponModifierBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CouponPagedMetadata.md b/docs/CouponPagedMetadata.md deleted file mode 100644 index 577c55a..0000000 --- a/docs/CouponPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# CouponPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Coupon]**](Coupon.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/StripeObject.md b/docs/CouponPayment.md similarity index 94% rename from docs/StripeObject.md rename to docs/CouponPayment.md index 7a618a5..7129896 100644 --- a/docs/StripeObject.md +++ b/docs/CouponPayment.md @@ -1,4 +1,4 @@ -# StripeObject +# CouponPayment ## Properties Name | Type | Description | Notes @@ -6,4 +6,3 @@ Name | Type | Description | Notes [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CouponRule.md b/docs/CouponRule.md deleted file mode 100644 index 0a4c633..0000000 --- a/docs/CouponRule.md +++ /dev/null @@ -1,26 +0,0 @@ -# CouponRule - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parent_rule_id** | **str** | { \"description\" : \"ID of the parent of this coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**coupon_definition_id** | **str** | { \"description\" : \"ID of the coupon-definition associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**subject** | **str** | { \"description\" : \"The subject of the coupon-rule. The coupon-rule can operate on either the user or subscription that the coupon-instance is associated with.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**polarity** | **str** | { \"description\" : \"Specifies whether the rule's result will affect the application of the coupon-instance positively or negatively.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**verb** | **str** | { \"description\" : \"The verb of the coupon-rule. coupon-rules can check whether the user or subscription has a certain property.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**preposition** | **str** | { \"description\" : \"This is the comparison operator of the coupon-rule's parameter and the subject's object.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**parameter** | **str** | { \"description\" : \"The parameter for the coupon-rule. This specifies the ID or the quantity for the object of the subject.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**object** | **str** | { \"description\" : \"The property of the subject of the coupon-rule. e.g. When the subject is 'subscription' and the object is 'product-ID', the coupon-rule will observe the product-ID for that subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**rule_validation_strategy** | **str** | { \"description\" : \"The rule-validation-strategy object associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**specifier** | **str** | { \"description\" : \"When the subject is subscription, the specifier is used to define which unit of measure the coupon rule will operate on. When the subject is user, the specifier defines which property of the user's account it will operate on.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] -**child_rules** | [**list[CouponRule]**](CouponRule.md) | { \"description\" : \"The collection of child coupon-rules associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CouponRulePagedMetadata.md b/docs/CouponRulePagedMetadata.md deleted file mode 100644 index 115b87c..0000000 --- a/docs/CouponRulePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# CouponRulePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[CouponRule]**](CouponRule.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CouponUniqueCodesRequest.md b/docs/CouponUniqueCodesRequest.md index a45d3a1..8215eed 100644 --- a/docs/CouponUniqueCodesRequest.md +++ b/docs/CouponUniqueCodesRequest.md @@ -3,11 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\"] } | -**quantity** | **int** | { \"description\" : \"The number of unique codes that will be returned.\", \"verbs\":[\"POST\"] } | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**quantity** | **int** | | [optional] +**issued_by** | **str** | | [optional] +**short_code** | **bool** | | [optional] +**id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CouponUniqueCodesResponse.md b/docs/CouponUniqueCodesResponse.md index 2331804..77785cb 100644 --- a/docs/CouponUniqueCodesResponse.md +++ b/docs/CouponUniqueCodesResponse.md @@ -3,10 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**coupon_code** | **str** | { \"description\" : \"A unique code that can be applied to a subscription.\", \"verbs\":[\"POST\"] } | [optional] +**created** | **datetime** | | [optional] +**coupon_code** | **str** | | [optional] **organization_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CouponUniqueCodesResponsePagedMetadata.md b/docs/CouponUniqueCodesResponsePagedMetadata.md deleted file mode 100644 index d31ec99..0000000 --- a/docs/CouponUniqueCodesResponsePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# CouponUniqueCodesResponsePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[CouponUniqueCodesResponse]**](CouponUniqueCodesResponse.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CouponWrapperResponse.md b/docs/CouponWrapperResponse.md index 9b26d99..9917164 100644 --- a/docs/CouponWrapperResponse.md +++ b/docs/CouponWrapperResponse.md @@ -3,13 +3,17 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**coupon_code** | **str** | {\"description\":\"Code of the coupon applied.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**discount** | **float** | {\"description\":\"Discount &mdash; including tax &mdash; contributed to the cost of the pricing component, due to application of coupon.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**discount_excluding_tax** | **float** | {\"description\":\"Discount &mdash; excluding tax &mdash; contributed to the cost of the pricing component, due to application of coupon.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**calculation** | **str** | {\"description\":\"Friendly text describing the calculation performed in applying the coupon.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**pricing_component_name** | **str** | {\"description\":\"Name of the pricing component to whom the coupon was applied.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**pricing_component_id** | **str** | {\"description\":\"ID of the pricing component to whom the coupon was applied.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**coupon_code** | **str** | | [optional] +**discount** | **float** | | [optional] +**discount_excluding_tax** | **float** | | [optional] +**calculation** | **str** | | [optional] +**pricing_component_name** | **str** | | [optional] +**pricing_component_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CouponbookApi.md b/docs/CouponbookApi.md deleted file mode 100644 index 25a94f7..0000000 --- a/docs/CouponbookApi.md +++ /dev/null @@ -1,482 +0,0 @@ -# billforward.CouponbookApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_coupon_book**](CouponbookApi.md#create_coupon_book) | **POST** /coupon-books | Create a coupon-book. -[**delete_coupon_book**](CouponbookApi.md#delete_coupon_book) | **DELETE** /coupon-books/{coupon-book-ID} | Retire a coupon-book, specified by the coupon-book-ID parameter. -[**get_all_attachable_coupon_books**](CouponbookApi.md#get_all_attachable_coupon_books) | **GET** /coupon-books/attachable/{attachableness}/{has_code} | Returns a collection of attachable coupon-books. An attachable coupon-book has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. -[**get_all_coupon_books**](CouponbookApi.md#get_all_coupon_books) | **GET** /coupon-books | Returns a collection of coupon-books. By default 10 values are returned. Records are returned in natural order. -[**get_coupon_book_by_book_code**](CouponbookApi.md#get_coupon_book_by_book_code) | **GET** /coupon-books/book-code/{book-code} | Returns a single coupon-book, specified by the book-code parameter. -[**get_coupon_book_by_coupon_book_definition_id**](CouponbookApi.md#get_coupon_book_by_coupon_book_definition_id) | **GET** /coupon-books/coupon-book-definition/{coupon-book-definition-ID} | Returns a collection of coupon-books, specified by coupon-book-definition-ID parameter. By default 10 coupon-books are returned. Records are returned in natural order. -[**get_coupon_book_by_coupon_code**](CouponbookApi.md#get_coupon_book_by_coupon_code) | **GET** /coupon-books/coupon/{coupon-code} | Returns a single coupon-book, specified by the coupon-code parameter. -[**get_coupon_book_by_id**](CouponbookApi.md#get_coupon_book_by_id) | **GET** /coupon-books/{coupon-book-ID} | Returns a single coupon-book, specified by the coupon-book-ID parameter. -[**update_coupon_book**](CouponbookApi.md#update_coupon_book) | **PUT** /coupon-books | Update a coupon-book. - - -# **create_coupon_book** -> CouponBookPagedMetadata create_coupon_book(coupon_book) - -Create a coupon-book. - -{\"nickname\":\"Create a new coupon book\",\"request\":\"createCouponBookRequest.html\",\"response\":\"createCouponBookResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookApi() -coupon_book = billforward.CouponBook() # CouponBook | The coupon-book object to be created. - -try: - # Create a coupon-book. - api_response = api_instance.create_coupon_book(coupon_book) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookApi->create_coupon_book: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_book** | [**CouponBook**](CouponBook.md)| The coupon-book object to be created. | - -### Return type - -[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_coupon_book** -> CouponBookPagedMetadata delete_coupon_book(coupon_book_id, organizations=organizations) - -Retire a coupon-book, specified by the coupon-book-ID parameter. - -{\"nickname\":\"Delete coupon book\",\"response\":\"deleteCouponBookByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookApi() -coupon_book_id = 'coupon_book_id_example' # str | ID of the coupon-book. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retire a coupon-book, specified by the coupon-book-ID parameter. - api_response = api_instance.delete_coupon_book(coupon_book_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookApi->delete_coupon_book: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_book_id** | **str**| ID of the coupon-book. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_attachable_coupon_books** -> CouponBookPagedMetadata get_all_attachable_coupon_books(attachableness, has_code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of attachable coupon-books. An attachable coupon-book has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all attachable coupon books\",\"response\":\"getCouponBookAllAttachable.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookApi() -attachableness = true # bool | The attachableness of the coupon-book. -has_code = true # bool | Whether the coupon-books have book codes or not. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first coupon-book to return. (optional) (default to 0) -records = 10 # int | The maximum number of coupon-books to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of attachable coupon-books. An attachable coupon-book has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_attachable_coupon_books(attachableness, has_code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookApi->get_all_attachable_coupon_books: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **attachableness** | **bool**| The attachableness of the coupon-book. | - **has_code** | **bool**| Whether the coupon-books have book codes or not. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first coupon-book to return. | [optional] [default to 0] - **records** | **int**| The maximum number of coupon-books to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_coupon_books** -> CouponBookPagedMetadata get_all_coupon_books(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of coupon-books. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all coupon books\",\"response\":\"getCouponBookAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first coupon-books to return. (optional) (default to 0) -records = 10 # int | The maximum number of coupon-books to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired coupon-books should be returned. (optional) (default to true) - -try: - # Returns a collection of coupon-books. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_coupon_books(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookApi->get_all_coupon_books: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first coupon-books to return. | [optional] [default to 0] - **records** | **int**| The maximum number of coupon-books to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired coupon-books should be returned. | [optional] [default to true] - -### Return type - -[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_book_by_book_code** -> CouponBookPagedMetadata get_coupon_book_by_book_code(book_code, organizations=organizations) - -Returns a single coupon-book, specified by the book-code parameter. - -{\"nickname\":\"Retrieve by book code\",\"response\":\"getCouponBookByBookCode.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookApi() -book_code = 'book_code_example' # str | The unique coupon-book-code. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single coupon-book, specified by the book-code parameter. - api_response = api_instance.get_coupon_book_by_book_code(book_code, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookApi->get_coupon_book_by_book_code: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **book_code** | **str**| The unique coupon-book-code. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_book_by_coupon_book_definition_id** -> CouponBookPagedMetadata get_coupon_book_by_coupon_book_definition_id(coupon_book_definition_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of coupon-books, specified by coupon-book-definition-ID parameter. By default 10 coupon-books are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by coupon book definition\",\"response\":\"getCouponBookByCouponBookDefinitionID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookApi() -coupon_book_definition_id = 'coupon_book_definition_id_example' # str | The string coupon-book-definition-ID of the coupon-book. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first coupon-book to return. (optional) (default to 0) -records = 10 # int | The maximum number of coupon-books to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired coupon-books should be returned. (optional) (default to true) - -try: - # Returns a collection of coupon-books, specified by coupon-book-definition-ID parameter. By default 10 coupon-books are returned. Records are returned in natural order. - api_response = api_instance.get_coupon_book_by_coupon_book_definition_id(coupon_book_definition_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookApi->get_coupon_book_by_coupon_book_definition_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_book_definition_id** | **str**| The string coupon-book-definition-ID of the coupon-book. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first coupon-book to return. | [optional] [default to 0] - **records** | **int**| The maximum number of coupon-books to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired coupon-books should be returned. | [optional] [default to true] - -### Return type - -[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_book_by_coupon_code** -> CouponBookPagedMetadata get_coupon_book_by_coupon_code(coupon_code, organizations=organizations) - -Returns a single coupon-book, specified by the coupon-code parameter. - -{\"nickname\":\"Retrieve by coupon code\",\"response\":\"getCouponBookByBookCode.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookApi() -coupon_code = 'coupon_code_example' # str | The unique coupon-code. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single coupon-book, specified by the coupon-code parameter. - api_response = api_instance.get_coupon_book_by_coupon_code(coupon_code, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookApi->get_coupon_book_by_coupon_code: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_code** | **str**| The unique coupon-code. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_book_by_id** -> CouponBookPagedMetadata get_coupon_book_by_id(coupon_book_id, organizations=organizations) - -Returns a single coupon-book, specified by the coupon-book-ID parameter. - -{\"nickname\":\"Retrieve an existing coupon book\",\"response\":\"getCouponBookByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookApi() -coupon_book_id = 'coupon_book_id_example' # str | ID of the coupon-book. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single coupon-book, specified by the coupon-book-ID parameter. - api_response = api_instance.get_coupon_book_by_id(coupon_book_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookApi->get_coupon_book_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_book_id** | **str**| ID of the coupon-book. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_coupon_book** -> CouponBookPagedMetadata update_coupon_book(coupon_book) - -Update a coupon-book. - -{\"nickname\":\"Update a coupon book\",\"request\":\"updateCouponBookRequest.html\",\"response\":\"updateCouponBookResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookApi() -coupon_book = billforward.CouponBook() # CouponBook | The coupon-book object to be updated. - -try: - # Update a coupon-book. - api_response = api_instance.update_coupon_book(coupon_book) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookApi->update_coupon_book: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_book** | [**CouponBook**](CouponBook.md)| The coupon-book object to be updated. | - -### Return type - -[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/CouponbookdefinitionApi.md b/docs/CouponbookdefinitionApi.md deleted file mode 100644 index d0fba62..0000000 --- a/docs/CouponbookdefinitionApi.md +++ /dev/null @@ -1,322 +0,0 @@ -# billforward.CouponbookdefinitionApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_coupon_book_definition**](CouponbookdefinitionApi.md#create_coupon_book_definition) | **POST** /coupon-book-definitions | Create a coupon-book-definition. -[**delete_coupon_book_definition**](CouponbookdefinitionApi.md#delete_coupon_book_definition) | **DELETE** /coupon-book-definitions/{coupon-book-definition-ID} | Retire a coupon-book-definition, specified by the coupon-book-definition-ID parameter. -[**get_all_coupon_book_definitions**](CouponbookdefinitionApi.md#get_all_coupon_book_definitions) | **GET** /coupon-book-definitions | Returns a collection of coupon-book-definitions. By default 10 values are returned. Records are returned in natural order. -[**get_coupon_book_definition_by_coupon_definition_id**](CouponbookdefinitionApi.md#get_coupon_book_definition_by_coupon_definition_id) | **GET** /coupon-book-definitions/coupon-definition/{coupon-definition-ID} | Returns a collection of coupon-book-definitions, specified by coupon-definition-ID parameter. By default 10 coupon-book-definitions are returned. Records are returned in natural order. -[**get_coupon_book_definition_by_id**](CouponbookdefinitionApi.md#get_coupon_book_definition_by_id) | **GET** /coupon-book-definitions/{coupon-book-definition-ID} | Returns a single coupon-book-definition, specified by the coupon-book-definition-ID parameter. -[**update_coupon_book_definition**](CouponbookdefinitionApi.md#update_coupon_book_definition) | **PUT** /coupon-book-definitions | Update a coupon-book-definition. - - -# **create_coupon_book_definition** -> CouponBookDefinitionPagedMetadata create_coupon_book_definition(coupon_book_definition) - -Create a coupon-book-definition. - -{\"nickname\":\"Create a new book definition\",\"request\":\"createCouponBookDefinitionRequest.html\",\"response\":\"createCouponBookDefinitionResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookdefinitionApi() -coupon_book_definition = billforward.CouponBookDefinition() # CouponBookDefinition | The coupon-book-definition object to be created. - -try: - # Create a coupon-book-definition. - api_response = api_instance.create_coupon_book_definition(coupon_book_definition) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookdefinitionApi->create_coupon_book_definition: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_book_definition** | [**CouponBookDefinition**](CouponBookDefinition.md)| The coupon-book-definition object to be created. | - -### Return type - -[**CouponBookDefinitionPagedMetadata**](CouponBookDefinitionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_coupon_book_definition** -> CouponBookDefinitionPagedMetadata delete_coupon_book_definition(coupon_book_definition_id, organizations=organizations) - -Retire a coupon-book-definition, specified by the coupon-book-definition-ID parameter. - -{\"nickname\":\"Delete book definition\",\"response\":\"deleteCouponBookDefinitionByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookdefinitionApi() -coupon_book_definition_id = 'coupon_book_definition_id_example' # str | ID of the coupon-definition. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retire a coupon-book-definition, specified by the coupon-book-definition-ID parameter. - api_response = api_instance.delete_coupon_book_definition(coupon_book_definition_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookdefinitionApi->delete_coupon_book_definition: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_book_definition_id** | **str**| ID of the coupon-definition. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponBookDefinitionPagedMetadata**](CouponBookDefinitionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_coupon_book_definitions** -> CouponBookDefinitionPagedMetadata get_all_coupon_book_definitions(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of coupon-book-definitions. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all book definitions\",\"response\":\"getCouponBookDefinitionAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookdefinitionApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first product-rate-plan to return. (optional) (default to 0) -records = 10 # int | The maximum number of product-rate-plans to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired coupon-book-definitions should be returned. (optional) (default to true) - -try: - # Returns a collection of coupon-book-definitions. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_coupon_book_definitions(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookdefinitionApi->get_all_coupon_book_definitions: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first product-rate-plan to return. | [optional] [default to 0] - **records** | **int**| The maximum number of product-rate-plans to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired coupon-book-definitions should be returned. | [optional] [default to true] - -### Return type - -[**CouponBookDefinitionPagedMetadata**](CouponBookDefinitionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_book_definition_by_coupon_definition_id** -> CouponBookDefinitionPagedMetadata get_coupon_book_definition_by_coupon_definition_id(coupon_definition_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of coupon-book-definitions, specified by coupon-definition-ID parameter. By default 10 coupon-book-definitions are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by coupon definition\",\"response\":\"getCouponBookDefinitionByCouponDefinitionID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookdefinitionApi() -coupon_definition_id = 'coupon_definition_id_example' # str | The string coupon-definition-ID of the coupon-book-definition. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first coupon-book-definition to return. (optional) (default to 0) -records = 10 # int | The maximum number of coupon-book-definitions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired coupon-book-definitions should be returned. (optional) (default to true) - -try: - # Returns a collection of coupon-book-definitions, specified by coupon-definition-ID parameter. By default 10 coupon-book-definitions are returned. Records are returned in natural order. - api_response = api_instance.get_coupon_book_definition_by_coupon_definition_id(coupon_definition_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookdefinitionApi->get_coupon_book_definition_by_coupon_definition_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_definition_id** | **str**| The string coupon-definition-ID of the coupon-book-definition. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first coupon-book-definition to return. | [optional] [default to 0] - **records** | **int**| The maximum number of coupon-book-definitions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired coupon-book-definitions should be returned. | [optional] [default to true] - -### Return type - -[**CouponBookDefinitionPagedMetadata**](CouponBookDefinitionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_book_definition_by_id** -> CouponBookDefinitionPagedMetadata get_coupon_book_definition_by_id(coupon_book_definition_id, organizations=organizations) - -Returns a single coupon-book-definition, specified by the coupon-book-definition-ID parameter. - -{\"nickname\":\"Retrieve an existing book definition\",\"response\":\"getCouponBookDefinitionByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookdefinitionApi() -coupon_book_definition_id = 'coupon_book_definition_id_example' # str | ID of the coupon-book-definition. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single coupon-book-definition, specified by the coupon-book-definition-ID parameter. - api_response = api_instance.get_coupon_book_definition_by_id(coupon_book_definition_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookdefinitionApi->get_coupon_book_definition_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_book_definition_id** | **str**| ID of the coupon-book-definition. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponBookDefinitionPagedMetadata**](CouponBookDefinitionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_coupon_book_definition** -> CouponBookDefinitionPagedMetadata update_coupon_book_definition(coupon_book_definition) - -Update a coupon-book-definition. - -{\"nickname\":\"Update a book definition\",\"request\":\"updateCouponBookDefinitionRequest.html\",\"response\":\"updateCouponBookDefinitionResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponbookdefinitionApi() -coupon_book_definition = billforward.CouponBookDefinition() # CouponBookDefinition | The coupon-book-definition object to be updated. - -try: - # Update a coupon-book-definition. - api_response = api_instance.update_coupon_book_definition(coupon_book_definition) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponbookdefinitionApi->update_coupon_book_definition: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_book_definition** | [**CouponBookDefinition**](CouponBookDefinition.md)| The coupon-book-definition object to be updated. | - -### Return type - -[**CouponBookDefinitionPagedMetadata**](CouponBookDefinitionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/CoupondefinitionApi.md b/docs/CoupondefinitionApi.md deleted file mode 100644 index 2a00b7f..0000000 --- a/docs/CoupondefinitionApi.md +++ /dev/null @@ -1,262 +0,0 @@ -# billforward.CoupondefinitionApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_coupon_definition**](CoupondefinitionApi.md#create_coupon_definition) | **POST** /coupon-definitions | Create a coupon-definition. -[**delete_coupon_definition**](CoupondefinitionApi.md#delete_coupon_definition) | **DELETE** /coupon-definitions/{coupon-definition-ID} | Retire a coupon-definition, specified by the coupon-definition-ID parameter. -[**get_all_coupon_definitions**](CoupondefinitionApi.md#get_all_coupon_definitions) | **GET** /coupon-definitions | Returns a collection of coupon-definitions. By default 10 values are returned. Records are returned in natural order. -[**get_coupon_definition_by_id**](CoupondefinitionApi.md#get_coupon_definition_by_id) | **GET** /coupon-definitions/{coupon-definition-ID} | Returns a single coupon-definition, specified by the coupon-definition-ID parameter. -[**update_coupon_definition**](CoupondefinitionApi.md#update_coupon_definition) | **PUT** /coupon-definitions | Update a coupon-definition. - - -# **create_coupon_definition** -> CouponDefinitionPagedMetadata create_coupon_definition(coupon_definition) - -Create a coupon-definition. - -{\"nickname\":\"Create a new definition\",\"request\":\"createCouponDefinitionRequest.html\",\"response\":\"createCouponDefinitionResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CoupondefinitionApi() -coupon_definition = billforward.CouponDefinition() # CouponDefinition | The coupon-definiton object to be created. - -try: - # Create a coupon-definition. - api_response = api_instance.create_coupon_definition(coupon_definition) - pprint(api_response) -except ApiException as e: - print "Exception when calling CoupondefinitionApi->create_coupon_definition: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_definition** | [**CouponDefinition**](CouponDefinition.md)| The coupon-definiton object to be created. | - -### Return type - -[**CouponDefinitionPagedMetadata**](CouponDefinitionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_coupon_definition** -> CouponDefinitionPagedMetadata delete_coupon_definition(coupon_definition_id, organizations=organizations) - -Retire a coupon-definition, specified by the coupon-definition-ID parameter. - -{\"nickname\":\"Delete a definition\",\"response\":\"deleteCouponDefinitionByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CoupondefinitionApi() -coupon_definition_id = 'coupon_definition_id_example' # str | ID of the coupon-definition. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retire a coupon-definition, specified by the coupon-definition-ID parameter. - api_response = api_instance.delete_coupon_definition(coupon_definition_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CoupondefinitionApi->delete_coupon_definition: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_definition_id** | **str**| ID of the coupon-definition. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponDefinitionPagedMetadata**](CouponDefinitionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_coupon_definitions** -> CouponDefinitionPagedMetadata get_all_coupon_definitions(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of coupon-definitions. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all coupon definitions\",\"response\":\"getCouponDefinitionAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CoupondefinitionApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first product-rate-plan to return. (optional) (default to 0) -records = 10 # int | The maximum number of product-rate-plans to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired coupon-definitions should be returned. (optional) (default to true) - -try: - # Returns a collection of coupon-definitions. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_coupon_definitions(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling CoupondefinitionApi->get_all_coupon_definitions: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first product-rate-plan to return. | [optional] [default to 0] - **records** | **int**| The maximum number of product-rate-plans to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired coupon-definitions should be returned. | [optional] [default to true] - -### Return type - -[**CouponDefinitionPagedMetadata**](CouponDefinitionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_definition_by_id** -> CouponDefinitionPagedMetadata get_coupon_definition_by_id(coupon_definition_id, organizations=organizations) - -Returns a single coupon-definition, specified by the coupon-definition-ID parameter. - -{\"nickname\":\"Get existing coupon definition\",\"response\":\"getCouponDefinitionByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CoupondefinitionApi() -coupon_definition_id = 'coupon_definition_id_example' # str | ID of the coupon-definition. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single coupon-definition, specified by the coupon-definition-ID parameter. - api_response = api_instance.get_coupon_definition_by_id(coupon_definition_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CoupondefinitionApi->get_coupon_definition_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_definition_id** | **str**| ID of the coupon-definition. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponDefinitionPagedMetadata**](CouponDefinitionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_coupon_definition** -> CouponDefinitionPagedMetadata update_coupon_definition(coupon_definition) - -Update a coupon-definition. - -{\"nickname\":\"Update a definition\",\"request\":\"updateCouponDefinitionRequest.html\",\"response\":\"updateCouponDefinitionResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CoupondefinitionApi() -coupon_definition = billforward.CouponDefinition() # CouponDefinition | The coupon-definition object to be updated. - -try: - # Update a coupon-definition. - api_response = api_instance.update_coupon_definition(coupon_definition) - pprint(api_response) -except ApiException as e: - print "Exception when calling CoupondefinitionApi->update_coupon_definition: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_definition** | [**CouponDefinition**](CouponDefinition.md)| The coupon-definition object to be updated. | - -### Return type - -[**CouponDefinitionPagedMetadata**](CouponDefinitionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/CouponinstanceApi.md b/docs/CouponinstanceApi.md deleted file mode 100644 index 91e871c..0000000 --- a/docs/CouponinstanceApi.md +++ /dev/null @@ -1,562 +0,0 @@ -# billforward.CouponinstanceApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_coupon_instance**](CouponinstanceApi.md#create_coupon_instance) | **POST** /coupon-instances | Create a coupon-instance. -[**delete_coupon_instance**](CouponinstanceApi.md#delete_coupon_instance) | **DELETE** /coupon-instances/{coupon-instance-ID} | Retire a coupon-instance, specified by the coupon-instance-ID parameter. -[**get_all_attachable_coupon_instances**](CouponinstanceApi.md#get_all_attachable_coupon_instances) | **GET** /coupon-instances/attachable/{attachableness}/{has_code} | Returns a collection of attachable coupon-instances. An attachable coupon-instance has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. -[**get_all_coupon_instances**](CouponinstanceApi.md#get_all_coupon_instances) | **GET** /coupon-instances | Returns a collection of coupon-instances. By default 10 values are returned. Records are returned in natural order. -[**get_coupon_instance_by_coupon_code**](CouponinstanceApi.md#get_coupon_instance_by_coupon_code) | **GET** /coupon-instances/coupon/{coupon-code} | Returns a collection of coupon-instances, specified by coupon-code parameter. By default 10 coupon-instances are returned. Records are returned in natural order. -[**get_coupon_instance_by_coupon_definition_id**](CouponinstanceApi.md#get_coupon_instance_by_coupon_definition_id) | **GET** /coupon-instances/coupon-definition/{coupon-definition-ID} | Returns a collection of coupon-instances, specified by coupon-definition-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. -[**get_coupon_instance_by_id**](CouponinstanceApi.md#get_coupon_instance_by_id) | **GET** /coupon-instances/{coupon-instance-ID} | Returns a single coupon-instance, specified by the coupon-instance-ID parameter. -[**get_coupon_instance_by_target_id**](CouponinstanceApi.md#get_coupon_instance_by_target_id) | **GET** /coupon-instances/target/{target-ID} | Returns a collection of coupon-instances, specified by target-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. -[**get_coupon_instance_by_target_type**](CouponinstanceApi.md#get_coupon_instance_by_target_type) | **GET** /coupon-instances/target-entity/{target} | Returns a collection of coupon-instances, specified by target parameter. By default 10 coupon-instances are returned. Records are returned in natural order. -[**update_coupon_instance**](CouponinstanceApi.md#update_coupon_instance) | **PUT** /coupon-instances | Update a coupon-instance. - - -# **create_coupon_instance** -> CouponInstancePagedMetadata create_coupon_instance(coupon_instance) - -Create a coupon-instance. - -{\"nickname\":\"Create a new coupon\",\"request\":\"createCouponInstanceRequest.html\",\"response\":\"createCouponInstanceResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponinstanceApi() -coupon_instance = billforward.CouponInstance() # CouponInstance | The coupon-instance object to be created. - -try: - # Create a coupon-instance. - api_response = api_instance.create_coupon_instance(coupon_instance) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponinstanceApi->create_coupon_instance: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_instance** | [**CouponInstance**](CouponInstance.md)| The coupon-instance object to be created. | - -### Return type - -[**CouponInstancePagedMetadata**](CouponInstancePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_coupon_instance** -> CouponInstancePagedMetadata delete_coupon_instance(coupon_instance_id, organizations=organizations) - -Retire a coupon-instance, specified by the coupon-instance-ID parameter. - -{\"nickname\":\"Delete a coupon\",\"response\":\"deleteCouponInstanceByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponinstanceApi() -coupon_instance_id = 'coupon_instance_id_example' # str | ID of the coupon-instance. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retire a coupon-instance, specified by the coupon-instance-ID parameter. - api_response = api_instance.delete_coupon_instance(coupon_instance_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponinstanceApi->delete_coupon_instance: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_instance_id** | **str**| ID of the coupon-instance. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponInstancePagedMetadata**](CouponInstancePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_attachable_coupon_instances** -> CouponInstancePagedMetadata get_all_attachable_coupon_instances(attachableness, has_code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of attachable coupon-instances. An attachable coupon-instance has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get attachable coupons\",\"response\":\"getCouponInstanceAllAttachable.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponinstanceApi() -attachableness = true # bool | The attachableness of the coupon-instance. -has_code = true # bool | Whether the coupon-instances have coupon codes or not. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first coupon-instance to return. (optional) (default to 0) -records = 10 # int | The maximum number of coupon-instances to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of attachable coupon-instances. An attachable coupon-instance has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_attachable_coupon_instances(attachableness, has_code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponinstanceApi->get_all_attachable_coupon_instances: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **attachableness** | **bool**| The attachableness of the coupon-instance. | - **has_code** | **bool**| Whether the coupon-instances have coupon codes or not. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first coupon-instance to return. | [optional] [default to 0] - **records** | **int**| The maximum number of coupon-instances to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**CouponInstancePagedMetadata**](CouponInstancePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_coupon_instances** -> CouponInstancePagedMetadata get_all_coupon_instances(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of coupon-instances. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all coupons\",\"response\":\"getCouponInstanceAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponinstanceApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first coupon-instance to return. (optional) (default to 0) -records = 10 # int | The maximum number of coupon-instances to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired coupon-instances should be returned. (optional) (default to true) - -try: - # Returns a collection of coupon-instances. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_coupon_instances(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponinstanceApi->get_all_coupon_instances: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first coupon-instance to return. | [optional] [default to 0] - **records** | **int**| The maximum number of coupon-instances to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired coupon-instances should be returned. | [optional] [default to true] - -### Return type - -[**CouponInstancePagedMetadata**](CouponInstancePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_instance_by_coupon_code** -> CouponInstancePagedMetadata get_coupon_instance_by_coupon_code(coupon_code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of coupon-instances, specified by coupon-code parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by coupon code\",\"response\":\"getCouponInstanceByCouponCode.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponinstanceApi() -coupon_code = 'coupon_code_example' # str | The string coupon-code of the coupon-instance. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first coupon-instance to return. (optional) (default to 0) -records = 10 # int | The maximum number of coupon-instances to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired coupon-instances should be returned. (optional) (default to true) - -try: - # Returns a collection of coupon-instances, specified by coupon-code parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - api_response = api_instance.get_coupon_instance_by_coupon_code(coupon_code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponinstanceApi->get_coupon_instance_by_coupon_code: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_code** | **str**| The string coupon-code of the coupon-instance. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first coupon-instance to return. | [optional] [default to 0] - **records** | **int**| The maximum number of coupon-instances to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired coupon-instances should be returned. | [optional] [default to true] - -### Return type - -[**CouponInstancePagedMetadata**](CouponInstancePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_instance_by_coupon_definition_id** -> CouponInstancePagedMetadata get_coupon_instance_by_coupon_definition_id(coupon_definition_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of coupon-instances, specified by coupon-definition-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by coupon definition\",\"response\":\"getCouponInstanceByCouponDefinitionID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponinstanceApi() -coupon_definition_id = 'coupon_definition_id_example' # str | The string coupon-definition-ID of the coupon-instance. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first coupon-instance to return. (optional) (default to 0) -records = 10 # int | The maximum number of coupon-instances to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired coupon-instances should be returned. (optional) (default to true) - -try: - # Returns a collection of coupon-instances, specified by coupon-definition-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - api_response = api_instance.get_coupon_instance_by_coupon_definition_id(coupon_definition_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponinstanceApi->get_coupon_instance_by_coupon_definition_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_definition_id** | **str**| The string coupon-definition-ID of the coupon-instance. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first coupon-instance to return. | [optional] [default to 0] - **records** | **int**| The maximum number of coupon-instances to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired coupon-instances should be returned. | [optional] [default to true] - -### Return type - -[**CouponInstancePagedMetadata**](CouponInstancePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_instance_by_id** -> CouponInstancePagedMetadata get_coupon_instance_by_id(coupon_instance_id, organizations=organizations) - -Returns a single coupon-instance, specified by the coupon-instance-ID parameter. - -{\"nickname\":\"Get existing coupon\",\"response\":\"getCouponInstanceByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponinstanceApi() -coupon_instance_id = 'coupon_instance_id_example' # str | ID of the coupon-instance. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single coupon-instance, specified by the coupon-instance-ID parameter. - api_response = api_instance.get_coupon_instance_by_id(coupon_instance_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponinstanceApi->get_coupon_instance_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_instance_id** | **str**| ID of the coupon-instance. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponInstancePagedMetadata**](CouponInstancePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_instance_by_target_id** -> CouponInstancePagedMetadata get_coupon_instance_by_target_id(target_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of coupon-instances, specified by target-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by target\",\"response\":\"getCouponInstanceByTargetID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponinstanceApi() -target_id = 'target_id_example' # str | The string target-ID of the coupon-instance. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first coupon-instance to return. (optional) (default to 0) -records = 10 # int | The maximum number of coupon-instances to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired coupon-instances should be returned. (optional) (default to true) - -try: - # Returns a collection of coupon-instances, specified by target-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - api_response = api_instance.get_coupon_instance_by_target_id(target_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponinstanceApi->get_coupon_instance_by_target_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **target_id** | **str**| The string target-ID of the coupon-instance. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first coupon-instance to return. | [optional] [default to 0] - **records** | **int**| The maximum number of coupon-instances to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired coupon-instances should be returned. | [optional] [default to true] - -### Return type - -[**CouponInstancePagedMetadata**](CouponInstancePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_instance_by_target_type** -> CouponInstancePagedMetadata get_coupon_instance_by_target_type(target, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of coupon-instances, specified by target parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by target type\",\"response\":\"getCouponInstanceByTarget.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponinstanceApi() -target = 'target_example' # str | The string target of the coupon-instance. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first coupon-instance to return. (optional) (default to 0) -records = 10 # int | The maximum number of coupon-instances to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired coupon-instances should be returned. (optional) (default to true) - -try: - # Returns a collection of coupon-instances, specified by target parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - api_response = api_instance.get_coupon_instance_by_target_type(target, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponinstanceApi->get_coupon_instance_by_target_type: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **target** | **str**| The string target of the coupon-instance. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first coupon-instance to return. | [optional] [default to 0] - **records** | **int**| The maximum number of coupon-instances to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired coupon-instances should be returned. | [optional] [default to true] - -### Return type - -[**CouponInstancePagedMetadata**](CouponInstancePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_coupon_instance** -> CouponInstancePagedMetadata update_coupon_instance(coupon_instance) - -Update a coupon-instance. - -{\"nickname\":\"Update a coupon\",\"request\":\"updateCouponInstanceRequest.html\",\"response\":\"updateCouponInstanceResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponinstanceApi() -coupon_instance = billforward.CouponInstance() # CouponInstance | The coupon-instance object to be updated. - -try: - # Update a coupon-instance. - api_response = api_instance.update_coupon_instance(coupon_instance) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponinstanceApi->update_coupon_instance: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_instance** | [**CouponInstance**](CouponInstance.md)| The coupon-instance object to be updated. | - -### Return type - -[**CouponInstancePagedMetadata**](CouponInstancePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/CouponmodifierApi.md b/docs/CouponmodifierApi.md deleted file mode 100644 index 985f06c..0000000 --- a/docs/CouponmodifierApi.md +++ /dev/null @@ -1,360 +0,0 @@ -# billforward.CouponmodifierApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_coupon_modifier**](CouponmodifierApi.md#create_coupon_modifier) | **POST** /coupon-modifiers | Create a coupon-modifier. -[**delete_coupon_modifier**](CouponmodifierApi.md#delete_coupon_modifier) | **DELETE** /coupon-modifiers/{coupon-modifier-ID} | Retire a coupon-modifier, specified by the coupon-modifier-ID parameter. -[**get_all_coupon_modifiers**](CouponmodifierApi.md#get_all_coupon_modifiers) | **GET** /coupon-modifiers | Returns a collection of coupon-modifiers. By default 10 values are returned. Records are returned in natural order. -[**get_coupon_modifier_by_coupon_code**](CouponmodifierApi.md#get_coupon_modifier_by_coupon_code) | **GET** /coupon-modifiers/coupon-code/{coupon-code} | Returns a collection of coupon-modifiers, specified by the coupon-code parameter. -[**get_coupon_modifier_by_coupon_definition_id**](CouponmodifierApi.md#get_coupon_modifier_by_coupon_definition_id) | **GET** /coupon-modifiers/coupon-definition/{coupon-definition-ID} | Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter. -[**get_coupon_modifier_by_id**](CouponmodifierApi.md#get_coupon_modifier_by_id) | **GET** /coupon-modifiers/{coupon-modifier-ID} | Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter. -[**update_coupon_modifier**](CouponmodifierApi.md#update_coupon_modifier) | **PUT** /coupon-modifiers | Update a coupon-instance. - - -# **create_coupon_modifier** -> CouponModifierBasePagedMetadata create_coupon_modifier(coupon_instance) - -Create a coupon-modifier. - -{\"nickname\":\"Create a new modifier\",\"request\":\"createCouponModifierRequest.html\",\"response\":\"createCouponModifierResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponmodifierApi() -coupon_instance = billforward.CouponModifierBase() # CouponModifierBase | The coupon-instance object to be created. - -try: - # Create a coupon-modifier. - api_response = api_instance.create_coupon_modifier(coupon_instance) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponmodifierApi->create_coupon_modifier: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_instance** | [**CouponModifierBase**](CouponModifierBase.md)| The coupon-instance object to be created. | - -### Return type - -[**CouponModifierBasePagedMetadata**](CouponModifierBasePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_coupon_modifier** -> CouponModifierBasePagedMetadata delete_coupon_modifier(coupon_modifier_id, organizations=organizations) - -Retire a coupon-modifier, specified by the coupon-modifier-ID parameter. - -{\"nickname\":\"Delete a modifier\",\"response\":\"deleteCouponModifierByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponmodifierApi() -coupon_modifier_id = 'coupon_modifier_id_example' # str | ID of the coupon-modifier. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retire a coupon-modifier, specified by the coupon-modifier-ID parameter. - api_response = api_instance.delete_coupon_modifier(coupon_modifier_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponmodifierApi->delete_coupon_modifier: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_modifier_id** | **str**| ID of the coupon-modifier. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponModifierBasePagedMetadata**](CouponModifierBasePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_coupon_modifiers** -> CouponModifierBasePagedMetadata get_all_coupon_modifiers(organizations=organizations, offset=offset, records=records) - -Returns a collection of coupon-modifiers. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all modifiers\",\"response\":\"getCouponModifierAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponmodifierApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first product-rate-plan to return. (optional) (default to 0) -records = 10 # int | The maximum number of product-rate-plans to return. (optional) (default to 10) - -try: - # Returns a collection of coupon-modifiers. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_coupon_modifiers(organizations=organizations, offset=offset, records=records) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponmodifierApi->get_all_coupon_modifiers: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first product-rate-plan to return. | [optional] [default to 0] - **records** | **int**| The maximum number of product-rate-plans to return. | [optional] [default to 10] - -### Return type - -[**CouponModifierBasePagedMetadata**](CouponModifierBasePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_modifier_by_coupon_code** -> CouponModifierBasePagedMetadata get_coupon_modifier_by_coupon_code(coupon_code, organizations=organizations, offset=offset, records=records) - -Returns a collection of coupon-modifiers, specified by the coupon-code parameter. - -{\"nickname\":\"Retrieve by coupon code\",\"response\":\"getCouponCode.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponmodifierApi() -coupon_code = 'coupon_code_example' # str | The coupon-code. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first product-rate-plan to return. (optional) (default to 0) -records = 10 # int | The maximum number of product-rate-plans to return. (optional) (default to 10) - -try: - # Returns a collection of coupon-modifiers, specified by the coupon-code parameter. - api_response = api_instance.get_coupon_modifier_by_coupon_code(coupon_code, organizations=organizations, offset=offset, records=records) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponmodifierApi->get_coupon_modifier_by_coupon_code: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_code** | **str**| The coupon-code. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first product-rate-plan to return. | [optional] [default to 0] - **records** | **int**| The maximum number of product-rate-plans to return. | [optional] [default to 10] - -### Return type - -[**CouponModifierBasePagedMetadata**](CouponModifierBasePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_modifier_by_coupon_definition_id** -> CouponModifierBasePagedMetadata get_coupon_modifier_by_coupon_definition_id(coupon_definition_id, organizations=organizations) - -Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter. - -{\"nickname\":\"Retrieve by coupon definition\",\"response\":\"getCouponModifierByCouponDefinitionID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponmodifierApi() -coupon_definition_id = 'coupon_definition_id_example' # str | ID of the coupon-definition. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter. - api_response = api_instance.get_coupon_modifier_by_coupon_definition_id(coupon_definition_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponmodifierApi->get_coupon_modifier_by_coupon_definition_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_definition_id** | **str**| ID of the coupon-definition. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponModifierBasePagedMetadata**](CouponModifierBasePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_modifier_by_id** -> CouponModifierBasePagedMetadata get_coupon_modifier_by_id(coupon_modifier_id, organizations=organizations) - -Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter. - -{\"nickname\":\"Get existing modifier\",\"response\":\"getCouponModifierByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponmodifierApi() -coupon_modifier_id = 'coupon_modifier_id_example' # str | ID of the coupon-modifier. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter. - api_response = api_instance.get_coupon_modifier_by_id(coupon_modifier_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponmodifierApi->get_coupon_modifier_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_modifier_id** | **str**| ID of the coupon-modifier. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponModifierBasePagedMetadata**](CouponModifierBasePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_coupon_modifier** -> CouponModifierBasePagedMetadata update_coupon_modifier(coupon_instance) - -Update a coupon-instance. - -{\"nickname\":\"Update a modifier\",\"request\":\"updateCouponInstanceRequest.html\",\"response\":\"updateCouponInstanceResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponmodifierApi() -coupon_instance = billforward.CouponModifierBase() # CouponModifierBase | The coupon-instance object to be updated. - -try: - # Update a coupon-instance. - api_response = api_instance.update_coupon_modifier(coupon_instance) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponmodifierApi->update_coupon_modifier: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_instance** | [**CouponModifierBase**](CouponModifierBase.md)| The coupon-instance object to be updated. | - -### Return type - -[**CouponModifierBasePagedMetadata**](CouponModifierBasePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/CouponruleApi.md b/docs/CouponruleApi.md deleted file mode 100644 index 4c57438..0000000 --- a/docs/CouponruleApi.md +++ /dev/null @@ -1,262 +0,0 @@ -# billforward.CouponruleApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_coupon_rule**](CouponruleApi.md#create_coupon_rule) | **POST** /coupon-rules | Create a coupon-rule. -[**delete_coupon_rule**](CouponruleApi.md#delete_coupon_rule) | **DELETE** /coupon-rules/{coupon-rule-ID} | Retire a coupon-rule, specified by the coupon-rule-ID parameter. -[**get_all_coupon_rules**](CouponruleApi.md#get_all_coupon_rules) | **GET** /coupon-rules | Returns a collection of coupon-rules. By default 10 values are returned. Records are returned in natural order. -[**get_coupon_rule_by_coupon_definition_id**](CouponruleApi.md#get_coupon_rule_by_coupon_definition_id) | **GET** /coupon-rules/coupon-definition/{coupon-definition-ID} | Returns a single coupon-definition, specified by the coupon-definition-ID parameter. -[**get_coupon_rule_by_id**](CouponruleApi.md#get_coupon_rule_by_id) | **GET** /coupon-rules/{coupon-rule-ID} | Returns a single coupon-rule, specified by the coupon-rule-ID parameter. - - -# **create_coupon_rule** -> CouponRulePagedMetadata create_coupon_rule(coupon_rule) - -Create a coupon-rule. - -{\"nickname\":\"Create a new rule\", \"request\" : \"createCouponRuleRequest.html\" ,\"response\" : \"createCouponRuleResponse.html\" } - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponruleApi() -coupon_rule = billforward.CouponRule() # CouponRule | The coupon-rule object to be created. - -try: - # Create a coupon-rule. - api_response = api_instance.create_coupon_rule(coupon_rule) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponruleApi->create_coupon_rule: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_rule** | [**CouponRule**](CouponRule.md)| The coupon-rule object to be created. | - -### Return type - -[**CouponRulePagedMetadata**](CouponRulePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_coupon_rule** -> CouponRulePagedMetadata delete_coupon_rule(coupon_rule_id, organizations=organizations) - -Retire a coupon-rule, specified by the coupon-rule-ID parameter. - -{\"nickname\":\"Delete a rule\",\"response\" : \"deleteCouponRuleByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponruleApi() -coupon_rule_id = 'coupon_rule_id_example' # str | ID of the coupon-rule. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retire a coupon-rule, specified by the coupon-rule-ID parameter. - api_response = api_instance.delete_coupon_rule(coupon_rule_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponruleApi->delete_coupon_rule: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_rule_id** | **str**| ID of the coupon-rule. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponRulePagedMetadata**](CouponRulePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_coupon_rules** -> CouponRulePagedMetadata get_all_coupon_rules(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of coupon-rules. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all rules\",\"response\" : \"getCouponRuleAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponruleApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first product-rate-plan to return. (optional) (default to 0) -records = 10 # int | The maximum number of product-rate-plans to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of coupon-rules. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_coupon_rules(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponruleApi->get_all_coupon_rules: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first product-rate-plan to return. | [optional] [default to 0] - **records** | **int**| The maximum number of product-rate-plans to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**CouponRulePagedMetadata**](CouponRulePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_rule_by_coupon_definition_id** -> CouponRulePagedMetadata get_coupon_rule_by_coupon_definition_id(coupon_definition_id, organizations=organizations) - -Returns a single coupon-definition, specified by the coupon-definition-ID parameter. - -{\"nickname\":\"Retrieve by coupon definition\",\"response\" : \"getCouponRuleByCouponDefinitionID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponruleApi() -coupon_definition_id = 'coupon_definition_id_example' # str | ID of the coupon-definition. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single coupon-definition, specified by the coupon-definition-ID parameter. - api_response = api_instance.get_coupon_rule_by_coupon_definition_id(coupon_definition_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponruleApi->get_coupon_rule_by_coupon_definition_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_definition_id** | **str**| ID of the coupon-definition. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponRulePagedMetadata**](CouponRulePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_rule_by_id** -> CouponRulePagedMetadata get_coupon_rule_by_id(coupon_rule_id, organizations=organizations) - -Returns a single coupon-rule, specified by the coupon-rule-ID parameter. - -{\"nickname\":\"Retrieve an existing rule\",\"response\" : \"getCouponRuleByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CouponruleApi() -coupon_rule_id = 'coupon_rule_id_example' # str | ID of the coupon-rule. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single coupon-rule, specified by the coupon-rule-ID parameter. - api_response = api_instance.get_coupon_rule_by_id(coupon_rule_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CouponruleApi->get_coupon_rule_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_rule_id** | **str**| ID of the coupon-rule. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CouponRulePagedMetadata**](CouponRulePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/CouponsApi.md b/docs/CouponsApi.md index 9730f61..8994534 100644 --- a/docs/CouponsApi.md +++ b/docs/CouponsApi.md @@ -1,58 +1,58 @@ # billforward.CouponsApi -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_coupon**](CouponsApi.md#create_coupon) | **POST** /coupons | Create a coupon. -[**create_coupon_unique_codes**](CouponsApi.md#create_coupon_unique_codes) | **POST** /coupons/{code}/codes | Create a list of unique coupon codes that can be applied to a subscription. -[**get_all_coupons**](CouponsApi.md#get_all_coupons) | **GET** /coupons | Returns a collection of all coupons. By default 10 values are returned. Records are returned in natural order. -[**get_applied_coupons**](CouponsApi.md#get_applied_coupons) | **GET** /coupons/{code}/applied | Returns a list of unique coupons which have been applied. -[**get_available_coupon_codes_for_code**](CouponsApi.md#get_available_coupon_codes_for_code) | **GET** /coupons/{code}/codes | Returns a list of available unique coupon codes for the specified parent coupon code that can be applied to a subscription. -[**get_coupon_code**](CouponsApi.md#get_coupon_code) | **GET** /coupons/{code} | Returns the coupon for the specified code that can be applied to a subscription. -[**get_subscription_applications_of_coupons**](CouponsApi.md#get_subscription_applications_of_coupons) | **GET** /coupons/{code}/subscriptions | Retrieves a collection of the coupons by this coupon code which have been applied. -[**retire_coupon**](CouponsApi.md#retire_coupon) | **DELETE** /coupons/{code} | <p>This method has 2 main behaviours depending on what is passed in. If the parent coupon code, for example SUMMER, is given no new coupons can be issued or claimed from this code. Deleting will result in the deleted property being set to true.</p><p>If a unique coupon code, for example SUMMER-AGH8, is given this will stop the coupon from being applied to the subscription from that point onwards. When a coupon is deleted the validUntil property is set which is the date/time it stopped applying to the target.</p> - +[**create_coupon**](CouponsApi.md#create_coupon) | **POST** /coupons | +[**create_coupon_unique_codes**](CouponsApi.md#create_coupon_unique_codes) | **POST** /coupons/{code}/codes | +[**get_all_coupons**](CouponsApi.md#get_all_coupons) | **GET** /coupons | +[**get_applied_coupons**](CouponsApi.md#get_applied_coupons) | **GET** /coupons/{code}/applied | +[**get_available_coupon_codes_for_code**](CouponsApi.md#get_available_coupon_codes_for_code) | **GET** /coupons/{code}/codes | +[**get_available_coupon_codes_for_code_as_csv**](CouponsApi.md#get_available_coupon_codes_for_code_as_csv) | **GET** /coupons/{code}/codes.csv | +[**get_coupon_code**](CouponsApi.md#get_coupon_code) | **GET** /coupons/{code} | +[**get_plans_for_coupon**](CouponsApi.md#get_plans_for_coupon) | **GET** /coupons/{code}/plans | +[**get_subscription_applications_of_coupons**](CouponsApi.md#get_subscription_applications_of_coupons) | **GET** /coupons/{code}/subscriptions | +[**retire_coupon**](CouponsApi.md#retire_coupon) | **DELETE** /coupons/{code} | # **create_coupon** -> CouponPagedMetadata create_coupon(code) +> InlineResponseDefault23 create_coupon(body=body) -Create a coupon. -{\"nickname\":\"Create a new coupon\",\"request\":\"createCouponRequest.html\",\"response\":\"createCouponResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.CouponsApi() -code = billforward.Coupon() # Coupon | The coupon object to be created. +api_instance = billforward.CouponsApi(billforward.ApiClient(configuration)) +body = billforward.CreateCouponRequest() # CreateCouponRequest | (optional) -try: - # Create a coupon. - api_response = api_instance.create_coupon(code) +try: + api_response = api_instance.create_coupon(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling CouponsApi->create_coupon: %s\n" % e + print("Exception when calling CouponsApi->create_coupon: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **code** | [**Coupon**](Coupon.md)| The coupon object to be created. | + **body** | [**CreateCouponRequest**](CreateCouponRequest.md)| | [optional] ### Return type -[**CouponPagedMetadata**](CouponPagedMetadata.md) +[**InlineResponseDefault23**](InlineResponseDefault23.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -62,46 +62,45 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_coupon_unique_codes** -> CouponUniqueCodesResponsePagedMetadata create_coupon_unique_codes(code, request=request) +> InlineResponseDefault24 create_coupon_unique_codes(code, body=body) -Create a list of unique coupon codes that can be applied to a subscription. -{ \"nickname\":\"Create unique coupon codes\",\"request\":\"createUniqueCodesRequest.html\",\"response\":\"createUniqueCodesResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.CouponsApi() -code = 'code_example' # str | The coupon code to use in the generation of the unique codes. -request = billforward.CouponUniqueCodesRequest() # CouponUniqueCodesRequest | The request object that specifies the number of codes to be created. (optional) +api_instance = billforward.CouponsApi(billforward.ApiClient(configuration)) +code = 'code_example' # str | +body = billforward.CouponUniqueCodesRequest() # CouponUniqueCodesRequest | (optional) -try: - # Create a list of unique coupon codes that can be applied to a subscription. - api_response = api_instance.create_coupon_unique_codes(code, request=request) +try: + api_response = api_instance.create_coupon_unique_codes(code, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling CouponsApi->create_coupon_unique_codes: %s\n" % e + print("Exception when calling CouponsApi->create_coupon_unique_codes: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **code** | **str**| The coupon code to use in the generation of the unique codes. | - **request** | [**CouponUniqueCodesRequest**](CouponUniqueCodesRequest.md)| The request object that specifies the number of codes to be created. | [optional] + **code** | **str**| | + **body** | [**CouponUniqueCodesRequest**](CouponUniqueCodesRequest.md)| | [optional] ### Return type -[**CouponUniqueCodesResponsePagedMetadata**](CouponUniqueCodesResponsePagedMetadata.md) +[**InlineResponseDefault24**](InlineResponseDefault24.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -111,54 +110,53 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_coupons** -> CouponPagedMetadata get_all_coupons(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault22 get_all_coupons(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Returns a collection of all coupons. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\":\"Retrieve all coupons\",\"response\":\"getCouponAll.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.CouponsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Returns a collection of all coupons. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.CouponsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_all_coupons(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling CouponsApi->get_all_coupons: %s\n" % e + print("Exception when calling CouponsApi->get_all_coupons: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**CouponPagedMetadata**](CouponPagedMetadata.md) +[**InlineResponseDefault22**](InlineResponseDefault22.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -168,276 +166,382 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_applied_coupons** -> CouponPagedMetadata get_applied_coupons(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault22 get_applied_coupons(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Returns a list of unique coupons which have been applied. -{ \"nickname\":\"Retrieve used unique coupons\",\"response\":\"getAppliedCodesForCode.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.CouponsApi() -code = 'code_example' # str | The base code to use in the generation of the unique codes. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Returns a list of unique coupons which have been applied. +api_instance = billforward.CouponsApi(billforward.ApiClient(configuration)) +code = 'code_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_applied_coupons(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling CouponsApi->get_applied_coupons: %s\n" % e + print("Exception when calling CouponsApi->get_applied_coupons: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **code** | **str**| The base code to use in the generation of the unique codes. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **code** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**CouponPagedMetadata**](CouponPagedMetadata.md) +[**InlineResponseDefault22**](InlineResponseDefault22.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_available_coupon_codes_for_code** -> CouponUniqueCodesResponsePagedMetadata get_available_coupon_codes_for_code(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault24 get_available_coupon_codes_for_code(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) -Returns a list of available unique coupon codes for the specified parent coupon code that can be applied to a subscription. -{ \"nickname\":\"Retrieve unused unique coupons\",\"response\":\"getAvailableCodesForCode.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.CouponsApi() -code = 'code_example' # str | The base code to use in the generation of the unique codes. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Returns a list of available unique coupon codes for the specified parent coupon code that can be applied to a subscription. - api_response = api_instance.get_available_coupon_codes_for_code(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +api_instance = billforward.CouponsApi(billforward.ApiClient(configuration)) +code = 'code_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: + api_response = api_instance.get_available_coupon_codes_for_code(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) pprint(api_response) except ApiException as e: - print "Exception when calling CouponsApi->get_available_coupon_codes_for_code: %s\n" % e + print("Exception when calling CouponsApi->get_available_coupon_codes_for_code: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **code** | **str**| The base code to use in the generation of the unique codes. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **code** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] ### Return type -[**CouponUniqueCodesResponsePagedMetadata**](CouponUniqueCodesResponsePagedMetadata.md) +[**InlineResponseDefault24**](InlineResponseDefault24.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_available_coupon_codes_for_code_as_csv** +> get_available_coupon_codes_for_code_as_csv(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.CouponsApi(billforward.ApiClient(configuration)) +code = 'code_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 56 # int | (optional) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: + api_instance.get_available_coupon_codes_for_code_as_csv(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) +except ApiException as e: + print("Exception when calling CouponsApi->get_available_coupon_codes_for_code_as_csv: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **code** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_coupon_code** -> CouponUniqueCodesResponsePagedMetadata get_coupon_code(code, organizations=organizations) +> InlineResponseDefault22 get_coupon_code(code, organizations=organizations) -Returns the coupon for the specified code that can be applied to a subscription. -{ \"nickname\":\"Retrieve coupon\",\"response\":\"getCouponByCode.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.CouponsApi() -code = 'code_example' # str | The parent coupon code to use in the generation of the unique codes. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +api_instance = billforward.CouponsApi(billforward.ApiClient(configuration)) +code = 'code_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Returns the coupon for the specified code that can be applied to a subscription. +try: api_response = api_instance.get_coupon_code(code, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling CouponsApi->get_coupon_code: %s\n" % e + print("Exception when calling CouponsApi->get_coupon_code: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **code** | **str**| The parent coupon code to use in the generation of the unique codes. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **code** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**CouponUniqueCodesResponsePagedMetadata**](CouponUniqueCodesResponsePagedMetadata.md) +[**InlineResponseDefault22**](InlineResponseDefault22.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_plans_for_coupon** +> InlineResponseDefault25 get_plans_for_coupon(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.CouponsApi(billforward.ApiClient(configuration)) +code = 'code_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_plans_for_coupon(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + pprint(api_response) +except ApiException as e: + print("Exception when calling CouponsApi->get_plans_for_coupon: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **code** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + +### Return type + +[**InlineResponseDefault25**](InlineResponseDefault25.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_subscription_applications_of_coupons** -> SubscriptionPagedMetadata get_subscription_applications_of_coupons(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault26 get_subscription_applications_of_coupons(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a collection of the coupons by this coupon code which have been applied. -{ \"nickname\":\"Retrieve subscriptions to which the given coupon code has been applied.\",\"response\":\"getSubscriptionApplications.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.CouponsApi() -code = 'code_example' # str | Base code of the coupon. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Retrieves a collection of the coupons by this coupon code which have been applied. +api_instance = billforward.CouponsApi(billforward.ApiClient(configuration)) +code = 'code_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_subscription_applications_of_coupons(code, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling CouponsApi->get_subscription_applications_of_coupons: %s\n" % e + print("Exception when calling CouponsApi->get_subscription_applications_of_coupons: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **code** | **str**| Base code of the coupon. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **code** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault26**](InlineResponseDefault26.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **retire_coupon** -> CouponPagedMetadata retire_coupon(code, organizations) +> InlineResponseDefault22 retire_coupon(code, organizations=organizations) -

This method has 2 main behaviours depending on what is passed in. If the parent coupon code, for example SUMMER, is given no new coupons can be issued or claimed from this code. Deleting will result in the deleted property being set to true.

If a unique coupon code, for example SUMMER-AGH8, is given this will stop the coupon from being applied to the subscription from that point onwards. When a coupon is deleted the validUntil property is set which is the date/time it stopped applying to the target.

-{ \"nickname\":\"Retire coupon\",\"response\":\"retireCoupon.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.CouponsApi() -code = 'code_example' # str | ID of the coupon to remove. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. +api_instance = billforward.CouponsApi(billforward.ApiClient(configuration)) +code = 'code_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - #

This method has 2 main behaviours depending on what is passed in. If the parent coupon code, for example SUMMER, is given no new coupons can be issued or claimed from this code. Deleting will result in the deleted property being set to true.

If a unique coupon code, for example SUMMER-AGH8, is given this will stop the coupon from being applied to the subscription from that point onwards. When a coupon is deleted the validUntil property is set which is the date/time it stopped applying to the target.

- api_response = api_instance.retire_coupon(code, organizations) +try: + api_response = api_instance.retire_coupon(code, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling CouponsApi->retire_coupon: %s\n" % e + print("Exception when calling CouponsApi->retire_coupon: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **code** | **str**| ID of the coupon to remove. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | + **code** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**CouponPagedMetadata**](CouponPagedMetadata.md) +[**InlineResponseDefault22**](InlineResponseDefault22.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/CreateAccountProfileRequest.md b/docs/CreateAccountProfileRequest.md deleted file mode 100644 index 2db2417..0000000 --- a/docs/CreateAccountProfileRequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# CreateAccountProfileRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**account_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**email** | **str** | { \"description\" : \"E-mail address\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**first_name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**last_name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**company_name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**logo_url** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**addresses** | [**list[CreateProfileAddressRequest]**](CreateProfileAddressRequest.md) | { \"description\" : \"Address associated with the profile\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**mobile** | **str** | { \"description\" : \"Mobile telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**landline** | **str** | { \"description\" : \"Home telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**fax** | **str** | { \"description\" : \"Fax number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**dob** | **datetime** | { \"description\" : \"Date of birth in YYYY-MM-DD format\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**vat_number** | **str** | { \"description\" : \"VAT number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**additional_information** | **str** | { \"description\" : \"Any additional information\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateAccountRequest.md b/docs/CreateAccountRequest.md deleted file mode 100644 index c7f8f03..0000000 --- a/docs/CreateAccountRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# CreateAccountRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**profile** | [**CreateAccountProfileRequest**](CreateAccountProfileRequest.md) | | [optional] -**organization_id** | **str** | { \"description\" : \"Organization associated with the account.\", \"verbs\":[] } | [optional] -**user_id** | **str** | { \"description\" : \"User associated with the account. If this is null, no user is currently assocaited with the account. A user is only set when an account is associated with a user account.\", \"verbs\":[] } | [optional] -**aggregating_product_rate_plan_id** | **str** | { \"description\" : \"If present, this will be the product rate plan to use when creating an aggregating subscription. An account level aggregating subscription will be created when the first subscription is created against the account.\", \"verbs\":[] } | [optional] -**aggregating_subscription_id** | **str** | { \"description\" : \"The consistent ID of the account level aggregating subscription, if one exists.\", \"verbs\":[] } | [optional] -**metadata** | [**DynamicMetadata**](DynamicMetadata.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateAddressRequest.md b/docs/CreateAddressRequest.md deleted file mode 100644 index eb27903..0000000 --- a/docs/CreateAddressRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# CreateAddressRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**profile_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**address_line1** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**address_line2** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**address_line3** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**city** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**province** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**country** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**postcode** | **str** | { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**landline** | **str** | { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**primary_address** | **bool** | { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateAggregatingComponentRequest.md b/docs/CreateAggregatingComponentRequest.md index 03bc39f..c7a91e7 100644 --- a/docs/CreateAggregatingComponentRequest.md +++ b/docs/CreateAggregatingComponentRequest.md @@ -3,10 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**pricing_component** | **str** | {\"description\":\"Name of the pricing component upon which to aggregate. The subscriber to the aggregating rate plan (which contains the AggregatingComponent specified here), will consult its children at the end of each billing period, and collect from those children all charges whose pricing component matches the ID of the component identified here. Those charges' quantities will be counted, and used when calculating the price of consuming this AggregatingComponent. The aggregating subscription then raises a discount charge &mdash; to account for the more favourable price tiering that emerges when aggregating.\",\"verbs\":[\"POST\"]} | -**organization_id** | **str** | {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested pricing component should be created. If omitted: this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional] +**created** | **datetime** | | [optional] +**pricing_component** | **str** | | [optional] +**organization_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateAggregatingSubscriptionRequest.md b/docs/CreateAggregatingSubscriptionRequest.md index e62992b..cdefdaf 100644 --- a/docs/CreateAggregatingSubscriptionRequest.md +++ b/docs/CreateAggregatingSubscriptionRequest.md @@ -3,21 +3,25 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**account_id** | **str** | {\"description\":\"ID of the BillForward Account who will own this aggregating subscription. You should ensure beforehand that the customer has had a BillForward Account created for them.\",\"verbs\":[\"POST\"]} | -**organization_id** | **str** | {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested Subscription should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional] -**name** | **str** | {\"default\":\"(Subscription will be named after the rate plan to which the subscription subscribes)\",\"description\":\"Name of the created subscription. This is primarily for your benefit &mdash; for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'BusinessCorp subscriptions, care of Mr Business (mr@busy.com)').\",\"verbs\":[\"POST\"]} | [optional] -**description** | **str** | {\"default\":\"(null)\",\"description\":\"Description of the created subscription. This is primarily for your benefit &mdash; for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Business signed up using BUSYGUYS coupon, at management trade show').\",\"verbs\":[\"POST\"]} | [optional] -**start** | **datetime** | {\"default\":\"(ServerNow upon receiving request)\",\"description\":\"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.\",\"verbs\":[\"POST\"]} | [optional] -**state** | **str** | {\"default\":\"Provisioned\",\"description\":\"The state in which the created subscription will begin.<br><span class=\\\"label label-default\\\">Provisioned</span> &mdash; The subscription will wait (without raising any invoices or beginning its service) until explicit action is taken to change its state.<br><span class=\\\"label label-default\\\">AwaitingPayment</span> &mdash; The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.\",\"verbs\":[\"POST\"]} | [optional] -**product_rate_plan** | **str** | {\"description\":\"ID of the rate plan to which the subscription will be subscribing. If omitted: it will be assumed you wish to create a new rate plan as part of this request &mdash; this subscription will subscribe to that newly-created rate plan.\",\"verbs\":[\"POST\"]} | [optional] -**duration** | **int** | {\"description\":\"[Required if and only if `productRatePlan` is omitted] Number of length-measures which constitute the rate plan's period.\",\"verbs\":[\"POST\"]} | [optional] -**duration_period** | **str** | {\"description\":\"[Required if and only if `productRatePlan` is omitted] Measure describing the magnitude of the rate plan's period.\",\"verbs\":[\"POST\"]} | [optional] -**product_type** | **str** | {\"description\":\"[Required if and only if `productRatePlan` is omitted] The frequency of the rate plan &mdash; either recurring or non-recurring.\",\"verbs\":[\"POST\"]} | [optional] -**aggregating_components** | [**list[CreateAggregatingComponentRequest]**](CreateAggregatingComponentRequest.md) | {\"default\":\"(empty list)\",\"description\":\"[Required if and only if `productRatePlan` is omitted] List of components whose prices should be recalculated upon invoice aggregation. For example: two subscriptions' individual consumptions may neither of them be large enough to achieve bulk buy discounts. When aggregated, though, the same two subscriptions' consumption may add up to a quantity which does merit a bulk buy discount within your tiering system.\",\"verbs\":[\"POST\"]} | [optional] -**aggregate_all_subscriptions_on_account** | **bool** | {\"default\":false,\"description\":\"Whether this 'aggregating subscription' should collect charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.\",\"verbs\":[\"POST\"]} | [optional] [default to False] -**currency** | **str** | {\"description\":\"[Required if and only if `productRatePlan` is omitted] The currency of the product-rate-plan &mdash; as specified by a three-character ISO 4217 currency code (i.e. USD).\",\"verbs\":[\"POST\"]} | +**created** | **datetime** | | [optional] +**account_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**start** | **datetime** | | [optional] +**end** | **datetime** | | [optional] +**state** | **str** | | [optional] +**product_rate_plan** | **str** | | [optional] +**duration** | **int** | | [optional] +**duration_period** | **str** | | [optional] +**product_type** | **str** | | [optional] +**aggregating_components** | [**list[CreateAggregatingComponentRequest]**](CreateAggregatingComponentRequest.md) | | [optional] +**aggregate_all_subscriptions_on_account** | **bool** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**failed_payment_behaviour** | **str** | | [optional] +**payment_terms** | **int** | | [optional] +**purchase_order** | **str** | | [optional] +**align_period_with_aggregating_subscription** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateCommissionInvoiceRequest.md b/docs/CreateCommissionInvoiceRequest.md new file mode 100644 index 0000000..de2e4bc --- /dev/null +++ b/docs/CreateCommissionInvoiceRequest.md @@ -0,0 +1,10 @@ +# CreateCommissionInvoiceRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**currencies** | **list[str]** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateContractPeriodRequest.md b/docs/CreateContractPeriodRequest.md new file mode 100644 index 0000000..bcdedf4 --- /dev/null +++ b/docs/CreateContractPeriodRequest.md @@ -0,0 +1,13 @@ +# CreateContractPeriodRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**contract_period** | **int** | | [optional] +**subscription_periods** | **int** | | [optional] +**quote_id** | **str** | | [optional] +**purchase_order** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateContractRequest.md b/docs/CreateContractRequest.md new file mode 100644 index 0000000..ba01788 --- /dev/null +++ b/docs/CreateContractRequest.md @@ -0,0 +1,18 @@ +# CreateContractRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**start** | **datetime** | | [optional] +**contract_end_behaviour** | **str** | | +**valid_from** | **datetime** | | +**valid_till** | **datetime** | | [optional] +**contract_periods** | [**list[CreateContractPeriodRequest]**](CreateContractPeriodRequest.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateCouponDiscountRequest.md b/docs/CreateCouponDiscountRequest.md new file mode 100644 index 0000000..090b22b --- /dev/null +++ b/docs/CreateCouponDiscountRequest.md @@ -0,0 +1,15 @@ +# CreateCouponDiscountRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**pricing_component** | **str** | | [optional] +**unit_of_measure** | **str** | | [optional] +**units_free** | **int** | | [optional] +**percentage_discount** | **float** | | [optional] +**cash_discount** | **float** | | [optional] +**tax_code** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateCouponRequest.md b/docs/CreateCouponRequest.md new file mode 100644 index 0000000..a696abf --- /dev/null +++ b/docs/CreateCouponRequest.md @@ -0,0 +1,18 @@ +# CreateCouponRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**coupon_code** | **str** | | [optional] +**product** | **str** | | [optional] +**product_rate_plan** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**coupons** | **int** | | [optional] +**uses** | **int** | | [optional] +**parent_coupon_code_redeemable** | **bool** | | [optional] +**discounts** | [**list[CreateCouponDiscountRequest]**](CreateCouponDiscountRequest.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateOfflinePaymentRequest.md b/docs/CreateOfflinePaymentRequest.md new file mode 100644 index 0000000..3e35005 --- /dev/null +++ b/docs/CreateOfflinePaymentRequest.md @@ -0,0 +1,20 @@ +# CreateOfflinePaymentRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**amount** | **float** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**payment_reference** | **str** | | [optional] +**type** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**payment_received** | **datetime** | | [optional] +**invoice_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreatePermissionOnRoleRequest.md b/docs/CreatePermissionOnRoleRequest.md new file mode 100644 index 0000000..8020131 --- /dev/null +++ b/docs/CreatePermissionOnRoleRequest.md @@ -0,0 +1,12 @@ +# CreatePermissionOnRoleRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**resource** | **str** | | +**action** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreatePermissionRequest.md b/docs/CreatePermissionRequest.md new file mode 100644 index 0000000..03c921b --- /dev/null +++ b/docs/CreatePermissionRequest.md @@ -0,0 +1,14 @@ +# CreatePermissionRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**resource** | **str** | | +**action** | **str** | | +**role** | **str** | | [optional] +**role_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreatePricingComponentQuantityRequest.md b/docs/CreatePricingComponentQuantityRequest.md new file mode 100644 index 0000000..d23b2ae --- /dev/null +++ b/docs/CreatePricingComponentQuantityRequest.md @@ -0,0 +1,15 @@ +# CreatePricingComponentQuantityRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**pricing_component** | **str** | | [optional] +**pricing_component_id** | **str** | | [optional] +**pricing_component_name** | **str** | | [optional] +**quantity** | **int** | | [optional] +**percentage_discount** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateProfileAddressRequest.md b/docs/CreateProfileAddressRequest.md deleted file mode 100644 index 71b4e53..0000000 --- a/docs/CreateProfileAddressRequest.md +++ /dev/null @@ -1,18 +0,0 @@ -# CreateProfileAddressRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**address_line1** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**address_line2** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**address_line3** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**city** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**province** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**country** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**postcode** | **str** | { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**landline** | **str** | { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**primary_address** | **bool** | { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateProfileRequest.md b/docs/CreateProfileRequest.md new file mode 100644 index 0000000..6252b64 --- /dev/null +++ b/docs/CreateProfileRequest.md @@ -0,0 +1,8 @@ +# CreateProfileRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateRoleRequest.md b/docs/CreateRoleRequest.md new file mode 100644 index 0000000..b9ee470 --- /dev/null +++ b/docs/CreateRoleRequest.md @@ -0,0 +1,14 @@ +# CreateRoleRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**default_role** | **bool** | | [optional] +**permissions** | [**list[CreatePermissionOnRoleRequest]**](CreatePermissionOnRoleRequest.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateSalesforceConfigurationRequest.md b/docs/CreateSalesforceConfigurationRequest.md new file mode 100644 index 0000000..3d3f203 --- /dev/null +++ b/docs/CreateSalesforceConfigurationRequest.md @@ -0,0 +1,14 @@ +# CreateSalesforceConfigurationRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**user_role** | **str** | | [optional] +**notification_email_addresses** | **str** | | [optional] +**respond_with_redirect** | **bool** | | [optional] +**base_uri** | **str** | | [optional] +**use_test_environment** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateSubscriptionBatchRequest.md b/docs/CreateSubscriptionBatchRequest.md index 22834ae..40be0a8 100644 --- a/docs/CreateSubscriptionBatchRequest.md +++ b/docs/CreateSubscriptionBatchRequest.md @@ -3,10 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**organization_id** | **str** | {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested Subscriptions should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional] -**subscriptions** | [**list[CreateSubscriptionRequest]**](CreateSubscriptionRequest.md) | {\"default\":\"(Empty list)\",\"description\":\"List of entities for requesting that subscriptions be created.\",\"verbs\":[\"POST\"]} | [optional] +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**subscriptions** | [**list[CreateSubscriptionRequest]**](CreateSubscriptionRequest.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateSubscriptionChargeAmendment.md b/docs/CreateSubscriptionChargeAmendment.md index 6d41ffb..5ebdd0c 100644 --- a/docs/CreateSubscriptionChargeAmendment.md +++ b/docs/CreateSubscriptionChargeAmendment.md @@ -3,29 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] -**subscription_charge_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**description** | **str** | { \"description\" : \".\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**amount** | **float** | { \"description\" : \"Monetary value to charge in the same currency as the subscription.\", \"verbs\":[\"POST\",\"GET\"] } | -**discount** | **float** | { \"description\" : \"\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"Manual\", \"verbs\":[] } | -**invoicing_type** | **str** | { \"description\" : \"<span class=\\\"label label-default\\\">Immediate</span> invoicing will result in an invoice being issued immediately for the charge. <span class=\\\"label label-default\\\">Aggregated</span> invoicing will generate a charge to be added to the next issued invoice, for example at the current billing period end.\", \"default\" : \"Aggregated\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**tax_status** | **str** | { \"description\" : \"Whether the amount specified is <span class=\\\"label label-default\\\">inclusive</span> or <span class=\\\"label label-default\\\">exclusive</span> of tax\", \"default\" : \"inclusive\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**subscription_charge** | [**SubscriptionCharge**](SubscriptionCharge.md) | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**pricing_component_value_change** | [**InsertableBillingEntity**](InsertableBillingEntity.md) | { \"description\" : \"\", \"verbs\":[] } | [optional] -**pricing_component_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | [optional] +**subscription_charge_id** | **str** | | [optional] +**amount** | **float** | | +**discount** | **float** | | [optional] +**type** | **str** | | +**invoicing_type** | **str** | | +**tax_status** | **str** | | +**subscription_charge** | [**SubscriptionCharge**](SubscriptionCharge.md) | | [optional] +**pricing_component_value_change** | [**PricingComponentValueChange**](PricingComponentValueChange.md) | | [optional] +**pricing_component_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateSubscriptionCheckoutDefinitionRequest.md b/docs/CreateSubscriptionCheckoutDefinitionRequest.md new file mode 100644 index 0000000..215e744 --- /dev/null +++ b/docs/CreateSubscriptionCheckoutDefinitionRequest.md @@ -0,0 +1,10 @@ +# CreateSubscriptionCheckoutDefinitionRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**plan** | **str** | | [optional] +**path** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateSubscriptionRequest.md b/docs/CreateSubscriptionRequest.md index d626960..ced49aa 100644 --- a/docs/CreateSubscriptionRequest.md +++ b/docs/CreateSubscriptionRequest.md @@ -3,26 +3,39 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**account_id** | **str** | {\"description\":\"ID of the BillForward Account who will own this subscription. You should ensure beforehand that the customer has had a BillForward Account created for them.\",\"verbs\":[\"POST\"]} | -**product** | **str** | {\"description\":\"Name or ID of the product.\",\"verbs\":[\"POST\"]} | -**product_rate_plan** | **str** | {\"description\":\"ID or name of the rate plan to which the subscription will be subscribing. Lookup by name is only possible if a `productID` is specified.\",\"verbs\":[\"POST\"]} | -**organization_id** | **str** | {\"default\":\"(Auto-populated using your authentication credentials)\",\"description\":\"ID of the BillForward Organization within which the requested Subscription should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional] -**name** | **str** | {\"default\":\"(Subscription will be named after the rate plan to which the subscription subscribes)\",\"description\":\"Name of the created subscription. This is primarily for your benefit &mdash; for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'Customer 1425, guy@mail.com, Premium membership').\",\"verbs\":[\"POST\"]} | [optional] -**description** | **str** | {\"default\":\"(null)\",\"description\":\"Description of the created subscription. This is primarily for your benefit &mdash; for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Customer obtained through Lazy Wednesdays promotion').\",\"verbs\":[\"POST\"]} | [optional] -**start** | **datetime** | {\"default\":\"(ServerNow upon receiving request)\",\"description\":\"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.\",\"verbs\":[\"POST\"]} | [optional] -**end** | **datetime** | {\"default\":\"(1 period ahead of the `start` time)\",\"description\":\"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should finish its first service period.\",\"verbs\":[\"POST\"]} | [optional] -**state** | **str** | {\"default\":\"Provisioned\",\"description\":\"The state in which the created subscription will begin.<br><span class=\\\"label label-default\\\">Provisioned</span> &mdash; The subscription will wait (without raising any invoices or beginning its service) until explicit action is taken to change its state.<br><span class=\\\"label label-default\\\">AwaitingPayment</span> &mdash; The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.\",\"verbs\":[\"POST\"]} | [optional] -**trial_end** | **datetime** | {\"default\":\"(null)\",\"description\":\"ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should leave the trial period.\",\"verbs\":[\"POST\"]} | [optional] +**created** | **datetime** | | [optional] +**account_id** | **str** | | [optional] +**product** | **str** | | [optional] +**product_rate_plan** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**contract_start** | **datetime** | | [optional] +**start** | **datetime** | | [optional] +**end** | **datetime** | | [optional] +**state** | **str** | | [optional] +**trial_end** | **datetime** | | [optional] **type** | **str** | | [optional] -**parent_id** | **str** | {\"default\":\"(If a subscription exists which 'aggregates all subscriptions belonging to this BillForward Account', refer to the ID of that subscription. Otherwise: null)\",\"description\":\"ID of a parent subscription which will collect the charges raised by this subscription. The parent becomes responsible for paying those charges. If a subscription exists which 'aggregates all subscriptions belonging to this BillForward Account', then that parent will override any parent specified here.\",\"verbs\":[\"POST\"]} | [optional] -**aggregate_all_subscriptions_on_account** | **bool** | {\"default\":false,\"description\":\"Whether this subscription should become an 'aggregating subscription', collecting charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.\",\"verbs\":[\"POST\"]} | [optional] [default to False] -**align_period_with_aggregating_subscription** | **bool** | {\"default\":true,\"description\":\"Whether to override the `end` date to line up with the current period end of the 'aggregating subscription' to which this subscription belongs.\",\"verbs\":[\"POST\"]} | [optional] [default to False] -**pricing_component_quantities** | [**list[PricingComponentQuantityRequest]**](PricingComponentQuantityRequest.md) | {\"default\":\"(empty list)\",\"description\":\"Quantities that this subscription possesses (upon beginning service), of pricing components upon the subscription's rate plan. For example: you can set the subscription to begin its service with '5 widgets' consumed. Otherwise the 'default quantity' will be observed instead, for each pricing component upon the rate plan.\",\"verbs\":[\"POST\"]} | [optional] -**metadata** | [**DynamicMetadata**](DynamicMetadata.md) | { \"description\" : \"Add metadata.\", \"verbs\":[\"POST\"] } | [optional] +**failed_payment_behaviour** | **str** | | [optional] +**parent_id** | **str** | | [optional] +**exclude_from_auto_aggregation** | **bool** | | [optional] +**aggregate_all_subscriptions_on_account** | **bool** | | [optional] +**allow_subscription_wihtout_rate_plan** | **bool** | | [optional] +**dont_create_default_fixed_term** | **bool** | | [optional] +**align_period_with_aggregating_subscription** | **bool** | | [optional] +**parent_should_copy_child_period_end** | **bool** | | [optional] +**pricing_component_quantities** | [**list[CreatePricingComponentQuantityRequest]**](CreatePricingComponentQuantityRequest.md) | | [optional] **payment_terms** | **int** | | [optional] -**contract_start** | **datetime** | {\"description\":\"start of the contracted period. This will be after a trial, if one exists\",\"verbs\":[\"GET\"]} | [optional] -**failed_payment_behaviour** | **str** | {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.<br><span class=\\\"label label-default\\\">CancelSubscription</span> &mdash; Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.<br><span class=\\\"label label-default\\\">None</span> &mdash; The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles &mdash; or when manual invoice remediation is common &mdash; <span class=\\\"label label-default\\\">None</span> is recommended.<br>In a heavily-automated SaaS environment, automatic cancellation via <span class=\\\"label label-default\\\">CancelSubscription</span> is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] +**purchase_order** | **str** | | [optional] +**coupon_codes** | **list[str]** | | [optional] +**prepayment_amount** | **float** | | [optional] +**extras** | [**Extras**](Extras.md) | | [optional] +**termed_subscription** | **bool** | | [optional] +**term_periods** | **int** | | [optional] +**term_expiry_behaviour** | **str** | | [optional] +**subsequent_product_rate_plan** | **str** | | [optional] +**metadata** | **dict(str, object)** | | [optional] +**ignore_first_period_usage** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateSubscriptionTimerRequest.md b/docs/CreateSubscriptionTimerRequest.md new file mode 100644 index 0000000..e609473 --- /dev/null +++ b/docs/CreateSubscriptionTimerRequest.md @@ -0,0 +1,14 @@ +# CreateSubscriptionTimerRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**period** | **str** | | [optional] +**duration** | **int** | | [optional] +**direction** | **str** | | [optional] +**event** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreateTOTPRequest.md b/docs/CreateTOTPRequest.md new file mode 100644 index 0000000..4703e9a --- /dev/null +++ b/docs/CreateTOTPRequest.md @@ -0,0 +1,12 @@ +# CreateTOTPRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **str** | | [optional] +**include_billforward_logo** | **bool** | | [optional] +**code** | **str** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreditAccountRequest.md b/docs/CreditAccountRequest.md index 4f4047e..221b85c 100644 --- a/docs/CreditAccountRequest.md +++ b/docs/CreditAccountRequest.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | [optional] -**value** | **float** | { \"description\" : \" Monetary value of the credit\", \"verbs\":[\"POST\",\"GET\"] } | -**currency** | **str** | { \"description\" : \"Currency of the credit\", \"verbs\":[\"POST\",\"GET\"] } | -**invoice_id** | **str** | { \"description\" : \"Reference an invoice\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**description** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | [optional] +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**value** | **float** | | [optional] +**expires** | **datetime** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**invoice_id** | **str** | | [optional] +**description** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreditNote.md b/docs/CreditNote.md index 5f4fb2b..27f7eab 100644 --- a/docs/CreditNote.md +++ b/docs/CreditNote.md @@ -3,21 +3,24 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**account_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**invoice_id** | **str** | { \"description\" : \"References an invoice from this credit note. This has no side-effects, such as limited scope of credit note.\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"Subscription to apply the credit note to. By default credit notes are owned by the account an can be used on any subscription. Providing this value limits the credit-note to only being used on the specified subscription.\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"verbs\":[] } | -**currency** | **str** | { \"description\" : \"Currency of the credit-note specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"GET\"] } | -**description** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**value** | **float** | { \"description\" : \" Monetary value of the credit-note\", \"verbs\":[\"POST\",\"GET\"] } | -**remaining_value** | **float** | { \"description\" : \"Remaining value of the payment not used. In the case when a credit-note is used across a range of invoices, each use reducing the available blance of the credit note.\", \"verbs\":[\"GET\"] } | -**created_by** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**invoice_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**linked_credit_note_id** | **str** | | [optional] +**type** | **str** | | +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | +**description** | **str** | | [optional] +**value** | **float** | | [optional] +**nominal_value** | **float** | | [optional] +**actual_value** | **float** | | [optional] +**remaining_value** | **float** | | +**expires** | **datetime** | | [optional] +**created_by** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreditNoteCurrency.md b/docs/CreditNoteCurrency.md new file mode 100644 index 0000000..8c68a89 --- /dev/null +++ b/docs/CreditNoteCurrency.md @@ -0,0 +1,14 @@ +# CreditNoteCurrency + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency_code** | **str** | | [optional] +**default_fraction_digits** | **int** | | [optional] +**numeric_code** | **int** | | [optional] +**display_name** | **str** | | [optional] +**symbol** | **str** | | [optional] +**numeric_code_as_string** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreditNotePagedMetadata.md b/docs/CreditNotePagedMetadata.md deleted file mode 100644 index 9466cfc..0000000 --- a/docs/CreditNotePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# CreditNotePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[CreditNote]**](CreditNote.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreditNotePayment.md b/docs/CreditNotePayment.md new file mode 100644 index 0000000..5131c16 --- /dev/null +++ b/docs/CreditNotePayment.md @@ -0,0 +1,8 @@ +# CreditNotePayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CreditSubscriptionRequest.md b/docs/CreditSubscriptionRequest.md index a5619ea..eb11bfc 100644 --- a/docs/CreditSubscriptionRequest.md +++ b/docs/CreditSubscriptionRequest.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | [optional] -**value** | **float** | { \"description\" : \" Monetary value of the credit-note\", \"verbs\":[\"POST\",\"GET\"] } | -**invoice_id** | **str** | { \"description\" : \"Reference an invoice\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**description** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | [optional] +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**value** | **float** | | [optional] +**expires** | **datetime** | | [optional] +**invoice_id** | **str** | | [optional] +**description** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreditnotesApi.md b/docs/CreditnotesApi.md deleted file mode 100644 index 8f5ebdc..0000000 --- a/docs/CreditnotesApi.md +++ /dev/null @@ -1,330 +0,0 @@ -# billforward.CreditnotesApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_credit_note**](CreditnotesApi.md#create_credit_note) | **POST** /credit-notes | Create a credit note. -[**get_credit_note_by_id**](CreditnotesApi.md#get_credit_note_by_id) | **GET** /credit-notes/{credit-note-ID} | Returns a single credit-note, specified by the ID parameter. -[**get_credit_note_for_account**](CreditnotesApi.md#get_credit_note_for_account) | **GET** /credit-notes/account/{account-ID} | Returns credit notes for an account. -[**get_credit_note_for_invoice**](CreditnotesApi.md#get_credit_note_for_invoice) | **GET** /credit-notes/invoice/{invoice-ID} | Returns credit notes for an invoice. -[**get_credit_note_for_subscription**](CreditnotesApi.md#get_credit_note_for_subscription) | **GET** /credit-notes/subscription/{subscription-ID} | Returns credit notes for an subscription. -[**retire_credit_note**](CreditnotesApi.md#retire_credit_note) | **DELETE** /credit-notes/{credit-note-ID} | Removes any remaining value from credit note - - -# **create_credit_note** -> CreditNotePagedMetadata create_credit_note(credit_note) - -Create a credit note. - -{\"nickname\":\"Create a new credit note\",\"request\":\"createCreditNoteRequest.html\",\"response\":\"createCreditNoteResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CreditnotesApi() -credit_note = billforward.CreditNote() # CreditNote | The credit note object to be created. - -try: - # Create a credit note. - api_response = api_instance.create_credit_note(credit_note) - pprint(api_response) -except ApiException as e: - print "Exception when calling CreditnotesApi->create_credit_note: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **credit_note** | [**CreditNote**](CreditNote.md)| The credit note object to be created. | - -### Return type - -[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_credit_note_by_id** -> CreditNotePagedMetadata get_credit_note_by_id(credit_note_id, organizations=organizations) - -Returns a single credit-note, specified by the ID parameter. - -{\"nickname\":\"Retrieve an existing credit note\",\"response\":\"getCreditNoteByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CreditnotesApi() -credit_note_id = 'credit_note_id_example' # str | ID of the credit-note. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single credit-note, specified by the ID parameter. - api_response = api_instance.get_credit_note_by_id(credit_note_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CreditnotesApi->get_credit_note_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **credit_note_id** | **str**| ID of the credit-note. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_credit_note_for_account** -> CreditNotePagedMetadata get_credit_note_for_account(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns credit notes for an account. - -{\"nickname\":\"Retrieve by account\",\"response\":\"getCreditNotesByAccount.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CreditnotesApi() -account_id = 'account_id_example' # str | ID of the account. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first payment to return. (optional) (default to 0) -records = 10 # int | The maximum number of payments to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns credit notes for an account. - api_response = api_instance.get_credit_note_for_account(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling CreditnotesApi->get_credit_note_for_account: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **str**| ID of the account. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first payment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of payments to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_credit_note_for_invoice** -> CreditNotePagedMetadata get_credit_note_for_invoice(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns credit notes for an invoice. - -{\"nickname\":\"Retrieve by invoice\",\"response\":\"getCreditNotesByInvoice.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CreditnotesApi() -invoice_id = 'invoice_id_example' # str | ID of the Invoice. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first payment to return. (optional) (default to 0) -records = 10 # int | The maximum number of payments to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns credit notes for an invoice. - api_response = api_instance.get_credit_note_for_invoice(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling CreditnotesApi->get_credit_note_for_invoice: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **invoice_id** | **str**| ID of the Invoice. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first payment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of payments to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_credit_note_for_subscription** -> CreditNotePagedMetadata get_credit_note_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns credit notes for an subscription. - -{\"nickname\":\"Retrieve by subscription\",\"response\":\"getCreditNotesSubscription.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CreditnotesApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first payment to return. (optional) (default to 0) -records = 10 # int | The maximum number of payments to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns credit notes for an subscription. - api_response = api_instance.get_credit_note_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling CreditnotesApi->get_credit_note_for_subscription: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first payment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of payments to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **retire_credit_note** -> CreditNotePagedMetadata retire_credit_note(credit_note_id, organizations) - -Removes any remaining value from credit note - -{\"nickname\":\"Removes remaining value from credit note\",\"response\":\"deleteCreditNote.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CreditnotesApi() -credit_note_id = 'credit_note_id_example' # str | ID of the credit-note. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. - -try: - # Removes any remaining value from credit note - api_response = api_instance.retire_credit_note(credit_note_id, organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CreditnotesApi->retire_credit_note: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **credit_note_id** | **str**| ID of the credit-note. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | - -### Return type - -[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/CybersourceConfiguration.md b/docs/CybersourceConfiguration.md new file mode 100644 index 0000000..5044d46 --- /dev/null +++ b/docs/CybersourceConfiguration.md @@ -0,0 +1,9 @@ +# CybersourceConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key_filename** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CybersourcePayment.md b/docs/CybersourcePayment.md new file mode 100644 index 0000000..2f73f3e --- /dev/null +++ b/docs/CybersourcePayment.md @@ -0,0 +1,8 @@ +# CybersourcePayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CybersourceTokenPagedMetadata.md b/docs/CybersourceTokenPagedMetadata.md deleted file mode 100644 index 0e3cec1..0000000 --- a/docs/CybersourceTokenPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# CybersourceTokenPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CybersourcetokensApi.md b/docs/CybersourcetokensApi.md deleted file mode 100644 index 8538de0..0000000 --- a/docs/CybersourcetokensApi.md +++ /dev/null @@ -1,254 +0,0 @@ -# billforward.CybersourcetokensApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_cybersource_token**](CybersourcetokensApi.md#create_cybersource_token) | **POST** /cybersource-tokens | Create a cybersource-token. -[**get_cybersource_token_by_id**](CybersourcetokensApi.md#get_cybersource_token_by_id) | **GET** /cybersource-tokens/{token-ID} | Returns a single cybersource-token, specified by the token-ID parameter. -[**get_cybersource_token_by_recurring_subscription_id**](CybersourcetokensApi.md#get_cybersource_token_by_recurring_subscription_id) | **GET** /cybersource-tokens/recurring-subscription-info/{recurring-subscription-ID} | Returns a single cybersource-token, specified by the recurring-subscription-ID parameter. -[**retire_cybersource_token**](CybersourcetokensApi.md#retire_cybersource_token) | **DELETE** /cybersource-tokens/{token-ID} | Retires the cybersource token specified by the token-ID parameter. -[**update_cybersource_token**](CybersourcetokensApi.md#update_cybersource_token) | **PUT** /cybersource-tokens | Update a cybersource-token. - - -# **create_cybersource_token** -> CybersourceTokenPagedMetadata create_cybersource_token(cybersource_token) - -Create a cybersource-token. - -{\"nickname\":\"Create a cybersource-token\",\"request\":\"createCybersourceTokenRequest.html\",\"response\":\"createCybersourceTokenResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CybersourcetokensApi() -cybersource_token = billforward.MutableBillingEntity() # MutableBillingEntity | The cybersource-token object to be created. - -try: - # Create a cybersource-token. - api_response = api_instance.create_cybersource_token(cybersource_token) - pprint(api_response) -except ApiException as e: - print "Exception when calling CybersourcetokensApi->create_cybersource_token: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **cybersource_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The cybersource-token object to be created. | - -### Return type - -[**CybersourceTokenPagedMetadata**](CybersourceTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_cybersource_token_by_id** -> CybersourceTokenPagedMetadata get_cybersource_token_by_id(token_id, organizations=organizations) - -Returns a single cybersource-token, specified by the token-ID parameter. - -{\"nickname\":\"NICKNAME\",\"response\":\"getCybersourceTokenByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CybersourcetokensApi() -token_id = 'token_id_example' # str | The unique sting ID of the cybersource token. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single cybersource-token, specified by the token-ID parameter. - api_response = api_instance.get_cybersource_token_by_id(token_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CybersourcetokensApi->get_cybersource_token_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **token_id** | **str**| The unique sting ID of the cybersource token. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CybersourceTokenPagedMetadata**](CybersourceTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_cybersource_token_by_recurring_subscription_id** -> CybersourceTokenPagedMetadata get_cybersource_token_by_recurring_subscription_id(recurring_subscription_id, organizations=organizations) - -Returns a single cybersource-token, specified by the recurring-subscription-ID parameter. - -{\"nickname\":\"NICKNAME\",\"response\":\"getCybersourceTokenByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CybersourcetokensApi() -recurring_subscription_id = 'recurring_subscription_id_example' # str | The recurring-subscription-info-subscription-ID of the cybersource token. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single cybersource-token, specified by the recurring-subscription-ID parameter. - api_response = api_instance.get_cybersource_token_by_recurring_subscription_id(recurring_subscription_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CybersourcetokensApi->get_cybersource_token_by_recurring_subscription_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **recurring_subscription_id** | **str**| The recurring-subscription-info-subscription-ID of the cybersource token. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**CybersourceTokenPagedMetadata**](CybersourceTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **retire_cybersource_token** -> CybersourceTokenPagedMetadata retire_cybersource_token(token_id, organizations) - -Retires the cybersource token specified by the token-ID parameter. - -{\"nickname\":\"NICKNAME\",\"response\":\"deleteCybersourceToken.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CybersourcetokensApi() -token_id = 'token_id_example' # str | ID of the cybersource-token. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. - -try: - # Retires the cybersource token specified by the token-ID parameter. - api_response = api_instance.retire_cybersource_token(token_id, organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling CybersourcetokensApi->retire_cybersource_token: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **token_id** | **str**| ID of the cybersource-token. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | - -### Return type - -[**CybersourceTokenPagedMetadata**](CybersourceTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_cybersource_token** -> CybersourceTokenPagedMetadata update_cybersource_token(cybersource_token) - -Update a cybersource-token. - -{\"nickname\":\"Update a cybersource-token\",\"request\":\"updateCybersourceTokenRequest.html\",\"response\":\"updateCybersourceTokenResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.CybersourcetokensApi() -cybersource_token = billforward.MutableBillingEntity() # MutableBillingEntity | The cybersource-token object to be updated. - -try: - # Update a cybersource-token. - api_response = api_instance.update_cybersource_token(cybersource_token) - pprint(api_response) -except ApiException as e: - print "Exception when calling CybersourcetokensApi->update_cybersource_token: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **cybersource_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The cybersource-token object to be updated. | - -### Return type - -[**CybersourceTokenPagedMetadata**](CybersourceTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/DataSyncJobErrorResponse.md b/docs/DataSyncJobErrorResponse.md new file mode 100644 index 0000000..0616660 --- /dev/null +++ b/docs/DataSyncJobErrorResponse.md @@ -0,0 +1,15 @@ +# DataSyncJobErrorResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**record_type** | **str** | | [optional] +**record_id** | **str** | | [optional] +**description** | **str** | | [optional] +**raw_internal_error** | **str** | | [optional] +**encountered** | **datetime** | | [optional] +**run_number** | **int** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/DataSyncJobResponse.md b/docs/DataSyncJobResponse.md new file mode 100644 index 0000000..603fabe --- /dev/null +++ b/docs/DataSyncJobResponse.md @@ -0,0 +1,28 @@ +# DataSyncJobResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**id** | **str** | | [optional] +**config_id** | **str** | | [optional] +**state** | **str** | | [optional] +**type** | **str** | | [optional] +**scope** | **str** | | [optional] +**target** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**data_from** | **datetime** | | [optional] +**data_till** | **datetime** | | [optional] +**started** | **datetime** | | [optional] +**stopped** | **datetime** | | [optional] +**created_by** | **str** | | [optional] +**max_retry_times** | **int** | | [optional] +**retry_attempted** | **int** | | [optional] +**deleted** | **bool** | | [optional] +**latest_run_number** | **int** | | [optional] +**errors** | [**list[DataSyncJobErrorResponse]**](DataSyncJobErrorResponse.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/DataSynchronisationAppConfigurationPagedMetadata.md b/docs/DataSynchronisationAppConfigurationPagedMetadata.md deleted file mode 100644 index 08cc8d9..0000000 --- a/docs/DataSynchronisationAppConfigurationPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# DataSynchronisationAppConfigurationPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DataSynchronisationConfiguration.md b/docs/DataSynchronisationConfiguration.md deleted file mode 100644 index 65c7cfb..0000000 --- a/docs/DataSynchronisationConfiguration.md +++ /dev/null @@ -1,22 +0,0 @@ -# DataSynchronisationConfiguration - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | ID of the Synchronization Configuration. | [optional] -**organization_id** | **str** | Organization associated with Synchronization Configuration. | -**username** | **str** | This is the username for the platform. | -**access_token** | **str** | This is the token for the platform. | -**refresh_token** | **str** | This is the refresh token for the platform. | -**instance_url** | **str** | This is the instance url for client's salesforce instance. | -**platform** | **str** | This is the platform of the job. | -**max_failed_retry** | **int** | This is maximum of the retry attempts when a synch is failed. | [optional] -**synch_interval** | **int** | This is interval between each sync. | [optional] -**deleted** | **bool** | Is the sync job deleted. | [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DataSynchronisationConfigurationPagedMetadata.md b/docs/DataSynchronisationConfigurationPagedMetadata.md deleted file mode 100644 index 1f741ab..0000000 --- a/docs/DataSynchronisationConfigurationPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# DataSynchronisationConfigurationPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[DataSynchronisationConfiguration]**](DataSynchronisationConfiguration.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DataSynchronizationJobPagedMetadata.md b/docs/DataSynchronizationJobPagedMetadata.md deleted file mode 100644 index d3b6364..0000000 --- a/docs/DataSynchronizationJobPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# DataSynchronizationJobPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DebtsResultPagedMetadata.md b/docs/DebtsResultPagedMetadata.md deleted file mode 100644 index 73b108e..0000000 --- a/docs/DebtsResultPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# DebtsResultPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DefaultApi.md b/docs/DefaultApi.md new file mode 100644 index 0000000..4c32cad --- /dev/null +++ b/docs/DefaultApi.md @@ -0,0 +1,149 @@ +# billforward.DefaultApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_totp_secret**](DefaultApi.md#create_totp_secret) | **POST** /2fa/totp | +[**enable2fa**](DefaultApi.md#enable2fa) | **POST** /2fa/enable | +[**get_qr_code**](DefaultApi.md#get_qr_code) | **GET** /barcode/qr/acc/{accountId} | + +# **create_totp_secret** +> create_totp_secret(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.DefaultApi(billforward.ApiClient(configuration)) +body = billforward.CreateTOTPRequest() # CreateTOTPRequest | (optional) + +try: + api_instance.create_totp_secret(body=body) +except ApiException as e: + print("Exception when calling DefaultApi->create_totp_secret: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateTOTPRequest**](CreateTOTPRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **enable2fa** +> enable2fa(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.DefaultApi(billforward.ApiClient(configuration)) +body = billforward.CreateTOTPRequest() # CreateTOTPRequest | (optional) + +try: + api_instance.enable2fa(body=body) +except ApiException as e: + print("Exception when calling DefaultApi->enable2fa: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateTOTPRequest**](CreateTOTPRequest.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_qr_code** +> get_qr_code(account_id, organizations=organizations, include_billforward_logo=include_billforward_logo) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.DefaultApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +include_billforward_logo = true # bool | (optional) + +try: + api_instance.get_qr_code(account_id, organizations=organizations, include_billforward_logo=include_billforward_logo) +except ApiException as e: + print("Exception when calling DefaultApi->get_qr_code: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **include_billforward_logo** | **bool**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/DunningApi.md b/docs/DunningApi.md new file mode 100644 index 0000000..67103bb --- /dev/null +++ b/docs/DunningApi.md @@ -0,0 +1,315 @@ +# billforward.DunningApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_dunning_line**](DunningApi.md#create_dunning_line) | **POST** /dunning-lines | +[**get_all_dunning_lines**](DunningApi.md#get_all_dunning_lines) | **GET** /dunning-lines | +[**get_dunning_line_by_attempt_index**](DunningApi.md#get_dunning_line_by_attempt_index) | **GET** /dunning-lines/attempt-index/{index} | +[**get_dunning_line_by_id**](DunningApi.md#get_dunning_line_by_id) | **GET** /dunning-lines/{dunning-line-ID} | +[**retire_dunning_line**](DunningApi.md#retire_dunning_line) | **DELETE** /dunning-lines/{dunning-line-ID} | +[**update_dunning_line**](DunningApi.md#update_dunning_line) | **PUT** /dunning-lines | + +# **create_dunning_line** +> InlineResponseDefault1 create_dunning_line(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.DunningApi(billforward.ApiClient(configuration)) +body = billforward.DunningLine() # DunningLine | (optional) + +try: + api_response = api_instance.create_dunning_line(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling DunningApi->create_dunning_line: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**DunningLine**](DunningLine.md)| | [optional] + +### Return type + +[**InlineResponseDefault1**](InlineResponseDefault1.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_dunning_lines** +> InlineResponseDefault get_all_dunning_lines(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.DunningApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) + +try: + api_response = api_instance.get_all_dunning_lines(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + pprint(api_response) +except ApiException as e: + print("Exception when calling DunningApi->get_all_dunning_lines: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to true] + +### Return type + +[**InlineResponseDefault**](InlineResponseDefault.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dunning_line_by_attempt_index** +> InlineResponseDefault get_dunning_line_by_attempt_index(index, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.DunningApi(billforward.ApiClient(configuration)) +index = 56 # int | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) + +try: + api_response = api_instance.get_dunning_line_by_attempt_index(index, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + pprint(api_response) +except ApiException as e: + print("Exception when calling DunningApi->get_dunning_line_by_attempt_index: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **index** | **int**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to true] + +### Return type + +[**InlineResponseDefault**](InlineResponseDefault.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_dunning_line_by_id** +> InlineResponseDefault1 get_dunning_line_by_id(dunning_line_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.DunningApi(billforward.ApiClient(configuration)) +dunning_line_id = 'dunning_line_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_dunning_line_by_id(dunning_line_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling DunningApi->get_dunning_line_by_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **dunning_line_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault1**](InlineResponseDefault1.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **retire_dunning_line** +> InlineResponseDefault1 retire_dunning_line(dunning_line_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.DunningApi(billforward.ApiClient(configuration)) +dunning_line_id = 'dunning_line_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.retire_dunning_line(dunning_line_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling DunningApi->retire_dunning_line: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **dunning_line_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault1**](InlineResponseDefault1.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_dunning_line** +> InlineResponseDefault1 update_dunning_line(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.DunningApi(billforward.ApiClient(configuration)) +body = billforward.DunningLine() # DunningLine | (optional) + +try: + api_response = api_instance.update_dunning_line(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling DunningApi->update_dunning_line: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**DunningLine**](DunningLine.md)| | [optional] + +### Return type + +[**InlineResponseDefault1**](InlineResponseDefault1.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/DunningLine.md b/docs/DunningLine.md index 109f5fc..9ab68c2 100644 --- a/docs/DunningLine.md +++ b/docs/DunningLine.md @@ -3,18 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the dunning-line.\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the dunning-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**type** | **str** | { \"description\" : \"ID of the organization associated with the dunning-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**attempt_ix** | **int** | { \"description\" : \"The payment attempt this dunning line applies to, specified as a positive integer. Dunning lines are ZERO indexed.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**minutes_delay** | **int** | { \"description\" : \"The time before the next payment attempt in minutes.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**gateway** | **str** | { \"description\" : \"The payment gateway to use for this payment attempt.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"Has the dunning-line been deleted?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] -**organization** | [**Organization**](Organization.md) | { \"description\" : \"organization associated with the dunning-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | +**type** | **str** | | +**attempt_ix** | **int** | | +**minutes_delay** | **int** | | +**gateway** | **str** | | [optional] +**deleted** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DunningLinePagedMetadata.md b/docs/DunningLinePagedMetadata.md deleted file mode 100644 index 743c59f..0000000 --- a/docs/DunningLinePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# DunningLinePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[DunningLine]**](DunningLine.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DunninglinesApi.md b/docs/DunninglinesApi.md deleted file mode 100644 index e9493d8..0000000 --- a/docs/DunninglinesApi.md +++ /dev/null @@ -1,322 +0,0 @@ -# billforward.DunninglinesApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_dunning_line**](DunninglinesApi.md#create_dunning_line) | **POST** /dunning-lines | Create a dunning-line. -[**get_all_dunning_lines**](DunninglinesApi.md#get_all_dunning_lines) | **GET** /dunning-lines | Returns a collection of all dunning-lines. By default 10 values are returned. Records are returned in natural order. -[**get_dunning_line_by_attempt_index**](DunninglinesApi.md#get_dunning_line_by_attempt_index) | **GET** /dunning-lines/attempt-index/{index} | Returns a collection of dunning-lines specified by the index parameter. By default 10 values are returned. Records are returned in natural order. -[**get_dunning_line_by_id**](DunninglinesApi.md#get_dunning_line_by_id) | **GET** /dunning-lines/{dunning-line-ID} | Returns a single dunning-line, specified by the dunning-line-ID parameter. -[**retire_dunning_line**](DunninglinesApi.md#retire_dunning_line) | **DELETE** /dunning-lines/{dunning-line-ID} | Retires the specified dunning-line. -[**update_dunning_line**](DunninglinesApi.md#update_dunning_line) | **PUT** /dunning-lines | Update a dunning-line. - - -# **create_dunning_line** -> DunningLinePagedMetadata create_dunning_line(dunning_line) - -Create a dunning-line. - -{\"nickname\":\"Create a new dunning line\",\"request\":\"createDunningLineRequest.html\",\"response\":\"createDunningLineResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.DunninglinesApi() -dunning_line = billforward.DunningLine() # DunningLine | The Dunning-Line object to be updated. - -try: - # Create a dunning-line. - api_response = api_instance.create_dunning_line(dunning_line) - pprint(api_response) -except ApiException as e: - print "Exception when calling DunninglinesApi->create_dunning_line: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dunning_line** | [**DunningLine**](DunningLine.md)| The Dunning-Line object to be updated. | - -### Return type - -[**DunningLinePagedMetadata**](DunningLinePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_dunning_lines** -> DunningLinePagedMetadata get_all_dunning_lines(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of all dunning-lines. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all dunning lines\",\"response\":\"getDunningLineByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.DunninglinesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first invoice to return. (optional) (default to 0) -records = 10 # int | The maximum number of invoices to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of all dunning-lines. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_dunning_lines(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling DunninglinesApi->get_all_dunning_lines: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first invoice to return. | [optional] [default to 0] - **records** | **int**| The maximum number of invoices to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**DunningLinePagedMetadata**](DunningLinePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_dunning_line_by_attempt_index** -> DunningLinePagedMetadata get_dunning_line_by_attempt_index(index, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of dunning-lines specified by the index parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by attempt\",\"response\":\"getDunningLineByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.DunninglinesApi() -index = 56 # int | The attempt index of the dunning-line. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first invoice to return. (optional) (default to 0) -records = 10 # int | The maximum number of invoices to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of dunning-lines specified by the index parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_dunning_line_by_attempt_index(index, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling DunninglinesApi->get_dunning_line_by_attempt_index: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **index** | **int**| The attempt index of the dunning-line. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first invoice to return. | [optional] [default to 0] - **records** | **int**| The maximum number of invoices to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**DunningLinePagedMetadata**](DunningLinePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_dunning_line_by_id** -> DunningLinePagedMetadata get_dunning_line_by_id(dunning_line_id, organizations=organizations) - -Returns a single dunning-line, specified by the dunning-line-ID parameter. - -{\"nickname\":\"Retrieve an existing dunning line\",\"response\":\"getDunningLineByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.DunninglinesApi() -dunning_line_id = 'dunning_line_id_example' # str | ID of the dunning-line. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single dunning-line, specified by the dunning-line-ID parameter. - api_response = api_instance.get_dunning_line_by_id(dunning_line_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling DunninglinesApi->get_dunning_line_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dunning_line_id** | **str**| ID of the dunning-line. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DunningLinePagedMetadata**](DunningLinePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json, text/xml - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **retire_dunning_line** -> DunningLinePagedMetadata retire_dunning_line(dunning_line_id, organizations) - -Retires the specified dunning-line. - -{\"nickname\":\"Delete a dunning line\",\"response\":\"deleteDunningLine.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.DunninglinesApi() -dunning_line_id = 'dunning_line_id_example' # str | ID of the dunning-line. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. - -try: - # Retires the specified dunning-line. - api_response = api_instance.retire_dunning_line(dunning_line_id, organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling DunninglinesApi->retire_dunning_line: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dunning_line_id** | **str**| ID of the dunning-line. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | - -### Return type - -[**DunningLinePagedMetadata**](DunningLinePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_dunning_line** -> DunningLinePagedMetadata update_dunning_line(dunning_line) - -Update a dunning-line. - -{\"nickname\":\"Update a dunning line\",\"request\":\"updateDunningLineRequest.html\",\"response\":\"updateDunningLineResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.DunninglinesApi() -dunning_line = billforward.DunningLine() # DunningLine | The Dunning-Line object to be updated. - -try: - # Update a dunning-line. - api_response = api_instance.update_dunning_line(dunning_line) - pprint(api_response) -except ApiException as e: - print "Exception when calling DunninglinesApi->update_dunning_line: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **dunning_line** | [**DunningLine**](DunningLine.md)| The Dunning-Line object to be updated. | - -### Return type - -[**DunningLinePagedMetadata**](DunningLinePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/EBANXApi.md b/docs/EBANXApi.md new file mode 100644 index 0000000..ce97198 --- /dev/null +++ b/docs/EBANXApi.md @@ -0,0 +1,199 @@ +# billforward.EBANXApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete_configuration1**](EBANXApi.md#delete_configuration1) | **DELETE** /ebanx | +[**get_configuration1**](EBANXApi.md#get_configuration1) | **GET** /ebanx | +[**handle_webhook**](EBANXApi.md#handle_webhook) | **POST** /ebanx/webhook/{organization_id} | +[**upsert_configuration1**](EBANXApi.md#upsert_configuration1) | **POST** /ebanx | + +# **delete_configuration1** +> APIConfiguration delete_configuration1(organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.EBANXApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.delete_configuration1(organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling EBANXApi->delete_configuration1: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**APIConfiguration**](APIConfiguration.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */* + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_configuration1** +> InlineResponseDefault14 get_configuration1(organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.EBANXApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_configuration1(organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling EBANXApi->get_configuration1: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault14**](InlineResponseDefault14.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **handle_webhook** +> InlineResponseDefault27 handle_webhook(organization_id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.EBANXApi(billforward.ApiClient(configuration)) +organization_id = 'organization_id_example' # str | +body = billforward.EBANXWebhook() # EBANXWebhook | (optional) + +try: + api_response = api_instance.handle_webhook(organization_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling EBANXApi->handle_webhook: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | **str**| | + **body** | [**EBANXWebhook**](EBANXWebhook.md)| | [optional] + +### Return type + +[**InlineResponseDefault27**](InlineResponseDefault27.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **upsert_configuration1** +> InlineResponseDefault14 upsert_configuration1(body=body, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.EBANXApi(billforward.ApiClient(configuration)) +body = billforward.EBANXGatewayRequest() # EBANXGatewayRequest | (optional) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.upsert_configuration1(body=body, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling EBANXApi->upsert_configuration1: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**EBANXGatewayRequest**](EBANXGatewayRequest.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault14**](InlineResponseDefault14.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/EBANXAuthCaptureRequest.md b/docs/EBANXAuthCaptureRequest.md new file mode 100644 index 0000000..9414247 --- /dev/null +++ b/docs/EBANXAuthCaptureRequest.md @@ -0,0 +1,13 @@ +# EBANXAuthCaptureRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**token** | **str** | | [optional] +**expiry** | **str** | | [optional] +**eft_code** | **str** | | [optional] +**payment_type_code** | **str** | | [optional] +**masked_card_number** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/EBANXConfiguration.md b/docs/EBANXConfiguration.md new file mode 100644 index 0000000..bb35140 --- /dev/null +++ b/docs/EBANXConfiguration.md @@ -0,0 +1,8 @@ +# EBANXConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/EBANXGatewayRequest.md b/docs/EBANXGatewayRequest.md new file mode 100644 index 0000000..2ff8809 --- /dev/null +++ b/docs/EBANXGatewayRequest.md @@ -0,0 +1,11 @@ +# EBANXGatewayRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**integration_key** | **str** | | [optional] +**public_integration_key** | **str** | | [optional] +**production** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/EBANXPayment.md b/docs/EBANXPayment.md new file mode 100644 index 0000000..7a7151d --- /dev/null +++ b/docs/EBANXPayment.md @@ -0,0 +1,8 @@ +# EBANXPayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/EBANXWebhook.md b/docs/EBANXWebhook.md new file mode 100644 index 0000000..3afbe31 --- /dev/null +++ b/docs/EBANXWebhook.md @@ -0,0 +1,12 @@ +# EBANXWebhook + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **str** | | [optional] +**organisation_id** | **str** | | [optional] +**notification_type** | **str** | | [optional] +**hash_codes** | **list[str]** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Email.md b/docs/Email.md deleted file mode 100644 index fabee90..0000000 --- a/docs/Email.md +++ /dev/null @@ -1,37 +0,0 @@ -# Email - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**account_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**invoice_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**_from** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**to** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**cc** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**bcc** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**subject** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**html** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**attachment_filename** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**attachment_html** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**plain** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**sent** | **datetime** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | { \"description\" : \".\", \"verbs\":[\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] [default to False] -**header_url** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**salutation** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**paragraph1** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**paragraph2** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**footer_information** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**signoff** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**emai_subscription_type** | **str** | | [optional] -**notification_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EmailPagedMetadata.md b/docs/EmailPagedMetadata.md deleted file mode 100644 index 129b6bb..0000000 --- a/docs/EmailPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# EmailPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Email]**](Email.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EmailProvider.md b/docs/EmailProvider.md deleted file mode 100644 index 41d3ee8..0000000 --- a/docs/EmailProvider.md +++ /dev/null @@ -1,20 +0,0 @@ -# EmailProvider - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the email provider.\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the email provider.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**name** | **str** | | -**host** | **str** | | -**port** | **int** | | -**username** | **str** | | [optional] -**password** | **str** | | [optional] -**deleted** | **bool** | { \"description\" : \"Has the dunning-line been deleted?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EmailProviderPagedMetadata.md b/docs/EmailProviderPagedMetadata.md deleted file mode 100644 index 86efbc1..0000000 --- a/docs/EmailProviderPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# EmailProviderPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[EmailProvider]**](EmailProvider.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EmailSubscription.md b/docs/EmailSubscription.md deleted file mode 100644 index be145cb..0000000 --- a/docs/EmailSubscription.md +++ /dev/null @@ -1,22 +0,0 @@ -# EmailSubscription - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the email provider.\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the email provider.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**type** | **str** | | [optional] -**state** | **str** | | -**_from** | **str** | | -**bcc** | **str** | | [optional] -**cc** | **str** | | [optional] -**subject_template** | **str** | | [optional] -**send_to_customer** | **bool** | | [optional] [default to False] -**attach_invoice** | **bool** | | [optional] [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EmailSubscriptionPagedMetadata.md b/docs/EmailSubscriptionPagedMetadata.md deleted file mode 100644 index 7b40743..0000000 --- a/docs/EmailSubscriptionPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# EmailSubscriptionPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[EmailSubscription]**](EmailSubscription.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EmailTokenization.md b/docs/EmailTokenization.md new file mode 100644 index 0000000..e3fb48e --- /dev/null +++ b/docs/EmailTokenization.md @@ -0,0 +1,36 @@ +# EmailTokenization + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | +**request_token** | **str** | | +**type** | **str** | | +**verification_state** | **str** | | [optional] +**email_id** | **str** | | +**public_token** | **str** | | +**account** | [**Account**](Account.md) | | +**account_full_name** | **str** | | +**subscription_id** | **str** | | [optional] +**subscription_name** | **str** | | [optional] +**product_rate_plan_name** | **str** | | [optional] +**invoice_id** | **str** | | [optional] +**invoice_version_id** | **str** | | [optional] +**logo_url** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**amount** | **float** | | [optional] +**last_sent** | **datetime** | | [optional] +**valid_till** | **datetime** | | +**payment_method_id** | **str** | | [optional] +**make_default** | **bool** | | [optional] +**charge_immediately** | **bool** | | [optional] +**capture_profile** | **bool** | | [optional] +**capture_billing_address** | **bool** | | [optional] +**capture_shipping_address** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/EmailTokenizationCreateAPIRequest.md b/docs/EmailTokenizationCreateAPIRequest.md new file mode 100644 index 0000000..ebb57e6 --- /dev/null +++ b/docs/EmailTokenizationCreateAPIRequest.md @@ -0,0 +1,17 @@ +# EmailTokenizationCreateAPIRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**invoice_id** | **str** | | [optional] +**gateway_type** | **str** | | [optional] +**make_default** | **bool** | | [optional] +**charge_immediately** | **bool** | | [optional] +**capture_profile** | **bool** | | [optional] +**capture_billing_address** | **bool** | | [optional] +**capture_shipping_address** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/EmailTokenizationSendAPIRequest.md b/docs/EmailTokenizationSendAPIRequest.md new file mode 100644 index 0000000..6636622 --- /dev/null +++ b/docs/EmailTokenizationSendAPIRequest.md @@ -0,0 +1,9 @@ +# EmailTokenizationSendAPIRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/EmailTokenizationUpdateAPIRequest.md b/docs/EmailTokenizationUpdateAPIRequest.md new file mode 100644 index 0000000..b6a8b5a --- /dev/null +++ b/docs/EmailTokenizationUpdateAPIRequest.md @@ -0,0 +1,10 @@ +# EmailTokenizationUpdateAPIRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**valid_till** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/EmailprovidersApi.md b/docs/EmailprovidersApi.md deleted file mode 100644 index 2100e63..0000000 --- a/docs/EmailprovidersApi.md +++ /dev/null @@ -1,216 +0,0 @@ -# billforward.EmailprovidersApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_email_provider**](EmailprovidersApi.md#create_email_provider) | **POST** /email-providers | Create an email provider. -[**delete**](EmailprovidersApi.md#delete) | **DELETE** /email-providers/{email-provider-ID} | Deletes a single email provider, specified by id or name parameter. -[**get_all_email_providers**](EmailprovidersApi.md#get_all_email_providers) | **GET** /email-providers | Returns a collection of all email-providers. By default 10 values are returned. Records are returned in natural order. -[**get_email_by_provider_id**](EmailprovidersApi.md#get_email_by_provider_id) | **GET** /email-providers/{email-provider-ID} | Retrieves a single email provider, specified by the version-ID parameter. - - -# **create_email_provider** -> EmailProviderPagedMetadata create_email_provider(request) - -Create an email provider. - -{\"nickname\":\"Create an email provider\",\"request\":\"createEmailProviderRequest.html\",\"response\":\"creatEmailProviderResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.EmailprovidersApi() -request = billforward.BillingEntityBase() # BillingEntityBase | . - -try: - # Create an email provider. - api_response = api_instance.create_email_provider(request) - pprint(api_response) -except ApiException as e: - print "Exception when calling EmailprovidersApi->create_email_provider: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **request** | [**BillingEntityBase**](BillingEntityBase.md)| . | - -### Return type - -[**EmailProviderPagedMetadata**](EmailProviderPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete** -> EmailProviderPagedMetadata delete(email_provider_id, organizations=organizations) - -Deletes a single email provider, specified by id or name parameter. - -{ \"nickname\" : \"delete\",\"response\" : \"deleteEmailProvider.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.EmailprovidersApi() -email_provider_id = 'email_provider_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Deletes a single email provider, specified by id or name parameter. - api_response = api_instance.delete(email_provider_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling EmailprovidersApi->delete: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **email_provider_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**EmailProviderPagedMetadata**](EmailProviderPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_email_providers** -> EmailProviderPagedMetadata get_all_email_providers(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of all email-providers. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all email providers\",\"response\":\"getEmailProvidersAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.EmailprovidersApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first email-provider to return. (optional) (default to 0) -records = 10 # int | The maximum number of email-provider to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Include deleted email-providers (optional) (default to false) - -try: - # Returns a collection of all email-providers. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_email_providers(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling EmailprovidersApi->get_all_email_providers: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first email-provider to return. | [optional] [default to 0] - **records** | **int**| The maximum number of email-provider to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Include deleted email-providers | [optional] [default to false] - -### Return type - -[**EmailProviderPagedMetadata**](EmailProviderPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_email_by_provider_id** -> EmailProviderPagedMetadata get_email_by_provider_id(email_provider_id, organizations=organizations, include_retired=include_retired) - -Retrieves a single email provider, specified by the version-ID parameter. - -{ \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailProviderByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.EmailprovidersApi() -email_provider_id = 'email_provider_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -include_retired = false # bool | Include deleted email-providers (optional) (default to false) - -try: - # Retrieves a single email provider, specified by the version-ID parameter. - api_response = api_instance.get_email_by_provider_id(email_provider_id, organizations=organizations, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling EmailprovidersApi->get_email_by_provider_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **email_provider_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **include_retired** | **bool**| Include deleted email-providers | [optional] [default to false] - -### Return type - -[**EmailProviderPagedMetadata**](EmailProviderPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/EmailsApi.md b/docs/EmailsApi.md deleted file mode 100644 index 2a40a3b..0000000 --- a/docs/EmailsApi.md +++ /dev/null @@ -1,158 +0,0 @@ -# billforward.EmailsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_email_by_id**](EmailsApi.md#get_email_by_id) | **GET** /emails/{email-ID} | Retrieves a single invoice, specified by the version-ID parameter. -[**get_email_html_by_id**](EmailsApi.md#get_email_html_by_id) | **GET** /emails/{email-ID}.html | Retrieves a single invoice, specified by the version-ID parameter. -[**get_email_text_by_id**](EmailsApi.md#get_email_text_by_id) | **GET** /emails/{email-ID}.txt | Retrieves a single invoice, specified by the version-ID parameter. - - -# **get_email_by_id** -> EmailPagedMetadata get_email_by_id(email_id, organizations=organizations) - -Retrieves a single invoice, specified by the version-ID parameter. - -{ \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.EmailsApi() -email_id = 'email_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retrieves a single invoice, specified by the version-ID parameter. - api_response = api_instance.get_email_by_id(email_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling EmailsApi->get_email_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **email_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**EmailPagedMetadata**](EmailPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json, text/xml - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_email_html_by_id** -> str get_email_html_by_id(email_id, organizations=organizations) - -Retrieves a single invoice, specified by the version-ID parameter. - -{ \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.EmailsApi() -email_id = 'email_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retrieves a single invoice, specified by the version-ID parameter. - api_response = api_instance.get_email_html_by_id(email_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling EmailsApi->get_email_html_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **email_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -**str** - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: text/html - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_email_text_by_id** -> str get_email_text_by_id(email_id, organizations=organizations) - -Retrieves a single invoice, specified by the version-ID parameter. - -{ \"nickname\" : \"Retrieve by version\",\"response\" : \"getEmailByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.EmailsApi() -email_id = 'email_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retrieves a single invoice, specified by the version-ID parameter. - api_response = api_instance.get_email_text_by_id(email_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling EmailsApi->get_email_text_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **email_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -**str** - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/EmailsubscriptionsApi.md b/docs/EmailsubscriptionsApi.md deleted file mode 100644 index 021b329..0000000 --- a/docs/EmailsubscriptionsApi.md +++ /dev/null @@ -1,266 +0,0 @@ -# billforward.EmailsubscriptionsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_email_subscription**](EmailsubscriptionsApi.md#create_email_subscription) | **POST** /email-subscriptions | Create an email subscription. -[**delete_email_subscription_by_type**](EmailsubscriptionsApi.md#delete_email_subscription_by_type) | **DELETE** /email-subscriptions/type={type} | Unsubscribe from the email specified by the type parameter. -[**get_all_email_subscriptions**](EmailsubscriptionsApi.md#get_all_email_subscriptions) | **GET** /email-subscriptions | Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order. -[**get_email_subscription_by_id**](EmailsubscriptionsApi.md#get_email_subscription_by_id) | **GET** /email-subscriptions/{email-subscription-id} | Retrieves a single email subscription, specified by ID. -[**update_email_subscription**](EmailsubscriptionsApi.md#update_email_subscription) | **PUT** /email-subscriptions | Update an email subscription. - - -# **create_email_subscription** -> EmailSubscriptionPagedMetadata create_email_subscription(request) - -Create an email subscription. - -{\"nickname\":\"Create an email subscription\",\"request\":\"createEmailSubscriptionRequest.html\",\"response\":\"creatEmailSubscriptionResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.EmailsubscriptionsApi() -request = billforward.BillingEntityBase() # BillingEntityBase | . - -try: - # Create an email subscription. - api_response = api_instance.create_email_subscription(request) - pprint(api_response) -except ApiException as e: - print "Exception when calling EmailsubscriptionsApi->create_email_subscription: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **request** | [**BillingEntityBase**](BillingEntityBase.md)| . | - -### Return type - -[**EmailSubscriptionPagedMetadata**](EmailSubscriptionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_email_subscription_by_type** -> EmailSubscriptionPagedMetadata delete_email_subscription_by_type(type, organizations=organizations) - -Unsubscribe from the email specified by the type parameter. - -{ \"nickname\" : \"Unsubscribe\",\"response\" : \"unsubscribeEmail.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.EmailsubscriptionsApi() -type = 'type_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Unsubscribe from the email specified by the type parameter. - api_response = api_instance.delete_email_subscription_by_type(type, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling EmailsubscriptionsApi->delete_email_subscription_by_type: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **type** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**EmailSubscriptionPagedMetadata**](EmailSubscriptionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json, text/xml - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_email_subscriptions** -> EmailSubscriptionPagedMetadata get_all_email_subscriptions(state, type, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all email subscriptions\",\"response\":\"getEmailSubscriptionsAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.EmailsubscriptionsApi() -state = 'state_example' # str | Constrains search to Email Subscriptions of a specific state. -type = 'type_example' # str | Constrains search to Email Subscriptions of a specific type -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first email-subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of email-subscription to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_email_subscriptions(state, type, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling EmailsubscriptionsApi->get_all_email_subscriptions: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **state** | **str**| Constrains search to Email Subscriptions of a specific state. | - **type** | **str**| Constrains search to Email Subscriptions of a specific type | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first email-subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of email-subscription to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**EmailSubscriptionPagedMetadata**](EmailSubscriptionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_email_subscription_by_id** -> EmailSubscriptionPagedMetadata get_email_subscription_by_id(email_subscription_id, organizations=organizations, include_retired=include_retired) - -Retrieves a single email subscription, specified by ID. - -{ \"nickname\" : \"Retrieve by ID\",\"response\" : \"getEmailSubscriptionByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.EmailsubscriptionsApi() -email_subscription_id = 'email_subscription_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -include_retired = false # bool | Include deleted email-subscriptions (optional) (default to false) - -try: - # Retrieves a single email subscription, specified by ID. - api_response = api_instance.get_email_subscription_by_id(email_subscription_id, organizations=organizations, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling EmailsubscriptionsApi->get_email_subscription_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **email_subscription_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **include_retired** | **bool**| Include deleted email-subscriptions | [optional] [default to false] - -### Return type - -[**EmailSubscriptionPagedMetadata**](EmailSubscriptionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_email_subscription** -> EmailSubscriptionPagedMetadata update_email_subscription(request) - -Update an email subscription. - -{\"nickname\":\"Update EmailSubscription\",\"request\":\"updateEmailSubscriptionRequest.html\",\"response\":\"updateEmailSubscriptionResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.EmailsubscriptionsApi() -request = billforward.BillingEntityBase() # BillingEntityBase | . - -try: - # Update an email subscription. - api_response = api_instance.update_email_subscription(request) - pprint(api_response) -except ApiException as e: - print "Exception when calling EmailsubscriptionsApi->update_email_subscription: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **request** | [**BillingEntityBase**](BillingEntityBase.md)| . | - -### Return type - -[**EmailSubscriptionPagedMetadata**](EmailSubscriptionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/EndTrialAmendment.md b/docs/EndTrialAmendment.md index f4601fa..f3e3b1e 100644 --- a/docs/EndTrialAmendment.md +++ b/docs/EndTrialAmendment.md @@ -3,19 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EpxCaptureRequest.md b/docs/EpxCaptureRequest.md new file mode 100644 index 0000000..e7575d5 --- /dev/null +++ b/docs/EpxCaptureRequest.md @@ -0,0 +1,35 @@ +# EpxCaptureRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | | [optional] +**tran_type** | **str** | | [optional] +**auth_guid** | **str** | | [optional] +**auth_resp** | **str** | | [optional] +**auth_code** | **str** | | [optional] +**auth_resp_text** | **str** | | [optional] +**auth_card_type** | **str** | | [optional] +**auth_amount_requested** | **str** | | [optional] +**auth_amount** | **str** | | [optional] +**auth_currency_code** | **str** | | [optional] +**auth_masked_account_nbr** | **str** | | [optional] +**first_name** | **str** | | [optional] +**last_name** | **str** | | [optional] +**exp_date** | **str** | | [optional] +**bp_resp_code** | **str** | | [optional] +**bp_resp_text** | **str** | | [optional] +**bp_fields_errors** | **str** | | [optional] +**network_response** | **str** | | [optional] +**cust_nbr** | **str** | | [optional] +**merch_nbr** | **str** | | [optional] +**dba_nbr** | **str** | | [optional] +**terminal_nbr** | **str** | | [optional] +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**default_payment_method** | **bool** | | [optional] +**formatted_error_message** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/EpxConfiguration.md b/docs/EpxConfiguration.md new file mode 100644 index 0000000..db76f15 --- /dev/null +++ b/docs/EpxConfiguration.md @@ -0,0 +1,13 @@ +# EpxConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**terminal_nbr** | **str** | | [optional] +**merch_nbr** | **str** | | [optional] +**cust_nbr** | **str** | | [optional] +**mac** | **str** | | [optional] +**dba_nbr** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/FileSham.md b/docs/EpxPayment.md similarity index 95% rename from docs/FileSham.md rename to docs/EpxPayment.md index f10913a..d2da225 100644 --- a/docs/FileSham.md +++ b/docs/EpxPayment.md @@ -1,4 +1,4 @@ -# FileSham +# EpxPayment ## Properties Name | Type | Description | Notes @@ -6,4 +6,3 @@ Name | Type | Description | Notes [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/EpxPreAuthRequest.md b/docs/EpxPreAuthRequest.md new file mode 100644 index 0000000..51553d1 --- /dev/null +++ b/docs/EpxPreAuthRequest.md @@ -0,0 +1,15 @@ +# EpxPreAuthRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**default_payment_method** | **bool** | | [optional] +**location_code** | **str** | | [optional] +**capture_method** | **str** | | [optional] +**amount** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/EpxPreAuthResponse.md b/docs/EpxPreAuthResponse.md new file mode 100644 index 0000000..353cb7c --- /dev/null +++ b/docs/EpxPreAuthResponse.md @@ -0,0 +1,19 @@ +# EpxPreAuthResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**tac** | **str** | | [optional] +**cust_nbr** | **str** | | [optional] +**merch_nbr** | **str** | | [optional] +**dba_nbr** | **str** | | [optional] +**terminal_nbr** | **str** | | [optional] +**batch_id** | **str** | | [optional] +**tran_code** | **str** | | [optional] +**amount** | **str** | | [optional] +**currency_code** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Event.md b/docs/Event.md deleted file mode 100644 index 660292a..0000000 --- a/docs/Event.md +++ /dev/null @@ -1,17 +0,0 @@ -# Event - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | | -**type** | **str** | | -**livemode** | **bool** | | [default to False] -**created** | **int** | | -**data** | [**EventData**](EventData.md) | | -**request** | **str** | | -**user_id** | **str** | | -**pending_webhooks** | **int** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ExecutionReceiptResponse.md b/docs/ExecutionReceiptResponse.md new file mode 100644 index 0000000..ca6bbe6 --- /dev/null +++ b/docs/ExecutionReceiptResponse.md @@ -0,0 +1,15 @@ +# ExecutionReceiptResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**receipt_id** | **str** | | [optional] +**gateway_reference_id** | **str** | | [optional] +**payment_id** | **str** | | [optional] +**payment_gateway** | **str** | | [optional] +**decision** | **str** | | [optional] +**gateway_execution_details** | **str** | | [optional] +**amount** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ExecutionResponse.md b/docs/ExecutionResponse.md new file mode 100644 index 0000000..d72a252 --- /dev/null +++ b/docs/ExecutionResponse.md @@ -0,0 +1,13 @@ +# ExecutionResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**invoice_id** | **str** | | [optional] +**invoice_type** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**outstanding_amount** | **float** | | [optional] +**executions** | [**list[ExecutionReceiptResponse]**](ExecutionReceiptResponse.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Extras.md b/docs/Extras.md new file mode 100644 index 0000000..3523da0 --- /dev/null +++ b/docs/Extras.md @@ -0,0 +1,9 @@ +# Extras + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**square_data** | [**SquareData**](SquareData.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/FixedTerm.md b/docs/FixedTerm.md index a79ee34..95d0600 100644 --- a/docs/FixedTerm.md +++ b/docs/FixedTerm.md @@ -3,24 +3,19 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | id | [optional] -**subscription_id** | **str** | { \"description\" : \"subscriptionID\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"The ID of the organization associated with the amendment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**fixed_term_definition_id** | **str** | { \"description\" : \"fixedTermDefinitionID\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**fixed_term_definition** | [**MutableBillingEntity**](MutableBillingEntity.md) | | -**expiry_behaviour** | **str** | fixedTermExpiryBehaviour | -**state** | **str** | state | -**product_rate_plan_as_of_time** | **datetime** | productRatePlanAsOfTime | -**compound_uplift** | **float** | { \"description\" : \"compoundUplift\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] }The proportional INCREASE in price applied every time the fixed terms recur. e.g. 0.03 is a 3% increase. -0.5 is a 50% decrease. 3 is a 300% increase | -**start_time** | **datetime** | start_time | -**expiry_time** | **datetime** | expiry_time | -**periods** | **int** | { \"description\" : \"The number of billing periods that this fixed term lasts for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**fixed_term_number** | **int** | { \"description\" : \"The number of sequential fixed terms previous to this one for the subscription (i.e. zero indexed 'fixedTermCount').\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"Is the fixedTerm deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**subscription_version_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**fixed_term_definition_id** | **str** | | [optional] +**fixed_term_definition** | [**FixedTermDefinition**](FixedTermDefinition.md) | | [optional] +**expiry_behaviour** | **str** | | +**periods** | **int** | | [optional] +**next_product_rate_plan_id** | **str** | | [optional] +**deleted** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/FixedTermDefinition.md b/docs/FixedTermDefinition.md new file mode 100644 index 0000000..9b7fca4 --- /dev/null +++ b/docs/FixedTermDefinition.md @@ -0,0 +1,19 @@ +# FixedTermDefinition + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**product_rate_plan_id** | **str** | | [optional] +**expiry_behaviour** | **str** | | +**next_product_rate_plan_id** | **str** | | [optional] +**first_term_periods** | **int** | | [optional] +**subsequent_term_periods** | **int** | | [optional] +**deleted** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/FixedTermDefinitionPagedMetadata.md b/docs/FixedTermDefinitionPagedMetadata.md deleted file mode 100644 index 7116666..0000000 --- a/docs/FixedTermDefinitionPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# FixedTermDefinitionPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/FixedTermExpiryAmendment.md b/docs/FixedTermExpiryAmendment.md index 9f38473..c86fbf9 100644 --- a/docs/FixedTermExpiryAmendment.md +++ b/docs/FixedTermExpiryAmendment.md @@ -3,20 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] -**fixed_term_id** | **str** | { \"description\" : \"ID of the fixed term to be expired by the amendment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | +**fixed_term_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/FixedTermPagedMetadata.md b/docs/FixedTermPagedMetadata.md deleted file mode 100644 index be97940..0000000 --- a/docs/FixedTermPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# FixedTermPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[FixedTerm]**](FixedTerm.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/FixedtermdefinitionsApi.md b/docs/FixedtermdefinitionsApi.md deleted file mode 100644 index 70aa257..0000000 --- a/docs/FixedtermdefinitionsApi.md +++ /dev/null @@ -1,104 +0,0 @@ -# billforward.FixedtermdefinitionsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_fixed_term_definition**](FixedtermdefinitionsApi.md#create_fixed_term_definition) | **POST** /fixed-term-definitions | Create -[**update_fixed_term_definition**](FixedtermdefinitionsApi.md#update_fixed_term_definition) | **PUT** /fixed-term-definitions | Update - - -# **create_fixed_term_definition** -> FixedTermDefinitionPagedMetadata create_fixed_term_definition(fixed_term_definiton) - -Create - -{\"nickname\":\"Create a new fixed term definition\",\"request\":\"createFixedTermDefinitionRequest.html\",\"response\":\"createFixedTermDefinitionResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.FixedtermdefinitionsApi() -fixed_term_definiton = billforward.MutableBillingEntity() # MutableBillingEntity | The fixed-term-definition object to be updated. - -try: - # Create - api_response = api_instance.create_fixed_term_definition(fixed_term_definiton) - pprint(api_response) -except ApiException as e: - print "Exception when calling FixedtermdefinitionsApi->create_fixed_term_definition: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **fixed_term_definiton** | [**MutableBillingEntity**](MutableBillingEntity.md)| The fixed-term-definition object to be updated. | - -### Return type - -[**FixedTermDefinitionPagedMetadata**](FixedTermDefinitionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_fixed_term_definition** -> FixedTermDefinitionPagedMetadata update_fixed_term_definition(fixed_term_definiton) - -Update - -{\"nickname\":\"Update a fixed-term definition\",\"request\":\"updateFixedTermDefinitionRequest.html\",\"response\":\"updateFixedTermDefinitionResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.FixedtermdefinitionsApi() -fixed_term_definiton = billforward.MutableBillingEntity() # MutableBillingEntity | The fixed-term-definition object to be updated. - -try: - # Update - api_response = api_instance.update_fixed_term_definition(fixed_term_definiton) - pprint(api_response) -except ApiException as e: - print "Exception when calling FixedtermdefinitionsApi->update_fixed_term_definition: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **fixed_term_definiton** | [**MutableBillingEntity**](MutableBillingEntity.md)| The fixed-term-definition object to be updated. | - -### Return type - -[**FixedTermDefinitionPagedMetadata**](FixedTermDefinitionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/FixedtermsApi.md b/docs/FixedtermsApi.md deleted file mode 100644 index 6eac2cd..0000000 --- a/docs/FixedtermsApi.md +++ /dev/null @@ -1,56 +0,0 @@ -# billforward.FixedtermsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**update_fixed_term**](FixedtermsApi.md#update_fixed_term) | **PUT** /fixed-terms | Update - - -# **update_fixed_term** -> FixedTermPagedMetadata update_fixed_term(payment_method) - -Update - -{\"nickname\":\"Update a fixed term\",\"request\":\"updateFixedTermRequest.html\",\"response\":\"updateFixedTermResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.FixedtermsApi() -payment_method = billforward.FixedTerm() # FixedTerm | The payment-method object to be updated. - -try: - # Update - api_response = api_instance.update_fixed_term(payment_method) - pprint(api_response) -except ApiException as e: - print "Exception when calling FixedtermsApi->update_fixed_term: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_method** | [**FixedTerm**](FixedTerm.md)| The payment-method object to be updated. | - -### Return type - -[**FixedTermPagedMetadata**](FixedTermPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/FlatAdvancePricingComponent.md b/docs/FlatAdvancePricingComponent.md new file mode 100644 index 0000000..e1722a2 --- /dev/null +++ b/docs/FlatAdvancePricingComponent.md @@ -0,0 +1,17 @@ +# FlatAdvancePricingComponent + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**display_name** | **str** | | [optional] +**upgrade_mode** | **str** | | [optional] +**downgrade_mode** | **str** | | [optional] +**unit** | **str** | | [optional] +**price** | **float** | | [optional] +**default_quantity** | **int** | | [optional] +**tax_code** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/FlatArrearsPricingComponent.md b/docs/FlatArrearsPricingComponent.md new file mode 100644 index 0000000..cc661b2 --- /dev/null +++ b/docs/FlatArrearsPricingComponent.md @@ -0,0 +1,17 @@ +# FlatArrearsPricingComponent + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**display_name** | **str** | | [optional] +**upgrade_mode** | **str** | | [optional] +**downgrade_mode** | **str** | | [optional] +**unit** | **str** | | [optional] +**price** | **float** | | [optional] +**default_quantity** | **int** | | [optional] +**tax_code** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/FlatPricingComponent.md b/docs/FlatPricingComponent.md index 91dd731..886944c 100644 --- a/docs/FlatPricingComponent.md +++ b/docs/FlatPricingComponent.md @@ -3,32 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**version_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**crm_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } When associating a pricing component with a product rate plan, this ID should be used. | -**product_rate_plan_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**unit_of_measure_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | -**name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**public_name** | **str** | {\"description\":\"A friendly non-unique name used to identify this pricing-component\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**description** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**charge_type** | **str** | { \"description\" : \"The charge type of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**invoicing_type** | **str** | { \"default\" : \"Aggregated\", \"description\" : \"For <span class=\\\"label label-default\\\">setup</span> pricing components <span class=\\\"label label-default\\\">Immediate</span> invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. <span class=\\\"label label-default\\\">Aggregated</span> invoicing will add a charge to the first invoice of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**charge_model** | **str** | { \"description\" : \"The charge model of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**upgrade_mode** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">immediate</span>\",\"description\":\"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.<br><span class=\\\"label label-default\\\">immediate</span> &mdash; Upgrade will apply at the time the request is made.<br><span class=\\\"label label-default\\\">delayed</span> &mdash; Upgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**downgrade_mode** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">delayed</span>\",\"description\":\"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.<br><span class=\\\"label label-default\\\">immediate</span> &mdash; Downgrade will apply at the time the request is made.<br><span class=\\\"label label-default\\\">delayed</span> &mdash; Downgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**default_quantity** | **int** | { \"description\" : \"The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**min_quantity** | **int** | { \"default\" : \"0\", \"description\" : \"The minimum quantity of the pricing-component.\", \"verbs\":[] } | [optional] -**max_quantity** | **int** | { \"description\" : \"The maximum quantity of the pricing-component.\", \"verbs\":[] } | [optional] -**valid_from** | **datetime** | { \"default\" : \"current time\", \"description\" : \"The DateTime specifying when the pricing-component is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**valid_till** | **datetime** | { \"default\" : \"null\", \"description\" : \"The UTC DateTime specifying when the pricing-component is valid till.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**tiers** | [**list[PricingComponentTier]**](PricingComponentTier.md) | { \"default\" : \"[]\", \"description\" : \"The pricing-component-tiers associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**unit_of_measure** | [**UnitOfMeasure**](UnitOfMeasure.md) | { \"description\" : \"The unit-of-measure associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/FlatSetupPricingComponent.md b/docs/FlatSetupPricingComponent.md new file mode 100644 index 0000000..302504f --- /dev/null +++ b/docs/FlatSetupPricingComponent.md @@ -0,0 +1,16 @@ +# FlatSetupPricingComponent + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**display_name** | **str** | | [optional] +**unit** | **str** | | [optional] +**invoicing_type** | **str** | | [optional] +**price** | **float** | | [optional] +**default_quantity** | **int** | | [optional] +**tax_code** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/FlatUsagePricingComponent.md b/docs/FlatUsagePricingComponent.md new file mode 100644 index 0000000..618c004 --- /dev/null +++ b/docs/FlatUsagePricingComponent.md @@ -0,0 +1,16 @@ +# FlatUsagePricingComponent + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**display_name** | **str** | | [optional] +**upgrade_mode** | **str** | | [optional] +**downgrade_mode** | **str** | | [optional] +**unit** | **str** | | [optional] +**price** | **float** | | [optional] +**tax_code** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/GetRatePlanAffiliateResponse.md b/docs/GetRatePlanAffiliateResponse.md new file mode 100644 index 0000000..5b0f9f3 --- /dev/null +++ b/docs/GetRatePlanAffiliateResponse.md @@ -0,0 +1,16 @@ +# GetRatePlanAffiliateResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**id** | **str** | | [optional] +**product_rate_plan_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**start_date** | **datetime** | | [optional] +**end_date** | **datetime** | | [optional] +**commission_structure** | [**CommissionStructure**](CommissionStructure.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/GetSubscriptionAffiliateResponse.md b/docs/GetSubscriptionAffiliateResponse.md new file mode 100644 index 0000000..b44040c --- /dev/null +++ b/docs/GetSubscriptionAffiliateResponse.md @@ -0,0 +1,13 @@ +# GetSubscriptionAffiliateResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**subscription_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**commission_structure** | [**CommissionStructure**](CommissionStructure.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/GoCardlessConfiguration.md b/docs/GoCardlessConfiguration.md new file mode 100644 index 0000000..b9d909b --- /dev/null +++ b/docs/GoCardlessConfiguration.md @@ -0,0 +1,8 @@ +# GoCardlessConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/GoCardlessTokenizationRequest.md b/docs/GoCardlessTokenizationRequest.md new file mode 100644 index 0000000..9984ff2 --- /dev/null +++ b/docs/GoCardlessTokenizationRequest.md @@ -0,0 +1,22 @@ +# GoCardlessTokenizationRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**default_payment_method** | **bool** | | [optional] +**account_holder_name** | **str** | | [optional] +**sort_code** | **str** | | [optional] +**account_number** | **str** | | [optional] +**iban** | **str** | | [optional] +**country** | **str** | | [optional] +**currency** | **str** | | [optional] +**holder_type** | **str** | | [optional] +**customer_id** | **str** | | [optional] +**name** | **str** | | [optional] +**email_tokenization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/HaltAggregationRequest.md b/docs/HaltAggregationRequest.md new file mode 100644 index 0000000..5a9405f --- /dev/null +++ b/docs/HaltAggregationRequest.md @@ -0,0 +1,9 @@ +# HaltAggregationRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/HaltAggregationResponse.md b/docs/HaltAggregationResponse.md new file mode 100644 index 0000000..52dba37 --- /dev/null +++ b/docs/HaltAggregationResponse.md @@ -0,0 +1,12 @@ +# HaltAggregationResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**parent** | [**Subscription**](Subscription.md) | | [optional] +**children** | [**list[Subscription]**](Subscription.md) | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/HostedPayment.md b/docs/HostedPayment.md new file mode 100644 index 0000000..695a46b --- /dev/null +++ b/docs/HostedPayment.md @@ -0,0 +1,13 @@ +# HostedPayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**gateway** | **str** | | [optional] +**payment_url** | **str** | | [optional] +**invoice_id** | **str** | | [optional] +**account_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/HostedPaymentConfig.md b/docs/HostedPaymentConfig.md new file mode 100644 index 0000000..a6154f2 --- /dev/null +++ b/docs/HostedPaymentConfig.md @@ -0,0 +1,10 @@ +# HostedPaymentConfig + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | | [optional] +**success_url** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/IDiscardable.md b/docs/IDiscardable.md new file mode 100644 index 0000000..28f430b --- /dev/null +++ b/docs/IDiscardable.md @@ -0,0 +1,9 @@ +# IDiscardable + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**discardable** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ImportInvoiceLine.md b/docs/ImportInvoiceLine.md index cad27b9..a6e0d7b 100644 --- a/docs/ImportInvoiceLine.md +++ b/docs/ImportInvoiceLine.md @@ -15,4 +15,3 @@ Name | Type | Description | Notes [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ImportInvoiceRequest.md b/docs/ImportInvoiceRequest.md new file mode 100644 index 0000000..ca079bf --- /dev/null +++ b/docs/ImportInvoiceRequest.md @@ -0,0 +1,27 @@ +# ImportInvoiceRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**subscription_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**cost** | **float** | | [optional] +**discount** | **float** | | [optional] +**refunded** | **float** | | [optional] +**paid** | **float** | | [optional] +**payment_received** | **datetime** | | [optional] +**period_start** | **datetime** | | [optional] +**period_end** | **datetime** | | [optional] +**state** | **str** | | [optional] +**payment_type** | **str** | | [optional] +**payment_name** | **str** | | [optional] +**payment_description** | **str** | | [optional] +**payment_reference** | **str** | | [optional] +**invoice_lines** | [**list[ImportInvoiceLine]**](ImportInvoiceLine.md) | | [optional] +**dry_run** | **bool** | | [optional] +**due** | **datetime** | | [optional] +**purchase_order** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ImportSubscriptionRequest.md b/docs/ImportSubscriptionRequest.md new file mode 100644 index 0000000..a589be6 --- /dev/null +++ b/docs/ImportSubscriptionRequest.md @@ -0,0 +1,23 @@ +# ImportSubscriptionRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**product** | **str** | | [optional] +**product_rate_plan** | **str** | | [optional] +**account_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**period_start** | **datetime** | | [optional] +**period_end** | **datetime** | | [optional] +**trial_end** | **datetime** | | [optional] +**state** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**subscription_end** | **datetime** | | [optional] +**periods** | **int** | | [optional] +**dry_run** | **bool** | | [optional] +**purchase_order** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault.md b/docs/InlineResponseDefault.md new file mode 100644 index 0000000..4f9804a --- /dev/null +++ b/docs/InlineResponseDefault.md @@ -0,0 +1,16 @@ +# InlineResponseDefault + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[DunningLine]**](DunningLine.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault1.md b/docs/InlineResponseDefault1.md new file mode 100644 index 0000000..95022a6 --- /dev/null +++ b/docs/InlineResponseDefault1.md @@ -0,0 +1,10 @@ +# InlineResponseDefault1 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[DunningLine]**](DunningLine.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault10.md b/docs/InlineResponseDefault10.md new file mode 100644 index 0000000..95dc10e --- /dev/null +++ b/docs/InlineResponseDefault10.md @@ -0,0 +1,16 @@ +# InlineResponseDefault10 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[SubscriptionCharge]**](SubscriptionCharge.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault100.md b/docs/InlineResponseDefault100.md new file mode 100644 index 0000000..fee249c --- /dev/null +++ b/docs/InlineResponseDefault100.md @@ -0,0 +1,16 @@ +# InlineResponseDefault100 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[StripeAchToken]**](StripeAchToken.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault101.md b/docs/InlineResponseDefault101.md new file mode 100644 index 0000000..5f674c7 --- /dev/null +++ b/docs/InlineResponseDefault101.md @@ -0,0 +1,16 @@ +# InlineResponseDefault101 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[Webhook]**](Webhook.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault102.md b/docs/InlineResponseDefault102.md new file mode 100644 index 0000000..23f573b --- /dev/null +++ b/docs/InlineResponseDefault102.md @@ -0,0 +1,10 @@ +# InlineResponseDefault102 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Webhook]**](Webhook.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault103.md b/docs/InlineResponseDefault103.md new file mode 100644 index 0000000..11db8fb --- /dev/null +++ b/docs/InlineResponseDefault103.md @@ -0,0 +1,10 @@ +# InlineResponseDefault103 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[AllowedWebhookSubscriptionValues]**](AllowedWebhookSubscriptionValues.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault11.md b/docs/InlineResponseDefault11.md new file mode 100644 index 0000000..ac7a28f --- /dev/null +++ b/docs/InlineResponseDefault11.md @@ -0,0 +1,10 @@ +# InlineResponseDefault11 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[HaltAggregationResponse]**](HaltAggregationResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault12.md b/docs/InlineResponseDefault12.md new file mode 100644 index 0000000..6ee2bcd --- /dev/null +++ b/docs/InlineResponseDefault12.md @@ -0,0 +1,16 @@ +# InlineResponseDefault12 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[Address]**](Address.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault13.md b/docs/InlineResponseDefault13.md new file mode 100644 index 0000000..5bcfef6 --- /dev/null +++ b/docs/InlineResponseDefault13.md @@ -0,0 +1,10 @@ +# InlineResponseDefault13 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[MarketplaceQuote]**](MarketplaceQuote.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault14.md b/docs/InlineResponseDefault14.md new file mode 100644 index 0000000..bb9519b --- /dev/null +++ b/docs/InlineResponseDefault14.md @@ -0,0 +1,10 @@ +# InlineResponseDefault14 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[APIConfiguration]**](APIConfiguration.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault15.md b/docs/InlineResponseDefault15.md new file mode 100644 index 0000000..adf0264 --- /dev/null +++ b/docs/InlineResponseDefault15.md @@ -0,0 +1,10 @@ +# InlineResponseDefault15 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[RecalculateChargeBatchResponse]**](RecalculateChargeBatchResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault16.md b/docs/InlineResponseDefault16.md new file mode 100644 index 0000000..a76f965 --- /dev/null +++ b/docs/InlineResponseDefault16.md @@ -0,0 +1,10 @@ +# InlineResponseDefault16 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[SubscriptionCharge]**](SubscriptionCharge.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault17.md b/docs/InlineResponseDefault17.md new file mode 100644 index 0000000..b4dbc7c --- /dev/null +++ b/docs/InlineResponseDefault17.md @@ -0,0 +1,10 @@ +# InlineResponseDefault17 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[SubscriptionCheckoutDefinitionDescription]**](SubscriptionCheckoutDefinitionDescription.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault18.md b/docs/InlineResponseDefault18.md new file mode 100644 index 0000000..28702ec --- /dev/null +++ b/docs/InlineResponseDefault18.md @@ -0,0 +1,16 @@ +# InlineResponseDefault18 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[APIConfiguration]**](APIConfiguration.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault19.md b/docs/InlineResponseDefault19.md new file mode 100644 index 0000000..0ec49ea --- /dev/null +++ b/docs/InlineResponseDefault19.md @@ -0,0 +1,10 @@ +# InlineResponseDefault19 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Contract]**](Contract.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault2.md b/docs/InlineResponseDefault2.md new file mode 100644 index 0000000..6913848 --- /dev/null +++ b/docs/InlineResponseDefault2.md @@ -0,0 +1,10 @@ +# InlineResponseDefault2 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[AddChargeToAccountResponse]**](AddChargeToAccountResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault20.md b/docs/InlineResponseDefault20.md new file mode 100644 index 0000000..0387f15 --- /dev/null +++ b/docs/InlineResponseDefault20.md @@ -0,0 +1,16 @@ +# InlineResponseDefault20 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[Contract]**](Contract.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault21.md b/docs/InlineResponseDefault21.md new file mode 100644 index 0000000..e743fc3 --- /dev/null +++ b/docs/InlineResponseDefault21.md @@ -0,0 +1,10 @@ +# InlineResponseDefault21 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[StartContractResponse]**](StartContractResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault22.md b/docs/InlineResponseDefault22.md new file mode 100644 index 0000000..1d71dfa --- /dev/null +++ b/docs/InlineResponseDefault22.md @@ -0,0 +1,16 @@ +# InlineResponseDefault22 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[Coupon]**](Coupon.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault23.md b/docs/InlineResponseDefault23.md new file mode 100644 index 0000000..66eddaa --- /dev/null +++ b/docs/InlineResponseDefault23.md @@ -0,0 +1,10 @@ +# InlineResponseDefault23 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Coupon]**](Coupon.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault24.md b/docs/InlineResponseDefault24.md new file mode 100644 index 0000000..cbea624 --- /dev/null +++ b/docs/InlineResponseDefault24.md @@ -0,0 +1,10 @@ +# InlineResponseDefault24 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[CouponCodeResponse]**](CouponCodeResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault25.md b/docs/InlineResponseDefault25.md new file mode 100644 index 0000000..094bb61 --- /dev/null +++ b/docs/InlineResponseDefault25.md @@ -0,0 +1,16 @@ +# InlineResponseDefault25 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[PlanResponse]**](PlanResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault26.md b/docs/InlineResponseDefault26.md new file mode 100644 index 0000000..293a429 --- /dev/null +++ b/docs/InlineResponseDefault26.md @@ -0,0 +1,16 @@ +# InlineResponseDefault26 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[Subscription]**](Subscription.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault27.md b/docs/InlineResponseDefault27.md new file mode 100644 index 0000000..79b0c8f --- /dev/null +++ b/docs/InlineResponseDefault27.md @@ -0,0 +1,10 @@ +# InlineResponseDefault27 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | **list[object]** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault28.md b/docs/InlineResponseDefault28.md new file mode 100644 index 0000000..dfa9646 --- /dev/null +++ b/docs/InlineResponseDefault28.md @@ -0,0 +1,10 @@ +# InlineResponseDefault28 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[AddChargeResponse]**](AddChargeResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault29.md b/docs/InlineResponseDefault29.md new file mode 100644 index 0000000..83b44c3 --- /dev/null +++ b/docs/InlineResponseDefault29.md @@ -0,0 +1,10 @@ +# InlineResponseDefault29 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Invoice]**](Invoice.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault3.md b/docs/InlineResponseDefault3.md new file mode 100644 index 0000000..ea05f51 --- /dev/null +++ b/docs/InlineResponseDefault3.md @@ -0,0 +1,16 @@ +# InlineResponseDefault3 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[CreditNote]**](CreditNote.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault30.md b/docs/InlineResponseDefault30.md new file mode 100644 index 0000000..0488f14 --- /dev/null +++ b/docs/InlineResponseDefault30.md @@ -0,0 +1,10 @@ +# InlineResponseDefault30 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[InvoiceTemplateConfigResponse]**](InvoiceTemplateConfigResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault31.md b/docs/InlineResponseDefault31.md new file mode 100644 index 0000000..ed0f4ac --- /dev/null +++ b/docs/InlineResponseDefault31.md @@ -0,0 +1,16 @@ +# InlineResponseDefault31 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[InvoiceLinePayments]**](InvoiceLinePayments.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault32.md b/docs/InlineResponseDefault32.md new file mode 100644 index 0000000..ee20e63 --- /dev/null +++ b/docs/InlineResponseDefault32.md @@ -0,0 +1,16 @@ +# InlineResponseDefault32 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[Refund]**](Refund.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault33.md b/docs/InlineResponseDefault33.md new file mode 100644 index 0000000..a0c23ea --- /dev/null +++ b/docs/InlineResponseDefault33.md @@ -0,0 +1,16 @@ +# InlineResponseDefault33 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[RevenueAttributions]**](RevenueAttributions.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault34.md b/docs/InlineResponseDefault34.md new file mode 100644 index 0000000..a029c1a --- /dev/null +++ b/docs/InlineResponseDefault34.md @@ -0,0 +1,10 @@ +# InlineResponseDefault34 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[SwaggerTypeListInv]**](SwaggerTypeListInv.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault35.md b/docs/InlineResponseDefault35.md new file mode 100644 index 0000000..4531db4 --- /dev/null +++ b/docs/InlineResponseDefault35.md @@ -0,0 +1,10 @@ +# InlineResponseDefault35 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[IssueInvoiceResponse]**](IssueInvoiceResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault36.md b/docs/InlineResponseDefault36.md new file mode 100644 index 0000000..cb006d2 --- /dev/null +++ b/docs/InlineResponseDefault36.md @@ -0,0 +1,10 @@ +# InlineResponseDefault36 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[InvoiceRefundResponse]**](InvoiceRefundResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault37.md b/docs/InlineResponseDefault37.md new file mode 100644 index 0000000..f69238e --- /dev/null +++ b/docs/InlineResponseDefault37.md @@ -0,0 +1,16 @@ +# InlineResponseDefault37 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[Notifications]**](Notifications.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault38.md b/docs/InlineResponseDefault38.md new file mode 100644 index 0000000..14ee78b --- /dev/null +++ b/docs/InlineResponseDefault38.md @@ -0,0 +1,10 @@ +# InlineResponseDefault38 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Notifications]**](Notifications.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault39.md b/docs/InlineResponseDefault39.md new file mode 100644 index 0000000..16d4dad --- /dev/null +++ b/docs/InlineResponseDefault39.md @@ -0,0 +1,10 @@ +# InlineResponseDefault39 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[NotificationSendResponse]**](NotificationSendResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault4.md b/docs/InlineResponseDefault4.md new file mode 100644 index 0000000..1072a6b --- /dev/null +++ b/docs/InlineResponseDefault4.md @@ -0,0 +1,10 @@ +# InlineResponseDefault4 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[CreditNote]**](CreditNote.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault40.md b/docs/InlineResponseDefault40.md new file mode 100644 index 0000000..fc2996b --- /dev/null +++ b/docs/InlineResponseDefault40.md @@ -0,0 +1,10 @@ +# InlineResponseDefault40 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[PaymentMethod]**](PaymentMethod.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault41.md b/docs/InlineResponseDefault41.md new file mode 100644 index 0000000..3763f41 --- /dev/null +++ b/docs/InlineResponseDefault41.md @@ -0,0 +1,10 @@ +# InlineResponseDefault41 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Payment]**](Payment.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault42.md b/docs/InlineResponseDefault42.md new file mode 100644 index 0000000..8b508a5 --- /dev/null +++ b/docs/InlineResponseDefault42.md @@ -0,0 +1,16 @@ +# InlineResponseDefault42 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[Payment]**](Payment.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault43.md b/docs/InlineResponseDefault43.md new file mode 100644 index 0000000..e50aeb1 --- /dev/null +++ b/docs/InlineResponseDefault43.md @@ -0,0 +1,10 @@ +# InlineResponseDefault43 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[PaymentRefundResponse]**](PaymentRefundResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault44.md b/docs/InlineResponseDefault44.md new file mode 100644 index 0000000..72168ca --- /dev/null +++ b/docs/InlineResponseDefault44.md @@ -0,0 +1,16 @@ +# InlineResponseDefault44 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[BFPermission]**](BFPermission.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault45.md b/docs/InlineResponseDefault45.md new file mode 100644 index 0000000..abfffff --- /dev/null +++ b/docs/InlineResponseDefault45.md @@ -0,0 +1,10 @@ +# InlineResponseDefault45 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[BFPermission]**](BFPermission.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault46.md b/docs/InlineResponseDefault46.md new file mode 100644 index 0000000..9c492fd --- /dev/null +++ b/docs/InlineResponseDefault46.md @@ -0,0 +1,10 @@ +# InlineResponseDefault46 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[PermissionActionEntity]**](PermissionActionEntity.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault47.md b/docs/InlineResponseDefault47.md new file mode 100644 index 0000000..d8d1997 --- /dev/null +++ b/docs/InlineResponseDefault47.md @@ -0,0 +1,10 @@ +# InlineResponseDefault47 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[PermissionResourceEntity]**](PermissionResourceEntity.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault48.md b/docs/InlineResponseDefault48.md new file mode 100644 index 0000000..eb2827e --- /dev/null +++ b/docs/InlineResponseDefault48.md @@ -0,0 +1,16 @@ +# InlineResponseDefault48 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[GetRatePlanAffiliateResponse]**](GetRatePlanAffiliateResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault49.md b/docs/InlineResponseDefault49.md new file mode 100644 index 0000000..d04b1c5 --- /dev/null +++ b/docs/InlineResponseDefault49.md @@ -0,0 +1,10 @@ +# InlineResponseDefault49 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[GetRatePlanAffiliateResponse]**](GetRatePlanAffiliateResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault5.md b/docs/InlineResponseDefault5.md new file mode 100644 index 0000000..be705c9 --- /dev/null +++ b/docs/InlineResponseDefault5.md @@ -0,0 +1,16 @@ +# InlineResponseDefault5 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[Account]**](Account.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault50.md b/docs/InlineResponseDefault50.md new file mode 100644 index 0000000..cd7ec0f --- /dev/null +++ b/docs/InlineResponseDefault50.md @@ -0,0 +1,10 @@ +# InlineResponseDefault50 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[SubscriptionCheckoutResponse]**](SubscriptionCheckoutResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault51.md b/docs/InlineResponseDefault51.md new file mode 100644 index 0000000..ed658bf --- /dev/null +++ b/docs/InlineResponseDefault51.md @@ -0,0 +1,10 @@ +# InlineResponseDefault51 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Subscription]**](Subscription.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault52.md b/docs/InlineResponseDefault52.md new file mode 100644 index 0000000..d9bdbb7 --- /dev/null +++ b/docs/InlineResponseDefault52.md @@ -0,0 +1,16 @@ +# InlineResponseDefault52 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[ApiQuote]**](ApiQuote.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault53.md b/docs/InlineResponseDefault53.md new file mode 100644 index 0000000..f6f3748 --- /dev/null +++ b/docs/InlineResponseDefault53.md @@ -0,0 +1,10 @@ +# InlineResponseDefault53 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[ApiQuote]**](ApiQuote.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault54.md b/docs/InlineResponseDefault54.md new file mode 100644 index 0000000..d505af6 --- /dev/null +++ b/docs/InlineResponseDefault54.md @@ -0,0 +1,16 @@ +# InlineResponseDefault54 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[Receipt]**](Receipt.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault55.md b/docs/InlineResponseDefault55.md new file mode 100644 index 0000000..18e66f0 --- /dev/null +++ b/docs/InlineResponseDefault55.md @@ -0,0 +1,10 @@ +# InlineResponseDefault55 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Receipt]**](Receipt.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault56.md b/docs/InlineResponseDefault56.md new file mode 100644 index 0000000..28eaa0c --- /dev/null +++ b/docs/InlineResponseDefault56.md @@ -0,0 +1,16 @@ +# InlineResponseDefault56 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[Role]**](Role.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault57.md b/docs/InlineResponseDefault57.md new file mode 100644 index 0000000..f294d59 --- /dev/null +++ b/docs/InlineResponseDefault57.md @@ -0,0 +1,10 @@ +# InlineResponseDefault57 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Role]**](Role.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault58.md b/docs/InlineResponseDefault58.md new file mode 100644 index 0000000..6efae95 --- /dev/null +++ b/docs/InlineResponseDefault58.md @@ -0,0 +1,10 @@ +# InlineResponseDefault58 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[DataSyncJobResponse]**](DataSyncJobResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault59.md b/docs/InlineResponseDefault59.md new file mode 100644 index 0000000..580e962 --- /dev/null +++ b/docs/InlineResponseDefault59.md @@ -0,0 +1,16 @@ +# InlineResponseDefault59 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[DataSyncJobResponse]**](DataSyncJobResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault6.md b/docs/InlineResponseDefault6.md new file mode 100644 index 0000000..945a0cc --- /dev/null +++ b/docs/InlineResponseDefault6.md @@ -0,0 +1,10 @@ +# InlineResponseDefault6 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Account]**](Account.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault60.md b/docs/InlineResponseDefault60.md new file mode 100644 index 0000000..7fe66d9 --- /dev/null +++ b/docs/InlineResponseDefault60.md @@ -0,0 +1,10 @@ +# InlineResponseDefault60 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[SalesforceConfigurationResponse]**](SalesforceConfigurationResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault61.md b/docs/InlineResponseDefault61.md new file mode 100644 index 0000000..cd70e06 --- /dev/null +++ b/docs/InlineResponseDefault61.md @@ -0,0 +1,10 @@ +# InlineResponseDefault61 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[TimeResponse]**](TimeResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault62.md b/docs/InlineResponseDefault62.md new file mode 100644 index 0000000..4c76ffa --- /dev/null +++ b/docs/InlineResponseDefault62.md @@ -0,0 +1,10 @@ +# InlineResponseDefault62 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[UpdatePricingComponentValueResponse]**](UpdatePricingComponentValueResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault63.md b/docs/InlineResponseDefault63.md new file mode 100644 index 0000000..d84bd75 --- /dev/null +++ b/docs/InlineResponseDefault63.md @@ -0,0 +1,10 @@ +# InlineResponseDefault63 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[SubscriptionCancellation]**](SubscriptionCancellation.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault64.md b/docs/InlineResponseDefault64.md new file mode 100644 index 0000000..0bcccfc --- /dev/null +++ b/docs/InlineResponseDefault64.md @@ -0,0 +1,16 @@ +# InlineResponseDefault64 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[Amendment]**](Amendment.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault65.md b/docs/InlineResponseDefault65.md new file mode 100644 index 0000000..a28a996 --- /dev/null +++ b/docs/InlineResponseDefault65.md @@ -0,0 +1,10 @@ +# InlineResponseDefault65 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Amendment]**](Amendment.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault66.md b/docs/InlineResponseDefault66.md new file mode 100644 index 0000000..0dcd232 --- /dev/null +++ b/docs/InlineResponseDefault66.md @@ -0,0 +1,16 @@ +# InlineResponseDefault66 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[GetSubscriptionAffiliateResponse]**](GetSubscriptionAffiliateResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault67.md b/docs/InlineResponseDefault67.md new file mode 100644 index 0000000..8d201b9 --- /dev/null +++ b/docs/InlineResponseDefault67.md @@ -0,0 +1,10 @@ +# InlineResponseDefault67 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[GetSubscriptionAffiliateResponse]**](GetSubscriptionAffiliateResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault68.md b/docs/InlineResponseDefault68.md new file mode 100644 index 0000000..452ee17 --- /dev/null +++ b/docs/InlineResponseDefault68.md @@ -0,0 +1,16 @@ +# InlineResponseDefault68 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[PricingComponentValue]**](PricingComponentValue.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault69.md b/docs/InlineResponseDefault69.md new file mode 100644 index 0000000..c459dd0 --- /dev/null +++ b/docs/InlineResponseDefault69.md @@ -0,0 +1,10 @@ +# InlineResponseDefault69 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[SwaggerTypeListSubs]**](SwaggerTypeListSubs.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault7.md b/docs/InlineResponseDefault7.md new file mode 100644 index 0000000..1407690 --- /dev/null +++ b/docs/InlineResponseDefault7.md @@ -0,0 +1,10 @@ +# InlineResponseDefault7 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[MetadataKeyValues]**](MetadataKeyValues.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault70.md b/docs/InlineResponseDefault70.md new file mode 100644 index 0000000..9c990a5 --- /dev/null +++ b/docs/InlineResponseDefault70.md @@ -0,0 +1,10 @@ +# InlineResponseDefault70 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[MigrationResponse]**](MigrationResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault71.md b/docs/InlineResponseDefault71.md new file mode 100644 index 0000000..4a9ef45 --- /dev/null +++ b/docs/InlineResponseDefault71.md @@ -0,0 +1,10 @@ +# InlineResponseDefault71 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[PricingComponentValueResponse]**](PricingComponentValueResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault72.md b/docs/InlineResponseDefault72.md new file mode 100644 index 0000000..421ccd9 --- /dev/null +++ b/docs/InlineResponseDefault72.md @@ -0,0 +1,10 @@ +# InlineResponseDefault72 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[PricingComponentValue]**](PricingComponentValue.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault73.md b/docs/InlineResponseDefault73.md new file mode 100644 index 0000000..b9af6c5 --- /dev/null +++ b/docs/InlineResponseDefault73.md @@ -0,0 +1,10 @@ +# InlineResponseDefault73 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[StartAllSubscriptionsResponse]**](StartAllSubscriptionsResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault74.md b/docs/InlineResponseDefault74.md new file mode 100644 index 0000000..762a337 --- /dev/null +++ b/docs/InlineResponseDefault74.md @@ -0,0 +1,16 @@ +# InlineResponseDefault74 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[AvataxConfiguration]**](AvataxConfiguration.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault75.md b/docs/InlineResponseDefault75.md new file mode 100644 index 0000000..b0f89c6 --- /dev/null +++ b/docs/InlineResponseDefault75.md @@ -0,0 +1,10 @@ +# InlineResponseDefault75 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[AvataxConfiguration]**](AvataxConfiguration.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault76.md b/docs/InlineResponseDefault76.md new file mode 100644 index 0000000..b0172ad --- /dev/null +++ b/docs/InlineResponseDefault76.md @@ -0,0 +1,10 @@ +# InlineResponseDefault76 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[AvataxPingResponse]**](AvataxPingResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault77.md b/docs/InlineResponseDefault77.md new file mode 100644 index 0000000..43edfd0 --- /dev/null +++ b/docs/InlineResponseDefault77.md @@ -0,0 +1,16 @@ +# InlineResponseDefault77 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[TaxationStrategy]**](TaxationStrategy.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault78.md b/docs/InlineResponseDefault78.md new file mode 100644 index 0000000..f9efb09 --- /dev/null +++ b/docs/InlineResponseDefault78.md @@ -0,0 +1,10 @@ +# InlineResponseDefault78 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[TaxationStrategy]**](TaxationStrategy.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault79.md b/docs/InlineResponseDefault79.md new file mode 100644 index 0000000..a2106ca --- /dev/null +++ b/docs/InlineResponseDefault79.md @@ -0,0 +1,10 @@ +# InlineResponseDefault79 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[EpxPreAuthResponse]**](EpxPreAuthResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault8.md b/docs/InlineResponseDefault8.md new file mode 100644 index 0000000..1b23cd8 --- /dev/null +++ b/docs/InlineResponseDefault8.md @@ -0,0 +1,16 @@ +# InlineResponseDefault8 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[Invoice]**](Invoice.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault80.md b/docs/InlineResponseDefault80.md new file mode 100644 index 0000000..3901b72 --- /dev/null +++ b/docs/InlineResponseDefault80.md @@ -0,0 +1,10 @@ +# InlineResponseDefault80 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[EmailTokenization]**](EmailTokenization.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault81.md b/docs/InlineResponseDefault81.md new file mode 100644 index 0000000..0a6ade5 --- /dev/null +++ b/docs/InlineResponseDefault81.md @@ -0,0 +1,16 @@ +# InlineResponseDefault81 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[EmailTokenization]**](EmailTokenization.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault82.md b/docs/InlineResponseDefault82.md new file mode 100644 index 0000000..74a7185 --- /dev/null +++ b/docs/InlineResponseDefault82.md @@ -0,0 +1,10 @@ +# InlineResponseDefault82 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[TokenizationPreAuth]**](TokenizationPreAuth.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault83.md b/docs/InlineResponseDefault83.md new file mode 100644 index 0000000..8ec9721 --- /dev/null +++ b/docs/InlineResponseDefault83.md @@ -0,0 +1,10 @@ +# InlineResponseDefault83 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Profile]**](Profile.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault84.md b/docs/InlineResponseDefault84.md new file mode 100644 index 0000000..bdc2fc4 --- /dev/null +++ b/docs/InlineResponseDefault84.md @@ -0,0 +1,10 @@ +# InlineResponseDefault84 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[UserCreationResponse]**](UserCreationResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault85.md b/docs/InlineResponseDefault85.md new file mode 100644 index 0000000..19c8935 --- /dev/null +++ b/docs/InlineResponseDefault85.md @@ -0,0 +1,16 @@ +# InlineResponseDefault85 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[SimpleUser]**](SimpleUser.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault86.md b/docs/InlineResponseDefault86.md new file mode 100644 index 0000000..9f5481d --- /dev/null +++ b/docs/InlineResponseDefault86.md @@ -0,0 +1,10 @@ +# InlineResponseDefault86 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[UserResponse]**](UserResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault87.md b/docs/InlineResponseDefault87.md new file mode 100644 index 0000000..4a182ea --- /dev/null +++ b/docs/InlineResponseDefault87.md @@ -0,0 +1,16 @@ +# InlineResponseDefault87 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[OrganizationLiteView]**](OrganizationLiteView.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault88.md b/docs/InlineResponseDefault88.md new file mode 100644 index 0000000..1b7a6b0 --- /dev/null +++ b/docs/InlineResponseDefault88.md @@ -0,0 +1,16 @@ +# InlineResponseDefault88 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[UserResponse]**](UserResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault89.md b/docs/InlineResponseDefault89.md new file mode 100644 index 0000000..ba054bc --- /dev/null +++ b/docs/InlineResponseDefault89.md @@ -0,0 +1,10 @@ +# InlineResponseDefault89 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[OpenIDRegistrationResponse]**](OpenIDRegistrationResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault9.md b/docs/InlineResponseDefault9.md new file mode 100644 index 0000000..ca49c38 --- /dev/null +++ b/docs/InlineResponseDefault9.md @@ -0,0 +1,16 @@ +# InlineResponseDefault9 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[PaymentMethod]**](PaymentMethod.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault90.md b/docs/InlineResponseDefault90.md new file mode 100644 index 0000000..7779fc8 --- /dev/null +++ b/docs/InlineResponseDefault90.md @@ -0,0 +1,10 @@ +# InlineResponseDefault90 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[PasswordResetResponse]**](PasswordResetResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault91.md b/docs/InlineResponseDefault91.md new file mode 100644 index 0000000..99b6ebc --- /dev/null +++ b/docs/InlineResponseDefault91.md @@ -0,0 +1,10 @@ +# InlineResponseDefault91 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Username]**](Username.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault92.md b/docs/InlineResponseDefault92.md new file mode 100644 index 0000000..9f0a28c --- /dev/null +++ b/docs/InlineResponseDefault92.md @@ -0,0 +1,10 @@ +# InlineResponseDefault92 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[UpdatePasswordResponse]**](UpdatePasswordResponse.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault93.md b/docs/InlineResponseDefault93.md new file mode 100644 index 0000000..298be0e --- /dev/null +++ b/docs/InlineResponseDefault93.md @@ -0,0 +1,10 @@ +# InlineResponseDefault93 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[AuthorizeNetToken]**](AuthorizeNetToken.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault94.md b/docs/InlineResponseDefault94.md new file mode 100644 index 0000000..1525695 --- /dev/null +++ b/docs/InlineResponseDefault94.md @@ -0,0 +1,10 @@ +# InlineResponseDefault94 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[BraintreeToken]**](BraintreeToken.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault95.md b/docs/InlineResponseDefault95.md new file mode 100644 index 0000000..1cb9ba9 --- /dev/null +++ b/docs/InlineResponseDefault95.md @@ -0,0 +1,10 @@ +# InlineResponseDefault95 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[StripeAchToken]**](StripeAchToken.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault96.md b/docs/InlineResponseDefault96.md new file mode 100644 index 0000000..95c6328 --- /dev/null +++ b/docs/InlineResponseDefault96.md @@ -0,0 +1,10 @@ +# InlineResponseDefault96 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[StripeToken]**](StripeToken.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault97.md b/docs/InlineResponseDefault97.md new file mode 100644 index 0000000..82b014f --- /dev/null +++ b/docs/InlineResponseDefault97.md @@ -0,0 +1,10 @@ +# InlineResponseDefault97 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[TrustCommerceToken]**](TrustCommerceToken.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault98.md b/docs/InlineResponseDefault98.md new file mode 100644 index 0000000..5298b31 --- /dev/null +++ b/docs/InlineResponseDefault98.md @@ -0,0 +1,16 @@ +# InlineResponseDefault98 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[BraintreeToken]**](BraintreeToken.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InlineResponseDefault99.md b/docs/InlineResponseDefault99.md new file mode 100644 index 0000000..8b0d56e --- /dev/null +++ b/docs/InlineResponseDefault99.md @@ -0,0 +1,16 @@ +# InlineResponseDefault99 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**execution_time** | **int** | | +**results** | [**list[StripeToken]**](StripeToken.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InsertableBillingEntity.md b/docs/InsertableBillingEntity.md deleted file mode 100644 index cf5c384..0000000 --- a/docs/InsertableBillingEntity.md +++ /dev/null @@ -1,23 +0,0 @@ -# InsertableBillingEntity - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**applied** | **datetime** | { \"description\" : \"The UTC DateTime when the pricing-component-value-change was processed.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**pricing_component_id** | **str** | { \"description\" : \"ID of the pricing-component associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**unit_of_measure_id** | **str** | { \"description\" : \"ID of the unit-of-measure associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"ID of the subscription associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**invoice_id** | **str** | { \"description\" : \"ID of the invoice associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"The organizationID.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**new_value** | **int** | { \"description\" : \"The new value of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**old_value** | **int** | { \"description\" : \"The new value of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**mode** | **str** | { \"description\" : \"The value change mode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**state** | **str** | { \"description\" : \"The value change state.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**as_of** | **datetime** | { \"description\" : \"The UTC DateTime when the pricing-component-value-change was calculated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/IntervalDate.md b/docs/IntervalDate.md new file mode 100644 index 0000000..075b3cc --- /dev/null +++ b/docs/IntervalDate.md @@ -0,0 +1,10 @@ +# IntervalDate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **datetime** | | [optional] +**to** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Invoice.md b/docs/Invoice.md index 95cdedf..d2b66e6 100644 --- a/docs/Invoice.md +++ b/docs/Invoice.md @@ -3,54 +3,60 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**version_id** | **str** | { \"description\" : \"Version identifier of the invoice.\", \"verbs\":[\"GET\"] } | [optional] -**id** | **str** | { \"description\" : \"Unique identifier for the invoice.\", \"verbs\":[\"GET\"] } | [optional] -**crm_id** | **str** | { \"description\" : \"CRM identifier of the invoice.\", \"verbs\":[\"PUT\",\"GET\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**subscription_version_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**account_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | -**parent_invoice_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | [optional] -**name** | **str** | { \"description\" : \"The name of the invoice\", \"verbs\":[] } | [optional] -**description** | **str** | { \"description\" : \"The description of the invoice\", \"verbs\":[] } | [optional] -**state** | **str** | { \"description\" : \"Initially an invoice is set as unpaid. Once payment for the full value of the invoice has been received it is marked as paid. An invoice may be paid from various sources including cards, coupons or manual payments.\", \"verbs\":[\"GET\"] } | -**issued** | **datetime** | { \"description\" : \"The UTC DateTime when the invoice was first issued.\", \"verbs\":[\"GET\"] } | [optional] -**period_start** | **datetime** | { \"description\" : \"Start of the period being billed by this invoice, UTC DateTime\", \"verbs\":[\"GET\"] } | [optional] -**period_end** | **datetime** | { \"description\" : \"End of the period being billed by this invoice, UTC DateTime.\", \"verbs\":[\"GET\"] } | [optional] -**due** | **datetime** | { \"description\" : \"Date this invoice is due, UTC DateTime.\", \"verbs\":[\"GET\"] } | [optional] -**deleted** | **bool** | { \"description\" : \"Indicates if an invoice has been retired. If an invoice has been retired it can still be retrieved using the appropriate flag on API requests. Generally invoices will not be retired.\", \"verbs\":[] } | [default to False] -**total_execution_attempts** | **int** | { \"description\" : \"Number of payment attempts for this invoice. This includes any manual execution attempts.\", \"verbs\":[\"GET\"] } | [optional] -**last_execution_attempt** | **datetime** | { \"description\" : \"UTC DateTime of the invoice's last execution attempt. This was the last time an attempt was made to take payment for this invoice.\", \"verbs\":[\"GET\"] } | [optional] -**next_execution_attempt** | **datetime** | { \"description\" : \"UTC DateTime of the invoice's next execution attempt. If the next execution attempt is greater than the period end for this invoice, the invoice will not receive another automatic execution attempt.\", \"verbs\":[\"GET\"] } | [optional] -**final_execution_attempt** | **datetime** | { \"description\" : \"UTC DateTime of the invoice's final execution attempt. The final execution attempt. This may be less than the next execution attempt if the next execution attempt never occurred.\", \"verbs\":[\"GET\"] } | [optional] -**payment_received** | **datetime** | { \"description\" : \"UTC DateTime specifying when payment was received for the invoice.\", \"verbs\":[\"GET\"] } | [optional] -**currency** | **str** | { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } | -**cost_excluding_tax** | **float** | { \"description\" : \"Cost of the invoice exclusive of tax.\", \"verbs\":[\"GET\"] } | -**invoice_cost** | **float** | { \"description\" : \"Cost of the invoice inclusive of tax.\", \"verbs\":[\"GET\"] } | -**non_discounted_cost** | **float** | Cost of the invoice before discounts, inclusive of tax. | -**non_discounted_cost_excluding_tax** | **float** | Cost of the invoice before discounts, inclusive of tax. | -**invoice_paid** | **float** | { \"description\" : \"Total amount of the invoice currently paid for. As the invoice may be paid by multiple payments, for example partly paid for by a voucher and then paid for by a card, this indicates the current paid amount of the invoice.\", \"verbs\":[\"GET\"] } | [optional] -**discount_amount** | **float** | { \"description\" : \"The amount of discounts for the invoice.\", \"verbs\":[\"GET\"] } | [optional] -**discount_amount_excluding_tax** | **float** | { \"description\" : \"The amount of discounts for the invoice excluding tax.\", \"verbs\":[\"GET\"] } | [optional] -**invoice_refunded** | **float** | { \"description\" : \"Total amount of the invoice refunded.\", \"verbs\":[\"GET\"] } | [optional] -**credit_rolled_over** | **float** | { \"description\" : \"The amount of credit to be returned to the pool.\", \"verbs\":[\"GET\"] } | -**credit_rolled_over_excluding_tax** | **float** | { \"description\" : \"The amount of credit to be returned to the pool excluding tax.\", \"verbs\":[\"GET\"] } | [optional] -**type** | **str** | { \"description\" : \"The type of the invoice. A subscription invoice is raised every time a subscription recurs. An amendment is created for intra-contract changes. An Adhoc invoice is created for payment that is taken out-of-band of a subscription. Finally the invoice generated for a trial period is marked as Trial.\", \"verbs\":[\"GET\"] } | -**locked** | **str** | { \"description\" : \"If the subscription is locked, it will not be processed by the system\", \"verbs\":[] } | [optional] -**managed_by** | **str** | { \"description\" : \"Which system is responsible for managing the subscription.\", \"verbs\":[] } | [optional] -**initial_invoice** | **bool** | { \"description\" : \"Is this an initial invoice. An initial invoice is the first invoice generated for a subscription. Initial invoices will not have dunning applied to them and as such will only have a single payment attempt. For trial periods, the trial invoice is the initial invoice.\", \"verbs\":[\"GET\"] } | [default to False] -**version_number** | **int** | { \"description\" : \"The version number of the Invoice. The first version of an Invoice is version number 1\", \"verbs\":[\"GET\"] } | -**invoice_lines** | [**list[InvoiceLine]**](InvoiceLine.md) | { \"description\" : \"The collection of invoice-lines associated with the invoice.\", \"verbs\":[\"GET\"] } | [optional] -**tax_lines** | [**list[InsertableBillingEntity]**](InsertableBillingEntity.md) | | [optional] -**invoice_payments** | [**list[InvoicePayment]**](InvoicePayment.md) | { \"description\" : \"Payments used for this invoice. Multiple payments may be associated with the invoice.\", \"verbs\":[\"GET\"] } | [optional] -**invoice_refunds** | [**list[Refund]**](Refund.md) | { \"description\" : \"Refunds associated with this invoice. Multiple refunds may be associated with the invoice.\", \"verbs\":[\"GET\"] } | [optional] -**invoice_credit_notes** | [**list[CreditNote]**](CreditNote.md) | { \"description\" : \"Credit Notes associated with this invoice. Multiple credit notes may be associated with the invoice.\", \"verbs\":[\"GET\"] } | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**metadata** | **dict(str, object)** | | [optional] +**version_id** | **str** | | [optional] +**id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**subscription_version_id** | **str** | | [optional] +**account_id** | **str** | | +**organization_id** | **str** | | +**parent_invoice_id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**state** | **str** | | +**issued** | **datetime** | | [optional] +**due** | **datetime** | | [optional] +**period_start** | **datetime** | | [optional] +**period_end** | **datetime** | | [optional] +**deleted** | **bool** | | +**total_execution_attempts** | **int** | | [optional] +**last_execution_attempt** | **datetime** | | [optional] +**next_execution_attempt** | **datetime** | | [optional] +**final_execution_attempt** | **datetime** | | [optional] +**payment_received** | **datetime** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | +**cost_excluding_tax** | **float** | | +**invoice_cost** | **float** | | +**non_discounted_cost** | **float** | | [optional] +**non_discounted_cost_excluding_tax** | **float** | | [optional] +**invoice_paid** | **float** | | [optional] +**discount_amount** | **float** | | [optional] +**discount_amount_excluding_tax** | **float** | | [optional] +**invoice_refunded** | **float** | | [optional] +**credit_rolled_over** | **float** | | +**credit_rolled_over_excluding_tax** | **float** | | [optional] +**type** | **str** | | +**locked** | **str** | | [optional] +**managed_by** | **str** | | [optional] +**initial_invoice** | **bool** | | +**processing** | **bool** | | +**purchase_order** | **str** | | [optional] +**version_number** | **int** | | +**invoice_lines** | [**list[InvoiceLines]**](InvoiceLines.md) | | [optional] +**tax_lines** | [**list[TaxLine]**](TaxLine.md) | | [optional] +**invoice_payments** | [**list[InvoicePayments]**](InvoicePayments.md) | | [optional] +**invoice_refunds** | [**list[Refund]**](Refund.md) | | [optional] +**invoice_credit_notes** | [**list[CreditNote]**](CreditNote.md) | | [optional] **charges** | [**list[SubscriptionCharge]**](SubscriptionCharge.md) | | [optional] +**payment_terms** | **int** | | [optional] **children** | [**list[Invoice]**](Invoice.md) | | [optional] +**executions** | [**list[ExecutionReceiptResponse]**](ExecutionReceiptResponse.md) | | [optional] +**total_invoice_cost** | **float** | | [optional] +**zero_cost** | **bool** | | [optional] +**c_rmid** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InvoiceChargeRequest.md b/docs/InvoiceChargeRequest.md index f631b82..48ce1bf 100644 --- a/docs/InvoiceChargeRequest.md +++ b/docs/InvoiceChargeRequest.md @@ -3,11 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**include_aggregated** | **bool** | {\"default\":false,\"description\":\"Outstanding charges for which invoices will be generated:<br><span class=\\\"label label-default\\\">true</span> &mdash; Include charges marked with 'Aggregated' `invoicingType` (i.e. charges that would otherwise be included anyway in the next naturally-occurring invoice)<br><span class=\\\"label label-default\\\">false</span> &mdash; Exclude charges marked with 'Aggregated' `invoicingType` (i.e. prefer that these charges be included instead on the next naturally-occurring invoice).\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**include_invoiced_charges_only** | **bool** | {\"default\":false,\"description\":\"Outstanding charges for which invoices will be generated:<br><span class=\\\"label label-default\\\">true</span> &mdash; Include those charges raised with 'no invoice' specified (i.e. charges against the subscription) &mdash; as well as charges raised against some specific invoice.<br><span class=\\\"label label-default\\\">false</span> &mdash; Include only charges raised against some specific invoice.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**invoice_state** | **str** | {\"default\":null (invoice is raised in its default initial state),\"description\":\"Initial state with which any invoices will be generated.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**include_aggregated** | **bool** | | [optional] +**include_invoiced_charges_only** | **bool** | | [optional] +**invoice_state** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InvoiceExecutionRequest.md b/docs/InvoiceExecutionRequest.md new file mode 100644 index 0000000..3221d93 --- /dev/null +++ b/docs/InvoiceExecutionRequest.md @@ -0,0 +1,14 @@ +# InvoiceExecutionRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**payment_amount** | **float** | | [optional] +**force_paid** | **bool** | | +**force_paid_reason** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**payment_method_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InvoiceLine.md b/docs/InvoiceLine.md deleted file mode 100644 index 6f6f10d..0000000 --- a/docs/InvoiceLine.md +++ /dev/null @@ -1,40 +0,0 @@ -# InvoiceLine - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**unit_of_measure** | [**UnitOfMeasure**](UnitOfMeasure.md) | { \"description\" : \"The unit-of-measure associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**pricing_component_type** | **str** | { \"description\" : \"The type of the pricing component associated with the invoice line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**charge_type** | **str** | { \"description\" : \"charge-type.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**period_start** | **datetime** | The period start of the charge. | -**period_end** | **datetime** | The period end of the charge. | -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**invoice_id** | **str** | { \"description\" : \"invoice associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**unit_of_measure_id** | **str** | { \"description\" : \"unit-of-measure associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"the subscription ID associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**product_rate_plan_id** | **str** | { \"description\" : \"the product rate plan ID associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**public_product_rate_plan_name** | **str** | { \"description\" : \"the public product rate plan name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**product_rate_plan_name** | **str** | { \"description\" : \"the product rate plan name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**product_id** | **str** | { \"description\" : \"the product ID associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**public_product_name** | **str** | { \"description\" : \"the public product name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**product_name** | **str** | { \"description\" : \"the product name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**name** | **str** | { \"description\" : \"The human readable name of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**description** | **str** | { \"description\" : \"The human readable description of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**calculation** | **str** | { \"description\" : \"A human readable explanation of how the value of the invoice-line was calculated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**cost** | **float** | { \"description\" : \"The cost of the invoice-line including tax.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**tax** | **float** | { \"description\" : \"The cumulative tax of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**component_value** | **int** | { \"description\" : \"The component value for the unit-of-measure that is associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**pricing_component_id** | **str** | The ID of the pricing-component that is associated with the invoice-line. | -**public_pricing_component_name** | **str** | The public name of the pricing-component that is associated with the invoice-line. | -**pricing_component_name** | **str** | The name of the pricing-component that is associated with the invoice-line. | -**subscription_charge_id** | **str** | The ID of the subscription-charge that is associated with the invoice-line. | -**child_invoice_id** | **str** | The ID of the invoice that is associated with the invoice-line. | -**type** | **str** | The type of the invoice-line. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvoiceLinePayment.md b/docs/InvoiceLinePayment.md deleted file mode 100644 index 2a978d0..0000000 --- a/docs/InvoiceLinePayment.md +++ /dev/null @@ -1,38 +0,0 @@ -# InvoiceLinePayment - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**period_start** | **datetime** | {\"description\":\"PeriodStart of the charge with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**period_end** | **datetime** | {\"description\":\"PeriodEnd of the charge with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**payment_received** | **datetime** | {\"description\":\"The date when the associated payment was received.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**refund_received** | **datetime** | {\"description\":\"The date when the associated payment was refunded.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**id** | **str** | {\"description\":\"ID of the InvoiceLinePayment.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**organization_id** | **str** | {\"description\":\"ID of the organization associated with the InvoiceLinePayment.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**payment_id** | **str** | {\"description\":\"ID of the Payment used upon this InvoiceLinePayment's invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**gateway_original_payment_reference** | **str** | {\"description\":\"Reference with which the original payment transaction can be looked up in its gateway.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**gateway_refund_payment_reference** | **str** | {\"description\":\"Reference with which the refund transaction for the payment can be looked up in its gateway.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**aggregated_invoice_id** | **str** | {\"description\":\"ID of the invoice to which this InvoiceLinePayment's invoice line belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**aggregated_invoice_line_id** | **str** | {\"description\":\"ID of the invoice line toward which this InvoiceLinePayment contributes payment.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**invoice_payment_id** | **str** | {\"description\":\"ID of the InvoicePayment with which this InvoiceLinePayment is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**currency** | **str** | {\"description\":\"The currency of the payment &mdash; specified by a three-character ISO 4217 currency code.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**gateway** | **str** | {\"description\":\"Payment gateway through which the payment was made.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**nominal_amount** | **float** | {\"description\":\"The amount paid &mdash; through credit or otherwise &mdash; toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**actual_amount** | **float** | {\"description\":\"The amount paid &mdash; through real money &mdash; toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**refunded_amount** | **float** | {\"description\":\"The monetary amount refunded toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**pricing_component_id** | **str** | {\"description\":\"ID of the PricingComponent with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**pricing_component_name** | **str** | {\"description\":\"Name of the PricingComponent with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**product_rate_plan_id** | **str** | {\"description\":\"ID of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**product_rate_plan_name** | **str** | {\"description\":\"Internal name of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**product_rate_plan_name_public** | **str** | {\"description\":\"Public name of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**product_id** | **str** | {\"description\":\"ID of the Product with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**product_name** | **str** | {\"description\":\"Internal name of the Product with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**product_name_public** | **str** | {\"description\":\"Public name of the Product with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**subscription_id** | **str** | {\"description\":\"ID of the Subscription with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**account_id** | **str** | {\"description\":\"ID of the Account with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvoiceLinePaymentPagedMetadata.md b/docs/InvoiceLinePaymentPagedMetadata.md deleted file mode 100644 index 7f35490..0000000 --- a/docs/InvoiceLinePaymentPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# InvoiceLinePaymentPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[InvoiceLinePayment]**](InvoiceLinePayment.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvoiceLinePayments.md b/docs/InvoiceLinePayments.md new file mode 100644 index 0000000..0450747 --- /dev/null +++ b/docs/InvoiceLinePayments.md @@ -0,0 +1,44 @@ +# InvoiceLinePayments + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | +**payment_id** | **str** | | +**gateway_original_payment_reference** | **str** | | [optional] +**gateway_refund_payment_reference** | **str** | | [optional] +**paid_invoice_version_id** | **str** | | +**invoice_id** | **str** | | [optional] +**child_invoice_line_id** | **str** | | [optional] +**invoice_payment_id** | **str** | | +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | +**gateway** | **str** | | +**nominal_amount** | **float** | | +**actual_amount** | **float** | | +**refunded_amount** | **float** | | +**pricing_component_id** | **str** | | [optional] +**pricing_component_name** | **str** | | [optional] +**product_rate_plan_id** | **str** | | [optional] +**product_rate_plan_name** | **str** | | [optional] +**product_rate_plan_name_public** | **str** | | [optional] +**product_id** | **str** | | [optional] +**product_name** | **str** | | [optional] +**product_name_public** | **str** | | [optional] +**child_subscription_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**period_start** | **datetime** | | +**period_end** | **datetime** | | +**payment_received** | **datetime** | | +**refund_received** | **datetime** | | +**pricing_component_charge_type** | **str** | | [optional] +**debit_quantity** | **int** | | [optional] +**province** | **str** | | [optional] +**country** | **str** | | [optional] +**manual_charge_name** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InvoiceLines.md b/docs/InvoiceLines.md new file mode 100644 index 0000000..2376340 --- /dev/null +++ b/docs/InvoiceLines.md @@ -0,0 +1,43 @@ +# InvoiceLines + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**invoice_id** | **str** | | +**unit_of_measure_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**product_rate_plan_id** | **str** | | [optional] +**public_product_rate_plan_name** | **str** | | [optional] +**product_rate_plan_name** | **str** | | [optional] +**product_id** | **str** | | [optional] +**public_product_name** | **str** | | [optional] +**product_name** | **str** | | [optional] +**percentage_of_original** | **float** | | [optional] +**organization_id** | **str** | | +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**calculation** | **str** | | +**group_name** | **str** | | [optional] +**cost** | **float** | | +**tax** | **float** | | +**component_value** | **int** | | [optional] +**quantity_label** | **str** | | [optional] +**pricing_component_id** | **str** | | [optional] +**public_pricing_component_name** | **str** | | [optional] +**pricing_component_name** | **str** | | [optional] +**subscription_charge_id** | **str** | | [optional] +**child_invoice_id** | **str** | | [optional] +**type** | **str** | | [optional] +**pricing_component_type** | **str** | | +**charge_type** | **str** | | +**period_start** | **datetime** | | +**period_end** | **datetime** | | +**linked_charge_id** | **str** | | [optional] +**discount** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InvoiceNextExecutionAttemptAmendment.md b/docs/InvoiceNextExecutionAttemptAmendment.md index 318daa7..8e7cfba 100644 --- a/docs/InvoiceNextExecutionAttemptAmendment.md +++ b/docs/InvoiceNextExecutionAttemptAmendment.md @@ -3,21 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] -**invoice_id** | **str** | { \"description\" : \"ID of the Invoice to which the amendment pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**force_paid** | **bool** | { \"description\" : \"Create an offline payment and force the invoice into the paid state.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] +**invoice_id** | **str** | | +**force_paid** | **bool** | | [optional] +**force_paid_reason** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InvoiceOutstandingChargesAmendment.md b/docs/InvoiceOutstandingChargesAmendment.md index 3981ae0..ff2e591 100644 --- a/docs/InvoiceOutstandingChargesAmendment.md +++ b/docs/InvoiceOutstandingChargesAmendment.md @@ -3,20 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] -**invoice_id** | **str** | { \"description\" : \"ID of the Invoice with which the amendment is associated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | +**invoice_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InvoicePagedMetadata.md b/docs/InvoicePagedMetadata.md deleted file mode 100644 index 7ce17cb..0000000 --- a/docs/InvoicePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# InvoicePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Invoice]**](Invoice.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvoicePayment.md b/docs/InvoicePayment.md deleted file mode 100644 index b797aed..0000000 --- a/docs/InvoicePayment.md +++ /dev/null @@ -1,24 +0,0 @@ -# InvoicePayment - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payment_received** | **datetime** | {\"description\":\"The date when the associated payment was received.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**refund_received** | **datetime** | {\"description\":\"The date when the associated payment was refunded.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the payment-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**crm_id** | **str** | { \"description\" : \"CRM ID of the invoice.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**payment_id** | **str** | { \"description\" : \"ID of the payment used.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**invoice_id** | **str** | { \"description\" : \"ID of the invoice associated with the payment-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the invoice-payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**currency** | **str** | { \"description\" : \"The currency of the payment specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**gateway** | **str** | Payment gateway associated with the payment | -**nominal_amount** | **float** | { \"description\" : \"The value that this payment-line represents.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**actual_amount** | **float** | { \"description\" : \"The value of the payment used by payment-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**refunded_amount** | **float** | { \"description\" : \"The refunded amount of the invoice-payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvoicePayments.md b/docs/InvoicePayments.md new file mode 100644 index 0000000..cc7fd2c --- /dev/null +++ b/docs/InvoicePayments.md @@ -0,0 +1,23 @@ +# InvoicePayments + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**crm_id** | **str** | | [optional] +**payment_id** | **str** | | +**invoice_id** | **str** | | +**organization_id** | **str** | | +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | +**gateway** | **str** | | [optional] +**nominal_amount** | **float** | | +**actual_amount** | **float** | | +**refunded_amount** | **float** | | +**payment_received** | **datetime** | | +**refund_received** | **datetime** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InvoiceRecalculationAmendment.md b/docs/InvoiceRecalculationAmendment.md index 9a41c3f..a1c7718 100644 --- a/docs/InvoiceRecalculationAmendment.md +++ b/docs/InvoiceRecalculationAmendment.md @@ -3,23 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] -**invoice_id** | **str** | { \"description\" : \"Identifier of the invoice to recalcaulte\", \"verbs\":[\"POST\",\"GET\"] } | -**recalculation_behaviour** | **str** | { \"description\" : \"The recalculation behaviour of the invoice\", \"default\" : \"RecalculateAsLatestSubscriptionVersion\", \"verbs\":[\"POST\",\"GET\"] } | -**new_invoice_state** | **str** | { \"description\" : \"State of invoice once recalculated\", \"default\" : \"Pending\", \"verbs\":[\"POST\",\"GET\"] } | -**include_invoiced_charges_only** | **bool** | { \"description\" : \"Only include charges which are already linked to the invoice being recalculated\", \"default\" : \"Pending\", \"verbs\":[\"POST\",\"GET\"] } | [default to False] +**invoice_id** | **str** | | +**recalculation_behaviour** | **str** | | +**new_invoice_state** | **str** | | +**include_invoiced_charges_only** | **bool** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InvoiceRecalculationRequest.md b/docs/InvoiceRecalculationRequest.md index 62d13ed..40b5609 100644 --- a/docs/InvoiceRecalculationRequest.md +++ b/docs/InvoiceRecalculationRequest.md @@ -3,12 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**recalculation_behaviour** | **str** | {\"default\":\"RecalculateAsLatestSubscriptionVersion\",\"description\":\"On plan change a subscription may have outstanding invoices.If the value of the invoice needs to be changed it can either be calculated via the new or old plan. <span class=\\\"label label-default\\\">RecalculateAsLatestSubscriptionVersion</span> calculates as the original plan and <span class=\\\"label label-default\\\">RecalculateAsCurrentSubscriptionVersion</span> as the new plan\"verbs\":[\"POST\",\"GET\"]} | -**new_state** | **str** | {\"default\":\"Pending\",\"description\":\"State of the invoice once recalculated\",\"verbs\":[\"POST\",\"GET\"]} | -**only_invoice_associated_charges** | **bool** | {\"default\":true,\"description\":\"Only include charges which are already associated with the invoice. For example the subscription may have pending charges which can be added to the invoice on recalculation by setting this value to false. Note settings this value to true may cause new invoice line itemsto the invoice\",\"verbs\":[\"POST\",\"GET\"]} | [default to False] -**dry_run** | **bool** | {\"default\":\"false\",\"description\":\"Calculate the invoice but do not store or attempt payment\",\"verbs\":[\"POST\",\"GET\"]} | [default to False] +**created** | **datetime** | | [optional] +**recalculation_behaviour** | **str** | | +**new_state** | **str** | | +**only_invoice_associated_charges** | **bool** | | +**recalculate_parent** | **bool** | | +**apply_coupons** | **bool** | | +**dry_run** | **bool** | | +**organization_id** | **str** | | [optional] +**invoice_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InvoiceRefundRequest.md b/docs/InvoiceRefundRequest.md new file mode 100644 index 0000000..39ce621 --- /dev/null +++ b/docs/InvoiceRefundRequest.md @@ -0,0 +1,12 @@ +# InvoiceRefundRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**reason** | **str** | | [optional] +**amount** | **float** | | [optional] +**virtual_refund_gateway_types** | **list[str]** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InvoiceRefundResponse.md b/docs/InvoiceRefundResponse.md new file mode 100644 index 0000000..b4aa2a0 --- /dev/null +++ b/docs/InvoiceRefundResponse.md @@ -0,0 +1,15 @@ +# InvoiceRefundResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**invoice** | [**Invoice**](Invoice.md) | | [optional] +**refunds** | [**list[Refund]**](Refund.md) | | [optional] +**organization_id** | **str** | | [optional] +**requested_amount** | **float** | | [optional] +**refunded_amount** | **float** | | [optional] +**amount_left_to_refund** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InvoiceSplit.md b/docs/InvoiceSplit.md new file mode 100644 index 0000000..c9db485 --- /dev/null +++ b/docs/InvoiceSplit.md @@ -0,0 +1,13 @@ +# InvoiceSplit + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**percentage** | **float** | | [optional] +**value** | **float** | | [optional] +**due_date** | **datetime** | | [optional] +**description** | **str** | | [optional] +**purchase_order** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InvoiceSplitServiceRequest.md b/docs/InvoiceSplitServiceRequest.md new file mode 100644 index 0000000..c666c24 --- /dev/null +++ b/docs/InvoiceSplitServiceRequest.md @@ -0,0 +1,12 @@ +# InvoiceSplitServiceRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requests** | [**list[InvoiceSplit]**](InvoiceSplit.md) | | [optional] +**organization_id** | **str** | | [optional] +**invoice_state** | **str** | | [optional] +**invoice_execution_time** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InvoiceTemplateConfigResponse.md b/docs/InvoiceTemplateConfigResponse.md new file mode 100644 index 0000000..a1538b0 --- /dev/null +++ b/docs/InvoiceTemplateConfigResponse.md @@ -0,0 +1,22 @@ +# InvoiceTemplateConfigResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**representing_account_id** | **str** | | [optional] +**tier_breakdown** | **bool** | | [optional] +**inclusive_end** | **bool** | | [optional] +**show_zero_cost** | **bool** | | [optional] +**show_plan_only_when_ambiguous** | **bool** | | [optional] +**include_footer** | **bool** | | [optional] +**invoice_header_display** | **str** | | [optional] +**group_invoice_line_items_by** | **str** | | [optional] +**hide_tax_if_zero** | **bool** | | [optional] +**show_unit_price** | **str** | | [optional] +**company_address_on_top** | **bool** | | [optional] +**upgrade_duration_wording** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/InvoicesApi.md b/docs/InvoicesApi.md index 8fadda0..187a36d 100644 --- a/docs/InvoicesApi.md +++ b/docs/InvoicesApi.md @@ -1,95 +1,100 @@ # billforward.InvoicesApi -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**add_charge_to_invoice**](InvoicesApi.md#add_charge_to_invoice) | **POST** /invoices/{invoice-ID}/charges | Creates a charge on the specified invoice. -[**aggregate_invoices**](InvoicesApi.md#aggregate_invoices) | **POST** /invoices/aggregate | Aggregate Invoices into to one parent Invoice -[**execute_invoice**](InvoicesApi.md#execute_invoice) | **POST** /invoices/{invoice-ID}/execute | Attempt payment for the outstanding value of an invoice -[**generate_line_payments_for_all_invoices**](InvoicesApi.md#generate_line_payments_for_all_invoices) | **POST** /invoices/generate-line-payments | Generates InvoiceLinePayments for all existing InvoicePayments. -[**get_all_invoices**](InvoicesApi.md#get_all_invoices) | **GET** /invoices | Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. -[**get_all_invoices_as_csv**](InvoicesApi.md#get_all_invoices_as_csv) | **GET** /invoices/all.csv | Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. -[**get_bucketed_revenue_attributions_as_csv**](InvoicesApi.md#get_bucketed_revenue_attributions_as_csv) | **GET** /invoices/bucketed-revenue-attributions.csv | Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed. -[**get_charges_on_invoice**](InvoicesApi.md#get_charges_on_invoice) | **GET** /invoices/{invoice-ID}/charges | Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order. -[**get_credit_invoice_line_payments_from_invoices_as_csv**](InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/credit.csv | Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. -[**get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/credit.csv | Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. -[**get_debit_invoice_line_payments_from_invoices_as_csv**](InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/revenue.csv | Retrieves received revenue from InvoicePayments upon line items, in CSV format. -[**get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/revenue.csv | Retrieves received revenue from InvoicePayments upon line items, in CSV format. -[**get_invoice_as_html**](InvoicesApi.md#get_invoice_as_html) | **GET** /invoices/{ID}.html | Retrieves a single invoice specified by the ID parameter. -[**get_invoice_as_pdf**](InvoicesApi.md#get_invoice_as_pdf) | **GET** /invoices/{ID}.pdf | Retrieves a single invoice specified by the ID parameter. -[**get_invoice_by_id**](InvoicesApi.md#get_invoice_by_id) | **GET** /invoices/{invoice-ID} | Retrieves a single invoice specified by the invoice-ID parameter. -[**get_invoice_by_id_as_csv**](InvoicesApi.md#get_invoice_by_id_as_csv) | **GET** /invoices/{ID}.csv | Retrieves a single invoice specified by the ID parameter. -[**get_invoice_by_subscription_id**](InvoicesApi.md#get_invoice_by_subscription_id) | **GET** /invoices/subscription/{subscription-ID} | Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_invoice_by_subscription_version_id**](InvoicesApi.md#get_invoice_by_subscription_version_id) | **GET** /invoices/subscription/version/{subscription-version-ID} | Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_invoice_by_version_id**](InvoicesApi.md#get_invoice_by_version_id) | **GET** /invoices/version/{version-ID} | Retrieves a single invoice, specified by the version-ID parameter. -[**get_invoices_by_account_id**](InvoicesApi.md#get_invoices_by_account_id) | **GET** /invoices/account/{account-ID} | Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_invoices_by_period_end**](InvoicesApi.md#get_invoices_by_period_end) | **GET** /invoices/period-end/{lower-threshold}/{upper-threshold} | Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**get_invoices_by_period_start**](InvoicesApi.md#get_invoices_by_period_start) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**get_invoices_by_period_start_as_csv**](InvoicesApi.md#get_invoices_by_period_start_as_csv) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold}.csv | Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**get_invoices_by_state**](InvoicesApi.md#get_invoices_by_state) | **GET** /invoices/state/{state} | Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -[**get_invoices_by_state_and_period_start**](InvoicesApi.md#get_invoices_by_state_and_period_start) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**get_invoices_by_state_and_period_start_as_csv**](InvoicesApi.md#get_invoices_by_state_and_period_start_as_csv) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}.csv | Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**get_invoices_by_state_as_csv**](InvoicesApi.md#get_invoices_by_state_as_csv) | **GET** /invoices/state/{state}.csv | Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -[**get_line_payments**](InvoicesApi.md#get_line_payments) | **GET** /invoices/line-payments | Retrieves all InvoiceLine payment attributions. -[**get_line_payments_as_csv**](InvoicesApi.md#get_line_payments_as_csv) | **GET** /invoices/line-payments.csv | Retrieves (as CSV) all InvoiceLine payment attributions. -[**get_metadata_for_invoice**](InvoicesApi.md#get_metadata_for_invoice) | **GET** /invoices/{invoice-ID}/metadata | Retrieve any associated metadata. -[**get_refund_invoice_line_payments_from_invoices_as_csv**](InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/refund.csv | Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. -[**get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received**](InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received) | **GET** /invoices/payment-received/refund.csv | Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. -[**get_revenue_attributions**](InvoicesApi.md#get_revenue_attributions) | **GET** /invoices/revenue-attributions | Retrieves all attributions of Invoice costs to Invoice lines. -[**get_revenue_attributions_as_csv**](InvoicesApi.md#get_revenue_attributions_as_csv) | **GET** /invoices/revenue-attributions.csv | Retrieves (as CSV) all attributions of Invoice costs to Invoice lines. +[**add_charge_to_invoice**](InvoicesApi.md#add_charge_to_invoice) | **POST** /invoices/{invoice-ID}/charges | +[**execute_invoice**](InvoicesApi.md#execute_invoice) | **POST** /invoices/{invoice-ID}/execute | +[**get_all_invoices**](InvoicesApi.md#get_all_invoices) | **GET** /invoices | +[**get_all_invoices_as_csv**](InvoicesApi.md#get_all_invoices_as_csv) | **GET** /invoices/all.csv | +[**get_bucketed_revenue_attributions_as_csv**](InvoicesApi.md#get_bucketed_revenue_attributions_as_csv) | **GET** /invoices/bucketed-revenue-attributions.csv | +[**get_charges_on_invoice**](InvoicesApi.md#get_charges_on_invoice) | **GET** /invoices/{invoice-ID}/charges | +[**get_credit_invoice_line_payments_from_invoices_as_csv**](InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/credit.csv | +[**get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/credit.csv | +[**get_debit_invoice_line_payments_from_invoices_as_csv**](InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/revenue.csv | +[**get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/revenue.csv | +[**get_hosted_payments**](InvoicesApi.md#get_hosted_payments) | **GET** /invoices/{invoiceID}/hosted-payments | +[**get_invoice_as_html**](InvoicesApi.md#get_invoice_as_html) | **GET** /invoices/{ID}.html | +[**get_invoice_as_pdf**](InvoicesApi.md#get_invoice_as_pdf) | **GET** /invoices/{id}.pdf | +[**get_invoice_by_id**](InvoicesApi.md#get_invoice_by_id) | **GET** /invoices/{invoice-ID} | +[**get_invoice_by_id_as_csv**](InvoicesApi.md#get_invoice_by_id_as_csv) | **GET** /invoices/{ID}.csv | +[**get_invoice_by_subscription_id**](InvoicesApi.md#get_invoice_by_subscription_id) | **GET** /invoices/subscription/{subscription-ID} | +[**get_invoice_by_subscription_version_id**](InvoicesApi.md#get_invoice_by_subscription_version_id) | **GET** /invoices/subscription/version/{subscription-version-ID} | +[**get_invoice_by_version_id**](InvoicesApi.md#get_invoice_by_version_id) | **GET** /invoices/version/{version-ID} | +[**get_invoice_template**](InvoicesApi.md#get_invoice_template) | **GET** /invoices/template | +[**get_invoices_by_account_id1**](InvoicesApi.md#get_invoices_by_account_id1) | **GET** /invoices/account/{account-ID} | +[**get_invoices_by_period_end**](InvoicesApi.md#get_invoices_by_period_end) | **GET** /invoices/period-end/{lower-threshold}/{upper-threshold} | +[**get_invoices_by_period_start**](InvoicesApi.md#get_invoices_by_period_start) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold} | +[**get_invoices_by_period_start_as_csv**](InvoicesApi.md#get_invoices_by_period_start_as_csv) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold}.csv | +[**get_invoices_by_state**](InvoicesApi.md#get_invoices_by_state) | **GET** /invoices/state/{state} | +[**get_invoices_by_state_and_period_start**](InvoicesApi.md#get_invoices_by_state_and_period_start) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold} | +[**get_invoices_by_state_and_period_start_as_csv**](InvoicesApi.md#get_invoices_by_state_and_period_start_as_csv) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}.csv | +[**get_invoices_by_state_as_csv**](InvoicesApi.md#get_invoices_by_state_as_csv) | **GET** /invoices/state/{state}.csv | +[**get_line_payments**](InvoicesApi.md#get_line_payments) | **GET** /invoices/line-payments | +[**get_line_payments_as_csv**](InvoicesApi.md#get_line_payments_as_csv) | **GET** /invoices/line-payments.csv | +[**get_metadata_for_invoice**](InvoicesApi.md#get_metadata_for_invoice) | **GET** /invoices/{invoice-ID}/metadata | +[**get_refund_for_refunded_invoice**](InvoicesApi.md#get_refund_for_refunded_invoice) | **GET** /invoices/{invoice-ID}/refunds | +[**get_refund_invoice_line_payments_from_invoices_as_csv**](InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/refund.csv | +[**get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received**](InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received) | **GET** /invoices/payment-received/refund.csv | +[**get_revenue_attributions**](InvoicesApi.md#get_revenue_attributions) | **GET** /invoices/revenue-attributions | +[**get_revenue_attributions_as_csv**](InvoicesApi.md#get_revenue_attributions_as_csv) | **GET** /invoices/revenue-attributions.csv | [**get_swagger_for_invoice**](InvoicesApi.md#get_swagger_for_invoice) | **GET** /invoices/swagger-end-point/{query-string} | -[**import_invoice**](InvoicesApi.md#import_invoice) | **POST** /invoices/import | Import an invoice. -[**recalculate_invoice**](InvoicesApi.md#recalculate_invoice) | **POST** /invoices/{invoice-ID}/recalculate | Re-calculate an Invoice. -[**remove_charge_from_invoice**](InvoicesApi.md#remove_charge_from_invoice) | **DELETE** /invoices/{invoice-ID}/charges/{charge-ID} | Removes the specified charge from the specified Invoice. -[**remove_metadata_from_invoice**](InvoicesApi.md#remove_metadata_from_invoice) | **DELETE** /invoices/{invoice-ID}/metadata | Remove any associated metadata. -[**set_metadata_for_invoice**](InvoicesApi.md#set_metadata_for_invoice) | **POST** /invoices/{invoice-ID}/metadata | Remove any existing metadata keys and create the provided data. -[**update_invoice**](InvoicesApi.md#update_invoice) | **PUT** /invoices | Update an Invoice. -[**upsert_metadata_for_invoice**](InvoicesApi.md#upsert_metadata_for_invoice) | **PUT** /invoices/{invoice-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed. -[**void_invoice**](InvoicesApi.md#void_invoice) | **DELETE** /invoices/{invoice-ID} | Voids the invoice specified by the invoice identifier parameter. - +[**import_invoice**](InvoicesApi.md#import_invoice) | **POST** /invoices/import | +[**issue_invoice**](InvoicesApi.md#issue_invoice) | **PUT** /invoices/{invoice-id}/issue | +[**list_original_invoice**](InvoicesApi.md#list_original_invoice) | **GET** /invoices/{invoice-id}/original | +[**list_split_invoice**](InvoicesApi.md#list_split_invoice) | **GET** /invoices/{invoice-id}/split | +[**recalculate_invoice**](InvoicesApi.md#recalculate_invoice) | **POST** /invoices/{invoice-ID}/recalculate | +[**refund_invoice**](InvoicesApi.md#refund_invoice) | **POST** /invoices/{invoice-id}/refund | +[**remove_charge_from_invoice**](InvoicesApi.md#remove_charge_from_invoice) | **DELETE** /invoices/{invoice-ID}/charges/{charge-ID} | +[**remove_metadata_from_invoice**](InvoicesApi.md#remove_metadata_from_invoice) | **DELETE** /invoices/{invoice-ID}/metadata | +[**set_metadata_for_invoice**](InvoicesApi.md#set_metadata_for_invoice) | **POST** /invoices/{invoice-ID}/metadata | +[**split_invoice**](InvoicesApi.md#split_invoice) | **POST** /invoices/{invoice-id}/split | +[**update_invoice**](InvoicesApi.md#update_invoice) | **PUT** /invoices | +[**update_invoice_template**](InvoicesApi.md#update_invoice_template) | **PUT** /invoices/template | +[**upsert_metadata_for_invoice**](InvoicesApi.md#upsert_metadata_for_invoice) | **PUT** /invoices/{invoice-ID}/metadata | +[**void_invoice**](InvoicesApi.md#void_invoice) | **DELETE** /invoices/{invoice-ID} | # **add_charge_to_invoice** -> SubscriptionChargePagedMetadata add_charge_to_invoice(invoice_id, charge) +> InlineResponseDefault28 add_charge_to_invoice(invoice_id, body=body) -Creates a charge on the specified invoice. -{\"nickname\":\"Add to invoice\",\"response\":\"addChargeToInvoice.html\",\"request\":\"addChargeToInvoiceRequest.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -invoice_id = 'invoice_id_example' # str | ID of the invoice. -charge = billforward.AddChargeRequest() # AddChargeRequest | The charge request +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +body = billforward.AddChargeRequest() # AddChargeRequest | (optional) -try: - # Creates a charge on the specified invoice. - api_response = api_instance.add_charge_to_invoice(invoice_id, charge) +try: + api_response = api_instance.add_charge_to_invoice(invoice_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->add_charge_to_invoice: %s\n" % e + print("Exception when calling InvoicesApi->add_charge_to_invoice: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **invoice_id** | **str**| ID of the invoice. | - **charge** | [**AddChargeRequest**](AddChargeRequest.md)| The charge request | + **invoice_id** | **str**| | + **body** | [**AddChargeRequest**](AddChargeRequest.md)| | [optional] ### Return type -[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md) +[**InlineResponseDefault28**](InlineResponseDefault28.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -98,45 +103,46 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **aggregate_invoices** -> InvoicePagedMetadata aggregate_invoices(request) +# **execute_invoice** +> InlineResponseDefault29 execute_invoice(invoice_id, body=body) -Aggregate Invoices into to one parent Invoice -{\"nickname\":\"Aggregate invoices\",\"response\":\"AggregateResponse.html\",\"request\":\"AggregateRequest.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -request = billforward.BillingEntityBase() # BillingEntityBase | +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +body = billforward.InvoiceExecutionRequest() # InvoiceExecutionRequest | (optional) -try: - # Aggregate Invoices into to one parent Invoice - api_response = api_instance.aggregate_invoices(request) +try: + api_response = api_instance.execute_invoice(invoice_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->aggregate_invoices: %s\n" % e + print("Exception when calling InvoicesApi->execute_invoice: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **request** | [**BillingEntityBase**](BillingEntityBase.md)| | + **invoice_id** | **str**| | + **body** | [**InvoiceExecutionRequest**](InvoiceExecutionRequest.md)| | [optional] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault29**](InlineResponseDefault29.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -145,263 +151,303 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **execute_invoice** -> InvoicePagedMetadata execute_invoice(invoice_id, request) +# **get_all_invoices** +> InlineResponseDefault8 get_all_invoices(organizations=organizations, state=state, account_id=account_id, subscription_id=subscription_id, subscription_version_id=subscription_version_id, invoice_version_id=invoice_version_id, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children, metadata=metadata) -Attempt payment for the outstanding value of an invoice -{\"nickname\":\"Execute invoice\",\"response\":\"executeInvoiceResponse.html\",\"request\":\"ExecuteInvoiceRequest.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -invoice_id = 'invoice_id_example' # str | -request = billforward.BillingEntityBase() # BillingEntityBase | +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +state = ['state_example'] # list[str] | (optional) +account_id = ['account_id_example'] # list[str] | (optional) +subscription_id = ['subscription_id_example'] # list[str] | (optional) +subscription_version_id = ['subscription_version_id_example'] # list[str] | (optional) +invoice_version_id = ['invoice_version_id_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) +exclude_children = true # bool | (optional) (default to true) +metadata = 'metadata_example' # str | (optional) -try: - # Attempt payment for the outstanding value of an invoice - api_response = api_instance.execute_invoice(invoice_id, request) +try: + api_response = api_instance.get_all_invoices(organizations=organizations, state=state, account_id=account_id, subscription_id=subscription_id, subscription_version_id=subscription_version_id, invoice_version_id=invoice_version_id, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children, metadata=metadata) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->execute_invoice: %s\n" % e + print("Exception when calling InvoicesApi->get_all_invoices: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **invoice_id** | **str**| | - **request** | [**BillingEntityBase**](BillingEntityBase.md)| | + **organizations** | [**list[str]**](str.md)| | [optional] + **state** | [**list[str]**](str.md)| | [optional] + **account_id** | [**list[str]**](str.md)| | [optional] + **subscription_id** | [**list[str]**](str.md)| | [optional] + **subscription_version_id** | [**list[str]**](str.md)| | [optional] + **invoice_version_id** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + **exclude_children** | **bool**| | [optional] [default to true] + **metadata** | **str**| | [optional] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault8**](InlineResponseDefault8.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **generate_line_payments_for_all_invoices** -> InvoiceLinePaymentPagedMetadata generate_line_payments_for_all_invoices(organizations=organizations) +# **get_all_invoices_as_csv** +> get_all_invoices_as_csv(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Generates InvoiceLinePayments for all existing InvoicePayments. -{ \"nickname\" : \"Generate InvoiceLinePayments\",\"response\" : \"Generate InvoiceLinePayments.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint -# create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -try: - # Generates InvoiceLinePayments for all existing InvoicePayments. - api_response = api_instance.generate_line_payments_for_all_invoices(organizations=organizations) - pprint(api_response) +# create an instance of the API class +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_instance.get_all_invoices_as_csv(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) except ApiException as e: - print "Exception when calling InvoicesApi->generate_line_payments_for_all_invoices: %s\n" % e + print("Exception when calling InvoicesApi->get_all_invoices_as_csv: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_invoices** -> InvoicePagedMetadata get_all_invoices(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children, metadata=metadata) +# **get_bucketed_revenue_attributions_as_csv** +> get_bucketed_revenue_attributions_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_granularity=date_granularity, date_time_format=date_time_format, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) -Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\" : \"Retrieve all invoices\",\"response\" : \"getInvoiceAll.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint -# create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first invoice to return. (optional) (default to 0) -records = 10 # int | The maximum number of invoices to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) -exclude_children = true # bool | Should child invoices be excluded. (optional) (default to true) -metadata = 'metadata_example' # str | (optional) -try: - # Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_invoices(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children, metadata=metadata) - pprint(api_response) +# create an instance of the API class +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_granularity = 'Second' # str | (optional) (default to Second) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) + +try: + api_instance.get_bucketed_revenue_attributions_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_granularity=date_granularity, date_time_format=date_time_format, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) except ApiException as e: - print "Exception when calling InvoicesApi->get_all_invoices: %s\n" % e + print("Exception when calling InvoicesApi->get_bucketed_revenue_attributions_as_csv: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first invoice to return. | [optional] [default to 0] - **records** | **int**| The maximum number of invoices to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - **exclude_children** | **bool**| Should child invoices be excluded. | [optional] [default to true] - **metadata** | **str**| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_granularity** | **str**| | [optional] [default to Second] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: application/json + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_invoices_as_csv** -> InvoicePagedMetadata get_all_invoices_as_csv(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +# **get_charges_on_invoice** +> InlineResponseDefault10 get_charges_on_invoice(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, state=state, type=type, include_retired=include_retired) -Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\" : \"Retrieve all invoices\",\"response\" : \"getInvoiceAll.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first invoice to return. (optional) (default to 0) -records = 10 # int | The maximum number of invoices to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_invoices_as_csv(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +state = 'state_example' # str | (optional) +type = 'type_example' # str | (optional) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_charges_on_invoice(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, state=state, type=type, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_all_invoices_as_csv: %s\n" % e + print("Exception when calling InvoicesApi->get_charges_on_invoice: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first invoice to return. | [optional] [default to 0] - **records** | **int**| The maximum number of invoices to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] + **invoice_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **state** | **str**| | [optional] + **type** | **str**| | [optional] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault10**](InlineResponseDefault10.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: text/csv + - **Content-Type**: Not defined + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_bucketed_revenue_attributions_as_csv** -> str get_bucketed_revenue_attributions_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +# **get_credit_invoice_line_payments_from_invoices_as_csv** +> get_credit_invoice_line_payments_from_invoices_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) -Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed. -{ \"nickname\" : \"(CSV) Retrieve bucketed revenue attributions\",\"response\" : \"getBucketedRevenueAttributions.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -recognition_start = 'recognition_start_example' # str | The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). (optional) -recognition_end = 'recognition_end_example' # str | The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). (optional) - -try: - # Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed. - api_response = api_instance.get_bucketed_revenue_attributions_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) - pprint(api_response) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) + +try: + api_instance.get_credit_invoice_line_payments_from_invoices_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) except ApiException as e: - print "Exception when calling InvoicesApi->get_bucketed_revenue_attributions_as_csv: %s\n" % e + print("Exception when calling InvoicesApi->get_credit_invoice_line_payments_from_invoices_as_csv: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **recognition_start** | **str**| The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). | [optional] - **recognition_end** | **str**| The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] ### Return type -**str** +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -410,1282 +456,1294 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_charges_on_invoice** -> SubscriptionChargePagedMetadata get_charges_on_invoice(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, state=state, type=type, include_retired=include_retired) +# **get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received** +> get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(organizations=organizations, start=start, end=end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) -Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"List on invoice\",\"response\":\"getChargesInvoice.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -invoice_id = 'invoice_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -state = 'state_example' # str | Ihe direction of any ordering, either ASC or DESC. (optional) -type = 'type_example' # str | Ihe direction of any ordering, either ASC or DESC. (optional) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_charges_on_invoice(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, state=state, type=type, include_retired=include_retired) - pprint(api_response) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) + +try: + api_instance.get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(organizations=organizations, start=start, end=end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) except ApiException as e: - print "Exception when calling InvoicesApi->get_charges_on_invoice: %s\n" % e + print("Exception when calling InvoicesApi->get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **invoice_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **state** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] - **type** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **organizations** | [**list[str]**](str.md)| | [optional] + **start** | [**SimpleDateParam**](.md)| | [optional] + **end** | [**SimpleDateParam**](.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] ### Return type -[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: application/json + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_credit_invoice_line_payments_from_invoices_as_csv** -> InvoiceLinePaymentPagedMetadata get_credit_invoice_line_payments_from_invoices_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +# **get_debit_invoice_line_payments_from_invoices_as_csv** +> get_debit_invoice_line_payments_from_invoices_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) -Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. -{ \"nickname\" : \"Credit InvoiceLinePayments CSV\",\"response\" : \"Credit InvoiceLinePayments.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -recognition_start = 'recognition_start_example' # str | The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24). (optional) -recognition_end = 'recognition_end_example' # str | The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24). (optional) - -try: - # Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. - api_response = api_instance.get_credit_invoice_line_payments_from_invoices_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) - pprint(api_response) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) + +try: + api_instance.get_debit_invoice_line_payments_from_invoices_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) except ApiException as e: - print "Exception when calling InvoicesApi->get_credit_invoice_line_payments_from_invoices_as_csv: %s\n" % e + print("Exception when calling InvoicesApi->get_debit_invoice_line_payments_from_invoices_as_csv: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **recognition_start** | **str**| The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24). | [optional] - **recognition_end** | **str**| The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24). | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] ### Return type -[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: text/csv + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received** -> InvoiceLinePaymentPagedMetadata get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +# **get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received** +> get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(organizations=organizations, start=start, end=end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) -Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. -{ \"nickname\" : \"Credit InvoiceLinePayments CSV\",\"response\" : \"Credit InvoiceLinePayments.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -recognition_start = 'recognition_start_example' # str | The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24). (optional) -recognition_end = 'recognition_end_example' # str | The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24). (optional) - -try: - # Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. - api_response = api_instance.get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) - pprint(api_response) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) + +try: + api_instance.get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(organizations=organizations, start=start, end=end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) except ApiException as e: - print "Exception when calling InvoicesApi->get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received: %s\n" % e + print("Exception when calling InvoicesApi->get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **recognition_start** | **str**| The UTC DateTime specifying the start of the interval within which credit payments will be recognised (example input: 2015-09-13T11:50:24). | [optional] - **recognition_end** | **str**| The UTC DateTime specifying the end of the interval within which credit payments will be recognised (example input: 2015-10-13T11:50:24). | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **start** | [**SimpleDateParam**](.md)| | [optional] + **end** | [**SimpleDateParam**](.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] ### Return type -[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: text/csv + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_debit_invoice_line_payments_from_invoices_as_csv** -> InvoiceLinePaymentPagedMetadata get_debit_invoice_line_payments_from_invoices_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +# **get_hosted_payments** +> list[HostedPayment] get_hosted_payments(invoice_id, organizations=organizations) -Retrieves received revenue from InvoicePayments upon line items, in CSV format. -{ \"nickname\" : \"Debit InvoiceLinePayments CSV\",\"response\" : \"Debit InvoiceLinePayments.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -recognition_start = 'recognition_start_example' # str | The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24). (optional) -recognition_end = 'recognition_end_example' # str | The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24). (optional) - -try: - # Retrieves received revenue from InvoicePayments upon line items, in CSV format. - api_response = api_instance.get_debit_invoice_line_payments_from_invoices_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_hosted_payments(invoice_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_debit_invoice_line_payments_from_invoices_as_csv: %s\n" % e + print("Exception when calling InvoicesApi->get_hosted_payments: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **recognition_start** | **str**| The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24). | [optional] - **recognition_end** | **str**| The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24). | [optional] + **invoice_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md) +[**list[HostedPayment]**](HostedPayment.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: text/csv + - **Content-Type**: Not defined + - **Accept**: */* [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received** -> InvoiceLinePaymentPagedMetadata get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +# **get_invoice_as_html** +> get_invoice_as_html(id, organizations=organizations, tier_breakdown=tier_breakdown, inclusive_end=inclusive_end, show_zero_cost=show_zero_cost, show_plan_only_when_ambiguous=show_plan_only_when_ambiguous, include_footer=include_footer, header_display=header_display, group_line_items_by=group_line_items_by, hide_tax_if_zero=hide_tax_if_zero, show_unit_price=show_unit_price, representing_account_id=representing_account_id, company_address_on_top=company_address_on_top, upgrade_duration_wording=upgrade_duration_wording, refresh_cache=refresh_cache) -Retrieves received revenue from InvoicePayments upon line items, in CSV format. -{ \"nickname\" : \"Debit InvoiceLinePayments CSV\",\"response\" : \"Debit InvoiceLinePayments.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -recognition_start = 'recognition_start_example' # str | The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24). (optional) -recognition_end = 'recognition_end_example' # str | The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24). (optional) - -try: - # Retrieves received revenue from InvoicePayments upon line items, in CSV format. - api_response = api_instance.get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) - pprint(api_response) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +id = 'id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +tier_breakdown = true # bool | (optional) +inclusive_end = true # bool | (optional) +show_zero_cost = true # bool | (optional) +show_plan_only_when_ambiguous = true # bool | (optional) +include_footer = true # bool | (optional) +header_display = 'header_display_example' # str | (optional) +group_line_items_by = 'group_line_items_by_example' # str | (optional) +hide_tax_if_zero = true # bool | (optional) +show_unit_price = 'show_unit_price_example' # str | (optional) +representing_account_id = 'representing_account_id_example' # str | (optional) +company_address_on_top = true # bool | (optional) +upgrade_duration_wording = true # bool | (optional) +refresh_cache = false # bool | (optional) (default to false) + +try: + api_instance.get_invoice_as_html(id, organizations=organizations, tier_breakdown=tier_breakdown, inclusive_end=inclusive_end, show_zero_cost=show_zero_cost, show_plan_only_when_ambiguous=show_plan_only_when_ambiguous, include_footer=include_footer, header_display=header_display, group_line_items_by=group_line_items_by, hide_tax_if_zero=hide_tax_if_zero, show_unit_price=show_unit_price, representing_account_id=representing_account_id, company_address_on_top=company_address_on_top, upgrade_duration_wording=upgrade_duration_wording, refresh_cache=refresh_cache) except ApiException as e: - print "Exception when calling InvoicesApi->get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received: %s\n" % e + print("Exception when calling InvoicesApi->get_invoice_as_html: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **recognition_start** | **str**| The UTC DateTime specifying the start of the interval within which revenue will be recognised (example input: 2015-09-13T11:50:24). | [optional] - **recognition_end** | **str**| The UTC DateTime specifying the end of the interval within which revenue will be recognised (example input: 2015-10-13T11:50:24). | [optional] + **id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **tier_breakdown** | **bool**| | [optional] + **inclusive_end** | **bool**| | [optional] + **show_zero_cost** | **bool**| | [optional] + **show_plan_only_when_ambiguous** | **bool**| | [optional] + **include_footer** | **bool**| | [optional] + **header_display** | **str**| | [optional] + **group_line_items_by** | **str**| | [optional] + **hide_tax_if_zero** | **bool**| | [optional] + **show_unit_price** | **str**| | [optional] + **representing_account_id** | **str**| | [optional] + **company_address_on_top** | **bool**| | [optional] + **upgrade_duration_wording** | **bool**| | [optional] + **refresh_cache** | **bool**| | [optional] [default to false] ### Return type -[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: text/csv + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_invoice_as_html** -> str get_invoice_as_html(id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, tier_breakdown=tier_breakdown, inclusive_end=inclusive_end, show_zero_cost=show_zero_cost, show_plan_only_when_ambiguous=show_plan_only_when_ambiguous) +# **get_invoice_as_pdf** +> get_invoice_as_pdf(id, organizations=organizations, offset=offset, order_by=order_by, order=order, include_retired=include_retired, tier_breakdown=tier_breakdown, inclusive_end=inclusive_end, show_zero_cost=show_zero_cost, show_plan_only_when_ambiguous=show_plan_only_when_ambiguous, include_footer=include_footer, header_display=header_display, group_line_items_by=group_line_items_by, hide_tax_if_zero=hide_tax_if_zero, show_unit_price=show_unit_price, representing_account_id=representing_account_id, company_address_on_top=company_address_on_top, upgrade_duration_wording=upgrade_duration_wording, refresh_cache=refresh_cache) -Retrieves a single invoice specified by the ID parameter. -{ \"nickname\" : \"HTML invoice\",\"response\" : \"getInvoiceByID.HTML.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -id = 'id_example' # str | The ID of the invoice. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first invoice to return. (optional) (default to 0) -records = 10 # int | The maximum number of invoices to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) -tier_breakdown = false # bool | Whether to provide a breakdown of charge tiering. (optional) (default to false) -inclusive_end = false # bool | Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \"period end\" date shown to the customer. (optional) (default to false) -show_zero_cost = true # bool | Whether to show zero-cost lines. (optional) (default to true) -show_plan_only_when_ambiguous = true # bool | Whether to state which plan the Invoice lines came from, regardless of whether there's only one plan involved in this Invoice. (optional) (default to true) - -try: - # Retrieves a single invoice specified by the ID parameter. - api_response = api_instance.get_invoice_as_html(id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, tier_breakdown=tier_breakdown, inclusive_end=inclusive_end, show_zero_cost=show_zero_cost, show_plan_only_when_ambiguous=show_plan_only_when_ambiguous) - pprint(api_response) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +id = 'id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) +tier_breakdown = true # bool | (optional) +inclusive_end = true # bool | (optional) +show_zero_cost = true # bool | (optional) +show_plan_only_when_ambiguous = true # bool | (optional) +include_footer = true # bool | (optional) +header_display = 'header_display_example' # str | (optional) +group_line_items_by = 'group_line_items_by_example' # str | (optional) +hide_tax_if_zero = true # bool | (optional) +show_unit_price = 'show_unit_price_example' # str | (optional) +representing_account_id = 'representing_account_id_example' # str | (optional) +company_address_on_top = true # bool | (optional) +upgrade_duration_wording = true # bool | (optional) +refresh_cache = false # bool | (optional) (default to false) + +try: + api_instance.get_invoice_as_pdf(id, organizations=organizations, offset=offset, order_by=order_by, order=order, include_retired=include_retired, tier_breakdown=tier_breakdown, inclusive_end=inclusive_end, show_zero_cost=show_zero_cost, show_plan_only_when_ambiguous=show_plan_only_when_ambiguous, include_footer=include_footer, header_display=header_display, group_line_items_by=group_line_items_by, hide_tax_if_zero=hide_tax_if_zero, show_unit_price=show_unit_price, representing_account_id=representing_account_id, company_address_on_top=company_address_on_top, upgrade_duration_wording=upgrade_duration_wording, refresh_cache=refresh_cache) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoice_as_html: %s\n" % e + print("Exception when calling InvoicesApi->get_invoice_as_pdf: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| The ID of the invoice. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first invoice to return. | [optional] [default to 0] - **records** | **int**| The maximum number of invoices to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - **tier_breakdown** | **bool**| Whether to provide a breakdown of charge tiering. | [optional] [default to false] - **inclusive_end** | **bool**| Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \"period end\" date shown to the customer. | [optional] [default to false] - **show_zero_cost** | **bool**| Whether to show zero-cost lines. | [optional] [default to true] - **show_plan_only_when_ambiguous** | **bool**| Whether to state which plan the Invoice lines came from, regardless of whether there's only one plan involved in this Invoice. | [optional] [default to true] + **id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + **tier_breakdown** | **bool**| | [optional] + **inclusive_end** | **bool**| | [optional] + **show_zero_cost** | **bool**| | [optional] + **show_plan_only_when_ambiguous** | **bool**| | [optional] + **include_footer** | **bool**| | [optional] + **header_display** | **str**| | [optional] + **group_line_items_by** | **str**| | [optional] + **hide_tax_if_zero** | **bool**| | [optional] + **show_unit_price** | **str**| | [optional] + **representing_account_id** | **str**| | [optional] + **company_address_on_top** | **bool**| | [optional] + **upgrade_duration_wording** | **bool**| | [optional] + **refresh_cache** | **bool**| | [optional] [default to false] ### Return type -**str** +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: text/html + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_invoice_as_pdf** -> file get_invoice_as_pdf(id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, tier_breakdown=tier_breakdown, inclusive_end=inclusive_end, show_zero_cost=show_zero_cost, show_plan_only_when_ambiguous=show_plan_only_when_ambiguous, include_footer=include_footer, group_line_items_by=group_line_items_by) +# **get_invoice_by_id** +> InlineResponseDefault8 get_invoice_by_id(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a single invoice specified by the ID parameter. -{ \"nickname\" : \"PDF Invoice\",\"response\" : \"getInvoiceByID.pdf\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint -# create an instance of the API class -api_instance = billforward.InvoicesApi() -id = 'id_example' # str | The ID of the invoice. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first invoice to return. (optional) (default to 0) -records = 10 # int | The maximum number of invoices to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) -tier_breakdown = false # bool | Whether to provide a breakdown of charge tiering. (optional) (default to false) -inclusive_end = false # bool | Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \"period end\" date shown to the customer. (optional) (default to false) -show_zero_cost = true # bool | Whether to show zero-cost lines. (optional) (default to true) -show_plan_only_when_ambiguous = true # bool | Whether to state which plan the Invoice lines came from, regardless of whether there's only one plan involved in this Invoice. (optional) (default to true) -include_footer = true # bool | (optional) -group_line_items_by = 'group_line_items_by_example' # str | (optional) -try: - # Retrieves a single invoice specified by the ID parameter. - api_response = api_instance.get_invoice_as_pdf(id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, tier_breakdown=tier_breakdown, inclusive_end=inclusive_end, show_zero_cost=show_zero_cost, show_plan_only_when_ambiguous=show_plan_only_when_ambiguous, include_footer=include_footer, group_line_items_by=group_line_items_by) +# create an instance of the API class +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_invoice_by_id(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoice_as_pdf: %s\n" % e + print("Exception when calling InvoicesApi->get_invoice_by_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| The ID of the invoice. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first invoice to return. | [optional] [default to 0] - **records** | **int**| The maximum number of invoices to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - **tier_breakdown** | **bool**| Whether to provide a breakdown of charge tiering. | [optional] [default to false] - **inclusive_end** | **bool**| Whether to present in the Invoice date range only those dates whose entirety are involved in the billing period. In other words: when true, this subtracts 1 from the \"period end\" date shown to the customer. | [optional] [default to false] - **show_zero_cost** | **bool**| Whether to show zero-cost lines. | [optional] [default to true] - **show_plan_only_when_ambiguous** | **bool**| Whether to state which plan the Invoice lines came from, regardless of whether there's only one plan involved in this Invoice. | [optional] [default to true] - **include_footer** | **bool**| | [optional] - **group_line_items_by** | **str**| | [optional] + **invoice_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**file**](file.md) +[**InlineResponseDefault8**](InlineResponseDefault8.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: application/pdf + - **Content-Type**: Not defined + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_invoice_by_id** -> InvoicePagedMetadata get_invoice_by_id(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) +# **get_invoice_by_id_as_csv** +> get_invoice_by_id_as_csv(id, organizations=organizations) -Retrieves a single invoice specified by the invoice-ID parameter. -{ \"nickname\" : \"Retrieve an existing invoice\",\"response\" : \"getInvoiceByID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -invoice_id = 'invoice_id_example' # str | The ID of the invoice. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first invoice to return. (optional) (default to 0) -records = 10 # int | The maximum number of invoices to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) -exclude_children = true # bool | Should child invoices be excluded. (optional) (default to true) - -try: - # Retrieves a single invoice specified by the invoice-ID parameter. - api_response = api_instance.get_invoice_by_id(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) - pprint(api_response) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +id = 'id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_instance.get_invoice_by_id_as_csv(id, organizations=organizations) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoice_by_id: %s\n" % e + print("Exception when calling InvoicesApi->get_invoice_by_id_as_csv: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **invoice_id** | **str**| The ID of the invoice. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first invoice to return. | [optional] [default to 0] - **records** | **int**| The maximum number of invoices to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - **exclude_children** | **bool**| Should child invoices be excluded. | [optional] [default to true] + **id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: application/json + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_invoice_by_id_as_csv** -> str get_invoice_by_id_as_csv(id, organizations=organizations) +# **get_invoice_by_subscription_id** +> InlineResponseDefault8 get_invoice_by_subscription_id(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a single invoice specified by the ID parameter. -{ \"nickname\" : \"CSV invoice\",\"response\" : \"getInvoiceByID.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint -# create an instance of the API class -api_instance = billforward.InvoicesApi() -id = 'id_example' # str | The ID of the invoice. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -try: - # Retrieves a single invoice specified by the ID parameter. - api_response = api_instance.get_invoice_by_id_as_csv(id, organizations=organizations) +# create an instance of the API class +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_invoice_by_subscription_id(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoice_by_id_as_csv: %s\n" % e + print("Exception when calling InvoicesApi->get_invoice_by_subscription_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| The ID of the invoice. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **subscription_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -**str** +[**InlineResponseDefault8**](InlineResponseDefault8.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: text/csv + - **Content-Type**: Not defined + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_invoice_by_subscription_id** -> InvoicePagedMetadata get_invoice_by_subscription_id(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) +# **get_invoice_by_subscription_version_id** +> InlineResponseDefault8 get_invoice_by_subscription_version_id(subscription_version_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\" : \"Retrieve by subscription\",\"response\" : \"getInvoiceBySubscriptionID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first invoice to return. (optional) (default to 0) -records = 10 # int | The maximum number of invoices to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) -exclude_children = true # bool | Should child invoices be excluded. (optional) (default to true) - -try: - # Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_invoice_by_subscription_id(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +subscription_version_id = 'subscription_version_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_invoice_by_subscription_version_id(subscription_version_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoice_by_subscription_id: %s\n" % e + print("Exception when calling InvoicesApi->get_invoice_by_subscription_version_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first invoice to return. | [optional] [default to 0] - **records** | **int**| The maximum number of invoices to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - **exclude_children** | **bool**| Should child invoices be excluded. | [optional] [default to true] + **subscription_version_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault8**](InlineResponseDefault8.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_invoice_by_subscription_version_id** -> InvoicePagedMetadata get_invoice_by_subscription_version_id(subscription_version_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) +# **get_invoice_by_version_id** +> InlineResponseDefault29 get_invoice_by_version_id(version_id, organizations=organizations) -Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\" : \"Retrieve by subscription version\",\"response\" : \"getInvoiceBySubscriptionVersionID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -subscription_version_id = 'subscription_version_id_example' # str | Version ID of the subscription. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first invoice to return. (optional) (default to 0) -records = 10 # int | The maximum number of invoices to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) -exclude_children = true # bool | Should child invoices be excluded. (optional) (default to true) - -try: - # Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_invoice_by_subscription_version_id(subscription_version_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +version_id = 'version_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_invoice_by_version_id(version_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoice_by_subscription_version_id: %s\n" % e + print("Exception when calling InvoicesApi->get_invoice_by_version_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_version_id** | **str**| Version ID of the subscription. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first invoice to return. | [optional] [default to 0] - **records** | **int**| The maximum number of invoices to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - **exclude_children** | **bool**| Should child invoices be excluded. | [optional] [default to true] + **version_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault29**](InlineResponseDefault29.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_invoice_by_version_id** -> InvoicePagedMetadata get_invoice_by_version_id(version_id, organizations=organizations) +# **get_invoice_template** +> InlineResponseDefault30 get_invoice_template(organizations=organizations) -Retrieves a single invoice, specified by the version-ID parameter. -{ \"nickname\" : \"Retrieve by version\",\"response\" : \"getInvoiceByVersionID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -version_id = 'version_id_example' # str | The version-ID of the invoice. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Retrieves a single invoice, specified by the version-ID parameter. - api_response = api_instance.get_invoice_by_version_id(version_id, organizations=organizations) +try: + api_response = api_instance.get_invoice_template(organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoice_by_version_id: %s\n" % e + print("Exception when calling InvoicesApi->get_invoice_template: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **version_id** | **str**| The version-ID of the invoice. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault30**](InlineResponseDefault30.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: application/json, text/xml + - **Content-Type**: Not defined + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_invoices_by_account_id** -> InvoicePagedMetadata get_invoices_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) +# **get_invoices_by_account_id1** +> InlineResponseDefault8 get_invoices_by_account_id1(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) -Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\" : \"Retrieve by account\",\"response\" : \"getInvoiceByAccountID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -account_id = 'account_id_example' # str | ID of the account. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first invoice to return. (optional) (default to 0) -records = 10 # int | The maximum number of invoices to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) -exclude_children = true # bool | Should child invoices be excluded. (optional) (default to true) - -try: - # Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_invoices_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) +exclude_children = true # bool | (optional) (default to true) + +try: + api_response = api_instance.get_invoices_by_account_id1(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoices_by_account_id: %s\n" % e + print("Exception when calling InvoicesApi->get_invoices_by_account_id1: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account_id** | **str**| ID of the account. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first invoice to return. | [optional] [default to 0] - **records** | **int**| The maximum number of invoices to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - **exclude_children** | **bool**| Should child invoices be excluded. | [optional] [default to true] + **account_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + **exclude_children** | **bool**| | [optional] [default to true] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault8**](InlineResponseDefault8.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_invoices_by_period_end** -> InvoicePagedMetadata get_invoices_by_period_end(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault8 get_invoices_by_period_end(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\" : \"Retrieve by period-end\",\"response\" : \"getInvoiceByPeriodEnd.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +lower_threshold = billforward.SimpleDateParam() # SimpleDateParam | +upper_threshold = billforward.SimpleDateParam() # SimpleDateParam | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_invoices_by_period_end(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoices_by_period_end: %s\n" % e + print("Exception when calling InvoicesApi->get_invoices_by_period_end: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] + **lower_threshold** | [**SimpleDateParam**](.md)| | + **upper_threshold** | [**SimpleDateParam**](.md)| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault8**](InlineResponseDefault8.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_invoices_by_period_start** -> InvoicePagedMetadata get_invoices_by_period_start(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault8 get_invoices_by_period_start(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\" : \"Retrieve by period-start\",\"response\" : \"getInvoiceByPeriodStart.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +lower_threshold = billforward.SimpleDateParam() # SimpleDateParam | +upper_threshold = billforward.SimpleDateParam() # SimpleDateParam | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_invoices_by_period_start(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoices_by_period_start: %s\n" % e + print("Exception when calling InvoicesApi->get_invoices_by_period_start: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] + **lower_threshold** | [**SimpleDateParam**](.md)| | + **upper_threshold** | [**SimpleDateParam**](.md)| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault8**](InlineResponseDefault8.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_invoices_by_period_start_as_csv** -> InvoicePagedMetadata get_invoices_by_period_start_as_csv(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> get_invoices_by_period_start_as_csv(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\" : \"Retrieve by period-start\",\"response\" : \"getInvoiceByPeriodStart.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_invoices_by_period_start_as_csv(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +lower_threshold = billforward.SimpleDateParam() # SimpleDateParam | +upper_threshold = billforward.SimpleDateParam() # SimpleDateParam | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_instance.get_invoices_by_period_start_as_csv(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoices_by_period_start_as_csv: %s\n" % e + print("Exception when calling InvoicesApi->get_invoices_by_period_start_as_csv: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] + **lower_threshold** | [**SimpleDateParam**](.md)| | + **upper_threshold** | [**SimpleDateParam**](.md)| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: text/csv + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_invoices_by_state** -> InvoicePagedMetadata get_invoices_by_state(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault8 get_invoices_by_state(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\" : \"Retrieve by state\",\"response\" : \"getInvoiceByState.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -state = 'state_example' # str | The current state of the invoice, either Paid, Pending, Unpaid or Voided. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'ID' # str | Specify a field used to order the result set. (optional) (default to ID) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +state = 'state_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_invoices_by_state(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoices_by_state: %s\n" % e + print("Exception when calling InvoicesApi->get_invoices_by_state: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **state** | **str**| The current state of the invoice, either Paid, Pending, Unpaid or Voided. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to ID] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] + **state** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault8**](InlineResponseDefault8.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_invoices_by_state_and_period_start** -> InvoicePagedMetadata get_invoices_by_state_and_period_start(state, lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault8 get_invoices_by_state_and_period_start(state, lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\" : \"Retrieve by state and period-start\",\"response\" : \"getInvoiceByStateAndPeriodStart.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -state = 'state_example' # str | The current state of the invoice, either Paid, Pending, Unpaid or Voided. -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +state = 'state_example' # str | +lower_threshold = billforward.SimpleDateParam() # SimpleDateParam | +upper_threshold = billforward.SimpleDateParam() # SimpleDateParam | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_invoices_by_state_and_period_start(state, lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoices_by_state_and_period_start: %s\n" % e + print("Exception when calling InvoicesApi->get_invoices_by_state_and_period_start: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **state** | **str**| The current state of the invoice, either Paid, Pending, Unpaid or Voided. | - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] + **state** | **str**| | + **lower_threshold** | [**SimpleDateParam**](.md)| | + **upper_threshold** | [**SimpleDateParam**](.md)| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault8**](InlineResponseDefault8.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_invoices_by_state_and_period_start_as_csv** -> InvoicePagedMetadata get_invoices_by_state_and_period_start_as_csv(state, lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> get_invoices_by_state_and_period_start_as_csv(state, lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\" : \"Retrieve by state and period-start\",\"response\" : \"getInvoiceByStateAndPeriodStart.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -state = 'state_example' # str | The current state of the invoice, either Paid, Pending, Unpaid or Voided. -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_invoices_by_state_and_period_start_as_csv(state, lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +state = 'state_example' # str | +lower_threshold = billforward.SimpleDateParam() # SimpleDateParam | +upper_threshold = billforward.SimpleDateParam() # SimpleDateParam | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_instance.get_invoices_by_state_and_period_start_as_csv(state, lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoices_by_state_and_period_start_as_csv: %s\n" % e + print("Exception when calling InvoicesApi->get_invoices_by_state_and_period_start_as_csv: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **state** | **str**| The current state of the invoice, either Paid, Pending, Unpaid or Voided. | - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] + **state** | **str**| | + **lower_threshold** | [**SimpleDateParam**](.md)| | + **upper_threshold** | [**SimpleDateParam**](.md)| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: text/csv + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_invoices_by_state_as_csv** -> InvoicePagedMetadata get_invoices_by_state_as_csv(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> get_invoices_by_state_as_csv(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\" : \"Retrieve by state\",\"response\" : \"getInvoiceByState.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -state = 'state_example' # str | The current state of the invoice, either Paid, Pending, Unpaid or Voided. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'ID' # str | Specify a field used to order the result set. (optional) (default to ID) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_invoices_by_state_as_csv(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +state = 'state_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_instance.get_invoices_by_state_as_csv(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) except ApiException as e: - print "Exception when calling InvoicesApi->get_invoices_by_state_as_csv: %s\n" % e + print("Exception when calling InvoicesApi->get_invoices_by_state_as_csv: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **state** | **str**| The current state of the invoice, either Paid, Pending, Unpaid or Voided. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to ID] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] + **state** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: text/csv + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_line_payments** -> InvoiceLinePaymentPagedMetadata get_line_payments(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway) +> InlineResponseDefault31 get_line_payments(organizations=organizations, payment_direction=payment_direction, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway) -Retrieves all InvoiceLine payment attributions. -{ \"nickname\" : \"Retrieve InvoiceLine payment attributions\",\"response\" : \"getInvoiceLinePayments.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -recognition_start = 'recognition_start_example' # str | The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24). (optional) -recognition_end = 'recognition_end_example' # str | The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24). (optional) -include_gateway = ['include_gateway_example'] # list[str] | Include attributions only from payments made via these payment gateways. Takes precedence over `exclude_gateway` param (if both are provided). (optional) -exclude_gateway = ['exclude_gateway_example'] # list[str] | Include attributions from payments made via all payment gateways, except these. (optional) - -try: - # Retrieves all InvoiceLine payment attributions. - api_response = api_instance.get_line_payments(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +payment_direction = 'All' # str | (optional) (default to All) +date_discriminator = 'PeriodStart' # str | (optional) (default to PeriodStart) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +include_gateway = ['include_gateway_example'] # list[str] | (optional) +exclude_gateway = ['exclude_gateway_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_line_payments(organizations=organizations, payment_direction=payment_direction, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_line_payments: %s\n" % e + print("Exception when calling InvoicesApi->get_line_payments: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **recognition_start** | **str**| The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24). | [optional] - **recognition_end** | **str**| The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24). | [optional] - **include_gateway** | [**list[str]**](str.md)| Include attributions only from payments made via these payment gateways. Takes precedence over `exclude_gateway` param (if both are provided). | [optional] - **exclude_gateway** | [**list[str]**](str.md)| Include attributions from payments made via all payment gateways, except these. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **payment_direction** | **str**| | [optional] [default to All] + **date_discriminator** | **str**| | [optional] [default to PeriodStart] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **include_gateway** | [**list[str]**](str.md)| | [optional] + **exclude_gateway** | [**list[str]**](str.md)| | [optional] ### Return type -[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md) +[**InlineResponseDefault31**](InlineResponseDefault31.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_line_payments_as_csv** -> InvoiceLinePaymentPagedMetadata get_line_payments_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway) +> get_line_payments_as_csv(organizations=organizations, payment_direction=payment_direction, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) -Retrieves (as CSV) all InvoiceLine payment attributions. -{ \"nickname\" : \"(CSV) Retrieve InvoiceLine payment attributions\",\"response\" : \"getInvoiceLinePayments.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -recognition_start = 'recognition_start_example' # str | The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24). (optional) -recognition_end = 'recognition_end_example' # str | The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24). (optional) -include_gateway = ['include_gateway_example'] # list[str] | Include attributions only from payments made via these payment gateways. Takes precedence over `exclude_gateway` param (if both are provided). (optional) -exclude_gateway = ['exclude_gateway_example'] # list[str] | Include attributions from payments made via all payment gateways, except these. (optional) - -try: - # Retrieves (as CSV) all InvoiceLine payment attributions. - api_response = api_instance.get_line_payments_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway) - pprint(api_response) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +payment_direction = 'All' # str | (optional) (default to All) +date_discriminator = 'PeriodStart' # str | (optional) (default to PeriodStart) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +include_gateway = ['include_gateway_example'] # list[str] | (optional) +exclude_gateway = ['exclude_gateway_example'] # list[str] | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) + +try: + api_instance.get_line_payments_as_csv(organizations=organizations, payment_direction=payment_direction, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) except ApiException as e: - print "Exception when calling InvoicesApi->get_line_payments_as_csv: %s\n" % e + print("Exception when calling InvoicesApi->get_line_payments_as_csv: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **recognition_start** | **str**| The UTC DateTime specifying the start of the interval within which line payment attributions will be recognised (example input: 2015-09-13T11:50:24). | [optional] - **recognition_end** | **str**| The UTC DateTime specifying the end of the interval within which line payment attributions will be recognised (example input: 2015-10-13T11:50:24). | [optional] - **include_gateway** | [**list[str]**](str.md)| Include attributions only from payments made via these payment gateways. Takes precedence over `exclude_gateway` param (if both are provided). | [optional] - **exclude_gateway** | [**list[str]**](str.md)| Include attributions from payments made via all payment gateways, except these. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **payment_direction** | **str**| | [optional] [default to All] + **date_discriminator** | **str**| | [optional] [default to PeriodStart] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **include_gateway** | [**list[str]**](str.md)| | [optional] + **exclude_gateway** | [**list[str]**](str.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] ### Return type -[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1695,30 +1753,29 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_metadata_for_invoice** -> DynamicMetadata get_metadata_for_invoice(invoice_id, organizations=organizations) +> InlineResponseDefault7 get_metadata_for_invoice(invoice_id, organizations=organizations) -Retrieve any associated metadata. -{\"nickname\":\"Retrieve metadata on invoice\",\"request\":\"getInvoiceMetadataRequest.html\",\"response\":\"getInvoiceMetadataResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) invoice_id = 'invoice_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Retrieve any associated metadata. +try: api_response = api_instance.get_metadata_for_invoice(invoice_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_metadata_for_invoice: %s\n" % e + print("Exception when calling InvoicesApi->get_metadata_for_invoice: %s\n" % e) ``` ### Parameters @@ -1726,219 +1783,290 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **invoice_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**DynamicMetadata**](DynamicMetadata.md) +[**InlineResponseDefault7**](InlineResponseDefault7.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_refund_invoice_line_payments_from_invoices_as_csv** -> InvoiceLinePaymentPagedMetadata get_refund_invoice_line_payments_from_invoices_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +# **get_refund_for_refunded_invoice** +> InlineResponseDefault32 get_refund_for_refunded_invoice(invoice_id, organizations=organizations) -Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. -{ \"nickname\" : \"Refund InvoiceLinePayments CSV\",\"response\" : \"Refund InvoiceLinePayments.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -recognition_start = 'recognition_start_example' # str | The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24). (optional) -recognition_end = 'recognition_end_example' # str | The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24). (optional) - -try: - # Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. - api_response = api_instance.get_refund_invoice_line_payments_from_invoices_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_refund_for_refunded_invoice(invoice_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_refund_invoice_line_payments_from_invoices_as_csv: %s\n" % e + print("Exception when calling InvoicesApi->get_refund_for_refunded_invoice: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **recognition_start** | **str**| The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24). | [optional] - **recognition_end** | **str**| The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24). | [optional] + **invoice_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md) +[**InlineResponseDefault32**](InlineResponseDefault32.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: text/csv + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_refund_invoice_line_payments_from_invoices_as_csv** +> get_refund_invoice_line_payments_from_invoices_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) + +try: + api_instance.get_refund_invoice_line_payments_from_invoices_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) +except ApiException as e: + print("Exception when calling InvoicesApi->get_refund_invoice_line_payments_from_invoices_as_csv: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received** -> InvoiceLinePaymentPagedMetadata get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +> get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(organizations=organizations, start=start, end=end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) -Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. -{ \"nickname\" : \"Refund InvoiceLinePayments CSV\",\"response\" : \"Refund InvoiceLinePayments.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -recognition_start = 'recognition_start_example' # str | The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24). (optional) -recognition_end = 'recognition_end_example' # str | The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24). (optional) - -try: - # Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. - api_response = api_instance.get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) - pprint(api_response) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) + +try: + api_instance.get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(organizations=organizations, start=start, end=end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) except ApiException as e: - print "Exception when calling InvoicesApi->get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received: %s\n" % e + print("Exception when calling InvoicesApi->get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **recognition_start** | **str**| The UTC DateTime specifying the start of the interval within which refunds will be recognised (example input: 2015-09-13T11:50:24). | [optional] - **recognition_end** | **str**| The UTC DateTime specifying the end of the interval within which refunds will be recognised (example input: 2015-10-13T11:50:24). | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **start** | [**SimpleDateParam**](.md)| | [optional] + **end** | [**SimpleDateParam**](.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] ### Return type -[**InvoiceLinePaymentPagedMetadata**](InvoiceLinePaymentPagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json - - **Accept**: text/csv + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_revenue_attributions** -> RevenueAttributionPagedMetadata get_revenue_attributions(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +> InlineResponseDefault33 get_revenue_attributions(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) -Retrieves all attributions of Invoice costs to Invoice lines. -{ \"nickname\" : \"Retrieve revenue attributions\",\"response\" : \"getRevenueAttributions.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -recognition_start = 'recognition_start_example' # str | The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). (optional) -recognition_end = 'recognition_end_example' # str | The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). (optional) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) -try: - # Retrieves all attributions of Invoice costs to Invoice lines. +try: api_response = api_instance.get_revenue_attributions(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_revenue_attributions: %s\n" % e + print("Exception when calling InvoicesApi->get_revenue_attributions: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **recognition_start** | **str**| The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). | [optional] - **recognition_end** | **str**| The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] ### Return type -[**RevenueAttributionPagedMetadata**](RevenueAttributionPagedMetadata.md) +[**InlineResponseDefault33**](InlineResponseDefault33.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_revenue_attributions_as_csv** -> str get_revenue_attributions_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +> get_revenue_attributions_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_granularity=date_granularity, date_time_format=date_time_format, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) -Retrieves (as CSV) all attributions of Invoice costs to Invoice lines. -{ \"nickname\" : \"(CSV) Retrieve revenue attributions\",\"response\" : \"getRevenueAttributions.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -recognition_start = 'recognition_start_example' # str | The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). (optional) -recognition_end = 'recognition_end_example' # str | The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). (optional) - -try: - # Retrieves (as CSV) all attributions of Invoice costs to Invoice lines. - api_response = api_instance.get_revenue_attributions_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) - pprint(api_response) +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_granularity = 'Second' # str | (optional) (default to Second) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) + +try: + api_instance.get_revenue_attributions_as_csv(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_granularity=date_granularity, date_time_format=date_time_format, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format) except ApiException as e: - print "Exception when calling InvoicesApi->get_revenue_attributions_as_csv: %s\n" % e + print("Exception when calling InvoicesApi->get_revenue_attributions_as_csv: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **recognition_start** | **str**| The UTC DateTime specifying the start of the interval within which revenue attributions will be recognised (example input: 2015-09-13T11:50:24). | [optional] - **recognition_end** | **str**| The UTC DateTime specifying the end of the interval within which revenue attributions will be recognised (example input: 2015-10-13T11:50:24). | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_granularity** | **str**| | [optional] [default to Second] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] ### Return type -**str** +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1948,103 +2076,101 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_swagger_for_invoice** -> SwaggerTypeListInv get_swagger_for_invoice(query_string, organizations=organizations, offset=offset, records=records, format=format, wildcard=wildcard, entity=entity) - +> InlineResponseDefault34 get_swagger_for_invoice(query_string, organizations=organizations, offset=offset, records=records, format=format, wildcard=wildcard, entity=entity) -{ \"nickname\" : \"\",\"response\" : \"\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -query_string = 'query_string_example' # str | The query string used to search. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The starting index of the search results. (optional) (default to 0) -records = 10 # int | The number of search results to return. (optional) (default to 10) -format = 'JSON' # str | The response format, either JSON or XML. (optional) (default to JSON) -wildcard = false # bool | Toggle if we search for full words or whether a wildcard is used. (optional) (default to false) -entity = false # bool | Is an entity returned with the search results. (optional) (default to false) - -try: - # +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +query_string = 'query_string_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +format = 'JSON' # str | (optional) (default to JSON) +wildcard = true # bool | (optional) (default to true) +entity = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_swagger_for_invoice(query_string, organizations=organizations, offset=offset, records=records, format=format, wildcard=wildcard, entity=entity) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->get_swagger_for_invoice: %s\n" % e + print("Exception when calling InvoicesApi->get_swagger_for_invoice: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **query_string** | **str**| The query string used to search. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The starting index of the search results. | [optional] [default to 0] - **records** | **int**| The number of search results to return. | [optional] [default to 10] - **format** | **str**| The response format, either JSON or XML. | [optional] [default to JSON] - **wildcard** | **bool**| Toggle if we search for full words or whether a wildcard is used. | [optional] [default to false] - **entity** | **bool**| Is an entity returned with the search results. | [optional] [default to false] + **query_string** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **format** | **str**| | [optional] [default to JSON] + **wildcard** | **bool**| | [optional] [default to true] + **entity** | **bool**| | [optional] [default to false] ### Return type -[**SwaggerTypeListInv**](SwaggerTypeListInv.md) +[**InlineResponseDefault34**](InlineResponseDefault34.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **import_invoice** -> InvoicePagedMetadata import_invoice(request) +> InlineResponseDefault29 import_invoice(body=body) -Import an invoice. -{\"nickname\":\"Import invoice\",\"response\":\"ImportInvoiceResponse.html\",\"request\":\"ImportInvoiceRequest.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -request = billforward.BillingEntityBase() # BillingEntityBase | +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +body = billforward.ImportInvoiceRequest() # ImportInvoiceRequest | (optional) -try: - # Import an invoice. - api_response = api_instance.import_invoice(request) +try: + api_response = api_instance.import_invoice(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->import_invoice: %s\n" % e + print("Exception when calling InvoicesApi->import_invoice: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **request** | [**BillingEntityBase**](BillingEntityBase.md)| | + **body** | [**ImportInvoiceRequest**](ImportInvoiceRequest.md)| | [optional] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault29**](InlineResponseDefault29.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2053,31 +2179,174 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **issue_invoice** +> InlineResponseDefault35 issue_invoice(invoice_id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +body = billforward.IssueInvoiceRequest() # IssueInvoiceRequest | (optional) + +try: + api_response = api_instance.issue_invoice(invoice_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling InvoicesApi->issue_invoice: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **invoice_id** | **str**| | + **body** | [**IssueInvoiceRequest**](IssueInvoiceRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault35**](InlineResponseDefault35.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: text/plain, application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_original_invoice** +> InlineResponseDefault8 list_original_invoice(invoice_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.list_original_invoice(invoice_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling InvoicesApi->list_original_invoice: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **invoice_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault8**](InlineResponseDefault8.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_split_invoice** +> InlineResponseDefault8 list_split_invoice(invoice_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.list_split_invoice(invoice_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling InvoicesApi->list_split_invoice: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **invoice_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault8**](InlineResponseDefault8.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **recalculate_invoice** -> InvoicePagedMetadata recalculate_invoice(invoice_id, request) +> InlineResponseDefault29 recalculate_invoice(invoice_id, body=body) -Re-calculate an Invoice. -{\"nickname\":\"Re-calculate an invoice\",\"response\":\"recalculateInvoiceResponse.html\",\"request\":\"RecalculateInvoiceRequest.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) invoice_id = 'invoice_id_example' # str | -request = billforward.InvoiceRecalculationRequest() # InvoiceRecalculationRequest | +body = billforward.InvoiceRecalculationRequest() # InvoiceRecalculationRequest | (optional) -try: - # Re-calculate an Invoice. - api_response = api_instance.recalculate_invoice(invoice_id, request) +try: + api_response = api_instance.recalculate_invoice(invoice_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->recalculate_invoice: %s\n" % e + print("Exception when calling InvoicesApi->recalculate_invoice: %s\n" % e) ``` ### Parameters @@ -2085,15 +2354,15 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **invoice_id** | **str**| | - **request** | [**InvoiceRecalculationRequest**](InvoiceRecalculationRequest.md)| | + **body** | [**InvoiceRecalculationRequest**](InvoiceRecalculationRequest.md)| | [optional] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault29**](InlineResponseDefault29.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2102,32 +2371,79 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **refund_invoice** +> InlineResponseDefault36 refund_invoice(invoice_id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +body = billforward.InvoiceRefundRequest() # InvoiceRefundRequest | (optional) + +try: + api_response = api_instance.refund_invoice(invoice_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling InvoicesApi->refund_invoice: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **invoice_id** | **str**| | + **body** | [**InvoiceRefundRequest**](InvoiceRefundRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault36**](InlineResponseDefault36.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **remove_charge_from_invoice** -> SubscriptionChargePagedMetadata remove_charge_from_invoice(invoice_id, charge_id, organizations=organizations) +> InlineResponseDefault10 remove_charge_from_invoice(invoice_id, charge_id, organizations=organizations) -Removes the specified charge from the specified Invoice. -{\"nickname\":\"Remove from invoice\",\"response\":\"deleteChargesInvoice.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) invoice_id = 'invoice_id_example' # str | charge_id = 'charge_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Removes the specified charge from the specified Invoice. +try: api_response = api_instance.remove_charge_from_invoice(invoice_id, charge_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->remove_charge_from_invoice: %s\n" % e + print("Exception when calling InvoicesApi->remove_charge_from_invoice: %s\n" % e) ``` ### Parameters @@ -2136,48 +2452,47 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **invoice_id** | **str**| | **charge_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md) +[**InlineResponseDefault10**](InlineResponseDefault10.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **remove_metadata_from_invoice** -> DynamicMetadata remove_metadata_from_invoice(invoice_id, organizations=organizations) +> InlineResponseDefault7 remove_metadata_from_invoice(invoice_id, organizations=organizations) -Remove any associated metadata. -{\"nickname\":\"Clear metadata from invoice\",\"request\" :\"deleteInvoiceMetadataRequest.html\",\"response\":\"deleteInvoiceMetadataResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) invoice_id = 'invoice_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Remove any associated metadata. +try: api_response = api_instance.remove_metadata_from_invoice(invoice_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->remove_metadata_from_invoice: %s\n" % e + print("Exception when calling InvoicesApi->remove_metadata_from_invoice: %s\n" % e) ``` ### Parameters @@ -2185,66 +2500,113 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **invoice_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**DynamicMetadata**](DynamicMetadata.md) +[**InlineResponseDefault7**](InlineResponseDefault7.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **set_metadata_for_invoice** -> DynamicMetadata set_metadata_for_invoice(metadata, invoice_id, organizations=organizations) +> InlineResponseDefault7 set_metadata_for_invoice(invoice_id, body=body, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +body = 'body_example' # str | (optional) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.set_metadata_for_invoice(invoice_id, body=body, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling InvoicesApi->set_metadata_for_invoice: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **invoice_id** | **str**| | + **body** | [**str**](str.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault7**](InlineResponseDefault7.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **split_invoice** +> InlineResponseDefault8 split_invoice(invoice_id, body=body) -Remove any existing metadata keys and create the provided data. -{\"nickname\":\"Set metadata on invoice\",\"request\":\"setInvoiceMetadataRequest.html\",\"response\":\"setInvoiceMetadataResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -metadata = billforward.DynamicMetadata() # DynamicMetadata | +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) invoice_id = 'invoice_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +body = billforward.InvoiceSplitServiceRequest() # InvoiceSplitServiceRequest | (optional) -try: - # Remove any existing metadata keys and create the provided data. - api_response = api_instance.set_metadata_for_invoice(metadata, invoice_id, organizations=organizations) +try: + api_response = api_instance.split_invoice(invoice_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->set_metadata_for_invoice: %s\n" % e + print("Exception when calling InvoicesApi->split_invoice: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **metadata** | [**DynamicMetadata**](DynamicMetadata.md)| | **invoice_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **body** | [**InvoiceSplitServiceRequest**](InvoiceSplitServiceRequest.md)| | [optional] ### Return type -[**DynamicMetadata**](DynamicMetadata.md) +[**InlineResponseDefault8**](InlineResponseDefault8.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2254,95 +2616,139 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_invoice** -> InvoicePagedMetadata update_invoice(invoice) +> InlineResponseDefault8 update_invoice(body=body) -Update an Invoice. -{\"nickname\":\"Update an invoice\",\"response\":\"updateInvoiceResponse.html\",\"request\":\"updateInvoiceRequest.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -invoice = billforward.Invoice() # Invoice | The invoice object to be updated. +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +body = billforward.UpdateInvoiceRequest() # UpdateInvoiceRequest | (optional) -try: - # Update an Invoice. - api_response = api_instance.update_invoice(invoice) +try: + api_response = api_instance.update_invoice(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->update_invoice: %s\n" % e + print("Exception when calling InvoicesApi->update_invoice: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **invoice** | [**Invoice**](Invoice.md)| The invoice object to be updated. | + **body** | [**UpdateInvoiceRequest**](UpdateInvoiceRequest.md)| | [optional] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault8**](InlineResponseDefault8.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_invoice_template** +> InlineResponseDefault30 update_invoice_template(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +body = billforward.UpdateInvoiceTemplateRequest() # UpdateInvoiceTemplateRequest | (optional) + +try: + api_response = api_instance.update_invoice_template(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling InvoicesApi->update_invoice_template: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**UpdateInvoiceTemplateRequest**](UpdateInvoiceTemplateRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault30**](InlineResponseDefault30.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **upsert_metadata_for_invoice** -> DynamicMetadata upsert_metadata_for_invoice(metadata, invoice_id, organizations=organizations) +> InlineResponseDefault7 upsert_metadata_for_invoice(invoice_id, body=body, organizations=organizations) -Update any existing metadata key-values and insert any new key-values, no keys will be removed. -{\"nickname\":\"Upsert metadata on invoice\",\"request\":\"upsertInvoiceMetadataRequest.html\",\"response\":\"upsertInvoiceMetadataResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -metadata = billforward.DynamicMetadata() # DynamicMetadata | +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) invoice_id = 'invoice_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +body = 'body_example' # str | (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Update any existing metadata key-values and insert any new key-values, no keys will be removed. - api_response = api_instance.upsert_metadata_for_invoice(metadata, invoice_id, organizations=organizations) +try: + api_response = api_instance.upsert_metadata_for_invoice(invoice_id, body=body, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->upsert_metadata_for_invoice: %s\n" % e + print("Exception when calling InvoicesApi->upsert_metadata_for_invoice: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **metadata** | [**DynamicMetadata**](DynamicMetadata.md)| | **invoice_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **body** | [**str**](str.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**DynamicMetadata**](DynamicMetadata.md) +[**InlineResponseDefault7**](InlineResponseDefault7.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2352,50 +2758,51 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **void_invoice** -> InvoicePagedMetadata void_invoice(invoice_id, organizations) +> InlineResponseDefault29 void_invoice(invoice_id, organizations=organizations, void_charges=void_charges) -Voids the invoice specified by the invoice identifier parameter. -{ \"nickname\" : \"Void an invoice\",\"response\" : \"voidInvoice.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.InvoicesApi() -invoice_id = 'invoice_id_example' # str | ID of the invoice. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. +api_instance = billforward.InvoicesApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +void_charges = true # bool | (optional) (default to true) -try: - # Voids the invoice specified by the invoice identifier parameter. - api_response = api_instance.void_invoice(invoice_id, organizations) +try: + api_response = api_instance.void_invoice(invoice_id, organizations=organizations, void_charges=void_charges) pprint(api_response) except ApiException as e: - print "Exception when calling InvoicesApi->void_invoice: %s\n" % e + print("Exception when calling InvoicesApi->void_invoice: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **invoice_id** | **str**| ID of the invoice. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | + **invoice_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **void_charges** | **bool**| | [optional] [default to true] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault29**](InlineResponseDefault29.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/IssueInvoiceAmendment.md b/docs/IssueInvoiceAmendment.md index 15c02ca..e7d513d 100644 --- a/docs/IssueInvoiceAmendment.md +++ b/docs/IssueInvoiceAmendment.md @@ -3,20 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] -**invoice_id** | **str** | { \"description\" : \"Identifier of invoice to issue\", \"verbs\":[\"POST\",\"GET\"] } | +**invoice_id** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/IssueInvoiceRequest.md b/docs/IssueInvoiceRequest.md new file mode 100644 index 0000000..b5eda33 --- /dev/null +++ b/docs/IssueInvoiceRequest.md @@ -0,0 +1,10 @@ +# IssueInvoiceRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**payment_amount** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/IssueInvoiceResponse.md b/docs/IssueInvoiceResponse.md new file mode 100644 index 0000000..6f387ba --- /dev/null +++ b/docs/IssueInvoiceResponse.md @@ -0,0 +1,15 @@ +# IssueInvoiceResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**issued** | **bool** | | [optional] +**voided** | **bool** | | [optional] +**reason** | **str** | | [optional] +**invoice** | [**Invoice**](Invoice.md) | | [optional] +**reason_explanation** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/KashConfiguration.md b/docs/KashConfiguration.md new file mode 100644 index 0000000..7fdf22c --- /dev/null +++ b/docs/KashConfiguration.md @@ -0,0 +1,10 @@ +# KashConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key_filename** | **str** | | [optional] +**secret_key** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/LegacyCreateWebhookRequest.md b/docs/LegacyCreateWebhookRequest.md new file mode 100644 index 0000000..f5150ab --- /dev/null +++ b/docs/LegacyCreateWebhookRequest.md @@ -0,0 +1,11 @@ +# LegacyCreateWebhookRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**url** | **str** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ManualCharge.md b/docs/ManualCharge.md new file mode 100644 index 0000000..5ea17ab --- /dev/null +++ b/docs/ManualCharge.md @@ -0,0 +1,9 @@ +# ManualCharge + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**quantity** | **int** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/MarketplaceQuote.md b/docs/MarketplaceQuote.md new file mode 100644 index 0000000..4c8db5c --- /dev/null +++ b/docs/MarketplaceQuote.md @@ -0,0 +1,16 @@ +# MarketplaceQuote + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**invoice_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**calculator_results** | [**list[CalculatorResult]**](CalculatorResult.md) | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**total** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Metadata.md b/docs/Metadata.md new file mode 100644 index 0000000..346ccf1 --- /dev/null +++ b/docs/Metadata.md @@ -0,0 +1,10 @@ +# Metadata + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution_time** | **int** | | +**results** | [**list[Webhook]**](Webhook.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/MetadataApi.md b/docs/MetadataApi.md deleted file mode 100644 index 24c0f8f..0000000 --- a/docs/MetadataApi.md +++ /dev/null @@ -1,204 +0,0 @@ -# billforward.MetadataApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**delete_metadata_key_values**](MetadataApi.md#delete_metadata_key_values) | **DELETE** /metadata | Remove any associated metadata. -[**get_metadata_key_values**](MetadataApi.md#get_metadata_key_values) | **GET** /metadata | Retrieve any associated metadata. -[**set_metadata_key_values**](MetadataApi.md#set_metadata_key_values) | **POST** /metadata | Remove any existing metadata keys and create the provided data. -[**upsert_metadata_key_values**](MetadataApi.md#upsert_metadata_key_values) | **PUT** /metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed. - - -# **delete_metadata_key_values** -> DynamicMetadata delete_metadata_key_values(organizations=organizations) - -Remove any associated metadata. - -{\"nickname\":\"Clear metadata from organization\",\"request\" :\"deleteOrganizationMetadataRequest.html\",\"response\":\"deleteOrganizationMetadataResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.MetadataApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Remove any associated metadata. - api_response = api_instance.delete_metadata_key_values(organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling MetadataApi->delete_metadata_key_values: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DynamicMetadata**](DynamicMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_metadata_key_values** -> DynamicMetadata get_metadata_key_values(organizations=organizations) - -Retrieve any associated metadata. - -{\"nickname\":\"Retrieve metadata on organization\",\"request\":\"getOrganizationMetadataRequest.html\",\"response\":\"getOrganizationMetadataResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.MetadataApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retrieve any associated metadata. - api_response = api_instance.get_metadata_key_values(organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling MetadataApi->get_metadata_key_values: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DynamicMetadata**](DynamicMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **set_metadata_key_values** -> DynamicMetadata set_metadata_key_values(metadata, organizations=organizations) - -Remove any existing metadata keys and create the provided data. - -{\"nickname\":\"Set metadata on organization\",\"request\":\"setOrganizationMetadataRequest.html\",\"response\":\"setOrganizationMetadataResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.MetadataApi() -metadata = billforward.DynamicMetadata() # DynamicMetadata | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Remove any existing metadata keys and create the provided data. - api_response = api_instance.set_metadata_key_values(metadata, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling MetadataApi->set_metadata_key_values: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **metadata** | [**DynamicMetadata**](DynamicMetadata.md)| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DynamicMetadata**](DynamicMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upsert_metadata_key_values** -> DynamicMetadata upsert_metadata_key_values(metadata, organizations=organizations) - -Update any existing metadata key-values and insert any new key-values, no keys will be removed. - -{\"nickname\":\"Upsert metadata on organization\",\"request\":\"upsertOrganizationMetadataRequest.html\",\"response\":\"upsertOrganizationMetadataResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.MetadataApi() -metadata = billforward.DynamicMetadata() # DynamicMetadata | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Update any existing metadata key-values and insert any new key-values, no keys will be removed. - api_response = api_instance.upsert_metadata_key_values(metadata, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling MetadataApi->upsert_metadata_key_values: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **metadata** | [**DynamicMetadata**](DynamicMetadata.md)| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DynamicMetadata**](DynamicMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/MetadataKeyValues.md b/docs/MetadataKeyValues.md new file mode 100644 index 0000000..6dcaed1 --- /dev/null +++ b/docs/MetadataKeyValues.md @@ -0,0 +1,10 @@ +# MetadataKeyValues + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/MetadataKeyValuesPagedMetadata.md b/docs/MetadataKeyValuesPagedMetadata.md deleted file mode 100644 index 21d6e06..0000000 --- a/docs/MetadataKeyValuesPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# MetadataKeyValuesPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Migration.md b/docs/Migration.md new file mode 100644 index 0000000..78757b7 --- /dev/null +++ b/docs/Migration.md @@ -0,0 +1,16 @@ +# Migration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**configuration_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**migration_state** | **str** | | +**migrated** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/MigrationRequest.md b/docs/MigrationRequest.md index 8c9cc43..ff2e4cb 100644 --- a/docs/MigrationRequest.md +++ b/docs/MigrationRequest.md @@ -3,16 +3,19 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**next_subscription_name** | **str** | {\"description\":\"Name to which the subscription will change upon successful migration.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**next_subscription_description** | **str** | {\"description\":\"Description to which the subscription will change upon successful migration.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**product** | **str** | {\"description\":\"The product to which the subscription will be migrated.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**product_rate_plan** | **str** | {\"description\":\"The rate plan (of some product) to which the subscription will be migrated.\",\"verbs\":[\"POST\",\"GET\"]} | -**invoicing_type** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">Aggregated</span>\",\"description\":\"The strategy for how to raise invoices for charges caused by this migration.<br><span class=\\\"label label-default\\\">Immediate</span> &mdash; Generate straight-away an invoice containing these charges.<br><span class=\\\"label label-default\\\">Aggregated</span> &mdash; Add these charges to the next invoice which is generated naturally &mdash; i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} | -**mappings** | [**list[PricingComponentMigrationValue]**](PricingComponentMigrationValue.md) | {\"description\":\"List of pricing components and quantities thereof to be consumed in the new rate plan.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**pricing_behaviour** | **str** | {\"default\":\"DifferenceProRated\",\"description\":\"Pricing behaviour defines how migration charges are calculated.<br><span class=\\\"label label-default\\\">DifferenceProRated</span> &mdash; Calculate the difference between in-advance charges of the existing and new rate-plan, then pro-rate based on time remaining.<br><span class=\\\"label label-default\\\">None</span> &mdash; Set the migration charge as zero cost.<br><span class=\\\"label label-default\\\">Full</span> &mdash; Set the costs as the total of the new rate-plan's in-advance charges.<br><span class=\\\"label label-default\\\">Difference</span> &mdash; The same calculation as in <span class=\\\"label label-default\\\">DifferenceProRated</span>, but with no pro-ration applied.<br><span class=\\\"label label-default\\\">ProRated</span> &mdash; When moving to a rate-plan of the same duration: Pro-rates the in-advance charges of the new rate-plan.<br>When moving to a rate-plan of a different duration: A credit-note will be issued for the price of any remaining time on the existing plan's billing period.\",\"verbs\":[\"POST\",\"GET\"]} | -**dry_run** | **bool** | {\"default\":\"false\",\"description\":\"Calculate the effects of migration but do not actually perform a migration.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**next_subscription_name** | **str** | | [optional] +**next_subscription_description** | **str** | | [optional] +**product** | **str** | | [optional] +**product_rate_plan** | **str** | | [optional] +**invoicing_type** | **str** | | +**mappings** | [**list[PricingComponentMigrationValue]**](PricingComponentMigrationValue.md) | | [optional] +**pricing_behaviour** | **str** | | +**void_existing_coupons** | **bool** | | [optional] +**force_trial_end** | **bool** | | [optional] +**dry_run** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/MigrationResponse.md b/docs/MigrationResponse.md new file mode 100644 index 0000000..7fb5ad6 --- /dev/null +++ b/docs/MigrationResponse.md @@ -0,0 +1,33 @@ +# MigrationResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**next_subscription_name** | **str** | | [optional] +**next_subscription_description** | **str** | | [optional] +**product** | **str** | | [optional] +**product_rate_plan** | **str** | | [optional] +**invoicing_type** | **str** | | +**mappings** | [**list[PricingComponentMigrationValue]**](PricingComponentMigrationValue.md) | | [optional] +**pricing_behaviour** | **str** | | +**void_existing_coupons** | **bool** | | [optional] +**force_trial_end** | **bool** | | [optional] +**dry_run** | **bool** | | [optional] +**new_subscription_id** | **str** | | [optional] +**new_subscription** | [**Subscription**](Subscription.md) | | [optional] +**previous_subscription** | [**Subscription**](Subscription.md) | | [optional] +**previous_product_rate_plan_id** | **str** | | [optional] +**previous_product_rate_plan_name** | **str** | | [optional] +**new_product_rate_plan_id** | **str** | | [optional] +**new_product_rate_plan_name** | **str** | | [optional] +**charge_type** | **str** | | [optional] +**amount** | **float** | | [optional] +**tax** | **float** | | [optional] +**invoices** | [**list[Invoice]**](Invoice.md) | | [optional] +**amendment** | [**Amendment**](Amendment.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/MutableBillingEntity.md b/docs/MutableBillingEntity.md deleted file mode 100644 index 9abd696..0000000 --- a/docs/MutableBillingEntity.md +++ /dev/null @@ -1,29 +0,0 @@ -# MutableBillingEntity - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | ID of the Synchronization Job. | [optional] -**config_id** | **str** | This is config id which links to this sync job. | -**organization_id** | **str** | Organization associated with the refund. | -**state** | **str** | This is the state of job. Pending jobs have not run. Complete jobs have run without error. Failed jobs have one of more errors. Cancelled jobs did not run. | -**type** | **str** | This is the type of job. Incremental jobs just sync changes, fully jobs sync all data. | -**scope** | **str** | The scope of the data synch'd. | -**target** | **str** | This is the target of the job. | -**name** | **str** | Name of the Job. | -**description** | **str** | Description of the Job. | -**data_from** | **datetime** | UTC DateTime of the start of the data to sync. | [optional] -**data_till** | **datetime** | UTC DateTime of the start of the data to sync. | [optional] -**started** | **datetime** | UTC DateTime of the end of the data to sync. | [optional] -**stopped** | **datetime** | UTC DateTime of the start of the data to sync. | [optional] -**created_by** | **str** | The account who created the synch job. | [optional] -**max_retry_times** | **int** | The max number of times the records will try to resync. | -**retry_attempted** | **int** | The number of times the records tried to resync. | -**deleted** | **bool** | Is the sync job deleted. | [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NestedAdhocChargeRequest.md b/docs/NestedAdhocChargeRequest.md new file mode 100644 index 0000000..35a1e53 --- /dev/null +++ b/docs/NestedAdhocChargeRequest.md @@ -0,0 +1,17 @@ +# NestedAdhocChargeRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**amount** | **float** | | [optional] +**tax_amount** | **bool** | | [optional] +**charge_type** | **str** | | [optional] +**trial** | **bool** | | [optional] +**quantity** | **int** | | [optional] +**period_start** | **datetime** | | [optional] +**period_end** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/NestedChargeRequest.md b/docs/NestedChargeRequest.md new file mode 100644 index 0000000..310be07 --- /dev/null +++ b/docs/NestedChargeRequest.md @@ -0,0 +1,21 @@ +# NestedChargeRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**amount** | **float** | | [optional] +**tax_amount** | **bool** | | [optional] +**period_start** | **datetime** | | [optional] +**period_end** | **datetime** | | [optional] +**charge_type** | **str** | | [optional] +**trial** | **bool** | | [optional] +**product** | **str** | | [optional] +**product_rate_plan** | **str** | | [optional] +**pricing_component** | **str** | | [optional] +**pricing_component_value** | **int** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Notification.md b/docs/Notification.md deleted file mode 100644 index aab2cbe..0000000 --- a/docs/Notification.md +++ /dev/null @@ -1,29 +0,0 @@ -# Notification - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**domain** | **str** | { \"description\" : \"The domain of the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**action** | **str** | { \"description\" : \"The action associated with the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"Organization associated with the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**webhook_id** | **str** | { \"description\" : \"Webhook associated with the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**entity_id** | **str** | { \"description\" : \"The id of the entity associated with the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**destination_url** | **str** | { \"description\" : \"The URL the notification will be sent to.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**format** | **str** | { \"description\" : \"Format of the notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**ack_enabled** | **bool** | { \"description\" : \"If true notifications will continue to be sent until an acknowledgment is received.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] -**entity** | **list[str]** | | [optional] -**changes** | **list[str]** | | [optional] -**last_send_attempt** | **datetime** | { \"description\" : \"The UTC DateTime of the notifications's last send attempt.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**next_send_attempt** | **datetime** | { \"description\" : \"The UTC DateTime of the notification's next send attempt.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**final_send_attempt** | **datetime** | { \"description\" : \"The UTC DateTime of the notification's final send attempt.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**total_send_attempts** | **int** | { \"description\" : \"The number of send attempts for this notification.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**state** | **str** | { \"description\" : \"Whether the notification has been sent.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**acked** | **datetime** | { \"description\" : \"The UTC DateTime when the notification was acked if it is ack enabled.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NotificationPagedMetadata.md b/docs/NotificationPagedMetadata.md deleted file mode 100644 index 7649af7..0000000 --- a/docs/NotificationPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# NotificationPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Notification]**](Notification.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NotificationSendRequest.md b/docs/NotificationSendRequest.md new file mode 100644 index 0000000..ebd043a --- /dev/null +++ b/docs/NotificationSendRequest.md @@ -0,0 +1,9 @@ +# NotificationSendRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**force_send** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/NotificationSendResponse.md b/docs/NotificationSendResponse.md new file mode 100644 index 0000000..c10db75 --- /dev/null +++ b/docs/NotificationSendResponse.md @@ -0,0 +1,26 @@ +# NotificationSendResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**id** | **str** | | [optional] +**domain** | **str** | | [optional] +**action** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**webhook_id** | **str** | | [optional] +**entity_id** | **str** | | [optional] +**destination_url** | **str** | | [optional] +**entity** | **list[str]** | | [optional] +**changes** | **list[str]** | | [optional] +**last_send_attempt** | **datetime** | | [optional] +**next_send_attempt** | **datetime** | | [optional] +**final_send_attempt** | **datetime** | | [optional] +**total_send_attempts** | **int** | | [optional] +**state** | **str** | | [optional] +**http_response_code** | **int** | | [optional] +**http_response_message** | **str** | | [optional] +**http_response_body** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Notifications.md b/docs/Notifications.md new file mode 100644 index 0000000..5a19610 --- /dev/null +++ b/docs/Notifications.md @@ -0,0 +1,29 @@ +# Notifications + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**domain** | **str** | | +**action** | **str** | | +**organization_id** | **str** | | +**webhook_id** | **str** | | [optional] +**audit_entry_id** | **str** | | [optional] +**entity_id** | **str** | | +**destination_url** | **str** | | +**format** | **str** | | +**ack_enabled** | **bool** | | +**entity** | **list[str]** | | [optional] +**changes** | **list[str]** | | [optional] +**last_send_attempt** | **datetime** | | [optional] +**next_send_attempt** | **datetime** | | [optional] +**final_send_attempt** | **datetime** | | [optional] +**total_send_attempts** | **int** | | [optional] +**state** | **str** | | +**acked** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/NotificationsApi.md b/docs/NotificationsApi.md index 520e4a3..48ca509 100644 --- a/docs/NotificationsApi.md +++ b/docs/NotificationsApi.md @@ -1,115 +1,122 @@ # billforward.NotificationsApi -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**ack_notification**](NotificationsApi.md#ack_notification) | **GET** /notifications/ack/{notification-ID} | Acknowledge a newly recevied notification. -[**get_all_notifications**](NotificationsApi.md#get_all_notifications) | **GET** /notifications | Returns a collection of all notifications. By default 10 values are returned. Records are returned in natural order. -[**get_notification_by_entity_id**](NotificationsApi.md#get_notification_by_entity_id) | **GET** /notifications/entity-ID/{entity-ID} | Returns a collection of notifications, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_notification_by_id**](NotificationsApi.md#get_notification_by_id) | **GET** /notifications/{notification-ID} | Returns a single notification, specified by the notification-ID parameter. -[**get_notifications_by_webhook_id**](NotificationsApi.md#get_notifications_by_webhook_id) | **GET** /notifications/{lower-threshold}/{upper-threshold}/{webhookID} | Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters for the given webhook id. By default 10 values are returned. Records are returned in natural order. -[**get_notifications_within_date_range**](NotificationsApi.md#get_notifications_within_date_range) | **GET** /notifications/{lower-threshold}/{upper-threshold} | Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. +[**get_all_notifications**](NotificationsApi.md#get_all_notifications) | **GET** /notifications | +[**get_notification_by_entity_id**](NotificationsApi.md#get_notification_by_entity_id) | **GET** /notifications/entity-ID/{entity-ID} | +[**get_notification_by_id**](NotificationsApi.md#get_notification_by_id) | **GET** /notifications/{notification-ID} | +[**get_notifications_by_webhook_id**](NotificationsApi.md#get_notifications_by_webhook_id) | **GET** /notifications/{lower-threshold}/{upper-threshold}/{webhookID} | +[**get_notifications_within_date_range**](NotificationsApi.md#get_notifications_within_date_range) | **GET** /notifications/{lower-threshold}/{upper-threshold} | +[**resend_notification**](NotificationsApi.md#resend_notification) | **POST** /notifications/{notification-ID}/resend | +# **get_all_notifications** +> InlineResponseDefault37 get_all_notifications(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -# **ack_notification** -> NotificationPagedMetadata ack_notification(notification_id, organizations=organizations) - -Acknowledge a newly recevied notification. -{\"nickname\":\"Acknowledge\",\"response\":\"getNotificationACK.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint -# create an instance of the API class -api_instance = billforward.NotificationsApi() -notification_id = 'notification_id_example' # str | ID of the notification. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -try: - # Acknowledge a newly recevied notification. - api_response = api_instance.ack_notification(notification_id, organizations=organizations) +# create an instance of the API class +api_instance = billforward.NotificationsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) + +try: + api_response = api_instance.get_all_notifications(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling NotificationsApi->ack_notification: %s\n" % e + print("Exception when calling NotificationsApi->get_all_notifications: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **notification_id** | **str**| ID of the notification. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to true] ### Return type -[**NotificationPagedMetadata**](NotificationPagedMetadata.md) +[**InlineResponseDefault37**](InlineResponseDefault37.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_notifications** -> NotificationPagedMetadata get_all_notifications(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +# **get_notification_by_entity_id** +> InlineResponseDefault37 get_notification_by_entity_id(entity_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Returns a collection of all notifications. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Get all notifications\",\"response\":\"getNotificationAll.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.NotificationsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first Subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of Subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of all notifications. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_notifications(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +api_instance = billforward.NotificationsApi(billforward.ApiClient(configuration)) +entity_id = 'entity_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) + +try: + api_response = api_instance.get_notification_by_entity_id(entity_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling NotificationsApi->get_all_notifications: %s\n" % e + print("Exception when calling NotificationsApi->get_notification_by_entity_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first Subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of Subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] + **entity_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to true] ### Return type -[**NotificationPagedMetadata**](NotificationPagedMetadata.md) +[**InlineResponseDefault37**](InlineResponseDefault37.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -118,171 +125,178 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_notification_by_entity_id** -> NotificationPagedMetadata get_notification_by_entity_id(entity_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +# **get_notification_by_id** +> InlineResponseDefault38 get_notification_by_id(notification_id, organizations=organizations) -Returns a collection of notifications, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by entity\",\"response\":\"getNotificationBySubscriptionID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.NotificationsApi() -entity_id = 'entity_id_example' # str | The string entity-ID of the notification. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first notification to return. (optional) (default to 0) -records = 10 # int | The maximum number of notifications to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of notifications, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_notification_by_entity_id(entity_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +api_instance = billforward.NotificationsApi(billforward.ApiClient(configuration)) +notification_id = 'notification_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_notification_by_id(notification_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling NotificationsApi->get_notification_by_entity_id: %s\n" % e + print("Exception when calling NotificationsApi->get_notification_by_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **entity_id** | **str**| The string entity-ID of the notification. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first notification to return. | [optional] [default to 0] - **records** | **int**| The maximum number of notifications to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] + **notification_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**NotificationPagedMetadata**](NotificationPagedMetadata.md) +[**InlineResponseDefault38**](InlineResponseDefault38.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_notification_by_id** -> NotificationPagedMetadata get_notification_by_id(notification_id, organizations=organizations) +# **get_notifications_by_webhook_id** +> InlineResponseDefault37 get_notifications_by_webhook_id(lower_threshold, upper_threshold, webhook_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, safety_margin=safety_margin) -Returns a single notification, specified by the notification-ID parameter. -{\"nickname\":\"Retrieve an existing notification\",\"response\":\"getNotificationByID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint -# create an instance of the API class -api_instance = billforward.NotificationsApi() -notification_id = 'notification_id_example' # str | ID of the notification. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -try: - # Returns a single notification, specified by the notification-ID parameter. - api_response = api_instance.get_notification_by_id(notification_id, organizations=organizations) +# create an instance of the API class +api_instance = billforward.NotificationsApi(billforward.ApiClient(configuration)) +lower_threshold = billforward.SimpleDateParam() # SimpleDateParam | +upper_threshold = billforward.SimpleDateParam() # SimpleDateParam | +webhook_id = 'webhook_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) +safety_margin = 10 # int | (optional) (default to 10) + +try: + api_response = api_instance.get_notifications_by_webhook_id(lower_threshold, upper_threshold, webhook_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, safety_margin=safety_margin) pprint(api_response) except ApiException as e: - print "Exception when calling NotificationsApi->get_notification_by_id: %s\n" % e + print("Exception when calling NotificationsApi->get_notifications_by_webhook_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **notification_id** | **str**| ID of the notification. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **lower_threshold** | [**SimpleDateParam**](.md)| | + **upper_threshold** | [**SimpleDateParam**](.md)| | + **webhook_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to true] + **safety_margin** | **int**| | [optional] [default to 10] ### Return type -[**NotificationPagedMetadata**](NotificationPagedMetadata.md) +[**InlineResponseDefault37**](InlineResponseDefault37.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_notifications_by_webhook_id** -> NotificationPagedMetadata get_notifications_by_webhook_id(lower_threshold, upper_threshold, webhook_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, safety_margin=safety_margin) +# **get_notifications_within_date_range** +> InlineResponseDefault37 get_notifications_within_date_range(lower_threshold, upper_threshold, organizations=organizations, domain=domain, action=action, webhook_id=webhook_id, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, safety_margin=safety_margin) -Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters for the given webhook id. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by creation\",\"response\":\"getNotificationByCreated.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.NotificationsApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -webhook_id = 'webhook_id_example' # str | The id of the webhook. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) -safety_margin = 10 # int | How many seconds behind server-time upperThreshold may approach. (optional) (default to 10) - -try: - # Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters for the given webhook id. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_notifications_by_webhook_id(lower_threshold, upper_threshold, webhook_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, safety_margin=safety_margin) +api_instance = billforward.NotificationsApi(billforward.ApiClient(configuration)) +lower_threshold = billforward.SimpleDateParam() # SimpleDateParam | +upper_threshold = billforward.SimpleDateParam() # SimpleDateParam | +organizations = ['organizations_example'] # list[str] | (optional) +domain = 'domain_example' # str | (optional) +action = 'action_example' # str | (optional) +webhook_id = 'webhook_id_example' # str | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) +safety_margin = 10 # int | (optional) (default to 10) + +try: + api_response = api_instance.get_notifications_within_date_range(lower_threshold, upper_threshold, organizations=organizations, domain=domain, action=action, webhook_id=webhook_id, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, safety_margin=safety_margin) pprint(api_response) except ApiException as e: - print "Exception when calling NotificationsApi->get_notifications_by_webhook_id: %s\n" % e + print("Exception when calling NotificationsApi->get_notifications_within_date_range: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **webhook_id** | **str**| The id of the webhook. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - **safety_margin** | **int**| How many seconds behind server-time upperThreshold may approach. | [optional] [default to 10] + **lower_threshold** | [**SimpleDateParam**](.md)| | + **upper_threshold** | [**SimpleDateParam**](.md)| | + **organizations** | [**list[str]**](str.md)| | [optional] + **domain** | **str**| | [optional] + **action** | **str**| | [optional] + **webhook_id** | **str**| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to true] + **safety_margin** | **int**| | [optional] [default to 10] ### Return type -[**NotificationPagedMetadata**](NotificationPagedMetadata.md) +[**InlineResponseDefault37**](InlineResponseDefault37.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -291,65 +305,50 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_notifications_within_date_range** -> NotificationPagedMetadata get_notifications_within_date_range(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, safety_margin=safety_margin) +# **resend_notification** +> InlineResponseDefault39 resend_notification(notification_id, body=body) -Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by creation\",\"response\":\"getNotificationByCreated.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.NotificationsApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) -safety_margin = 10 # int | How many seconds behind server-time upperThreshold may approach. (optional) (default to 10) - -try: - # Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_notifications_within_date_range(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, safety_margin=safety_margin) +api_instance = billforward.NotificationsApi(billforward.ApiClient(configuration)) +notification_id = 'notification_id_example' # str | +body = billforward.NotificationSendRequest() # NotificationSendRequest | (optional) + +try: + api_response = api_instance.resend_notification(notification_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling NotificationsApi->get_notifications_within_date_range: %s\n" % e + print("Exception when calling NotificationsApi->resend_notification: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - **safety_margin** | **int**| How many seconds behind server-time upperThreshold may approach. | [optional] [default to 10] + **notification_id** | **str**| | + **body** | [**NotificationSendRequest**](NotificationSendRequest.md)| | [optional] ### Return type -[**NotificationPagedMetadata**](NotificationPagedMetadata.md) +[**InlineResponseDefault39**](InlineResponseDefault39.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: */* - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/OAuthToken.md b/docs/OAuthToken.md new file mode 100644 index 0000000..8f0f1c0 --- /dev/null +++ b/docs/OAuthToken.md @@ -0,0 +1,10 @@ +# OAuthToken + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_token** | **str** | | [optional] +**refresh_token** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/OfflinePayment.md b/docs/OfflinePayment.md new file mode 100644 index 0000000..4bdf338 --- /dev/null +++ b/docs/OfflinePayment.md @@ -0,0 +1,12 @@ +# OfflinePayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reference** | **str** | | [optional] +**description** | **str** | | [optional] +**name** | **str** | | [optional] +**offline_payment_type** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/OpenIDRegistrationResponse.md b/docs/OpenIDRegistrationResponse.md new file mode 100644 index 0000000..4f942c7 --- /dev/null +++ b/docs/OpenIDRegistrationResponse.md @@ -0,0 +1,10 @@ +# OpenIDRegistrationResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/OpenIdUserLinkRequest.md b/docs/OpenIdUserLinkRequest.md new file mode 100644 index 0000000..2f8177f --- /dev/null +++ b/docs/OpenIdUserLinkRequest.md @@ -0,0 +1,11 @@ +# OpenIdUserLinkRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**provider** | **str** | | [optional] +**password_reset_code** | **str** | | [optional] +**id_token** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Organization.md b/docs/Organization.md deleted file mode 100644 index 1088027..0000000 --- a/docs/Organization.md +++ /dev/null @@ -1,23 +0,0 @@ -# Organization - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the organization.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**customer_code** | **str** | { \"description\" : \"A shortcode for the organization. This is used as a short reference code for use when referring to the organization, by default this is set to the organizations name.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**name** | **str** | { \"description\" : \"The name of the organization.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"Indicates if an organization has been retired. If an organization has been retired it can still be retrieved using the appropriate flag on API requests.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] -**webhooks** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | { \"description\" : \"The WebHooks associated with the organization. These are the end-points where notifications are sent. WebHooks are added, updated and removed from the organization. Thus to add a WebHook, the webhook must be defined on this property of the organization and then the organization updated. To update a WebHook the same procedure must be followed, first retrieving the organization followed by updating the appropriate WebHook, finally the organization is updated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**alias** | [**list[Alias]**](Alias.md) | | [optional] -**clients** | [**list[Client]**](Client.md) | { \"description\" : \"The OAuth2 clients associated with the organization. In most cases an organization would not have any clients associated with their account. In the case of an APP developer, a clients would exist per an application they have developed. To further understand clients please see the client, OAuth2 API and APP development documentation.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**dunning_lines** | [**list[DunningLine]**](DunningLine.md) | { \"description\" : \"The dunning-lines associated with the organization. Dunning lines are used as re-try logic for invoices to attempt to reconcile the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**taxation_strategies** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | { \"description\" : \"The taxation-strategies associated with the organization. Taxation-strategies may be linked to product-rate-plans to specify how their tax should be calculated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**organization_gateways** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | { \"description\" : \"The card-vault gateways associated with the organization.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**api_configurations** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | { \"description\" : \"Stores the organizations 3rd party API keys which may be used by the system for payment gateway integration etc.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/OrganizationLiteView.md b/docs/OrganizationLiteView.md new file mode 100644 index 0000000..25e6a63 --- /dev/null +++ b/docs/OrganizationLiteView.md @@ -0,0 +1,14 @@ +# OrganizationLiteView + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**id** | **str** | | [optional] +**customer_code** | **str** | | [optional] +**name** | **str** | | [optional] +**deleted** | **bool** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/OrganizationPagedMetadata.md b/docs/OrganizationPagedMetadata.md deleted file mode 100644 index b7d7cac..0000000 --- a/docs/OrganizationPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# OrganizationPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Organization]**](Organization.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/OrganizationsApi.md b/docs/OrganizationsApi.md deleted file mode 100644 index bf154f8..0000000 --- a/docs/OrganizationsApi.md +++ /dev/null @@ -1,370 +0,0 @@ -# billforward.OrganizationsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_organization**](OrganizationsApi.md#create_organization) | **POST** /organizations | Create an organization. -[**get_all_my_organizations**](OrganizationsApi.md#get_all_my_organizations) | **GET** /organizations/mine | Returns a collection of all my asociated organizations. By default 10 values are returned. Records are returned in natural order. -[**get_all_organizations**](OrganizationsApi.md#get_all_organizations) | **GET** /organizations | Returns a collection of all organizations. By default 10 values are returned. Records are returned in natural order. -[**get_organization_by_customer_code**](OrganizationsApi.md#get_organization_by_customer_code) | **GET** /organizations/customer-code/{customer-code} | Returns a single organization, specified by the customer-code parameter. -[**get_organization_by_id**](OrganizationsApi.md#get_organization_by_id) | **GET** /organizations/{organization-ID} | Returns a single Organization, specified by the organization-ID parameter. -[**get_organization_by_name**](OrganizationsApi.md#get_organization_by_name) | **GET** /organizations/name/{name} | Returns a single Organization, specified by the name parameter. -[**update_organization**](OrganizationsApi.md#update_organization) | **PUT** /organizations | Update an organization. - - -# **create_organization** -> OrganizationPagedMetadata create_organization(organization) - -Create an organization. - -{\"nickname\":\"Create\",\"request\":\"createOrganizationRequest.html\",\"response\":\"createOrganizationResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.OrganizationsApi() -organization = billforward.Organization() # Organization | The organization object to be updated. - -try: - # Create an organization. - api_response = api_instance.create_organization(organization) - pprint(api_response) -except ApiException as e: - print "Exception when calling OrganizationsApi->create_organization: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organization** | [**Organization**](Organization.md)| The organization object to be updated. | - -### Return type - -[**OrganizationPagedMetadata**](OrganizationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_my_organizations** -> OrganizationPagedMetadata get_all_my_organizations(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of all my asociated organizations. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get Mine\",\"response\":\"getOrganizationAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.OrganizationsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first organization to return. (optional) (default to 0) -records = 10 # int | The maximum number of organizations to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of all my asociated organizations. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_my_organizations(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling OrganizationsApi->get_all_my_organizations: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first organization to return. | [optional] [default to 0] - **records** | **int**| The maximum number of organizations to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**OrganizationPagedMetadata**](OrganizationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_organizations** -> OrganizationPagedMetadata get_all_organizations(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of all organizations. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get All\",\"response\":\"getOrganizationAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.OrganizationsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first organization to return. (optional) (default to 0) -records = 10 # int | The maximum number of organizations to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of all organizations. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_organizations(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling OrganizationsApi->get_all_organizations: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first organization to return. | [optional] [default to 0] - **records** | **int**| The maximum number of organizations to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**OrganizationPagedMetadata**](OrganizationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_organization_by_customer_code** -> OrganizationPagedMetadata get_organization_by_customer_code(customer_code, organizations=organizations) - -Returns a single organization, specified by the customer-code parameter. - -{\"nickname\":\"Retrieve by Customer-Code\",\"response\":\"getOrganizationByCustomer.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.OrganizationsApi() -customer_code = 'customer_code_example' # str | The unique customer code of the organization. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single organization, specified by the customer-code parameter. - api_response = api_instance.get_organization_by_customer_code(customer_code, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling OrganizationsApi->get_organization_by_customer_code: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **customer_code** | **str**| The unique customer code of the organization. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**OrganizationPagedMetadata**](OrganizationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_organization_by_id** -> OrganizationPagedMetadata get_organization_by_id(organization_id, organizations=organizations) - -Returns a single Organization, specified by the organization-ID parameter. - -{\"nickname\":\"Retrieve by id\",\"response\":\"getOrganizationByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.OrganizationsApi() -organization_id = 'organization_id_example' # str | ID of the organization. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single Organization, specified by the organization-ID parameter. - api_response = api_instance.get_organization_by_id(organization_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling OrganizationsApi->get_organization_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organization_id** | **str**| ID of the organization. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**OrganizationPagedMetadata**](OrganizationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_organization_by_name** -> OrganizationPagedMetadata get_organization_by_name(name, organizations=organizations) - -Returns a single Organization, specified by the name parameter. - -{\"nickname\":\"Retrieve by Name\",\"response\":\"getOrganizationByName.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.OrganizationsApi() -name = 'name_example' # str | The name of the Organization. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single Organization, specified by the name parameter. - api_response = api_instance.get_organization_by_name(name, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling OrganizationsApi->get_organization_by_name: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **name** | **str**| The name of the Organization. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**OrganizationPagedMetadata**](OrganizationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_organization** -> OrganizationPagedMetadata update_organization(organization) - -Update an organization. - -{\"nickname\":\"Updated\",\"request\":\"updateOrganizationRequest.html\",\"response\":\"updateOrganizationResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.OrganizationsApi() -organization = billforward.Organization() # Organization | The organization object to be updated. - -try: - # Update an organization. - api_response = api_instance.update_organization(organization) - pprint(api_response) -except ApiException as e: - print "Exception when calling OrganizationsApi->update_organization: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organization** | [**Organization**](Organization.md)| The organization object to be updated. | - -### Return type - -[**OrganizationPagedMetadata**](OrganizationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/Password.md b/docs/Password.md index 536102e..10cac55 100644 --- a/docs/Password.md +++ b/docs/Password.md @@ -3,14 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the password.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**user_id** | **str** | { \"description\" : \"ID of the user associated with the password.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"Organization associated with the user\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**password** | **str** | { \"description\" : \"The password.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**active** | **bool** | { \"description\" : \"Is this the active password.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**id** | **str** | | [optional] +**user_id** | **str** | | +**organization_id** | **str** | | +**password** | **str** | | +**active** | **bool** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PasswordPagedMetadata.md b/docs/PasswordPagedMetadata.md deleted file mode 100644 index e84d17e..0000000 --- a/docs/PasswordPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# PasswordPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Password]**](Password.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PasswordResetCodeRequest.md b/docs/PasswordResetCodeRequest.md new file mode 100644 index 0000000..2659969 --- /dev/null +++ b/docs/PasswordResetCodeRequest.md @@ -0,0 +1,9 @@ +# PasswordResetCodeRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PasswordResetResponse.md b/docs/PasswordResetResponse.md new file mode 100644 index 0000000..01b56a6 --- /dev/null +++ b/docs/PasswordResetResponse.md @@ -0,0 +1,11 @@ +# PasswordResetResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**password_reset_valid_till** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PasswordUpdateWithResetCodeRequest.md b/docs/PasswordUpdateWithResetCodeRequest.md new file mode 100644 index 0000000..6ce15a5 --- /dev/null +++ b/docs/PasswordUpdateWithResetCodeRequest.md @@ -0,0 +1,12 @@ +# PasswordUpdateWithResetCodeRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**password_reset_code** | **str** | | [optional] +**new_password** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PasswordsApi.md b/docs/PasswordsApi.md deleted file mode 100644 index badd8cd..0000000 --- a/docs/PasswordsApi.md +++ /dev/null @@ -1,56 +0,0 @@ -# billforward.PasswordsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_password**](PasswordsApi.md#create_password) | **POST** /passwords | Create - - -# **create_password** -> PasswordPagedMetadata create_password(password) - -Create - -{\"nickname\":\"Create\",\"request\":\"createPasswordRequest.html\",\"response\":\"createPasswordResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PasswordsApi() -password = billforward.Password() # Password | The password object to be created. - -try: - # Create - api_response = api_instance.create_password(password) - pprint(api_response) -except ApiException as e: - print "Exception when calling PasswordsApi->create_password: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **password** | [**Password**](Password.md)| The password object to be created. | - -### Return type - -[**PasswordPagedMetadata**](PasswordPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PauseRequest.md b/docs/PauseRequest.md index d2fb75f..a7c5e89 100644 --- a/docs/PauseRequest.md +++ b/docs/PauseRequest.md @@ -3,9 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**resume** | **datetime** | {\"default\":\"(No resumption is scheduled)\",\"description\":\"Schedules the frozen subscription to resume at some time.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] +**created** | **datetime** | | [optional] +**resume** | **datetime** | | [optional] +**new_subscription_start** | **datetime** | | [optional] +**new_subscription_state** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**dry_run** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PayVisionAuthCaptureRequest.md b/docs/PayVisionAuthCaptureRequest.md new file mode 100644 index 0000000..848adfd --- /dev/null +++ b/docs/PayVisionAuthCaptureRequest.md @@ -0,0 +1,10 @@ +# PayVisionAuthCaptureRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**registration_id** | **str** | | +**registration_resource_path** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PayVisionConfiguration.md b/docs/PayVisionConfiguration.md new file mode 100644 index 0000000..2b825ed --- /dev/null +++ b/docs/PayVisionConfiguration.md @@ -0,0 +1,13 @@ +# PayVisionConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key_filename** | **str** | | [optional] +**domain** | **str** | | [optional] +**entity_id** | **str** | | [optional] +**password** | **str** | | [optional] +**user_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PayVisionPreAuthRequest.md b/docs/PayVisionPreAuthRequest.md new file mode 100644 index 0000000..2410797 --- /dev/null +++ b/docs/PayVisionPreAuthRequest.md @@ -0,0 +1,8 @@ +# PayVisionPreAuthRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Payment.md b/docs/Payment.md index dc358e7..d840854 100644 --- a/docs/Payment.md +++ b/docs/Payment.md @@ -3,24 +3,27 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**crm_id** | **str** | { \"description\" : \"CRM ID of the invoice.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**payment_method_id** | **str** | { \"description\" : \"ID of the payment method associated with the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**invoice_id** | **str** | { \"description\" : \"ID of the invoice associated with the payment. This may be null when a payment is not explicitly associated with an invoice. Payments may be used across multiple invoices.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**gateway** | **str** | { \"description\" : \"Payment gateway associated with the payment\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**currency** | **str** | { \"description\" : \"The currency of the payment specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**nominal_value** | **float** | { \"description\" : \"Nominal value of the payment. This is the theoretical value of the payment, thus the value this payment can pay off an invoice. For example a coupon has a nominal value of the discount, and the actual value is zero.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**actual_value** | **float** | { \"description\" : \"Actual monetary value of the payment. This is real value of the payment amount, thus the amount of currency received for this payment. A coupon has a real value of zero, even though the nominal amount it pays may be greater than zero.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**remaining_nominal_value** | **float** | { \"description\" : \"Remaining nominal value of the payment not used. In the case when a payment is used across a range of invoices a payment may be used multiple times, each use reducing the available blance of the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**payment_received** | **datetime** | { \"description\" : \"UTC DateTime specifying when payment was received for the invoice.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**refunded_value** | **float** | { \"description\" : \"Refunded nominal value of the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**refund_id** | **str** | { \"description\" : \"ID of the refund associated with the payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**type** | **str** | { \"description\" : \"Type of payment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**metadata** | **dict(str, object)** | | [optional] +**id** | **str** | | [optional] +**crm_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**payment_method_id** | **str** | | [optional] +**invoice_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**gateway** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | +**nominal_value** | **float** | | +**actual_value** | **float** | | +**payment_received** | **datetime** | | [optional] +**refunded_value** | **float** | | [optional] +**refund_id** | **str** | | [optional] +**type** | **str** | | +**remaining_nominal_value** | **float** | | +**type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentAccountingView.md b/docs/PaymentAccountingView.md new file mode 100644 index 0000000..a72b200 --- /dev/null +++ b/docs/PaymentAccountingView.md @@ -0,0 +1,20 @@ +# PaymentAccountingView + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**payment_method_id** | **str** | | [optional] +**invoice_id** | **str** | | [optional] +**actual_value** | **float** | | [optional] +**nominal_value** | **float** | | [optional] +**remaining_value** | **float** | | [optional] +**refunded_value** | **float** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**gateway** | **str** | | [optional] +**payment_received** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PaymentGatewayApi.md b/docs/PaymentGatewayApi.md new file mode 100644 index 0000000..664ed1d --- /dev/null +++ b/docs/PaymentGatewayApi.md @@ -0,0 +1,260 @@ +# billforward.PaymentGatewayApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_api_configuration**](PaymentGatewayApi.md#create_api_configuration) | **POST** /configurations | +[**get_all_api_configurations**](PaymentGatewayApi.md#get_all_api_configurations) | **GET** /configurations | +[**get_api_configurations_by_type**](PaymentGatewayApi.md#get_api_configurations_by_type) | **GET** /configurations/type/{configuration-type} | +[**public_configuration**](PaymentGatewayApi.md#public_configuration) | **GET** /configurations/public | +[**update_api_configuration**](PaymentGatewayApi.md#update_api_configuration) | **PUT** /configurations | + +# **create_api_configuration** +> InlineResponseDefault14 create_api_configuration(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.PaymentGatewayApi(billforward.ApiClient(configuration)) +body = billforward.APIConfiguration() # APIConfiguration | (optional) + +try: + api_response = api_instance.create_api_configuration(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling PaymentGatewayApi->create_api_configuration: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**APIConfiguration**](APIConfiguration.md)| | [optional] + +### Return type + +[**InlineResponseDefault14**](InlineResponseDefault14.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_api_configurations** +> InlineResponseDefault18 get_all_api_configurations(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.PaymentGatewayApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: + api_response = api_instance.get_all_api_configurations(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) + pprint(api_response) +except ApiException as e: + print("Exception when calling PaymentGatewayApi->get_all_api_configurations: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + +### Return type + +[**InlineResponseDefault18**](InlineResponseDefault18.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_api_configurations_by_type** +> InlineResponseDefault18 get_api_configurations_by_type(configuration_type, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.PaymentGatewayApi(billforward.ApiClient(configuration)) +configuration_type = 'configuration_type_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: + api_response = api_instance.get_api_configurations_by_type(configuration_type, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) + pprint(api_response) +except ApiException as e: + print("Exception when calling PaymentGatewayApi->get_api_configurations_by_type: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **configuration_type** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + +### Return type + +[**InlineResponseDefault18**](InlineResponseDefault18.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **public_configuration** +> PublicConfigurationResponse public_configuration(organization_id=organization_id) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.PaymentGatewayApi(billforward.ApiClient(configuration)) +organization_id = 'organization_id_example' # str | (optional) + +try: + api_response = api_instance.public_configuration(organization_id=organization_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling PaymentGatewayApi->public_configuration: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | **str**| | [optional] + +### Return type + +[**PublicConfigurationResponse**](PublicConfigurationResponse.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_api_configuration** +> InlineResponseDefault14 update_api_configuration(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.PaymentGatewayApi(billforward.ApiClient(configuration)) +body = billforward.APIConfiguration() # APIConfiguration | (optional) + +try: + api_response = api_instance.update_api_configuration(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling PaymentGatewayApi->update_api_configuration: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**APIConfiguration**](APIConfiguration.md)| | [optional] + +### Return type + +[**InlineResponseDefault14**](InlineResponseDefault14.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/PaymentMethod.md b/docs/PaymentMethod.md index 8a4fc6b..99b2bfe 100644 --- a/docs/PaymentMethod.md +++ b/docs/PaymentMethod.md @@ -3,32 +3,34 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the payment-method.\", \"verbs\":[\"GET\"] } | [optional] -**crm_id** | **str** | { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":] } | [optional] -**account_id** | **str** | { \"description\" : \"ID of the account associated with the payment-method.\", \"verbs\":[\"POST\",\"GET\"] } | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**crm_id** | **str** | | [optional] +**account_id** | **str** | | [optional] **organization_id** | **str** | | [optional] -**name** | **str** | { \"description\" : \"Name of the payment-method.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**description** | **str** | { \"description\" : \"Description of the payment-method.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**card_holder_name** | **str** | { \"description\" : \"Name of the card holder\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**expiry_date** | **str** | { \"description\" : \"In the case of card payment methods this is the expiry date of the card, format should be MMYY including leading 0's. For example 0115 for January 2015.\", \"verbs\":[\"POST\",\"GET\"] } | -**card_type** | **str** | { \"description\" : \"Type of the card. In the case of card payment methods this is the payment type, for example VISA, MasterCard.\", \"verbs\":[\"POST\",\"GET\"] } | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**card_holder_name** | **str** | | [optional] +**expiry_date** | **str** | | [optional] +**card_type** | **str** | | [optional] **country** | **str** | | [optional] **province** | **str** | | [optional] **first_six** | **str** | | [optional] **last_four** | **str** | | [optional] **expiry_year** | **int** | | [optional] **expiry_month** | **int** | | [optional] -**link_id** | **str** | | -**gateway** | **str** | { \"description\" : \"Gateway type for payment-method.\", \"verbs\":[\"POST\",\"GET\"] } | -**ip_address** | **str** | {\"description\":\"IP address associated with this payment method.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**ip_address_country** | **str** | {\"description\":\"Country of the IP address associated with this payment method.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**state** | **str** | { \"description\" : \"State of the payment-method.\", \"verbs\":[\"POST\",\"GET\"] } | -**deleted** | **bool** | {\"default\" : \"false\", \"description\" : \"Indicates if a payment-method has been retired. If a payment-method has been retired it can still be retrieved using the appropriate flag on API requests. Generally payment-methods will be retired by customers wanting to remove the payment method from their account. Caution should be used when requested deleted payment methods.\", \"verbs\":[\"GET\"] } | [optional] [default to False] -**default_payment_method** | **bool** | {\"default\" : \"false\", \"description\" : \"Indicates if this is the default payment method for the account.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] [default to False] +**link_id** | **str** | | [optional] +**gateway** | **str** | | [optional] +**api_configuration_id** | **str** | | [optional] +**ip_address** | **str** | | [optional] +**ip_address_country** | **str** | | [optional] +**tokenization_method** | **str** | | [optional] +**state** | **str** | | [optional] +**gateway_refreshed** | **datetime** | | [optional] +**deleted** | **bool** | | [optional] +**default_payment_method** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodPagedMetadata.md b/docs/PaymentMethodPagedMetadata.md deleted file mode 100644 index ce26c38..0000000 --- a/docs/PaymentMethodPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# PaymentMethodPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[PaymentMethod]**](PaymentMethod.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentMethodSubscriptionLink.md b/docs/PaymentMethodSubscriptionLink.md index 329f510..7de0c65 100644 --- a/docs/PaymentMethodSubscriptionLink.md +++ b/docs/PaymentMethodSubscriptionLink.md @@ -3,17 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**crm_id** | **str** | { \"description\" : \"CRM ID of the product-rate-plan.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"Subscription to add payment method to.\", \"verbs\":[\"POST\",\"GET\"] } | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**crm_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] **organization_id** | **str** | | [optional] -**payment_method_id** | **str** | { \"description\" : \"Payment method to add to subscription.\", \"verbs\":[\"POST\",\"GET\"] } | -**deleted** | **bool** | | [optional] [default to False] +**payment_method_id** | **str** | | +**deleted** | **bool** | | [optional] **payment_method** | [**PaymentMethod**](PaymentMethod.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentMethodSubscriptionLinkPagedMetadata.md b/docs/PaymentMethodSubscriptionLinkPagedMetadata.md deleted file mode 100644 index 624966d..0000000 --- a/docs/PaymentMethodSubscriptionLinkPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# PaymentMethodSubscriptionLinkPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[PaymentMethodSubscriptionLink]**](PaymentMethodSubscriptionLink.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentPagedMetadata.md b/docs/PaymentPagedMetadata.md deleted file mode 100644 index 9b0d5f6..0000000 --- a/docs/PaymentPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# PaymentPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Payment]**](Payment.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PaymentRefundRequest.md b/docs/PaymentRefundRequest.md new file mode 100644 index 0000000..81c9543 --- /dev/null +++ b/docs/PaymentRefundRequest.md @@ -0,0 +1,12 @@ +# PaymentRefundRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**reason** | **str** | | [optional] +**amount** | **float** | | [optional] +**virtual_refund_gateway_types** | **list[str]** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PaymentRefundResponse.md b/docs/PaymentRefundResponse.md new file mode 100644 index 0000000..1b93db1 --- /dev/null +++ b/docs/PaymentRefundResponse.md @@ -0,0 +1,16 @@ +# PaymentRefundResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**payment** | [**Payment**](Payment.md) | | [optional] +**refunds** | [**list[Refund]**](Refund.md) | | [optional] +**invoices** | [**list[Invoice]**](Invoice.md) | | [optional] +**organization_id** | **str** | | [optional] +**requested_amount** | **float** | | [optional] +**refunded_amount** | **float** | | [optional] +**amount_left_to_refund** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PaymentRetryRequest.md b/docs/PaymentRetryRequest.md index c94ec86..da335e3 100644 --- a/docs/PaymentRetryRequest.md +++ b/docs/PaymentRetryRequest.md @@ -3,9 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | [optional] -**retry_time** | **datetime** | { \"default\" : \"immediately\", \"description\" : \"When the payment retry will be attempted\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] +**organization_id** | **str** | | [optional] +**retry_time** | **datetime** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PaymentmethodsApi.md b/docs/PaymentmethodsApi.md index 30e27b8..2ff4b45 100644 --- a/docs/PaymentmethodsApi.md +++ b/docs/PaymentmethodsApi.md @@ -1,91 +1,90 @@ -# billforward.PaymentmethodsApi +# billforward.PaymentMethodsApi -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_payment_method**](PaymentmethodsApi.md#create_payment_method) | **POST** /payment-methods | Create a payment-method. -[**delete_payment_method**](PaymentmethodsApi.md#delete_payment_method) | **DELETE** /payment-methods/{payment-method-ID} | Deletes the payment-method specified by the payment-method-ID parameter. -[**get_all_payment_methods**](PaymentmethodsApi.md#get_all_payment_methods) | **GET** /payment-methods | Returns a collection of all payment-methods. By default 10 values are returned. Records are returned in natural order. -[**get_payment_method_by_account_id**](PaymentmethodsApi.md#get_payment_method_by_account_id) | **GET** /payment-methods/account/{account-ID} | Returns a collection of payment-methods, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_payment_method_by_id**](PaymentmethodsApi.md#get_payment_method_by_id) | **GET** /payment-methods/{payment-method-ID} | Returns a single payment-method, specified by the payment-method-ID parameter. -[**get_payment_method_by_link_id**](PaymentmethodsApi.md#get_payment_method_by_link_id) | **GET** /payment-methods/link-id/{linkID} | Returns a single payment-method, specified by the linkID parameter. -[**get_payment_method_by_payment_gateway**](PaymentmethodsApi.md#get_payment_method_by_payment_gateway) | **GET** /payment-methods/gateway/{gateway} | Returns a collection of payment-methods, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. -[**update_payment_method**](PaymentmethodsApi.md#update_payment_method) | **PUT** /payment-methods | Update a payment-method. - +[**create_payment_method**](PaymentMethodsApi.md#create_payment_method) | **POST** /payment-methods | +[**delete_payment_method**](PaymentMethodsApi.md#delete_payment_method) | **DELETE** /payment-methods/{payment-method-ID} | +[**get_all_payment_methods**](PaymentMethodsApi.md#get_all_payment_methods) | **GET** /payment-methods | +[**get_mandate_pdf**](PaymentMethodsApi.md#get_mandate_pdf) | **GET** /payment-methods/{payment-method-ID}/mandate.pdf | +[**get_payment_method_by_id**](PaymentMethodsApi.md#get_payment_method_by_id) | **GET** /payment-methods/{payment-method-ID} | +[**get_payment_method_by_link_id**](PaymentMethodsApi.md#get_payment_method_by_link_id) | **GET** /payment-methods/link-id/{linkID} | +[**get_payment_method_by_payment_gateway**](PaymentMethodsApi.md#get_payment_method_by_payment_gateway) | **GET** /payment-methods/gateway/{gateway} | +[**update_payment_method**](PaymentMethodsApi.md#update_payment_method) | **PUT** /payment-methods | +[**verify_ach**](PaymentMethodsApi.md#verify_ach) | **POST** /payment-methods/{payment-method-ID}/verify/micro-deposits | # **create_payment_method** -> PaymentMethodPagedMetadata create_payment_method(payment_method) +> InlineResponseDefault40 create_payment_method(body=body) -Create a payment-method. -{\"nickname\":\"Create a new payment method\",\"request\":\"createPaymentMethodRequest.html\",\"response\":\"createPaymentMethodResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentmethodsApi() -payment_method = billforward.PaymentMethod() # PaymentMethod | The payment-method object to be updated. +api_instance = billforward.PaymentMethodsApi(billforward.ApiClient(configuration)) +body = billforward.PaymentMethod() # PaymentMethod | (optional) -try: - # Create a payment-method. - api_response = api_instance.create_payment_method(payment_method) +try: + api_response = api_instance.create_payment_method(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentmethodsApi->create_payment_method: %s\n" % e + print("Exception when calling PaymentMethodsApi->create_payment_method: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **payment_method** | [**PaymentMethod**](PaymentMethod.md)| The payment-method object to be updated. | + **body** | [**PaymentMethod**](PaymentMethod.md)| | [optional] ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +[**InlineResponseDefault40**](InlineResponseDefault40.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Content-Type**: text/plain, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_payment_method** -> PaymentMethodPagedMetadata delete_payment_method(payment_method_id, organizations=organizations) +> InlineResponseDefault40 delete_payment_method(payment_method_id, delete_gateway_data=delete_gateway_data, organizations=organizations) -Deletes the payment-method specified by the payment-method-ID parameter. -{\"nickname\":\"Delete payment method\",\"response\":\"deletePaymentMethod.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentmethodsApi() +api_instance = billforward.PaymentMethodsApi(billforward.ApiClient(configuration)) payment_method_id = 'payment_method_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +delete_gateway_data = false # bool | (optional) (default to false) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Deletes the payment-method specified by the payment-method-ID parameter. - api_response = api_instance.delete_payment_method(payment_method_id, organizations=organizations) +try: + api_response = api_instance.delete_payment_method(payment_method_id, delete_gateway_data=delete_gateway_data, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentmethodsApi->delete_payment_method: %s\n" % e + print("Exception when calling PaymentMethodsApi->delete_payment_method: %s\n" % e) ``` ### Parameters @@ -93,72 +92,76 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **payment_method_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **delete_gateway_data** | **bool**| | [optional] [default to false] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +[**InlineResponseDefault40**](InlineResponseDefault40.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_payment_methods** -> PaymentMethodPagedMetadata get_all_payment_methods(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault9 get_all_payment_methods(organizations=organizations, routing_number=routing_number, account_number=account_number, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Returns a collection of all payment-methods. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Get all payment methods\",\"response\":\"getPaymentMethodAll.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentmethodsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first payment-method to return. (optional) (default to 0) -records = 10 # int | The maximum number of payment-methods to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of all payment-methods. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_payment_methods(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +api_instance = billforward.PaymentMethodsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +routing_number = 'routing_number_example' # str | (optional) +account_number = 'account_number_example' # str | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_all_payment_methods(organizations=organizations, routing_number=routing_number, account_number=account_number, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentmethodsApi->get_all_payment_methods: %s\n" % e + print("Exception when calling PaymentMethodsApi->get_all_payment_methods: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first payment-method to return. | [optional] [default to 0] - **records** | **int**| The maximum number of payment-methods to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] + **organizations** | [**list[str]**](str.md)| | [optional] + **routing_number** | **str**| | [optional] + **account_number** | **str**| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +[**InlineResponseDefault9**](InlineResponseDefault9.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -167,92 +170,77 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_payment_method_by_account_id** -> PaymentMethodPagedMetadata get_payment_method_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, default_only=default_only) +# **get_mandate_pdf** +> get_mandate_pdf(payment_method_id, organizations=organizations) -Returns a collection of payment-methods, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by account\",\"response\":\"getPaymentMethodByAccount.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentmethodsApi() -account_id = 'account_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first payment-method to return. (optional) (default to 0) -records = 10 # int | The maximum number of payment-methods to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) -default_only = false # bool | Whether only the defualt payment method should be returned. (optional) (default to false) - -try: - # Returns a collection of payment-methods, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_payment_method_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, default_only=default_only) - pprint(api_response) +api_instance = billforward.PaymentMethodsApi(billforward.ApiClient(configuration)) +payment_method_id = 'payment_method_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_instance.get_mandate_pdf(payment_method_id, organizations=organizations) except ApiException as e: - print "Exception when calling PaymentmethodsApi->get_payment_method_by_account_id: %s\n" % e + print("Exception when calling PaymentMethodsApi->get_mandate_pdf: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **account_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first payment-method to return. | [optional] [default to 0] - **records** | **int**| The maximum number of payment-methods to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - **default_only** | **bool**| Whether only the defualt payment method should be returned. | [optional] [default to false] + **payment_method_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain - - **Accept**: application/json + - **Content-Type**: Not defined + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_payment_method_by_id** -> PaymentMethodPagedMetadata get_payment_method_by_id(payment_method_id, organizations=organizations) +> InlineResponseDefault40 get_payment_method_by_id(payment_method_id, organizations=organizations) -Returns a single payment-method, specified by the payment-method-ID parameter. -{\"nickname\":\"Get existing payment method\",\"response\":\"getPaymentMethodByID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentmethodsApi() +api_instance = billforward.PaymentMethodsApi(billforward.ApiClient(configuration)) payment_method_id = 'payment_method_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Returns a single payment-method, specified by the payment-method-ID parameter. +try: api_response = api_instance.get_payment_method_by_id(payment_method_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentmethodsApi->get_payment_method_by_id: %s\n" % e + print("Exception when calling PaymentMethodsApi->get_payment_method_by_id: %s\n" % e) ``` ### Parameters @@ -260,123 +248,121 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **payment_method_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +[**InlineResponseDefault40**](InlineResponseDefault40.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_payment_method_by_link_id** -> PaymentMethodPagedMetadata get_payment_method_by_link_id(link_id, organizations=organizations) +> InlineResponseDefault9 get_payment_method_by_link_id(link_id, organizations=organizations) -Returns a single payment-method, specified by the linkID parameter. -{\"nickname\":\"Retrieve by subscription link\",\"response\":\"getPaymentMethodByLinkID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentmethodsApi() -link_id = 'link_id_example' # str | The link-id of the payment-method. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +api_instance = billforward.PaymentMethodsApi(billforward.ApiClient(configuration)) +link_id = 'link_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Returns a single payment-method, specified by the linkID parameter. +try: api_response = api_instance.get_payment_method_by_link_id(link_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentmethodsApi->get_payment_method_by_link_id: %s\n" % e + print("Exception when calling PaymentMethodsApi->get_payment_method_by_link_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **link_id** | **str**| The link-id of the payment-method. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **link_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +[**InlineResponseDefault9**](InlineResponseDefault9.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_payment_method_by_payment_gateway** -> PaymentMethodPagedMetadata get_payment_method_by_payment_gateway(gateway, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault9 get_payment_method_by_payment_gateway(gateway, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Returns a collection of payment-methods, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by gateway\",\"response\":\"getPaymentMethodByGateway.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentmethodsApi() -gateway = 'gateway_example' # str | The payment-method gateway which generated the payment-method. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first payment-method to return. (optional) (default to 0) -records = 10 # int | The maximum number of payment-methods to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of payment-methods, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.PaymentMethodsApi(billforward.ApiClient(configuration)) +gateway = 'gateway_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) + +try: api_response = api_instance.get_payment_method_by_payment_gateway(gateway, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentmethodsApi->get_payment_method_by_payment_gateway: %s\n" % e + print("Exception when calling PaymentMethodsApi->get_payment_method_by_payment_gateway: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **gateway** | **str**| The payment-method gateway which generated the payment-method. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first payment-method to return. | [optional] [default to 0] - **records** | **int**| The maximum number of payment-methods to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] + **gateway** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to true] ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +[**InlineResponseDefault9**](InlineResponseDefault9.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -386,49 +372,98 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_payment_method** -> PaymentMethodPagedMetadata update_payment_method(payment_method) +> InlineResponseDefault40 update_payment_method(body=body, delete_gateway_data=delete_gateway_data) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + -Update a payment-method. +# create an instance of the API class +api_instance = billforward.PaymentMethodsApi(billforward.ApiClient(configuration)) +body = billforward.PaymentMethod() # PaymentMethod | (optional) +delete_gateway_data = false # bool | (optional) (default to false) + +try: + api_response = api_instance.update_payment_method(body=body, delete_gateway_data=delete_gateway_data) + pprint(api_response) +except ApiException as e: + print("Exception when calling PaymentMethodsApi->update_payment_method: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**PaymentMethod**](PaymentMethod.md)| | [optional] + **delete_gateway_data** | **bool**| | [optional] [default to false] + +### Return type + +[**InlineResponseDefault40**](InlineResponseDefault40.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: text/plain, application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **verify_ach** +> InlineResponseDefault40 verify_ach(payment_method_id, body=body) -{\"nickname\":\"Update a payment-method\",\"request\":\"updatePaymentMethodRequest.html\",\"response\":\"updatePaymentMethodResponse.html\"} -### Example + +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentmethodsApi() -payment_method = billforward.PaymentMethod() # PaymentMethod | The payment-method object to be updated. +api_instance = billforward.PaymentMethodsApi(billforward.ApiClient(configuration)) +payment_method_id = 'payment_method_id_example' # str | +body = billforward.VerifyPaymentMethodRequest() # VerifyPaymentMethodRequest | (optional) -try: - # Update a payment-method. - api_response = api_instance.update_payment_method(payment_method) +try: + api_response = api_instance.verify_ach(payment_method_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentmethodsApi->update_payment_method: %s\n" % e + print("Exception when calling PaymentMethodsApi->verify_ach: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **payment_method** | [**PaymentMethod**](PaymentMethod.md)| The payment-method object to be updated. | + **payment_method_id** | **str**| | + **body** | [**VerifyPaymentMethodRequest**](VerifyPaymentMethodRequest.md)| | [optional] ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +[**InlineResponseDefault40**](InlineResponseDefault40.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/PaymentmethodsubscriptionlinksApi.md b/docs/PaymentmethodsubscriptionlinksApi.md deleted file mode 100644 index e5ffa5e..0000000 --- a/docs/PaymentmethodsubscriptionlinksApi.md +++ /dev/null @@ -1,106 +0,0 @@ -# billforward.PaymentmethodsubscriptionlinksApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_payment_method_subscription_link**](PaymentmethodsubscriptionlinksApi.md#create_payment_method_subscription_link) | **POST** /payment-method-subscription-links | Create -[**retire_payment_method_subscription_link**](PaymentmethodsubscriptionlinksApi.md#retire_payment_method_subscription_link) | **DELETE** /payment-method-subscription-links/{payment-method-subscription-link-ID} | Retires the payment-method-subscription-link specified by the link-ID parameter. - - -# **create_payment_method_subscription_link** -> PaymentMethodSubscriptionLinkPagedMetadata create_payment_method_subscription_link(payment_method) - -Create - -{\"nickname\":\"Add a payment method to a subscription\",\"request\":\"createPaymentMethodSubscriptionLinkRequest.html\",\"response\":\"createPaymentMethodSubscriptionLinkResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PaymentmethodsubscriptionlinksApi() -payment_method = billforward.PaymentMethodSubscriptionLink() # PaymentMethodSubscriptionLink | The payment-method object to be updated. - -try: - # Create - api_response = api_instance.create_payment_method_subscription_link(payment_method) - pprint(api_response) -except ApiException as e: - print "Exception when calling PaymentmethodsubscriptionlinksApi->create_payment_method_subscription_link: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_method** | [**PaymentMethodSubscriptionLink**](PaymentMethodSubscriptionLink.md)| The payment-method object to be updated. | - -### Return type - -[**PaymentMethodSubscriptionLinkPagedMetadata**](PaymentMethodSubscriptionLinkPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **retire_payment_method_subscription_link** -> PaymentMethodSubscriptionLinkPagedMetadata retire_payment_method_subscription_link(payment_method_subscription_link_id, organizations) - -Retires the payment-method-subscription-link specified by the link-ID parameter. - -{\"nickname\":\"Remove a payment method from a subscription\",\"response\":\"deletePaymentMethodSubscriptionLink.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PaymentmethodsubscriptionlinksApi() -payment_method_subscription_link_id = 'payment_method_subscription_link_id_example' # str | ID of the link. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. - -try: - # Retires the payment-method-subscription-link specified by the link-ID parameter. - api_response = api_instance.retire_payment_method_subscription_link(payment_method_subscription_link_id, organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling PaymentmethodsubscriptionlinksApi->retire_payment_method_subscription_link: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_method_subscription_link_id** | **str**| ID of the link. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | - -### Return type - -[**PaymentMethodSubscriptionLinkPagedMetadata**](PaymentMethodSubscriptionLinkPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PaymentsApi.md b/docs/PaymentsApi.md index c509600..e5236de 100644 --- a/docs/PaymentsApi.md +++ b/docs/PaymentsApi.md @@ -1,115 +1,164 @@ # billforward.PaymentsApi -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_payment**](PaymentsApi.md#create_payment) | **POST** /payments | Create a payment. -[**get_all_payments**](PaymentsApi.md#get_all_payments) | **GET** /payments | Returns a collection of all payments. By default 10 values are returned. Records are returned in natural order. -[**get_payment_as_csv**](PaymentsApi.md#get_payment_as_csv) | **GET** /payments/csv | Retrieves payments in CSV format. -[**get_payment_by_id**](PaymentsApi.md#get_payment_by_id) | **GET** /payments/{payment-ID} | Returns a single payment, specified by the payment-ID parameter. -[**get_payment_by_invoice_id**](PaymentsApi.md#get_payment_by_invoice_id) | **GET** /payments/invoice/{invoice-ID} | Returns a collection of payments, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_payment_by_payment_gateway**](PaymentsApi.md#get_payment_by_payment_gateway) | **GET** /payments/gateway/{gateway} | Returns a collection of payments, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. -[**get_payment_by_payment_method_id**](PaymentsApi.md#get_payment_by_payment_method_id) | **GET** /payments/payment-method/{payment-method-ID} | Returns a collection of payments, specified by the payment-method-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**update_payment**](PaymentsApi.md#update_payment) | **PUT** /payments | Update a payment. +[**create_offline_payment**](PaymentsApi.md#create_offline_payment) | **POST** /payments/offline | +[**create_payment**](PaymentsApi.md#create_payment) | **POST** /payments | +[**get_all_payments**](PaymentsApi.md#get_all_payments) | **GET** /payments | +[**get_payment_as_csv**](PaymentsApi.md#get_payment_as_csv) | **GET** /payments/csv | +[**get_payment_by_id**](PaymentsApi.md#get_payment_by_id) | **GET** /payments/{payment-ID} | +[**get_payment_by_invoice_id**](PaymentsApi.md#get_payment_by_invoice_id) | **GET** /payments/invoice/{invoice-ID} | +[**get_payment_by_payment_gateway**](PaymentsApi.md#get_payment_by_payment_gateway) | **GET** /payments/gateway/{gateway} | +[**get_payment_by_payment_method_id**](PaymentsApi.md#get_payment_by_payment_method_id) | **GET** /payments/payment-method/{payment-method-ID} | +[**refund_payment**](PaymentsApi.md#refund_payment) | **POST** /payments/{payment_id}/refund | +[**update_payment**](PaymentsApi.md#update_payment) | **PUT** /payments | +# **create_offline_payment** +> InlineResponseDefault41 create_offline_payment(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.PaymentsApi(billforward.ApiClient(configuration)) +body = billforward.CreateOfflinePaymentRequest() # CreateOfflinePaymentRequest | (optional) + +try: + api_response = api_instance.create_offline_payment(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling PaymentsApi->create_offline_payment: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateOfflinePaymentRequest**](CreateOfflinePaymentRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault41**](InlineResponseDefault41.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_payment** -> PaymentPagedMetadata create_payment(payment) +> InlineResponseDefault41 create_payment(body=body) -Create a payment. -{\"nickname\":\"Create a new payment\",\"request\":\"createPaymentRequest.html\",\"response\":\"createPaymentResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentsApi() -payment = billforward.Payment() # Payment | The payment object to be updated. +api_instance = billforward.PaymentsApi(billforward.ApiClient(configuration)) +body = billforward.Payment() # Payment | (optional) -try: - # Create a payment. - api_response = api_instance.create_payment(payment) +try: + api_response = api_instance.create_payment(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentsApi->create_payment: %s\n" % e + print("Exception when calling PaymentsApi->create_payment: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **payment** | [**Payment**](Payment.md)| The payment object to be updated. | + **body** | [**Payment**](Payment.md)| | [optional] ### Return type -[**PaymentPagedMetadata**](PaymentPagedMetadata.md) +[**InlineResponseDefault41**](InlineResponseDefault41.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_payments** -> PaymentPagedMetadata get_all_payments(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault42 get_all_payments(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, account_id=account_id, subscription_id=subscription_id) -Returns a collection of all payments. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Get all payments\",\"response\":\"getPaymentAll.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first payment to return. (optional) (default to 0) -records = 10 # int | The maximum number of payments to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of all payments. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_payments(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +api_instance = billforward.PaymentsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) +account_id = ['account_id_example'] # list[str] | (optional) +subscription_id = ['subscription_id_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_all_payments(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, account_id=account_id, subscription_id=subscription_id) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentsApi->get_all_payments: %s\n" % e + print("Exception when calling PaymentsApi->get_all_payments: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first payment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of payments to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to true] + **account_id** | [**list[str]**](str.md)| | [optional] + **subscription_id** | [**list[str]**](str.md)| | [optional] ### Return type -[**PaymentPagedMetadata**](PaymentPagedMetadata.md) +[**InlineResponseDefault42**](InlineResponseDefault42.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -119,223 +168,218 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_payment_as_csv** -> PaymentPagedMetadata get_payment_as_csv(received_start, received_end, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) +> get_payment_as_csv(organizations=organizations, received_start=received_start, received_end=received_end, offset=offset, records=records, order_by=order_by, order=order) -Retrieves payments in CSV format. -{ \"nickname\":\"Payments CSV\",\"response\":\"payments.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentsApi() -received_start = 'received_start_example' # str | The UTC DateTime specifying the start of the interval within which payments were received. -received_end = 'received_end_example' # str | The UTC DateTime specifying the end of the interval within which payments were received. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 56 # int | The offset from the first payment to return. (optional) -records = 56 # int | The maximum number of payments to return. (optional) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Retrieves payments in CSV format. - api_response = api_instance.get_payment_as_csv(received_start, received_end, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) +api_instance = billforward.PaymentsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +received_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +received_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +offset = 56 # int | (optional) +records = 56 # int | (optional) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: + api_instance.get_payment_as_csv(organizations=organizations, received_start=received_start, received_end=received_end, offset=offset, records=records, order_by=order_by, order=order) except ApiException as e: - print "Exception when calling PaymentsApi->get_payment_as_csv: %s\n" % e + print("Exception when calling PaymentsApi->get_payment_as_csv: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **received_start** | **str**| The UTC DateTime specifying the start of the interval within which payments were received. | - **received_end** | **str**| The UTC DateTime specifying the end of the interval within which payments were received. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first payment to return. | [optional] - **records** | **int**| The maximum number of payments to return. | [optional] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to DESC] + **organizations** | [**list[str]**](str.md)| | [optional] + **received_start** | [**SimpleDateParam**](.md)| | [optional] + **received_end** | [**SimpleDateParam**](.md)| | [optional] + **offset** | **int**| | [optional] + **records** | **int**| | [optional] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] ### Return type -[**PaymentPagedMetadata**](PaymentPagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/csv + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_payment_by_id** -> PaymentPagedMetadata get_payment_by_id(payment_id, organizations=organizations) +> InlineResponseDefault41 get_payment_by_id(payment_id, organizations=organizations) -Returns a single payment, specified by the payment-ID parameter. -{\"nickname\":\"Retrieve an existing payment\",\"response\":\"getPaymentByID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentsApi() -payment_id = 'payment_id_example' # str | The unique string-ID of the payment. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +api_instance = billforward.PaymentsApi(billforward.ApiClient(configuration)) +payment_id = 'payment_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Returns a single payment, specified by the payment-ID parameter. +try: api_response = api_instance.get_payment_by_id(payment_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentsApi->get_payment_by_id: %s\n" % e + print("Exception when calling PaymentsApi->get_payment_by_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **payment_id** | **str**| The unique string-ID of the payment. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **payment_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**PaymentPagedMetadata**](PaymentPagedMetadata.md) +[**InlineResponseDefault41**](InlineResponseDefault41.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_payment_by_invoice_id** -> PaymentPagedMetadata get_payment_by_invoice_id(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault42 get_payment_by_invoice_id(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Returns a collection of payments, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Get for invoice\",\"response\":\"getPaymentByInvoice.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentsApi() -invoice_id = 'invoice_id_example' # str | The string ID of the account -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first payment to return. (optional) (default to 0) -records = 10 # int | The maximum number of payments to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of payments, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.PaymentsApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) + +try: api_response = api_instance.get_payment_by_invoice_id(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentsApi->get_payment_by_invoice_id: %s\n" % e + print("Exception when calling PaymentsApi->get_payment_by_invoice_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **invoice_id** | **str**| The string ID of the account | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first payment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of payments to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] + **invoice_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to true] ### Return type -[**PaymentPagedMetadata**](PaymentPagedMetadata.md) +[**InlineResponseDefault42**](InlineResponseDefault42.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_payment_by_payment_gateway** -> PaymentPagedMetadata get_payment_by_payment_gateway(gateway, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault42 get_payment_by_payment_gateway(gateway, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Returns a collection of payments, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by gateway\",\"response\":\"getPaymentByGateway.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentsApi() -gateway = 'gateway_example' # str | The payment gateway which generated the payment. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first payment to return. (optional) (default to 0) -records = 10 # int | The maximum number of payments to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of payments, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.PaymentsApi(billforward.ApiClient(configuration)) +gateway = 'gateway_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) + +try: api_response = api_instance.get_payment_by_payment_gateway(gateway, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentsApi->get_payment_by_payment_gateway: %s\n" % e + print("Exception when calling PaymentsApi->get_payment_by_payment_gateway: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **gateway** | **str**| The payment gateway which generated the payment. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first payment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of payments to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] + **gateway** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to true] ### Return type -[**PaymentPagedMetadata**](PaymentPagedMetadata.md) +[**InlineResponseDefault42**](InlineResponseDefault42.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -345,108 +389,154 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_payment_by_payment_method_id** -> PaymentPagedMetadata get_payment_by_payment_method_id(payment_method_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault42 get_payment_by_payment_method_id(payment_method_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Returns a collection of payments, specified by the payment-method-ID parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by payment method\",\"response\":\"getPaymentByPaymentMethod.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentsApi() -payment_method_id = 'payment_method_id_example' # str | ID of the PaymentMethod -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first payment to return. (optional) (default to 0) -records = 10 # int | The maximum number of payments to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of payments, specified by the payment-method-ID parameter. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.PaymentsApi(billforward.ApiClient(configuration)) +payment_method_id = 'payment_method_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) + +try: api_response = api_instance.get_payment_by_payment_method_id(payment_method_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentsApi->get_payment_by_payment_method_id: %s\n" % e + print("Exception when calling PaymentsApi->get_payment_by_payment_method_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **payment_method_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to true] + +### Return type + +[**InlineResponseDefault42**](InlineResponseDefault42.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **refund_payment** +> InlineResponseDefault43 refund_payment(payment_id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.PaymentsApi(billforward.ApiClient(configuration)) +payment_id = 'payment_id_example' # str | +body = billforward.PaymentRefundRequest() # PaymentRefundRequest | (optional) + +try: + api_response = api_instance.refund_payment(payment_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling PaymentsApi->refund_payment: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **payment_method_id** | **str**| ID of the PaymentMethod | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first payment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of payments to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] + **payment_id** | **str**| | + **body** | [**PaymentRefundRequest**](PaymentRefundRequest.md)| | [optional] ### Return type -[**PaymentPagedMetadata**](PaymentPagedMetadata.md) +[**InlineResponseDefault43**](InlineResponseDefault43.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: */* - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_payment** -> PaymentPagedMetadata update_payment(payment) +> InlineResponseDefault41 update_payment(body=body) -Update a payment. -{\"nickname\":\"Update a payment\",\"request\":\"updatePaymentRequest.html\",\"response\":\"updatePaymentResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PaymentsApi() -payment = billforward.Payment() # Payment | The payment object to be updated. +api_instance = billforward.PaymentsApi(billforward.ApiClient(configuration)) +body = billforward.Payment() # Payment | (optional) -try: - # Update a payment. - api_response = api_instance.update_payment(payment) +try: + api_response = api_instance.update_payment(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling PaymentsApi->update_payment: %s\n" % e + print("Exception when calling PaymentsApi->update_payment: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **payment** | [**Payment**](Payment.md)| The payment object to be updated. | + **body** | [**Payment**](Payment.md)| | [optional] ### Return type -[**PaymentPagedMetadata**](PaymentPagedMetadata.md) +[**InlineResponseDefault41**](InlineResponseDefault41.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/PaypalConfiguration.md b/docs/PaypalConfiguration.md new file mode 100644 index 0000000..951edbf --- /dev/null +++ b/docs/PaypalConfiguration.md @@ -0,0 +1,8 @@ +# PaypalConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PaypalPayment.md b/docs/PaypalPayment.md new file mode 100644 index 0000000..ec664af --- /dev/null +++ b/docs/PaypalPayment.md @@ -0,0 +1,8 @@ +# PaypalPayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PendingComponentValueChange.md b/docs/PendingComponentValueChange.md index 030c5f5..1180bfc 100644 --- a/docs/PendingComponentValueChange.md +++ b/docs/PendingComponentValueChange.md @@ -10,4 +10,3 @@ Name | Type | Description | Notes [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Period.md b/docs/Period.md deleted file mode 100644 index 5467353..0000000 --- a/docs/Period.md +++ /dev/null @@ -1,18 +0,0 @@ -# Period - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**subscription_id** | **str** | { \"description\" : \"ID of the subscription to which this billing period pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"Organization associated with this billing period.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**invoice_id** | **str** | | [optional] -**state** | **str** | { \"description\" : \"The current state of this billing period. Initially a period is '\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] }ACTIVE_STATE'. Once the 'stop' date is passed, the billing period becomes HISTORIC_STATE. | -**period** | **int** | { \"description\" : \"The incarnation of the subscription to which this billing period refers. The first incarnation of the subscription is in 'period 0'. A recurring subscription may enter 'period 1' and further.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**start** | **datetime** | { \"description\" : \"The start date of this billing period, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**stop** | **datetime** | { \"description\" : \"The end date of this billing period, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**usage_type** | **str** | { \"description\" : \"The type of usage measured within this billing period. Options are '\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] }Temporal which refers to time-based usage and Itemized, which refers to one-off usages. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PeriodPagedMetadata.md b/docs/PeriodPagedMetadata.md deleted file mode 100644 index e08725f..0000000 --- a/docs/PeriodPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# PeriodPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Period]**](Period.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PeriodsApi.md b/docs/PeriodsApi.md deleted file mode 100644 index 77351c8..0000000 --- a/docs/PeriodsApi.md +++ /dev/null @@ -1,122 +0,0 @@ -# billforward.PeriodsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_all_periods_for_subscription**](PeriodsApi.md#get_all_periods_for_subscription) | **GET** /periods/{subscription-id} | Retrieve by subscription) -[**get_latest_periods**](PeriodsApi.md#get_latest_periods) | **GET** /periods | Get all periods - - -# **get_all_periods_for_subscription** -> PeriodPagedMetadata get_all_periods_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Retrieve by subscription) - -{ \"nickname\" : \"Retrieve by subscription\",\"response\" : \"getPeriodsForSubscription.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PeriodsApi() -subscription_id = 'subscription_id_example' # str | The subscriptionID of the usage. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Retrieve by subscription) - api_response = api_instance.get_all_periods_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling PeriodsApi->get_all_periods_for_subscription: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| The subscriptionID of the usage. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**PeriodPagedMetadata**](PeriodPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_latest_periods** -> PeriodPagedMetadata get_latest_periods(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Get all periods - -{ \"nickname\" : \"Get all periods\",\"response\" : \"getPeriods.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PeriodsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Get all periods - api_response = api_instance.get_latest_periods(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling PeriodsApi->get_latest_periods: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**PeriodPagedMetadata**](PeriodPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PermissionActionEntity.md b/docs/PermissionActionEntity.md new file mode 100644 index 0000000..471334d --- /dev/null +++ b/docs/PermissionActionEntity.md @@ -0,0 +1,11 @@ +# PermissionActionEntity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**actions** | **list[str]** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PermissionActionEntityPagedMetadata.md b/docs/PermissionActionEntityPagedMetadata.md deleted file mode 100644 index 7649430..0000000 --- a/docs/PermissionActionEntityPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# PermissionActionEntityPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PermissionResourceEntity.md b/docs/PermissionResourceEntity.md new file mode 100644 index 0000000..25d997e --- /dev/null +++ b/docs/PermissionResourceEntity.md @@ -0,0 +1,11 @@ +# PermissionResourceEntity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**resources** | **list[str]** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PermissionResourceEntityPagedMetadata.md b/docs/PermissionResourceEntityPagedMetadata.md deleted file mode 100644 index f4789b2..0000000 --- a/docs/PermissionResourceEntityPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# PermissionResourceEntityPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PermissionsApi.md b/docs/PermissionsApi.md index 2093f7a..5087c88 100644 --- a/docs/PermissionsApi.md +++ b/docs/PermissionsApi.md @@ -1,113 +1,110 @@ # billforward.PermissionsApi -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_permission**](PermissionsApi.md#create_permission) | **POST** /permissions | Create a new permission. -[**get_all_permissions**](PermissionsApi.md#get_all_permissions) | **GET** /permissions | Retrieves a collection of all permissions. By default 10 values are returned. Records are returned in natural order. -[**get_available_actions_for_resource**](PermissionsApi.md#get_available_actions_for_resource) | **GET** /permissions/resources/{resource} | Retrieves all the available actions for the specified resource. -[**get_available_resources**](PermissionsApi.md#get_available_resources) | **GET** /permissions/resources | Retrieves all available resource. -[**get_permission_by_id**](PermissionsApi.md#get_permission_by_id) | **GET** /permissions/{permission-ID} | Retrieves a single permission, specified by the ID parameter. -[**revoke_permission**](PermissionsApi.md#revoke_permission) | **DELETE** /permissions/{permission-ID} | Revokes a permission - +[**create_permission**](PermissionsApi.md#create_permission) | **POST** /permissions | +[**get_all_permissions**](PermissionsApi.md#get_all_permissions) | **GET** /permissions | +[**get_available_actions_for_resource**](PermissionsApi.md#get_available_actions_for_resource) | **GET** /permissions/resources/{resource} | +[**get_available_resources**](PermissionsApi.md#get_available_resources) | **GET** /permissions/resources | +[**get_permission_by_id**](PermissionsApi.md#get_permission_by_id) | **GET** /permissions/{permission-ID} | +[**revoke_permission**](PermissionsApi.md#revoke_permission) | **DELETE** /permissions/{permission-ID} | # **create_permission** -> BFPermissionPagedMetadata create_permission(permission_request) +> InlineResponseDefault45 create_permission(body=body) -Create a new permission. -{\"nickname\":\"Create a new permission\",\"request\":\"createPermissionRequest.html\",\"response\":\"createPermissionResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PermissionsApi() -permission_request = billforward.BillingEntityBase() # BillingEntityBase | +api_instance = billforward.PermissionsApi(billforward.ApiClient(configuration)) +body = billforward.CreatePermissionRequest() # CreatePermissionRequest | (optional) -try: - # Create a new permission. - api_response = api_instance.create_permission(permission_request) +try: + api_response = api_instance.create_permission(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling PermissionsApi->create_permission: %s\n" % e + print("Exception when calling PermissionsApi->create_permission: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **permission_request** | [**BillingEntityBase**](BillingEntityBase.md)| | + **body** | [**CreatePermissionRequest**](CreatePermissionRequest.md)| | [optional] ### Return type -[**BFPermissionPagedMetadata**](BFPermissionPagedMetadata.md) +[**InlineResponseDefault45**](InlineResponseDefault45.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_permissions** -> BFPermissionPagedMetadata get_all_permissions(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault44 get_all_permissions(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a collection of all permissions. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve all permissions\",\"response\":\"getPermissionAll.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PermissionsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Retrieves a collection of all permissions. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.PermissionsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_all_permissions(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling PermissionsApi->get_all_permissions: %s\n" % e + print("Exception when calling PermissionsApi->get_all_permissions: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**BFPermissionPagedMetadata**](BFPermissionPagedMetadata.md) +[**InlineResponseDefault44**](InlineResponseDefault44.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -117,30 +114,29 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_available_actions_for_resource** -> PermissionActionEntityPagedMetadata get_available_actions_for_resource(resource, organizations=organizations) +> InlineResponseDefault46 get_available_actions_for_resource(resource, organizations=organizations) -Retrieves all the available actions for the specified resource. -{\"nickname\":\"Retrieve available actions\",\"response\":\"getAvailableActions.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PermissionsApi() +api_instance = billforward.PermissionsApi(billforward.ApiClient(configuration)) resource = 'resource_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Retrieves all the available actions for the specified resource. +try: api_response = api_instance.get_available_actions_for_resource(resource, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling PermissionsApi->get_available_actions_for_resource: %s\n" % e + print("Exception when calling PermissionsApi->get_available_actions_for_resource: %s\n" % e) ``` ### Parameters @@ -148,96 +144,94 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **resource** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**PermissionActionEntityPagedMetadata**](PermissionActionEntityPagedMetadata.md) +[**InlineResponseDefault46**](InlineResponseDefault46.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_available_resources** -> PermissionResourceEntityPagedMetadata get_available_resources(organizations=organizations) +> InlineResponseDefault47 get_available_resources(organizations=organizations) -Retrieves all available resource. -{\"nickname\":\"Retrieve available resources\",\"response\":\"getAvailableResources.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PermissionsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +api_instance = billforward.PermissionsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Retrieves all available resource. +try: api_response = api_instance.get_available_resources(organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling PermissionsApi->get_available_resources: %s\n" % e + print("Exception when calling PermissionsApi->get_available_resources: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**PermissionResourceEntityPagedMetadata**](PermissionResourceEntityPagedMetadata.md) +[**InlineResponseDefault47**](InlineResponseDefault47.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_permission_by_id** -> BFPermissionPagedMetadata get_permission_by_id(permission_id, organizations=organizations, include_retired=include_retired) +> InlineResponseDefault45 get_permission_by_id(permission_id, organizations=organizations, include_retired=include_retired) -Retrieves a single permission, specified by the ID parameter. -{\"nickname\":\"Retrieve a permission\",\"response\":\"getPermissionByID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PermissionsApi() +api_instance = billforward.PermissionsApi(billforward.ApiClient(configuration)) permission_id = 'permission_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) +organizations = ['organizations_example'] # list[str] | (optional) +include_retired = false # bool | (optional) (default to false) -try: - # Retrieves a single permission, specified by the ID parameter. +try: api_response = api_instance.get_permission_by_id(permission_id, organizations=organizations, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling PermissionsApi->get_permission_by_id: %s\n" % e + print("Exception when calling PermissionsApi->get_permission_by_id: %s\n" % e) ``` ### Parameters @@ -245,49 +239,48 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **permission_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **organizations** | [**list[str]**](str.md)| | [optional] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**BFPermissionPagedMetadata**](BFPermissionPagedMetadata.md) +[**InlineResponseDefault45**](InlineResponseDefault45.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **revoke_permission** -> BFPermissionPagedMetadata revoke_permission(permission_id, organizations=organizations) +> InlineResponseDefault45 revoke_permission(permission_id, organizations=organizations) -Revokes a permission -{\"nickname\":\"Revoke permission\",\"response\":\"revokePermission.html\",\"request\":\"revokePErmissionRequest.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.PermissionsApi() +api_instance = billforward.PermissionsApi(billforward.ApiClient(configuration)) permission_id = 'permission_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Revokes a permission +try: api_response = api_instance.revoke_permission(permission_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling PermissionsApi->revoke_permission: %s\n" % e + print("Exception when calling PermissionsApi->revoke_permission: %s\n" % e) ``` ### Parameters @@ -295,19 +288,19 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **permission_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**BFPermissionPagedMetadata**](BFPermissionPagedMetadata.md) +[**InlineResponseDefault45**](InlineResponseDefault45.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/PlanAggregation.md b/docs/PlanAggregation.md new file mode 100644 index 0000000..a5a9d2b --- /dev/null +++ b/docs/PlanAggregation.md @@ -0,0 +1,9 @@ +# PlanAggregation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pricing_components** | [**list[AggregatingComponentDescription]**](AggregatingComponentDescription.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PlanRequest.md b/docs/PlanRequest.md new file mode 100644 index 0000000..3fa3a36 --- /dev/null +++ b/docs/PlanRequest.md @@ -0,0 +1,31 @@ +# PlanRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**display_name** | **str** | | [optional] +**description** | **str** | | [optional] +**tax_status** | **str** | | [optional] +**failed_payment_behaviour** | **str** | | [optional] +**duration** | **int** | | [optional] +**duration_period** | **str** | | [optional] +**trial** | **int** | | [optional] +**trial_period** | **str** | | [optional] +**pro_rata_mode** | **str** | | [optional] +**localised_tax** | **bool** | | [optional] +**create_zero_valued_invoices** | **bool** | | [optional] +**migration_behaviour** | **str** | | [optional] +**invoice_issue_type** | **str** | | [optional] +**issue_duration** | **int** | | [optional] +**issue_period** | **str** | | [optional] +**payment_terms** | **int** | | [optional] +**generate_service_end_invoice** | **bool** | | [optional] +**fixed_term** | [**FixedTerm**](FixedTerm.md) | | [optional] +**taxation_strategies** | **list[str]** | | [optional] +**pricing** | [**PricingComponentsByChargeType**](PricingComponentsByChargeType.md) | | [optional] +**metadata** | **dict(str, object)** | | [optional] +**path** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PlanResponse.md b/docs/PlanResponse.md new file mode 100644 index 0000000..f433647 --- /dev/null +++ b/docs/PlanResponse.md @@ -0,0 +1,37 @@ +# PlanResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**id** | **str** | | [optional] +**path** | **str** | | [optional] +**name** | **str** | | [optional] +**display_name** | **str** | | [optional] +**description** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**tax_status** | **str** | | [optional] +**failed_payment_behaviour** | **str** | | [optional] +**duration** | **int** | | [optional] +**duration_period** | **str** | | [optional] +**trial** | **int** | | [optional] +**trial_period** | **str** | | [optional] +**pro_rata_mode** | **str** | | [optional] +**localised_tax** | **bool** | | [optional] +**create_zero_valued_invoices** | **bool** | | [optional] +**migration_behaviour** | **str** | | [optional] +**invoice_issue_type** | **str** | | [optional] +**issue_duration** | **int** | | [optional] +**issue_period** | **str** | | [optional] +**payment_terms** | **int** | | [optional] +**generate_service_end_invoice** | **bool** | | [optional] +**fixed_term** | [**FixedTerm**](FixedTerm.md) | | [optional] +**taxation_strategies** | **list[str]** | | [optional] +**pricing** | [**PricingComponentsByChargeType**](PricingComponentsByChargeType.md) | | [optional] +**valid_from** | **datetime** | | [optional] +**valid_till** | **datetime** | | [optional] +**metadata** | **dict(str, object)** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PlansApi.md b/docs/PlansApi.md new file mode 100644 index 0000000..62563a5 --- /dev/null +++ b/docs/PlansApi.md @@ -0,0 +1,158 @@ +# billforward.PlansApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete**](PlansApi.md#delete) | **DELETE** /plans/{path} | +[**find**](PlansApi.md#find) | **GET** /plans/{path} | +[**upsert**](PlansApi.md#upsert) | **PUT** /plans | + +# **delete** +> InlineResponseDefault25 delete(path, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.PlansApi(billforward.ApiClient(configuration)) +path = 'path_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.delete(path, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling PlansApi->delete: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault25**](InlineResponseDefault25.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **find** +> InlineResponseDefault25 find(path, records=records, organizations=organizations, with_pricing=with_pricing, with_metadata=with_metadata) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.PlansApi(billforward.ApiClient(configuration)) +path = 'path_example' # str | +records = 56 # int | (optional) +organizations = ['organizations_example'] # list[str] | (optional) +with_pricing = true # bool | (optional) (default to true) +with_metadata = true # bool | (optional) (default to true) + +try: + api_response = api_instance.find(path, records=records, organizations=organizations, with_pricing=with_pricing, with_metadata=with_metadata) + pprint(api_response) +except ApiException as e: + print("Exception when calling PlansApi->find: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **path** | **str**| | + **records** | **int**| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **with_pricing** | **bool**| | [optional] [default to true] + **with_metadata** | **bool**| | [optional] [default to true] + +### Return type + +[**InlineResponseDefault25**](InlineResponseDefault25.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **upsert** +> InlineResponseDefault25 upsert(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.PlansApi(billforward.ApiClient(configuration)) +body = [billforward.PlanRequest()] # list[PlanRequest] | (optional) + +try: + api_response = api_instance.upsert(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling PlansApi->upsert: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**list[PlanRequest]**](PlanRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault25**](InlineResponseDefault25.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: text/plain, application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/PrepaymentCharge.md b/docs/PrepaymentCharge.md new file mode 100644 index 0000000..084b9b4 --- /dev/null +++ b/docs/PrepaymentCharge.md @@ -0,0 +1,8 @@ +# PrepaymentCharge + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PriceBreakdown.md b/docs/PriceBreakdown.md new file mode 100644 index 0000000..3fc5073 --- /dev/null +++ b/docs/PriceBreakdown.md @@ -0,0 +1,14 @@ +# PriceBreakdown + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total_cost** | **float** | | [optional] +**total_cost_excluding_tax** | **float** | | [optional] +**tax** | **float** | | [optional] +**proration** | **float** | | [optional] +**price_lines** | [**list[PriceLine]**](PriceLine.md) | | [optional] +**calculation_details** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PriceCalculationPagedMetadata.md b/docs/PriceCalculationPagedMetadata.md deleted file mode 100644 index c826776..0000000 --- a/docs/PriceCalculationPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# PriceCalculationPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PriceLine.md b/docs/PriceLine.md new file mode 100644 index 0000000..4ed4b39 --- /dev/null +++ b/docs/PriceLine.md @@ -0,0 +1,25 @@ +# PriceLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tier_id** | **str** | | [optional] +**pricing_component_version_id** | **str** | | [optional] +**pricing_component_id** | **str** | | [optional] +**product_rate_plan_id** | **str** | | [optional] +**lower_threshold** | **int** | | [optional] +**upper_threshold** | **int** | | [optional] +**pricing_type** | **str** | | [optional] +**calculation_details** | **str** | | [optional] +**unit_price** | **float** | | [optional] +**unit_price_excluding_tax** | **float** | | [optional] +**prorated_unit_price** | **float** | | [optional] +**prorated_unit_price_excluding_tax** | **float** | | [optional] +**quantity** | **int** | | [optional] +**cost** | **float** | | [optional] +**cost_excluding_tax** | **float** | | [optional] +**prorated_cost** | **float** | | [optional] +**prorated_cost_excluding_tax** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PricingComponent.md b/docs/PricingComponent.md index 3db039b..4a345f1 100644 --- a/docs/PricingComponent.md +++ b/docs/PricingComponent.md @@ -3,32 +3,36 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**version_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**crm_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } When associating a pricing component with a product rate plan, this ID should be used. | -**product_rate_plan_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**unit_of_measure_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | -**name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**public_name** | **str** | {\"description\":\"A friendly non-unique name used to identify this pricing-component\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**description** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**charge_type** | **str** | { \"description\" : \"The charge type of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**invoicing_type** | **str** | { \"default\" : \"Aggregated\", \"description\" : \"For <span class=\\\"label label-default\\\">setup</span> pricing components <span class=\\\"label label-default\\\">Immediate</span> invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. <span class=\\\"label label-default\\\">Aggregated</span> invoicing will add a charge to the first invoice of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**charge_model** | **str** | { \"description\" : \"The charge model of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**upgrade_mode** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">immediate</span>\",\"description\":\"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.<br><span class=\\\"label label-default\\\">immediate</span> &mdash; Upgrade will apply at the time the request is made.<br><span class=\\\"label label-default\\\">delayed</span> &mdash; Upgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**downgrade_mode** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">delayed</span>\",\"description\":\"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.<br><span class=\\\"label label-default\\\">immediate</span> &mdash; Downgrade will apply at the time the request is made.<br><span class=\\\"label label-default\\\">delayed</span> &mdash; Downgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**default_quantity** | **int** | { \"description\" : \"The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**min_quantity** | **int** | { \"default\" : \"0\", \"description\" : \"The minimum quantity of the pricing-component.\", \"verbs\":[] } | [optional] -**max_quantity** | **int** | { \"description\" : \"The maximum quantity of the pricing-component.\", \"verbs\":[] } | [optional] -**valid_from** | **datetime** | { \"default\" : \"current time\", \"description\" : \"The DateTime specifying when the pricing-component is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**valid_till** | **datetime** | { \"default\" : \"null\", \"description\" : \"The UTC DateTime specifying when the pricing-component is valid till.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**tiers** | [**list[PricingComponentTier]**](PricingComponentTier.md) | { \"default\" : \"[]\", \"description\" : \"The pricing-component-tiers associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**unit_of_measure** | [**UnitOfMeasure**](UnitOfMeasure.md) | { \"description\" : \"The unit-of-measure associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**dummy_field** | **str** | | [optional] +**crm_id** | **str** | | [optional] +**product_rate_plan_id** | **str** | | +**product_rate_plan_version_id** | **str** | | +**unit_of_measure_id** | **str** | | +**organization_id** | **str** | | +**name** | **str** | | +**public_name** | **str** | | [optional] +**description** | **str** | | [optional] +**tax_code** | **str** | | [optional] +**charge_type** | **str** | | +**invoicing_type** | **str** | | [optional] +**charge_model** | **str** | | [optional] +**upgrade_mode** | **str** | | [optional] +**downgrade_mode** | **str** | | [optional] +**default_quantity** | **int** | | [optional] +**min_quantity** | **int** | | [optional] +**max_quantity** | **int** | | [optional] +**valid_from** | **datetime** | | +**valid_till** | **datetime** | | [optional] +**unit_credit** | **int** | | [optional] +**tiers** | [**list[PricingComponentTier]**](PricingComponentTier.md) | | [optional] +**unit_of_measure** | [**UnitOfMeasure**](UnitOfMeasure.md) | | [optional] +**sorted_tiers** | [**list[PricingComponentTier]**](PricingComponentTier.md) | | [optional] +**version_id** | **str** | | [optional] +**id** | **str** | | +**type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PricingComponentCharge.md b/docs/PricingComponentCharge.md new file mode 100644 index 0000000..2d15d6d --- /dev/null +++ b/docs/PricingComponentCharge.md @@ -0,0 +1,25 @@ +# PricingComponentCharge + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pricing_component_name** | **str** | | +**public_pricing_component_name** | **str** | | [optional] +**pricing_component_id** | **str** | | +**product_name** | **str** | | +**public_product_name** | **str** | | [optional] +**product_id** | **str** | | +**product_rate_plan_name** | **str** | | +**public_product_rate_plan_name** | **str** | | [optional] +**product_rate_plan_id** | **str** | | +**unit_of_measure_id** | **str** | | +**unit_of_measure_name** | **str** | | +**pricing_component_value** | **int** | | +**existing_pricing_component_value** | **int** | | +**pricing_component_type** | **str** | | [optional] +**creation_type** | **str** | | [optional] +**proration** | **float** | | [optional] +**quantity_label** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PricingComponentCouponModifier.md b/docs/PricingComponentCouponModifier.md deleted file mode 100644 index 01afe5b..0000000 --- a/docs/PricingComponentCouponModifier.md +++ /dev/null @@ -1,24 +0,0 @@ -# PricingComponentCouponModifier - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**coupon_definition_id** | **str** | { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**effect_amount** | **float** | { \"description\" : \"The effect amount for the coupon-modifier. This is affected by the operand field.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**operand** | **str** | { \"description\" : \"The operand field affects the effect amount of the coupon-modifier. If the operand is fixed, it is an exact amount of the currency defined by the coupon-definition. If the operand is percent, this means the coupon will be affecting a percentage of the unaltered cost. E.g. a 25% modifier will apply a 25% discount on a subscription or a pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**effect** | **str** | { \"description\" : \"The effect of the coupon-modifier. The coupon-modifier can affect first, last, and cheapest value of a specific unit-of-measure-id for a subscription. The coupon-modifier can also affect all of the values for a unit-of-measure-id, or can affect all of the subscription cost.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**effect_additional** | **bool** | { \"description\" : \"Specifies whether the coupon-modifier will be affecting only additional units. If this field is set, the coupon-instance-existing-values for the coupon-instance are observed, and any units of the unit-of-measure-id defined by the modifier below the coupon-instance-existing-values for that unit-of-measure-id will be ignored.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] -**specifier_amount** | **int** | { \"description\" : \"The number of units that will be affected by the coupon-modifier, if the domain is set to uom\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**domain** | **str** | { \"description\" : \"The domain of the coupon-modifier\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**specifier** | **str** | { \"description\" : \"The specifier is domain-specific. If the domain is uom, this field is used to limit the coupon-modifier to a specific unit-of-measure-id.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**precedence** | **int** | { \"description\" : \"The precedence of the coupon-modifier. This is used to order application of coupon-modifiers. Higher precedence means the coupon-modifier will be applied before others.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PricingComponentMigrationValue.md b/docs/PricingComponentMigrationValue.md index 2727c61..3c2af7f 100644 --- a/docs/PricingComponentMigrationValue.md +++ b/docs/PricingComponentMigrationValue.md @@ -3,12 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**id** | **str** | {\"description\":\"The ID of the charge.\",\"verbs\":[\"GET\"]} | [optional] -**pricing_component** | **str** | {\"description\":\"ID or name of the pricing component whose migration value is being described.\",\"verbs\":[\"POST\",\"GET\"]} | -**value** | **int** | {\"description\":\"Amount consumed of the pricing component whose migration value is being described.\",\"verbs\":[\"POST\",\"GET\"]} | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**id** | **str** | | [optional] +**pricing_component** | **str** | | [optional] +**pricing_component_id** | **str** | | [optional] +**pricing_component_name** | **str** | | [optional] +**value** | **int** | | [optional] +**organization_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PricingComponentPagedMetadata.md b/docs/PricingComponentPagedMetadata.md deleted file mode 100644 index a2c4a9d..0000000 --- a/docs/PricingComponentPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# PricingComponentPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[PricingComponent]**](PricingComponent.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PricingComponentQuantityRequest.md b/docs/PricingComponentQuantityRequest.md deleted file mode 100644 index 265a6d4..0000000 --- a/docs/PricingComponentQuantityRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# PricingComponentQuantityRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**pricing_component** | **str** | | -**quantity** | **int** | | -**percentage_discount** | **float** | { \"description\" : \"Percentage to be discounted\", \"verbs\":[\"POST\",\"GET\"] } | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PricingComponentTier.md b/docs/PricingComponentTier.md index 337a46a..a146e1c 100644 --- a/docs/PricingComponentTier.md +++ b/docs/PricingComponentTier.md @@ -3,19 +3,20 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**lower_threshold** | **int** | { \"description\" : \"The lower threshold of the tier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**upper_threshold** | **int** | { \"default\" : \"&infin;\", \"description\" : \"The upper threshold of the tier. If this is left null the tier will be infinite\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**crm_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**pricing_component_version_id** | **str** | { \"description\" : \"Version ID of the associated pricing-component\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**pricing_component_id** | **str** | { \"description\" : \"ID of the pricing-component associated with the pricing-component-tier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**product_rate_plan_id** | **str** | { \"description\" : \"ID of the product-rate-plan associated with the pricing-component-tier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"Organization associated with the pricing-component-tier.\", \"verbs\":[] } | [optional] -**pricing_type** | **str** | { \"description\" : \"Pricing calculation used to price items in this pricing tier. Unit pricing means every distinct value is used in the calculation. Fixed means that the total price of the tier is fixed regardless of the purchased amount.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**price** | **float** | { \"description\" : \"Cost associated with tier. When the pricingType is fixed this is the total value. When pricingType is unit, this is the cost of each unit. \", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**id** | **str** | | [optional] +**crm_id** | **str** | | [optional] +**pricing_component_version_id** | **str** | | [optional] +**product_rate_plan_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**lower_threshold** | **int** | | [optional] +**bucket_size** | **int** | | [optional] +**upper_threshold** | **int** | | [optional] +**pricing_type** | **str** | | +**price** | **float** | | +**component_id** | **str** | | [optional] +**pricing_component_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PricingComponentTierPagedMetadata.md b/docs/PricingComponentTierPagedMetadata.md deleted file mode 100644 index 442af95..0000000 --- a/docs/PricingComponentTierPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# PricingComponentTierPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[PricingComponentTier]**](PricingComponentTier.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PricingComponentValue.md b/docs/PricingComponentValue.md index 8ff92d4..a84d7f5 100644 --- a/docs/PricingComponentValue.md +++ b/docs/PricingComponentValue.md @@ -3,20 +3,20 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**version_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**pricing_component_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**pricing_component_name** | **str** | { \"description\" : \"Name of the pricing-component associated with the pricing-component-value.\", \"verbs\":[\"GET\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"Value can be left null if setting the pricing component value on the subscription directly.\", \"verbs\":[\"GET\", \"POST\"] } | -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**value** | **int** | { \"description\" : \"Quantity of a particular pricing component the subscription should have. For example if you have a pricing component for widgets, where $5/widget/month and you set the value to 10 then the customer will be charged $50 ($5 x 10) monthly.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**applies_from** | **datetime** | { \"description\" : \"<p>The appliesFrom can be left null. If appliesFrom is set, it indicates when a value came into effect.</p>\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**applies_till** | **datetime** | { \"description\" : \"<p>For <span class=\\\"label label-default\\\">setup</span>, <span class=\\\"label label-default\\\">subscription</span>, and <span class=\\\"label label-default\\\">arrears</span> pricing components if appliesTill is specificed the value will be used whilst the time has not been reached. If appliesTill is null the pricing component value will be used until a new value is added. When a new value is added appliesTill will be set to the time the new value will take effect.</p><p><span class=\\\"label label-default\\\">usage</span> pricing applies to the previous billing period as it is charged in-arrears. When adding usage a new pricing component value should be added with appliesTill set to the end of the usages billing period. For example a monthly subscription results in an invoice being generated on the 1<sup>st</sup> of March, the previous months usage period ended on the same date. A usage value should be added to the subscription with the appliesTill set to the invoices periodStart, the 1<sup>st</sup> of March.</p>\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | +**version_id** | **str** | | [optional] +**pricing_component_id** | **str** | | [optional] +**pricing_component_name** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**value** | **int** | | +**applies_from** | **datetime** | | [optional] +**applies_till** | **datetime** | | [optional] **pending_change** | [**PendingComponentValueChange**](PendingComponentValueChange.md) | | [optional] +**inferred_from_default** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PricingComponentValueAmendment.md b/docs/PricingComponentValueAmendment.md new file mode 100644 index 0000000..f06d02f --- /dev/null +++ b/docs/PricingComponentValueAmendment.md @@ -0,0 +1,11 @@ +# PricingComponentValueAmendment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**invoicing_type** | **str** | | +**invoice_id** | **str** | | [optional] +**component_changes** | [**list[ComponentChange]**](ComponentChange.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PricingComponentValueChange.md b/docs/PricingComponentValueChange.md new file mode 100644 index 0000000..978b0cf --- /dev/null +++ b/docs/PricingComponentValueChange.md @@ -0,0 +1,24 @@ +# PricingComponentValueChange + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**id** | **str** | | [optional] +**unit_of_measure_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**invoice_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**new_value** | **int** | | +**old_value** | **int** | | +**mode** | **str** | | +**state** | **str** | | +**applied** | **datetime** | | [optional] +**as_of** | **datetime** | | +**discardable** | **bool** | | [optional] +**as_of_date** | **datetime** | | [optional] +**pricing_component_id** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PricingComponentValueChangeAmendment.md b/docs/PricingComponentValueChangeAmendment.md deleted file mode 100644 index 730d791..0000000 --- a/docs/PricingComponentValueChangeAmendment.md +++ /dev/null @@ -1,24 +0,0 @@ -# PricingComponentValueChangeAmendment - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] -**invoicing_type** | **str** | { \"description\" : \"<span class=\\\"label label-default\\\">Immediate</span> generates an invoice straight away for any costs arising from this change, for example upgrade charge. <span class=\\\"label label-default\\\">Aggregated</span> add any upgrade charges to the next invoice, generally this would be at the next period end.\", \"default\" : \"Aggregated\", \"verbs\":[\"POST\",\"GET\"] } | -**invoice_id** | **str** | { \"description\" : \"Identifer of the invoice with the charges for this change.\", \"verbs\":[\"GET\"] } | [optional] -**component_changes** | [**list[ComponentChange]**](ComponentChange.md) | { \"description\" : \"Changes to perform, for example upgrade\", \"verbs\":[\"POST\",\"GET\"] } | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PricingComponentValueChangePagedMetadata.md b/docs/PricingComponentValueChangePagedMetadata.md deleted file mode 100644 index 3e71c93..0000000 --- a/docs/PricingComponentValueChangePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# PricingComponentValueChangePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[InsertableBillingEntity]**](InsertableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PricingComponentValueMigrationAmendmentMapping.md b/docs/PricingComponentValueMigrationAmendmentMapping.md index 1e48c9b..6f3f6c6 100644 --- a/docs/PricingComponentValueMigrationAmendmentMapping.md +++ b/docs/PricingComponentValueMigrationAmendmentMapping.md @@ -3,16 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**amendment_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**value** | **int** | { \"description\" : \"Units purchased for pricing-component\", \"verbs\":[\"POST\",\"GET\"] } | -**pricing_component_id** | **str** | { \"description\" : \"Identifier for pricing-component in new the new rate-plan\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**pricing_component_name** | **str** | { \"description\" : \"Name of the pricing component. (Must be provided if pricingComponentID is empty)\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**amendment_id** | **str** | | [optional] +**value** | **int** | | +**pricing_component_name** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**pricing_component_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PricingComponentValuePagedMetadata.md b/docs/PricingComponentValuePagedMetadata.md deleted file mode 100644 index e826cf5..0000000 --- a/docs/PricingComponentValuePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# PricingComponentValuePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[PricingComponentValue]**](PricingComponentValue.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PricingComponentValueRequest.md b/docs/PricingComponentValueRequest.md index 11d189f..53bafbe 100644 --- a/docs/PricingComponentValueRequest.md +++ b/docs/PricingComponentValueRequest.md @@ -3,12 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**value** | **int** | {\"default\":\"<span class=\\\"label label-default\\\"></span>\",\"description\":\"Modifies the current value used to calculate the recurring costs of the subscription. This can effectively be thought of as an upsert.Note: altering costs on invoices are made be editing charges.<br><span class=\\\"label label-default\\\">Setup Pricing</span> &mdash; Value changed if initial invoice has not been issued.<br><span class=\\\"label label-default\\\">In-Advance/Subscription Pricing</span> &mdash; Value changed and a charge added. If the change is delayed the current value on the subscription will show the delayed change.<br><span class=\\\"label label-default\\\">Arrears Pricing</span> &mdash; Value updated, and a pro-rated charge added to the subscription if required.<br><span class=\\\"label label-default\\\">Usage Pricing</span> &mdash; Usage created or updated for the current billing cycle.which is generated naturally &mdash; i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} | -**change_mode** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">as on pricing component</span>\",\"description\":\"Default behaviour when a value is changed by default the change mode from the pricing component is used.<br><span class=\\\"label label-default\\\">immediate</span> &mdash; Change will apply at the time the request is made.<br><span class=\\\"label label-default\\\">delayed</span> &mdash; Change will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**invoicing_type** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">Aggregated</span>\",\"description\":\"If the change results in a charge should it be invoiced straight away or on the next invoice.<br><span class=\\\"label label-default\\\">Immediate</span> &mdash; If the change has a cost associated with it , for example a pro-rated upgrade charge, an invoice will be raised at the time the request is made. If the invoice fails to be paid the upgrade will fail and the invoice will be voided. No credit or refund is issued for immediate downgrades.<br><span class=\\\"label label-default\\\">Aggregated</span> &mdash; If the change has a cost associated with it , for example a pro-rated upgrade charge, the charge will be added to the next invoice raised for this subscription. As no payment is required when the change is request the change always succeeds.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**no_charge** | **bool** | {\"default\":\"<span class=\\\"label label-default\\\">false</span>\",\"description\":\"If specified the change will have no cost associated with it. This is useful for immediately changing a value without creating any upgrade charge.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] +**created** | **datetime** | | [optional] +**value** | **int** | | +**organization_id** | **str** | | [optional] +**change_mode** | **str** | | [optional] +**prorate** | **bool** | | [optional] +**invoicing_type** | **str** | | [optional] +**no_charge** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/PricingComponentValueResponse.md b/docs/PricingComponentValueResponse.md new file mode 100644 index 0000000..b4a71ec --- /dev/null +++ b/docs/PricingComponentValueResponse.md @@ -0,0 +1,27 @@ +# PricingComponentValueResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**state** | **str** | | [optional] +**existing_value** | **int** | | [optional] +**new_value** | **int** | | [optional] +**type** | **str** | | [optional] +**pricing_component_id** | **str** | | [optional] +**pricing_component_name** | **str** | | [optional] +**pricing_component_public_name** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**invoice_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**cost** | **float** | | [optional] +**credit** | **float** | | [optional] +**discount** | **float** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**new_value_active** | **datetime** | | [optional] +**charge_id** | **str** | | [optional] +**amendment_id** | **str** | | [optional] +**coupon_charge_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PricingComponentValueResponsePagedMetadata.md b/docs/PricingComponentValueResponsePagedMetadata.md deleted file mode 100644 index e0baf8a..0000000 --- a/docs/PricingComponentValueResponsePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# PricingComponentValueResponsePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PricingComponentsByChargeType.md b/docs/PricingComponentsByChargeType.md new file mode 100644 index 0000000..fcdf857 --- /dev/null +++ b/docs/PricingComponentsByChargeType.md @@ -0,0 +1,13 @@ +# PricingComponentsByChargeType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**setup** | [**SetupPricingComponentsByChargeModel**](SetupPricingComponentsByChargeModel.md) | | [optional] +**advance** | [**AdvancePricingComponentsByChargeModel**](AdvancePricingComponentsByChargeModel.md) | | [optional] +**arrears** | [**ArrearsPricingComponentsByChargeModel**](ArrearsPricingComponentsByChargeModel.md) | | [optional] +**usage** | [**UsagePricingComponentsByChargeModel**](UsagePricingComponentsByChargeModel.md) | | [optional] +**aggregation** | [**PlanAggregation**](PlanAggregation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PricingTier.md b/docs/PricingTier.md new file mode 100644 index 0000000..624502f --- /dev/null +++ b/docs/PricingTier.md @@ -0,0 +1,13 @@ +# PricingTier + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **int** | | [optional] +**to** | **int** | | [optional] +**price** | **float** | | [optional] +**bucket_size** | **int** | | [optional] +**type** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PricingcalculatorApi.md b/docs/PricingcalculatorApi.md deleted file mode 100644 index 1f18b4a..0000000 --- a/docs/PricingcalculatorApi.md +++ /dev/null @@ -1,152 +0,0 @@ -# billforward.PricingcalculatorApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_amendment_cost**](PricingcalculatorApi.md#get_amendment_cost) | **POST** /pricing-calculator/amendment-cost | Calculates the price of a subscription's upgrading/downgrading to a new pricing component value. -[**get_coupon_instance_initialisation_cost**](PricingcalculatorApi.md#get_coupon_instance_initialisation_cost) | **POST** /pricing-calculator/coupon-instance/initialisation | Calculates the price of a subscription to a rate plan, at specified values of pricing component values, and with the specified coupon applied. -[**get_product_rate_plan_costs**](PricingcalculatorApi.md#get_product_rate_plan_costs) | **POST** /pricing-calculator/product-rate-plan | Calculates the price of a subscription to a rate plan, at specified values of pricing component values. - - -# **get_amendment_cost** -> AmendmentPriceNTimePagedMetadata get_amendment_cost(ammendment_price_request) - -Calculates the price of a subscription's upgrading/downgrading to a new pricing component value. - -{ \"nickname\" : \"Calculate upgrade price\", \"request\" : \"AmendmentPriceRequest.html\" ,\"response\" : \"AmendmentPriceNTime.html\" } - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcalculatorApi() -ammendment_price_request = billforward.BillingEntityBase() # BillingEntityBase | An amendment pricing request - -try: - # Calculates the price of a subscription's upgrading/downgrading to a new pricing component value. - api_response = api_instance.get_amendment_cost(ammendment_price_request) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcalculatorApi->get_amendment_cost: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **ammendment_price_request** | [**BillingEntityBase**](BillingEntityBase.md)| An amendment pricing request | - -### Return type - -[**AmendmentPriceNTimePagedMetadata**](AmendmentPriceNTimePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_coupon_instance_initialisation_cost** -> PriceCalculationPagedMetadata get_coupon_instance_initialisation_cost(coupon_instance_initialisation_request) - -Calculates the price of a subscription to a rate plan, at specified values of pricing component values, and with the specified coupon applied. - -{ \"nickname\" : \"Calculate price with a coupon\",\"request\" : \"PriceRequestWithCoupon.html\" ,\"response\" : \"PriceCalculationWithCoupon.html\" } - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcalculatorApi() -coupon_instance_initialisation_request = billforward.BillingEntityBase() # BillingEntityBase | A coupon instance initialisation request - -try: - # Calculates the price of a subscription to a rate plan, at specified values of pricing component values, and with the specified coupon applied. - api_response = api_instance.get_coupon_instance_initialisation_cost(coupon_instance_initialisation_request) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcalculatorApi->get_coupon_instance_initialisation_cost: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **coupon_instance_initialisation_request** | [**BillingEntityBase**](BillingEntityBase.md)| A coupon instance initialisation request | - -### Return type - -[**PriceCalculationPagedMetadata**](PriceCalculationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_product_rate_plan_costs** -> PriceCalculationPagedMetadata get_product_rate_plan_costs(price_request) - -Calculates the price of a subscription to a rate plan, at specified values of pricing component values. - -{ \"nickname\" : \"Calculate price\", \"request\" : \"PriceRequest.html\" ,\"response\" : \"PriceCalculation.html\" } - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcalculatorApi() -price_request = billforward.BillingEntityBase() # BillingEntityBase | A price request - -try: - # Calculates the price of a subscription to a rate plan, at specified values of pricing component values. - api_response = api_instance.get_product_rate_plan_costs(price_request) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcalculatorApi->get_product_rate_plan_costs: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **price_request** | [**BillingEntityBase**](BillingEntityBase.md)| A price request | - -### Return type - -[**PriceCalculationPagedMetadata**](PriceCalculationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PricingcomponentsApi.md b/docs/PricingcomponentsApi.md deleted file mode 100644 index 40a2a1f..0000000 --- a/docs/PricingcomponentsApi.md +++ /dev/null @@ -1,332 +0,0 @@ -# billforward.PricingcomponentsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_pricing_component**](PricingcomponentsApi.md#create_pricing_component) | **POST** /pricing-components | Create a pricing-component. -[**get_all_pricing_components**](PricingcomponentsApi.md#get_all_pricing_components) | **GET** /pricing-components | Returns a collection of pricing-components. By default 10 values are returned. Records are returned in natural order. -[**get_pricing_component**](PricingcomponentsApi.md#get_pricing_component) | **GET** /pricing-components/{pricing-component-ID} | Returns a collection of pricing-components, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_pricing_component_by_product_rate_plan_id**](PricingcomponentsApi.md#get_pricing_component_by_product_rate_plan_id) | **GET** /pricing-components/product-rate-plan/{product-rate-plan-ID} | Returns a collection of pricing-components, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**retire_pricing_component**](PricingcomponentsApi.md#retire_pricing_component) | **DELETE** /pricing-components/{pricing-component-ID} | Retires the pricing-component specified by the pricing-component-ID parameter. -[**update_pricing_component**](PricingcomponentsApi.md#update_pricing_component) | **PUT** /pricing-components | Update a pricing-component. - - -# **create_pricing_component** -> PricingComponentPagedMetadata create_pricing_component(pricing_component) - -Create a pricing-component. - -{\"nickname\":\"Create a new pricing-component\",\"request\":\"createPricingComponentRequest.html\",\"response\":\"createPricingComponentResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentsApi() -pricing_component = billforward.PricingComponent() # PricingComponent | The pricing-component object to be updated. - -try: - # Create a pricing-component. - api_response = api_instance.create_pricing_component(pricing_component) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentsApi->create_pricing_component: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pricing_component** | [**PricingComponent**](PricingComponent.md)| The pricing-component object to be updated. | - -### Return type - -[**PricingComponentPagedMetadata**](PricingComponentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_pricing_components** -> PricingComponentPagedMetadata get_all_pricing_components(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of pricing-components. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all pricing-components\",\"response\":\"getPricingComponentsAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-components to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of pricing-components. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_pricing_components(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentsApi->get_all_pricing_components: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-components to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**PricingComponentPagedMetadata**](PricingComponentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pricing_component** -> PricingComponentPagedMetadata get_pricing_component(pricing_component_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of pricing-components, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve an existing pricing-component\",\"response\":\"getPricingComponentsByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentsApi() -pricing_component_id = 'pricing_component_id_example' # str | The string ID of the pricing-component. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-components to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of pricing-components, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_pricing_component(pricing_component_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentsApi->get_pricing_component: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pricing_component_id** | **str**| The string ID of the pricing-component. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-components to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**PricingComponentPagedMetadata**](PricingComponentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pricing_component_by_product_rate_plan_id** -> PricingComponentPagedMetadata get_pricing_component_by_product_rate_plan_id(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of pricing-components, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by rate-plan\",\"response\":\"getPricingComponentsByPRP.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentsApi() -product_rate_plan_id = 'product_rate_plan_id_example' # str | The string product-rate-plan-ID of the pricing-component. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-components to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of pricing-components, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_pricing_component_by_product_rate_plan_id(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentsApi->get_pricing_component_by_product_rate_plan_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_rate_plan_id** | **str**| The string product-rate-plan-ID of the pricing-component. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-components to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**PricingComponentPagedMetadata**](PricingComponentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **retire_pricing_component** -> PricingComponentPagedMetadata retire_pricing_component(pricing_component_id, organizations=organizations) - -Retires the pricing-component specified by the pricing-component-ID parameter. - -{\"nickname\":\"Delete a pricing-component\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentsApi() -pricing_component_id = 'pricing_component_id_example' # str | The string ID of the pricing-component. -organizations = ['organizations_example'] # list[str] | A list of organization IDs used to restrict the scope of API calls. (optional) - -try: - # Retires the pricing-component specified by the pricing-component-ID parameter. - api_response = api_instance.retire_pricing_component(pricing_component_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentsApi->retire_pricing_component: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pricing_component_id** | **str**| The string ID of the pricing-component. | - **organizations** | [**list[str]**](str.md)| A list of organization IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**PricingComponentPagedMetadata**](PricingComponentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_pricing_component** -> PricingComponentPagedMetadata update_pricing_component(pricing_component) - -Update a pricing-component. - -{\"nickname\":\"Update a pricing-component\",\"request\":\"updatePricingComponentRequest.html\",\"response\":\"updatePricingComponentResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentsApi() -pricing_component = billforward.PricingComponent() # PricingComponent | The pricing-component object to be updated. - -try: - # Update a pricing-component. - api_response = api_instance.update_pricing_component(pricing_component) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentsApi->update_pricing_component: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pricing_component** | [**PricingComponent**](PricingComponent.md)| The pricing-component object to be updated. | - -### Return type - -[**PricingComponentPagedMetadata**](PricingComponentPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PricingcomponenttiersApi.md b/docs/PricingcomponenttiersApi.md deleted file mode 100644 index c58d3cd..0000000 --- a/docs/PricingcomponenttiersApi.md +++ /dev/null @@ -1,276 +0,0 @@ -# billforward.PricingcomponenttiersApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_pricing_component_tier**](PricingcomponenttiersApi.md#create_pricing_component_tier) | **POST** /pricing-component-tiers | Create -[**get_all_pricing_component_tiers**](PricingcomponenttiersApi.md#get_all_pricing_component_tiers) | **GET** /pricing-component-tiers | Returns a collection of pricing-component-tier-tiers. By default 10 values are returned. Records are returned in natural order. -[**get_pricing_component_tier**](PricingcomponenttiersApi.md#get_pricing_component_tier) | **GET** /pricing-component-tiers/{pricing-component-tier-ID} | Returns a collection of pricing-component-tier-tiers, specified by the pricing-component-tier-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_pricing_component_tier_by_product_rate_plan_id**](PricingcomponenttiersApi.md#get_pricing_component_tier_by_product_rate_plan_id) | **GET** /pricing-component-tiers/product-rate-plan/{product-rate-plan-ID} | Returns a collection of pricing-component-tier-tiers, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**update_pricing_component_tier**](PricingcomponenttiersApi.md#update_pricing_component_tier) | **PUT** /pricing-component-tiers | Update. - - -# **create_pricing_component_tier** -> PricingComponentTierPagedMetadata create_pricing_component_tier(pricing_component_tier) - -Create - -{\"nickname\":\"Create a new tier\",\"request\":\"createPricingComponentTierRequest.html\",\"response\":\"createPricingComponentTierResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponenttiersApi() -pricing_component_tier = billforward.PricingComponentTier() # PricingComponentTier | The pricing-component-tier object to be updated. - -try: - # Create - api_response = api_instance.create_pricing_component_tier(pricing_component_tier) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponenttiersApi->create_pricing_component_tier: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pricing_component_tier** | [**PricingComponentTier**](PricingComponentTier.md)| The pricing-component-tier object to be updated. | - -### Return type - -[**PricingComponentTierPagedMetadata**](PricingComponentTierPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_pricing_component_tiers** -> PricingComponentTierPagedMetadata get_all_pricing_component_tiers(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of pricing-component-tier-tiers. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all tiers\",\"response\":\"getPricingComponentTiersAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponenttiersApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component-tier-tier to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-component-tier-tiers to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of pricing-component-tier-tiers. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_pricing_component_tiers(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponenttiersApi->get_all_pricing_component_tiers: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component-tier-tier to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-component-tier-tiers to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**PricingComponentTierPagedMetadata**](PricingComponentTierPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pricing_component_tier** -> PricingComponentTierPagedMetadata get_pricing_component_tier(pricing_component_tier_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of pricing-component-tier-tiers, specified by the pricing-component-tier-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve an existing tier\",\"response\":\"getPricingComponentTiersByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponenttiersApi() -pricing_component_tier_id = 'pricing_component_tier_id_example' # str | The string ID of the pricing-component-tier-tier. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component-tier-tier to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-component-tier-tiers to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of pricing-component-tier-tiers, specified by the pricing-component-tier-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_pricing_component_tier(pricing_component_tier_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponenttiersApi->get_pricing_component_tier: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pricing_component_tier_id** | **str**| The string ID of the pricing-component-tier-tier. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component-tier-tier to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-component-tier-tiers to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**PricingComponentTierPagedMetadata**](PricingComponentTierPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pricing_component_tier_by_product_rate_plan_id** -> PricingComponentTierPagedMetadata get_pricing_component_tier_by_product_rate_plan_id(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of pricing-component-tier-tiers, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by rate-plan\",\"response\":\"getPricingComponentTiersByPRP.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponenttiersApi() -product_rate_plan_id = 'product_rate_plan_id_example' # str | The string product-rate-plan-ID of the pricing-component-tier-tier. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component-tier-tier to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-component-tier-tiers to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of pricing-component-tier-tiers, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_pricing_component_tier_by_product_rate_plan_id(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponenttiersApi->get_pricing_component_tier_by_product_rate_plan_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_rate_plan_id** | **str**| The string product-rate-plan-ID of the pricing-component-tier-tier. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component-tier-tier to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-component-tier-tiers to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**PricingComponentTierPagedMetadata**](PricingComponentTierPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_pricing_component_tier** -> PricingComponentTierPagedMetadata update_pricing_component_tier(pricing_component_tier) - -Update. - -{\"nickname\":\"Update a tier\",\"request\":\"updatePricingComponentTierRequest.html\",\"response\":\"updatePricingComponentTierResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponenttiersApi() -pricing_component_tier = billforward.PricingComponentTier() # PricingComponentTier | The pricing-component-tier object to be updated. - -try: - # Update. - api_response = api_instance.update_pricing_component_tier(pricing_component_tier) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponenttiersApi->update_pricing_component_tier: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pricing_component_tier** | [**PricingComponentTier**](PricingComponentTier.md)| The pricing-component-tier object to be updated. | - -### Return type - -[**PricingComponentTierPagedMetadata**](PricingComponentTierPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PricingcomponentvaluechangesApi.md b/docs/PricingcomponentvaluechangesApi.md deleted file mode 100644 index 9e7d2c5..0000000 --- a/docs/PricingcomponentvaluechangesApi.md +++ /dev/null @@ -1,336 +0,0 @@ -# billforward.PricingcomponentvaluechangesApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_pricing_component_value_change**](PricingcomponentvaluechangesApi.md#create_pricing_component_value_change) | **POST** /pricing-component-value-changes | Create a pricing-component-value-change. -[**get_all_pricing_component_value_changes**](PricingcomponentvaluechangesApi.md#get_all_pricing_component_value_changes) | **GET** /pricing-component-value-changes | Returns a collection of pricing-component-value-changes. By default 10 values are returned. Records are returned in natural order. -[**get_pricing_component_value_change**](PricingcomponentvaluechangesApi.md#get_pricing_component_value_change) | **GET** /pricing-component-value-changes/{ID} | Returns a single pricing-component-value-changes, specified by the ID parameter. -[**get_pricing_component_value_change_by_component_id**](PricingcomponentvaluechangesApi.md#get_pricing_component_value_change_by_component_id) | **GET** /pricing-component-value-changes/component-ID/{pricing-component-ID} | Returns a collection of pricing-component-value-changes, specified by the pricing-component-value-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_pricing_component_value_change_by_invoice_id**](PricingcomponentvaluechangesApi.md#get_pricing_component_value_change_by_invoice_id) | **GET** /pricing-component-value-changes/invoice/{invoice-ID} | Returns a collection of pricing-component-value-changes, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_pricing_component_value_change_by_subscription_id**](PricingcomponentvaluechangesApi.md#get_pricing_component_value_change_by_subscription_id) | **GET** /pricing-component-value-changes/subscription/{subscription-ID} | Returns a collection of pricing-component-value-changes, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - - -# **create_pricing_component_value_change** -> PricingComponentValueChangePagedMetadata create_pricing_component_value_change(pricing_component_value_change) - -Create a pricing-component-value-change. - -{\"nickname\":\"Create\",\"request\":\"createPricingComponentValueChangeRequest.html\",\"response\":\"createPricingComponentValueChangeResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentvaluechangesApi() -pricing_component_value_change = billforward.InsertableBillingEntity() # InsertableBillingEntity | The pricing-component-value-change object to be updated. - -try: - # Create a pricing-component-value-change. - api_response = api_instance.create_pricing_component_value_change(pricing_component_value_change) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentvaluechangesApi->create_pricing_component_value_change: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pricing_component_value_change** | [**InsertableBillingEntity**](InsertableBillingEntity.md)| The pricing-component-value-change object to be updated. | - -### Return type - -[**PricingComponentValueChangePagedMetadata**](PricingComponentValueChangePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_pricing_component_value_changes** -> PricingComponentValueChangePagedMetadata get_all_pricing_component_value_changes(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of pricing-component-value-changes. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get All\",\"response\":\"getPricingComponentValueChangeAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentvaluechangesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component-value-change to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-component-value-changes to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of pricing-component-value-changes. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_pricing_component_value_changes(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentvaluechangesApi->get_all_pricing_component_value_changes: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component-value-change to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-component-value-changes to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**PricingComponentValueChangePagedMetadata**](PricingComponentValueChangePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pricing_component_value_change** -> PricingComponentValueChangePagedMetadata get_pricing_component_value_change(id, organizations=organizations) - -Returns a single pricing-component-value-changes, specified by the ID parameter. - -{\"nickname\":\"Retrieve by id\",\"response\":\"getPricingComponentValueChangeByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentvaluechangesApi() -id = 'id_example' # str | The string ID of the pricing-component-value-change. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single pricing-component-value-changes, specified by the ID parameter. - api_response = api_instance.get_pricing_component_value_change(id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentvaluechangesApi->get_pricing_component_value_change: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| The string ID of the pricing-component-value-change. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**PricingComponentValueChangePagedMetadata**](PricingComponentValueChangePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pricing_component_value_change_by_component_id** -> PricingComponentValueChangePagedMetadata get_pricing_component_value_change_by_component_id(pricing_component_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of pricing-component-value-changes, specified by the pricing-component-value-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by Component-ID\",\"response\":\"getPricingComponentValueChangeByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentvaluechangesApi() -pricing_component_id = 'pricing_component_id_example' # str | The string ID of the pricing-component-value. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component-value-change to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-component-value-changes to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of pricing-component-value-changes, specified by the pricing-component-value-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_pricing_component_value_change_by_component_id(pricing_component_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentvaluechangesApi->get_pricing_component_value_change_by_component_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pricing_component_id** | **str**| The string ID of the pricing-component-value. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component-value-change to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-component-value-changes to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**PricingComponentValueChangePagedMetadata**](PricingComponentValueChangePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pricing_component_value_change_by_invoice_id** -> PricingComponentValueChangePagedMetadata get_pricing_component_value_change_by_invoice_id(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of pricing-component-value-changes, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by Invoice-ID\",\"response\":\"getPricingComponentValueChangeByInvoiceID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentvaluechangesApi() -invoice_id = 'invoice_id_example' # str | The string invoice-ID of the pricing-component-value-change. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component-value-change to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-component-value-changes to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of pricing-component-value-changes, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_pricing_component_value_change_by_invoice_id(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentvaluechangesApi->get_pricing_component_value_change_by_invoice_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **invoice_id** | **str**| The string invoice-ID of the pricing-component-value-change. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component-value-change to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-component-value-changes to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**PricingComponentValueChangePagedMetadata**](PricingComponentValueChangePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pricing_component_value_change_by_subscription_id** -> PricingComponentValueChangePagedMetadata get_pricing_component_value_change_by_subscription_id(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of pricing-component-value-changes, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by Subscription-ID\",\"response\":\"getPricingComponentValueChangeBySubscriptionID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentvaluechangesApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component-value-change to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-component-value-changes to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of pricing-component-value-changes, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_pricing_component_value_change_by_subscription_id(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentvaluechangesApi->get_pricing_component_value_change_by_subscription_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component-value-change to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-component-value-changes to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**PricingComponentValueChangePagedMetadata**](PricingComponentValueChangePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PricingcomponentvaluesApi.md b/docs/PricingcomponentvaluesApi.md deleted file mode 100644 index 477a3e6..0000000 --- a/docs/PricingcomponentvaluesApi.md +++ /dev/null @@ -1,282 +0,0 @@ -# billforward.PricingcomponentvaluesApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_pricing_component_value**](PricingcomponentvaluesApi.md#create_pricing_component_value) | **POST** /pricing-component-values | Create a pricing-component-value. -[**get_all_pricing_component_values**](PricingcomponentvaluesApi.md#get_all_pricing_component_values) | **GET** /pricing-component-values | Returns a collection of pricing-component-values.By default 10 values are returned. Records are returned in natural order. -[**get_pricing_component_value**](PricingcomponentvaluesApi.md#get_pricing_component_value) | **GET** /pricing-component-values/{pricing-component-ID} | Returns a collection of pricing-component-values, specified by the pricing-component-ID parameter.By default 10 values are returned. Records are returned in natural order. -[**get_pricing_component_value_by_subscription_id**](PricingcomponentvaluesApi.md#get_pricing_component_value_by_subscription_id) | **GET** /pricing-component-values/subscription/{subscription-ID} | Returns a collection of pricing-component-values, specified by the subscription-ID parameter.By default 10 values are returned. Records are returned in natural order. -[**update_pricing_component_value**](PricingcomponentvaluesApi.md#update_pricing_component_value) | **PUT** /pricing-component-values | Update a pricing-component-value. - - -# **create_pricing_component_value** -> PricingComponentValuePagedMetadata create_pricing_component_value(pricing_component_value) - -Create a pricing-component-value. - -{\"nickname\":\"Create a new value\",\"request\":\"createPricingComponentValueRequest.html\",\"response\":\"createPricingComponentValueResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentvaluesApi() -pricing_component_value = billforward.PricingComponentValue() # PricingComponentValue | The pricing-component-value object to be updated. - -try: - # Create a pricing-component-value. - api_response = api_instance.create_pricing_component_value(pricing_component_value) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentvaluesApi->create_pricing_component_value: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pricing_component_value** | [**PricingComponentValue**](PricingComponentValue.md)| The pricing-component-value object to be updated. | - -### Return type - -[**PricingComponentValuePagedMetadata**](PricingComponentValuePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_pricing_component_values** -> PricingComponentValuePagedMetadata get_all_pricing_component_values(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of pricing-component-values.By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all values\",\"response\":\"getPricingComponentValueAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentvaluesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component-value to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-component-values to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of pricing-component-values.By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_pricing_component_values(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentvaluesApi->get_all_pricing_component_values: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component-value to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-component-values to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**PricingComponentValuePagedMetadata**](PricingComponentValuePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pricing_component_value** -> PricingComponentValuePagedMetadata get_pricing_component_value(pricing_component_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of pricing-component-values, specified by the pricing-component-ID parameter.By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get existing values\",\"response\":\"getPricingComponentValueByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentvaluesApi() -pricing_component_id = 'pricing_component_id_example' # str | The string ID of the pricing-component-value. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component-value to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-component-values to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of pricing-component-values, specified by the pricing-component-ID parameter.By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_pricing_component_value(pricing_component_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentvaluesApi->get_pricing_component_value: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pricing_component_id** | **str**| The string ID of the pricing-component-value. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component-value to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-component-values to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**PricingComponentValuePagedMetadata**](PricingComponentValuePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_pricing_component_value_by_subscription_id** -> PricingComponentValuePagedMetadata get_pricing_component_value_by_subscription_id(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of pricing-component-values, specified by the subscription-ID parameter.By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by subscription\",\"response\":\"getPricingComponentValueBySubscriptionID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentvaluesApi() -subscription_id = 'subscription_id_example' # str | The string subscription-ID of the pricing-component-value. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component-value to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-component-values to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of pricing-component-values, specified by the subscription-ID parameter.By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_pricing_component_value_by_subscription_id(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentvaluesApi->get_pricing_component_value_by_subscription_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| The string subscription-ID of the pricing-component-value. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component-value to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-component-values to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**PricingComponentValuePagedMetadata**](PricingComponentValuePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_pricing_component_value** -> PricingComponentValuePagedMetadata update_pricing_component_value(pricing_component_value) - -Update a pricing-component-value. - -{\"nickname\":\"Update a value\",\"request\":\"updatePricingComponentValueRequest.html\",\"response\":\"updatePricingComponentValueResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.PricingcomponentvaluesApi() -pricing_component_value = billforward.PricingComponentValue() # PricingComponentValue | The pricing-component-value object to be updated. - -try: - # Update a pricing-component-value. - api_response = api_instance.update_pricing_component_value(pricing_component_value) - pprint(api_response) -except ApiException as e: - print "Exception when calling PricingcomponentvaluesApi->update_pricing_component_value: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pricing_component_value** | [**PricingComponentValue**](PricingComponentValue.md)| The pricing-component-value object to be updated. | - -### Return type - -[**PricingComponentValuePagedMetadata**](PricingComponentValuePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/Product.md b/docs/Product.md deleted file mode 100644 index 9f9e7dc..0000000 --- a/docs/Product.md +++ /dev/null @@ -1,27 +0,0 @@ -# Product - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | {\"description\":\"ID uniquely identifying this product.\",\"verbs\":[\"GET\"]} | [optional] -**crm_id** | **str** | {\"description\":\"Customer-relationship-management ID of the product.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | [optional] -**account_id** | **str** | {\"description\":\"\",\"verbs\":[]} | [optional] -**name** | **str** | {\"description\":\"A unique name &mdash; for your benefit &mdash; used to identify this product within BillForward. It should reflect the fact that this product confers some service to a customer (e.g. \\\"Gold membership\\\").<br>The product can also be defined by the frequency with which it recurs (e.g. \\\"Monthly Gold membership\\\").<br>Remember also that rate plans can override the timing prescribed by their product. If you intend to override that timing, you may consider the product's period duration to be an unimportant factor when it comes to naming it.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**public_name** | **str** | {\"description\":\"A friendly non-unique name used to identify this product\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**description** | **str** | {\"description\":\"A description &mdash; for your benefit &mdash; of the product. For example: you could explain what service this product entitles a customer to.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**duration** | **int** | {\"description\":\"Number of length-measures which constitute the product's period.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**duration_period** | **str** | {\"description\":\"Measure describing the magnitude of the product's period.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**metadata** | [**DynamicMetadata**](DynamicMetadata.md) | | [optional] -**trial** | **int** | {\"default\":0,\"description\":\"Number of trial-length-measures which constitute the product's trial period\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**trial_period** | **str** | {\"default\":\"none\",\"description\":\"Measure describing the magnitude of the product's trial period.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**product_type** | **str** | {\"default\":\"recurring\",\"description\":\"The frequency of the product &mdash; either recurring or non-recurring.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**deleted** | **bool** | {\"description\":\"\",\"verbs\":[\"GET\"]} | [default to False] -**start_date** | **datetime** | {\"description\":\"\",\"verbs\":[]} | [optional] -**payment_terms** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ProductCouponModifier.md b/docs/ProductCouponModifier.md deleted file mode 100644 index 41cad32..0000000 --- a/docs/ProductCouponModifier.md +++ /dev/null @@ -1,24 +0,0 @@ -# ProductCouponModifier - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**coupon_definition_id** | **str** | { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**effect_amount** | **float** | { \"description\" : \"The effect amount for the coupon-modifier. This is affected by the operand field.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**operand** | **str** | { \"description\" : \"The operand field affects the effect amount of the coupon-modifier. If the operand is fixed, it is an exact amount of the currency defined by the coupon-definition. If the operand is percent, this means the coupon will be affecting a percentage of the unaltered cost. E.g. a 25% modifier will apply a 25% discount on a subscription or a pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**effect** | **str** | { \"description\" : \"The effect of the coupon-modifier. The coupon-modifier can affect first, last, and cheapest value of a specific unit-of-measure-id for a subscription. The coupon-modifier can also affect all of the values for a unit-of-measure-id, or can affect all of the subscription cost.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**effect_additional** | **bool** | { \"description\" : \"Specifies whether the coupon-modifier will be affecting only additional units. If this field is set, the coupon-instance-existing-values for the coupon-instance are observed, and any units of the unit-of-measure-id defined by the modifier below the coupon-instance-existing-values for that unit-of-measure-id will be ignored.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] -**specifier_amount** | **int** | { \"description\" : \"The number of units that will be affected by the coupon-modifier, if the domain is set to uom\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**domain** | **str** | { \"description\" : \"The domain of the coupon-modifier\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**specifier** | **str** | { \"description\" : \"The specifier is domain-specific. If the domain is uom, this field is used to limit the coupon-modifier to a specific unit-of-measure-id.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**precedence** | **int** | { \"description\" : \"The precedence of the coupon-modifier. This is used to order application of coupon-modifiers. Higher precedence means the coupon-modifier will be applied before others.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ProductPagedMetadata.md b/docs/ProductPagedMetadata.md deleted file mode 100644 index 66364f7..0000000 --- a/docs/ProductPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# ProductPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Product]**](Product.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ProductPaymentsResultPagedMetadata.md b/docs/ProductPaymentsResultPagedMetadata.md deleted file mode 100644 index 4514ee4..0000000 --- a/docs/ProductPaymentsResultPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# ProductPaymentsResultPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ProductRatePlan.md b/docs/ProductRatePlan.md deleted file mode 100644 index 500b00e..0000000 --- a/docs/ProductRatePlan.md +++ /dev/null @@ -1,41 +0,0 @@ -# ProductRatePlan - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**metadata** | [**DynamicMetadata**](DynamicMetadata.md) | { \"description\" : \"Add metadata.\", \"verbs\":[\"POST\"] } | [optional] -**id** | **str** | {\"description\":\"ID uniquely identifying this rate plan.\",\"verbs\":[\"GET\"]} | [optional] -**crm_id** | **str** | {\"description\":\"Customer-relationship-management ID of the rate plan.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | [optional] -**product_id** | **str** | {\"description\":\"ID of the product to which this rate plan belongs. A product is essentially a collection of rate plans, and describes the service conferred to a customer upon subscription to any of said product's rate plans. The product serves also as a template from which its rate plans can infer default attributes.\",\"verbs\":[\"POST\",\"GET\"]} | -**currency** | **str** | {\"description\":\"The currency of the product-rate-plan &mdash; as specified by a three-character ISO 4217 currency code (i.e. USD).\",\"verbs\":[\"POST\",\"GET\"]} | -**tax_status** | **str** | {\"default\":\"inclusive\",\"description\":\"The tax status of the product-rate-plan &mdash; either inclusive or exclusive.<br><span class=\\\"label label-default\\\">exclusive</span>pricing indicates that the cost of the Pricing Components do not include tax; when BillForward generates an Invoice, the tax will be calculated with this price as a base. <br>Tax-<span class=\\\"label label-default\\\">inclusive</span>pricing indicates that the Pricing components include Tax. BillForward will still calculate tax on each invoice. Tax will be calculated from the sales price.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**failed_payment_behaviour** | **str** | {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.<br><span class=\\\"label label-default\\\">CancelSubscription</span> &mdash; Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.<br><span class=\\\"label label-default\\\">None</span> &mdash; The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles &mdash; or when manual invoice remediation is common &mdash; <span class=\\\"label label-default\\\">None</span> is recommended.<br>In a heavily-automated SaaS environment, automatic cancellation via <span class=\\\"label label-default\\\">CancelSubscription</span> is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**duration** | **int** | {\"description\":\"Number of length-measures which constitute the rate plan's period. If left unspecified: the rate plan will use the same `duration` number as the Product to which it belongs.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**duration_period** | **str** | {\"description\":\"Measure describing the magnitude of the rate plan's period. If left unspecified: the rate plan will use the same `durationPeriod` magnitude as the Product to which it belongs.\",\"verbs\":[\"POST\",\"GET\"]} | -**trial** | **int** | {\"default\":0,\"description\":\"Number of trial-length-measures which constitute the rate plan's trial period. If left unspecified: the rate plan will use the same `trial` number as the Product to which it belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**trial_period** | **str** | {\"default\":\"none\",\"description\":\"Measure describing the magnitude of the rate plan's trial period. If left unspecified: the rate plan will use the same `trialPeriod` magnitude as the Product to which it belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**product_type** | **str** | {\"default\":\"recurring\",\"description\":\"The frequency of the rate plan &mdash; either recurring or non-recurring. If left unspecified: the rate plan will use the same `productType` frequency as the Product to which it belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**pro_rata_mode** | **str** | {\"default\":\"WithCoupon\",\"description\":\"The pro-rata mode for the rate plan. <br><span class=\\\"label label-default\\\">None</span> &mdash; The pro-rata cost for upgrades will be ignored.<br><span class=\\\"label label-default\\\">WithCoupon</span> &mdash; The pro-rata cost for upgrades will be calculated based on the time remaining for the subscription. Discounts from any attached coupons will be deducted from the pro-rated cost.<br><span class=\\\"label label-default\\\">WithoutCoupon</span> &mdash; The pro-rata cost for upgrades will be calculated based on the time remaining for the subscription. Discounts from any attached coupons will not be deducted from the pro-rated cost. \",\"verbs\":[]} | -**create_zero_valued_invoices** | **bool** | {\"default\":\"true\",\"description\":\"Whether invoices are created if they have a zero valued cost before any discounts are applied.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] -**name** | **str** | {\"description\":\"A friendly name &mdash; for your benefit &mdash; used to identify this rate plan within some product in BillForward. The name should reflect the fact that this rate plan provides to the customer a price tiering system within which a subscription to its Product can be made. <br>The rate plan's name could describe the nature of its price tiering (e.g. \\\"Default pricing\\\", \\\"Student pricing\\\").<br>Remember also that rate plans can override the timing prescribed by their product. If your rate plan is defined by its overriding the default timing of its product, then that can be reflected in that rate plan's name. (e.g. \\\"Student pricing - Annual\\\").\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**public_name** | **str** | {\"description\":\"A friendly non-unique name used to identify this product-rate-plan\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**valid_from** | **datetime** | {\"description\":\"The UTC DateTime specifying when the rate plan is valid from.\",\"verbs\":[\"GET\"]} | [optional] -**valid_till** | **datetime** | {\"description\":\"The UTC DateTime specifying when the product-rate-plan is valid till.\",\"verbs\":[\"GET\"]} | [optional] -**status** | **str** | {\"description\":\"The current status of the rate plan.\",\"verbs\":[]} | [optional] -**migration_behaviour** | **str** | {\"default\":\"CreditAccount\",\"description\":\"The action that should be taken, should the pro-rata calculation result in a negative value.<br><span class=\\\"label label-default\\\">NoCharge</span> &mdash; Don't return to the customer any money.<br><span class=\\\"label label-default\\\">CreditAccount</span> &mdash; Credit the customer's account with the amount.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**invoice_issue_type** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">Immediate</span>\",\"description\":\"The strategy for how invoices for this plan will be issued.<br><span class=\\\"label label-default\\\">Immediate</span> &mdash; All generated invoices move immediately to the 'Unpaid' state &mdash; beginning the payment pursuit process.<br><span class=\\\"label label-default\\\">Delayed</span> &mdash; All generated invoices begin in the 'Pending' state. An 'Issue Invoice' amendment is scheduled (based on the rate plan's `issueDuration` and `issuePeriod`) that will move the invoice to the 'Unpaid' state (beginning the payment pursuit process) in accordance with the rate plan's issuance schedule.<br><span class=\\\"label label-default\\\">Manual</span> &mdash; All generated invoices sit in the 'Pending' state &mdash; they will not be issued to the customer unless explicit action is taken. This gives you an opportunity to review or recalculate the invoice.\"verbs\":[\"POST\",\"GET\"]} | [optional] -**issue_duration** | **int** | {\"description\":\"Number of issue-length-measures between issuance of invoices for this rate plan.\"\"verbs\":[\"POST\",\"GET\"]} | [optional] -**issue_period** | **str** | {\"description\":\"Measure describing the magnitude of the invoice issuance period.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**taxation** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"A list linking taxation strategies to the rate plan.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} | [optional] -**fixed_term_definitions** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"A list linking \\\"Fixed-Term Definitions\\\" to the rate plan.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**product** | [**Product**](Product.md) | {\"description\":\"The product to which this rate plan belongs. A product is essentially a collection of rate plans, and describes the service conferred to a customer upon subscription to any of said product's rate plans. The product serves also as a template from which its rate plans can infer default attributes.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**pricing_components** | [**list[PricingComponent]**](PricingComponent.md) | {\"description\":\"The pricing-components which describe the price tiering system of this rate plan. A product rate plan may have 1 or more pricing components. Each pricing component represents a different charge associated with the subscription. Pricing components are versioned.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**aggregating_components** | [**list[AggregatingComponent]**](AggregatingComponent.md) | {\"default\":\"(empty list)\",\"description\":\"List of AggregatingComponents &mdash; these describe pricing components whose prices should be recalculated upon invoice aggregation. For example: two subscriptions' individual consumptions may be neither of them large enough to achieve bulk-buy discounts. When aggregated, though, the same two subscriptions' consumption may add up to a quantity which does merit a bulk buy discount within your tiering system.\",\"verbs\":[\"POST\"]} | [optional] -**payment_terms** | **int** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ProductRatePlanMigrationAmendment.md b/docs/ProductRatePlanMigrationAmendment.md index 6e99673..a237372 100644 --- a/docs/ProductRatePlanMigrationAmendment.md +++ b/docs/ProductRatePlanMigrationAmendment.md @@ -3,27 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] -**product_rate_plan_id** | **str** | { \"description\" : \"Identifier of the rate-plan the subscription to migrate to\", \"verbs\":[\"POST\",\"GET\"] } | -**invoicing_type** | **str** | { \"description\" : \"<span class=\\\"label label-default\\\">Immediate</span> invoicing will result in an invoice being issued immediately for migration charges. <span class=\\\"label label-default\\\">Aggregated</span> invoicing will generate a charge to be added to the next issued invoice, for example at the current billing period end.\", \"default\" : \"Immediate\", \"verbs\":[\"POST\",\"GET\"] } | -**mappings** | [**list[PricingComponentValueMigrationAmendmentMapping]**](PricingComponentValueMigrationAmendmentMapping.md) | { \"description\" : \"Mapping of new rate-plans pricing-components to values\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**previous_subscription_id** | **str** | { \"description\" : \"ID of the previous subscription.\", \"verbs\":[\"GET\"] } | [optional] -**next_subscription_id** | **str** | { \"description\" : \"ID of the next subscription.\", \"verbs\":[\"GET\"] } | [optional] -**next_subscription_name** | **str** | { \"description\" : \"User definable friendly name for the migrated subscription.\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**next_subscription_description** | **str** | { \"description\" : \"User definable description for the migrated subscription.\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**pricing_behaviour** | **str** | { \"description\" : \"Pricing behaviour defines how migration charges are calculated. <span class=\\\"label label-default\\\">DifferenceProRated</span> calculates the difference between in-advance charges of the existing and new rate-plan, then pro-rates based on time remaining. <span class=\\\"label label-default\\\">None</span> sets the migration charge as zero cost. <span class=\\\"label label-default\\\">Full</span> sets the costs as the total of the new rate-plans in-advance charges. <span class=\\\"label label-default\\\">Difference</span> is the same calculation as <span class=\\\"label label-default\\\">DifferenceProRated</span> but no pro-ration is applied. <span class=\\\"label label-default\\\">ProRated</span> differs depending on two cases; when moving to a rate-plan of the same duration it pro-rates the in-advance charges of the new rate-plan. If the duration is different, a credit-note will be issued any remaining time on the existing plans billing period.\", \"default\" : \"DifferenceProRated\", \"verbs\":[\"POST\",\"GET\"] } | +**product_rate_plan_id** | **str** | | +**invoicing_type** | **str** | | +**mappings** | [**list[PricingComponentValueMigrationAmendmentMapping]**](PricingComponentValueMigrationAmendmentMapping.md) | | [optional] +**previous_subscription_id** | **str** | | [optional] +**next_subscription_id** | **str** | | [optional] +**next_subscription_name** | **str** | | [optional] +**next_subscription_description** | **str** | | [optional] +**pricing_behaviour** | **str** | | +**force_trial_end** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ProductRatePlanMigrationCharge.md b/docs/ProductRatePlanMigrationCharge.md new file mode 100644 index 0000000..c12fe1d --- /dev/null +++ b/docs/ProductRatePlanMigrationCharge.md @@ -0,0 +1,20 @@ +# ProductRatePlanMigrationCharge + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pricing_behaviour** | **str** | | +**same_period** | **bool** | | [optional] +**original_product_rate_plan_id** | **str** | | [optional] +**original_public_product_rate_plan_name** | **str** | | [optional] +**original_product_rate_plan_name** | **str** | | [optional] +**new_product_rate_plan_id** | **str** | | [optional] +**new_public_product_rate_plan_name** | **str** | | [optional] +**new_product_rate_plan_name** | **str** | | [optional] +**new_product_id** | **str** | | [optional] +**new_public_product_name** | **str** | | [optional] +**new_product_name** | **str** | | [optional] +**pricing_component_values** | [**list[PricingComponentMigrationValue]**](PricingComponentMigrationValue.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ProductRatePlanPagedMetadata.md b/docs/ProductRatePlanPagedMetadata.md deleted file mode 100644 index cc722a5..0000000 --- a/docs/ProductRatePlanPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# ProductRatePlanPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[ProductRatePlan]**](ProductRatePlan.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ProductRatePlanPaymentsResultPagedMetadata.md b/docs/ProductRatePlanPaymentsResultPagedMetadata.md deleted file mode 100644 index cf790b8..0000000 --- a/docs/ProductRatePlanPaymentsResultPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# ProductRatePlanPaymentsResultPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ProductrateplansApi.md b/docs/ProductrateplansApi.md deleted file mode 100644 index bfc13f7..0000000 --- a/docs/ProductrateplansApi.md +++ /dev/null @@ -1,760 +0,0 @@ -# billforward.ProductrateplansApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**add_taxation_strategy_to_rate_plan**](ProductrateplansApi.md#add_taxation_strategy_to_rate_plan) | **POST** /product-rate-plans/{product-rate-plan-ID}/tax | Adds or re-enables the specified taxation-strategy for the given product-rate-plan. -[**create_rate_plan**](ProductrateplansApi.md#create_rate_plan) | **POST** /product-rate-plans | Create a new rate-plan. -[**delete_metadata_for_rate_plan**](ProductrateplansApi.md#delete_metadata_for_rate_plan) | **DELETE** /product-rate-plans/{product-rate-plan-ID}/metadata | Remove any associated metadata. -[**get_all_rate_plans**](ProductrateplansApi.md#get_all_rate_plans) | **GET** /product-rate-plans | Returns a collection of product-rate-plans. By default 10 values are returned. Records are returned in natural order. -[**get_available_taxation_strategies_for_rate_plan**](ProductrateplansApi.md#get_available_taxation_strategies_for_rate_plan) | **GET** /product-rate-plans/{product-rate-plan-ID}/tax | Returns all available taxes for the specified product-rate-plan. By default 10 values are returned. Records are returned in natural order. -[**get_metadata_for_rate_plan**](ProductrateplansApi.md#get_metadata_for_rate_plan) | **GET** /product-rate-plans/{product-rate-plan-ID}/metadata | Retrieve any associated metadata. -[**get_product_rate_plan_by_id**](ProductrateplansApi.md#get_product_rate_plan_by_id) | **GET** /product-rate-plans/{product-rate-plan-ID} | Returns product-rate-plans, specified by the product-rate-plan id or name. -[**get_rate_plan_by_product**](ProductrateplansApi.md#get_rate_plan_by_product) | **GET** /product-rate-plans/product/{product-ID} | Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_rate_plan_by_product_and_rate_plan**](ProductrateplansApi.md#get_rate_plan_by_product_and_rate_plan) | **GET** /product-rate-plans/product/{product-ID}/rate-plan/{rate-plan-ID} | Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**remove_taxation_strategy_from_rate_plan**](ProductrateplansApi.md#remove_taxation_strategy_from_rate_plan) | **DELETE** /product-rate-plans/{product-rate-plan-ID}/tax/{taxation-strategy-ID} | Removes the specified taxation-strategy for the given product-rate-plan. -[**retire_rate_plan**](ProductrateplansApi.md#retire_rate_plan) | **DELETE** /product-rate-plans/{product-rate-plan-ID} | Retires the product-rate-plan specified product-rate-plan-ID. -[**set_metadata_for_rate_plan**](ProductrateplansApi.md#set_metadata_for_rate_plan) | **POST** /product-rate-plans/{product-rate-plan-ID}/metadata | Remove any existing metadata keys and create the provided data. -[**update_rate_plan**](ProductrateplansApi.md#update_rate_plan) | **PUT** /product-rate-plans | Update a rate-plan. -[**upsert_metadata_for_rate_plan**](ProductrateplansApi.md#upsert_metadata_for_rate_plan) | **PUT** /product-rate-plans/{product-rate-plan-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed. - - -# **add_taxation_strategy_to_rate_plan** -> TaxationStrategyPagedMetadata add_taxation_strategy_to_rate_plan(product_rate_plan_id, taxation_strategy) - -Adds or re-enables the specified taxation-strategy for the given product-rate-plan. - -{\"nickname\":\"Add tax\",\"response\":\"addTaxationStrategy.html\",\"request\":\"addTaxationStrategy.request.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -product_rate_plan_id = 'product_rate_plan_id_example' # str | -taxation_strategy = billforward.AddTaxationStrategyRequest() # AddTaxationStrategyRequest | The taxation-strategy - -try: - # Adds or re-enables the specified taxation-strategy for the given product-rate-plan. - api_response = api_instance.add_taxation_strategy_to_rate_plan(product_rate_plan_id, taxation_strategy) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->add_taxation_strategy_to_rate_plan: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_rate_plan_id** | **str**| | - **taxation_strategy** | [**AddTaxationStrategyRequest**](AddTaxationStrategyRequest.md)| The taxation-strategy | - -### Return type - -[**TaxationStrategyPagedMetadata**](TaxationStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_rate_plan** -> ProductRatePlanPagedMetadata create_rate_plan(product_rate_plan) - -Create a new rate-plan. - -{\"nickname\":\"Create a new rate-plan\",\"request\":\"createPRPRequest.html\",\"response\":\"createPRPResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -product_rate_plan = billforward.ProductRatePlan() # ProductRatePlan | The product-rate-plan object to be created. - -try: - # Create a new rate-plan. - api_response = api_instance.create_rate_plan(product_rate_plan) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->create_rate_plan: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_rate_plan** | [**ProductRatePlan**](ProductRatePlan.md)| The product-rate-plan object to be created. | - -### Return type - -[**ProductRatePlanPagedMetadata**](ProductRatePlanPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_metadata_for_rate_plan** -> DynamicMetadata delete_metadata_for_rate_plan(product_rate_plan_id, organizations=organizations) - -Remove any associated metadata. - -{\"nickname\":\"Clear metadata from rate-plan\",\"request\" :\"deleteRatePlanMetadataRequest.html\",\"response\":\"deleteRatePlanMetadataResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -product_rate_plan_id = 'product_rate_plan_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Remove any associated metadata. - api_response = api_instance.delete_metadata_for_rate_plan(product_rate_plan_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->delete_metadata_for_rate_plan: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_rate_plan_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DynamicMetadata**](DynamicMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain, application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_rate_plans** -> ProductRatePlanPagedMetadata get_all_rate_plans(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, metadata=metadata) - -Returns a collection of product-rate-plans. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all rate-plans\",\"response\":\"getPRPAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first product-rate-plan to return. (optional) (default to 0) -records = 10 # int | The maximum number of product-rate-plans to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) -metadata = 'metadata_example' # str | (optional) - -try: - # Returns a collection of product-rate-plans. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_rate_plans(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, metadata=metadata) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->get_all_rate_plans: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first product-rate-plan to return. | [optional] [default to 0] - **records** | **int**| The maximum number of product-rate-plans to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - **metadata** | **str**| | [optional] - -### Return type - -[**ProductRatePlanPagedMetadata**](ProductRatePlanPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_available_taxation_strategies_for_rate_plan** -> TaxationStrategyPagedMetadata get_available_taxation_strategies_for_rate_plan(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns all available taxes for the specified product-rate-plan. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"List taxes\",\"response\":\"getAvailableTaxationStrategies.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -product_rate_plan_id = 'product_rate_plan_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns all available taxes for the specified product-rate-plan. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_available_taxation_strategies_for_rate_plan(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->get_available_taxation_strategies_for_rate_plan: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_rate_plan_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**TaxationStrategyPagedMetadata**](TaxationStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain, application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_metadata_for_rate_plan** -> DynamicMetadata get_metadata_for_rate_plan(product_rate_plan_id, organizations=organizations) - -Retrieve any associated metadata. - -{\"nickname\":\"Retrieve metadata on rate-plan\",\"request\":\"getRatePlanMetadataRequest.html\",\"response\":\"getRatePlanMetadataResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -product_rate_plan_id = 'product_rate_plan_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retrieve any associated metadata. - api_response = api_instance.get_metadata_for_rate_plan(product_rate_plan_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->get_metadata_for_rate_plan: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_rate_plan_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DynamicMetadata**](DynamicMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_product_rate_plan_by_id** -> ProductRatePlanPagedMetadata get_product_rate_plan_by_id(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns product-rate-plans, specified by the product-rate-plan id or name. - -{\"nickname\":\"Retrieve an existing rate-plan\",\"response\":\"getPRPByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -product_rate_plan_id = 'product_rate_plan_id_example' # str | id or name of the product-rate-plan. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first product-rate-plan to return. (optional) (default to 0) -records = 10 # int | The maximum number of product-rate-plans to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Returns product-rate-plans, specified by the product-rate-plan id or name. - api_response = api_instance.get_product_rate_plan_by_id(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->get_product_rate_plan_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_rate_plan_id** | **str**| id or name of the product-rate-plan. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first product-rate-plan to return. | [optional] [default to 0] - **records** | **int**| The maximum number of product-rate-plans to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - -### Return type - -[**ProductRatePlanPagedMetadata**](ProductRatePlanPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain, application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_rate_plan_by_product** -> ProductRatePlanPagedMetadata get_rate_plan_by_product(product_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by product\",\"response\":\"getPRPByProductID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -product_id = 'product_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first product-rate-plan to return. (optional) (default to 0) -records = 10 # int | The maximum number of product-rate-plans to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_rate_plan_by_product(product_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->get_rate_plan_by_product: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first product-rate-plan to return. | [optional] [default to 0] - **records** | **int**| The maximum number of product-rate-plans to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**ProductRatePlanPagedMetadata**](ProductRatePlanPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain, application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_rate_plan_by_product_and_rate_plan** -> ProductRatePlanPagedMetadata get_rate_plan_by_product_and_rate_plan(product_id, rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by name\",\"response\":\"getPRPByNameAndProduct.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -product_id = 'product_id_example' # str | -rate_plan_id = 'rate_plan_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first product-rate-plan to return. (optional) (default to 0) -records = 10 # int | The maximum number of product-rate-plans to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_rate_plan_by_product_and_rate_plan(product_id, rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->get_rate_plan_by_product_and_rate_plan: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_id** | **str**| | - **rate_plan_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first product-rate-plan to return. | [optional] [default to 0] - **records** | **int**| The maximum number of product-rate-plans to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - -### Return type - -[**ProductRatePlanPagedMetadata**](ProductRatePlanPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain, application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **remove_taxation_strategy_from_rate_plan** -> TaxationStrategyPagedMetadata remove_taxation_strategy_from_rate_plan(product_rate_plan_id, taxation_strategy_id, organizations=organizations) - -Removes the specified taxation-strategy for the given product-rate-plan. - -{\"nickname\":\"Remove tax\",\"response\":\"removeTaxationStrategy.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -product_rate_plan_id = 'product_rate_plan_id_example' # str | -taxation_strategy_id = 'taxation_strategy_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Removes the specified taxation-strategy for the given product-rate-plan. - api_response = api_instance.remove_taxation_strategy_from_rate_plan(product_rate_plan_id, taxation_strategy_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->remove_taxation_strategy_from_rate_plan: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_rate_plan_id** | **str**| | - **taxation_strategy_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**TaxationStrategyPagedMetadata**](TaxationStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain, application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **retire_rate_plan** -> ProductRatePlanPagedMetadata retire_rate_plan(product_rate_plan_id, organizations=organizations) - -Retires the product-rate-plan specified product-rate-plan-ID. - -{\"nickname\":\"Delete a rate-plan\",\"response\":\"deletePRP.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -product_rate_plan_id = 'product_rate_plan_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retires the product-rate-plan specified product-rate-plan-ID. - api_response = api_instance.retire_rate_plan(product_rate_plan_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->retire_rate_plan: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_rate_plan_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**ProductRatePlanPagedMetadata**](ProductRatePlanPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain, application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **set_metadata_for_rate_plan** -> DynamicMetadata set_metadata_for_rate_plan(metadata, product_rate_plan_id, organizations=organizations) - -Remove any existing metadata keys and create the provided data. - -{\"nickname\":\"Set metadata on rate-plan\",\"request\":\"setRatePlanMetadataRequest.html\",\"response\":\"setRatePlanMetadataResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -metadata = billforward.DynamicMetadata() # DynamicMetadata | -product_rate_plan_id = 'product_rate_plan_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Remove any existing metadata keys and create the provided data. - api_response = api_instance.set_metadata_for_rate_plan(metadata, product_rate_plan_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->set_metadata_for_rate_plan: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **metadata** | [**DynamicMetadata**](DynamicMetadata.md)| | - **product_rate_plan_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DynamicMetadata**](DynamicMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_rate_plan** -> ProductRatePlanPagedMetadata update_rate_plan(product_rate_plan) - -Update a rate-plan. - -{\"nickname\":\"Update a rate-plan\",\"request\":\"updatePRPRequest.html\",\"response\":\"updatePRPResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -product_rate_plan = billforward.ProductRatePlan() # ProductRatePlan | The product-rate-plan object to be updated. - -try: - # Update a rate-plan. - api_response = api_instance.update_rate_plan(product_rate_plan) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->update_rate_plan: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_rate_plan** | [**ProductRatePlan**](ProductRatePlan.md)| The product-rate-plan object to be updated. | - -### Return type - -[**ProductRatePlanPagedMetadata**](ProductRatePlanPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upsert_metadata_for_rate_plan** -> DynamicMetadata upsert_metadata_for_rate_plan(metadata, product_rate_plan_id, organizations=organizations) - -Update any existing metadata key-values and insert any new key-values, no keys will be removed. - -{\"nickname\":\"Upsert metadata on rate-plan\",\"request\":\"upsertRatePlanMetadataRequest.html\",\"response\":\"upsertRatePlanMetadataResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductrateplansApi() -metadata = billforward.DynamicMetadata() # DynamicMetadata | -product_rate_plan_id = 'product_rate_plan_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Update any existing metadata key-values and insert any new key-values, no keys will be removed. - api_response = api_instance.upsert_metadata_for_rate_plan(metadata, product_rate_plan_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductrateplansApi->upsert_metadata_for_rate_plan: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **metadata** | [**DynamicMetadata**](DynamicMetadata.md)| | - **product_rate_plan_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DynamicMetadata**](DynamicMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/ProductsApi.md b/docs/ProductsApi.md deleted file mode 100644 index d4bcdf8..0000000 --- a/docs/ProductsApi.md +++ /dev/null @@ -1,478 +0,0 @@ -# billforward.ProductsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_product**](ProductsApi.md#create_product) | **POST** /products | Create a product. -[**delete_metadata_for_product**](ProductsApi.md#delete_metadata_for_product) | **DELETE** /products/{product-ID}/metadata | Remove any associated metadata. -[**get_all_products**](ProductsApi.md#get_all_products) | **GET** /products | Returns a collection of products. By default 10 values are returned. Records are returned in natural order. -[**get_metadata_for_product**](ProductsApi.md#get_metadata_for_product) | **GET** /products/{product-ID}/metadata | Retrieve any associated metadata. -[**get_product_by_id**](ProductsApi.md#get_product_by_id) | **GET** /products/{product-ID} | Returns a single product, specified by the product-ID parameter. -[**retire_product**](ProductsApi.md#retire_product) | **DELETE** /products/{product-ID} | Deletes the product specified by the product-ID parameter. Any existing subscriptions will continue; it is a soft delete. -[**set_metadata_for_product**](ProductsApi.md#set_metadata_for_product) | **POST** /products/{product-ID}/metadata | Remove any existing metadata keys and create the provided data. -[**update_product**](ProductsApi.md#update_product) | **PUT** /products | Update a product. -[**upsert_metadata_for_product**](ProductsApi.md#upsert_metadata_for_product) | **PUT** /products/{product-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed. - - -# **create_product** -> ProductPagedMetadata create_product(product) - -Create a product. - -{\"nickname\":\"Create a new product\",\"request\":\"createProductRequest.html\",\"response\":\"createProductResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductsApi() -product = billforward.Product() # Product | The product object to be updated. - -try: - # Create a product. - api_response = api_instance.create_product(product) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductsApi->create_product: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product** | [**Product**](Product.md)| The product object to be updated. | - -### Return type - -[**ProductPagedMetadata**](ProductPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_metadata_for_product** -> DynamicMetadata delete_metadata_for_product(product_id, organizations=organizations) - -Remove any associated metadata. - -{\"nickname\":\"Clear metadata from product\",\"request\" :\"deleteProductMetadataRequest.html\",\"response\":\"deleteProductMetadataResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductsApi() -product_id = 'product_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Remove any associated metadata. - api_response = api_instance.delete_metadata_for_product(product_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductsApi->delete_metadata_for_product: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DynamicMetadata**](DynamicMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain, application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_products** -> ProductPagedMetadata get_all_products(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, metadata=metadata) - -Returns a collection of products. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all products\",\"response\":\"getProductAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first product to return. (optional) (default to 0) -records = 10 # int | The maximum number of products to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) -metadata = 'metadata_example' # str | (optional) - -try: - # Returns a collection of products. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_products(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, metadata=metadata) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductsApi->get_all_products: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first product to return. | [optional] [default to 0] - **records** | **int**| The maximum number of products to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - **metadata** | **str**| | [optional] - -### Return type - -[**ProductPagedMetadata**](ProductPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json, text/plain - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_metadata_for_product** -> DynamicMetadata get_metadata_for_product(product_id, organizations=organizations) - -Retrieve any associated metadata. - -{\"nickname\":\"Retrieve metadata on product\",\"request\":\"getProductMetadataRequest.html\",\"response\":\"getProductMetadataResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductsApi() -product_id = 'product_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Retrieve any associated metadata. - api_response = api_instance.get_metadata_for_product(product_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductsApi->get_metadata_for_product: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DynamicMetadata**](DynamicMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json, text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_product_by_id** -> ProductPagedMetadata get_product_by_id(product_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a single product, specified by the product-ID parameter. - -{\"nickname\":\"Retrieve an existing product\",\"response\":\"getProductByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductsApi() -product_id = 'product_id_example' # str | ID or name of the product. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first product-rate-plan to return. (optional) (default to 0) -records = 10 # int | The maximum number of product-rate-plans to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a single product, specified by the product-ID parameter. - api_response = api_instance.get_product_by_id(product_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductsApi->get_product_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_id** | **str**| ID or name of the product. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first product-rate-plan to return. | [optional] [default to 0] - **records** | **int**| The maximum number of product-rate-plans to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**ProductPagedMetadata**](ProductPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain, application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **retire_product** -> ProductPagedMetadata retire_product(product_id, organizations=organizations) - -Deletes the product specified by the product-ID parameter. Any existing subscriptions will continue; it is a soft delete. - -{\"nickname\":\"Delete a product\",\"response\":\"deleteProduct.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductsApi() -product_id = 'product_id_example' # str | ID of the Product. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Deletes the product specified by the product-ID parameter. Any existing subscriptions will continue; it is a soft delete. - api_response = api_instance.retire_product(product_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductsApi->retire_product: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_id** | **str**| ID of the Product. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**ProductPagedMetadata**](ProductPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain, application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **set_metadata_for_product** -> DynamicMetadata set_metadata_for_product(metadata, product_id, organizations=organizations) - -Remove any existing metadata keys and create the provided data. - -{\"nickname\":\"Set metadata on product\",\"request\":\"setProductMetadataRequest.html\",\"response\":\"setProductMetadataResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductsApi() -metadata = billforward.DynamicMetadata() # DynamicMetadata | -product_id = 'product_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Remove any existing metadata keys and create the provided data. - api_response = api_instance.set_metadata_for_product(metadata, product_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductsApi->set_metadata_for_product: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **metadata** | [**DynamicMetadata**](DynamicMetadata.md)| | - **product_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DynamicMetadata**](DynamicMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_product** -> ProductPagedMetadata update_product(product) - -Update a product. - -{\"nickname\":\"Update a product\",\"request\":\"updateProductRequest.html\",\"response\":\"updateProductResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductsApi() -product = billforward.Product() # Product | The product object to be updated. - -try: - # Update a product. - api_response = api_instance.update_product(product) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductsApi->update_product: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product** | [**Product**](Product.md)| The product object to be updated. | - -### Return type - -[**ProductPagedMetadata**](ProductPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **upsert_metadata_for_product** -> DynamicMetadata upsert_metadata_for_product(metadata, product_id, organizations=organizations) - -Update any existing metadata key-values and insert any new key-values, no keys will be removed. - -{\"nickname\":\"Upsert metadata on product\",\"request\":\"upsertProductMetadataRequest.html\",\"response\":\"upsertProductMetadataResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProductsApi() -metadata = billforward.DynamicMetadata() # DynamicMetadata | -product_id = 'product_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Update any existing metadata key-values and insert any new key-values, no keys will be removed. - api_response = api_instance.upsert_metadata_for_product(metadata, product_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProductsApi->upsert_metadata_for_product: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **metadata** | [**DynamicMetadata**](DynamicMetadata.md)| | - **product_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DynamicMetadata**](DynamicMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/Profile.md b/docs/Profile.md index a64f0d4..a5cfb6a 100644 --- a/docs/Profile.md +++ b/docs/Profile.md @@ -3,25 +3,28 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the profile.\", \"verbs\":[\"PUT\",\"GET\"] } | -**account_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | -**email** | **str** | { \"description\" : \"E-mail address\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**first_name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**last_name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**company_name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**logo_url** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**addresses** | [**list[Address]**](Address.md) | { \"description\" : \"Address associated with the profile\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**mobile** | **str** | { \"description\" : \"Mobile telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**landline** | **str** | { \"description\" : \"Home telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**fax** | **str** | { \"description\" : \"Fax number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**dob** | **datetime** | { \"description\" : \"Date of birth in YYYY-MM-DD format\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**vat_number** | **str** | { \"description\" : \"VAT number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**additional_information** | **str** | { \"description\" : \"Any additional information\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**account_id** | **str** | | +**organization_id** | **str** | | +**email** | **str** | | [optional] +**first_name** | **str** | | [optional] +**last_name** | **str** | | [optional] +**company_name** | **str** | | [optional] +**logo_url** | **str** | | [optional] +**addresses** | [**list[Address]**](Address.md) | | [optional] +**mobile** | **str** | | [optional] +**landline** | **str** | | [optional] +**fax** | **str** | | [optional] +**dob** | **datetime** | | [optional] +**vat_number** | **str** | | [optional] +**additional_emails** | **str** | | [optional] +**additional_information** | **str** | | [optional] +**correspondence_language** | **str** | | [optional] +**ava_tax_customer_usage_type** | **str** | | [optional] +**apply_tax** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ProfilePagedMetadata.md b/docs/ProfilePagedMetadata.md deleted file mode 100644 index 9a539a5..0000000 --- a/docs/ProfilePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# ProfilePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Profile]**](Profile.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ProfilesApi.md b/docs/ProfilesApi.md deleted file mode 100644 index 188bd7c..0000000 --- a/docs/ProfilesApi.md +++ /dev/null @@ -1,280 +0,0 @@ -# billforward.ProfilesApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_all_profiles**](ProfilesApi.md#get_all_profiles) | **GET** /profiles | Returns a collection of all profiles. By default 10 values are returned. Records are returned in natural order -[**get_profile**](ProfilesApi.md#get_profile) | **GET** /profiles/{profile-ID} | Returns a single profile, specified by the ID parameter. -[**get_profile_by_account_id**](ProfilesApi.md#get_profile_by_account_id) | **GET** /profiles/account/{account-ID} | Returns a collection of profiles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order -[**get_profile_by_email_address**](ProfilesApi.md#get_profile_by_email_address) | **GET** /profiles/email/{email} | Returns a single profile, specified by the email parameter. -[**update_profile**](ProfilesApi.md#update_profile) | **PUT** /profiles | Update a profile - - -# **get_all_profiles** -> ProfilePagedMetadata get_all_profiles(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of all profiles. By default 10 values are returned. Records are returned in natural order - -{\"nickname\":\"Get all profiles\",\"response\":\"getProfileAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProfilesApi() -organizations = ['organizations_example'] # list[str] | A list of organizations used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first profile to return. (optional) (default to 0) -records = 10 # int | The maximum number of profiles to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of all profiles. By default 10 values are returned. Records are returned in natural order - api_response = api_instance.get_all_profiles(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProfilesApi->get_all_profiles: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organizations used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first profile to return. | [optional] [default to 0] - **records** | **int**| The maximum number of profiles to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**ProfilePagedMetadata**](ProfilePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_profile** -> ProfilePagedMetadata get_profile(profile_id, organizations=organizations) - -Returns a single profile, specified by the ID parameter. - -{\"nickname\":\"Retrieve an existing profile\",\"response\":\"getProfileByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProfilesApi() -profile_id = 'profile_id_example' # str | ID of the Profile. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single profile, specified by the ID parameter. - api_response = api_instance.get_profile(profile_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProfilesApi->get_profile: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **profile_id** | **str**| ID of the Profile. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**ProfilePagedMetadata**](ProfilePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_profile_by_account_id** -> ProfilePagedMetadata get_profile_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of profiles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order - -{\"nickname\":\"Retrieve by account\",\"response\":\"getProfileByAccountID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProfilesApi() -account_id = 'account_id_example' # str | The account-ID of the profile. -organizations = ['organizations_example'] # list[str] | A list of organizations used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first profile to return. (optional) (default to 0) -records = 10 # int | The maximum number of profiles to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of profiles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order - api_response = api_instance.get_profile_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProfilesApi->get_profile_by_account_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **str**| The account-ID of the profile. | - **organizations** | [**list[str]**](str.md)| A list of organizations used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first profile to return. | [optional] [default to 0] - **records** | **int**| The maximum number of profiles to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**ProfilePagedMetadata**](ProfilePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_profile_by_email_address** -> ProfilePagedMetadata get_profile_by_email_address(email, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a single profile, specified by the email parameter. - -{\"nickname\":\"Retrieve by e-mail\",\"response\":\"getProfileByEmail.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProfilesApi() -email = 'email_example' # str | The email address of the profile. -organizations = ['organizations_example'] # list[str] | A list of organizations used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first profile to return. (optional) (default to 0) -records = 10 # int | The maximum number of profiles to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired profiles should be returned. (optional) (default to false) - -try: - # Returns a single profile, specified by the email parameter. - api_response = api_instance.get_profile_by_email_address(email, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProfilesApi->get_profile_by_email_address: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **email** | **str**| The email address of the profile. | - **organizations** | [**list[str]**](str.md)| A list of organizations used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first profile to return. | [optional] [default to 0] - **records** | **int**| The maximum number of profiles to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired profiles should be returned. | [optional] [default to false] - -### Return type - -[**ProfilePagedMetadata**](ProfilePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_profile** -> ProfilePagedMetadata update_profile(request) - -Update a profile - -{\"nickname\":\"Update a profile\",\"request\":\"updateProfileRequest.html\",\"response\":\"updateProfileResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.ProfilesApi() -request = billforward.UpdateProfileRequest() # UpdateProfileRequest | The profile object to be updated. - -try: - # Update a profile - api_response = api_instance.update_profile(request) - pprint(api_response) -except ApiException as e: - print "Exception when calling ProfilesApi->update_profile: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **request** | [**UpdateProfileRequest**](UpdateProfileRequest.md)| The profile object to be updated. | - -### Return type - -[**ProfilePagedMetadata**](ProfilePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PublicConfigurationResponse.md b/docs/PublicConfigurationResponse.md new file mode 100644 index 0000000..790a044 --- /dev/null +++ b/docs/PublicConfigurationResponse.md @@ -0,0 +1,11 @@ +# PublicConfigurationResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**square_app_id** | **str** | | [optional] +**square_o_auth_url** | **str** | | [optional] +**stripe_client_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/QuoteRequest.md b/docs/QuoteRequest.md index 5a8e4cc..c862fd1 100644 --- a/docs/QuoteRequest.md +++ b/docs/QuoteRequest.md @@ -3,24 +3,28 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**product** | **str** | {\"description\":\"The product for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**product_rate_plan** | **str** | {\"description\":\"The rate plan (of some product) for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | -**account_id** | **str** | {\"description\":\"ID of the account for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**subscription_id** | **str** | {\"description\":\"ID of the subscription for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**subscription_version_id** | **str** | {\"description\":\"version ID of the subscription for which a price quote is requested.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**quote_for** | **str** | {\"default\":\"RecurringPeriod\",\"description\":\"Subscription scenario with which the quote is concerned.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**prorated** | **bool** | {\"default\":true,\"description\":\"Whether or not to pro-rate the price (if the quote concerns a time interval containing a partial period).\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**free** | **bool** | {\"default\":false,\"description\":\"Whether or not to present a waived final price in the quote.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**include_applied_coupons** | **bool** | {\"default\":true,\"description\":\"Whether or not to include coupons which have already been applied to the subscription.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**period_start** | **datetime** | {\"default\":\"(Now)\",\"description\":\"The time-beginning of the interval with which the quote is concerned. This can be used to request a quote across partial or multiple periods &mdash; potentially pro-rating its price.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**period_end** | **datetime** | {\"default\":\"(End of current period)\",\"description\":\"The time-ending of the interval with which the quote is concerned. This can be used to request a quote across partial or multiple periods &mdash; potentially pro-rating its price.\",\"verbs\":[\"POST\",\"GET\"]} | -**remaining_credit_behaviour** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">Rollover</span>\",\"description\":\"Defines the behaviour applied to any outstanding credit resulting from the application of the charge..<br><span class=\\\"label label-default\\\">Rollover</span> &mdash; Outstanding credit is returned to the accounts credit pool.<br><span class=\\\"label label-default\\\">Discard</span> &mdash; Outstanding credit is lost.\",\"verbs\":[\"POST\",\"GET\"]} | -**quantities** | [**list[QuoteRequestValue]**](QuoteRequestValue.md) | {\"description\":\"A list of pricing components (and their values) to consider in calculating the quote.\",\"verbs\":[\"POST\"]} | [optional] -**coupon_codes** | **list[str]** | {\"description\":\"A list of coupon codes to consider in calculating the quote.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**pricing_behaviour** | **str** | { \"description\" : \"Pricing behaviour defines how migration charges are calculated. <span class=\\\"label label-default\\\">DifferenceProRated</span> calculates the difference between in-advance charges of the existing and new rate-plan, then pro-rates based on time remaining. <span class=\\\"label label-default\\\">None</span> sets the migration charge as zero cost. <span class=\\\"label label-default\\\">Full</span> sets the costs as the total of the new rate-plans in-advance charges. <span class=\\\"label label-default\\\">Difference</span> is the same calculation as <span class=\\\"label label-default\\\">DifferenceProRated</span> but no pro-ration is applied. <span class=\\\"label label-default\\\">ProRated</span> differs depending on two cases; when moving to a rate-plan of the same duration it pro-rates the in-advance charges of the new rate-plan. If the duration is different, a credit-note will be issued any remaining time on the existing plans billing period.\", \"default\" : \"DifferenceProRated\", \"verbs\":[\"POST\",\"GET\"] } | +**product** | **str** | | [optional] +**product_rate_plan** | **str** | | [optional] +**product_id** | **str** | | [optional] +**product_name** | **str** | | [optional] +**product_rate_plan_name** | **str** | | [optional] +**account_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**quote_for** | **str** | | [optional] +**prorated** | **bool** | | [optional] +**free** | **bool** | | [optional] +**include_applied_coupons** | **bool** | | [optional] +**period_start** | **datetime** | | [optional] +**period_end** | **datetime** | | +**remaining_credit_behaviour** | **str** | | +**quantities** | [**list[QuoteRequestValue]**](QuoteRequestValue.md) | | [optional] +**coupon_codes** | **list[str]** | | [optional] +**store_quote** | **bool** | | [optional] +**pricing_behaviour** | **str** | | +**purchase_order** | **str** | | [optional] +**type** | **str** | | [optional] +**pricing_components** | [**list[QuoteRequestValue]**](QuoteRequestValue.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/QuoteRequestValue.md b/docs/QuoteRequestValue.md index 39d32ec..18001d8 100644 --- a/docs/QuoteRequestValue.md +++ b/docs/QuoteRequestValue.md @@ -3,11 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**pricing_component** | **str** | {\"description\":\"Name or ID of the pricing component involved in some price quote.\",\"verbs\":[\"POST\",\"GET\"]} | -**quantity** | **int** | {\"description\":\"Quantity consumed of the pricing component involved in some price quote.\",\"verbs\":[\"POST\",\"GET\"]} | -**existing_quantity** | **int** | {\"description\":\"Pre-existing value of pricing component from which the customer is transitioning. Provide this when calculating (for example) upgrade costs.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**percentage_discount** | **float** | {\"description\":\"The discount percentage applied to this pricing component.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] +**pricing_component** | **str** | | [optional] +**quantity** | **int** | | [optional] +**existing_quantity** | **int** | | [optional] +**percentage_discount** | **float** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/QuotesApi.md b/docs/QuotesApi.md index 9b99582..1d68a6a 100644 --- a/docs/QuotesApi.md +++ b/docs/QuotesApi.md @@ -1,51 +1,157 @@ # billforward.QuotesApi -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**quote**](QuotesApi.md#quote) | **POST** /quotes | Returns a quote. +[**get_all_quotes**](QuotesApi.md#get_all_quotes) | **GET** /quotes | +[**get_quote_by_id**](QuotesApi.md#get_quote_by_id) | **GET** /quotes/{id} | +[**quote**](QuotesApi.md#quote) | **POST** /quotes | +# **get_all_quotes** +> InlineResponseDefault52 get_all_quotes(account_id=account_id, subscription_id=subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.QuotesApi(billforward.ApiClient(configuration)) +account_id = ['account_id_example'] # list[str] | (optional) +subscription_id = ['subscription_id_example'] # list[str] | (optional) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: + api_response = api_instance.get_all_quotes(account_id=account_id, subscription_id=subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) + pprint(api_response) +except ApiException as e: + print("Exception when calling QuotesApi->get_all_quotes: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | [**list[str]**](str.md)| | [optional] + **subscription_id** | [**list[str]**](str.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + +### Return type + +[**InlineResponseDefault52**](InlineResponseDefault52.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_quote_by_id** +> InlineResponseDefault53 get_quote_by_id(id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.QuotesApi(billforward.ApiClient(configuration)) +id = 'id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_quote_by_id(id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling QuotesApi->get_quote_by_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault53**](InlineResponseDefault53.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **quote** -> APIQuotePagedMetadata quote(quote_request) +> InlineResponseDefault53 quote(body=body) -Returns a quote. -{\"nickname\":\"Returns a quote\",\"request\":\"PriceRequest.html\",\"response\":\"PriceCalculation.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.QuotesApi() -quote_request = billforward.QuoteRequest() # QuoteRequest | A quote request +api_instance = billforward.QuotesApi(billforward.ApiClient(configuration)) +body = billforward.QuoteRequest() # QuoteRequest | (optional) -try: - # Returns a quote. - api_response = api_instance.quote(quote_request) +try: + api_response = api_instance.quote(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling QuotesApi->quote: %s\n" % e + print("Exception when calling QuotesApi->quote: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **quote_request** | [**QuoteRequest**](QuoteRequest.md)| A quote request | + **body** | [**QuoteRequest**](QuoteRequest.md)| | [optional] ### Return type -[**APIQuotePagedMetadata**](APIQuotePagedMetadata.md) +[**InlineResponseDefault53**](InlineResponseDefault53.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/RecalculateChargeBatchRequest.md b/docs/RecalculateChargeBatchRequest.md new file mode 100644 index 0000000..183c401 --- /dev/null +++ b/docs/RecalculateChargeBatchRequest.md @@ -0,0 +1,13 @@ +# RecalculateChargeBatchRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**charges** | [**list[SingleRecalculateChargeRequest]**](SingleRecalculateChargeRequest.md) | | [optional] +**recalculate_invoices** | **bool** | | [optional] +**invoice_state** | **str** | | [optional] +**dry_run** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/RecalculateChargeBatchResponse.md b/docs/RecalculateChargeBatchResponse.md new file mode 100644 index 0000000..d207a56 --- /dev/null +++ b/docs/RecalculateChargeBatchResponse.md @@ -0,0 +1,13 @@ +# RecalculateChargeBatchResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**charges** | [**list[SubscriptionCharge]**](SubscriptionCharge.md) | | [optional] +**recalculated_invoices** | [**list[Invoice]**](Invoice.md) | | [optional] +**organization_id** | **str** | | [optional] +**recalculate_invoices** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/RecalculateChargeRequest.md b/docs/RecalculateChargeRequest.md index 8c4b8e6..665b1f7 100644 --- a/docs/RecalculateChargeRequest.md +++ b/docs/RecalculateChargeRequest.md @@ -3,15 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**name** | **str** | {\"description\":\"New friendly name given to the charge to help identify it.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**description** | **str** | {\"description\":\"New description given to the charge.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**amount** | **float** | {\"description\":\"(Applicable only if the existing charge has none of [`pricingComponentName`, `pricingComponentID`] defined)<br>New monetary amount for which to charge. Used only for ad-hoc charges (i.e charges not associated with any pricing component).<br>This amount excludes tax.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**invoicing_type** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">Aggregated</span>\",\"description\":\"The strategy for how to raise invoices describing the charges produced by this charge recalculation.<br><span class=\\\"label label-default\\\">Immediate</span> &mdash; Generate straight-away an invoice containing these charges.<br><span class=\\\"label label-default\\\">Aggregated</span> &mdash; Add these charges to the next invoice which is generated naturally &mdash; i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**pricing_component_value** | **int** | {\"description\":\"(Applicable only if the existing charge has any of [`pricingComponentName`, `pricingComponentID`] defined)<br>The updated value consumed of the pricing component which this charge concerns.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**recalculation_behaviour** | **str** | {\"default\":\"RecalculateWithLatestPricing\",\"verbs\":[\"POST\",\"GET\"]} | -**dry_run** | **bool** | {\"default\":false,\"description\":\"Changes described in the response:<br><span class=\\\"label label-default\\\">true</span> &mdash; Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.<br><span class=\\\"label label-default\\\">false</span> &mdash; Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**quantity_label** | **str** | | [optional] +**amount** | **float** | | [optional] +**invoicing_type** | **str** | | [optional] +**pricing_component_value** | **int** | | [optional] +**recalculation_behaviour** | **str** | | +**dry_run** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Receipt.md b/docs/Receipt.md index ea76489..b6029ac 100644 --- a/docs/Receipt.md +++ b/docs/Receipt.md @@ -3,11 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**refund_id** | **str** | | -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] **id** | **str** | | [optional] -**crm_id** | **str** | { \"description\" : \"CRM ID of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | +**crm_id** | **str** | | [optional] **invoice_id** | **str** | | [optional] **gateway_reference_id** | **str** | | [optional] **account_id** | **str** | | [optional] @@ -20,19 +19,20 @@ Name | Type | Description | Notes **card_country** | **str** | | [optional] **card_province** | **str** | | [optional] **card_type** | **str** | | [optional] -**ip_address** | **str** | {\"description\":\"IP address associated with this payment method.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**ip_address_country** | **str** | {\"description\":\"Country of the IP address associated with this payment method.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**type** | **str** | { \"description\" : \"Type of transaction.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**currency** | **str** | { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | +**ip_address** | **str** | | [optional] +**ip_address_country** | **str** | | [optional] +**type** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] **value** | **float** | | [optional] **payment_gateway** | **str** | | [optional] -**invoice_type** | **str** | { \"description\" : \"The type of the invoice. A subscription invoice is raised every time a subscription recurs. An amendment is created for intra-contract changes. An Adhoc invoice is created for payment that is taken out-of-band of a subscription. Finally the invoice generated for a trial period is marked as Trial.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | +**invoice_type** | **str** | | [optional] **execution_attempt** | **int** | | [optional] **decision** | **str** | | [optional] **reason_code** | **int** | | [optional] **raw_reason_code** | **str** | | [optional] **raw_data** | **list[str]** | | [optional] +**refund_id** | **str** | | +**subscription_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ReceiptPagedMetadata.md b/docs/ReceiptPagedMetadata.md deleted file mode 100644 index df3896f..0000000 --- a/docs/ReceiptPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# ReceiptPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Receipt]**](Receipt.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ReceiptsApi.md b/docs/ReceiptsApi.md index 46def12..f927e48 100644 --- a/docs/ReceiptsApi.md +++ b/docs/ReceiptsApi.md @@ -1,86 +1,84 @@ # billforward.ReceiptsApi -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_receipt**](ReceiptsApi.md#create_receipt) | **POST** /receipts | Create a receipt. -[**get_all_receipts**](ReceiptsApi.md#get_all_receipts) | **GET** /receipts | Returns a collection of all receipts. By default 10 values are returned. receipts are returned in natural order -[**get_receipt_by_id**](ReceiptsApi.md#get_receipt_by_id) | **GET** /receipts/{receipt-ID} | Returns a single receipt, specified by the ID parameter. -[**get_receipts_by_invoice**](ReceiptsApi.md#get_receipts_by_invoice) | **GET** /receipts/invoice/{invoice-ID} | Returns a receipt for the receipt payment. -[**get_receipts_by_payment**](ReceiptsApi.md#get_receipts_by_payment) | **GET** /receipts/payment/{payment-ID} | Returns a collection of receipts for the payment. -[**get_receipts_for_debit_payments_as_csv**](ReceiptsApi.md#get_receipts_for_debit_payments_as_csv) | **GET** /receipts/debits.csv | Retrieves debit payments in CSV format. -[**get_receipts_for_refund_payments_as_csv**](ReceiptsApi.md#get_receipts_for_refund_payments_as_csv) | **GET** /receipts/refunds.csv | Retrieves refunded payments in CSV format. - +[**create_receipt**](ReceiptsApi.md#create_receipt) | **POST** /receipts | +[**get_all_receipts**](ReceiptsApi.md#get_all_receipts) | **GET** /receipts | +[**get_receipt_by_id**](ReceiptsApi.md#get_receipt_by_id) | **GET** /receipts/{receipt-ID} | +[**get_receipts_by_invoice**](ReceiptsApi.md#get_receipts_by_invoice) | **GET** /receipts/invoice/{invoice-ID} | +[**get_receipts_by_payment**](ReceiptsApi.md#get_receipts_by_payment) | **GET** /receipts/payment/{payment-ID} | +[**get_receipts_for_debit_payments_as_csv**](ReceiptsApi.md#get_receipts_for_debit_payments_as_csv) | **GET** /receipts/debits.csv | +[**get_receipts_for_refund_payments_as_csv**](ReceiptsApi.md#get_receipts_for_refund_payments_as_csv) | **GET** /receipts/refunds.csv | # **create_receipt** -> ReceiptPagedMetadata create_receipt(receipt) +> InlineResponseDefault55 create_receipt(body=body) -Create a receipt. -{\"nickname\":\"Create a new receipt\",\"request\":\"createReceiptRequest.html\",\"response\":\"createReceiptResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.ReceiptsApi() -receipt = billforward.Receipt() # Receipt | The receipt object to be created. +api_instance = billforward.ReceiptsApi(billforward.ApiClient(configuration)) +body = billforward.Receipt() # Receipt | (optional) -try: - # Create a receipt. - api_response = api_instance.create_receipt(receipt) +try: + api_response = api_instance.create_receipt(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling ReceiptsApi->create_receipt: %s\n" % e + print("Exception when calling ReceiptsApi->create_receipt: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **receipt** | [**Receipt**](Receipt.md)| The receipt object to be created. | + **body** | [**Receipt**](Receipt.md)| | [optional] ### Return type -[**ReceiptPagedMetadata**](ReceiptPagedMetadata.md) +[**InlineResponseDefault55**](InlineResponseDefault55.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_receipts** -> ReceiptPagedMetadata get_all_receipts(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, account_id=account_id, invoice_id=invoice_id, payment_method_id=payment_method_id, type=type, gateway=gateway, decision=decision) +> InlineResponseDefault54 get_all_receipts(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, account_id=account_id, invoice_id=invoice_id, payment_method_id=payment_method_id, type=type, gateway=gateway, decision=decision) -Returns a collection of all receipts. By default 10 values are returned. receipts are returned in natural order -{\"nickname\":\"Get all receipts\",\"response\":\"getreceiptsAll.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.ReceiptsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first receipt to return. (optional) (default to 0) -records = 10 # int | The maximum number of receipts to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) +api_instance = billforward.ReceiptsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) account_id = ['account_id_example'] # list[str] | (optional) invoice_id = ['invoice_id_example'] # list[str] | (optional) payment_method_id = ['payment_method_id_example'] # list[str] | (optional) @@ -88,23 +86,22 @@ type = 'type_example' # str | (optional) gateway = 'gateway_example' # str | (optional) decision = 'decision_example' # str | (optional) -try: - # Returns a collection of all receipts. By default 10 values are returned. receipts are returned in natural order +try: api_response = api_instance.get_all_receipts(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, account_id=account_id, invoice_id=invoice_id, payment_method_id=payment_method_id, type=type, gateway=gateway, decision=decision) pprint(api_response) except ApiException as e: - print "Exception when calling ReceiptsApi->get_all_receipts: %s\n" % e + print("Exception when calling ReceiptsApi->get_all_receipts: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first receipt to return. | [optional] [default to 0] - **records** | **int**| The maximum number of receipts to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] **account_id** | [**list[str]**](str.md)| | [optional] **invoice_id** | [**list[str]**](str.md)| | [optional] **payment_method_id** | [**list[str]**](str.md)| | [optional] @@ -114,11 +111,11 @@ Name | Type | Description | Notes ### Return type -[**ReceiptPagedMetadata**](ReceiptPagedMetadata.md) +[**InlineResponseDefault54**](InlineResponseDefault54.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -128,285 +125,278 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_receipt_by_id** -> ReceiptPagedMetadata get_receipt_by_id(receipt_id, organizations=organizations) +> InlineResponseDefault55 get_receipt_by_id(receipt_id, organizations=organizations) -Returns a single receipt, specified by the ID parameter. -{\"nickname\":\"Retrieve an existing receipt\",\"response\":\"getreceiptByID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.ReceiptsApi() -receipt_id = 'receipt_id_example' # str | ID of the receipt. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +api_instance = billforward.ReceiptsApi(billforward.ApiClient(configuration)) +receipt_id = 'receipt_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Returns a single receipt, specified by the ID parameter. +try: api_response = api_instance.get_receipt_by_id(receipt_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling ReceiptsApi->get_receipt_by_id: %s\n" % e + print("Exception when calling ReceiptsApi->get_receipt_by_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **receipt_id** | **str**| ID of the receipt. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **receipt_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**ReceiptPagedMetadata**](ReceiptPagedMetadata.md) +[**InlineResponseDefault55**](InlineResponseDefault55.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_receipts_by_invoice** -> ReceiptPagedMetadata get_receipts_by_invoice(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) +> InlineResponseDefault54 get_receipts_by_invoice(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) -Returns a receipt for the receipt payment. -{\"nickname\":\"Retrieve by invoice\",\"response\":\"getreceiptsByInvoice.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.ReceiptsApi() -invoice_id = 'invoice_id_example' # str | ID of the Invoice. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first receipt to return. (optional) (default to 0) -records = 10 # int | The maximum number of receipts to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a receipt for the receipt payment. +api_instance = billforward.ReceiptsApi(billforward.ApiClient(configuration)) +invoice_id = 'invoice_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: api_response = api_instance.get_receipts_by_invoice(invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) pprint(api_response) except ApiException as e: - print "Exception when calling ReceiptsApi->get_receipts_by_invoice: %s\n" % e + print("Exception when calling ReceiptsApi->get_receipts_by_invoice: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **invoice_id** | **str**| ID of the Invoice. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first receipt to return. | [optional] [default to 0] - **records** | **int**| The maximum number of receipts to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] + **invoice_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] ### Return type -[**ReceiptPagedMetadata**](ReceiptPagedMetadata.md) +[**InlineResponseDefault54**](InlineResponseDefault54.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_receipts_by_payment** -> ReceiptPagedMetadata get_receipts_by_payment(payment_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) +> InlineResponseDefault54 get_receipts_by_payment(payment_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) -Returns a collection of receipts for the payment. -{\"nickname\":\"Retrieve by payment\",\"response\":\"getreceiptsByPayment.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.ReceiptsApi() -payment_id = 'payment_id_example' # str | ID of the payment. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first receipt to return. (optional) (default to 0) -records = 10 # int | The maximum number of receipts to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of receipts for the payment. +api_instance = billforward.ReceiptsApi(billforward.ApiClient(configuration)) +payment_id = 'payment_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: api_response = api_instance.get_receipts_by_payment(payment_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) pprint(api_response) except ApiException as e: - print "Exception when calling ReceiptsApi->get_receipts_by_payment: %s\n" % e + print("Exception when calling ReceiptsApi->get_receipts_by_payment: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **payment_id** | **str**| ID of the payment. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first receipt to return. | [optional] [default to 0] - **records** | **int**| The maximum number of receipts to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] + **payment_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] ### Return type -[**ReceiptPagedMetadata**](ReceiptPagedMetadata.md) +[**InlineResponseDefault54**](InlineResponseDefault54.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_receipts_for_debit_payments_as_csv** -> ReceiptPagedMetadata get_receipts_for_debit_payments_as_csv(organizations=organizations, received_start=received_start, received_end=received_end, offset=offset, records=records, order_by=order_by, order=order, gateway=gateway) +> get_receipts_for_debit_payments_as_csv(organizations=organizations, received_start=received_start, received_end=received_end, offset=offset, records=records, order_by=order_by, order=order, gateway=gateway) -Retrieves debit payments in CSV format. -{ \"nickname\":\"Debit payments CSV\",\"response\":\"Debit payments.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.ReceiptsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -received_start = 'received_start_example' # str | The UTC DateTime specifying the start of the interval within which payments were received. (optional) -received_end = 'received_end_example' # str | The UTC DateTime specifying the end of the interval within which payments were received. (optional) -offset = 56 # int | The offset from the first payment to return. (optional) -records = 56 # int | The maximum number of payments to return. (optional) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to DESC) -gateway = ['gateway_example'] # list[str] | A list of payment gateways to include in the account. If none are specified, all gateways will be included. (optional) - -try: - # Retrieves debit payments in CSV format. - api_response = api_instance.get_receipts_for_debit_payments_as_csv(organizations=organizations, received_start=received_start, received_end=received_end, offset=offset, records=records, order_by=order_by, order=order, gateway=gateway) - pprint(api_response) +api_instance = billforward.ReceiptsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +received_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +received_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +offset = 56 # int | (optional) +records = 56 # int | (optional) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +gateway = ['gateway_example'] # list[str] | (optional) + +try: + api_instance.get_receipts_for_debit_payments_as_csv(organizations=organizations, received_start=received_start, received_end=received_end, offset=offset, records=records, order_by=order_by, order=order, gateway=gateway) except ApiException as e: - print "Exception when calling ReceiptsApi->get_receipts_for_debit_payments_as_csv: %s\n" % e + print("Exception when calling ReceiptsApi->get_receipts_for_debit_payments_as_csv: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **received_start** | **str**| The UTC DateTime specifying the start of the interval within which payments were received. | [optional] - **received_end** | **str**| The UTC DateTime specifying the end of the interval within which payments were received. | [optional] - **offset** | **int**| The offset from the first payment to return. | [optional] - **records** | **int**| The maximum number of payments to return. | [optional] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **gateway** | [**list[str]**](str.md)| A list of payment gateways to include in the account. If none are specified, all gateways will be included. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **received_start** | [**SimpleDateParam**](.md)| | [optional] + **received_end** | [**SimpleDateParam**](.md)| | [optional] + **offset** | **int**| | [optional] + **records** | **int**| | [optional] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **gateway** | [**list[str]**](str.md)| | [optional] ### Return type -[**ReceiptPagedMetadata**](ReceiptPagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/csv + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_receipts_for_refund_payments_as_csv** -> ReceiptPagedMetadata get_receipts_for_refund_payments_as_csv(organizations=organizations, completed_start=completed_start, completed_end=completed_end, offset=offset, records=records, order_by=order_by, order=order) +> get_receipts_for_refund_payments_as_csv(organizations=organizations, completed_start=completed_start, completed_end=completed_end, offset=offset, records=records, order_by=order_by, order=order) -Retrieves refunded payments in CSV format. -{ \"nickname\":\"Refunded payments CSV\",\"response\":\"Refunded payments.csv\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.ReceiptsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -completed_start = 'completed_start_example' # str | The UTC DateTime specifying the start of the interval within which payments were received. (optional) -completed_end = 'completed_end_example' # str | The UTC DateTime specifying the end of the interval within which payments were received. (optional) -offset = 56 # int | The offset from the first payment to return. (optional) -records = 56 # int | The maximum number of payments to return. (optional) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Retrieves refunded payments in CSV format. - api_response = api_instance.get_receipts_for_refund_payments_as_csv(organizations=organizations, completed_start=completed_start, completed_end=completed_end, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) +api_instance = billforward.ReceiptsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +completed_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +completed_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +offset = 56 # int | (optional) +records = 56 # int | (optional) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: + api_instance.get_receipts_for_refund_payments_as_csv(organizations=organizations, completed_start=completed_start, completed_end=completed_end, offset=offset, records=records, order_by=order_by, order=order) except ApiException as e: - print "Exception when calling ReceiptsApi->get_receipts_for_refund_payments_as_csv: %s\n" % e + print("Exception when calling ReceiptsApi->get_receipts_for_refund_payments_as_csv: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **completed_start** | **str**| The UTC DateTime specifying the start of the interval within which payments were received. | [optional] - **completed_end** | **str**| The UTC DateTime specifying the end of the interval within which payments were received. | [optional] - **offset** | **int**| The offset from the first payment to return. | [optional] - **records** | **int**| The maximum number of payments to return. | [optional] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to DESC] + **organizations** | [**list[str]**](str.md)| | [optional] + **completed_start** | [**SimpleDateParam**](.md)| | [optional] + **completed_end** | [**SimpleDateParam**](.md)| | [optional] + **offset** | **int**| | [optional] + **records** | **int**| | [optional] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] ### Return type -[**ReceiptPagedMetadata**](ReceiptPagedMetadata.md) +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/csv + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/Refund.md b/docs/Refund.md index 4a9bc4f..ef3d8ae 100644 --- a/docs/Refund.md +++ b/docs/Refund.md @@ -3,35 +3,42 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\", \"PUT\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | [optional] -**account_id** | **str** | { \"description\" : \"Identifier of account to refund.\", \"verbs\":[\"GET\"] } | [optional] -**reason** | **str** | { \"description\" : \"The reason for the refund.\", \"verbs\":[\"GET\"] } | [optional] -**nominal_value** | **float** | { \"description\" : \"\", \"verbs\":[] } | -**value** | **float** | { \"description\" : \"Positive decimal representing the total value to refund. This is at most the amount un-refunded on the payment. If amount is the total payment amount is refunded.\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**refunded** | **float** | { \"description\" : \"Value refunded\", \"verbs\":[\"GET\"] } | [optional] -**actual_value** | **float** | { \"description\" : \"\", \"verbs\":[] } | -**nominal_refunded_value** | **float** | { \"description\" : \"Nominal value refunded.\", \"verbs\":[] } | -**actual_refunded_value** | **float** | { \"description\" : \"Refunded amount\", \"verbs\":[] } | -**refund_state** | **str** | { \"default\" : \"AwaitingRefund\", \"PUT_description\" : \"<span class=\\\"label label-default\\\">Pending</span> refunds can be set to <span class=\\\"label label-default\\\">AwaitingRefund</span> to initiate the refund or <span class=\\\"label label-default\\\">Cancelled</span> to stop the refund.\", \"description\" : \"Initially a refund is in the <span class=\\\"label label-default\\\">AwaitingRefund</span> state. Once the funds are successfully returned the state is <span class=\\\"label label-default\\\">Refunded</span>. If the refund fails or is rejected is it set as <span class=\\\"label label-default\\\">Failed</span>. Refunds can be set to a <span class=\\\"label label-default\\\">Pending</span> state to support authorization flows, and will leave the refund pending until updated to <span class=\\\"label label-default\\\">AwaitingRefund</span>. <span class=\\\"label label-default\\\">Cancelled</span> is when a refund will not be executed.\", \"verbs\":[\"GET\", \"POST\", \"PUT\"] } | -**refund_type** | **str** | { \"description\" : \"This is the type of refund. Refunds are associated with either an invoice and payment, a payment or unreferenced.\", \"verbs\":[] } | -**refund_nature** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">SingleAttempt</span>\",\"description\":The mechanism by which credit is returned to the customer:<br><span class=\\\"label label-default\\\">Void</span> &mdash; The original authorized payment is voided before capture.<br><span class=\\\"label label-default\\\">Refund</span> &mdash; A refund is issued against an already-captured payment.\",\"verbs\":[\"GET\"]} | -**refund_completed** | **datetime** | { \"description\" : \"When the refund was completed\", \"verbs\":[\"GET\"] } | [optional] -**currency** | **str** | { \"description\" : \"Currency of the refund specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } | -**payment_method_id** | **str** | { \"description\" : \"Payment method to refund from\", \"verbs\":[\"GET\"] } | [optional] -**invoice_payment_id** | **str** | { \"description\" : \"Invoice payment to refund\", \"verbs\":[\"POST\", \"GET\"] } | [optional] -**refund_invoice_payment_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | [optional] -**original_payment_id** | **str** | { \"description\" : \"Original payment being refunded.\", \"verbs\":[\"GET\"] } | [optional] -**original_gateway_payment_reference** | **str** | { \"description\" : \"Reference in the gateway to the payment being refunded.\", \"verbs\":[\"GET\"] } | [optional] -**refund_payment_id** | **str** | { \"description\" : \"Identifier for the payment used to refund\", \"verbs\":[\"GET\"] } | [optional] -**invoice_id** | **str** | { \"description\" : \"Invoice to refund.\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**receipt_id** | **str** | { \"description\" : \"ID of the receipt for this refund.\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**original_receipt_id** | **str** | { \"description\" : \"ID of the receipt for the successful payment that this entity refunds.\", \"verbs\":[\"POST\",\"GET\"] } | [optional] -**created_by** | **str** | { \"description\" : \"Refund requested by this account\", \"verbs\":[\"GET\"] } | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**reason** | **str** | | [optional] +**nominal_value** | **float** | | +**value** | **float** | | [optional] +**refunded** | **float** | | [optional] +**actual_value** | **float** | | +**nominal_refunded_value** | **float** | | +**actual_refunded_value** | **float** | | +**refund_state** | **str** | | +**refund_type** | **str** | | +**refund_nature** | **str** | | +**last_execution_attempt** | **datetime** | | [optional] +**next_execution_attempt** | **datetime** | | [optional] +**final_execution_attempt** | **datetime** | | [optional] +**refund_completed** | **datetime** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | +**payment_method_id** | **str** | | [optional] +**invoice_payment_id** | **str** | | [optional] +**refund_invoice_payment_id** | **str** | | [optional] +**original_payment_id** | **str** | | [optional] +**original_gateway_payment_reference** | **str** | | [optional] +**refund_payment_id** | **str** | | [optional] +**invoice_id** | **str** | | [optional] +**receipt_id** | **str** | | [optional] +**original_receipt_id** | **str** | | [optional] +**created_by** | **str** | | [optional] +**type** | **str** | | [optional] +**state** | **str** | | [optional] +**refunded_value** | **float** | | [optional] +**refunded_payment** | [**Payment**](Payment.md) | | [optional] +**account** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RefundAccountingView.md b/docs/RefundAccountingView.md new file mode 100644 index 0000000..edd9f55 --- /dev/null +++ b/docs/RefundAccountingView.md @@ -0,0 +1,26 @@ +# RefundAccountingView + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**actual_refunded_value** | **float** | | [optional] +**refund_completed** | **datetime** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**account_id** | **str** | | [optional] +**reason** | **str** | | [optional] +**nominal_value** | **float** | | [optional] +**actual_value** | **float** | | [optional] +**nominal_refunded_value** | **float** | | [optional] +**refund_type** | **str** | | [optional] +**refund_nature** | **str** | | [optional] +**payment_method_id** | **str** | | [optional] +**invoice_payment_id** | **str** | | [optional] +**original_payment_id** | **str** | | [optional] +**refund_payment_id** | **str** | | [optional] +**invoice_id** | **str** | | [optional] +**receipt_id** | **str** | | [optional] +**original_receipt_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/RefundPagedMetadata.md b/docs/RefundPagedMetadata.md deleted file mode 100644 index 4d8a87a..0000000 --- a/docs/RefundPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# RefundPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Refund]**](Refund.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RefundsApi.md b/docs/RefundsApi.md deleted file mode 100644 index d4296f1..0000000 --- a/docs/RefundsApi.md +++ /dev/null @@ -1,420 +0,0 @@ -# billforward.RefundsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_refund**](RefundsApi.md#create_refund) | **POST** /refunds | <p>When creating a refund either the invoice, or invoice payment must be specified.</p><p>Creating a refund by specifying the invoiceID will refund any un-refunded value up to the full value of the payment. When refunding via the invoicePaymentID the same rules apply. Refunds will be processed by the same payment methods that took the payment.</p><p>Refunds can be for a partial amount of the payment. It is possible to create refunds up to the value of the total payment.</p><p>Once a payment or invoice is fully refunded, no more refunds can be created. Errors will be returned if the payment is greater than available refund funds.</p> -[**get_all_refunds**](RefundsApi.md#get_all_refunds) | **GET** /refunds | Returns a collection of all refunds. By default 10 values are returned. Refunds are returned in natural order -[**get_refund_by_id**](RefundsApi.md#get_refund_by_id) | **GET** /refunds/{refund-ID} | Returns a single refund, specified by the ID parameter. -[**get_refund_for_original_payment**](RefundsApi.md#get_refund_for_original_payment) | **GET** /refunds/original-payment/{payment-ID} | Returns a refund for the original payment. -[**get_refund_for_refund_payment**](RefundsApi.md#get_refund_for_refund_payment) | **GET** /refunds/refund-payment/{payment-ID} | Returns a refund for the refund payment. -[**get_refund_for_refunded_invoice**](RefundsApi.md#get_refund_for_refunded_invoice) | **GET** /refunds/invoice/{invoice-ID} | Returns a refund for the refund payment. -[**get_refunds_as_csv**](RefundsApi.md#get_refunds_as_csv) | **GET** /refunds/csv | Retrieves refunds in CSV format. -[**update_refund**](RefundsApi.md#update_refund) | **PUT** /refunds | Update a refund - - -# **create_refund** -> RefundPagedMetadata create_refund(refund) - -

When creating a refund either the invoice, or invoice payment must be specified.

Creating a refund by specifying the invoiceID will refund any un-refunded value up to the full value of the payment. When refunding via the invoicePaymentID the same rules apply. Refunds will be processed by the same payment methods that took the payment.

Refunds can be for a partial amount of the payment. It is possible to create refunds up to the value of the total payment.

Once a payment or invoice is fully refunded, no more refunds can be created. Errors will be returned if the payment is greater than available refund funds.

- -{\"nickname\":\"Create a new refund\",\"request\":\"createRefundRequest.html\",\"response\":\"createRefundResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RefundsApi() -refund = billforward.Refund() # Refund | The refund object to be created. - -try: - #

When creating a refund either the invoice, or invoice payment must be specified.

Creating a refund by specifying the invoiceID will refund any un-refunded value up to the full value of the payment. When refunding via the invoicePaymentID the same rules apply. Refunds will be processed by the same payment methods that took the payment.

Refunds can be for a partial amount of the payment. It is possible to create refunds up to the value of the total payment.

Once a payment or invoice is fully refunded, no more refunds can be created. Errors will be returned if the payment is greater than available refund funds.

- api_response = api_instance.create_refund(refund) - pprint(api_response) -except ApiException as e: - print "Exception when calling RefundsApi->create_refund: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **refund** | [**Refund**](Refund.md)| The refund object to be created. | - -### Return type - -[**RefundPagedMetadata**](RefundPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_refunds** -> RefundPagedMetadata get_all_refunds(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of all refunds. By default 10 values are returned. Refunds are returned in natural order - -{\"nickname\":\"Get all refunds\",\"response\":\"getRefundsAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RefundsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first refund to return. (optional) (default to 0) -records = 10 # int | The maximum number of refunds to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of all refunds. By default 10 values are returned. Refunds are returned in natural order - api_response = api_instance.get_all_refunds(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling RefundsApi->get_all_refunds: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first refund to return. | [optional] [default to 0] - **records** | **int**| The maximum number of refunds to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**RefundPagedMetadata**](RefundPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_refund_by_id** -> RefundPagedMetadata get_refund_by_id(refund_id, organizations=organizations) - -Returns a single refund, specified by the ID parameter. - -{\"nickname\":\"Retrieve an existing refund\",\"response\":\"getRefundByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RefundsApi() -refund_id = 'refund_id_example' # str | ID of the Refund. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single refund, specified by the ID parameter. - api_response = api_instance.get_refund_by_id(refund_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling RefundsApi->get_refund_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **refund_id** | **str**| ID of the Refund. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**RefundPagedMetadata**](RefundPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_refund_for_original_payment** -> RefundPagedMetadata get_refund_for_original_payment(payment_id, organizations=organizations) - -Returns a refund for the original payment. - -{\"nickname\":\"Retrieve by originating payment\",\"response\":\"getRefundsByPayment.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RefundsApi() -payment_id = 'payment_id_example' # str | ID of the Payment. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a refund for the original payment. - api_response = api_instance.get_refund_for_original_payment(payment_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling RefundsApi->get_refund_for_original_payment: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_id** | **str**| ID of the Payment. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**RefundPagedMetadata**](RefundPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_refund_for_refund_payment** -> RefundPagedMetadata get_refund_for_refund_payment(payment_id, organizations=organizations) - -Returns a refund for the refund payment. - -{\"nickname\":\"Retrieve by refund payment\",\"response\":\"getRefundsByPayment.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RefundsApi() -payment_id = 'payment_id_example' # str | ID of the Payment. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a refund for the refund payment. - api_response = api_instance.get_refund_for_refund_payment(payment_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling RefundsApi->get_refund_for_refund_payment: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **payment_id** | **str**| ID of the Payment. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**RefundPagedMetadata**](RefundPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_refund_for_refunded_invoice** -> RefundPagedMetadata get_refund_for_refunded_invoice(invoice_id, organizations=organizations) - -Returns a refund for the refund payment. - -{\"nickname\":\"Retrieve by invoice\",\"response\":\"getRefundsByInvoice.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RefundsApi() -invoice_id = 'invoice_id_example' # str | ID of the Invoice. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a refund for the refund payment. - api_response = api_instance.get_refund_for_refunded_invoice(invoice_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling RefundsApi->get_refund_for_refunded_invoice: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **invoice_id** | **str**| ID of the Invoice. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**RefundPagedMetadata**](RefundPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_refunds_as_csv** -> RefundPagedMetadata get_refunds_as_csv(completed_start, completed_end, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Retrieves refunds in CSV format. - -{ \"nickname\":\"Refunds CSV\",\"response\":\"refunds.csv\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RefundsApi() -completed_start = 'completed_start_example' # str | The UTC DateTime specifying the start of the interval within which refunds were completed. -completed_end = 'completed_end_example' # str | The UTC DateTime specifying the end of the interval within which refunds were completed. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 56 # int | The offset from the first refund to return. (optional) -records = 56 # int | The maximum number of refunds to return. (optional) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Retrieves refunds in CSV format. - api_response = api_instance.get_refunds_as_csv(completed_start, completed_end, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling RefundsApi->get_refunds_as_csv: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **completed_start** | **str**| The UTC DateTime specifying the start of the interval within which refunds were completed. | - **completed_end** | **str**| The UTC DateTime specifying the end of the interval within which refunds were completed. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first refund to return. | [optional] - **records** | **int**| The maximum number of refunds to return. | [optional] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**RefundPagedMetadata**](RefundPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: text/csv - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_refund** -> RefundPagedMetadata update_refund(refund) - -Update a refund - -{\"nickname\":\"Update a refund\",\"request\":\"updateRefundRequest.html\",\"response\":\"updateRefundResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RefundsApi() -refund = billforward.Refund() # Refund | The refund object to be update. - -try: - # Update a refund - api_response = api_instance.update_refund(refund) - pprint(api_response) -except ApiException as e: - print "Exception when calling RefundsApi->update_refund: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **refund** | [**Refund**](Refund.md)| The refund object to be update. | - -### Return type - -[**RefundPagedMetadata**](RefundPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/RemoveCreditAccountRequest.md b/docs/RemoveCreditAccountRequest.md new file mode 100644 index 0000000..00a9d7d --- /dev/null +++ b/docs/RemoveCreditAccountRequest.md @@ -0,0 +1,12 @@ +# RemoveCreditAccountRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**value** | **float** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ReportsApi.md b/docs/ReportsApi.md new file mode 100644 index 0000000..735180b --- /dev/null +++ b/docs/ReportsApi.md @@ -0,0 +1,783 @@ +# billforward.ReportsApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_accounts_overview**](ReportsApi.md#get_accounts_overview) | **GET** /reports/accounts/overview.csv | +[**get_affiliate_charge_report**](ReportsApi.md#get_affiliate_charge_report) | **GET** /reports/affiliate/overview.csv | +[**get_coupon_report**](ReportsApi.md#get_coupon_report) | **GET** /reports/coupons/overview.csv | +[**get_csv_report_invoice_line_payments_bucketed**](ReportsApi.md#get_csv_report_invoice_line_payments_bucketed) | **GET** /reports/fulfilled/bucketed.csv | +[**get_csv_report_invoice_line_payments_raw**](ReportsApi.md#get_csv_report_invoice_line_payments_raw) | **GET** /reports/fulfilled/raw.csv | +[**get_csv_report_revenue_attributions_bucketed**](ReportsApi.md#get_csv_report_revenue_attributions_bucketed) | **GET** /reports/invoiced/bucketed.csv | +[**get_csv_report_revenue_attributions_raw**](ReportsApi.md#get_csv_report_revenue_attributions_raw) | **GET** /reports/invoiced/raw.csv | +[**get_csv_revenue_schedule**](ReportsApi.md#get_csv_revenue_schedule) | **GET** /reports/revenue-schedule/raw.csv | +[**get_payment_transactions**](ReportsApi.md#get_payment_transactions) | **GET** /reports/transactions/payments.csv | +[**get_refunds_as_csv**](ReportsApi.md#get_refunds_as_csv) | **GET** /refunds/csv | +[**get_shipments_report**](ReportsApi.md#get_shipments_report) | **GET** /reports/shipments/overview.csv | +[**get_subscriptions_overview**](ReportsApi.md#get_subscriptions_overview) | **GET** /reports/subscriptions/overview.csv | + +# **get_accounts_overview** +> get_accounts_overview(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ReportsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +date_discriminator = 'AccountCreated' # str | (optional) (default to AccountCreated) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) +meta_column_account = ['meta_column_account_example'] # list[str] | (optional) + +try: + api_instance.get_accounts_overview(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account) +except ApiException as e: + print("Exception when calling ReportsApi->get_accounts_overview: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **date_discriminator** | **str**| | [optional] [default to AccountCreated] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] + **meta_column_account** | [**list[str]**](str.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_affiliate_charge_report** +> get_affiliate_charge_report(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ReportsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) + +try: + api_instance.get_affiliate_charge_report(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +except ApiException as e: + print("Exception when calling ReportsApi->get_affiliate_charge_report: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_coupon_report** +> get_coupon_report(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ReportsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) + +try: + api_instance.get_coupon_report(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +except ApiException as e: + print("Exception when calling ReportsApi->get_coupon_report: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_csv_report_invoice_line_payments_bucketed** +> get_csv_report_invoice_line_payments_bucketed(organizations=organizations, payment_direction=payment_direction, bucket_type=bucket_type, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway, accounts=accounts, subscriptions=subscriptions, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ReportsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +payment_direction = 'All' # str | (optional) (default to All) +bucket_type = 'DebitActualAmount' # str | (optional) (default to DebitActualAmount) +date_discriminator = 'PeriodStart' # str | (optional) (default to PeriodStart) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +include_gateway = ['include_gateway_example'] # list[str] | (optional) +exclude_gateway = ['exclude_gateway_example'] # list[str] | (optional) +accounts = ['accounts_example'] # list[str] | (optional) +subscriptions = ['subscriptions_example'] # list[str] | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) +meta_column_account = ['meta_column_account_example'] # list[str] | (optional) +meta_column_sub_child = ['meta_column_sub_child_example'] # list[str] | (optional) + +try: + api_instance.get_csv_report_invoice_line_payments_bucketed(organizations=organizations, payment_direction=payment_direction, bucket_type=bucket_type, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway, accounts=accounts, subscriptions=subscriptions, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child) +except ApiException as e: + print("Exception when calling ReportsApi->get_csv_report_invoice_line_payments_bucketed: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **payment_direction** | **str**| | [optional] [default to All] + **bucket_type** | **str**| | [optional] [default to DebitActualAmount] + **date_discriminator** | **str**| | [optional] [default to PeriodStart] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **include_gateway** | [**list[str]**](str.md)| | [optional] + **exclude_gateway** | [**list[str]**](str.md)| | [optional] + **accounts** | [**list[str]**](str.md)| | [optional] + **subscriptions** | [**list[str]**](str.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] + **meta_column_account** | [**list[str]**](str.md)| | [optional] + **meta_column_sub_child** | [**list[str]**](str.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_csv_report_invoice_line_payments_raw** +> get_csv_report_invoice_line_payments_raw(organizations=organizations, payment_direction=payment_direction, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway, accounts=accounts, subscriptions=subscriptions, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ReportsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +payment_direction = 'All' # str | (optional) (default to All) +date_discriminator = 'PeriodStart' # str | (optional) (default to PeriodStart) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +include_gateway = ['include_gateway_example'] # list[str] | (optional) +exclude_gateway = ['exclude_gateway_example'] # list[str] | (optional) +accounts = ['accounts_example'] # list[str] | (optional) +subscriptions = ['subscriptions_example'] # list[str] | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) +meta_column_account = ['meta_column_account_example'] # list[str] | (optional) +meta_column_sub_child = ['meta_column_sub_child_example'] # list[str] | (optional) + +try: + api_instance.get_csv_report_invoice_line_payments_raw(organizations=organizations, payment_direction=payment_direction, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway, accounts=accounts, subscriptions=subscriptions, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child) +except ApiException as e: + print("Exception when calling ReportsApi->get_csv_report_invoice_line_payments_raw: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **payment_direction** | **str**| | [optional] [default to All] + **date_discriminator** | **str**| | [optional] [default to PeriodStart] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **include_gateway** | [**list[str]**](str.md)| | [optional] + **exclude_gateway** | [**list[str]**](str.md)| | [optional] + **accounts** | [**list[str]**](str.md)| | [optional] + **subscriptions** | [**list[str]**](str.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] + **meta_column_account** | [**list[str]**](str.md)| | [optional] + **meta_column_sub_child** | [**list[str]**](str.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_csv_report_revenue_attributions_bucketed** +> get_csv_report_revenue_attributions_bucketed(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ReportsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +date_discriminator = 'PeriodStart' # str | (optional) (default to PeriodStart) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) +meta_column_account = ['meta_column_account_example'] # list[str] | (optional) +meta_column_sub_child = ['meta_column_sub_child_example'] # list[str] | (optional) + +try: + api_instance.get_csv_report_revenue_attributions_bucketed(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child) +except ApiException as e: + print("Exception when calling ReportsApi->get_csv_report_revenue_attributions_bucketed: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **date_discriminator** | **str**| | [optional] [default to PeriodStart] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] + **meta_column_account** | [**list[str]**](str.md)| | [optional] + **meta_column_sub_child** | [**list[str]**](str.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_csv_report_revenue_attributions_raw** +> get_csv_report_revenue_attributions_raw(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ReportsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +date_discriminator = 'PeriodStart' # str | (optional) (default to PeriodStart) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) +meta_column_account = ['meta_column_account_example'] # list[str] | (optional) +meta_column_sub_child = ['meta_column_sub_child_example'] # list[str] | (optional) + +try: + api_instance.get_csv_report_revenue_attributions_raw(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child) +except ApiException as e: + print("Exception when calling ReportsApi->get_csv_report_revenue_attributions_raw: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **date_discriminator** | **str**| | [optional] [default to PeriodStart] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] + **meta_column_account** | [**list[str]**](str.md)| | [optional] + **meta_column_sub_child** | [**list[str]**](str.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_csv_revenue_schedule** +> get_csv_revenue_schedule(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway, bucket_by=bucket_by, group_by=group_by, pivot_by_dates=pivot_by_dates, include_detailed_lines=include_detailed_lines, accounts=accounts, subscriptions=subscriptions, plans=plans) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ReportsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +include_gateway = ['include_gateway_example'] # list[str] | (optional) +exclude_gateway = ['exclude_gateway_example'] # list[str] | (optional) +bucket_by = 'day' # str | (optional) (default to day) +group_by = ['group_by_example'] # list[str] | (optional) +pivot_by_dates = false # bool | (optional) (default to false) +include_detailed_lines = false # bool | (optional) (default to false) +accounts = ['accounts_example'] # list[str] | (optional) +subscriptions = ['subscriptions_example'] # list[str] | (optional) +plans = ['plans_example'] # list[str] | (optional) + +try: + api_instance.get_csv_revenue_schedule(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway, bucket_by=bucket_by, group_by=group_by, pivot_by_dates=pivot_by_dates, include_detailed_lines=include_detailed_lines, accounts=accounts, subscriptions=subscriptions, plans=plans) +except ApiException as e: + print("Exception when calling ReportsApi->get_csv_revenue_schedule: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **include_gateway** | [**list[str]**](str.md)| | [optional] + **exclude_gateway** | [**list[str]**](str.md)| | [optional] + **bucket_by** | **str**| | [optional] [default to day] + **group_by** | [**list[str]**](str.md)| | [optional] + **pivot_by_dates** | **bool**| | [optional] [default to false] + **include_detailed_lines** | **bool**| | [optional] [default to false] + **accounts** | [**list[str]**](str.md)| | [optional] + **subscriptions** | [**list[str]**](str.md)| | [optional] + **plans** | [**list[str]**](str.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_payment_transactions** +> get_payment_transactions(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ReportsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +date_discriminator = 'PaymentReceived' # str | (optional) (default to PaymentReceived) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +include_gateway = ['include_gateway_example'] # list[str] | (optional) +exclude_gateway = ['exclude_gateway_example'] # list[str] | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) +meta_column_account = ['meta_column_account_example'] # list[str] | (optional) +meta_column_sub_child = ['meta_column_sub_child_example'] # list[str] | (optional) + +try: + api_instance.get_payment_transactions(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, include_gateway=include_gateway, exclude_gateway=exclude_gateway, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child) +except ApiException as e: + print("Exception when calling ReportsApi->get_payment_transactions: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **date_discriminator** | **str**| | [optional] [default to PaymentReceived] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **include_gateway** | [**list[str]**](str.md)| | [optional] + **exclude_gateway** | [**list[str]**](str.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] + **meta_column_account** | [**list[str]**](str.md)| | [optional] + **meta_column_sub_child** | [**list[str]**](str.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_refunds_as_csv** +> get_refunds_as_csv(organizations=organizations, completed_start=completed_start, completed_end=completed_end, offset=offset, records=records, order_by=order_by, order=order) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ReportsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +completed_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +completed_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +offset = 56 # int | (optional) +records = 56 # int | (optional) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: + api_instance.get_refunds_as_csv(organizations=organizations, completed_start=completed_start, completed_end=completed_end, offset=offset, records=records, order_by=order_by, order=order) +except ApiException as e: + print("Exception when calling ReportsApi->get_refunds_as_csv: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **completed_start** | [**SimpleDateParam**](.md)| | [optional] + **completed_end** | [**SimpleDateParam**](.md)| | [optional] + **offset** | **int**| | [optional] + **records** | **int**| | [optional] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_shipments_report** +> get_shipments_report(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ReportsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) + +try: + api_instance.get_shipments_report(organizations=organizations, recognition_start=recognition_start, recognition_end=recognition_end) +except ApiException as e: + print("Exception when calling ReportsApi->get_shipments_report: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_subscriptions_overview** +> get_subscriptions_overview(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub=meta_column_sub, account_id=account_id, subscription_id=subscription_id, parent_sub_id=parent_sub_id, product_id=product_id, rate_plan_id=rate_plan_id, exclude_child_subs=exclude_child_subs, exclude_parentless_subs=exclude_parentless_subs) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.ReportsApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +date_discriminator = 'AccountCreated' # str | (optional) (default to AccountCreated) +recognition_start = billforward.SimpleDateParam() # SimpleDateParam | (optional) +recognition_end = billforward.SimpleDateParam() # SimpleDateParam | (optional) +date_interval_inclusivity = 'Exclusive' # str | (optional) (default to Exclusive) +date_time_format = 'UTCExcel' # str | (optional) (default to UTCExcel) +date_granularity = 'Second' # str | (optional) (default to Second) +boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseLowercase) +monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) +meta_column_account = ['meta_column_account_example'] # list[str] | (optional) +meta_column_sub = ['meta_column_sub_example'] # list[str] | (optional) +account_id = ['account_id_example'] # list[str] | (optional) +subscription_id = ['subscription_id_example'] # list[str] | (optional) +parent_sub_id = ['parent_sub_id_example'] # list[str] | (optional) +product_id = ['product_id_example'] # list[str] | (optional) +rate_plan_id = ['rate_plan_id_example'] # list[str] | (optional) +exclude_child_subs = false # bool | (optional) (default to false) +exclude_parentless_subs = false # bool | (optional) (default to false) + +try: + api_instance.get_subscriptions_overview(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub=meta_column_sub, account_id=account_id, subscription_id=subscription_id, parent_sub_id=parent_sub_id, product_id=product_id, rate_plan_id=rate_plan_id, exclude_child_subs=exclude_child_subs, exclude_parentless_subs=exclude_parentless_subs) +except ApiException as e: + print("Exception when calling ReportsApi->get_subscriptions_overview: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **date_discriminator** | **str**| | [optional] [default to AccountCreated] + **recognition_start** | [**SimpleDateParam**](.md)| | [optional] + **recognition_end** | [**SimpleDateParam**](.md)| | [optional] + **date_interval_inclusivity** | **str**| | [optional] [default to Exclusive] + **date_time_format** | **str**| | [optional] [default to UTCExcel] + **date_granularity** | **str**| | [optional] [default to Second] + **boolean_format** | **str**| | [optional] [default to TrueFalseLowercase] + **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] + **meta_column_account** | [**list[str]**](str.md)| | [optional] + **meta_column_sub** | [**list[str]**](str.md)| | [optional] + **account_id** | [**list[str]**](str.md)| | [optional] + **subscription_id** | [**list[str]**](str.md)| | [optional] + **parent_sub_id** | [**list[str]**](str.md)| | [optional] + **product_id** | [**list[str]**](str.md)| | [optional] + **rate_plan_id** | [**list[str]**](str.md)| | [optional] + **exclude_child_subs** | **bool**| | [optional] [default to false] + **exclude_parentless_subs** | **bool**| | [optional] [default to false] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ResumeRequest.md b/docs/ResumeRequest.md index dbe57b2..8ed45eb 100644 --- a/docs/ResumeRequest.md +++ b/docs/ResumeRequest.md @@ -3,10 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**resume** | **datetime** | {\"default\":\"(Resume immediately)\",\"description\":\"Schedules the resumption to be actioned at some future time.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**dry_run** | **bool** | {\"default\":false,\"description\":\"Changes described in the response:<br><span class=\\\"label label-default\\\">true</span> &mdash; Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.<br><span class=\\\"label label-default\\\">false</span> &mdash; Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] +**created** | **datetime** | | [optional] +**resume** | **datetime** | | [optional] +**new_subscription_start** | **datetime** | | [optional] +**new_subscription_state** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**dry_run** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ResumeSubscriptionAmendment.md b/docs/ResumeSubscriptionAmendment.md index d0059ff..2c581c7 100644 --- a/docs/ResumeSubscriptionAmendment.md +++ b/docs/ResumeSubscriptionAmendment.md @@ -3,19 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] +**new_subscription_state** | **str** | | [optional] +**new_subscription_start** | **datetime** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RevenueAttribution.md b/docs/RevenueAttribution.md deleted file mode 100644 index 7a3e6fc..0000000 --- a/docs/RevenueAttribution.md +++ /dev/null @@ -1,33 +0,0 @@ -# RevenueAttribution - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**period_start** | **datetime** | {\"description\":\"PeriodStart of the charge with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**period_end** | **datetime** | {\"description\":\"PeriodEnd of the charge with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**id** | **str** | {\"description\":\"ID of the RevenueAttribution.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**organization_id** | **str** | {\"description\":\"ID of the organization associated with the RevenueAttribution.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**invoice_id** | **str** | {\"description\":\"Consistent ID of the invoice which is expected to be consulted when paying for the billed feature described in this RevenueAttribution. That is: the top parent of that billed feature.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**invoice_version_id** | **str** | {\"description\":\"Version ID of the invoice which is expected to be consulted when paying for the billed feature described in this RevenueAttribution. That is: the top parent of that billed feature.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**aggregated_invoice_id** | **str** | {\"description\":\"ID of the invoice to which this RevenueAttribution's invoice line belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**aggregated_invoice_line_id** | **str** | {\"description\":\"ID of the invoice line whose debt this RevenueAttribution describes.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**currency** | **str** | {\"description\":\"The currency of the Invoice from which this RevenueAttribution was raised &mdash; specified by a three-character ISO 4217 currency code.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**nominal_amount** | **float** | {\"description\":\"The amount paid &mdash; through credit or otherwise &mdash; toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**actual_amount** | **float** | {\"description\":\"The amount paid &mdash; through real money &mdash; toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**pricing_component_id** | **str** | {\"description\":\"ID of the PricingComponent with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**pricing_component_name** | **str** | {\"description\":\"Name of the PricingComponent with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**product_rate_plan_id** | **str** | {\"description\":\"ID of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**product_rate_plan_name** | **str** | {\"description\":\"Internal name of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**product_rate_plan_name_public** | **str** | {\"description\":\"Public name of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**product_id** | **str** | {\"description\":\"ID of the Product with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**product_name** | **str** | {\"description\":\"Internal name of the Product with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**product_name_public** | **str** | {\"description\":\"Public name of the Product with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**aggregated_subscription_id** | **str** | {\"description\":\"ID of the Subscription with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**subscription_id** | **str** | {\"description\":\"Consistent ID of the Subscription which pays for this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**account_id** | **str** | {\"description\":\"ID of the Account with which this RevenueAttribution's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RevenueAttributionPagedMetadata.md b/docs/RevenueAttributionPagedMetadata.md deleted file mode 100644 index 769d575..0000000 --- a/docs/RevenueAttributionPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# RevenueAttributionPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[RevenueAttribution]**](RevenueAttribution.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RevenueAttributions.md b/docs/RevenueAttributions.md new file mode 100644 index 0000000..3d9f6de --- /dev/null +++ b/docs/RevenueAttributions.md @@ -0,0 +1,37 @@ +# RevenueAttributions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | +**invoice_id** | **str** | | +**invoice_version_id** | **str** | | +**child_invoice_version_id** | **str** | | +**child_invoice_line_id** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | +**nominal_amount** | **float** | | +**actual_amount** | **float** | | +**pricing_component_id** | **str** | | [optional] +**pricing_component_name** | **str** | | [optional] +**product_rate_plan_id** | **str** | | [optional] +**product_rate_plan_name** | **str** | | [optional] +**product_rate_plan_name_public** | **str** | | [optional] +**product_id** | **str** | | [optional] +**product_name** | **str** | | [optional] +**product_name_public** | **str** | | [optional] +**child_subscription_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**period_start** | **datetime** | | +**period_end** | **datetime** | | +**pricing_component_charge_type** | **str** | | [optional] +**debit_quantity** | **int** | | [optional] +**province** | **str** | | [optional] +**country** | **str** | | [optional] +**manual_charge_name** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Role.md b/docs/Role.md index cb6fe54..6930cef 100644 --- a/docs/Role.md +++ b/docs/Role.md @@ -3,19 +3,18 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**name** | **str** | { \"description\" : \"Friendly name of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] -**description** | **str** | { \"description\" : \"Friendly description of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] -**revoked** | **datetime** | { \"description\" : \"If a role is deleted it is set as revoked from this date. Any account in the role will no longer have its permissions.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] -**deleted** | **bool** | { \"default\" : \"false\", \"description\" : \"If a role is deleted any account in the role will no longer have its permissions.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] [default to False] -**default_role** | **bool** | { \"default\" : \"false\", \"description\" : \"If set this role will become the default role for the organization. Any accounts without an explicitly set role will have this applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] [default to False] -**default_returned** | **bool** | { \"default\" : \"false\", \"description\" : \"When returning the list of roles for an account, this indicates if the role was returned due to defaulting.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] [default to False] -**permissions** | [**list[BFPermission]**](BFPermission.md) | { \"description\" : \"List of permissions in this role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**revoked** | **datetime** | | [optional] +**deleted** | **bool** | | [optional] +**default_role** | **bool** | | [optional] +**default_returned** | **bool** | | [optional] +**permissions** | [**list[BFPermission]**](BFPermission.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RolePagedMetadata.md b/docs/RolePagedMetadata.md deleted file mode 100644 index d818128..0000000 --- a/docs/RolePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# RolePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Role]**](Role.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RolesApi.md b/docs/RolesApi.md deleted file mode 100644 index 3cf0b45..0000000 --- a/docs/RolesApi.md +++ /dev/null @@ -1,318 +0,0 @@ -# billforward.RolesApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_role**](RolesApi.md#create_role) | **POST** /roles | Create a new role. -[**get_all_roles**](RolesApi.md#get_all_roles) | **GET** /roles | Retrieves a collection of all roles. By default 10 values are returned. Records are returned in natural order. -[**get_role_by_id**](RolesApi.md#get_role_by_id) | **GET** /roles/{role} | Retrieves a single role, specified by the ID parameter. -[**remove_permission_from_role**](RolesApi.md#remove_permission_from_role) | **DELETE** /roles/{role}/permission/{resource}/{action} | Revokes a particular permission -[**revoke_role**](RolesApi.md#revoke_role) | **DELETE** /roles/{role} | Revokes a role -[**update_role**](RolesApi.md#update_role) | **PUT** /roles | Update a role. - - -# **create_role** -> RolePagedMetadata create_role(role_request) - -Create a new role. - -{\"nickname\":\"Create a new role\",\"request\":\"createRoleRequest.html\",\"response\":\"createRoleResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RolesApi() -role_request = billforward.BillingEntityBase() # BillingEntityBase | - -try: - # Create a new role. - api_response = api_instance.create_role(role_request) - pprint(api_response) -except ApiException as e: - print "Exception when calling RolesApi->create_role: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **role_request** | [**BillingEntityBase**](BillingEntityBase.md)| | - -### Return type - -[**RolePagedMetadata**](RolePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_roles** -> RolePagedMetadata get_all_roles(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Retrieves a collection of all roles. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve all roles\",\"response\":\"getRoleAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RolesApi() -organizations = ['organizations_example'] # list[str] | (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Retrieves a collection of all roles. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_roles(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling RolesApi->get_all_roles: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] - -### Return type - -[**RolePagedMetadata**](RolePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_role_by_id** -> RolePagedMetadata get_role_by_id(role, organizations=organizations, include_retired=include_retired) - -Retrieves a single role, specified by the ID parameter. - -{\"nickname\":\"Retrieve a role\",\"response\":\"getRoleByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RolesApi() -role = 'role_example' # str | ID or name of the role. -organizations = ['organizations_example'] # list[str] | (optional) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Retrieves a single role, specified by the ID parameter. - api_response = api_instance.get_role_by_id(role, organizations=organizations, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling RolesApi->get_role_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **role** | **str**| ID or name of the role. | - **organizations** | [**list[str]**](str.md)| | [optional] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] - -### Return type - -[**RolePagedMetadata**](RolePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **remove_permission_from_role** -> RolePagedMetadata remove_permission_from_role(role, resource, action, organizations=organizations) - -Revokes a particular permission - -{\"nickname\":\"Remove Permission from role\",\"response\":\"removePermissionFromGroup.html\",\"request\":\"removePermissionFromGroupRequest.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RolesApi() -role = 'role_example' # str | ID or name of the role. -resource = 'resource_example' # str | -action = 'action_example' # str | -organizations = ['organizations_example'] # list[str] | (optional) - -try: - # Revokes a particular permission - api_response = api_instance.remove_permission_from_role(role, resource, action, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling RolesApi->remove_permission_from_role: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **role** | **str**| ID or name of the role. | - **resource** | **str**| | - **action** | **str**| | - **organizations** | [**list[str]**](str.md)| | [optional] - -### Return type - -[**RolePagedMetadata**](RolePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **revoke_role** -> RolePagedMetadata revoke_role(role, organizations=organizations) - -Revokes a role - -{\"nickname\":\"Revoke role\",\"response\":\"revokeRole.html\",\"request\":\"revokeRoleRequest.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RolesApi() -role = 'role_example' # str | ID or name of the role. -organizations = ['organizations_example'] # list[str] | (optional) - -try: - # Revokes a role - api_response = api_instance.revoke_role(role, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling RolesApi->revoke_role: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **role** | **str**| ID or name of the role. | - **organizations** | [**list[str]**](str.md)| | [optional] - -### Return type - -[**RolePagedMetadata**](RolePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_role** -> RolePagedMetadata update_role(role_request) - -Update a role. - -{\"nickname\":\"Update a role\",\"request\":\"updateRoleRequest.html\",\"response\":\"updateRoleResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.RolesApi() -role_request = billforward.UpdateRoleRequest() # UpdateRoleRequest | - -try: - # Update a role. - api_response = api_instance.update_role(role_request) - pprint(api_response) -except ApiException as e: - print "Exception when calling RolesApi->update_role: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **role_request** | [**UpdateRoleRequest**](UpdateRoleRequest.md)| | - -### Return type - -[**RolePagedMetadata**](RolePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/RuleSatisfaction.md b/docs/RuleSatisfaction.md deleted file mode 100644 index e81da38..0000000 --- a/docs/RuleSatisfaction.md +++ /dev/null @@ -1,13 +0,0 @@ -# RuleSatisfaction - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**satisfied** | **bool** | | [optional] [default to False] -**broken_rules** | [**list[CouponRule]**](CouponRule.md) | | [optional] -**coupon_instance_being_initialised** | **bool** | | [optional] [default to False] -**new_user** | **bool** | | [optional] [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/SagePayAuthCaptureRequest.md b/docs/SagePayAuthCaptureRequest.md new file mode 100644 index 0000000..ec2acd9 --- /dev/null +++ b/docs/SagePayAuthCaptureRequest.md @@ -0,0 +1,12 @@ +# SagePayAuthCaptureRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card_token** | **str** | | +**card_type** | **str** | | [optional] +**expiry_date** | **str** | | [optional] +**last4_digits** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SagePayCardPayment.md b/docs/SagePayCardPayment.md new file mode 100644 index 0000000..c38c301 --- /dev/null +++ b/docs/SagePayCardPayment.md @@ -0,0 +1,8 @@ +# SagePayCardPayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SagePayConfiguration.md b/docs/SagePayConfiguration.md new file mode 100644 index 0000000..78d3e87 --- /dev/null +++ b/docs/SagePayConfiguration.md @@ -0,0 +1,11 @@ +# SagePayConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled_card_types** | [**list[SagePayEnabledCardType]**](SagePayEnabledCardType.md) | | [optional] +**account_type** | **str** | | [optional] +**vendor** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SagePayEnabledCardType.md b/docs/SagePayEnabledCardType.md new file mode 100644 index 0000000..7e4ae98 --- /dev/null +++ b/docs/SagePayEnabledCardType.md @@ -0,0 +1,16 @@ +# SagePayEnabledCardType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**card_type** | **str** | | +**api_configuration_id** | **str** | | +**deleted** | **bool** | | +**organization_id** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SagePayPreAuthRequest.md b/docs/SagePayPreAuthRequest.md new file mode 100644 index 0000000..b12f75f --- /dev/null +++ b/docs/SagePayPreAuthRequest.md @@ -0,0 +1,11 @@ +# SagePayPreAuthRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **str** | | [optional] +**form_profile** | **str** | | [optional] +**vpsprotocol** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SalesforceApi.md b/docs/SalesforceApi.md new file mode 100644 index 0000000..97174b0 --- /dev/null +++ b/docs/SalesforceApi.md @@ -0,0 +1,242 @@ +# billforward.SalesforceApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**change_salesforce_job_state**](SalesforceApi.md#change_salesforce_job_state) | **POST** /salesforce/sync/action | +[**connect_to_salesforce**](SalesforceApi.md#connect_to_salesforce) | **POST** /salesforce/connect | +[**get_all_salesforce_jobs**](SalesforceApi.md#get_all_salesforce_jobs) | **GET** /salesforce/sync | +[**get_salesforce_configuration**](SalesforceApi.md#get_salesforce_configuration) | **GET** /salesforce/configuration | +[**update_salesforce_configuration**](SalesforceApi.md#update_salesforce_configuration) | **PUT** /salesforce/configuration | + +# **change_salesforce_job_state** +> InlineResponseDefault58 change_salesforce_job_state(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SalesforceApi(billforward.ApiClient(configuration)) +body = billforward.SyncActionRequest() # SyncActionRequest | (optional) + +try: + api_response = api_instance.change_salesforce_job_state(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SalesforceApi->change_salesforce_job_state: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**SyncActionRequest**](SyncActionRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault58**](InlineResponseDefault58.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **connect_to_salesforce** +> InlineResponseDefault27 connect_to_salesforce(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SalesforceApi(billforward.ApiClient(configuration)) +body = billforward.CreateSalesforceConfigurationRequest() # CreateSalesforceConfigurationRequest | (optional) + +try: + api_response = api_instance.connect_to_salesforce(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SalesforceApi->connect_to_salesforce: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateSalesforceConfigurationRequest**](CreateSalesforceConfigurationRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault27**](InlineResponseDefault27.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_salesforce_jobs** +> InlineResponseDefault59 get_all_salesforce_jobs(organization_id=organization_id) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SalesforceApi(billforward.ApiClient(configuration)) +organization_id = 'organization_id_example' # str | (optional) + +try: + api_response = api_instance.get_all_salesforce_jobs(organization_id=organization_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling SalesforceApi->get_all_salesforce_jobs: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | **str**| | [optional] + +### Return type + +[**InlineResponseDefault59**](InlineResponseDefault59.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_salesforce_configuration** +> InlineResponseDefault60 get_salesforce_configuration(organization_id=organization_id) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SalesforceApi(billforward.ApiClient(configuration)) +organization_id = 'organization_id_example' # str | (optional) + +try: + api_response = api_instance.get_salesforce_configuration(organization_id=organization_id) + pprint(api_response) +except ApiException as e: + print("Exception when calling SalesforceApi->get_salesforce_configuration: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | **str**| | [optional] + +### Return type + +[**InlineResponseDefault60**](InlineResponseDefault60.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_salesforce_configuration** +> InlineResponseDefault60 update_salesforce_configuration(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SalesforceApi(billforward.ApiClient(configuration)) +body = billforward.UpdateSalesforceConfigurationRequest() # UpdateSalesforceConfigurationRequest | (optional) + +try: + api_response = api_instance.update_salesforce_configuration(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SalesforceApi->update_salesforce_configuration: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**UpdateSalesforceConfigurationRequest**](UpdateSalesforceConfigurationRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault60**](InlineResponseDefault60.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SalesforceConfigurationResponse.md b/docs/SalesforceConfigurationResponse.md new file mode 100644 index 0000000..9ef7af2 --- /dev/null +++ b/docs/SalesforceConfigurationResponse.md @@ -0,0 +1,18 @@ +# SalesforceConfigurationResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**username** | **str** | | [optional] +**access_token** | **str** | | [optional] +**authorized** | **bool** | | [optional] +**refresh_token** | **str** | | [optional] +**instance_url** | **str** | | [optional] +**user_role** | **str** | | [optional] +**notification_email_addresses** | **str** | | [optional] +**use_test_environment** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SearchApi.md b/docs/SearchApi.md deleted file mode 100644 index 112717d..0000000 --- a/docs/SearchApi.md +++ /dev/null @@ -1,68 +0,0 @@ -# billforward.SearchApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**perform_search**](SearchApi.md#perform_search) | **GET** /search/{query-string} | Returns the results of the global search specified by the query-string. - - -# **perform_search** -> SearchResultPagedMetadata perform_search(query_string, organizations=organizations, types=types, offset=offset, records=records, wildcard=wildcard, entity=entity) - -Returns the results of the global search specified by the query-string. - -{\"nickname\":\"Search an organizations data\",\"response\":\"getSearchByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SearchApi() -query_string = 'query_string_example' # str | The query string used to search. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -types = ['types_example'] # list[str] | A list of entities which will be checked when searching (optional) -offset = 0 # int | The starting index of the search results. (optional) (default to 0) -records = 10 # int | The number of search results to return. (optional) (default to 10) -wildcard = false # bool | Toggle if we search for full words or whether a wildcard is used. (optional) (default to false) -entity = false # bool | Is an entity returned with the search results. (optional) (default to false) - -try: - # Returns the results of the global search specified by the query-string. - api_response = api_instance.perform_search(query_string, organizations=organizations, types=types, offset=offset, records=records, wildcard=wildcard, entity=entity) - pprint(api_response) -except ApiException as e: - print "Exception when calling SearchApi->perform_search: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **query_string** | **str**| The query string used to search. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **types** | [**list[str]**](str.md)| A list of entities which will be checked when searching | [optional] - **offset** | **int**| The starting index of the search results. | [optional] [default to 0] - **records** | **int**| The number of search results to return. | [optional] [default to 10] - **wildcard** | **bool**| Toggle if we search for full words or whether a wildcard is used. | [optional] [default to false] - **entity** | **bool**| Is an entity returned with the search results. | [optional] [default to false] - -### Return type - -[**SearchResultPagedMetadata**](SearchResultPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/SearchResultPagedMetadata.md b/docs/SearchResultPagedMetadata.md deleted file mode 100644 index f4dc7ac..0000000 --- a/docs/SearchResultPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# SearchResultPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/SecurityApi.md b/docs/SecurityApi.md new file mode 100644 index 0000000..735714b --- /dev/null +++ b/docs/SecurityApi.md @@ -0,0 +1,1077 @@ +# billforward.SecurityApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_flexcheck_user_login**](SecurityApi.md#create_flexcheck_user_login) | **POST** /users/flexcheck | +[**create_role**](SecurityApi.md#create_role) | **POST** /roles | +[**create_user_login**](SecurityApi.md#create_user_login) | **POST** /users | +[**get_all_roles**](SecurityApi.md#get_all_roles) | **GET** /roles | +[**get_current_user**](SecurityApi.md#get_current_user) | **GET** /users/mine | +[**get_my_organizations**](SecurityApi.md#get_my_organizations) | **GET** /users/mine/organizations | +[**get_private_permanent_api_token**](SecurityApi.md#get_private_permanent_api_token) | **POST** /users/generate-permanent-api-token | +[**get_role_by_id**](SecurityApi.md#get_role_by_id) | **GET** /roles/{role} | +[**get_simple_all_users**](SecurityApi.md#get_simple_all_users) | **GET** /users | +[**get_temporary_api_tokens**](SecurityApi.md#get_temporary_api_tokens) | **GET** /users/generate-tokens | +[**get_user_by_username**](SecurityApi.md#get_user_by_username) | **GET** /users/username/{email} | +[**invite_user_login**](SecurityApi.md#invite_user_login) | **POST** /users/invite | +[**link_open_id_token_to_user**](SecurityApi.md#link_open_id_token_to_user) | **POST** /users/invite/openid | +[**refresh_permanent_api_token**](SecurityApi.md#refresh_permanent_api_token) | **POST** /users/refresh-permanent-api-token | +[**remove_permission_from_role**](SecurityApi.md#remove_permission_from_role) | **DELETE** /roles/{role}/permission/{resource}/{action} | +[**request_password_reset_code**](SecurityApi.md#request_password_reset_code) | **POST** /users/password-reset/request-reset-code | +[**revoke_role**](SecurityApi.md#revoke_role) | **DELETE** /roles/{role} | +[**update_email**](SecurityApi.md#update_email) | **PUT** /users/{email}/email | +[**update_role**](SecurityApi.md#update_role) | **PUT** /roles | +[**update_user_infos**](SecurityApi.md#update_user_infos) | **PUT** /users/{email} | +[**update_user_password**](SecurityApi.md#update_user_password) | **PUT** /users/{email}/password | +[**update_user_password_with_reset_code**](SecurityApi.md#update_user_password_with_reset_code) | **POST** /users/password-reset/password-update | + +# **create_flexcheck_user_login** +> InlineResponseDefault84 create_flexcheck_user_login(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +body = billforward.UserCreateRequest() # UserCreateRequest | (optional) + +try: + api_response = api_instance.create_flexcheck_user_login(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->create_flexcheck_user_login: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**UserCreateRequest**](UserCreateRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault84**](InlineResponseDefault84.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_role** +> InlineResponseDefault57 create_role(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +body = billforward.CreateRoleRequest() # CreateRoleRequest | (optional) + +try: + api_response = api_instance.create_role(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->create_role: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateRoleRequest**](CreateRoleRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault57**](InlineResponseDefault57.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_user_login** +> InlineResponseDefault84 create_user_login(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +body = billforward.UserCreateRequest() # UserCreateRequest | (optional) + +try: + api_response = api_instance.create_user_login(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->create_user_login: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**UserCreateRequest**](UserCreateRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault84**](InlineResponseDefault84.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_roles** +> InlineResponseDefault56 get_all_roles(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_all_roles(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->get_all_roles: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + +### Return type + +[**InlineResponseDefault56**](InlineResponseDefault56.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_current_user** +> InlineResponseDefault86 get_current_user(organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_current_user(organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->get_current_user: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault86**](InlineResponseDefault86.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_my_organizations** +> InlineResponseDefault87 get_my_organizations() + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) + +try: + api_response = api_instance.get_my_organizations() + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->get_my_organizations: %s\n" % e) +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**InlineResponseDefault87**](InlineResponseDefault87.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_private_permanent_api_token** +> OAuthToken get_private_permanent_api_token(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +body = billforward.UserPrivatePermanentTokenRequest() # UserPrivatePermanentTokenRequest | (optional) + +try: + api_response = api_instance.get_private_permanent_api_token(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->get_private_permanent_api_token: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**UserPrivatePermanentTokenRequest**](UserPrivatePermanentTokenRequest.md)| | [optional] + +### Return type + +[**OAuthToken**](OAuthToken.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_role_by_id** +> InlineResponseDefault57 get_role_by_id(role, organizations=organizations, include_retired=include_retired) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +role = 'role_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_role_by_id(role, organizations=organizations, include_retired=include_retired) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->get_role_by_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **role** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **include_retired** | **bool**| | [optional] [default to false] + +### Return type + +[**InlineResponseDefault57**](InlineResponseDefault57.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_simple_all_users** +> InlineResponseDefault85 get_simple_all_users(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: + api_response = api_instance.get_simple_all_users(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->get_simple_all_users: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + +### Return type + +[**InlineResponseDefault85**](InlineResponseDefault85.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_temporary_api_tokens** +> TokensResponse get_temporary_api_tokens() + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) + +try: + api_response = api_instance.get_temporary_api_tokens() + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->get_temporary_api_tokens: %s\n" % e) +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**TokensResponse**](TokensResponse.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_user_by_username** +> InlineResponseDefault88 get_user_by_username(email, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +email = 'email_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_user_by_username(email, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->get_user_by_username: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **email** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault88**](InlineResponseDefault88.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **invite_user_login** +> InlineResponseDefault84 invite_user_login(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +body = billforward.UserInviteRequest() # UserInviteRequest | (optional) + +try: + api_response = api_instance.invite_user_login(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->invite_user_login: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**UserInviteRequest**](UserInviteRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault84**](InlineResponseDefault84.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **link_open_id_token_to_user** +> InlineResponseDefault89 link_open_id_token_to_user(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +body = billforward.OpenIdUserLinkRequest() # OpenIdUserLinkRequest | (optional) + +try: + api_response = api_instance.link_open_id_token_to_user(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->link_open_id_token_to_user: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**OpenIdUserLinkRequest**](OpenIdUserLinkRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault89**](InlineResponseDefault89.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **refresh_permanent_api_token** +> OAuthToken refresh_permanent_api_token(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +body = billforward.UserPrivatePermanentTokenRefreshRequest() # UserPrivatePermanentTokenRefreshRequest | (optional) + +try: + api_response = api_instance.refresh_permanent_api_token(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->refresh_permanent_api_token: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**UserPrivatePermanentTokenRefreshRequest**](UserPrivatePermanentTokenRefreshRequest.md)| | [optional] + +### Return type + +[**OAuthToken**](OAuthToken.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **remove_permission_from_role** +> InlineResponseDefault57 remove_permission_from_role(role, resource, action, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +role = 'role_example' # str | +resource = 'resource_example' # str | +action = 'action_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.remove_permission_from_role(role, resource, action, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->remove_permission_from_role: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **role** | **str**| | + **resource** | **str**| | + **action** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault57**](InlineResponseDefault57.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **request_password_reset_code** +> InlineResponseDefault90 request_password_reset_code(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +body = billforward.PasswordResetCodeRequest() # PasswordResetCodeRequest | (optional) + +try: + api_response = api_instance.request_password_reset_code(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->request_password_reset_code: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**PasswordResetCodeRequest**](PasswordResetCodeRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault90**](InlineResponseDefault90.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: text/plain, application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **revoke_role** +> InlineResponseDefault57 revoke_role(role, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +role = 'role_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.revoke_role(role, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->revoke_role: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **role** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault57**](InlineResponseDefault57.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_email** +> InlineResponseDefault86 update_email(email, body=body, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +email = 'email_example' # str | +body = billforward.UpdateEmailRequest() # UpdateEmailRequest | (optional) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.update_email(email, body=body, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->update_email: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **email** | **str**| | + **body** | [**UpdateEmailRequest**](UpdateEmailRequest.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault86**](InlineResponseDefault86.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_role** +> InlineResponseDefault57 update_role(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +body = billforward.UpdateRoleRequest() # UpdateRoleRequest | (optional) + +try: + api_response = api_instance.update_role(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->update_role: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**UpdateRoleRequest**](UpdateRoleRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault57**](InlineResponseDefault57.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_user_infos** +> InlineResponseDefault91 update_user_infos(email, body=body, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +email = 'email_example' # str | +body = billforward.UpdateUserInfoRequest() # UpdateUserInfoRequest | (optional) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.update_user_infos(email, body=body, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->update_user_infos: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **email** | **str**| | + **body** | [**UpdateUserInfoRequest**](UpdateUserInfoRequest.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault91**](InlineResponseDefault91.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_user_password** +> InlineResponseDefault92 update_user_password(email, body=body, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +email = 'email_example' # str | +body = billforward.UpdatePasswordRequest() # UpdatePasswordRequest | (optional) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.update_user_password(email, body=body, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->update_user_password: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **email** | **str**| | + **body** | [**UpdatePasswordRequest**](UpdatePasswordRequest.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault92**](InlineResponseDefault92.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_user_password_with_reset_code** +> InlineResponseDefault92 update_user_password_with_reset_code(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SecurityApi(billforward.ApiClient(configuration)) +body = billforward.PasswordUpdateWithResetCodeRequest() # PasswordUpdateWithResetCodeRequest | (optional) + +try: + api_response = api_instance.update_user_password_with_reset_code(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SecurityApi->update_user_password_with_reset_code: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**PasswordUpdateWithResetCodeRequest**](PasswordUpdateWithResetCodeRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault92**](InlineResponseDefault92.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ServiceEndAmendment.md b/docs/ServiceEndAmendment.md index 3a64a96..61c47d4 100644 --- a/docs/ServiceEndAmendment.md +++ b/docs/ServiceEndAmendment.md @@ -3,19 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SetRatePlanAffiliateRequest.md b/docs/SetRatePlanAffiliateRequest.md new file mode 100644 index 0000000..57020f4 --- /dev/null +++ b/docs/SetRatePlanAffiliateRequest.md @@ -0,0 +1,16 @@ +# SetRatePlanAffiliateRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**amount** | **float** | | [optional] +**type** | **str** | | [optional] +**description** | **str** | | [optional] +**pricing_component_name** | **str** | | [optional] +**start_date** | **datetime** | | [optional] +**end_date** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PasswordResetRequest.md b/docs/SetSubscriptionAffiliateRequest.md similarity index 54% rename from docs/PasswordResetRequest.md rename to docs/SetSubscriptionAffiliateRequest.md index ebbf3af..eb757df 100644 --- a/docs/PasswordResetRequest.md +++ b/docs/SetSubscriptionAffiliateRequest.md @@ -1,10 +1,14 @@ -# PasswordResetRequest +# SetSubscriptionAffiliateRequest ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**email** | **str** | {\"description\":\"Login E-mail address of the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**description** | **str** | | [optional] +**type** | **str** | | [optional] +**amount** | **float** | | [optional] +**pricing_component_name** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SetupCharge.md b/docs/SetupCharge.md new file mode 100644 index 0000000..ee74a88 --- /dev/null +++ b/docs/SetupCharge.md @@ -0,0 +1,11 @@ +# SetupCharge + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pricing_component_id** | **str** | | +**unit_of_measure_id** | **str** | | +**pricing_component_value** | **int** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SetupPricingComponentsByChargeModel.md b/docs/SetupPricingComponentsByChargeModel.md new file mode 100644 index 0000000..941bf75 --- /dev/null +++ b/docs/SetupPricingComponentsByChargeModel.md @@ -0,0 +1,11 @@ +# SetupPricingComponentsByChargeModel + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**flat** | [**list[FlatSetupPricingComponent]**](FlatSetupPricingComponent.md) | | [optional] +**tiered** | [**list[TieredSetupPricingComponent]**](TieredSetupPricingComponent.md) | | [optional] +**volume** | [**list[TieredSetupPricingComponent]**](TieredSetupPricingComponent.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ShuttleAuthCaptureRequest.md b/docs/ShuttleAuthCaptureRequest.md new file mode 100644 index 0000000..521c48f --- /dev/null +++ b/docs/ShuttleAuthCaptureRequest.md @@ -0,0 +1,10 @@ +# ShuttleAuthCaptureRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shuttle_payment_method** | **str** | | +**shuttle_instance_id** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ShuttleConfiguration.md b/docs/ShuttleConfiguration.md new file mode 100644 index 0000000..ec7af81 --- /dev/null +++ b/docs/ShuttleConfiguration.md @@ -0,0 +1,11 @@ +# ShuttleConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hosted_payment_config** | [**HostedPaymentConfig**](HostedPaymentConfig.md) | | [optional] +**instance_key** | **str** | | [optional] +**percentage_for_other_payment_methods** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ShuttlePayment.md b/docs/ShuttlePayment.md new file mode 100644 index 0000000..93a2fad --- /dev/null +++ b/docs/ShuttlePayment.md @@ -0,0 +1,8 @@ +# ShuttlePayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ShuttlePreAuthRequest.md b/docs/ShuttlePreAuthRequest.md new file mode 100644 index 0000000..22b2981 --- /dev/null +++ b/docs/ShuttlePreAuthRequest.md @@ -0,0 +1,9 @@ +# ShuttlePreAuthRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**signature_body** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SimpleDateParam.md b/docs/SimpleDateParam.md new file mode 100644 index 0000000..f0c9391 --- /dev/null +++ b/docs/SimpleDateParam.md @@ -0,0 +1,10 @@ +# SimpleDateParam + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_date** | **datetime** | | [optional] +**original_value** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SimpleUser.md b/docs/SimpleUser.md new file mode 100644 index 0000000..d6f5847 --- /dev/null +++ b/docs/SimpleUser.md @@ -0,0 +1,13 @@ +# SimpleUser + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**id** | **str** | | [optional] +**username** | **str** | | [optional] +**email** | **str** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SingleRecalculateChargeRequest.md b/docs/SingleRecalculateChargeRequest.md new file mode 100644 index 0000000..64282c8 --- /dev/null +++ b/docs/SingleRecalculateChargeRequest.md @@ -0,0 +1,18 @@ +# SingleRecalculateChargeRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**quantity_label** | **str** | | [optional] +**amount** | **float** | | [optional] +**invoicing_type** | **str** | | [optional] +**pricing_component_value** | **int** | | [optional] +**recalculation_behaviour** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SpreedlyAuthCaptureRequest.md b/docs/SpreedlyAuthCaptureRequest.md new file mode 100644 index 0000000..7a04c93 --- /dev/null +++ b/docs/SpreedlyAuthCaptureRequest.md @@ -0,0 +1,9 @@ +# SpreedlyAuthCaptureRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card_token** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SpreedlyConfiguration.md b/docs/SpreedlyConfiguration.md new file mode 100644 index 0000000..08bad79 --- /dev/null +++ b/docs/SpreedlyConfiguration.md @@ -0,0 +1,11 @@ +# SpreedlyConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access_secret** | **str** | | [optional] +**signing_secret** | **str** | | [optional] +**api_key** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SpreedlyPreAuthRequest.md b/docs/SpreedlyPreAuthRequest.md new file mode 100644 index 0000000..6439e80 --- /dev/null +++ b/docs/SpreedlyPreAuthRequest.md @@ -0,0 +1,8 @@ +# SpreedlyPreAuthRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SquareAuthCaptureRequest.md b/docs/SquareAuthCaptureRequest.md new file mode 100644 index 0000000..702c1a3 --- /dev/null +++ b/docs/SquareAuthCaptureRequest.md @@ -0,0 +1,12 @@ +# SquareAuthCaptureRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card_nonce** | **str** | | +**buyer_verification_token** | **str** | | [optional] +**billing_address** | [**Address**](Address.md) | | [optional] +**location_id** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SquareConfiguration.md b/docs/SquareConfiguration.md new file mode 100644 index 0000000..6d7173c --- /dev/null +++ b/docs/SquareConfiguration.md @@ -0,0 +1,9 @@ +# SquareConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**square_data** | [**SquareConfigurationData**](SquareConfigurationData.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SquareConfigurationData.md b/docs/SquareConfigurationData.md new file mode 100644 index 0000000..de8ddcf --- /dev/null +++ b/docs/SquareConfigurationData.md @@ -0,0 +1,14 @@ +# SquareConfigurationData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**business_name** | **str** | | [optional] +**country** | **str** | | [optional] +**language_code** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**main_location_id** | **str** | | [optional] +**public_url** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SquareData.md b/docs/SquareData.md new file mode 100644 index 0000000..36a15e4 --- /dev/null +++ b/docs/SquareData.md @@ -0,0 +1,9 @@ +# SquareData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**location_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SquarePayment.md b/docs/SquarePayment.md new file mode 100644 index 0000000..a62caba --- /dev/null +++ b/docs/SquarePayment.md @@ -0,0 +1,8 @@ +# SquarePayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SquareSubscription.md b/docs/SquareSubscription.md new file mode 100644 index 0000000..8049d84 --- /dev/null +++ b/docs/SquareSubscription.md @@ -0,0 +1,13 @@ +# SquareSubscription + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [optional] +**organization_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**location_id** | **str** | | [optional] +**customer_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/EventData.md b/docs/StartAllSubscriptionsRequest.md similarity index 69% rename from docs/EventData.md rename to docs/StartAllSubscriptionsRequest.md index 5ade3c1..eaf676b 100644 --- a/docs/EventData.md +++ b/docs/StartAllSubscriptionsRequest.md @@ -1,11 +1,10 @@ -# EventData +# StartAllSubscriptionsRequest ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**previous_attributes** | **dict(str, object)** | | -**object** | [**StripeObject**](StripeObject.md) | | +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/StartAllSubscriptionsResponse.md b/docs/StartAllSubscriptionsResponse.md new file mode 100644 index 0000000..5efe0cc --- /dev/null +++ b/docs/StartAllSubscriptionsResponse.md @@ -0,0 +1,12 @@ +# StartAllSubscriptionsResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**subscriptions** | [**list[Subscription]**](Subscription.md) | | [optional] +**parent** | [**Subscription**](Subscription.md) | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/StartContractRequest.md b/docs/StartContractRequest.md new file mode 100644 index 0000000..f81b741 --- /dev/null +++ b/docs/StartContractRequest.md @@ -0,0 +1,11 @@ +# StartContractRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start** | **datetime** | | [optional] +**state** | **str** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/StartContractResponse.md b/docs/StartContractResponse.md new file mode 100644 index 0000000..ed3487d --- /dev/null +++ b/docs/StartContractResponse.md @@ -0,0 +1,11 @@ +# StartContractResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**subscription** | [**Subscription**](Subscription.md) | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/StripeACHCaptureRequest.md b/docs/StripeACHCaptureRequest.md new file mode 100644 index 0000000..01929f9 --- /dev/null +++ b/docs/StripeACHCaptureRequest.md @@ -0,0 +1,19 @@ +# StripeACHCaptureRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**default_payment_method** | **bool** | | [optional] +**routing_number** | **str** | | [optional] +**account_number** | **str** | | [optional] +**stripe_customer_id** | **str** | | [optional] +**holder_name** | **str** | | [optional] +**bank_account_name** | **str** | | [optional] +**account_holder_type** | **str** | | [optional] +**email_tokenization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/StripeACHPayment.md b/docs/StripeACHPayment.md new file mode 100644 index 0000000..94768ea --- /dev/null +++ b/docs/StripeACHPayment.md @@ -0,0 +1,8 @@ +# StripeACHPayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/StripeACHTokenPagedMetadata.md b/docs/StripeACHTokenPagedMetadata.md deleted file mode 100644 index 9436951..0000000 --- a/docs/StripeACHTokenPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# StripeACHTokenPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/StripeAchToken.md b/docs/StripeAchToken.md new file mode 100644 index 0000000..decdfdd --- /dev/null +++ b/docs/StripeAchToken.md @@ -0,0 +1,19 @@ +# StripeAchToken + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**account_id** | **str** | | +**organization_id** | **str** | | +**stripe_customer_id** | **str** | | +**stripe_bank_account_id** | **str** | | [optional] +**verified** | **bool** | | [optional] +**deleted** | **bool** | | +**bank_account** | [**BankAccount**](BankAccount.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/StripeAdditionalData.md b/docs/StripeAdditionalData.md new file mode 100644 index 0000000..d592b8f --- /dev/null +++ b/docs/StripeAdditionalData.md @@ -0,0 +1,10 @@ +# StripeAdditionalData + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**setup_intent_client_secret** | **str** | | [optional] +**setup_intent_status** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/StripeAuthCaptureRequest.md b/docs/StripeAuthCaptureRequest.md index 184bd8d..ff37049 100644 --- a/docs/StripeAuthCaptureRequest.md +++ b/docs/StripeAuthCaptureRequest.md @@ -3,20 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | | -**account_id** | **str** | {\"description\":\"ID of the BillForward Account with which you would like to associate the created payment method.<br>If omitted, BillForward will associate the created PaymentMethod with a newly-created Account, whose Profile details will be populated using billing information from the funding instrument.\",\"verbs\":[\"POST\"]} | [optional] -**gateway** | **str** | {\"description\":\"The gateway with which your funding instrument has been vaulted.\",\"verbs\":[\"POST\"]} | [optional] -**company_name** | **str** | {\"description\":\"The name of the company of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**email** | **str** | {\"description\":\"The email address of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**first_name** | **str** | {\"description\":\"The first name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**last_name** | **str** | {\"description\":\"The last name of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**mobile** | **str** | {\"description\":\"The mobile phone number of the customer from whose card a PaymentMethod is being produced. If provided: this metadata will be used to populate a Profile &mdash; should a BillForward Account be created by this request.\",\"verbs\":[\"POST\"]} | [optional] -**default_payment_method** | **bool** | {\"default\":false,\"description\":\"Whether the PaymentMethod produced by this request should be elected as the 'default' payment method for the concerned BillForward Account. Whichever PaymentMethod is elected as an Account's default payment method, will be consulted whenever payment is demanded of that Account (i.e. upon the execution of any of the Account's invoices).\",\"verbs\":[\"POST\"]} | [optional] [default to False] -**organization_id** | **str** | {\"description\":\"ID of the BillForward Organization within which the requested PaymentMethod should be created. If omitted, this will be auto-populated using your authentication credentials.\",\"verbs\":[\"POST\"]} | [optional] -**stripe_token** | **str** | {\"description\":\"Single-use token <a href=\\\"https://stripe.com/docs/stripe.js\\\">provided by Stripe's client-side card capture SDK</a>, in response to your capturing a card into the Stripe vault. This token will be used by BillForward to find the tokenized card within the Stripe vault &mdash; precursory to linking a BillForward PaymentMethod to that tokenized card.\",\"verbs\":[\"POST\"]} | -**card_id** | **str** | {\"description\":\"ID of the captured Card in Stripe. This can be provided as well as &mdash; or instead of &mdash; the one-use `stripeToken`, to lead BillForward to the card tokenized within the Stripe vault.\",\"verbs\":[\"POST\"]} | [optional] +**stripe_token** | **str** | | +**card_id** | **str** | | [optional] **customer_id** | **str** | | [optional] +**requires_setup_intent** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/StripeCardPayment.md b/docs/StripeCardPayment.md new file mode 100644 index 0000000..0edcc0b --- /dev/null +++ b/docs/StripeCardPayment.md @@ -0,0 +1,8 @@ +# StripeCardPayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/StripeConfiguration.md b/docs/StripeConfiguration.md new file mode 100644 index 0000000..eb92ce9 --- /dev/null +++ b/docs/StripeConfiguration.md @@ -0,0 +1,8 @@ +# StripeConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/StripePreAuthRequest.md b/docs/StripePreAuthRequest.md new file mode 100644 index 0000000..7b1bcd9 --- /dev/null +++ b/docs/StripePreAuthRequest.md @@ -0,0 +1,8 @@ +# StripePreAuthRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/StripeToken.md b/docs/StripeToken.md new file mode 100644 index 0000000..ac72f3a --- /dev/null +++ b/docs/StripeToken.md @@ -0,0 +1,18 @@ +# StripeToken + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**account_id** | **str** | | +**card_details_id** | **str** | | [optional] +**organization_id** | **str** | | +**stripe_customer_id** | **str** | | +**status** | **str** | | +**deleted** | **bool** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/StripeTokenPagedMetadata.md b/docs/StripeTokenPagedMetadata.md deleted file mode 100644 index 7825dbe..0000000 --- a/docs/StripeTokenPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# StripeTokenPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Subscription.md b/docs/Subscription.md index b3bcf72..5a658d7 100644 --- a/docs/Subscription.md +++ b/docs/Subscription.md @@ -3,47 +3,56 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**metadata** | [**DynamicMetadata**](DynamicMetadata.md) | { \"description\" : \"Add metadata.\", \"verbs\":[\"POST\"] } | [optional] -**id** | **str** | {\"description\":\"\",\"verbs\":[\"GET\"]} | -**version_id** | **str** | {\"description\":\"\",\"verbs\":[\"GET\"]} | [optional] -**crm_id** | **str** | {\"description\":\"\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**account_id** | **str** | {\"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} | -**organization_id** | **str** | {\"description\":\"Organization associated with the subscription.\",\"verbs\":[]} | -**product_id** | **str** | {\"description\":\"\",\"verbs\":[\"GET\"]} | -**product_rate_plan_id** | **str** | {\"description\":\"Identifier of the rate-plan being billed for.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**parent_id** | **str** | {\"description\":\"\",\"verbs\":[\"GET\"]} | [optional] -**name** | **str** | {\"description\":\"User definable friendly name for the subscription.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**description** | **str** | {\"description\":\"\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**type** | **str** | {\"default\":\"dependent on product\", \"description\":\"\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**state** | **str** | {\"PUT_description\":\"A <span class=\\\"label label-default\\\">Provisioned</span> subscription can be updated to either <span class=\\\"label label-default\\\">Trial</span> or <span class=\\\"label label-default\\\">AwaitingPayment</span>, this will start the subscription. Any updates to the state of a non-<span class=\\\"label label-default\\\">Provisioned</span> will be ignored. To cancel or otherwise amend a subscription please use the explict amendment calls.\", \"description\":\"A <span class=\\\"label label-default\\\">Provisioned</span> subscription will not begin until marked as <span class=\\\"label label-default\\\">Trial</span> or <span class=\\\"label label-default\\\">AwaitingPayment</span>. Trial subscriptions transition to <span class=\\\"label label-default\\\">AwaitingPayment</span> when the trial period is over. On subscription renewal the state becomes <span class=\\\"label label-default\\\">AwaitingPayment</span>. Once outstanding invoices are paid the state changes to <span class=\\\"label label-default\\\">Paid</span>. A subscription is set as either <span class=\\\"label label-default\\\">Failed</span> or left as <span class=\\\"label label-default\\\">AwaitingPayment</span>, depending on the rate-plan configuration. If a subscription is non-recurring or fixed-term and ends naturally, it will be marked as <span class=\\\"label label-default\\\">Expired</span>. If all payment attempts have failed a subscription is marked as <span class=\\\"label label-default\\\">Cancelled</span> if it has been manually ended. Once a subscription is marked as <span class=\\\"label label-default\\\">Failed</span>, <span class=\\\"label label-default\\\">Expired</span>, or <span class=\\\"label label-default\\\">Cancelled</span> no invoices other than a final invoice will be issued. Note: Updating account card details will not lead to BillForward automatically retrying payment, manual payment attempts can be made.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**current_period_start** | **datetime** | {\"description\":\"Start of the current invoice period. At the end of this period, a new new invoice will be generated\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**current_period_end** | **datetime** | {\"description\":\"End of the current period invoiced for. This can be manually updated to extend trials or delay invoice generation.\",\"verbs\":[\"PUT\",\"GET\"]} | [optional] -**contract_start** | **datetime** | {\"description\":\"start of the contracted period. This will be after a trial, if one exists\",\"verbs\":[\"GET\"]} | [optional] -**subscription_end** | **datetime** | {\"description\":\"When a subscription will end. This may be in the future if the cancellation is at the end of the current period.\",\"verbs\":[\"GET\"]} | [optional] -**current_period_end_explicit** | **datetime** | {\"description\":\"Override for the initial subscription period. Allows periods to align to a date or time regardless of purchase date/time.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**initial_period_start** | **datetime** | {\"description\":\"Start of the first successful period\",\"verbs\":[\"GET\"]} | -**successful_periods** | **int** | {\"description\":\"Number of paid-for periods billing, excluding trials, since the subscription started.\",\"verbs\":[\"GET\"]} | [optional] -**total_periods** | **int** | {\"description\":\"Total number of subscription periods.\",\"verbs\":[\"GET\"]} | [optional] -**trial_end** | **datetime** | {\"description\":\"The end time of the trial period, if one existed\",\"verbs\":[\"GET\"]} | -**dunning** | **bool** | { \"default\":\"false\", \"description\":\"Are there outstanding invoices which are currently in dunning.\",\"verbs\":[\"GET\", \"PUT\", \"POST\"]} | [optional] [default to False] -**locked** | **str** | {\"description\":\"If the subscription is locked, it will not be processed by the system\",\"verbs\":[]} | [optional] -**managed_by** | **str** | {\"description\":\"Which system is responsible for managing the subscription.\",\"verbs\":[]} | [optional] -**version_start** | **datetime** | {\"description\":\"When the current version of the subscription started.\",\"verbs\":[\"GET\"]} | -**version_end** | **datetime** | {\"description\":\"When the current version of the subscription ended, null indicates current version.\",\"verbs\":[\"GET\"]} | [optional] -**version_number** | **int** | {\"description\":\"Incremental version number of the subscription, starts at 1.\",\"verbs\":[\"GET\"]} | -**credit_enabled** | **bool** | { \"default\":\"true\", \"description\":\"Can credit-notes be used to pay outstanding invoices for this subscription.\",\"verbs\":[\"GET\", \"PUT\", \"POST\"]} | [optional] [default to False] -**aggregate_all_subscriptions_on_account** | **bool** | { \"default\":\"true\", \"description\":\"Whether the subscription will aggregate all other subscriptions on the account.\",\"verbs\":[\"GET\", \"PUT\", \"POST\"]} | [optional] [default to False] -**pricing_component_values** | [**list[PricingComponentValue]**](PricingComponentValue.md) | {\"description\":\"The quantities for each pricing component of the rate-plan. Values should be set for all pricing components of the rate-plan apart from the usage components. Usage components should be added when the usage is known, this is often after the end of the current billing cycle.\",\"verbs\":[\"GET\", \"POST\"]} | [optional] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**metadata** | **dict(str, object)** | | [optional] +**id** | **str** | | +**version_id** | **str** | | [optional] +**crm_id** | **str** | | [optional] +**account_id** | **str** | | +**organization_id** | **str** | | +**product_id** | **str** | | [optional] +**product_rate_plan_id** | **str** | | [optional] +**parent_id** | **str** | | [optional] +**name** | **str** | | +**description** | **str** | | [optional] +**type** | **str** | | [optional] +**version** | **str** | | [optional] +**state** | **str** | | +**active** | **bool** | | [optional] +**current_period_start** | **datetime** | | [optional] +**current_period_end** | **datetime** | | [optional] +**contract_start** | **datetime** | | [optional] +**subscription_end** | **datetime** | | [optional] +**current_period_end_explicit** | **datetime** | | [optional] +**initial_period_start** | **datetime** | | [optional] +**successful_periods** | **int** | | [optional] +**total_periods** | **int** | | [optional] +**total_version_periods** | **int** | | [optional] +**trial_end** | **datetime** | | [optional] +**dunning** | **bool** | | [optional] +**locked** | **str** | | [optional] +**managed_by** | **str** | | [optional] +**version_start** | **datetime** | | +**version_end** | **datetime** | | [optional] +**version_number** | **int** | | +**credit_enabled** | **bool** | | [optional] +**aggregate_all_subscriptions_on_account** | **bool** | | [optional] +**failed_payment_behaviour** | **str** | | [optional] +**pricing_component_values** | [**list[PricingComponentValue]**](PricingComponentValue.md) | | [optional] **payment_method_subscription_links** | [**list[PaymentMethodSubscriptionLink]**](PaymentMethodSubscriptionLink.md) | | [optional] -**fixed_terms** | [**list[FixedTerm]**](FixedTerm.md) | {\"description\":\"List of fixed terms that have been or are applied to the subscription\",\"verbs\":[\"GET\"]} | [optional] -**current_time** | **datetime** | {\"description\":\"The current time &mdash; from the point of view of the subscription.\",\"verbs\":[\"GET\"]} | -**time_offset** | **int** | {\"description\":\"How far in the future is the entity (in seconds) compared to the BillForward server's time.\",\"verbs\":[\"GET\"]} | [optional] +**fixed_terms** | [**list[FixedTerm]**](FixedTerm.md) | | [optional] +**contracts** | [**list[Contract]**](Contract.md) | | [optional] +**square_subscription** | [**SquareSubscription**](SquareSubscription.md) | | [optional] +**execution_info** | [**ExecutionResponse**](ExecutionResponse.md) | | [optional] +**current_time** | **datetime** | | [optional] +**time_offset** | **int** | | [optional] +**revive** | [**SubscriptionRevivePartialRequest**](SubscriptionRevivePartialRequest.md) | | [optional] **payment_terms** | **int** | | [optional] -**failed_payment_behaviour** | **str** | {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.<br><span class=\\\"label label-default\\\">CancelSubscription</span> &mdash; Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.<br><span class=\\\"label label-default\\\">None</span> &mdash; The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles &mdash; or when manual invoice remediation is common &mdash; <span class=\\\"label label-default\\\">None</span> is recommended.<br>In a heavily-automated SaaS environment, automatic cancellation via <span class=\\\"label label-default\\\">CancelSubscription</span> is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] +**purchase_order** | **str** | | [optional] +**affiliate_subscription_relationship** | [**list[AffiliateSubscriptionRelationship]**](AffiliateSubscriptionRelationship.md) | | [optional] +**fixed_term** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SubscriptionCancellation.md b/docs/SubscriptionCancellation.md new file mode 100644 index 0000000..cef78af --- /dev/null +++ b/docs/SubscriptionCancellation.md @@ -0,0 +1,25 @@ +# SubscriptionCancellation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**subscription_id** | **str** | | +**organization_id** | **str** | | +**source** | **str** | | [optional] +**service_end** | **str** | | +**revive** | [**SubscriptionRevivePartialRequest**](SubscriptionRevivePartialRequest.md) | | [optional] +**cancellation_credit** | **str** | | +**credit_note_description** | **str** | | [optional] +**pre_cancellation_state** | **str** | | [optional] +**state** | **str** | | +**cancel_children** | **bool** | | [optional] +**cancel_empty_parent** | **bool** | | [optional] +**associated_refunds** | [**list[Refund]**](Refund.md) | | [optional] +**discardable** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SubscriptionCancellationPagedMetadata.md b/docs/SubscriptionCancellationPagedMetadata.md deleted file mode 100644 index 4110cdc..0000000 --- a/docs/SubscriptionCancellationPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# SubscriptionCancellationPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/SubscriptionCharge.md b/docs/SubscriptionCharge.md index d86bfb9..c9bc3b4 100644 --- a/docs/SubscriptionCharge.md +++ b/docs/SubscriptionCharge.md @@ -3,32 +3,39 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | {\"description\":\"The ID of the charge.\",\"verbs\":[\"GET\"]} | [optional] -**crm_id** | **str** | {\"description\":\"Customer-relationship-management ID of the charge.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | [optional] -**account_id** | **str** | {\"description\":\"ID of the account owning the subscription for which the charge was generated.\",\"verbs\":[\"GET\",\"POST\"]} | [optional] -**subscription_id** | **str** | {\"description\":\"ID of the subscription for which the charge was generated.\",\"verbs\":[\"GET\",\"POST\"]} | [optional] -**subscription_version_id** | **str** | {\"description\":\"Version ID of the subscription for which the charge was generated.\",\"verbs\":[\"GET\",\"POST\"]} | [optional] -**invoice_id** | **str** | {\"description\":\"ID of the invoice to which this charge applies (if the charge targets a specific invoice).\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**name** | **str** | {\"description\":\"Friendly name given to the charge to help identify it.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} | [optional] -**description** | **str** | {\"description\":\"Description given to the charge.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} | [optional] -**amount** | **float** | {\"description\":\"Monetary amount of the charge &mdash; including any tax applied to the final amount.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**amount_excluding_tax** | **float** | {\"description\":\"Monetary amount of the charge &mdash; excluding any tax applied to the final amount.\",\"verbs\":[\"GET\"]} | [optional] -**currency** | **str** | { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } | [optional] -**period_start** | **datetime** | {\"default\":\"(Now)\",\"description\":\"The time-beginning of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**period_end** | **datetime** | {\"default\":\"(End of current period)\",\"description\":\"The time-ending of the interval to which the charge applies. This can be used to apply a charge across partial or multiple periods,to pro-rate its price.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**type** | **str** | {\"description\":\"A type describing the nature of the charge.\",\"verbs\":[\"POST\",\"GET\"]} | -**invoicing_type** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">Aggregated</span>\",\"description\":\"The strategy for how this charge will raise invoices.<br><span class=\\\"label label-default\\\">Immediate</span> &mdash; Generate straight-away an invoice containing this charge.<br><span class=\\\"label label-default\\\">Aggregated</span> &mdash; Add this charge to the next invoice which is generated naturally &mdash; i.e. the invoice raised at the current period's end.\",\"verbs\":[\"POST\",\"GET\"]} | -**state** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">Pending</span>\",\"description\":\"The current state of the charge.\",\"verbs\":[\"POST\",\"GET\",\"PUT\"]} | -**charge_type** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">Debit</span>\",\"description\":\"Whether this charge represents money given to or taken from the customer.<br><span class=\\\"label label-default\\\">Credit</span> &mdash; This is a charge for money given to the customer.<br><span class=\\\"label label-default\\\">Debit</span> &mdash; This is a charge for money taken from the customer.\",\"verbs\":[\"POST\",\"GET\"]} | -**calculation** | **str** | {\"default\":\"(Empty string)\",\"description\":\"A human-readable explanation of how the value of the charge was calculated.\",\"verbs\":[\"GET\"]} | [optional] -**remaining_credit_behaviour** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">Rollover</span>\",\"description\":\"Defines the behaviour applied to any outstanding credit resulting from the application of the charge..<br><span class=\\\"label label-default\\\">Rollover</span> &mdash; Outstanding credit is returned to the accounts credit pool.<br><span class=\\\"label label-default\\\">Discard</span> &mdash; Outstanding credit is lost.\",\"verbs\":[\"POST\",\"GET\"]} | -**trial** | **bool** | {\"default\":\"false\",\"description\":\"(Applicable only if any of [`pricingComponentName`, `pricingComponentID`] are defined)<br>Whether the charge was created for a subscription whilst in a trial period.<br><span class=\\\"label label-default\\\">false</span> &mdash; This is a non-trial charge, so funds will be sought from the customer.<br><span class=\\\"label label-default\\\">true</span> &mdash; This is a trial charge, soThe charge can be considered 'Paid' without taking any funds from the customer.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**version_id** | **str** | {\"description\":\"The version ID of the charge.\",\"verbs\":[\"GET\"]} | [optional] -**version_number** | **int** | {\"description\":\"The version number of the charge. The first version of a charge is version number 1.\",\"verbs\":[\"GET\"]} | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**subscription_version_id** | **str** | | [optional] +**invoice_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**tax_code** | **str** | | [optional] +**amount** | **float** | | [optional] +**amount_excluding_tax** | **float** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | [optional] +**period_start** | **datetime** | | [optional] +**period_end** | **datetime** | | [optional] +**type** | **str** | | +**invoicing_type** | **str** | | +**state** | **str** | | +**charge_type** | **str** | | +**calculation** | **str** | | [optional] +**remaining_credit_behaviour** | **str** | | +**trial** | **bool** | | [optional] +**version_id** | **str** | | [optional] +**version_number** | **int** | | +**linked_charge_id** | **str** | | [optional] +**percentage_of_original** | **float** | | [optional] +**original_charge_id** | **str** | | [optional] +**group_name** | **str** | | [optional] +**outer_period_start** | **datetime** | | [optional] +**crm_id** | **str** | | [optional] +**type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SubscriptionChargePagedMetadata.md b/docs/SubscriptionChargePagedMetadata.md deleted file mode 100644 index 42fee61..0000000 --- a/docs/SubscriptionChargePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# SubscriptionChargePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[SubscriptionCharge]**](SubscriptionCharge.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/SubscriptionCheckoutActionRequest.md b/docs/SubscriptionCheckoutActionRequest.md new file mode 100644 index 0000000..a7b9c0d --- /dev/null +++ b/docs/SubscriptionCheckoutActionRequest.md @@ -0,0 +1,13 @@ +# SubscriptionCheckoutActionRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**checkout** | **str** | | [optional] +**account_id** | **str** | | [optional] +**start** | **datetime** | | [optional] +**coupon_codes** | **list[str]** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SubscriptionCheckoutDefinitionDescription.md b/docs/SubscriptionCheckoutDefinitionDescription.md new file mode 100644 index 0000000..606e2ca --- /dev/null +++ b/docs/SubscriptionCheckoutDefinitionDescription.md @@ -0,0 +1,15 @@ +# SubscriptionCheckoutDefinitionDescription + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**id** | **str** | | [optional] +**plan_id** | **str** | | [optional] +**plan_name** | **str** | | [optional] +**plan_public_name** | **str** | | [optional] +**path** | **str** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SubscriptionCheckoutResponse.md b/docs/SubscriptionCheckoutResponse.md new file mode 100644 index 0000000..b432ba2 --- /dev/null +++ b/docs/SubscriptionCheckoutResponse.md @@ -0,0 +1,13 @@ +# SubscriptionCheckoutResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**quote** | [**ApiQuote**](ApiQuote.md) | | [optional] +**plan_display_name** | **str** | | [optional] +**path** | **str** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SubscriptionLTVResultPagedMetadata.md b/docs/SubscriptionLTVResultPagedMetadata.md deleted file mode 100644 index 8dea923..0000000 --- a/docs/SubscriptionLTVResultPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# SubscriptionLTVResultPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/SubscriptionPagedMetadata.md b/docs/SubscriptionPagedMetadata.md deleted file mode 100644 index 3b74202..0000000 --- a/docs/SubscriptionPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# SubscriptionPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Subscription]**](Subscription.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/SubscriptionReviveAmendment.md b/docs/SubscriptionReviveAmendment.md new file mode 100644 index 0000000..53aa053 --- /dev/null +++ b/docs/SubscriptionReviveAmendment.md @@ -0,0 +1,10 @@ +# SubscriptionReviveAmendment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**revive_children** | **bool** | | [optional] +**failed_payment_behaviour** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SubscriptionRevivePartialRequest.md b/docs/SubscriptionRevivePartialRequest.md new file mode 100644 index 0000000..5abcac4 --- /dev/null +++ b/docs/SubscriptionRevivePartialRequest.md @@ -0,0 +1,9 @@ +# SubscriptionRevivePartialRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**resume** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SubscriptionReviveRequest.md b/docs/SubscriptionReviveRequest.md new file mode 100644 index 0000000..1a5aac3 --- /dev/null +++ b/docs/SubscriptionReviveRequest.md @@ -0,0 +1,14 @@ +# SubscriptionReviveRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**state** | **str** | | [optional] +**start** | **datetime** | | [optional] +**failed_payment_behaviour** | **str** | | [optional] +**revive_children** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SubscriptionsApi.md b/docs/SubscriptionsApi.md index cfd5969..c49937b 100644 --- a/docs/SubscriptionsApi.md +++ b/docs/SubscriptionsApi.md @@ -1,103 +1,104 @@ # billforward.SubscriptionsApi -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**add_charge_to_subscription**](SubscriptionsApi.md#add_charge_to_subscription) | **POST** /subscriptions/{subscription-ID}/charge | Creates a charge on the specified subscription. -[**add_coupon_to_subscription**](SubscriptionsApi.md#add_coupon_to_subscription) | **POST** /subscriptions/{subscription-ID}/coupons | Applies a coupon to a subscription. -[**add_credit_note_to_subscription**](SubscriptionsApi.md#add_credit_note_to_subscription) | **POST** /subscriptions/{subscription-ID}/credit | Creates a credit-note which may be used by only the specified subscription. -[**add_payment_method_to_subscription**](SubscriptionsApi.md#add_payment_method_to_subscription) | **POST** /subscriptions/{subscription-ID}/payment-methods | Enables the payment method to pay invoices of this subscription. -[**advance_subscription**](SubscriptionsApi.md#advance_subscription) | **POST** /subscriptions/{subscription-ID}/advance | Advance the subscription through time. -[**available_payment_methods_for_subscription**](SubscriptionsApi.md#available_payment_methods_for_subscription) | **GET** /subscriptions/{subscription-ID}/payment-methods | Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order. -[**batch_create_subscriptions**](SubscriptionsApi.md#batch_create_subscriptions) | **POST** /subscriptions/batch | Create multiple subscriptions. -[**cancel_subscription**](SubscriptionsApi.md#cancel_subscription) | **POST** /subscriptions/{subscription-ID}/cancel | Retires the subscription specified by the subscription-ID parameter. Retiring a subscription causes it to cancel based on the specified retirement settings for the product. -[**create_aggregating_subscription**](SubscriptionsApi.md#create_aggregating_subscription) | **POST** /subscriptions/aggregating | Create an aggregating subscription. -[**create_subscription**](SubscriptionsApi.md#create_subscription) | **POST** /subscriptions | Create a new subscription. -[**create_subscription_v2**](SubscriptionsApi.md#create_subscription_v2) | **POST** /subscriptions/create | Create a subscription (V2). -[**create_timer**](SubscriptionsApi.md#create_timer) | **POST** /subscriptions/{subscription-ID}/timer | Create a timer for a subscription event. -[**delete_metadata_for_subscription**](SubscriptionsApi.md#delete_metadata_for_subscription) | **DELETE** /subscriptions/{subscription-ID}/metadata | Remove any associated metadata. -[**freeze_subscription**](SubscriptionsApi.md#freeze_subscription) | **POST** /subscriptions/{subscription-ID}/freeze | Freeze the subscription. -[**get_all_subscriptions**](SubscriptionsApi.md#get_all_subscriptions) | **GET** /subscriptions | Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order. -[**get_applicable_coupons_for_subscription**](SubscriptionsApi.md#get_applicable_coupons_for_subscription) | **GET** /subscriptions/{subscription-ID}/applicable-coupons | Retrieves a collection of the coupons which can be applied to this subscription. -[**get_available_credit_subscription**](SubscriptionsApi.md#get_available_credit_subscription) | **GET** /subscriptions/{subscription-ID}/credit | Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order. -[**get_charges_on_subscription**](SubscriptionsApi.md#get_charges_on_subscription) | **GET** /subscriptions/{subscription-ID}/charges | Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order. -[**get_children_of_subscription**](SubscriptionsApi.md#get_children_of_subscription) | **GET** /subscriptions/{subscription-ID}/children | Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order. -[**get_coupons_on_subscription**](SubscriptionsApi.md#get_coupons_on_subscription) | **GET** /subscriptions/{subscription-ID}/coupons | Retrieves a collection of the coupons and the unique codes currently applied to the subscription. -[**get_invoices_for_subscription_by_state**](SubscriptionsApi.md#get_invoices_for_subscription_by_state) | **GET** /subscriptions/{subscriptionID}/invoices/{state} | Retrieves a collection of invoice objects of the specified state for the given subscription. By default 10 values are returned. Records are returned in natural order. -[**get_metadata_for_subscription**](SubscriptionsApi.md#get_metadata_for_subscription) | **GET** /subscriptions/{subscription-ID}/metadata | Retrieve any associated metadata. -[**get_parent_subscription**](SubscriptionsApi.md#get_parent_subscription) | **GET** /subscriptions/{subscription-ID}/parent | Return the parent of the given subscription. -[**get_pricing_component_values_of_subscription**](SubscriptionsApi.md#get_pricing_component_values_of_subscription) | **GET** /subscriptions/{subscription-ID}/values | Gets the subscription's current pricing-component values. -[**get_subscription_by_account_id**](SubscriptionsApi.md#get_subscription_by_account_id) | **GET** /subscriptions/account/{account-ID} | Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_subscription_by_id**](SubscriptionsApi.md#get_subscription_by_id) | **GET** /subscriptions/{subscription-ID} | Retrieves a single subscription, specified by the ID parameter. -[**get_subscription_by_product_id**](SubscriptionsApi.md#get_subscription_by_product_id) | **GET** /subscriptions/product/{product-ID} | Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_subscription_by_product_rate_plan_id**](SubscriptionsApi.md#get_subscription_by_product_rate_plan_id) | **GET** /subscriptions/product-rate-plan/{product-rate-plan-ID} | Retrieves a collection of subscriptions, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_subscription_by_state**](SubscriptionsApi.md#get_subscription_by_state) | **GET** /subscriptions/state/{state} | Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -[**get_subscription_by_version_id**](SubscriptionsApi.md#get_subscription_by_version_id) | **GET** /subscriptions/version/{version-ID} | Retrieves a single subscription, specified by the version-ID parameter. -[**get_subscriptions_by_initial_period_start**](SubscriptionsApi.md#get_subscriptions_by_initial_period_start) | **GET** /subscriptions/initial-period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**get_subscriptions_by_period_end**](SubscriptionsApi.md#get_subscriptions_by_period_end) | **GET** /subscriptions/period-end/{lower-threshold}/{upper-threshold} | Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**get_subscriptions_by_period_start**](SubscriptionsApi.md#get_subscriptions_by_period_start) | **GET** /subscriptions/period-start/{lower-threshold}/{upper-threshold} | Retrieves a collection of subscription objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -[**get_subscriptions_by_successful_periods**](SubscriptionsApi.md#get_subscriptions_by_successful_periods) | **GET** /subscriptions/successful-periods/{lower-threshold}/{upper-threshold} | Retrieves a collection of subscription objects whose successful periods count falls within the range specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. +[**add_charge_to_subscription**](SubscriptionsApi.md#add_charge_to_subscription) | **POST** /subscriptions/{subscription-ID}/charge | +[**add_coupon_to_subscription**](SubscriptionsApi.md#add_coupon_to_subscription) | **POST** /subscriptions/{subscription-ID}/coupons | +[**add_credit_note_to_subscription**](SubscriptionsApi.md#add_credit_note_to_subscription) | **POST** /subscriptions/{subscription-ID}/credit | +[**add_payment_method_to_subscription**](SubscriptionsApi.md#add_payment_method_to_subscription) | **POST** /subscriptions/{subscription-ID}/payment-methods | +[**advance_subscription**](SubscriptionsApi.md#advance_subscription) | **POST** /subscriptions/{subscription-ID}/advance | +[**available_payment_methods_for_subscription**](SubscriptionsApi.md#available_payment_methods_for_subscription) | **GET** /subscriptions/{subscription-ID}/payment-methods | +[**batch_create_subscriptions**](SubscriptionsApi.md#batch_create_subscriptions) | **POST** /subscriptions/batch | +[**batch_increment_usage**](SubscriptionsApi.md#batch_increment_usage) | **POST** /subscriptions/{subscriptionID}/increment-values | +[**cancel_subscription**](SubscriptionsApi.md#cancel_subscription) | **POST** /subscriptions/{subscription-ID}/cancel | +[**create_aggregating_subscription**](SubscriptionsApi.md#create_aggregating_subscription) | **POST** /subscriptions/aggregating | +[**create_subscription_from_request**](SubscriptionsApi.md#create_subscription_from_request) | **POST** /subscriptions/create | +[**create_timer**](SubscriptionsApi.md#create_timer) | **POST** /subscriptions/{subscription-ID}/timer | +[**delete_metadata_for_subscription**](SubscriptionsApi.md#delete_metadata_for_subscription) | **DELETE** /subscriptions/{subscription-ID}/metadata | +[**freeze_subscription**](SubscriptionsApi.md#freeze_subscription) | **POST** /subscriptions/{subscription-ID}/freeze | +[**get_affiliate1**](SubscriptionsApi.md#get_affiliate1) | **GET** /subscriptions/{subscriptionID}/affiliate | +[**get_applicable_coupons_for_subscription**](SubscriptionsApi.md#get_applicable_coupons_for_subscription) | **GET** /subscriptions/{subscription-ID}/applicable-coupons | +[**get_available_credit_subscription**](SubscriptionsApi.md#get_available_credit_subscription) | **GET** /subscriptions/{subscription-ID}/credit | +[**get_charges_on_subscription**](SubscriptionsApi.md#get_charges_on_subscription) | **GET** /subscriptions/{subscription-ID}/charges | +[**get_children_of_subscription**](SubscriptionsApi.md#get_children_of_subscription) | **GET** /subscriptions/{subscription-ID}/children | +[**get_coupons_on_subscription**](SubscriptionsApi.md#get_coupons_on_subscription) | **GET** /subscriptions/{subscription-ID}/coupons | +[**get_invoices_for_subscription_by_state**](SubscriptionsApi.md#get_invoices_for_subscription_by_state) | **GET** /subscriptions/{subscriptionID}/invoices/{state} | +[**get_metadata_for_subscription**](SubscriptionsApi.md#get_metadata_for_subscription) | **GET** /subscriptions/{subscription-ID}/metadata | +[**get_parent_subscription**](SubscriptionsApi.md#get_parent_subscription) | **GET** /subscriptions/{subscription-ID}/parent | +[**get_pricing_component_values_of_subscription**](SubscriptionsApi.md#get_pricing_component_values_of_subscription) | **GET** /subscriptions/{subscription-ID}/values | +[**get_subscription_by_account_id**](SubscriptionsApi.md#get_subscription_by_account_id) | **GET** /subscriptions/account/{account-ID} | +[**get_subscription_by_id**](SubscriptionsApi.md#get_subscription_by_id) | **GET** /subscriptions/{subscription-ID} | +[**get_subscription_by_product_id**](SubscriptionsApi.md#get_subscription_by_product_id) | **GET** /subscriptions/product/{product-ID} | +[**get_subscription_by_product_rate_plan_id**](SubscriptionsApi.md#get_subscription_by_product_rate_plan_id) | **GET** /subscriptions/product-rate-plan/{product-rate-plan-ID} | +[**get_subscription_by_state**](SubscriptionsApi.md#get_subscription_by_state) | **GET** /subscriptions/state/{state} | +[**get_subscription_by_version_id**](SubscriptionsApi.md#get_subscription_by_version_id) | **GET** /subscriptions/version/{version-ID} | +[**get_subscriptions_by_initial_period_start**](SubscriptionsApi.md#get_subscriptions_by_initial_period_start) | **GET** /subscriptions/initial-period-start/{lower-threshold}/{upper-threshold} | +[**get_subscriptions_by_period_end**](SubscriptionsApi.md#get_subscriptions_by_period_end) | **GET** /subscriptions/period-end/{lower-threshold}/{upper-threshold} | +[**get_subscriptions_by_period_start**](SubscriptionsApi.md#get_subscriptions_by_period_start) | **GET** /subscriptions/period-start/{lower-threshold}/{upper-threshold} | +[**get_subscriptions_by_successful_periods**](SubscriptionsApi.md#get_subscriptions_by_successful_periods) | **GET** /subscriptions/successful-periods/{lower-threshold}/{upper-threshold} | [**get_swagger_subscription**](SubscriptionsApi.md#get_swagger_subscription) | **GET** /subscriptions/swagger-end-point/{query-string} | -[**get_timers_for_subscription**](SubscriptionsApi.md#get_timers_for_subscription) | **GET** /subscriptions/{subscription-ID}/timer | Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order. -[**import_subscription**](SubscriptionsApi.md#import_subscription) | **POST** /subscriptions/import | Import a subscription. -[**invoice_charges_on_subscription**](SubscriptionsApi.md#invoice_charges_on_subscription) | **POST** /subscriptions/{subscription-ID}/invoice-charges | Invoice any outstanding charges for the subscription. -[**migrate_subscription**](SubscriptionsApi.md#migrate_subscription) | **POST** /subscriptions/{subscription-ID}/migrate | Migrate the subscription to a new plan. -[**remove_coupon_from_subscription**](SubscriptionsApi.md#remove_coupon_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/coupons/{coupon-code} | Removes the coupon from the subscription. -[**remove_credit_from_subscription**](SubscriptionsApi.md#remove_credit_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/credit/{value} | Decrease the amount of credit available to the specified subscription. -[**remove_payment_method_from_subscription**](SubscriptionsApi.md#remove_payment_method_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/payment-methods/{payment-method-ID} | Removes the specified payment method for the given subscription. -[**remove_pricing_component_value_change_from_subscription**](SubscriptionsApi.md#remove_pricing_component_value_change_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/values/{pricing-component} | Discards from the subscription any scheduled changes in the value of the specified pricing-component. -[**resume_subscription**](SubscriptionsApi.md#resume_subscription) | **POST** /subscriptions/{subscription-ID}/resume | Resume the frozen subscription. -[**revive_subscription**](SubscriptionsApi.md#revive_subscription) | **POST** /subscriptions/{subscription-ID}/revive | Revives a cancelled subscription and returns it to its previous state -[**set_metadata_for_subscription**](SubscriptionsApi.md#set_metadata_for_subscription) | **POST** /subscriptions/{subscription-ID}/metadata | Remove any existing metadata keys and create the provided data. -[**set_pricing_component_value_on_subscription**](SubscriptionsApi.md#set_pricing_component_value_on_subscription) | **POST** /subscriptions/{subscription-ID}/pricing-component-values | Sets upon this subscription a new value for the specified pricing-component without performing an upgrade. -[**set_pricing_component_value_on_subscription_v2**](SubscriptionsApi.md#set_pricing_component_value_on_subscription_v2) | **POST** /subscriptions/{subscription-ID}/values/{pricing-component} | Upgrades/downgrades this subscription to some new value for the specified pricing-component. -[**update_subscription**](SubscriptionsApi.md#update_subscription) | **PUT** /subscriptions | Update a subscription. -[**update_subscription_v2**](SubscriptionsApi.md#update_subscription_v2) | **PUT** /subscriptions/update | Update a subscription (V2). -[**upsert_metadata_for_subscription**](SubscriptionsApi.md#upsert_metadata_for_subscription) | **PUT** /subscriptions/{subscription-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed. - +[**get_timers_for_subscription**](SubscriptionsApi.md#get_timers_for_subscription) | **GET** /subscriptions/{subscription-ID}/timer | +[**import_subscription**](SubscriptionsApi.md#import_subscription) | **POST** /subscriptions/import | +[**invoice_charges_on_subscription**](SubscriptionsApi.md#invoice_charges_on_subscription) | **POST** /subscriptions/{subscription-ID}/invoice-charges | +[**migrate_subscription**](SubscriptionsApi.md#migrate_subscription) | **POST** /subscriptions/{subscription-ID}/migrate | +[**pause_subscription**](SubscriptionsApi.md#pause_subscription) | **POST** /subscriptions/{subscription-ID}/pause | +[**remove_coupon_from_subscription**](SubscriptionsApi.md#remove_coupon_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/coupons/{coupon-code} | +[**remove_credit_from_subscription**](SubscriptionsApi.md#remove_credit_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/credit/{value} | +[**remove_payment_method_from_subscription**](SubscriptionsApi.md#remove_payment_method_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/payment-methods/{payment-method-ID} | +[**remove_pricing_component_value_change_from_subscription**](SubscriptionsApi.md#remove_pricing_component_value_change_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/values/{pricing-component} | +[**resume_subscription**](SubscriptionsApi.md#resume_subscription) | **POST** /subscriptions/{subscription-ID}/resume | +[**revive_subscription**](SubscriptionsApi.md#revive_subscription) | **POST** /subscriptions/{subscription-ID}/revive | +[**set_affiliate1**](SubscriptionsApi.md#set_affiliate1) | **POST** /subscriptions/{subscriptionID}/affiliate | +[**set_metadata_for_subscription**](SubscriptionsApi.md#set_metadata_for_subscription) | **POST** /subscriptions/{subscription-ID}/metadata | +[**set_pricing_component_value_on_subscription**](SubscriptionsApi.md#set_pricing_component_value_on_subscription) | **POST** /subscriptions/{subscription-ID}/pricing-component-values | +[**set_pricing_component_value_on_subscription1**](SubscriptionsApi.md#set_pricing_component_value_on_subscription1) | **POST** /subscriptions/{subscription-ID}/values/{pricing-component} | +[**set_pricing_component_value_on_subscription_batch_update**](SubscriptionsApi.md#set_pricing_component_value_on_subscription_batch_update) | **POST** /subscriptions/{subscription-ID}/values | +[**start_all_subscriptions**](SubscriptionsApi.md#start_all_subscriptions) | **POST** /subscriptions/{accountID}/start | +[**update_subscription_from_request**](SubscriptionsApi.md#update_subscription_from_request) | **PUT** /subscriptions/update | +[**upsert_metadata_for_subscription**](SubscriptionsApi.md#upsert_metadata_for_subscription) | **PUT** /subscriptions/{subscription-ID}/metadata | # **add_charge_to_subscription** -> SubscriptionChargePagedMetadata add_charge_to_subscription(subscription_id, charge) +> InlineResponseDefault28 add_charge_to_subscription(subscription_id, body=body) -Creates a charge on the specified subscription. -{\"nickname\":\"Add Charge\",\"response\":\"addChargeToSubscriptionRequest.html\",\"response\":\"addChargeToSubscription.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. -charge = billforward.AddChargeRequest() # AddChargeRequest | The charge request +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +body = billforward.AddChargeRequest() # AddChargeRequest | (optional) -try: - # Creates a charge on the specified subscription. - api_response = api_instance.add_charge_to_subscription(subscription_id, charge) +try: + api_response = api_instance.add_charge_to_subscription(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->add_charge_to_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->add_charge_to_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | - **charge** | [**AddChargeRequest**](AddChargeRequest.md)| The charge request | + **subscription_id** | **str**| | + **body** | [**AddChargeRequest**](AddChargeRequest.md)| | [optional] ### Return type -[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md) +[**InlineResponseDefault28**](InlineResponseDefault28.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -107,30 +108,29 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **add_coupon_to_subscription** -> CouponPagedMetadata add_coupon_to_subscription(subscription_id, request) +> InlineResponseDefault23 add_coupon_to_subscription(subscription_id, body=body) -Applies a coupon to a subscription. -{\"nickname\":\"Apply coupon\", \"request\":\"addCouponCodeRequest.html\",\"response\":\"addCouponCodeResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -request = billforward.AddCouponCodeRequest() # AddCouponCodeRequest | Request containing the coupon code. +body = billforward.AddCouponCodeRequest() # AddCouponCodeRequest | (optional) -try: - # Applies a coupon to a subscription. - api_response = api_instance.add_coupon_to_subscription(subscription_id, request) +try: + api_response = api_instance.add_coupon_to_subscription(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->add_coupon_to_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->add_coupon_to_subscription: %s\n" % e) ``` ### Parameters @@ -138,15 +138,15 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **request** | [**AddCouponCodeRequest**](AddCouponCodeRequest.md)| Request containing the coupon code. | + **body** | [**AddCouponCodeRequest**](AddCouponCodeRequest.md)| | [optional] ### Return type -[**CouponPagedMetadata**](CouponPagedMetadata.md) +[**InlineResponseDefault23**](InlineResponseDefault23.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -156,46 +156,45 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **add_credit_note_to_subscription** -> CreditNotePagedMetadata add_credit_note_to_subscription(subscription_id, credit_note) +> InlineResponseDefault4 add_credit_note_to_subscription(subscription_id, body=body) -Creates a credit-note which may be used by only the specified subscription. -{\"nickname\":\"Add Credit\",\"request\":\"addCreditNoteToSubscriptionRequest.html\", \"response\":\"addCreditNoteToSubscription.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. -credit_note = billforward.CreditSubscriptionRequest() # CreditSubscriptionRequest | The credit-note request +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +body = billforward.CreditSubscriptionRequest() # CreditSubscriptionRequest | (optional) -try: - # Creates a credit-note which may be used by only the specified subscription. - api_response = api_instance.add_credit_note_to_subscription(subscription_id, credit_note) +try: + api_response = api_instance.add_credit_note_to_subscription(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->add_credit_note_to_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->add_credit_note_to_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | - **credit_note** | [**CreditSubscriptionRequest**](CreditSubscriptionRequest.md)| The credit-note request | + **subscription_id** | **str**| | + **body** | [**CreditSubscriptionRequest**](CreditSubscriptionRequest.md)| | [optional] ### Return type -[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md) +[**InlineResponseDefault4**](InlineResponseDefault4.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -205,30 +204,29 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **add_payment_method_to_subscription** -> PaymentMethodPagedMetadata add_payment_method_to_subscription(subscription_id, payment_method) +> InlineResponseDefault40 add_payment_method_to_subscription(subscription_id, body=body) -Enables the payment method to pay invoices of this subscription. -{\"nickname\":\"Add payment-method to subscription\",\"response\":\"addPaymentMethod.html\",\"request\":\"addPaymentMethod.request.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -payment_method = billforward.AddPaymentMethodRequest() # AddPaymentMethodRequest | +body = billforward.AddPaymentMethodRequest() # AddPaymentMethodRequest | (optional) -try: - # Enables the payment method to pay invoices of this subscription. - api_response = api_instance.add_payment_method_to_subscription(subscription_id, payment_method) +try: + api_response = api_instance.add_payment_method_to_subscription(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->add_payment_method_to_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->add_payment_method_to_subscription: %s\n" % e) ``` ### Parameters @@ -236,15 +234,15 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **payment_method** | [**AddPaymentMethodRequest**](AddPaymentMethodRequest.md)| | + **body** | [**AddPaymentMethodRequest**](AddPaymentMethodRequest.md)| | [optional] ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +[**InlineResponseDefault40**](InlineResponseDefault40.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -254,46 +252,45 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **advance_subscription** -> TimeResponsePagedMetadata advance_subscription(subscription_id, request) +> InlineResponseDefault61 advance_subscription(subscription_id, body=body) -Advance the subscription through time. -{\"nickname\":\"Advance\",\"request\":\"advanceSubscriptionRequest.html\",\"response\":\"advanceSubscription.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. -request = billforward.TimeRequest() # TimeRequest | The request +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +body = billforward.TimeRequest() # TimeRequest | (optional) -try: - # Advance the subscription through time. - api_response = api_instance.advance_subscription(subscription_id, request) +try: + api_response = api_instance.advance_subscription(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->advance_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->advance_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | - **request** | [**TimeRequest**](TimeRequest.md)| The request | + **subscription_id** | **str**| | + **body** | [**TimeRequest**](TimeRequest.md)| | [optional] ### Return type -[**TimeResponsePagedMetadata**](TimeResponsePagedMetadata.md) +[**InlineResponseDefault61**](InlineResponseDefault61.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -303,34 +300,33 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **available_payment_methods_for_subscription** -> PaymentMethodPagedMetadata available_payment_methods_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) +> InlineResponseDefault9 available_payment_methods_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) -Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order. -{ \"nickname\" : \"List on subscription\",\"response\" : \"getAvailablePaymentMethods.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order. +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) + +try: api_response = api_instance.available_payment_methods_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->available_payment_methods_for_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->available_payment_methods_for_subscription: %s\n" % e) ``` ### Parameters @@ -338,66 +334,65 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +[**InlineResponseDefault9**](InlineResponseDefault9.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **batch_create_subscriptions** -> SubscriptionPagedMetadata batch_create_subscriptions(request) +> InlineResponseDefault26 batch_create_subscriptions(body=body) -Create multiple subscriptions. -{\"nickname\":\"Create multiple subscriptions\",\"response\":\"createMultipleSubscriptionViaHelper.html\",\"request\":\"createMultipleSubscriptionViaHelper.request.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -request = billforward.CreateSubscriptionBatchRequest() # CreateSubscriptionBatchRequest | +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +body = billforward.CreateSubscriptionBatchRequest() # CreateSubscriptionBatchRequest | (optional) -try: - # Create multiple subscriptions. - api_response = api_instance.batch_create_subscriptions(request) +try: + api_response = api_instance.batch_create_subscriptions(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->batch_create_subscriptions: %s\n" % e + print("Exception when calling SubscriptionsApi->batch_create_subscriptions: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **request** | [**CreateSubscriptionBatchRequest**](CreateSubscriptionBatchRequest.md)| | + **body** | [**CreateSubscriptionBatchRequest**](CreateSubscriptionBatchRequest.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault26**](InlineResponseDefault26.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -406,31 +401,30 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **cancel_subscription** -> SubscriptionCancellationPagedMetadata cancel_subscription(subscription_id, subscription_cancellation) +# **batch_increment_usage** +> InlineResponseDefault62 batch_increment_usage(subscription_id, body=body) -Retires the subscription specified by the subscription-ID parameter. Retiring a subscription causes it to cancel based on the specified retirement settings for the product. -{\"nickname\":\"Cancel subscription\",\"response\":\"deleteSubscription.html\",\"request\":\"deleteSubscriptionRequest.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -subscription_cancellation = billforward.CancelSubscriptionRequest() # CancelSubscriptionRequest | The cancellation request +body = billforward.BatchIncrementValuesRequest() # BatchIncrementValuesRequest | (optional) -try: - # Retires the subscription specified by the subscription-ID parameter. Retiring a subscription causes it to cancel based on the specified retirement settings for the product. - api_response = api_instance.cancel_subscription(subscription_id, subscription_cancellation) +try: + api_response = api_instance.batch_increment_usage(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->cancel_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->batch_increment_usage: %s\n" % e) ``` ### Parameters @@ -438,15 +432,15 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **subscription_cancellation** | [**CancelSubscriptionRequest**](CancelSubscriptionRequest.md)| The cancellation request | + **body** | [**BatchIncrementValuesRequest**](BatchIncrementValuesRequest.md)| | [optional] ### Return type -[**SubscriptionCancellationPagedMetadata**](SubscriptionCancellationPagedMetadata.md) +[**InlineResponseDefault62**](InlineResponseDefault62.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -455,45 +449,46 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_aggregating_subscription** -> SubscriptionPagedMetadata create_aggregating_subscription(request) +# **cancel_subscription** +> InlineResponseDefault63 cancel_subscription(subscription_id, body=body) -Create an aggregating subscription. -{\"nickname\":\"Create aggregating subscription\",\"response\":\"createAggregatingSubscription.html\",\"request\":\"createAggregatingSubscription.request.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -request = billforward.CreateAggregatingSubscriptionRequest() # CreateAggregatingSubscriptionRequest | +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +body = billforward.SubscriptionCancellation() # SubscriptionCancellation | (optional) -try: - # Create an aggregating subscription. - api_response = api_instance.create_aggregating_subscription(request) +try: + api_response = api_instance.cancel_subscription(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->create_aggregating_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->cancel_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **request** | [**CreateAggregatingSubscriptionRequest**](CreateAggregatingSubscriptionRequest.md)| | + **subscription_id** | **str**| | + **body** | [**SubscriptionCancellation**](SubscriptionCancellation.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault63**](InlineResponseDefault63.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -502,92 +497,90 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_subscription** -> SubscriptionPagedMetadata create_subscription(subscription) +# **create_aggregating_subscription** +> InlineResponseDefault51 create_aggregating_subscription(body=body) -Create a new subscription. -{\"nickname\":\"Create a new subscription\",\"request\":\"createSubscriptionRequest.html\",\"response\":\"createSubscriptionResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription = billforward.Subscription() # Subscription | The subscription object to be updated. +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +body = billforward.CreateAggregatingSubscriptionRequest() # CreateAggregatingSubscriptionRequest | (optional) -try: - # Create a new subscription. - api_response = api_instance.create_subscription(subscription) +try: + api_response = api_instance.create_aggregating_subscription(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->create_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->create_aggregating_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription** | [**Subscription**](Subscription.md)| The subscription object to be updated. | + **body** | [**CreateAggregatingSubscriptionRequest**](CreateAggregatingSubscriptionRequest.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault51**](InlineResponseDefault51.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_subscription_v2** -> SubscriptionPagedMetadata create_subscription_v2(request) +# **create_subscription_from_request** +> InlineResponseDefault51 create_subscription_from_request(body=body) -Create a subscription (V2). -{\"nickname\":\"Create a subscription (V2)\",\"response\":\"createSubscriptionViaHelper.html\",\"request\":\"createSubscriptionViaHelper.request.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -request = billforward.CreateSubscriptionRequest() # CreateSubscriptionRequest | +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +body = billforward.CreateSubscriptionRequest() # CreateSubscriptionRequest | (optional) -try: - # Create a subscription (V2). - api_response = api_instance.create_subscription_v2(request) +try: + api_response = api_instance.create_subscription_from_request(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->create_subscription_v2: %s\n" % e + print("Exception when calling SubscriptionsApi->create_subscription_from_request: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **request** | [**CreateSubscriptionRequest**](CreateSubscriptionRequest.md)| | + **body** | [**CreateSubscriptionRequest**](CreateSubscriptionRequest.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault51**](InlineResponseDefault51.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -597,30 +590,29 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_timer** -> TimerAmendment create_timer(subscription_id, request) +> InlineResponseDefault65 create_timer(subscription_id, body=body) -Create a timer for a subscription event. -{\"nickname\":\"Create Timer\",\"response\":\"createSubscriptionTimer.html\",\"request\":\"createSubscriptionTimer.request.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -request = billforward.BillingEntityBase() # BillingEntityBase | +body = billforward.CreateSubscriptionTimerRequest() # CreateSubscriptionTimerRequest | (optional) -try: - # Create a timer for a subscription event. - api_response = api_instance.create_timer(subscription_id, request) +try: + api_response = api_instance.create_timer(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->create_timer: %s\n" % e + print("Exception when calling SubscriptionsApi->create_timer: %s\n" % e) ``` ### Parameters @@ -628,15 +620,15 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **request** | [**BillingEntityBase**](BillingEntityBase.md)| | + **body** | [**CreateSubscriptionTimerRequest**](CreateSubscriptionTimerRequest.md)| | [optional] ### Return type -[**TimerAmendment**](TimerAmendment.md) +[**InlineResponseDefault65**](InlineResponseDefault65.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -646,30 +638,29 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **delete_metadata_for_subscription** -> DynamicMetadata delete_metadata_for_subscription(subscription_id, organizations=organizations) +> InlineResponseDefault7 delete_metadata_for_subscription(subscription_id, organizations=organizations) -Remove any associated metadata. -{\"nickname\":\"Clear from subscription\",\"request\" :\"deleteSubscriptionMetadataRequest.html\",\"response\":\"deleteSubscriptionMetadataResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Remove any associated metadata. +try: api_response = api_instance.delete_metadata_for_subscription(subscription_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->delete_metadata_for_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->delete_metadata_for_subscription: %s\n" % e) ``` ### Parameters @@ -677,64 +668,63 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**DynamicMetadata**](DynamicMetadata.md) +[**InlineResponseDefault7**](InlineResponseDefault7.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **freeze_subscription** -> SubscriptionPagedMetadata freeze_subscription(subscription_id, request) +> InlineResponseDefault51 freeze_subscription(subscription_id, body=body) -Freeze the subscription. -{\"nickname\":\"Freeze\",\"request\":\"freezeSubscriptionRequest.html\",\"response\":\"freezeSubscription.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. -request = billforward.PauseRequest() # PauseRequest | The request +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +body = billforward.PauseRequest() # PauseRequest | (optional) -try: - # Freeze the subscription. - api_response = api_instance.freeze_subscription(subscription_id, request) +try: + api_response = api_instance.freeze_subscription(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->freeze_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->freeze_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | - **request** | [**PauseRequest**](PauseRequest.md)| The request | + **subscription_id** | **str**| | + **body** | [**PauseRequest**](PauseRequest.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault51**](InlineResponseDefault51.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -743,160 +733,141 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_subscriptions** -> SubscriptionPagedMetadata get_all_subscriptions(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children, metadata=metadata, exclude_service_ended=exclude_service_ended, account_id=account_id) +# **get_affiliate1** +> InlineResponseDefault66 get_affiliate1(subscription_id, organizations=organizations) -Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve all subscriptions\",\"response\":\"getSubscriptionAll.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) -exclude_children = true # bool | Should child subscriptiosn be excluded. (optional) (default to true) -metadata = 'metadata_example' # str | (optional) -exclude_service_ended = true # bool | (optional) -account_id = ['account_id_example'] # list[str] | A list of accountIDs to filter subscriptions on (optional) - -try: - # Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_subscriptions(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children, metadata=metadata, exclude_service_ended=exclude_service_ended, account_id=account_id) +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_affiliate1(subscription_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_all_subscriptions: %s\n" % e + print("Exception when calling SubscriptionsApi->get_affiliate1: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] - **exclude_children** | **bool**| Should child subscriptiosn be excluded. | [optional] [default to true] - **metadata** | **str**| | [optional] - **exclude_service_ended** | **bool**| | [optional] - **account_id** | [**list[str]**](str.md)| A list of accountIDs to filter subscriptions on | [optional] + **subscription_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault66**](InlineResponseDefault66.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_applicable_coupons_for_subscription** -> CouponPagedMetadata get_applicable_coupons_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault22 get_applicable_coupons_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a collection of the coupons which can be applied to this subscription. -{ \"nickname\" : \"Retrieve applicable coupons\",\"response\" : \"getApplicableCoupons.html\" } -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Retrieves a collection of the coupons which can be applied to this subscription. +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_applicable_coupons_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_applicable_coupons_for_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->get_applicable_coupons_for_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **subscription_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**CouponPagedMetadata**](CouponPagedMetadata.md) +[**InlineResponseDefault22**](InlineResponseDefault22.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_available_credit_subscription** -> CreditNotePagedMetadata get_available_credit_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault3 get_available_credit_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Get available credit\",\"response\":\"getAvailableCreditSubscription.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order. +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_available_credit_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_available_credit_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->get_available_credit_subscription: %s\n" % e) ``` ### Parameters @@ -904,60 +875,59 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md) +[**InlineResponseDefault3**](InlineResponseDefault3.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_charges_on_subscription** -> SubscriptionChargePagedMetadata get_charges_on_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, state=state, type=type, include_retired=include_retired) +> InlineResponseDefault10 get_charges_on_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, state=state, type=type, include_retired=include_retired) -Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Get charges\",\"response\":\"getChargesSubscription.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -state = 'state_example' # str | Ihe direction of any ordering, either ASC or DESC. (optional) -type = 'type_example' # str | Ihe direction of any ordering, either ASC or DESC. (optional) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order. +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +state = 'state_example' # str | (optional) +type = 'type_example' # str | (optional) +include_retired = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_charges_on_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, state=state, type=type, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_charges_on_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->get_charges_on_subscription: %s\n" % e) ``` ### Parameters @@ -965,60 +935,59 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **state** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] - **type** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **state** | **str**| | [optional] + **type** | **str**| | [optional] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**SubscriptionChargePagedMetadata**](SubscriptionChargePagedMetadata.md) +[**InlineResponseDefault10**](InlineResponseDefault10.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_children_of_subscription** -> SubscriptionPagedMetadata get_children_of_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault26 get_children_of_subscription(subscription_id, exclude_service_ended=exclude_service_ended, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) -Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Get Aggregated Entities\",\"response\":\"getAggregatedEntities.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_children_of_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +exclude_service_ended = false # bool | (optional) (default to false) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: + api_response = api_instance.get_children_of_subscription(subscription_id, exclude_service_ended=exclude_service_ended, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_children_of_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->get_children_of_subscription: %s\n" % e) ``` ### Parameters @@ -1026,171 +995,168 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **exclude_service_ended** | **bool**| | [optional] [default to false] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault26**](InlineResponseDefault26.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_coupons_on_subscription** -> CouponPagedMetadata get_coupons_on_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault22 get_coupons_on_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Retrieves a collection of the coupons and the unique codes currently applied to the subscription. -{\"nickname\":\"Retrieve coupons\",\"response\":\"getCoupons.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) - -try: - # Retrieves a collection of the coupons and the unique codes currently applied to the subscription. +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_coupons_on_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_coupons_on_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->get_coupons_on_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **subscription_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**CouponPagedMetadata**](CouponPagedMetadata.md) +[**InlineResponseDefault22**](InlineResponseDefault22.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_invoices_for_subscription_by_state** -> InvoicePagedMetadata get_invoices_for_subscription_by_state(subscription_id, state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) +> InlineResponseDefault8 get_invoices_for_subscription_by_state(subscription_id, state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) -Retrieves a collection of invoice objects of the specified state for the given subscription. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve invoices by state for subscription\",\"response\":\"getInvoicesForSubscriptionByState.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription_id = 'subscription_id_example' # str | The unique id of the subscription. -state = 'state_example' # str | The state of the invoices to retrieve. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Retrieves a collection of invoice objects of the specified state for the given subscription. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +state = 'state_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: api_response = api_instance.get_invoices_for_subscription_by_state(subscription_id, state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_invoices_for_subscription_by_state: %s\n" % e + print("Exception when calling SubscriptionsApi->get_invoices_for_subscription_by_state: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| The unique id of the subscription. | - **state** | **str**| The state of the invoices to retrieve. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] + **subscription_id** | **str**| | + **state** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault8**](InlineResponseDefault8.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_metadata_for_subscription** -> DynamicMetadata get_metadata_for_subscription(subscription_id, organizations=organizations) +> InlineResponseDefault7 get_metadata_for_subscription(subscription_id, organizations=organizations) -Retrieve any associated metadata. -{\"nickname\":\"Retrieve on subscription\",\"request\":\"getSubscriptionMetadataRequest.html\",\"response\":\"getSubscriptionMetadataResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Retrieve any associated metadata. +try: api_response = api_instance.get_metadata_for_subscription(subscription_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_metadata_for_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->get_metadata_for_subscription: %s\n" % e) ``` ### Parameters @@ -1198,48 +1164,47 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**DynamicMetadata**](DynamicMetadata.md) +[**InlineResponseDefault7**](InlineResponseDefault7.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_parent_subscription** -> SubscriptionPagedMetadata get_parent_subscription(subscription_id, organizations=organizations) +> InlineResponseDefault26 get_parent_subscription(subscription_id, organizations=organizations) -Return the parent of the given subscription. -{\"nickname\":\"Get parent\",\"response\":\"getParentSubscription.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Return the parent of the given subscription. +try: api_response = api_instance.get_parent_subscription(subscription_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_parent_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->get_parent_subscription: %s\n" % e) ``` ### Parameters @@ -1247,101 +1212,101 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault26**](InlineResponseDefault26.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_pricing_component_values_of_subscription** -> PricingComponentValuePagedMetadata get_pricing_component_values_of_subscription(subscription_id) +> InlineResponseDefault68 get_pricing_component_values_of_subscription(subscription_id, organizations=organizations) -Gets the subscription's current pricing-component values. -{\"nickname\":\"Get values\",\"response\":\"getPricingComponentValues.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Gets the subscription's current pricing-component values. - api_response = api_instance.get_pricing_component_values_of_subscription(subscription_id) +try: + api_response = api_instance.get_pricing_component_values_of_subscription(subscription_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_pricing_component_values_of_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->get_pricing_component_values_of_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | + **subscription_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**PricingComponentValuePagedMetadata**](PricingComponentValuePagedMetadata.md) +[**InlineResponseDefault68**](InlineResponseDefault68.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_subscription_by_account_id** -> SubscriptionPagedMetadata get_subscription_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) +> InlineResponseDefault26 get_subscription_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) -Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by account\",\"response\":\"getSubscriptionByAccount.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) account_id = 'account_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) -exclude_children = true # bool | Should child subscriptiosn be excluded. (optional) (default to true) - -try: - # Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) +exclude_children = true # bool | (optional) (default to true) + +try: api_response = api_instance.get_subscription_by_account_id(account_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_subscription_by_account_id: %s\n" % e + print("Exception when calling SubscriptionsApi->get_subscription_by_account_id: %s\n" % e) ``` ### Parameters @@ -1349,55 +1314,54 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] - **exclude_children** | **bool**| Should child subscriptiosn be excluded. | [optional] [default to true] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + **exclude_children** | **bool**| | [optional] [default to true] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault26**](InlineResponseDefault26.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_subscription_by_id** -> SubscriptionPagedMetadata get_subscription_by_id(subscription_id, organizations=organizations, include_retired=include_retired) +> InlineResponseDefault51 get_subscription_by_id(subscription_id, organizations=organizations, include_retired=include_retired) -Retrieves a single subscription, specified by the ID parameter. -{\"nickname\":\"Retrieve an existing subscription\",\"response\":\"getSubscriptionByID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) +organizations = ['organizations_example'] # list[str] | (optional) +include_retired = false # bool | (optional) (default to false) -try: - # Retrieves a single subscription, specified by the ID parameter. +try: api_response = api_instance.get_subscription_by_id(subscription_id, organizations=organizations, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_subscription_by_id: %s\n" % e + print("Exception when calling SubscriptionsApi->get_subscription_by_id: %s\n" % e) ``` ### Parameters @@ -1405,116 +1369,114 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] + **organizations** | [**list[str]**](str.md)| | [optional] + **include_retired** | **bool**| | [optional] [default to false] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault51**](InlineResponseDefault51.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_subscription_by_product_id** -> SubscriptionPagedMetadata get_subscription_by_product_id(product_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) +> InlineResponseDefault26 get_subscription_by_product_id(product_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) -Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by product\",\"response\":\"getSubscriptionByProduct.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -product_id = 'product_id_example' # str | ID of the product -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) -exclude_children = true # bool | Should child subscriptiosn be excluded. (optional) (default to true) - -try: - # Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +product_id = 'product_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) +exclude_children = true # bool | (optional) (default to true) + +try: api_response = api_instance.get_subscription_by_product_id(product_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_subscription_by_product_id: %s\n" % e + print("Exception when calling SubscriptionsApi->get_subscription_by_product_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **product_id** | **str**| ID of the product | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] - **exclude_children** | **bool**| Should child subscriptiosn be excluded. | [optional] [default to true] + **product_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + **exclude_children** | **bool**| | [optional] [default to true] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault26**](InlineResponseDefault26.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_subscription_by_product_rate_plan_id** -> SubscriptionPagedMetadata get_subscription_by_product_rate_plan_id(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) +> InlineResponseDefault26 get_subscription_by_product_rate_plan_id(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) -Retrieves a collection of subscriptions, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by rate-plan\",\"response\":\"getSubscriptionByProductRatePlan.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) product_rate_plan_id = 'product_rate_plan_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) -exclude_children = true # bool | Should child subscriptiosn be excluded. (optional) (default to true) - -try: - # Retrieves a collection of subscriptions, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) +exclude_children = true # bool | (optional) (default to true) + +try: api_response = api_instance.get_subscription_by_product_rate_plan_id(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_subscription_by_product_rate_plan_id: %s\n" % e + print("Exception when calling SubscriptionsApi->get_subscription_by_product_rate_plan_id: %s\n" % e) ``` ### Parameters @@ -1522,466 +1484,458 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **product_rate_plan_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] - **exclude_children** | **bool**| Should child subscriptiosn be excluded. | [optional] [default to true] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + **exclude_children** | **bool**| | [optional] [default to true] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault26**](InlineResponseDefault26.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_subscription_by_state** -> SubscriptionPagedMetadata get_subscription_by_state(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) +> InlineResponseDefault26 get_subscription_by_state(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) -Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by state\",\"response\":\"getSubscriptionByState.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -state = 'state_example' # str | The current state of the subscription, either Provisioned, AwaitingPayment, Paid or Cancelled -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'id' # str | Specify a field used to order the result set. (optional) (default to id) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired subscriptions should be returned. (optional) (default to false) -exclude_children = true # bool | Should child subscriptiosn be excluded. (optional) (default to true) - -try: - # Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +state = 'state_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'id' # str | (optional) (default to id) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) +exclude_children = true # bool | (optional) (default to true) + +try: api_response = api_instance.get_subscription_by_state(state, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, exclude_children=exclude_children) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_subscription_by_state: %s\n" % e + print("Exception when calling SubscriptionsApi->get_subscription_by_state: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **state** | **str**| The current state of the subscription, either Provisioned, AwaitingPayment, Paid or Cancelled | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to id] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired subscriptions should be returned. | [optional] [default to false] - **exclude_children** | **bool**| Should child subscriptiosn be excluded. | [optional] [default to true] + **state** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to id] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + **exclude_children** | **bool**| | [optional] [default to true] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault26**](InlineResponseDefault26.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_subscription_by_version_id** -> SubscriptionPagedMetadata get_subscription_by_version_id(version_id, organizations=organizations) +> InlineResponseDefault51 get_subscription_by_version_id(version_id, organizations=organizations) -Retrieves a single subscription, specified by the version-ID parameter. -{\"nickname\":\"Retrieve by version\",\"response\":\"getSubscriptionByVersionID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -version_id = 'version_id_example' # str | The version-ID of the subscription. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +version_id = 'version_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Retrieves a single subscription, specified by the version-ID parameter. +try: api_response = api_instance.get_subscription_by_version_id(version_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_subscription_by_version_id: %s\n" % e + print("Exception when calling SubscriptionsApi->get_subscription_by_version_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **version_id** | **str**| The version-ID of the subscription. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **version_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault51**](InlineResponseDefault51.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_subscriptions_by_initial_period_start** -> SubscriptionPagedMetadata get_subscriptions_by_initial_period_start(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) +> InlineResponseDefault26 get_subscriptions_by_initial_period_start(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) -Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by initial period-start\",\"response\":\"getSubscriptionByInitialPeriodStart.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +lower_threshold = billforward.SimpleDateParam() # SimpleDateParam | +upper_threshold = billforward.SimpleDateParam() # SimpleDateParam | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: api_response = api_instance.get_subscriptions_by_initial_period_start(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_subscriptions_by_initial_period_start: %s\n" % e + print("Exception when calling SubscriptionsApi->get_subscriptions_by_initial_period_start: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] + **lower_threshold** | [**SimpleDateParam**](.md)| | + **upper_threshold** | [**SimpleDateParam**](.md)| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault26**](InlineResponseDefault26.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_subscriptions_by_period_end** -> SubscriptionPagedMetadata get_subscriptions_by_period_end(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) +> InlineResponseDefault26 get_subscriptions_by_period_end(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) -Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by period-end\",\"response\":\"getSubscriptionByPeriodEnd.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +lower_threshold = billforward.SimpleDateParam() # SimpleDateParam | +upper_threshold = billforward.SimpleDateParam() # SimpleDateParam | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: api_response = api_instance.get_subscriptions_by_period_end(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_subscriptions_by_period_end: %s\n" % e + print("Exception when calling SubscriptionsApi->get_subscriptions_by_period_end: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] + **lower_threshold** | [**SimpleDateParam**](.md)| | + **upper_threshold** | [**SimpleDateParam**](.md)| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault26**](InlineResponseDefault26.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_subscriptions_by_period_start** -> SubscriptionPagedMetadata get_subscriptions_by_period_start(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) +> InlineResponseDefault26 get_subscriptions_by_period_start(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) -Retrieves a collection of subscription objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by period-start\",\"response\":\"getSubscriptionByPeriodStart.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -lower_threshold = 'lower_threshold_example' # str | The UTC DateTime specifying the start of the result period. -upper_threshold = 'upper_threshold_example' # str | The UTC DateTime specifying the end of the result period. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Retrieves a collection of subscription objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +lower_threshold = billforward.SimpleDateParam() # SimpleDateParam | +upper_threshold = billforward.SimpleDateParam() # SimpleDateParam | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: api_response = api_instance.get_subscriptions_by_period_start(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_subscriptions_by_period_start: %s\n" % e + print("Exception when calling SubscriptionsApi->get_subscriptions_by_period_start: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **lower_threshold** | **str**| The UTC DateTime specifying the start of the result period. | - **upper_threshold** | **str**| The UTC DateTime specifying the end of the result period. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] + **lower_threshold** | [**SimpleDateParam**](.md)| | + **upper_threshold** | [**SimpleDateParam**](.md)| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault26**](InlineResponseDefault26.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_subscriptions_by_successful_periods** -> SubscriptionPagedMetadata get_subscriptions_by_successful_periods(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) +> InlineResponseDefault26 get_subscriptions_by_successful_periods(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) -Retrieves a collection of subscription objects whose successful periods count falls within the range specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Retrieve by successful period\",\"response\":\"getSubscriptionBySuccessfulPeriods.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -lower_threshold = 56 # int | The lower threshold of the range -upper_threshold = 56 # int | The upper threshold of the range. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Retrieves a collection of subscription objects whose successful periods count falls within the range specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +lower_threshold = 56 # int | +upper_threshold = 56 # int | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) + +try: api_response = api_instance.get_subscriptions_by_successful_periods(lower_threshold, upper_threshold, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_subscriptions_by_successful_periods: %s\n" % e + print("Exception when calling SubscriptionsApi->get_subscriptions_by_successful_periods: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **lower_threshold** | **int**| The lower threshold of the range | - **upper_threshold** | **int**| The upper threshold of the range. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] + **lower_threshold** | **int**| | + **upper_threshold** | **int**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault26**](InlineResponseDefault26.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_swagger_subscription** -> SwaggerTypeListSubs get_swagger_subscription(query_string, organizations=organizations, offset=offset, records=records, format=format, wildcard=wildcard, entity=entity) - +> InlineResponseDefault69 get_swagger_subscription(query_string, organizations=organizations, offset=offset, records=records, format=format, wildcard=wildcard, entity=entity) -{ \"nickname\" : \"\",\"response\" : \"\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -query_string = 'query_string_example' # str | The query string used to search. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The starting index of the search results. (optional) (default to 0) -records = 10 # int | The number of search results to return. (optional) (default to 10) -format = 'JSON' # str | The response format, either JSON or XML. (optional) (default to JSON) -wildcard = false # bool | Toggle if we search for full words or whether a wildcard is used. (optional) (default to false) -entity = false # bool | Is an entity returned with the search results. (optional) (default to false) - -try: - # +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +query_string = 'query_string_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +format = 'JSON' # str | (optional) (default to JSON) +wildcard = true # bool | (optional) (default to true) +entity = false # bool | (optional) (default to false) + +try: api_response = api_instance.get_swagger_subscription(query_string, organizations=organizations, offset=offset, records=records, format=format, wildcard=wildcard, entity=entity) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_swagger_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->get_swagger_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **query_string** | **str**| The query string used to search. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The starting index of the search results. | [optional] [default to 0] - **records** | **int**| The number of search results to return. | [optional] [default to 10] - **format** | **str**| The response format, either JSON or XML. | [optional] [default to JSON] - **wildcard** | **bool**| Toggle if we search for full words or whether a wildcard is used. | [optional] [default to false] - **entity** | **bool**| Is an entity returned with the search results. | [optional] [default to false] + **query_string** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **format** | **str**| | [optional] [default to JSON] + **wildcard** | **bool**| | [optional] [default to true] + **entity** | **bool**| | [optional] [default to false] ### Return type -[**SwaggerTypeListSubs**](SwaggerTypeListSubs.md) +[**InlineResponseDefault69**](InlineResponseDefault69.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_timers_for_subscription** -> TimerAmendment get_timers_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, state=state, event=event) +> InlineResponseDefault64 get_timers_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, state=state, event=event) -Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Get Timers\",\"response\":\"getTimersforSubscription.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first subscription to return. (optional) (default to 0) -records = 10 # int | The maximum number of subscriptions to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired timers should be returned. (optional) (default to false) -state = 'state_example' # str | The state of the timer amendment (optional) -event = 'event_example' # str | The type of timer event (optional) - -try: - # Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order. +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) +state = 'state_example' # str | (optional) +event = 'event_example' # str | (optional) + +try: api_response = api_instance.get_timers_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired, state=state, event=event) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->get_timers_for_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->get_timers_for_subscription: %s\n" % e) ``` ### Parameters @@ -1989,69 +1943,68 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first subscription to return. | [optional] [default to 0] - **records** | **int**| The maximum number of subscriptions to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired timers should be returned. | [optional] [default to false] - **state** | **str**| The state of the timer amendment | [optional] - **event** | **str**| The type of timer event | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + **state** | **str**| | [optional] + **event** | **str**| | [optional] ### Return type -[**TimerAmendment**](TimerAmendment.md) +[**InlineResponseDefault64**](InlineResponseDefault64.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **import_subscription** -> SubscriptionPagedMetadata import_subscription(request) +> InlineResponseDefault51 import_subscription(body=body) -Import a subscription. -{\"nickname\":\"Import\",\"request\":\"importSubscriptionRequest.html\",\"response\":\"importSubscription.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -request = billforward.BillingEntityBase() # BillingEntityBase | The request +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +body = billforward.ImportSubscriptionRequest() # ImportSubscriptionRequest | (optional) -try: - # Import a subscription. - api_response = api_instance.import_subscription(request) +try: + api_response = api_instance.import_subscription(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->import_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->import_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **request** | [**BillingEntityBase**](BillingEntityBase.md)| The request | + **body** | [**ImportSubscriptionRequest**](ImportSubscriptionRequest.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault51**](InlineResponseDefault51.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2061,46 +2014,45 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **invoice_charges_on_subscription** -> InvoicePagedMetadata invoice_charges_on_subscription(subscription_id, charge) +> InlineResponseDefault29 invoice_charges_on_subscription(subscription_id, body=body) -Invoice any outstanding charges for the subscription. -{\"nickname\":\"Invoice Charges\",\"request\":\"invoiceChargesRequest.html\",\"response\":\"invoiceCharges.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. -charge = billforward.InvoiceChargeRequest() # InvoiceChargeRequest | The charge request +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +body = billforward.InvoiceChargeRequest() # InvoiceChargeRequest | (optional) -try: - # Invoice any outstanding charges for the subscription. - api_response = api_instance.invoice_charges_on_subscription(subscription_id, charge) +try: + api_response = api_instance.invoice_charges_on_subscription(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->invoice_charges_on_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->invoice_charges_on_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | - **charge** | [**InvoiceChargeRequest**](InvoiceChargeRequest.md)| The charge request | + **subscription_id** | **str**| | + **body** | [**InvoiceChargeRequest**](InvoiceChargeRequest.md)| | [optional] ### Return type -[**InvoicePagedMetadata**](InvoicePagedMetadata.md) +[**InlineResponseDefault29**](InlineResponseDefault29.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2110,46 +2062,93 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **migrate_subscription** -> SubscriptionPagedMetadata migrate_subscription(subscription_id, request) +> InlineResponseDefault70 migrate_subscription(subscription_id, body=body) -Migrate the subscription to a new plan. -{\"nickname\":\"Migrate\",\"request\":\"migrateSubscriptionRequest.html\", \"response\":\"migrateSubscription.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. -request = billforward.MigrationRequest() # MigrationRequest | The migration request +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +body = billforward.MigrationRequest() # MigrationRequest | (optional) -try: - # Migrate the subscription to a new plan. - api_response = api_instance.migrate_subscription(subscription_id, request) +try: + api_response = api_instance.migrate_subscription(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->migrate_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->migrate_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | - **request** | [**MigrationRequest**](MigrationRequest.md)| The migration request | + **subscription_id** | **str**| | + **body** | [**MigrationRequest**](MigrationRequest.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault70**](InlineResponseDefault70.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pause_subscription** +> InlineResponseDefault51 pause_subscription(subscription_id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +body = billforward.PauseRequest() # PauseRequest | (optional) + +try: + api_response = api_instance.pause_subscription(subscription_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SubscriptionsApi->pause_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **subscription_id** | **str**| | + **body** | [**PauseRequest**](PauseRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault51**](InlineResponseDefault51.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2159,31 +2158,30 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **remove_coupon_from_subscription** -> CouponPagedMetadata remove_coupon_from_subscription(subscription_id, coupon_code, organizations=organizations) +> InlineResponseDefault23 remove_coupon_from_subscription(subscription_id, coupon_code, organizations=organizations) -Removes the coupon from the subscription. -{\"nickname\":\"Remove coupon\",\"response\":\"removeCouponResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | coupon_code = 'coupon_code_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Removes the coupon from the subscription. +try: api_response = api_instance.remove_coupon_from_subscription(subscription_id, coupon_code, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->remove_coupon_from_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->remove_coupon_from_subscription: %s\n" % e) ``` ### Parameters @@ -2192,49 +2190,48 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | **coupon_code** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**CouponPagedMetadata**](CouponPagedMetadata.md) +[**InlineResponseDefault23**](InlineResponseDefault23.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **remove_credit_from_subscription** -> CreditNotePagedMetadata remove_credit_from_subscription(subscription_id, value, organizations=organizations) +> InlineResponseDefault3 remove_credit_from_subscription(subscription_id, value, organizations=organizations) -Decrease the amount of credit available to the specified subscription. -{\"nickname\":\"Remove Credit\",\"response\":\"removeCreditForSubscription.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -value = 'value_example' # str |

Either a credit note ID or a currency value.

If a credit note ID is provided any remaining credit will be removed.

If a decimal is provided this value will be removed from any credit available to the subscription. For example if the subscription is in USD setting the value as 10 will reduce credit by $10 (USD), setting 9.86 would reduce the credit by $9.86 (USD). The value will be reduced from any credit available.

-organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +value = 'value_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Decrease the amount of credit available to the specified subscription. +try: api_response = api_instance.remove_credit_from_subscription(subscription_id, value, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->remove_credit_from_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->remove_credit_from_subscription: %s\n" % e) ``` ### Parameters @@ -2242,50 +2239,49 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **value** | **str**| <p>Either a credit note ID or a currency value.</p><p>If a credit note ID is provided any remaining credit will be removed.</p><p>If a decimal is provided this value will be removed from any credit available to the subscription. For example if the subscription is in USD setting the value as 10 will reduce credit by $10 (USD), setting 9.86 would reduce the credit by $9.86 (USD). The value will be reduced from any credit available.</p> | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **value** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md) +[**InlineResponseDefault3**](InlineResponseDefault3.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **remove_payment_method_from_subscription** -> PaymentMethodPagedMetadata remove_payment_method_from_subscription(subscription_id, payment_method_id, organizations=organizations) +> InlineResponseDefault51 remove_payment_method_from_subscription(subscription_id, payment_method_id, organizations=organizations) -Removes the specified payment method for the given subscription. -{\"nickname\":\"Remove payment-method\",\"response\":\"removePaymentMethod.html\",\"request\":\"removePaymentMethod.request.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | payment_method_id = 'payment_method_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Removes the specified payment method for the given subscription. +try: api_response = api_instance.remove_payment_method_from_subscription(subscription_id, payment_method_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->remove_payment_method_from_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->remove_payment_method_from_subscription: %s\n" % e) ``` ### Parameters @@ -2294,49 +2290,48 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | **payment_method_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +[**InlineResponseDefault51**](InlineResponseDefault51.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **remove_pricing_component_value_change_from_subscription** -> PaymentMethodPagedMetadata remove_pricing_component_value_change_from_subscription(subscription_id, pricing_component, organizations=organizations) +> InlineResponseDefault68 remove_pricing_component_value_change_from_subscription(subscription_id, pricing_component, organizations=organizations) -Discards from the subscription any scheduled changes in the value of the specified pricing-component. -{\"nickname\":\"Discard value changes\",\"response\":\"removePricingComponentValueChange.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | pricing_component = 'pricing_component_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Discards from the subscription any scheduled changes in the value of the specified pricing-component. +try: api_response = api_instance.remove_pricing_component_value_change_from_subscription(subscription_id, pricing_component, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->remove_pricing_component_value_change_from_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->remove_pricing_component_value_change_from_subscription: %s\n" % e) ``` ### Parameters @@ -2345,64 +2340,63 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | **pricing_component** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +[**InlineResponseDefault68**](InlineResponseDefault68.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain, application/json + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **resume_subscription** -> SubscriptionPagedMetadata resume_subscription(subscription_id, request) +> InlineResponseDefault51 resume_subscription(subscription_id, body=body) -Resume the frozen subscription. -{\"nickname\":\"Resume\",\"request\":\"resumeSubscriptionRequest.html\",\"response\":\"resumeSubscription.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. -request = billforward.ResumeRequest() # ResumeRequest | The request +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +body = billforward.ResumeRequest() # ResumeRequest | (optional) -try: - # Resume the frozen subscription. - api_response = api_instance.resume_subscription(subscription_id, request) +try: + api_response = api_instance.resume_subscription(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->resume_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->resume_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | - **request** | [**ResumeRequest**](ResumeRequest.md)| The request | + **subscription_id** | **str**| | + **body** | [**ResumeRequest**](ResumeRequest.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault51**](InlineResponseDefault51.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2412,30 +2406,77 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **revive_subscription** -> SubscriptionPagedMetadata revive_subscription(subscription_id, request) +> InlineResponseDefault26 revive_subscription(subscription_id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +body = billforward.SubscriptionReviveRequest() # SubscriptionReviveRequest | (optional) + +try: + api_response = api_instance.revive_subscription(subscription_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SubscriptionsApi->revive_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **subscription_id** | **str**| | + **body** | [**SubscriptionReviveRequest**](SubscriptionReviveRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault26**](InlineResponseDefault26.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_affiliate1** +> InlineResponseDefault67 set_affiliate1(subscription_id, body=body) -Revives a cancelled subscription and returns it to its previous state -{\"nickname\":\"Revive subscription\",\"request\":\"reviveSubscriptionRequest.html\", \"response\":\"reviveSubscription.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -request = billforward.ReviveSubscriptionRequest() # ReviveSubscriptionRequest | The revive request +body = billforward.SetSubscriptionAffiliateRequest() # SetSubscriptionAffiliateRequest | (optional) -try: - # Revives a cancelled subscription and returns it to its previous state - api_response = api_instance.revive_subscription(subscription_id, request) +try: + api_response = api_instance.set_affiliate1(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->revive_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->set_affiliate1: %s\n" % e) ``` ### Parameters @@ -2443,15 +2484,15 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **request** | [**ReviveSubscriptionRequest**](ReviveSubscriptionRequest.md)| The revive request | + **body** | [**SetSubscriptionAffiliateRequest**](SetSubscriptionAffiliateRequest.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault67**](InlineResponseDefault67.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2461,48 +2502,47 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **set_metadata_for_subscription** -> DynamicMetadata set_metadata_for_subscription(metadata, subscription_id, organizations=organizations) +> InlineResponseDefault7 set_metadata_for_subscription(subscription_id, body=body, organizations=organizations) -Remove any existing metadata keys and create the provided data. -{\"nickname\":\"Set on subscription\",\"request\":\"setSubscriptionMetadataRequest.html\",\"response\":\"setSubscriptionMetadataResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -metadata = billforward.DynamicMetadata() # DynamicMetadata | +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +body = 'body_example' # str | (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Remove any existing metadata keys and create the provided data. - api_response = api_instance.set_metadata_for_subscription(metadata, subscription_id, organizations=organizations) +try: + api_response = api_instance.set_metadata_for_subscription(subscription_id, body=body, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->set_metadata_for_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->set_metadata_for_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **metadata** | [**DynamicMetadata**](DynamicMetadata.md)| | **subscription_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **body** | [**str**](str.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**DynamicMetadata**](DynamicMetadata.md) +[**InlineResponseDefault7**](InlineResponseDefault7.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2512,46 +2552,95 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **set_pricing_component_value_on_subscription** -> PricingComponentValuePagedMetadata set_pricing_component_value_on_subscription(subscription_id, pricing_component_value) +> InlineResponseDefault72 set_pricing_component_value_on_subscription(subscription_id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +body = billforward.PricingComponentValue() # PricingComponentValue | (optional) + +try: + api_response = api_instance.set_pricing_component_value_on_subscription(subscription_id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **subscription_id** | **str**| | + **body** | [**PricingComponentValue**](PricingComponentValue.md)| | [optional] + +### Return type + +[**InlineResponseDefault72**](InlineResponseDefault72.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_pricing_component_value_on_subscription1** +> InlineResponseDefault71 set_pricing_component_value_on_subscription1(subscription_id, pricing_component, body=body) -Sets upon this subscription a new value for the specified pricing-component without performing an upgrade. -{\"nickname\":\"Set values\",\"request\":\"setPricingComponentValuesRequest.html\",\"response\":\"setPricingComponentValues.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription_id = 'subscription_id_example' # str | ID of the subscription. -pricing_component_value = billforward.PricingComponentValue() # PricingComponentValue | The pricing-component-value request +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +subscription_id = 'subscription_id_example' # str | +pricing_component = 'pricing_component_example' # str | +body = billforward.PricingComponentValueRequest() # PricingComponentValueRequest | (optional) -try: - # Sets upon this subscription a new value for the specified pricing-component without performing an upgrade. - api_response = api_instance.set_pricing_component_value_on_subscription(subscription_id, pricing_component_value) +try: + api_response = api_instance.set_pricing_component_value_on_subscription1(subscription_id, pricing_component, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription1: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| ID of the subscription. | - **pricing_component_value** | [**PricingComponentValue**](PricingComponentValue.md)| The pricing-component-value request | + **subscription_id** | **str**| | + **pricing_component** | **str**| | + **body** | [**PricingComponentValueRequest**](PricingComponentValueRequest.md)| | [optional] ### Return type -[**PricingComponentValuePagedMetadata**](PricingComponentValuePagedMetadata.md) +[**InlineResponseDefault71**](InlineResponseDefault71.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2560,32 +2649,30 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **set_pricing_component_value_on_subscription_v2** -> PricingComponentValueResponsePagedMetadata set_pricing_component_value_on_subscription_v2(subscription_id, pricing_component, value) +# **set_pricing_component_value_on_subscription_batch_update** +> InlineResponseDefault62 set_pricing_component_value_on_subscription_batch_update(subscription_id, body=body) -Upgrades/downgrades this subscription to some new value for the specified pricing-component. -{\"nickname\":\"Set value\",\"request\":\"setPricingComponentValueRequest.html\",\"response\":\"setPricingComponentValue.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -pricing_component = 'pricing_component_example' # str | Name or ID of the pricing-component. -value = billforward.PricingComponentValueRequest() # PricingComponentValueRequest | The pricing-component-value request +body = billforward.BatchUpdatePricingComponentValuesRequest() # BatchUpdatePricingComponentValuesRequest | (optional) -try: - # Upgrades/downgrades this subscription to some new value for the specified pricing-component. - api_response = api_instance.set_pricing_component_value_on_subscription_v2(subscription_id, pricing_component, value) +try: + api_response = api_instance.set_pricing_component_value_on_subscription_batch_update(subscription_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription_v2: %s\n" % e + print("Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription_batch_update: %s\n" % e) ``` ### Parameters @@ -2593,16 +2680,15 @@ except ApiException as e: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **subscription_id** | **str**| | - **pricing_component** | **str**| Name or ID of the pricing-component. | - **value** | [**PricingComponentValueRequest**](PricingComponentValueRequest.md)| The pricing-component-value request | + **body** | [**BatchUpdatePricingComponentValuesRequest**](BatchUpdatePricingComponentValuesRequest.md)| | [optional] ### Return type -[**PricingComponentValueResponsePagedMetadata**](PricingComponentValueResponsePagedMetadata.md) +[**InlineResponseDefault62**](InlineResponseDefault62.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2611,92 +2697,92 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_subscription** -> SubscriptionPagedMetadata update_subscription(subscription) +# **start_all_subscriptions** +> InlineResponseDefault73 start_all_subscriptions(account_id, body=body) -Update a subscription. -{\"nickname\":\"Update a subscription\",\"request\":\"updateSubscriptionRequest.html\",\"response\":\"updateSubscriptionResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -subscription = billforward.Subscription() # Subscription | The subscription object to be updated. +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +body = billforward.StartAllSubscriptionsRequest() # StartAllSubscriptionsRequest | (optional) -try: - # Update a subscription. - api_response = api_instance.update_subscription(subscription) +try: + api_response = api_instance.start_all_subscriptions(account_id, body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->update_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->start_all_subscriptions: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **subscription** | [**Subscription**](Subscription.md)| The subscription object to be updated. | + **account_id** | **str**| | + **body** | [**StartAllSubscriptionsRequest**](StartAllSubscriptionsRequest.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault73**](InlineResponseDefault73.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_subscription_v2** -> SubscriptionPagedMetadata update_subscription_v2(request) +# **update_subscription_from_request** +> InlineResponseDefault51 update_subscription_from_request(body=body) -Update a subscription (V2). -{\"nickname\":\"Update subscription (V2)\",\"response\":\"updateSubscriptionViaHelper.html\",\"request\":\"updateSubscriptionViaHelper.request.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -request = billforward.UpdateSubscriptionRequest() # UpdateSubscriptionRequest | +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) +body = billforward.UpdateSubscriptionRequest() # UpdateSubscriptionRequest | (optional) -try: - # Update a subscription (V2). - api_response = api_instance.update_subscription_v2(request) +try: + api_response = api_instance.update_subscription_from_request(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->update_subscription_v2: %s\n" % e + print("Exception when calling SubscriptionsApi->update_subscription_from_request: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **request** | [**UpdateSubscriptionRequest**](UpdateSubscriptionRequest.md)| | + **body** | [**UpdateSubscriptionRequest**](UpdateSubscriptionRequest.md)| | [optional] ### Return type -[**SubscriptionPagedMetadata**](SubscriptionPagedMetadata.md) +[**InlineResponseDefault51**](InlineResponseDefault51.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2706,48 +2792,47 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **upsert_metadata_for_subscription** -> DynamicMetadata upsert_metadata_for_subscription(metadata, subscription_id, organizations=organizations) +> InlineResponseDefault7 upsert_metadata_for_subscription(subscription_id, body=body, organizations=organizations) -Update any existing metadata key-values and insert any new key-values, no keys will be removed. -{\"nickname\":\"Upsert on subscription\",\"request\":\"upsertSubscriptionMetadataRequest.html\",\"response\":\"upsertSubscriptionMetadataResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.SubscriptionsApi() -metadata = billforward.DynamicMetadata() # DynamicMetadata | +api_instance = billforward.SubscriptionsApi(billforward.ApiClient(configuration)) subscription_id = 'subscription_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +body = 'body_example' # str | (optional) +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Update any existing metadata key-values and insert any new key-values, no keys will be removed. - api_response = api_instance.upsert_metadata_for_subscription(metadata, subscription_id, organizations=organizations) +try: + api_response = api_instance.upsert_metadata_for_subscription(subscription_id, body=body, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling SubscriptionsApi->upsert_metadata_for_subscription: %s\n" % e + print("Exception when calling SubscriptionsApi->upsert_metadata_for_subscription: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **metadata** | [**DynamicMetadata**](DynamicMetadata.md)| | **subscription_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **body** | [**str**](str.md)| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**DynamicMetadata**](DynamicMetadata.md) +[**InlineResponseDefault7**](InlineResponseDefault7.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/SwaggerTypeList.md b/docs/SwaggerTypeList.md deleted file mode 100644 index e987c79..0000000 --- a/docs/SwaggerTypeList.md +++ /dev/null @@ -1,11 +0,0 @@ -# SwaggerTypeList - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**component_change** | [**ComponentChange**](ComponentChange.md) | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**mappings** | [**PricingComponentValueMigrationAmendmentMapping**](PricingComponentValueMigrationAmendmentMapping.md) | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/SwaggerTypeListInv.md b/docs/SwaggerTypeListInv.md index 14d1389..a7fa95c 100644 --- a/docs/SwaggerTypeListInv.md +++ b/docs/SwaggerTypeListInv.md @@ -3,8 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payment_retry_request** | [**PaymentRetryRequest**](PaymentRetryRequest.md) | { \"description\" : \"\", \"verbs\":[\"GET\"] } | +**payment_retry_request** | [**PaymentRetryRequest**](PaymentRetryRequest.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SwaggerTypeListSubs.md b/docs/SwaggerTypeListSubs.md index 7f7f18d..c31d1ec 100644 --- a/docs/SwaggerTypeListSubs.md +++ b/docs/SwaggerTypeListSubs.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**credit_subscription_request** | [**CreditSubscriptionRequest**](CreditSubscriptionRequest.md) | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**add_payment_method_request** | [**AddPaymentMethodRequest**](AddPaymentMethodRequest.md) | { \"description\" : \"\", \"verbs\":[\"GET\"] } | +**update_pricing_component_value_response** | [**UpdatePricingComponentValueResponse**](UpdatePricingComponentValueResponse.md) | | [optional] +**credit_subscription_request** | [**CreditSubscriptionRequest**](CreditSubscriptionRequest.md) | | [optional] +**add_payment_method_request** | [**AddPaymentMethodRequest**](AddPaymentMethodRequest.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SyncActionRequest.md b/docs/SyncActionRequest.md new file mode 100644 index 0000000..ed41fa6 --- /dev/null +++ b/docs/SyncActionRequest.md @@ -0,0 +1,10 @@ +# SyncActionRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**action** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SynchAppConfigsApi.md b/docs/SynchAppConfigsApi.md deleted file mode 100644 index 26c6b32..0000000 --- a/docs/SynchAppConfigsApi.md +++ /dev/null @@ -1,204 +0,0 @@ -# billforward.SynchAppConfigsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_sync_app_config**](SynchAppConfigsApi.md#create_sync_app_config) | **POST** /synchAppConfigs | Create a synch app configuration. -[**get_sync_app_config**](SynchAppConfigsApi.md#get_sync_app_config) | **GET** /synchAppConfigs/{synchAppConfigs-ID} | Returns a single config, specified by the ID parameter. -[**get_sync_app_config_by_platform**](SynchAppConfigsApi.md#get_sync_app_config_by_platform) | **GET** /synchAppConfigs/platform/{platform} | Returns a collection configurations, specified by the platform parameter. -[**update_sync_app_config**](SynchAppConfigsApi.md#update_sync_app_config) | **PUT** /synchAppConfigs | Update a synch app configuration. - - -# **create_sync_app_config** -> DataSynchronisationAppConfigurationPagedMetadata create_sync_app_config(synch_app_config) - -Create a synch app configuration. - -{\"nickname\":\"Create a new synch app configuration\",\"request\":\"createSynchAppConfigurationRequest.html\",\"response\":\"createSynchAppConfigurationResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchAppConfigsApi() -synch_app_config = billforward.MutableBillingEntity() # MutableBillingEntity | The data synch app config object to be created. - -try: - # Create a synch app configuration. - api_response = api_instance.create_sync_app_config(synch_app_config) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchAppConfigsApi->create_sync_app_config: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **synch_app_config** | [**MutableBillingEntity**](MutableBillingEntity.md)| The data synch app config object to be created. | - -### Return type - -[**DataSynchronisationAppConfigurationPagedMetadata**](DataSynchronisationAppConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_sync_app_config** -> DataSynchronisationAppConfigurationPagedMetadata get_sync_app_config(synch_app_configs_id, organizations=organizations) - -Returns a single config, specified by the ID parameter. - -{ \"nickname\" : \"Retrieve an existing synch config\",\"response\" : \"getSynchAppConfigByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchAppConfigsApi() -synch_app_configs_id = 'synch_app_configs_id_example' # str | ID of the Synch App Configuration. -organizations = ['organizations_example'] # list[str] | A list of organization -IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single config, specified by the ID parameter. - api_response = api_instance.get_sync_app_config(synch_app_configs_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchAppConfigsApi->get_sync_app_config: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **synch_app_configs_id** | **str**| ID of the Synch App Configuration. | - **organizations** | [**list[str]**](str.md)| A list of organization -IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DataSynchronisationAppConfigurationPagedMetadata**](DataSynchronisationAppConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_sync_app_config_by_platform** -> DataSynchronisationAppConfigurationPagedMetadata get_sync_app_config_by_platform(platform, organizations=organizations) - -Returns a collection configurations, specified by the platform parameter. - -{ \"nickname\" : \"Retrieve by platform\",\"response\" : \"getSynchAppConfigsByPlatform.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchAppConfigsApi() -platform = 'platform_example' # str | The type of the synch app configuration. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a collection configurations, specified by the platform parameter. - api_response = api_instance.get_sync_app_config_by_platform(platform, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchAppConfigsApi->get_sync_app_config_by_platform: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **platform** | **str**| The type of the synch app configuration. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DataSynchronisationAppConfigurationPagedMetadata**](DataSynchronisationAppConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_sync_app_config** -> DataSynchronisationAppConfigurationPagedMetadata update_sync_app_config(synch_app_config) - -Update a synch app configuration. - -{ \"nickname\" : \"Update a sync app configuration\", \"request\" : \"updateSyncAppConfigRequest.html\" ,\"response\" : \"updateSyncAppConfigResponse.html\" } - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchAppConfigsApi() -synch_app_config = billforward.MutableBillingEntity() # MutableBillingEntity | The synch app configuration object to be updated. - -try: - # Update a synch app configuration. - api_response = api_instance.update_sync_app_config(synch_app_config) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchAppConfigsApi->update_sync_app_config: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **synch_app_config** | [**MutableBillingEntity**](MutableBillingEntity.md)| The synch app configuration object to be updated. | - -### Return type - -[**DataSynchronisationAppConfigurationPagedMetadata**](DataSynchronisationAppConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/SynchConfigsApi.md b/docs/SynchConfigsApi.md deleted file mode 100644 index 3bdf2e4..0000000 --- a/docs/SynchConfigsApi.md +++ /dev/null @@ -1,310 +0,0 @@ -# billforward.SynchConfigsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_sync_config**](SynchConfigsApi.md#create_sync_config) | **POST** /synchConfigs | Create a synch configuration. -[**get_all_sync_configs**](SynchConfigsApi.md#get_all_sync_configs) | **GET** /synchConfigs | Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. -[**get_sync_config**](SynchConfigsApi.md#get_sync_config) | **GET** /synchConfigs/{synchConfigs-ID} | Returns a single config, specified by the ID parameter. -[**get_sync_config_by_platform**](SynchConfigsApi.md#get_sync_config_by_platform) | **GET** /synchConfigs/platform/{platform} | Returns a collection configurations, specified by the platform parameter. -[**get_sync_config_by_username**](SynchConfigsApi.md#get_sync_config_by_username) | **GET** /synchConfigs/username/{username} | Returns a collection configurations, specified by the username parameter. -[**update_sync_config**](SynchConfigsApi.md#update_sync_config) | **PUT** /synchConfigs | Update a synch configuration. - - -# **create_sync_config** -> DataSynchronisationConfigurationPagedMetadata create_sync_config(synch_config) - -Create a synch configuration. - -{\"nickname\":\"Create a new synch configuration\",\"request\":\"createSynchConfigRequest.html\",\"response\":\"createSynchConfigResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchConfigsApi() -synch_config = billforward.DataSynchronisationConfiguration() # DataSynchronisationConfiguration | The data synch config object to be created. - -try: - # Create a synch configuration. - api_response = api_instance.create_sync_config(synch_config) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchConfigsApi->create_sync_config: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **synch_config** | [**DataSynchronisationConfiguration**](DataSynchronisationConfiguration.md)| The data synch config object to be created. | - -### Return type - -[**DataSynchronisationConfigurationPagedMetadata**](DataSynchronisationConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_sync_configs** -> DataSynchronisationConfigurationPagedMetadata get_all_sync_configs(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - -{ \"nickname\" : \"Get all synch configs\",\"response\" : \"getSynchConfigsAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchConfigsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first synch configuration to return. (optional) (default to 0) -records = 10 # int | The maximum number of configs to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_sync_configs(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchConfigsApi->get_all_sync_configs: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first synch configuration to return. | [optional] [default to 0] - **records** | **int**| The maximum number of configs to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**DataSynchronisationConfigurationPagedMetadata**](DataSynchronisationConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_sync_config** -> DataSynchronisationConfigurationPagedMetadata get_sync_config(synch_configs_id, organizations=organizations) - -Returns a single config, specified by the ID parameter. - -{ \"nickname\" : \"Retrieve an existing synch config\",\"response\" : \"getSynchConfigByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchConfigsApi() -synch_configs_id = 'synch_configs_id_example' # str | ID of the Synch Configuration. -organizations = ['organizations_example'] # list[str] | A list of organization -IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single config, specified by the ID parameter. - api_response = api_instance.get_sync_config(synch_configs_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchConfigsApi->get_sync_config: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **synch_configs_id** | **str**| ID of the Synch Configuration. | - **organizations** | [**list[str]**](str.md)| A list of organization -IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DataSynchronisationConfigurationPagedMetadata**](DataSynchronisationConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_sync_config_by_platform** -> DataSynchronisationConfigurationPagedMetadata get_sync_config_by_platform(platform, organizations=organizations) - -Returns a collection configurations, specified by the platform parameter. - -{ \"nickname\" : \"Retrieve by platform\",\"response\" : \"getSynchConfigsByPlatform.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchConfigsApi() -platform = 'platform_example' # str | The type of the synch configuration. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a collection configurations, specified by the platform parameter. - api_response = api_instance.get_sync_config_by_platform(platform, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchConfigsApi->get_sync_config_by_platform: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **platform** | **str**| The type of the synch configuration. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DataSynchronisationConfigurationPagedMetadata**](DataSynchronisationConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_sync_config_by_username** -> DataSynchronisationConfigurationPagedMetadata get_sync_config_by_username(username, organizations=organizations) - -Returns a collection configurations, specified by the username parameter. - -{ \"nickname\" : \"Retrieve by username\",\"response\" : \"getSynchConfigByUsername.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchConfigsApi() -username = 'username_example' # str | The username in the synch configuration. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a collection configurations, specified by the username parameter. - api_response = api_instance.get_sync_config_by_username(username, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchConfigsApi->get_sync_config_by_username: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **username** | **str**| The username in the synch configuration. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DataSynchronisationConfigurationPagedMetadata**](DataSynchronisationConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_sync_config** -> DataSynchronisationConfigurationPagedMetadata update_sync_config(synch_config) - -Update a synch configuration. - -{ \"nickname\" : \"Update a synch config\", \"request\" : \"updateSyncConfigRequest.html\" ,\"response\" : \"updateSyncConfigResponse.html\" } - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchConfigsApi() -synch_config = billforward.DataSynchronisationConfiguration() # DataSynchronisationConfiguration | The synch configuration object to be updated. - -try: - # Update a synch configuration. - api_response = api_instance.update_sync_config(synch_config) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchConfigsApi->update_sync_config: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **synch_config** | [**DataSynchronisationConfiguration**](DataSynchronisationConfiguration.md)| The synch configuration object to be updated. | - -### Return type - -[**DataSynchronisationConfigurationPagedMetadata**](DataSynchronisationConfigurationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/SynchJobsApi.md b/docs/SynchJobsApi.md deleted file mode 100644 index 2fce199..0000000 --- a/docs/SynchJobsApi.md +++ /dev/null @@ -1,410 +0,0 @@ -# billforward.SynchJobsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_sync_job**](SynchJobsApi.md#create_sync_job) | **POST** /synchJobs | Create a synch job. -[**get_all_sync_jobs**](SynchJobsApi.md#get_all_sync_jobs) | **GET** /synchJobs | Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. -[**get_sync_job_by_id**](SynchJobsApi.md#get_sync_job_by_id) | **GET** /synchJobs/{synchJob-ID} | Returns a single job, specified by the ID parameter. -[**get_sync_job_by_scope**](SynchJobsApi.md#get_sync_job_by_scope) | **GET** /synchJobs/scope/{scope} | Returns a collection jobs, specified by the scope parameter. -[**get_sync_job_by_state**](SynchJobsApi.md#get_sync_job_by_state) | **GET** /synchJobs/state/{state} | Returns a collection jobs, specified by the state parameter. -[**get_sync_job_by_target**](SynchJobsApi.md#get_sync_job_by_target) | **GET** /synchJobs/target/{target} | Returns a collection jobs, specified by the target parameter. -[**get_sync_job_by_type**](SynchJobsApi.md#get_sync_job_by_type) | **GET** /synchJobs/type/{type} | Returns a collection jobs, specified by the type parameter. -[**update_sync_job**](SynchJobsApi.md#update_sync_job) | **PUT** /synchJobs | Update a synch job. - - -# **create_sync_job** -> DataSynchronizationJobPagedMetadata create_sync_job(synch_job) - -Create a synch job. - -{\"nickname\":\"Create a new sync job\",\"request\":\"createSynchJobRequest.html\",\"response\":\"createSynchJobResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchJobsApi() -synch_job = billforward.MutableBillingEntity() # MutableBillingEntity | The data synch job object to be created. - -try: - # Create a synch job. - api_response = api_instance.create_sync_job(synch_job) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchJobsApi->create_sync_job: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **synch_job** | [**MutableBillingEntity**](MutableBillingEntity.md)| The data synch job object to be created. | - -### Return type - -[**DataSynchronizationJobPagedMetadata**](DataSynchronizationJobPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_sync_jobs** -> DataSynchronizationJobPagedMetadata get_all_sync_jobs(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all synch jobs\",\"response\":\"getSynchJobsAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchJobsApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first synch job to return. (optional) (default to 0) -records = 10 # int | The maximum number of synch jobs to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_sync_jobs(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchJobsApi->get_all_sync_jobs: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first synch job to return. | [optional] [default to 0] - **records** | **int**| The maximum number of synch jobs to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**DataSynchronizationJobPagedMetadata**](DataSynchronizationJobPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_sync_job_by_id** -> DataSynchronizationJobPagedMetadata get_sync_job_by_id(synch_job_id, organizations=organizations) - -Returns a single job, specified by the ID parameter. - -{\"nickname\":\"Retrieve an existing synch job\",\"response\":\"getSyncJobByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchJobsApi() -synch_job_id = 'synch_job_id_example' # str | ID of the Sync Job. -organizations = ['organizations_example'] # list[str] | A list of organization -IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single job, specified by the ID parameter. - api_response = api_instance.get_sync_job_by_id(synch_job_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchJobsApi->get_sync_job_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **synch_job_id** | **str**| ID of the Sync Job. | - **organizations** | [**list[str]**](str.md)| A list of organization -IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DataSynchronizationJobPagedMetadata**](DataSynchronizationJobPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_sync_job_by_scope** -> DataSynchronizationJobPagedMetadata get_sync_job_by_scope(scope, organizations=organizations) - -Returns a collection jobs, specified by the scope parameter. - -{\"nickname\":\"Retrieve by scope\",\"response\":\"getSyncJobByScope.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchJobsApi() -scope = 'scope_example' # str | The scope of the synch job. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a collection jobs, specified by the scope parameter. - api_response = api_instance.get_sync_job_by_scope(scope, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchJobsApi->get_sync_job_by_scope: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **scope** | **str**| The scope of the synch job. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DataSynchronizationJobPagedMetadata**](DataSynchronizationJobPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_sync_job_by_state** -> DataSynchronizationJobPagedMetadata get_sync_job_by_state(state, organizations=organizations) - -Returns a collection jobs, specified by the state parameter. - -{\"nickname\":\"Retrieve by state\",\"response\":\"getSyncJobByState.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchJobsApi() -state = 'state_example' # str | The state of the synch job. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a collection jobs, specified by the state parameter. - api_response = api_instance.get_sync_job_by_state(state, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchJobsApi->get_sync_job_by_state: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **state** | **str**| The state of the synch job. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DataSynchronizationJobPagedMetadata**](DataSynchronizationJobPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_sync_job_by_target** -> DataSynchronizationJobPagedMetadata get_sync_job_by_target(target, organizations=organizations) - -Returns a collection jobs, specified by the target parameter. - -{\"nickname\":\"Retrieve by target\",\"response\":\"getSyncJobByTarget.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchJobsApi() -target = 'target_example' # str | The target of the synch job. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a collection jobs, specified by the target parameter. - api_response = api_instance.get_sync_job_by_target(target, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchJobsApi->get_sync_job_by_target: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **target** | **str**| The target of the synch job. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DataSynchronizationJobPagedMetadata**](DataSynchronizationJobPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_sync_job_by_type** -> DataSynchronizationJobPagedMetadata get_sync_job_by_type(type, organizations=organizations) - -Returns a collection jobs, specified by the type parameter. - -{\"nickname\":\"Retrieve by type\",\"response\":\"getSyncJobByType.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchJobsApi() -type = 'type_example' # str | The type of the synch job. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a collection jobs, specified by the type parameter. - api_response = api_instance.get_sync_job_by_type(type, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchJobsApi->get_sync_job_by_type: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **type** | **str**| The type of the synch job. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**DataSynchronizationJobPagedMetadata**](DataSynchronizationJobPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_sync_job** -> DataSynchronizationJobPagedMetadata update_sync_job(synch_job) - -Update a synch job. - -{\"nickname\":\"Update a synch job\",\"request\":\"updateSyncJobRequest.html\",\"response\":\"updateSyncJobResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.SynchJobsApi() -synch_job = billforward.MutableBillingEntity() # MutableBillingEntity | The synch job object to be updated. - -try: - # Update a synch job. - api_response = api_instance.update_sync_job(synch_job) - pprint(api_response) -except ApiException as e: - print "Exception when calling SynchJobsApi->update_sync_job: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **synch_job** | [**MutableBillingEntity**](MutableBillingEntity.md)| The synch job object to be updated. | - -### Return type - -[**DataSynchronizationJobPagedMetadata**](DataSynchronizationJobPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/TaxLine.md b/docs/TaxLine.md new file mode 100644 index 0000000..43c3c18 --- /dev/null +++ b/docs/TaxLine.md @@ -0,0 +1,18 @@ +# TaxLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**id** | **str** | | [optional] +**invoice_id** | **str** | | +**organization_id** | **str** | | +**taxation_strategy_id** | **str** | | [optional] +**name** | **str** | | +**percentage** | **float** | | +**amount** | **float** | | +**linked_charge_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TaxationLinkPagedMetadata.md b/docs/TaxationLinkPagedMetadata.md deleted file mode 100644 index 27f4da2..0000000 --- a/docs/TaxationLinkPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# TaxationLinkPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TaxationStrategy.md b/docs/TaxationStrategy.md new file mode 100644 index 0000000..85dd3b5 --- /dev/null +++ b/docs/TaxationStrategy.md @@ -0,0 +1,24 @@ +# TaxationStrategy + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | +**version_id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**country** | **str** | | +**province** | **str** | | [optional] +**currency** | [**CreditNoteCurrency**](CreditNoteCurrency.md) | | +**name** | **str** | | +**percentage** | **float** | | +**applied_at** | **str** | | [optional] +**deleted** | **bool** | | +**default_taxation_strategy** | **bool** | | [optional] +**valid_from** | **datetime** | | +**valid_till** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TaxationStrategyPagedMetadata.md b/docs/TaxationStrategyPagedMetadata.md deleted file mode 100644 index 23995ad..0000000 --- a/docs/TaxationStrategyPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# TaxationStrategyPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TaxationlinksApi.md b/docs/TaxationlinksApi.md deleted file mode 100644 index 208cc51..0000000 --- a/docs/TaxationlinksApi.md +++ /dev/null @@ -1,332 +0,0 @@ -# billforward.TaxationlinksApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_taxation_link**](TaxationlinksApi.md#create_taxation_link) | **POST** /taxation-links | Create -[**get_all_taxation_links**](TaxationlinksApi.md#get_all_taxation_links) | **GET** /taxation-links | Returns a collection of all taxation-links. By default 10 values are returned. Records are returned in natural order. -[**get_taxation_link_by_id**](TaxationlinksApi.md#get_taxation_link_by_id) | **GET** /taxation-links/{taxation-link-ID} | Returns a single taxation-link, specified by the taxation-link-ID parameter. -[**get_taxation_link_by_product_rate_plan**](TaxationlinksApi.md#get_taxation_link_by_product_rate_plan) | **GET** /taxation-links/product-rate-plan/{product-rate-plan-ID} | Returns a collection of taxation-links, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_taxation_link_by_taxation_strategy**](TaxationlinksApi.md#get_taxation_link_by_taxation_strategy) | **GET** /taxation-links/taxation-strategy/{taxation-strategy-ID} | Returns a collection of taxation-links, specified by the taxation-strategy-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**update_taxation_link**](TaxationlinksApi.md#update_taxation_link) | **PUT** /taxation-links | Update - - -# **create_taxation_link** -> TaxationLinkPagedMetadata create_taxation_link(taxation_link) - -Create - -{\"nickname\":\"Add a taxation strategy to a rate-plan\",\"request\":\"createTaxationLinkRequest.html\",\"response\":\"createTaxationLinkResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationlinksApi() -taxation_link = billforward.MutableBillingEntity() # MutableBillingEntity | The taxation-link object to be updated. - -try: - # Create - api_response = api_instance.create_taxation_link(taxation_link) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationlinksApi->create_taxation_link: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **taxation_link** | [**MutableBillingEntity**](MutableBillingEntity.md)| The taxation-link object to be updated. | - -### Return type - -[**TaxationLinkPagedMetadata**](TaxationLinkPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_taxation_links** -> TaxationLinkPagedMetadata get_all_taxation_links(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of all taxation-links. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all taxation links\",\"response\":\"getTaxationLinkAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationlinksApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of all taxation-links. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_taxation_links(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationlinksApi->get_all_taxation_links: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**TaxationLinkPagedMetadata**](TaxationLinkPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_taxation_link_by_id** -> TaxationLinkPagedMetadata get_taxation_link_by_id(taxation_link_id, organizations=organizations) - -Returns a single taxation-link, specified by the taxation-link-ID parameter. - -{\"nickname\":\"Retrieve an existing taxation link\",\"response\":\"getTaxationLinkByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationlinksApi() -taxation_link_id = 'taxation_link_id_example' # str | The unique ID of the Taxation Link. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single taxation-link, specified by the taxation-link-ID parameter. - api_response = api_instance.get_taxation_link_by_id(taxation_link_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationlinksApi->get_taxation_link_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **taxation_link_id** | **str**| The unique ID of the Taxation Link. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**TaxationLinkPagedMetadata**](TaxationLinkPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_taxation_link_by_product_rate_plan** -> TaxationLinkPagedMetadata get_taxation_link_by_product_rate_plan(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of taxation-links, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by rate-plan\",\"response\":\"getTaxationLinkByPRPID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationlinksApi() -product_rate_plan_id = 'product_rate_plan_id_example' # str | The ID of the product-rate-plan -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of taxation-links, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_taxation_link_by_product_rate_plan(product_rate_plan_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationlinksApi->get_taxation_link_by_product_rate_plan: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **product_rate_plan_id** | **str**| The ID of the product-rate-plan | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**TaxationLinkPagedMetadata**](TaxationLinkPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_taxation_link_by_taxation_strategy** -> TaxationLinkPagedMetadata get_taxation_link_by_taxation_strategy(taxation_strategy_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of taxation-links, specified by the taxation-strategy-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by taxation strategy\",\"response\":\"getTaxationLinkByTSID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationlinksApi() -taxation_strategy_id = 'taxation_strategy_id_example' # str | The ID of the taxation-strategy -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of taxation-links, specified by the taxation-strategy-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_taxation_link_by_taxation_strategy(taxation_strategy_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationlinksApi->get_taxation_link_by_taxation_strategy: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **taxation_strategy_id** | **str**| The ID of the taxation-strategy | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**TaxationLinkPagedMetadata**](TaxationLinkPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_taxation_link** -> TaxationLinkPagedMetadata update_taxation_link(taxation_link) - -Update - -{\"nickname\":\"Change taxation linked to rate-plan\",\"request\":\"updateTaxationLinkRequest.html\",\"response\":\"updateTaxationLinkResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationlinksApi() -taxation_link = billforward.MutableBillingEntity() # MutableBillingEntity | The taxation-link object to be updated. - -try: - # Update - api_response = api_instance.update_taxation_link(taxation_link) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationlinksApi->update_taxation_link: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **taxation_link** | [**MutableBillingEntity**](MutableBillingEntity.md)| The taxation-link object to be updated. | - -### Return type - -[**TaxationLinkPagedMetadata**](TaxationLinkPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/TaxationstrategiesApi.md b/docs/TaxationstrategiesApi.md deleted file mode 100644 index e66e30b..0000000 --- a/docs/TaxationstrategiesApi.md +++ /dev/null @@ -1,502 +0,0 @@ -# billforward.TaxationstrategiesApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_taxation_strategy**](TaxationstrategiesApi.md#create_taxation_strategy) | **POST** /taxation-strategies | <p>Add a new tax or schedule changes in an existing tax.</p><p>Add a new tax by providing the location and tax percentage. To schedule a tax change specify the ID of the current Tax. A new version of the will be created <i>validFrom</i> the specified date, the existing tax <i>validTill</i> the start of this new tax.</p> -[**get_all_taxation_strategies**](TaxationstrategiesApi.md#get_all_taxation_strategies) | **GET** /taxation-strategies | Returns a collection of all taxation-strategies. By default 10 values are returned. Records are returned in natural order. -[**get_taxation_strategy_by_consistent_id**](TaxationstrategiesApi.md#get_taxation_strategy_by_consistent_id) | **GET** /taxation-strategies/{taxation-strategy-ID} | Returns the tax currently being applied for the taxation-strategy-ID. To return schedule or historic tax changes the include_retired query parameter should be set to true. -[**get_taxation_strategy_by_country**](TaxationstrategiesApi.md#get_taxation_strategy_by_country) | **GET** /taxation-strategies/country/{country} | Returns a collection of taxation-strategies, specified by the country parameter. By default 10 values are returned. Records are returned in natural order. To return schedule or historic tax changes the include_retired query parameter should be set to true. -[**get_taxation_strategy_by_currency**](TaxationstrategiesApi.md#get_taxation_strategy_by_currency) | **GET** /taxation-strategies/currency/{currency} | Returns a collection of taxation-strategies, specified by the currency parameter. By default 10 values are returned. Records are returned in natural order. -[**get_taxation_strategy_by_province**](TaxationstrategiesApi.md#get_taxation_strategy_by_province) | **GET** /taxation-strategies/province/{province} | Returns a collection of taxation-strategies, specified by the province parameter. By default 10 values are returned. Records are returned in natural order. -[**get_taxation_strategy_by_version_id**](TaxationstrategiesApi.md#get_taxation_strategy_by_version_id) | **GET** /taxation-strategies/version/{version-ID} | Returns a single taxation-strategy, specified by the taxation-strategy-ID parameter. -[**retire_taxation_strategy**](TaxationstrategiesApi.md#retire_taxation_strategy) | **DELETE** /taxation-strategies/version/{version-ID} | Retires the taxation-strategy specified by taxation-strategy-ID parameter. Only the version of the tax which has an unbounded (null) validTill can be removed. Removing a tax change will make the previous tax come into effect. For example if you have a Tax in January and 5% and a new tax at 7% from February onwards, you can remove the February tax. Remove the February tax will re-instate the January tax. -[**update_taxation_strategy**](TaxationstrategiesApi.md#update_taxation_strategy) | **PUT** /taxation-strategies | Update a tax. - - -# **create_taxation_strategy** -> TaxationStrategyPagedMetadata create_taxation_strategy(taxation_strategy) - -

Add a new tax or schedule changes in an existing tax.

Add a new tax by providing the location and tax percentage. To schedule a tax change specify the ID of the current Tax. A new version of the will be created validFrom the specified date, the existing tax validTill the start of this new tax.

- -{\"nickname\":\"Create a tax\",\"request\":\"createTaxationStrategyRequest.html\",\"response\":\"createTaxationStrategyResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationstrategiesApi() -taxation_strategy = billforward.MutableBillingEntity() # MutableBillingEntity | The taxation-strategy object to be updated. - -try: - #

Add a new tax or schedule changes in an existing tax.

Add a new tax by providing the location and tax percentage. To schedule a tax change specify the ID of the current Tax. A new version of the will be created validFrom the specified date, the existing tax validTill the start of this new tax.

- api_response = api_instance.create_taxation_strategy(taxation_strategy) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationstrategiesApi->create_taxation_strategy: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **taxation_strategy** | [**MutableBillingEntity**](MutableBillingEntity.md)| The taxation-strategy object to be updated. | - -### Return type - -[**TaxationStrategyPagedMetadata**](TaxationStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_taxation_strategies** -> TaxationStrategyPagedMetadata get_all_taxation_strategies(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of all taxation-strategies. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all tax\",\"response\":\"getTaxationStrategyAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationstrategiesApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-strategy to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-strategies to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Returns a collection of all taxation-strategies. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_taxation_strategies(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationstrategiesApi->get_all_taxation_strategies: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-strategy to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-strategies to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - -### Return type - -[**TaxationStrategyPagedMetadata**](TaxationStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_taxation_strategy_by_consistent_id** -> TaxationStrategyPagedMetadata get_taxation_strategy_by_consistent_id(taxation_strategy_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns the tax currently being applied for the taxation-strategy-ID. To return schedule or historic tax changes the include_retired query parameter should be set to true. - -{\"nickname\":\"Retrieve an existing tax \",\"response\":\"getTaxationStrategyByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationstrategiesApi() -taxation_strategy_id = 'taxation_strategy_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-strategy to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-strategies to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Returns the tax currently being applied for the taxation-strategy-ID. To return schedule or historic tax changes the include_retired query parameter should be set to true. - api_response = api_instance.get_taxation_strategy_by_consistent_id(taxation_strategy_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationstrategiesApi->get_taxation_strategy_by_consistent_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **taxation_strategy_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-strategy to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-strategies to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - -### Return type - -[**TaxationStrategyPagedMetadata**](TaxationStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_taxation_strategy_by_country** -> TaxationStrategyPagedMetadata get_taxation_strategy_by_country(country, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of taxation-strategies, specified by the country parameter. By default 10 values are returned. Records are returned in natural order. To return schedule or historic tax changes the include_retired query parameter should be set to true. - -{\"nickname\":\"Retrieve by country\",\"response\":\"getTaxationStrategyByCountry.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationstrategiesApi() -country = 'country_example' # str | The country -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-strategy to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-strategies to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Returns a collection of taxation-strategies, specified by the country parameter. By default 10 values are returned. Records are returned in natural order. To return schedule or historic tax changes the include_retired query parameter should be set to true. - api_response = api_instance.get_taxation_strategy_by_country(country, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationstrategiesApi->get_taxation_strategy_by_country: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **country** | **str**| The country | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-strategy to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-strategies to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - -### Return type - -[**TaxationStrategyPagedMetadata**](TaxationStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_taxation_strategy_by_currency** -> TaxationStrategyPagedMetadata get_taxation_strategy_by_currency(currency, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of taxation-strategies, specified by the currency parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by currency\",\"response\":\"getTaxationStrategyByProvince.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationstrategiesApi() -currency = 'currency_example' # str | The currency -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-strategy to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-strategies to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Returns a collection of taxation-strategies, specified by the currency parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_taxation_strategy_by_currency(currency, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationstrategiesApi->get_taxation_strategy_by_currency: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **currency** | **str**| The currency | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-strategy to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-strategies to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - -### Return type - -[**TaxationStrategyPagedMetadata**](TaxationStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_taxation_strategy_by_province** -> TaxationStrategyPagedMetadata get_taxation_strategy_by_province(province, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of taxation-strategies, specified by the province parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by province\",\"response\":\"getTaxationStrategyByProvince.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationstrategiesApi() -province = 'province_example' # str | The province -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-strategy to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-strategies to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = false # bool | Whether retired products should be returned. (optional) (default to false) - -try: - # Returns a collection of taxation-strategies, specified by the province parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_taxation_strategy_by_province(province, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationstrategiesApi->get_taxation_strategy_by_province: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **province** | **str**| The province | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-strategy to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-strategies to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to false] - -### Return type - -[**TaxationStrategyPagedMetadata**](TaxationStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_taxation_strategy_by_version_id** -> TaxationStrategyPagedMetadata get_taxation_strategy_by_version_id(version_id, organizations=organizations) - -Returns a single taxation-strategy, specified by the taxation-strategy-ID parameter. - -{\"nickname\":\"Retrieve by version\",\"response\":\"getTaxationStrategyByVersionID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationstrategiesApi() -version_id = 'version_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single taxation-strategy, specified by the taxation-strategy-ID parameter. - api_response = api_instance.get_taxation_strategy_by_version_id(version_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationstrategiesApi->get_taxation_strategy_by_version_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **version_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**TaxationStrategyPagedMetadata**](TaxationStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **retire_taxation_strategy** -> TaxationStrategyPagedMetadata retire_taxation_strategy(version_id, organizations) - -Retires the taxation-strategy specified by taxation-strategy-ID parameter. Only the version of the tax which has an unbounded (null) validTill can be removed. Removing a tax change will make the previous tax come into effect. For example if you have a Tax in January and 5% and a new tax at 7% from February onwards, you can remove the February tax. Remove the February tax will re-instate the January tax. - -{\"nickname\":\"Remove a tax change\",\"response\":\"deleteSubscription.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationstrategiesApi() -version_id = 'version_id_example' # str | -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. - -try: - # Retires the taxation-strategy specified by taxation-strategy-ID parameter. Only the version of the tax which has an unbounded (null) validTill can be removed. Removing a tax change will make the previous tax come into effect. For example if you have a Tax in January and 5% and a new tax at 7% from February onwards, you can remove the February tax. Remove the February tax will re-instate the January tax. - api_response = api_instance.retire_taxation_strategy(version_id, organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationstrategiesApi->retire_taxation_strategy: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **version_id** | **str**| | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | - -### Return type - -[**TaxationStrategyPagedMetadata**](TaxationStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_taxation_strategy** -> TaxationStrategyPagedMetadata update_taxation_strategy(taxation_strategy) - -Update a tax. - -{\"nickname\":\"Update a tax\",\"request\":\"updateTaxationStrategyRequest.html\",\"response\":\"updateTaxationStrategyResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TaxationstrategiesApi() -taxation_strategy = billforward.MutableBillingEntity() # MutableBillingEntity | The taxation-strategy object to be updated. - -try: - # Update a tax. - api_response = api_instance.update_taxation_strategy(taxation_strategy) - pprint(api_response) -except ApiException as e: - print "Exception when calling TaxationstrategiesApi->update_taxation_strategy: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **taxation_strategy** | [**MutableBillingEntity**](MutableBillingEntity.md)| The taxation-strategy object to be updated. | - -### Return type - -[**TaxationStrategyPagedMetadata**](TaxationStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/TaxesApi.md b/docs/TaxesApi.md new file mode 100644 index 0000000..d686acc --- /dev/null +++ b/docs/TaxesApi.md @@ -0,0 +1,492 @@ +# billforward.TaxesApi + +All URIs are relative to *https://app.billforward.net/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_taxation_strategy**](TaxesApi.md#create_taxation_strategy) | **POST** /taxation-strategies | +[**get_all_taxation_strategies**](TaxesApi.md#get_all_taxation_strategies) | **GET** /taxation-strategies | +[**get_taxation_strategy_by_consistent_id**](TaxesApi.md#get_taxation_strategy_by_consistent_id) | **GET** /taxation-strategies/{taxation-strategy-ID} | +[**get_taxation_strategy_by_country**](TaxesApi.md#get_taxation_strategy_by_country) | **GET** /taxation-strategies/country/{country} | +[**get_taxation_strategy_by_currency**](TaxesApi.md#get_taxation_strategy_by_currency) | **GET** /taxation-strategies/currency/{currency} | +[**get_taxation_strategy_by_province**](TaxesApi.md#get_taxation_strategy_by_province) | **GET** /taxation-strategies/province/{province} | +[**get_taxation_strategy_by_version_id**](TaxesApi.md#get_taxation_strategy_by_version_id) | **GET** /taxation-strategies/version/{version-ID} | +[**retire_taxation_strategy**](TaxesApi.md#retire_taxation_strategy) | **DELETE** /taxation-strategies/version/{version-ID} | +[**update_taxation_strategy**](TaxesApi.md#update_taxation_strategy) | **PUT** /taxation-strategies | + +# **create_taxation_strategy** +> InlineResponseDefault78 create_taxation_strategy(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TaxesApi(billforward.ApiClient(configuration)) +body = billforward.TaxationStrategy() # TaxationStrategy | (optional) + +try: + api_response = api_instance.create_taxation_strategy(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TaxesApi->create_taxation_strategy: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**TaxationStrategy**](TaxationStrategy.md)| | [optional] + +### Return type + +[**InlineResponseDefault78**](InlineResponseDefault78.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_taxation_strategies** +> InlineResponseDefault77 get_all_taxation_strategies(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TaxesApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_all_taxation_strategies(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + pprint(api_response) +except ApiException as e: + print("Exception when calling TaxesApi->get_all_taxation_strategies: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + +### Return type + +[**InlineResponseDefault77**](InlineResponseDefault77.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_taxation_strategy_by_consistent_id** +> InlineResponseDefault77 get_taxation_strategy_by_consistent_id(taxation_strategy_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TaxesApi(billforward.ApiClient(configuration)) +taxation_strategy_id = 'taxation_strategy_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_taxation_strategy_by_consistent_id(taxation_strategy_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + pprint(api_response) +except ApiException as e: + print("Exception when calling TaxesApi->get_taxation_strategy_by_consistent_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **taxation_strategy_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + +### Return type + +[**InlineResponseDefault77**](InlineResponseDefault77.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_taxation_strategy_by_country** +> InlineResponseDefault77 get_taxation_strategy_by_country(country, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TaxesApi(billforward.ApiClient(configuration)) +country = 'country_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_taxation_strategy_by_country(country, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + pprint(api_response) +except ApiException as e: + print("Exception when calling TaxesApi->get_taxation_strategy_by_country: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **country** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + +### Return type + +[**InlineResponseDefault77**](InlineResponseDefault77.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_taxation_strategy_by_currency** +> InlineResponseDefault77 get_taxation_strategy_by_currency(currency, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TaxesApi(billforward.ApiClient(configuration)) +currency = 'currency_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_taxation_strategy_by_currency(currency, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + pprint(api_response) +except ApiException as e: + print("Exception when calling TaxesApi->get_taxation_strategy_by_currency: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **currency** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + +### Return type + +[**InlineResponseDefault77**](InlineResponseDefault77.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_taxation_strategy_by_province** +> InlineResponseDefault77 get_taxation_strategy_by_province(province, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TaxesApi(billforward.ApiClient(configuration)) +province = 'province_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = false # bool | (optional) (default to false) + +try: + api_response = api_instance.get_taxation_strategy_by_province(province, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) + pprint(api_response) +except ApiException as e: + print("Exception when calling TaxesApi->get_taxation_strategy_by_province: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **province** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to false] + +### Return type + +[**InlineResponseDefault77**](InlineResponseDefault77.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_taxation_strategy_by_version_id** +> InlineResponseDefault78 get_taxation_strategy_by_version_id(version_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TaxesApi(billforward.ApiClient(configuration)) +version_id = 'version_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_taxation_strategy_by_version_id(version_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling TaxesApi->get_taxation_strategy_by_version_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **version_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault78**](InlineResponseDefault78.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **retire_taxation_strategy** +> InlineResponseDefault78 retire_taxation_strategy(version_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TaxesApi(billforward.ApiClient(configuration)) +version_id = 'version_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.retire_taxation_strategy(version_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling TaxesApi->retire_taxation_strategy: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **version_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault78**](InlineResponseDefault78.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_taxation_strategy** +> InlineResponseDefault78 update_taxation_strategy(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TaxesApi(billforward.ApiClient(configuration)) +body = billforward.TaxationStrategy() # TaxationStrategy | (optional) + +try: + api_response = api_instance.update_taxation_strategy(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TaxesApi->update_taxation_strategy: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**TaxationStrategy**](TaxationStrategy.md)| | [optional] + +### Return type + +[**InlineResponseDefault78**](InlineResponseDefault78.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TieredAdvancePricingComponent.md b/docs/TieredAdvancePricingComponent.md new file mode 100644 index 0000000..082d80b --- /dev/null +++ b/docs/TieredAdvancePricingComponent.md @@ -0,0 +1,17 @@ +# TieredAdvancePricingComponent + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**display_name** | **str** | | [optional] +**upgrade_mode** | **str** | | [optional] +**downgrade_mode** | **str** | | [optional] +**unit** | **str** | | [optional] +**default_quantity** | **int** | | [optional] +**tiers** | [**list[PricingTier]**](PricingTier.md) | | [optional] +**tax_code** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TieredArrearsPricingComponent.md b/docs/TieredArrearsPricingComponent.md new file mode 100644 index 0000000..9e48dc0 --- /dev/null +++ b/docs/TieredArrearsPricingComponent.md @@ -0,0 +1,17 @@ +# TieredArrearsPricingComponent + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**display_name** | **str** | | [optional] +**upgrade_mode** | **str** | | [optional] +**downgrade_mode** | **str** | | [optional] +**unit** | **str** | | [optional] +**default_quantity** | **int** | | [optional] +**tiers** | [**list[PricingTier]**](PricingTier.md) | | [optional] +**tax_code** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TieredPricingComponent.md b/docs/TieredPricingComponent.md index 0aacbae..61deeef 100644 --- a/docs/TieredPricingComponent.md +++ b/docs/TieredPricingComponent.md @@ -3,32 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**version_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**crm_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } When associating a pricing component with a product rate plan, this ID should be used. | -**product_rate_plan_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**unit_of_measure_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | -**name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**public_name** | **str** | {\"description\":\"A friendly non-unique name used to identify this pricing-component\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**description** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**charge_type** | **str** | { \"description\" : \"The charge type of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**invoicing_type** | **str** | { \"default\" : \"Aggregated\", \"description\" : \"For <span class=\\\"label label-default\\\">setup</span> pricing components <span class=\\\"label label-default\\\">Immediate</span> invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. <span class=\\\"label label-default\\\">Aggregated</span> invoicing will add a charge to the first invoice of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**charge_model** | **str** | { \"description\" : \"The charge model of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**upgrade_mode** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">immediate</span>\",\"description\":\"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.<br><span class=\\\"label label-default\\\">immediate</span> &mdash; Upgrade will apply at the time the request is made.<br><span class=\\\"label label-default\\\">delayed</span> &mdash; Upgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**downgrade_mode** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">delayed</span>\",\"description\":\"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.<br><span class=\\\"label label-default\\\">immediate</span> &mdash; Downgrade will apply at the time the request is made.<br><span class=\\\"label label-default\\\">delayed</span> &mdash; Downgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**default_quantity** | **int** | { \"description\" : \"The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**min_quantity** | **int** | { \"default\" : \"0\", \"description\" : \"The minimum quantity of the pricing-component.\", \"verbs\":[] } | [optional] -**max_quantity** | **int** | { \"description\" : \"The maximum quantity of the pricing-component.\", \"verbs\":[] } | [optional] -**valid_from** | **datetime** | { \"default\" : \"current time\", \"description\" : \"The DateTime specifying when the pricing-component is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**valid_till** | **datetime** | { \"default\" : \"null\", \"description\" : \"The UTC DateTime specifying when the pricing-component is valid till.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**tiers** | [**list[PricingComponentTier]**](PricingComponentTier.md) | { \"default\" : \"[]\", \"description\" : \"The pricing-component-tiers associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**unit_of_measure** | [**UnitOfMeasure**](UnitOfMeasure.md) | { \"description\" : \"The unit-of-measure associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TieredSetupPricingComponent.md b/docs/TieredSetupPricingComponent.md new file mode 100644 index 0000000..09329ae --- /dev/null +++ b/docs/TieredSetupPricingComponent.md @@ -0,0 +1,16 @@ +# TieredSetupPricingComponent + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**display_name** | **str** | | [optional] +**unit** | **str** | | [optional] +**invoicing_type** | **str** | | [optional] +**default_quantity** | **int** | | [optional] +**tiers** | [**list[PricingTier]**](PricingTier.md) | | [optional] +**tax_code** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TieredUsagePricingComponent.md b/docs/TieredUsagePricingComponent.md new file mode 100644 index 0000000..515093f --- /dev/null +++ b/docs/TieredUsagePricingComponent.md @@ -0,0 +1,16 @@ +# TieredUsagePricingComponent + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**display_name** | **str** | | [optional] +**upgrade_mode** | **str** | | [optional] +**downgrade_mode** | **str** | | [optional] +**unit** | **str** | | [optional] +**tiers** | [**list[PricingTier]**](PricingTier.md) | | [optional] +**tax_code** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TieredVolumePricingComponent.md b/docs/TieredVolumePricingComponent.md index 4765c7d..4dfef3c 100644 --- a/docs/TieredVolumePricingComponent.md +++ b/docs/TieredVolumePricingComponent.md @@ -3,32 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**version_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**crm_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } When associating a pricing component with a product rate plan, this ID should be used. | -**product_rate_plan_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**unit_of_measure_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | -**name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**public_name** | **str** | {\"description\":\"A friendly non-unique name used to identify this pricing-component\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**description** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**charge_type** | **str** | { \"description\" : \"The charge type of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**invoicing_type** | **str** | { \"default\" : \"Aggregated\", \"description\" : \"For <span class=\\\"label label-default\\\">setup</span> pricing components <span class=\\\"label label-default\\\">Immediate</span> invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. <span class=\\\"label label-default\\\">Aggregated</span> invoicing will add a charge to the first invoice of the subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**charge_model** | **str** | { \"description\" : \"The charge model of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**upgrade_mode** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">immediate</span>\",\"description\":\"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.<br><span class=\\\"label label-default\\\">immediate</span> &mdash; Upgrade will apply at the time the request is made.<br><span class=\\\"label label-default\\\">delayed</span> &mdash; Upgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**downgrade_mode** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">delayed</span>\",\"description\":\"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.<br><span class=\\\"label label-default\\\">immediate</span> &mdash; Downgrade will apply at the time the request is made.<br><span class=\\\"label label-default\\\">delayed</span> &mdash; Downgrade will apply at the end of the current billing cycle.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**default_quantity** | **int** | { \"description\" : \"The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**min_quantity** | **int** | { \"default\" : \"0\", \"description\" : \"The minimum quantity of the pricing-component.\", \"verbs\":[] } | [optional] -**max_quantity** | **int** | { \"description\" : \"The maximum quantity of the pricing-component.\", \"verbs\":[] } | [optional] -**valid_from** | **datetime** | { \"default\" : \"current time\", \"description\" : \"The DateTime specifying when the pricing-component is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**valid_till** | **datetime** | { \"default\" : \"null\", \"description\" : \"The UTC DateTime specifying when the pricing-component is valid till.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**tiers** | [**list[PricingComponentTier]**](PricingComponentTier.md) | { \"default\" : \"[]\", \"description\" : \"The pricing-component-tiers associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**unit_of_measure** | [**UnitOfMeasure**](UnitOfMeasure.md) | { \"description\" : \"The unit-of-measure associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TimeApi.md b/docs/TimeApi.md deleted file mode 100644 index 2af158d..0000000 --- a/docs/TimeApi.md +++ /dev/null @@ -1,56 +0,0 @@ -# billforward.TimeApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_time_swagger**](TimeApi.md#get_time_swagger) | **GET** /time/swagger-end-point | - - -# **get_time_swagger** -> TimeResponsePagedMetadata get_time_swagger(request) - - - -{\"nickname\":\"\",\"request\":\"advanceSubscriptionRequest.html\",\"response\":\"advanceSubscription.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.TimeApi() -request = billforward.TimeRequest() # TimeRequest | The request - -try: - # - api_response = api_instance.get_time_swagger(request) - pprint(api_response) -except ApiException as e: - print "Exception when calling TimeApi->get_time_swagger: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **request** | [**TimeRequest**](TimeRequest.md)| The request | - -### Return type - -[**TimeResponsePagedMetadata**](TimeResponsePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/TimeRequest.md b/docs/TimeRequest.md index 96f758c..83efbdd 100644 --- a/docs/TimeRequest.md +++ b/docs/TimeRequest.md @@ -3,16 +3,18 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**periods** | **int** | {\"description\":\"(Required: one of [`periods`, `to`])<br>The number of period boundaries up to which the subscription should advance. A 1-value advances the subscription to the end of its current service period. Higher values advance the subscription to subsequent period boundaries.\"verbs\":[\"POST\",\"GET\"]} | [optional] -**to** | **datetime** | {\"description\":\"(Required: one of [`periods`, `to`])<br>The time up until which the subscription should be fast-forwarded.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**dry_run** | **bool** | {\"default\":false,\"description\":\"Changes described in the response:<br><span class=\\\"label label-default\\\">true</span> &mdash; Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.<br><span class=\\\"label label-default\\\">false</span> &mdash; Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**skip_intermediate_periods** | **bool** | {\"default\":false,\"description\":\"As time scrubs forward:<br><span class=\\\"label label-default\\\">true</span> &mdash; Raise no invoice upon advancing over a period boundary.<br><span class=\\\"label label-default\\\">false</span> &mdash; Raise invoices for any period that is entered.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**handle_amendments** | **bool** | {\"default\":true,\"description\":\"As time scrubs forward:<br><span class=\\\"label label-default\\\">true</span> &mdash; Run any amendments that were scheduled to action.<br><span class=\\\"label label-default\\\">false</span> &mdash; Do not run any amendments that were scheduled to action.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**execution_strategy** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">SingleAttempt</span>\",\"description\":\"What strategy to use when executing any invoices raised as time advances:<br><span class=\\\"label label-default\\\">SingleAttempt</span> &mdash; Execute any invoice just once.<br><span class=\\\"label label-default\\\">FollowDunning</span> &mdash; Apply the existing dunning strategy when executing invoices.<br><span class=\\\"label label-default\\\">None</span>: Do not execute invoices.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**freeze_on_completion** | **bool** | {\"default\":false,\"description\":\"Once the subscription is advanced through time:<br><span class=\\\"label label-default\\\">true</span> &mdash; Freeze the subscription.<br><span class=\\\"label label-default\\\">false</span> &mdash; Do not freeze the subscription.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**advance_inclusively** | **bool** | {\"default\":true,\"description\":\"When advancing onto an instant in time:<br><span class=\\\"label label-default\\\">true</span> &mdash; Action the events scheduled for your destination time. Amendments scheduled at your destined time will be actioned during this time travel. Advancing to a period boundary will promote your subscription to the period on the future side of that boundary.<br><span class=\\\"label label-default\\\">false</span> &mdash; Do not action events scheduled for your destination time. Amendments scheduled at your destined time will not be actioned during this time travel. Advancing to a period boundary will result in your subscription's remaining within the period on the past side of that boundary.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] +**created** | **datetime** | | [optional] +**periods** | **int** | | [optional] +**to** | **datetime** | | [optional] +**dry_run** | **bool** | | [optional] +**skip_intermediate_periods** | **bool** | | [optional] +**handle_child_subscriptions** | **bool** | | [optional] +**handle_amendments** | **bool** | | [optional] +**execution_strategy** | **str** | | [optional] +**freeze_on_completion** | **bool** | | [optional] +**organization_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**advance_inclusively** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TimeResponse.md b/docs/TimeResponse.md index a4cbf4e..197796b 100644 --- a/docs/TimeResponse.md +++ b/docs/TimeResponse.md @@ -3,18 +3,20 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**periods** | **int** | {\"description\":\"(Required: one of [`periods`, `to`])<br>The number of period boundaries up to which the subscription should advance. A 1-value advances the subscription to the end of its current service period. Higher values advance the subscription to subsequent period boundaries.\"verbs\":[\"POST\",\"GET\"]} | [optional] -**to** | **datetime** | {\"description\":\"(Required: one of [`periods`, `to`])<br>The time up until which the subscription should be fast-forwarded.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**dry_run** | **bool** | {\"default\":false,\"description\":\"Changes described in the response:<br><span class=\\\"label label-default\\\">true</span> &mdash; Are not actually performed; your subscription remains unchanged, no billing events run, and no invoices are executed.<br><span class=\\\"label label-default\\\">false</span> &mdash; Are actually performed and committed.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**skip_intermediate_periods** | **bool** | {\"default\":false,\"description\":\"As time scrubs forward:<br><span class=\\\"label label-default\\\">true</span> &mdash; Raise no invoice upon advancing over a period boundary.<br><span class=\\\"label label-default\\\">false</span> &mdash; Raise invoices for any period that is entered.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**handle_amendments** | **bool** | {\"default\":true,\"description\":\"As time scrubs forward:<br><span class=\\\"label label-default\\\">true</span> &mdash; Run any amendments that were scheduled to action.<br><span class=\\\"label label-default\\\">false</span> &mdash; Do not run any amendments that were scheduled to action.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**execution_strategy** | **str** | {\"default\":\"<span class=\\\"label label-default\\\">SingleAttempt</span>\",\"description\":\"What strategy to use when executing any invoices raised as time advances:<br><span class=\\\"label label-default\\\">SingleAttempt</span> &mdash; Execute any invoice just once.<br><span class=\\\"label label-default\\\">FollowDunning</span> &mdash; Apply the existing dunning strategy when executing invoices.<br><span class=\\\"label label-default\\\">None</span>: Do not execute invoices.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] -**freeze_on_completion** | **bool** | {\"default\":false,\"description\":\"Once the subscription is advanced through time:<br><span class=\\\"label label-default\\\">true</span> &mdash; Freeze the subscription.<br><span class=\\\"label label-default\\\">false</span> &mdash; Do not freeze the subscription.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] -**advance_inclusively** | **bool** | {\"default\":true,\"description\":\"When advancing onto an instant in time:<br><span class=\\\"label label-default\\\">true</span> &mdash; Action the events scheduled for your destination time. Amendments scheduled at your destined time will be actioned during this time travel. Advancing to a period boundary will promote your subscription to the period on the future side of that boundary.<br><span class=\\\"label label-default\\\">false</span> &mdash; Do not action events scheduled for your destination time. Amendments scheduled at your destined time will not be actioned during this time travel. Advancing to a period boundary will result in your subscription's remaining within the period on the past side of that boundary.\",\"verbs\":[\"POST\",\"GET\"]} | [optional] [default to False] +**created** | **datetime** | | [optional] +**periods** | **int** | | [optional] +**to** | **datetime** | | [optional] +**dry_run** | **bool** | | [optional] +**skip_intermediate_periods** | **bool** | | [optional] +**handle_child_subscriptions** | **bool** | | [optional] +**handle_amendments** | **bool** | | [optional] +**execution_strategy** | **str** | | [optional] +**freeze_on_completion** | **bool** | | [optional] +**organization_id** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**advance_inclusively** | **bool** | | [optional] **subscriptions** | [**list[Subscription]**](Subscription.md) | | [optional] **invoices** | [**list[Invoice]**](Invoice.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TimeResponsePagedMetadata.md b/docs/TimeResponsePagedMetadata.md deleted file mode 100644 index 36b6c2c..0000000 --- a/docs/TimeResponsePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# TimeResponsePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[TimeResponse]**](TimeResponse.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TimerAmendment.md b/docs/TimerAmendment.md index 644cd28..8ffd9c8 100644 --- a/docs/TimerAmendment.md +++ b/docs/TimerAmendment.md @@ -3,26 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] **entity_id** | **str** | | [optional] **entity** | **str** | | [optional] -**offset_direction** | **str** | | [optional] -**offset_period** | **str** | | [optional] **offset_duration** | **int** | | [optional] +**offset_period** | **str** | | [optional] +**offset_direction** | **str** | | [optional] **original_event_date** | **datetime** | | [optional] **timer_event** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/TokenizationApi.md b/docs/TokenizationApi.md index 8df9a2f..0606c8c 100644 --- a/docs/TokenizationApi.md +++ b/docs/TokenizationApi.md @@ -1,88 +1,113 @@ # billforward.TokenizationApi -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**auth_capture**](TokenizationApi.md#auth_capture) | **POST** /tokenization/auth-capture | [Note: this API can be invoked more simply by our client-side card capture library, <a href=\"https://github.com/billforward/billforward-js\">BillForward.js</a>; you should not need to interact with this API manually unless you have particularly bespoke requirements] -[**braintree_card_capture**](TokenizationApi.md#braintree_card_capture) | **POST** /tokenization/braintree | [Warning: for use only in PCI-compliant environments; for more information, <a href=\"mailto:support@billforward.net\">contact us</a> regarding provisioning of your own on-premise BillForward instance] Captures raw credit card details into Braintree's vault. -[**pay_vision_shout_v1**](TokenizationApi.md#pay_vision_shout_v1) | **POST** /tokenization/payvision-shout-v1 | [Note: this API is intended to be invoked by the PayVision servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. -[**pre_auth**](TokenizationApi.md#pre_auth) | **POST** /tokenization/pre-auth | [Note: this API can be invoked more simply by our client-side card capture library, <a href=\"https://github.com/billforward/billforward-js\">BillForward.js</a>; you should not need to interact with this API manually unless you have particularly bespoke requirements] -[**sage_pay_notify_v300**](TokenizationApi.md#sage_pay_notify_v300) | **POST** /tokenization/sagepay-notify-v3-00 | [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of receiving a callback from a SagePay card capture operation, using SagePay's FORM Protocol, v3.0] Handles SagePay Notification. -[**sage_pay_shout_v300**](TokenizationApi.md#sage_pay_shout_v300) | **GET** /tokenization/sagepay-shout-v3-00 | [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe, using SagePay's FORM Protocol, v3.0] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. - +[**auth_capture**](TokenizationApi.md#auth_capture) | **POST** /tokenization/auth-capture | +[**braintree_card_capture**](TokenizationApi.md#braintree_card_capture) | **POST** /tokenization/braintree | +[**create_authorize_net_token**](TokenizationApi.md#create_authorize_net_token) | **POST** /vaulted-gateways/authorize-net | +[**create_braintree_token**](TokenizationApi.md#create_braintree_token) | **POST** /vaulted-gateways/braintree | +[**create_stripe_ach_token**](TokenizationApi.md#create_stripe_ach_token) | **POST** /vaulted-gateways/stripe-ACH | +[**create_stripe_token**](TokenizationApi.md#create_stripe_token) | **POST** /vaulted-gateways/stripe | +[**create_trust_commerce_token**](TokenizationApi.md#create_trust_commerce_token) | **POST** /vaulted-gateways/trustCommerce | +[**display_card_capture_form**](TokenizationApi.md#display_card_capture_form) | **GET** /tokenization/card-capture-form | +[**epx_card_capture**](TokenizationApi.md#epx_card_capture) | **POST** /tokenization/epx | +[**epx_pre_auth**](TokenizationApi.md#epx_pre_auth) | **POST** /tokenization/epx-pre-auth | +[**epx_pre_auth_response**](TokenizationApi.md#epx_pre_auth_response) | **POST** /tokenization/epx-redirect | +[**expire_email_redirect_capture**](TokenizationApi.md#expire_email_redirect_capture) | **DELETE** /tokenization/email-redirect/{id} | +[**get_all_email_redirect_capture**](TokenizationApi.md#get_all_email_redirect_capture) | **GET** /tokenization/email-redirect | +[**get_braintree_by_account_id**](TokenizationApi.md#get_braintree_by_account_id) | **GET** /vaulted-gateways/braintree/{accountID} | +[**get_by_card_details_id**](TokenizationApi.md#get_by_card_details_id) | **GET** /vaulted-gateways/stripe/card-details-id/{cardDetailsID} | +[**get_email_redirect_capture**](TokenizationApi.md#get_email_redirect_capture) | **GET** /tokenization/email-redirect/{id} | +[**get_email_redirect_capture_invoice_html**](TokenizationApi.md#get_email_redirect_capture_invoice_html) | **GET** /tokenization/email-redirect/{id}/invoice.html | +[**get_stripe_ach**](TokenizationApi.md#get_stripe_ach) | **GET** /vaulted-gateways/stripe-ACH/{stripeACHTokenID} | +[**get_stripe_token**](TokenizationApi.md#get_stripe_token) | **GET** /vaulted-gateways/stripe/{stripeTokenID} | +[**go_cardless_bank_account_capture**](TokenizationApi.md#go_cardless_bank_account_capture) | **POST** /tokenization/direct-debit | +[**pay_vision_shout_v1**](TokenizationApi.md#pay_vision_shout_v1) | **POST** /tokenization/payvision-shout-v1 | +[**pre_auth**](TokenizationApi.md#pre_auth) | **POST** /tokenization/pre-auth | +[**sage_pay_notify_v300**](TokenizationApi.md#sage_pay_notify_v300) | **POST** /tokenization/sagepay-notify-v3-00 | +[**sage_pay_shout_v300**](TokenizationApi.md#sage_pay_shout_v300) | **GET** /tokenization/sagepay-shout-v3-00 | +[**send_email_redirect_capture**](TokenizationApi.md#send_email_redirect_capture) | **POST** /tokenization/email-redirect/{id}/send | +[**start_email_redirect_capture**](TokenizationApi.md#start_email_redirect_capture) | **POST** /tokenization/email-redirect | +[**stripe_ach_bank_account_capture**](TokenizationApi.md#stripe_ach_bank_account_capture) | **POST** /tokenization/ach | +[**stripe_web_hook**](TokenizationApi.md#stripe_web_hook) | **POST** /vaulted-gateways/stripe/webhook | +[**update_email_redirect_capture**](TokenizationApi.md#update_email_redirect_capture) | **PUT** /tokenization/email-redirect/{id} | +[**update_profile_with_token**](TokenizationApi.md#update_profile_with_token) | **PUT** /tokenization/profile | +[**update_stripe_ach_token**](TokenizationApi.md#update_stripe_ach_token) | **PUT** /vaulted-gateways/stripe-ACH | +[**update_stripe_token**](TokenizationApi.md#update_stripe_token) | **PUT** /vaulted-gateways/stripe | +[**zooz_card_capture**](TokenizationApi.md#zooz_card_capture) | **POST** /tokenization/zooz | +[**zooz_web_hook**](TokenizationApi.md#zooz_web_hook) | **POST** /vaulted-gateways/zooz/webhook | # **auth_capture** -> PaymentMethodPagedMetadata auth_capture(auth_capture_request) +> InlineResponseDefault40 auth_capture(body=body) -[Note: this API can be invoked more simply by our client-side card capture library, BillForward.js; you should not need to interact with this API manually unless you have particularly bespoke requirements] -{\"nickname\":\"Authorized card capture\",\"response\":\"BFJSAuthCapture.html\",\"request\":\"BFJSAuthCapture.request.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.TokenizationApi() -auth_capture_request = billforward.AuthCaptureRequest() # AuthCaptureRequest | The auth capture request. +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.AuthCaptureRequest() # AuthCaptureRequest | (optional) -try: - # [Note: this API can be invoked more simply by our client-side card capture library, BillForward.js; you should not need to interact with this API manually unless you have particularly bespoke requirements] - api_response = api_instance.auth_capture(auth_capture_request) +try: + api_response = api_instance.auth_capture(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling TokenizationApi->auth_capture: %s\n" % e + print("Exception when calling TokenizationApi->auth_capture: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **auth_capture_request** | [**AuthCaptureRequest**](AuthCaptureRequest.md)| The auth capture request. | + **body** | [**AuthCaptureRequest**](AuthCaptureRequest.md)| | [optional] ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +[**InlineResponseDefault40**](InlineResponseDefault40.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **braintree_card_capture** -> PaymentMethodPagedMetadata braintree_card_capture(body=body) +> InlineResponseDefault40 braintree_card_capture(body=body) -[Warning: for use only in PCI-compliant environments; for more information, contact us regarding provisioning of your own on-premise BillForward instance] Captures raw credit card details into Braintree's vault. -{\"nickname\":\"Braintree Tokenization\",\"response\":\"braintreeDirectTokenization.html\",\"request\":\"braintreeDirectTokenization.request.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.TokenizationApi() +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) body = billforward.BraintreeCaptureRequest() # BraintreeCaptureRequest | (optional) -try: - # [Warning: for use only in PCI-compliant environments; for more information, contact us regarding provisioning of your own on-premise BillForward instance] Captures raw credit card details into Braintree's vault. +try: api_response = api_instance.braintree_card_capture(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling TokenizationApi->braintree_card_capture: %s\n" % e + print("Exception when calling TokenizationApi->braintree_card_capture: %s\n" % e) ``` ### Parameters @@ -93,11 +118,11 @@ Name | Type | Description | Notes ### Return type -[**PaymentMethodPagedMetadata**](PaymentMethodPagedMetadata.md) +[**InlineResponseDefault40**](InlineResponseDefault40.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -106,231 +131,1597 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **pay_vision_shout_v1** -> str pay_vision_shout_v1(_resource_path=_resource_path, id=id) +# **create_authorize_net_token** +> InlineResponseDefault93 create_authorize_net_token(body=body) -[Note: this API is intended to be invoked by the PayVision servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. -{\"nickname\":\"Generate PayVision iframe redirect\",\"response\":\"payVisionShoutV1.html\",\"request\":\"payVisionShoutV1.request.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.TokenizationApi() -_resource_path = '_resource_path_example' # str | (optional) -id = 'id_example' # str | (optional) +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.AuthorizeNetToken() # AuthorizeNetToken | (optional) -try: - # [Note: this API is intended to be invoked by the PayVision servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. - api_response = api_instance.pay_vision_shout_v1(_resource_path=_resource_path, id=id) +try: + api_response = api_instance.create_authorize_net_token(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling TokenizationApi->pay_vision_shout_v1: %s\n" % e + print("Exception when calling TokenizationApi->create_authorize_net_token: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **_resource_path** | **str**| | [optional] - **id** | **str**| | [optional] + **body** | [**AuthorizeNetToken**](AuthorizeNetToken.md)| | [optional] ### Return type -**str** +[**InlineResponseDefault93**](InlineResponseDefault93.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: text/html + - **Content-Type**: application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **pre_auth** -> TokenizationPreAuthPagedMetadata pre_auth(pre_auth_request) +# **create_braintree_token** +> InlineResponseDefault94 create_braintree_token(body=body) -[Note: this API can be invoked more simply by our client-side card capture library, BillForward.js; you should not need to interact with this API manually unless you have particularly bespoke requirements] -{\"nickname\":\"Pre-authorize card capture\",\"response\":\"BFJSPreAuth.html\",\"request\":\"BFJSPreAuth.request.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.TokenizationApi() -pre_auth_request = billforward.InsertableBillingEntity() # InsertableBillingEntity | The auth request. +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.BraintreeToken() # BraintreeToken | (optional) -try: - # [Note: this API can be invoked more simply by our client-side card capture library, BillForward.js; you should not need to interact with this API manually unless you have particularly bespoke requirements] - api_response = api_instance.pre_auth(pre_auth_request) +try: + api_response = api_instance.create_braintree_token(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling TokenizationApi->pre_auth: %s\n" % e + print("Exception when calling TokenizationApi->create_braintree_token: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **pre_auth_request** | [**InsertableBillingEntity**](InsertableBillingEntity.md)| The auth request. | + **body** | [**BraintreeToken**](BraintreeToken.md)| | [optional] ### Return type -[**TokenizationPreAuthPagedMetadata**](TokenizationPreAuthPagedMetadata.md) +[**InlineResponseDefault94**](InlineResponseDefault94.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **sage_pay_notify_v300** -> str sage_pay_notify_v300(organizations=organizations, bill_forward_url_root=bill_forward_url_root, access_token=access_token, vps_protocol=vps_protocol, tx_type=tx_type, vendor_tx_code=vendor_tx_code, status=status, vps_tx_id=vps_tx_id, card_type=card_type, token=token, status_detail=status_detail, last4_digits=last4_digits, vps_signature=vps_signature, expiry_date=expiry_date) +# **create_stripe_ach_token** +> InlineResponseDefault95 create_stripe_ach_token(body=body) -[Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of receiving a callback from a SagePay card capture operation, using SagePay's FORM Protocol, v3.0] Handles SagePay Notification. -{\"nickname\":\"Handle SagePay Notification\",\"response\":\"sagePayNotifyV3_00.html\",\"request\":\"sagePayNotifyV3_00.request.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.TokenizationApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the queryparameter. Example: ...&organizations=org1&organizations=org2 (optional) -bill_forward_url_root = 'bill_forward_url_root_example' # str | The URL through which BFJS connected to BillForward. (optional) -access_token = 'access_token_example' # str | The public token through which BFJS connected to BillForward. (optional) -vps_protocol = 'vps_protocol_example' # str | (optional) -tx_type = 'tx_type_example' # str | (optional) -vendor_tx_code = 'vendor_tx_code_example' # str | (optional) -status = 'status_example' # str | (optional) -vps_tx_id = 'vps_tx_id_example' # str | (optional) -card_type = 'card_type_example' # str | (optional) -token = 'token_example' # str | (optional) -status_detail = 'status_detail_example' # str | (optional) -last4_digits = 'last4_digits_example' # str | (optional) -vps_signature = 'vps_signature_example' # str | (optional) -expiry_date = 'expiry_date_example' # str | (optional) +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.StripeAchToken() # StripeAchToken | (optional) -try: - # [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of receiving a callback from a SagePay card capture operation, using SagePay's FORM Protocol, v3.0] Handles SagePay Notification. - api_response = api_instance.sage_pay_notify_v300(organizations=organizations, bill_forward_url_root=bill_forward_url_root, access_token=access_token, vps_protocol=vps_protocol, tx_type=tx_type, vendor_tx_code=vendor_tx_code, status=status, vps_tx_id=vps_tx_id, card_type=card_type, token=token, status_detail=status_detail, last4_digits=last4_digits, vps_signature=vps_signature, expiry_date=expiry_date) +try: + api_response = api_instance.create_stripe_ach_token(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling TokenizationApi->sage_pay_notify_v300: %s\n" % e + print("Exception when calling TokenizationApi->create_stripe_ach_token: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the queryparameter. Example: ...&organizations=org1&organizations=org2 | [optional] - **bill_forward_url_root** | **str**| The URL through which BFJS connected to BillForward. | [optional] - **access_token** | **str**| The public token through which BFJS connected to BillForward. | [optional] - **vps_protocol** | **str**| | [optional] - **tx_type** | **str**| | [optional] - **vendor_tx_code** | **str**| | [optional] - **status** | **str**| | [optional] - **vps_tx_id** | **str**| | [optional] - **card_type** | **str**| | [optional] - **token** | **str**| | [optional] - **status_detail** | **str**| | [optional] - **last4_digits** | **str**| | [optional] - **vps_signature** | **str**| | [optional] - **expiry_date** | **str**| | [optional] + **body** | [**StripeAchToken**](StripeAchToken.md)| | [optional] + +### Return type + +[**InlineResponseDefault95**](InlineResponseDefault95.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_stripe_token** +> InlineResponseDefault96 create_stripe_token(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.StripeToken() # StripeToken | (optional) + +try: + api_response = api_instance.create_stripe_token(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->create_stripe_token: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**StripeToken**](StripeToken.md)| | [optional] + +### Return type + +[**InlineResponseDefault96**](InlineResponseDefault96.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **create_trust_commerce_token** +> InlineResponseDefault97 create_trust_commerce_token(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.TrustCommerceToken() # TrustCommerceToken | (optional) + +try: + api_response = api_instance.create_trust_commerce_token(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->create_trust_commerce_token: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**TrustCommerceToken**](TrustCommerceToken.md)| | [optional] + +### Return type + +[**InlineResponseDefault97**](InlineResponseDefault97.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **display_card_capture_form** +> display_card_capture_form(organizations=organizations, account_id=account_id) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +account_id = 'account_id_example' # str | (optional) + +try: + api_instance.display_card_capture_form(organizations=organizations, account_id=account_id) +except ApiException as e: + print("Exception when calling TokenizationApi->display_card_capture_form: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **account_id** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **epx_card_capture** +> InlineResponseDefault40 epx_card_capture(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.EpxCaptureRequest() # EpxCaptureRequest | (optional) + +try: + api_response = api_instance.epx_card_capture(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->epx_card_capture: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**EpxCaptureRequest**](EpxCaptureRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault40**](InlineResponseDefault40.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **epx_pre_auth** +> InlineResponseDefault79 epx_pre_auth(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.EpxPreAuthRequest() # EpxPreAuthRequest | (optional) + +try: + api_response = api_instance.epx_pre_auth(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->epx_pre_auth: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**EpxPreAuthRequest**](EpxPreAuthRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault79**](InlineResponseDefault79.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **epx_pre_auth_response** +> epx_pre_auth_response(cust_nbr=cust_nbr, merch_nbr=merch_nbr, dba_nbr=dba_nbr, terminal_nbr=terminal_nbr, tran_code=tran_code, amount=amount, auth_account=auth_account, first_name=first_name, last_name=last_name, exp_date=exp_date, bp_resp_code=bp_resp_code, bp_resp_text=bp_resp_text, bp_field_errors=bp_field_errors, msg_version=msg_version, tran_type=tran_type, tran_nbr=tran_nbr, local_date=local_date, local_time=local_time, auth_guid=auth_guid, auth_resp=auth_resp, auth_code=auth_code, auth_cvv2=auth_cvv2, auth_resp_text=auth_resp_text, auth_card_type=auth_card_type, auth_tran_date_gmt=auth_tran_date_gmt, auth_amount_requested=auth_amount_requested, auth_amount=auth_amount, auth_currency_code=auth_currency_code, network_response=network_response, auth_masked_account_nbr=auth_masked_account_nbr, user_data_9=user_data_9, user_data_10=user_data_10) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +cust_nbr = 'cust_nbr_example' # str | (optional) +merch_nbr = 'merch_nbr_example' # str | (optional) +dba_nbr = 'dba_nbr_example' # str | (optional) +terminal_nbr = 'terminal_nbr_example' # str | (optional) +tran_code = 'tran_code_example' # str | (optional) +amount = 'amount_example' # str | (optional) +auth_account = 'auth_account_example' # str | (optional) +first_name = 'first_name_example' # str | (optional) +last_name = 'last_name_example' # str | (optional) +exp_date = 'exp_date_example' # str | (optional) +bp_resp_code = 'bp_resp_code_example' # str | (optional) +bp_resp_text = 'bp_resp_text_example' # str | (optional) +bp_field_errors = 'bp_field_errors_example' # str | (optional) +msg_version = 'msg_version_example' # str | (optional) +tran_type = 'tran_type_example' # str | (optional) +tran_nbr = 'tran_nbr_example' # str | (optional) +local_date = 'local_date_example' # str | (optional) +local_time = 'local_time_example' # str | (optional) +auth_guid = 'auth_guid_example' # str | (optional) +auth_resp = 'auth_resp_example' # str | (optional) +auth_code = 'auth_code_example' # str | (optional) +auth_cvv2 = 'auth_cvv2_example' # str | (optional) +auth_resp_text = 'auth_resp_text_example' # str | (optional) +auth_card_type = 'auth_card_type_example' # str | (optional) +auth_tran_date_gmt = 'auth_tran_date_gmt_example' # str | (optional) +auth_amount_requested = 'auth_amount_requested_example' # str | (optional) +auth_amount = 'auth_amount_example' # str | (optional) +auth_currency_code = 'auth_currency_code_example' # str | (optional) +network_response = 'network_response_example' # str | (optional) +auth_masked_account_nbr = 'auth_masked_account_nbr_example' # str | (optional) +user_data_9 = 'user_data_9_example' # str | (optional) +user_data_10 = 'user_data_10_example' # str | (optional) + +try: + api_instance.epx_pre_auth_response(cust_nbr=cust_nbr, merch_nbr=merch_nbr, dba_nbr=dba_nbr, terminal_nbr=terminal_nbr, tran_code=tran_code, amount=amount, auth_account=auth_account, first_name=first_name, last_name=last_name, exp_date=exp_date, bp_resp_code=bp_resp_code, bp_resp_text=bp_resp_text, bp_field_errors=bp_field_errors, msg_version=msg_version, tran_type=tran_type, tran_nbr=tran_nbr, local_date=local_date, local_time=local_time, auth_guid=auth_guid, auth_resp=auth_resp, auth_code=auth_code, auth_cvv2=auth_cvv2, auth_resp_text=auth_resp_text, auth_card_type=auth_card_type, auth_tran_date_gmt=auth_tran_date_gmt, auth_amount_requested=auth_amount_requested, auth_amount=auth_amount, auth_currency_code=auth_currency_code, network_response=network_response, auth_masked_account_nbr=auth_masked_account_nbr, user_data_9=user_data_9, user_data_10=user_data_10) +except ApiException as e: + print("Exception when calling TokenizationApi->epx_pre_auth_response: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cust_nbr** | **str**| | [optional] + **merch_nbr** | **str**| | [optional] + **dba_nbr** | **str**| | [optional] + **terminal_nbr** | **str**| | [optional] + **tran_code** | **str**| | [optional] + **amount** | **str**| | [optional] + **auth_account** | **str**| | [optional] + **first_name** | **str**| | [optional] + **last_name** | **str**| | [optional] + **exp_date** | **str**| | [optional] + **bp_resp_code** | **str**| | [optional] + **bp_resp_text** | **str**| | [optional] + **bp_field_errors** | **str**| | [optional] + **msg_version** | **str**| | [optional] + **tran_type** | **str**| | [optional] + **tran_nbr** | **str**| | [optional] + **local_date** | **str**| | [optional] + **local_time** | **str**| | [optional] + **auth_guid** | **str**| | [optional] + **auth_resp** | **str**| | [optional] + **auth_code** | **str**| | [optional] + **auth_cvv2** | **str**| | [optional] + **auth_resp_text** | **str**| | [optional] + **auth_card_type** | **str**| | [optional] + **auth_tran_date_gmt** | **str**| | [optional] + **auth_amount_requested** | **str**| | [optional] + **auth_amount** | **str**| | [optional] + **auth_currency_code** | **str**| | [optional] + **network_response** | **str**| | [optional] + **auth_masked_account_nbr** | **str**| | [optional] + **user_data_9** | **str**| | [optional] + **user_data_10** | **str**| | [optional] ### Return type -**str** +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: text/plain + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **sage_pay_shout_v300** -> str sage_pay_shout_v300(organizations=organizations, s=s, t=t, c=c, e=e, l=l, d=d) +# **expire_email_redirect_capture** +> InlineResponseDefault80 expire_email_redirect_capture(id, organizations=organizations) -[Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe, using SagePay's FORM Protocol, v3.0] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. -{\"nickname\":\"Generate SagePay iframe redirect\",\"response\":\"sagePayShoutV3_00.html\",\"request\":\"sagePayShoutV3_00.request.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.TokenizationApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the queryparameter. Example: ...&organizations=org1&organizations=org2 (optional) -s = 's_example' # str | (optional) -t = 't_example' # str | (optional) -c = 'c_example' # str | (optional) -e = 'e_example' # str | (optional) -l = 'l_example' # str | (optional) -d = 'd_example' # str | (optional) +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +id = 'id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - # [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe, using SagePay's FORM Protocol, v3.0] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. - api_response = api_instance.sage_pay_shout_v300(organizations=organizations, s=s, t=t, c=c, e=e, l=l, d=d) +try: + api_response = api_instance.expire_email_redirect_capture(id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling TokenizationApi->sage_pay_shout_v300: %s\n" % e + print("Exception when calling TokenizationApi->expire_email_redirect_capture: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the queryparameter. Example: ...&organizations=org1&organizations=org2 | [optional] - **s** | **str**| | [optional] - **t** | **str**| | [optional] - **c** | **str**| | [optional] - **e** | **str**| | [optional] - **l** | **str**| | [optional] - **d** | **str**| | [optional] + **id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault80**](InlineResponseDefault80.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_email_redirect_capture** +> InlineResponseDefault81 get_all_email_redirect_capture(account_id=account_id, subscription_id=subscription_id, invoice_id=invoice_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | (optional) +subscription_id = 'subscription_id_example' # str | (optional) +invoice_id = 'invoice_id_example' # str | (optional) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_all_email_redirect_capture(account_id=account_id, subscription_id=subscription_id, invoice_id=invoice_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->get_all_email_redirect_capture: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| | [optional] + **subscription_id** | **str**| | [optional] + **invoice_id** | **str**| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault81**](InlineResponseDefault81.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_braintree_by_account_id** +> InlineResponseDefault98 get_braintree_by_account_id(account_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +account_id = 'account_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_braintree_by_account_id(account_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->get_braintree_by_account_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **account_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault98**](InlineResponseDefault98.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_by_card_details_id** +> InlineResponseDefault99 get_by_card_details_id(card_details_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +card_details_id = 'card_details_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_by_card_details_id(card_details_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->get_by_card_details_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **card_details_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault99**](InlineResponseDefault99.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_email_redirect_capture** +> InlineResponseDefault80 get_email_redirect_capture(id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +id = 'id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_email_redirect_capture(id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->get_email_redirect_capture: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault80**](InlineResponseDefault80.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_email_redirect_capture_invoice_html** +> get_email_redirect_capture_invoice_html(id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +id = 'id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_instance.get_email_redirect_capture_invoice_html(id, organizations=organizations) +except ApiException as e: + print("Exception when calling TokenizationApi->get_email_redirect_capture_invoice_html: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stripe_ach** +> InlineResponseDefault100 get_stripe_ach(stripe_ach_token_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +stripe_ach_token_id = 'stripe_ach_token_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_stripe_ach(stripe_ach_token_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->get_stripe_ach: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **stripe_ach_token_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault100**](InlineResponseDefault100.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_stripe_token** +> InlineResponseDefault99 get_stripe_token(stripe_token_id, organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +stripe_token_id = 'stripe_token_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_stripe_token(stripe_token_id, organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->get_stripe_token: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **stripe_token_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] + +### Return type + +[**InlineResponseDefault99**](InlineResponseDefault99.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **go_cardless_bank_account_capture** +> InlineResponseDefault40 go_cardless_bank_account_capture(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.GoCardlessTokenizationRequest() # GoCardlessTokenizationRequest | (optional) + +try: + api_response = api_instance.go_cardless_bank_account_capture(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->go_cardless_bank_account_capture: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**GoCardlessTokenizationRequest**](GoCardlessTokenizationRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault40**](InlineResponseDefault40.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pay_vision_shout_v1** +> pay_vision_shout_v1(_resource_path=_resource_path, id=id) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +_resource_path = '_resource_path_example' # str | (optional) +id = 'id_example' # str | (optional) + +try: + api_instance.pay_vision_shout_v1(_resource_path=_resource_path, id=id) +except ApiException as e: + print("Exception when calling TokenizationApi->pay_vision_shout_v1: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **_resource_path** | **str**| | [optional] + **id** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **pre_auth** +> InlineResponseDefault82 pre_auth(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.TokenizationPreAuthRequest() # TokenizationPreAuthRequest | (optional) + +try: + api_response = api_instance.pre_auth(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->pre_auth: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**TokenizationPreAuthRequest**](TokenizationPreAuthRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault82**](InlineResponseDefault82.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sage_pay_notify_v300** +> sage_pay_notify_v300(vps_protocol=vps_protocol, tx_type=tx_type, vendor_tx_code=vendor_tx_code, status=status, vps_tx_id=vps_tx_id, card_type=card_type, token=token, status_detail=status_detail, last4_digits=last4_digits, vps_signature=vps_signature, expiry_date=expiry_date, organizations=organizations, u=u, access_token=access_token) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +vps_protocol = 'vps_protocol_example' # str | (optional) +tx_type = 'tx_type_example' # str | (optional) +vendor_tx_code = 'vendor_tx_code_example' # str | (optional) +status = 'status_example' # str | (optional) +vps_tx_id = 'vps_tx_id_example' # str | (optional) +card_type = 'card_type_example' # str | (optional) +token = 'token_example' # str | (optional) +status_detail = 'status_detail_example' # str | (optional) +last4_digits = 'last4_digits_example' # str | (optional) +vps_signature = 'vps_signature_example' # str | (optional) +expiry_date = 'expiry_date_example' # str | (optional) +organizations = ['organizations_example'] # list[str] | (optional) +u = 'u_example' # str | (optional) +access_token = 'access_token_example' # str | (optional) + +try: + api_instance.sage_pay_notify_v300(vps_protocol=vps_protocol, tx_type=tx_type, vendor_tx_code=vendor_tx_code, status=status, vps_tx_id=vps_tx_id, card_type=card_type, token=token, status_detail=status_detail, last4_digits=last4_digits, vps_signature=vps_signature, expiry_date=expiry_date, organizations=organizations, u=u, access_token=access_token) +except ApiException as e: + print("Exception when calling TokenizationApi->sage_pay_notify_v300: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **vps_protocol** | **str**| | [optional] + **tx_type** | **str**| | [optional] + **vendor_tx_code** | **str**| | [optional] + **status** | **str**| | [optional] + **vps_tx_id** | **str**| | [optional] + **card_type** | **str**| | [optional] + **token** | **str**| | [optional] + **status_detail** | **str**| | [optional] + **last4_digits** | **str**| | [optional] + **vps_signature** | **str**| | [optional] + **expiry_date** | **str**| | [optional] + **organizations** | [**list[str]**](str.md)| | [optional] + **u** | **str**| | [optional] + **access_token** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sage_pay_shout_v300** +> sage_pay_shout_v300(organizations=organizations, s=s, t=t, c=c, e=e, l=l, d=d) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +s = 's_example' # str | (optional) +t = 't_example' # str | (optional) +c = 'c_example' # str | (optional) +e = 'e_example' # str | (optional) +l = 'l_example' # str | (optional) +d = 'd_example' # str | (optional) + +try: + api_instance.sage_pay_shout_v300(organizations=organizations, s=s, t=t, c=c, e=e, l=l, d=d) +except ApiException as e: + print("Exception when calling TokenizationApi->sage_pay_shout_v300: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **s** | **str**| | [optional] + **t** | **str**| | [optional] + **c** | **str**| | [optional] + **e** | **str**| | [optional] + **l** | **str**| | [optional] + **d** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **send_email_redirect_capture** +> InlineResponseDefault80 send_email_redirect_capture(id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +id = 'id_example' # str | +body = billforward.EmailTokenizationSendAPIRequest() # EmailTokenizationSendAPIRequest | (optional) + +try: + api_response = api_instance.send_email_redirect_capture(id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->send_email_redirect_capture: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **body** | [**EmailTokenizationSendAPIRequest**](EmailTokenizationSendAPIRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault80**](InlineResponseDefault80.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **start_email_redirect_capture** +> InlineResponseDefault80 start_email_redirect_capture(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.EmailTokenizationCreateAPIRequest() # EmailTokenizationCreateAPIRequest | (optional) + +try: + api_response = api_instance.start_email_redirect_capture(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->start_email_redirect_capture: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**EmailTokenizationCreateAPIRequest**](EmailTokenizationCreateAPIRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault80**](InlineResponseDefault80.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **stripe_ach_bank_account_capture** +> InlineResponseDefault40 stripe_ach_bank_account_capture(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.StripeACHCaptureRequest() # StripeACHCaptureRequest | (optional) + +try: + api_response = api_instance.stripe_ach_bank_account_capture(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->stripe_ach_bank_account_capture: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**StripeACHCaptureRequest**](StripeACHCaptureRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault40**](InlineResponseDefault40.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **stripe_web_hook** +> stripe_web_hook(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = 'body_example' # str | (optional) + +try: + api_instance.stripe_web_hook(body=body) +except ApiException as e: + print("Exception when calling TokenizationApi->stripe_web_hook: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**str**](str.md)| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: */* + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_email_redirect_capture** +> InlineResponseDefault80 update_email_redirect_capture(id, body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +id = 'id_example' # str | +body = billforward.EmailTokenizationUpdateAPIRequest() # EmailTokenizationUpdateAPIRequest | (optional) + +try: + api_response = api_instance.update_email_redirect_capture(id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->update_email_redirect_capture: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **body** | [**EmailTokenizationUpdateAPIRequest**](EmailTokenizationUpdateAPIRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault80**](InlineResponseDefault80.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_profile_with_token** +> InlineResponseDefault83 update_profile_with_token(body=body, request_token=request_token) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.Profile() # Profile | (optional) +request_token = 'request_token_example' # str | (optional) + +try: + api_response = api_instance.update_profile_with_token(body=body, request_token=request_token) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->update_profile_with_token: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Profile**](Profile.md)| | [optional] + **request_token** | **str**| | [optional] + +### Return type + +[**InlineResponseDefault83**](InlineResponseDefault83.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_stripe_ach_token** +> InlineResponseDefault95 update_stripe_ach_token(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.StripeAchToken() # StripeAchToken | (optional) + +try: + api_response = api_instance.update_stripe_ach_token(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->update_stripe_ach_token: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**StripeAchToken**](StripeAchToken.md)| | [optional] + +### Return type + +[**InlineResponseDefault95**](InlineResponseDefault95.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_stripe_token** +> InlineResponseDefault96 update_stripe_token(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.StripeToken() # StripeToken | (optional) + +try: + api_response = api_instance.update_stripe_token(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->update_stripe_token: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**StripeToken**](StripeToken.md)| | [optional] + +### Return type + +[**InlineResponseDefault96**](InlineResponseDefault96.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **zooz_card_capture** +> InlineResponseDefault40 zooz_card_capture(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = billforward.ZoozCaptureRequest() # ZoozCaptureRequest | (optional) + +try: + api_response = api_instance.zooz_card_capture(body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling TokenizationApi->zooz_card_capture: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**ZoozCaptureRequest**](ZoozCaptureRequest.md)| | [optional] + +### Return type + +[**InlineResponseDefault40**](InlineResponseDefault40.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **zooz_web_hook** +> zooz_web_hook(body=body) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) +body = 'body_example' # str | (optional) + +try: + api_instance.zooz_web_hook(body=body) +except ApiException as e: + print("Exception when calling TokenizationApi->zooz_web_hook: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**str**](str.md)| | [optional] ### Return type -**str** +void (empty response body) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain - - **Accept**: text/html + - **Content-Type**: */* + - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/TokenizationEpxredirectBody.md b/docs/TokenizationEpxredirectBody.md new file mode 100644 index 0000000..b14a6c3 --- /dev/null +++ b/docs/TokenizationEpxredirectBody.md @@ -0,0 +1,40 @@ +# TokenizationEpxredirectBody + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cust_nbr** | **str** | | [optional] +**merch_nbr** | **str** | | [optional] +**dba_nbr** | **str** | | [optional] +**terminal_nbr** | **str** | | [optional] +**tran_code** | **str** | | [optional] +**amount** | **str** | | [optional] +**auth_account** | **str** | | [optional] +**first_name** | **str** | | [optional] +**last_name** | **str** | | [optional] +**exp_date** | **str** | | [optional] +**bp_resp_code** | **str** | | [optional] +**bp_resp_text** | **str** | | [optional] +**bp_field_errors** | **str** | | [optional] +**msg_version** | **str** | | [optional] +**tran_type** | **str** | | [optional] +**tran_nbr** | **str** | | [optional] +**local_date** | **str** | | [optional] +**local_time** | **str** | | [optional] +**auth_guid** | **str** | | [optional] +**auth_resp** | **str** | | [optional] +**auth_code** | **str** | | [optional] +**auth_cvv2** | **str** | | [optional] +**auth_resp_text** | **str** | | [optional] +**auth_card_type** | **str** | | [optional] +**auth_tran_date_gmt** | **str** | | [optional] +**auth_amount_requested** | **str** | | [optional] +**auth_amount** | **str** | | [optional] +**auth_currency_code** | **str** | | [optional] +**network_response** | **str** | | [optional] +**auth_masked_account_nbr** | **str** | | [optional] +**user_data_9** | **str** | | [optional] +**user_data_10** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TokenizationPayvisionshoutv1Body.md b/docs/TokenizationPayvisionshoutv1Body.md new file mode 100644 index 0000000..01fa4d0 --- /dev/null +++ b/docs/TokenizationPayvisionshoutv1Body.md @@ -0,0 +1,10 @@ +# TokenizationPayvisionshoutv1Body + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_resource_path** | **str** | | [optional] +**id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TokenizationPreAuth.md b/docs/TokenizationPreAuth.md new file mode 100644 index 0000000..3bde446 --- /dev/null +++ b/docs/TokenizationPreAuth.md @@ -0,0 +1,10 @@ +# TokenizationPreAuth + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TokenizationPreAuthPagedMetadata.md b/docs/TokenizationPreAuthPagedMetadata.md deleted file mode 100644 index 7b8126c..0000000 --- a/docs/TokenizationPreAuthPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# TokenizationPreAuthPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TokenizationPreAuthRequest.md b/docs/TokenizationPreAuthRequest.md new file mode 100644 index 0000000..1502f6f --- /dev/null +++ b/docs/TokenizationPreAuthRequest.md @@ -0,0 +1,18 @@ +# TokenizationPreAuthRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**gateway_id** | **str** | | [optional] +**gateway** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**bill_forward_url** | **str** | | [optional] +**bill_forward_public_token** | **str** | | [optional] +**email_tokenization_id** | **str** | | [optional] +**id** | **str** | | [optional] +**type** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TokenizationSagepaynotifyv300Body.md b/docs/TokenizationSagepaynotifyv300Body.md new file mode 100644 index 0000000..647bb08 --- /dev/null +++ b/docs/TokenizationSagepaynotifyv300Body.md @@ -0,0 +1,19 @@ +# TokenizationSagepaynotifyv300Body + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**vps_protocol** | **str** | | [optional] +**tx_type** | **str** | | [optional] +**vendor_tx_code** | **str** | | [optional] +**status** | **str** | | [optional] +**vps_tx_id** | **str** | | [optional] +**card_type** | **str** | | [optional] +**token** | **str** | | [optional] +**status_detail** | **str** | | [optional] +**last4_digits** | **str** | | [optional] +**vps_signature** | **str** | | [optional] +**expiry_date** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TokensResponse.md b/docs/TokensResponse.md new file mode 100644 index 0000000..c5f2580 --- /dev/null +++ b/docs/TokensResponse.md @@ -0,0 +1,10 @@ +# TokensResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**private_token** | [**OAuthToken**](OAuthToken.md) | | [optional] +**public_token** | [**OAuthToken**](OAuthToken.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TrustCommerceConfiguration.md b/docs/TrustCommerceConfiguration.md new file mode 100644 index 0000000..edc1397 --- /dev/null +++ b/docs/TrustCommerceConfiguration.md @@ -0,0 +1,10 @@ +# TrustCommerceConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **str** | | [optional] +**cust_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TrustCommerceToken.md b/docs/TrustCommerceToken.md new file mode 100644 index 0000000..85b890f --- /dev/null +++ b/docs/TrustCommerceToken.md @@ -0,0 +1,17 @@ +# TrustCommerceToken + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**account_id** | **str** | | +**card_details_id** | **str** | | [optional] +**organization_id** | **str** | | +**token_id** | **str** | | +**deleted** | **bool** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TrustCommerceTokenPagedMetadata.md b/docs/TrustCommerceTokenPagedMetadata.md deleted file mode 100644 index 0d504c6..0000000 --- a/docs/TrustCommerceTokenPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# TrustCommerceTokenPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TypedQueryResultWrapperAPIQuote.md b/docs/TypedQueryResultWrapperAPIQuote.md new file mode 100644 index 0000000..52f2ac7 --- /dev/null +++ b/docs/TypedQueryResultWrapperAPIQuote.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperAPIQuote + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**ApiQuote**](ApiQuote.md) | | [optional] +**typed_results** | [**list[ApiQuote]**](ApiQuote.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperAccount.md b/docs/TypedQueryResultWrapperAccount.md new file mode 100644 index 0000000..f5e290f --- /dev/null +++ b/docs/TypedQueryResultWrapperAccount.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperAccount + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Account**](Account.md) | | [optional] +**typed_results** | [**list[Account]**](Account.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperAddress.md b/docs/TypedQueryResultWrapperAddress.md new file mode 100644 index 0000000..5c2c03a --- /dev/null +++ b/docs/TypedQueryResultWrapperAddress.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperAddress + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Address**](Address.md) | | [optional] +**typed_results** | [**list[Address]**](Address.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperAmendment.md b/docs/TypedQueryResultWrapperAmendment.md new file mode 100644 index 0000000..83b6f7c --- /dev/null +++ b/docs/TypedQueryResultWrapperAmendment.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperAmendment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Amendment**](Amendment.md) | | [optional] +**typed_results** | [**list[Amendment]**](Amendment.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperAvataxConfiguration.md b/docs/TypedQueryResultWrapperAvataxConfiguration.md new file mode 100644 index 0000000..adab796 --- /dev/null +++ b/docs/TypedQueryResultWrapperAvataxConfiguration.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperAvataxConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**AvataxConfiguration**](AvataxConfiguration.md) | | [optional] +**typed_results** | [**list[AvataxConfiguration]**](AvataxConfiguration.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperBFPermission.md b/docs/TypedQueryResultWrapperBFPermission.md new file mode 100644 index 0000000..9b14a70 --- /dev/null +++ b/docs/TypedQueryResultWrapperBFPermission.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperBFPermission + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**BFPermission**](BFPermission.md) | | [optional] +**typed_results** | [**list[BFPermission]**](BFPermission.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperBraintreeToken.md b/docs/TypedQueryResultWrapperBraintreeToken.md new file mode 100644 index 0000000..772f140 --- /dev/null +++ b/docs/TypedQueryResultWrapperBraintreeToken.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperBraintreeToken + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**BraintreeToken**](BraintreeToken.md) | | [optional] +**typed_results** | [**list[BraintreeToken]**](BraintreeToken.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperContract.md b/docs/TypedQueryResultWrapperContract.md new file mode 100644 index 0000000..1b4864d --- /dev/null +++ b/docs/TypedQueryResultWrapperContract.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperContract + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Contract**](Contract.md) | | [optional] +**typed_results** | [**list[Contract]**](Contract.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperCoupon.md b/docs/TypedQueryResultWrapperCoupon.md new file mode 100644 index 0000000..d415edd --- /dev/null +++ b/docs/TypedQueryResultWrapperCoupon.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperCoupon + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Coupon**](Coupon.md) | | [optional] +**typed_results** | [**list[Coupon]**](Coupon.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperCreditNote.md b/docs/TypedQueryResultWrapperCreditNote.md new file mode 100644 index 0000000..e871e9a --- /dev/null +++ b/docs/TypedQueryResultWrapperCreditNote.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperCreditNote + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**CreditNote**](CreditNote.md) | | [optional] +**typed_results** | [**list[CreditNote]**](CreditNote.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperDataSyncJobResponse.md b/docs/TypedQueryResultWrapperDataSyncJobResponse.md new file mode 100644 index 0000000..507f715 --- /dev/null +++ b/docs/TypedQueryResultWrapperDataSyncJobResponse.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperDataSyncJobResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**DataSyncJobResponse**](DataSyncJobResponse.md) | | [optional] +**typed_results** | [**list[DataSyncJobResponse]**](DataSyncJobResponse.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperDunningLine.md b/docs/TypedQueryResultWrapperDunningLine.md new file mode 100644 index 0000000..997e706 --- /dev/null +++ b/docs/TypedQueryResultWrapperDunningLine.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperDunningLine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**DunningLine**](DunningLine.md) | | [optional] +**typed_results** | [**list[DunningLine]**](DunningLine.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperInvoice.md b/docs/TypedQueryResultWrapperInvoice.md new file mode 100644 index 0000000..6b32d80 --- /dev/null +++ b/docs/TypedQueryResultWrapperInvoice.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperInvoice + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Invoice**](Invoice.md) | | [optional] +**typed_results** | [**list[Invoice]**](Invoice.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperInvoiceLinePayment.md b/docs/TypedQueryResultWrapperInvoiceLinePayment.md new file mode 100644 index 0000000..b8bdcc4 --- /dev/null +++ b/docs/TypedQueryResultWrapperInvoiceLinePayment.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperInvoiceLinePayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**InvoiceLinePayments**](InvoiceLinePayments.md) | | [optional] +**typed_results** | [**list[InvoiceLinePayments]**](InvoiceLinePayments.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperNotification.md b/docs/TypedQueryResultWrapperNotification.md new file mode 100644 index 0000000..f30da67 --- /dev/null +++ b/docs/TypedQueryResultWrapperNotification.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperNotification + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Notifications**](Notifications.md) | | [optional] +**typed_results** | [**list[Notifications]**](Notifications.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperPayment.md b/docs/TypedQueryResultWrapperPayment.md new file mode 100644 index 0000000..124ef18 --- /dev/null +++ b/docs/TypedQueryResultWrapperPayment.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperPayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Payment**](Payment.md) | | [optional] +**typed_results** | [**list[Payment]**](Payment.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperPaymentMethod.md b/docs/TypedQueryResultWrapperPaymentMethod.md new file mode 100644 index 0000000..95f2933 --- /dev/null +++ b/docs/TypedQueryResultWrapperPaymentMethod.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperPaymentMethod + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**PaymentMethod**](PaymentMethod.md) | | [optional] +**typed_results** | [**list[PaymentMethod]**](PaymentMethod.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperPlanResponse.md b/docs/TypedQueryResultWrapperPlanResponse.md new file mode 100644 index 0000000..1747d30 --- /dev/null +++ b/docs/TypedQueryResultWrapperPlanResponse.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperPlanResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**PlanResponse**](PlanResponse.md) | | [optional] +**typed_results** | [**list[PlanResponse]**](PlanResponse.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperProfile.md b/docs/TypedQueryResultWrapperProfile.md new file mode 100644 index 0000000..d40d646 --- /dev/null +++ b/docs/TypedQueryResultWrapperProfile.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperProfile + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Profile**](Profile.md) | | [optional] +**typed_results** | [**list[Profile]**](Profile.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperReceipt.md b/docs/TypedQueryResultWrapperReceipt.md new file mode 100644 index 0000000..d6a8650 --- /dev/null +++ b/docs/TypedQueryResultWrapperReceipt.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperReceipt + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Receipt**](Receipt.md) | | [optional] +**typed_results** | [**list[Receipt]**](Receipt.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperRefund.md b/docs/TypedQueryResultWrapperRefund.md new file mode 100644 index 0000000..cafa0e3 --- /dev/null +++ b/docs/TypedQueryResultWrapperRefund.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperRefund + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Refund**](Refund.md) | | [optional] +**typed_results** | [**list[Refund]**](Refund.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperRevenueAttribution.md b/docs/TypedQueryResultWrapperRevenueAttribution.md new file mode 100644 index 0000000..b34d270 --- /dev/null +++ b/docs/TypedQueryResultWrapperRevenueAttribution.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperRevenueAttribution + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**RevenueAttributions**](RevenueAttributions.md) | | [optional] +**typed_results** | [**list[RevenueAttributions]**](RevenueAttributions.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperRole.md b/docs/TypedQueryResultWrapperRole.md new file mode 100644 index 0000000..c0558e4 --- /dev/null +++ b/docs/TypedQueryResultWrapperRole.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperRole + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Role**](Role.md) | | [optional] +**typed_results** | [**list[Role]**](Role.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperStripeACHToken.md b/docs/TypedQueryResultWrapperStripeACHToken.md new file mode 100644 index 0000000..1f3fb5d --- /dev/null +++ b/docs/TypedQueryResultWrapperStripeACHToken.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperStripeACHToken + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**StripeAchToken**](StripeAchToken.md) | | [optional] +**typed_results** | [**list[StripeAchToken]**](StripeAchToken.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperStripeToken.md b/docs/TypedQueryResultWrapperStripeToken.md new file mode 100644 index 0000000..26b13e2 --- /dev/null +++ b/docs/TypedQueryResultWrapperStripeToken.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperStripeToken + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**StripeToken**](StripeToken.md) | | [optional] +**typed_results** | [**list[StripeToken]**](StripeToken.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperSubscription.md b/docs/TypedQueryResultWrapperSubscription.md new file mode 100644 index 0000000..b37ef74 --- /dev/null +++ b/docs/TypedQueryResultWrapperSubscription.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperSubscription + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Subscription**](Subscription.md) | | [optional] +**typed_results** | [**list[Subscription]**](Subscription.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperSubscriptionCharge.md b/docs/TypedQueryResultWrapperSubscriptionCharge.md new file mode 100644 index 0000000..f908b5c --- /dev/null +++ b/docs/TypedQueryResultWrapperSubscriptionCharge.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperSubscriptionCharge + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**SubscriptionCharge**](SubscriptionCharge.md) | | [optional] +**typed_results** | [**list[SubscriptionCharge]**](SubscriptionCharge.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperTaxationStrategy.md b/docs/TypedQueryResultWrapperTaxationStrategy.md new file mode 100644 index 0000000..68c97af --- /dev/null +++ b/docs/TypedQueryResultWrapperTaxationStrategy.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperTaxationStrategy + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**TaxationStrategy**](TaxationStrategy.md) | | [optional] +**typed_results** | [**list[TaxationStrategy]**](TaxationStrategy.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperUserResponse.md b/docs/TypedQueryResultWrapperUserResponse.md new file mode 100644 index 0000000..2997f10 --- /dev/null +++ b/docs/TypedQueryResultWrapperUserResponse.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperUserResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**UserResponse**](UserResponse.md) | | [optional] +**typed_results** | [**list[UserResponse]**](UserResponse.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TypedQueryResultWrapperWebhook.md b/docs/TypedQueryResultWrapperWebhook.md new file mode 100644 index 0000000..a80c3b8 --- /dev/null +++ b/docs/TypedQueryResultWrapperWebhook.md @@ -0,0 +1,25 @@ +# TypedQueryResultWrapperWebhook + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_name** | **str** | | [optional] +**total_records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] +**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | | [optional] +**arguments** | **list[str]** | | [optional] +**organizations** | **list[str]** | | [optional] +**types** | **list[str]** | | [optional] +**offset** | **int** | | [optional] +**records** | **int** | | [optional] +**order_by** | **str** | | [optional] +**order_direction** | **str** | | [optional] +**include_retired** | **bool** | | [optional] +**wildcard** | **bool** | | [optional] +**entity** | **bool** | | [optional] +**typed_single_result** | [**Webhook**](Webhook.md) | | [optional] +**typed_results** | [**list[Webhook]**](Webhook.md) | | [optional] +**single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UnitDiscount.md b/docs/UnitDiscount.md deleted file mode 100644 index f1646fc..0000000 --- a/docs/UnitDiscount.md +++ /dev/null @@ -1,13 +0,0 @@ -# UnitDiscount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**unit_value** | **int** | | [optional] -**tier_id** | **str** | | [optional] -**unaltered_value** | **float** | | [optional] -**discount_value** | **float** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UnitOfMeasure.md b/docs/UnitOfMeasure.md index 3cf1bba..92e93de 100644 --- a/docs/UnitOfMeasure.md +++ b/docs/UnitOfMeasure.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**crm_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | -**displayed_as** | **str** | { \"description\" : \"Unit of measurement, such as users, pounds, minutes.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [default to False] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**crm_id** | **str** | | [optional] +**name** | **str** | | +**organization_id** | **str** | | +**displayed_as** | **str** | | +**deleted** | **bool** | | +**rounding** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UnitOfMeasureCouponModifier.md b/docs/UnitOfMeasureCouponModifier.md deleted file mode 100644 index 8f5c44b..0000000 --- a/docs/UnitOfMeasureCouponModifier.md +++ /dev/null @@ -1,24 +0,0 @@ -# UnitOfMeasureCouponModifier - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"ID of the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"ID of the organization associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**coupon_definition_id** | **str** | { \"description\" : \"The unique ID of the coupon-definition associated with the coupon-modifier.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**effect_amount** | **float** | { \"description\" : \"The effect amount for the coupon-modifier. This is affected by the operand field.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**operand** | **str** | { \"description\" : \"The operand field affects the effect amount of the coupon-modifier. If the operand is fixed, it is an exact amount of the currency defined by the coupon-definition. If the operand is percent, this means the coupon will be affecting a percentage of the unaltered cost. E.g. a 25% modifier will apply a 25% discount on a subscription or a pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**effect** | **str** | { \"description\" : \"The effect of the coupon-modifier. The coupon-modifier can affect first, last, and cheapest value of a specific unit-of-measure-id for a subscription. The coupon-modifier can also affect all of the values for a unit-of-measure-id, or can affect all of the subscription cost.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**effect_additional** | **bool** | { \"description\" : \"Specifies whether the coupon-modifier will be affecting only additional units. If this field is set, the coupon-instance-existing-values for the coupon-instance are observed, and any units of the unit-of-measure-id defined by the modifier below the coupon-instance-existing-values for that unit-of-measure-id will be ignored.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] -**specifier_amount** | **int** | { \"description\" : \"The number of units that will be affected by the coupon-modifier, if the domain is set to uom\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**domain** | **str** | { \"description\" : \"The domain of the coupon-modifier\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**specifier** | **str** | { \"description\" : \"The specifier is domain-specific. If the domain is uom, this field is used to limit the coupon-modifier to a specific unit-of-measure-id.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**precedence** | **int** | { \"description\" : \"The precedence of the coupon-modifier. This is used to order application of coupon-modifiers. Higher precedence means the coupon-modifier will be applied before others.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**deleted** | **bool** | { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UnitOfMeasurePagedMetadata.md b/docs/UnitOfMeasurePagedMetadata.md deleted file mode 100644 index de71070..0000000 --- a/docs/UnitOfMeasurePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# UnitOfMeasurePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[UnitOfMeasure]**](UnitOfMeasure.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UnitofmeasureApi.md b/docs/UnitofmeasureApi.md deleted file mode 100644 index d82a3b7..0000000 --- a/docs/UnitofmeasureApi.md +++ /dev/null @@ -1,212 +0,0 @@ -# billforward.UnitofmeasureApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_unit_of_measure**](UnitofmeasureApi.md#create_unit_of_measure) | **POST** /units-of-measure | Create a unit-of-measure. -[**get_all_units_of_measure**](UnitofmeasureApi.md#get_all_units_of_measure) | **GET** /units-of-measure | Returns a collection of all unit-of-measure objects. By default 10 values are returned. Records are returned in natural order. -[**get_unit_of_measure_by_id**](UnitofmeasureApi.md#get_unit_of_measure_by_id) | **GET** /units-of-measure/{unit-of-measure-identifier} | Returns a single unit-of-measure corresponding to the unique id or name specified. -[**update_unit_of_measure**](UnitofmeasureApi.md#update_unit_of_measure) | **PUT** /units-of-measure | Update a unit-of-measure. - - -# **create_unit_of_measure** -> UnitOfMeasurePagedMetadata create_unit_of_measure(unit_of_measure) - -Create a unit-of-measure. - -{\"nickname\":\"Create a new unit of measure\",\"request\":\"createUnitOfMeasureRequest.html\",\"response\":\"createUnitOfMeasureResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UnitofmeasureApi() -unit_of_measure = billforward.UnitOfMeasure() # UnitOfMeasure | The unit-of-measure object to be created. - -try: - # Create a unit-of-measure. - api_response = api_instance.create_unit_of_measure(unit_of_measure) - pprint(api_response) -except ApiException as e: - print "Exception when calling UnitofmeasureApi->create_unit_of_measure: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **unit_of_measure** | [**UnitOfMeasure**](UnitOfMeasure.md)| The unit-of-measure object to be created. | - -### Return type - -[**UnitOfMeasurePagedMetadata**](UnitOfMeasurePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_units_of_measure** -> UnitOfMeasurePagedMetadata get_all_units_of_measure(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of all unit-of-measure objects. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Get all units of measure\",\"response\":\"getUnitOfMeasureAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UnitofmeasureApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first taxation-link to return. (optional) (default to 0) -records = 10 # int | The maximum number of taxation-links to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of all unit-of-measure objects. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_units_of_measure(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling UnitofmeasureApi->get_all_units_of_measure: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first taxation-link to return. | [optional] [default to 0] - **records** | **int**| The maximum number of taxation-links to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**UnitOfMeasurePagedMetadata**](UnitOfMeasurePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_unit_of_measure_by_id** -> UnitOfMeasurePagedMetadata get_unit_of_measure_by_id(unit_of_measure_identifier, organizations=organizations) - -Returns a single unit-of-measure corresponding to the unique id or name specified. - -{\"nickname\":\"Retrieve an existing unit of measure\",\"response\":\"getUnitOfMeasureByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UnitofmeasureApi() -unit_of_measure_identifier = 'unit_of_measure_identifier_example' # str | The unique id or name of the unit-of-measure. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single unit-of-measure corresponding to the unique id or name specified. - api_response = api_instance.get_unit_of_measure_by_id(unit_of_measure_identifier, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling UnitofmeasureApi->get_unit_of_measure_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **unit_of_measure_identifier** | **str**| The unique id or name of the unit-of-measure. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**UnitOfMeasurePagedMetadata**](UnitOfMeasurePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_unit_of_measure** -> UnitOfMeasurePagedMetadata update_unit_of_measure(unit_of_measure) - -Update a unit-of-measure. - -{\"nickname\":\"Update a unit of measure\",\"request\":\"updateUnitOfMeasureRequest.html\",\"response\":\"updateUnitOfMeasureResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UnitofmeasureApi() -unit_of_measure = billforward.UnitOfMeasure() # UnitOfMeasure | The unit-of-measure object to be updated. - -try: - # Update a unit-of-measure. - api_response = api_instance.update_unit_of_measure(unit_of_measure) - pprint(api_response) -except ApiException as e: - print "Exception when calling UnitofmeasureApi->update_unit_of_measure: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **unit_of_measure** | [**UnitOfMeasure**](UnitOfMeasure.md)| The unit-of-measure object to be updated. | - -### Return type - -[**UnitOfMeasurePagedMetadata**](UnitOfMeasurePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/UpdateAddressRequest.md b/docs/UpdateAddressRequest.md deleted file mode 100644 index 8ebfde9..0000000 --- a/docs/UpdateAddressRequest.md +++ /dev/null @@ -1,20 +0,0 @@ -# UpdateAddressRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | | -**profile_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**address_line1** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**address_line2** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**address_line3** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**city** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**province** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**country** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**postcode** | **str** | { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**landline** | **str** | { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**primary_address** | **bool** | { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] [default to False] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UpdateComponentValueAmendment.md b/docs/UpdateComponentValueAmendment.md index 6b3fa96..46df92a 100644 --- a/docs/UpdateComponentValueAmendment.md +++ b/docs/UpdateComponentValueAmendment.md @@ -3,23 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**type** | **str** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } | -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**amendment_type** | **str** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } | -**actioning_time** | **datetime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**actioned_time** | **datetime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional] -**state** | **str** | Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending | -**deleted** | **bool** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to False] -**pricing_component_value_id** | **str** | { \"description\" : \"The consistent ID of the associated pricing-component-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**pricing_component_value_change_id** | **str** | { \"description\" : \"The unique ID of the associated pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**pricing_component_id** | **str** | { \"description\" : \"The consistent ID of the associated pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**value** | **int** | { \"description\" : \"The new value of the pricing-component-value\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | +**pricing_component_value_id** | **str** | | +**pricing_component_value_change_id** | **str** | | [optional] +**pricing_component_id** | **str** | | +**value** | **int** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateContractRequest.md b/docs/UpdateContractRequest.md new file mode 100644 index 0000000..9949993 --- /dev/null +++ b/docs/UpdateContractRequest.md @@ -0,0 +1,17 @@ +# UpdateContractRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**contract** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**start** | **datetime** | | [optional] +**contract_end_behaviour** | **str** | | +**valid_from** | **datetime** | | +**valid_till** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UpdateEmailRequest.md b/docs/UpdateEmailRequest.md new file mode 100644 index 0000000..27f107b --- /dev/null +++ b/docs/UpdateEmailRequest.md @@ -0,0 +1,13 @@ +# UpdateEmailRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **str** | | [optional] +**new_email** | **str** | | [optional] +**confirm_new_email** | **str** | | [optional] +**revoke_old_access_tokens** | **bool** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UpdateInvoiceRequest.md b/docs/UpdateInvoiceRequest.md new file mode 100644 index 0000000..66a2743 --- /dev/null +++ b/docs/UpdateInvoiceRequest.md @@ -0,0 +1,18 @@ +# UpdateInvoiceRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**id** | **str** | | [optional] +**version_id** | **str** | | [optional] +**state** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**purchase_order** | **str** | | [optional] +**payment_terms** | **int** | | [optional] +**payment_amount** | **float** | | [optional] +**due** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UpdateInvoiceTemplateRequest.md b/docs/UpdateInvoiceTemplateRequest.md new file mode 100644 index 0000000..0d15359 --- /dev/null +++ b/docs/UpdateInvoiceTemplateRequest.md @@ -0,0 +1,21 @@ +# UpdateInvoiceTemplateRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**representing_account_id** | **str** | | [optional] +**tier_breakdown** | **bool** | | [optional] +**inclusive_end** | **bool** | | [optional] +**show_zero_cost** | **bool** | | [optional] +**show_plan_only_when_ambiguous** | **bool** | | [optional] +**include_footer** | **bool** | | [optional] +**invoice_header_display** | **str** | | [optional] +**group_invoice_line_items_by** | **str** | | [optional] +**hide_tax_if_zero** | **bool** | | [optional] +**show_unit_price** | **str** | | [optional] +**company_address_on_top** | **bool** | | [optional] +**upgrade_duration_wording** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UpdatePasswordRequest.md b/docs/UpdatePasswordRequest.md new file mode 100644 index 0000000..3cc2bf8 --- /dev/null +++ b/docs/UpdatePasswordRequest.md @@ -0,0 +1,12 @@ +# UpdatePasswordRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**old_password** | **str** | | [optional] +**new_password** | **str** | | [optional] +**confirm_new_password** | **str** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UpdatePasswordResponse.md b/docs/UpdatePasswordResponse.md new file mode 100644 index 0000000..1dd6e1f --- /dev/null +++ b/docs/UpdatePasswordResponse.md @@ -0,0 +1,13 @@ +# UpdatePasswordResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**id** | **str** | | [optional] +**username** | [**list[UsernameResponse]**](UsernameResponse.md) | | [optional] +**organization_id** | **str** | | [optional] +**password_reset_valid_till** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UpdatePricingComponentValueChangeResult.md b/docs/UpdatePricingComponentValueChangeResult.md new file mode 100644 index 0000000..dbb57bd --- /dev/null +++ b/docs/UpdatePricingComponentValueChangeResult.md @@ -0,0 +1,20 @@ +# UpdatePricingComponentValueChangeResult + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pricing_component_id** | **str** | | [optional] +**pricing_component_name** | **str** | | [optional] +**pricing_component_public_name** | **str** | | [optional] +**new_value** | **int** | | [optional] +**old_value** | **int** | | [optional] +**type** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**amount** | **float** | | [optional] +**charge_type** | **str** | | [optional] +**charge** | [**SubscriptionCharge**](SubscriptionCharge.md) | | [optional] +**amendment** | [**Amendment**](Amendment.md) | | [optional] +**state** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UpdatePricingComponentValueRequest.md b/docs/UpdatePricingComponentValueRequest.md new file mode 100644 index 0000000..9b1612a --- /dev/null +++ b/docs/UpdatePricingComponentValueRequest.md @@ -0,0 +1,12 @@ +# UpdatePricingComponentValueRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pricing_component** | **str** | | +**value** | **int** | | +**change_mode** | **str** | | [optional] +**prorate** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UpdatePricingComponentValueResponse.md b/docs/UpdatePricingComponentValueResponse.md new file mode 100644 index 0000000..b66b2d2 --- /dev/null +++ b/docs/UpdatePricingComponentValueResponse.md @@ -0,0 +1,12 @@ +# UpdatePricingComponentValueResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**changes** | [**list[UpdatePricingComponentValueChangeResult]**](UpdatePricingComponentValueChangeResult.md) | | [optional] +**invoice** | [**Invoice**](Invoice.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UpdateProfileRequest.md b/docs/UpdateProfileRequest.md deleted file mode 100644 index b6346d0..0000000 --- a/docs/UpdateProfileRequest.md +++ /dev/null @@ -1,24 +0,0 @@ -# UpdateProfileRequest - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**account_id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[] } | [optional] -**email** | **str** | { \"description\" : \"E-mail address\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**first_name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**last_name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**company_name** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**logo_url** | **str** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**addresses** | [**list[Address]**](Address.md) | { \"description\" : \"Address associated with the profile\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**mobile** | **str** | { \"description\" : \"Mobile telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**landline** | **str** | { \"description\" : \"Home telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**fax** | **str** | { \"description\" : \"Fax number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**dob** | **datetime** | { \"description\" : \"Date of birth in YYYY-MM-DD format\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**vat_number** | **str** | { \"description\" : \"VAT number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**additional_information** | **str** | { \"description\" : \"Any additional information\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UpdateRatePlanAffiliateRequest.md b/docs/UpdateRatePlanAffiliateRequest.md new file mode 100644 index 0000000..d1c9ac4 --- /dev/null +++ b/docs/UpdateRatePlanAffiliateRequest.md @@ -0,0 +1,12 @@ +# UpdateRatePlanAffiliateRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**id** | **str** | | [optional] +**start_date** | **datetime** | | [optional] +**end_date** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UpdateRoleRequest.md b/docs/UpdateRoleRequest.md index c9995f7..f17de67 100644 --- a/docs/UpdateRoleRequest.md +++ b/docs/UpdateRoleRequest.md @@ -3,13 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**organization_id** | **str** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional] -**id** | **str** | { \"description\" : \"\", \"verbs\":[\"GET\", \"PUT\"] } | -**name** | **str** | { \"description\" : \"Friendly name of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] -**description** | **str** | { \"description\" : \"Friendly description of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] -**default_role** | **bool** | { \"description\" : \"If set this role will become the default role for the organization unsetting any existing role. Any accounts without an explicitly set role will have this applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] [default to False] +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**default_role** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateSalesforceConfigurationRequest.md b/docs/UpdateSalesforceConfigurationRequest.md new file mode 100644 index 0000000..590020a --- /dev/null +++ b/docs/UpdateSalesforceConfigurationRequest.md @@ -0,0 +1,11 @@ +# UpdateSalesforceConfigurationRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**organization_id** | **str** | | [optional] +**user_role** | **str** | | [optional] +**notification_email_addresses** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UpdateSubscriptionRequest.md b/docs/UpdateSubscriptionRequest.md index cf252c0..9d8932e 100644 --- a/docs/UpdateSubscriptionRequest.md +++ b/docs/UpdateSubscriptionRequest.md @@ -3,16 +3,27 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | {\"description\":\"ID of the Subscription you wish to update.\",\"verbs\":[\"POST\"]} | -**name** | **str** | {\"description\":\"New name to assign to the updated subscription. This is primarily for your benefit &mdash; for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'Customer 1425, guy@mail.com, Premium membership').\",\"verbs\":[\"POST\"]} | [optional] -**description** | **str** | {\"description\":\"New description to assign to the updated subscription. This is primarily for your benefit &mdash; for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Customer obtained through Lazy Wednesdays promotion').\",\"verbs\":[\"POST\"]} | [optional] -**start** | **datetime** | {\"description\":\"[Can only be changed if subscription is still in Provisioned state] ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.\",\"verbs\":[\"POST\"]} | [optional] -**end** | **datetime** | {\"description\":\"[Can only be changed if subscription is still in Provisioned state] ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should finish its first service period.\",\"verbs\":[\"POST\"]} | [optional] -**state** | **str** | {\"description\":\"[Can only be changed if subscription is still in Provisioned state] The state into which you wish to move the updated subscription.<br><span class=\\\"label label-default\\\">AwaitingPayment</span> &mdash; The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.\",\"verbs\":[\"POST\"]} | [optional] -**parent_id** | **str** | {\"description\":\"ID of a parent subscription which will collect the charges raised by this subscription. The parent becomes responsible for paying those charges.\",\"verbs\":[\"POST\"]} | [optional] -**aggregate_all_subscriptions_on_account** | **bool** | {\"description\":\"Whether this subscription should become an 'aggregating subscription', collecting charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.\",\"verbs\":[\"POST\"]} | [optional] [default to False] -**failed_payment_behaviour** | **str** | {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.<br><span class=\\\"label label-default\\\">CancelSubscription</span> &mdash; Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.<br><span class=\\\"label label-default\\\">None</span> &mdash; The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles &mdash; or when manual invoice remediation is common &mdash; <span class=\\\"label label-default\\\">None</span> is recommended.<br>In a heavily-automated SaaS environment, automatic cancellation via <span class=\\\"label label-default\\\">CancelSubscription</span> is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] +**created** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**contract_start** | **datetime** | | [optional] +**start** | **datetime** | | [optional] +**end** | **datetime** | | [optional] +**trial_end** | **datetime** | | [optional] +**type** | **str** | | [optional] +**state** | **str** | | [optional] +**parent_id** | **str** | | [optional] +**exclude_from_auto_aggregation** | **bool** | | [optional] +**failed_payment_behaviour** | **str** | | [optional] +**payment_terms** | **int** | | [optional] +**align_period_with_aggregating_subscription** | **bool** | | [optional] +**ignore_first_period_usage** | **bool** | | [optional] +**extras** | [**Extras**](Extras.md) | | [optional] +**purchase_order** | **str** | | [optional] +**subscription_id** | **str** | | [optional] +**dry_run** | **bool** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UpdateUserInfoRequest.md b/docs/UpdateUserInfoRequest.md new file mode 100644 index 0000000..f7f8d48 --- /dev/null +++ b/docs/UpdateUserInfoRequest.md @@ -0,0 +1,11 @@ +# UpdateUserInfoRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**first_name** | **str** | | [optional] +**last_name** | **str** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UpgradeCharge.md b/docs/UpgradeCharge.md new file mode 100644 index 0000000..cef1ef3 --- /dev/null +++ b/docs/UpgradeCharge.md @@ -0,0 +1,12 @@ +# UpgradeCharge + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pricing_component_value_change** | [**PricingComponentValueChange**](PricingComponentValueChange.md) | | [optional] +**pricing_component_name** | **str** | | [optional] +**public_pricing_component_name** | **str** | | [optional] +**pricing_component_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Usage.md b/docs/Usage.md deleted file mode 100644 index ffba274..0000000 --- a/docs/Usage.md +++ /dev/null @@ -1,28 +0,0 @@ -# Usage - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**session_id** | **str** | { \"description\" : \"A (not guaranteed unique) identifier for the session from which this usage was generated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**subscription_id** | **str** | { \"description\" : \"ID of the subscription to which this usage instance pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**pricing_component_id** | **str** | { \"description\" : \"The ID of the pricing component this usage is for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**pricing_component_name** | **str** | { \"description\" : \"The name of the pricing component this usage is for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**uom** | **str** | { \"description\" : \"The unit-of-measure that this usage is for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"The organization associated with this usage instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**usage_period** | **int** | { \"description\" : \"The usage period during which this usage occurred.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**usage_duration** | **int** | { \"description\" : \"The amount of time over which usage occurred (in milliseconds?). Relevant for 'temporal' usage only.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**usage_type** | **str** | { \"description\" : \"The type of usage ('Temporal' or 'Itemized').\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**usage_value** | **int** | { \"description\" : \"The quantity of product consumed by this usage. Relevant for 'itemized' usage only.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**detailed** | **bool** | { \"description\" : \"Is this usage a detailed entry?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] [default to False] -**created_by** | **str** | { \"description\" : \"Some identifying information about who created this object.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**updated_by** | **str** | { \"description\" : \"Some identifying information about who updated this object.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**start** | **datetime** | { \"description\" : \"The start date of this usage instance, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**stop** | **datetime** | { \"description\" : \"The end date of this usage instance, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was updated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**occurred_on** | **datetime** | { \"description\" : \"The UTC DateTime when the usage occurred.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**billing_date** | **datetime** | { \"description\" : \"The UTC DateTime when the usage is to be billed.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UsageApi.md b/docs/UsageApi.md deleted file mode 100644 index dc0cac4..0000000 --- a/docs/UsageApi.md +++ /dev/null @@ -1,286 +0,0 @@ -# billforward.UsageApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_usage_instance**](UsageApi.md#create_usage_instance) | **POST** /usage | Add usage -[**get_usage_by_id**](UsageApi.md#get_usage_by_id) | **GET** /usage/{subscription-id}/{period-id} | Retrieve by subscription and period -[**get_usage_by_subscription_id**](UsageApi.md#get_usage_by_subscription_id) | **GET** /usage/{subscription-id} | Retrieve by subscription -[**get_usage_by_subscription_id_uo_m_period_and_usage_type**](UsageApi.md#get_usage_by_subscription_id_uo_m_period_and_usage_type) | **GET** /usage/{subscription-id}/{uom}/{period-id}/{usage-type} | Retrieve by subscription, period and type -[**update_usage_instance**](UsageApi.md#update_usage_instance) | **PUT** /usage | Update usage - - -# **create_usage_instance** -> UsagePagedMetadata create_usage_instance(usage) - -Add usage - -{\"nickname\":\"Add usage\",\"request\":\"createUsageRequest.html\",\"response\":\"createUsageResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsageApi() -usage = billforward.CompoundUsage() # CompoundUsage | An array of The 'Usage' objects to be created. - -try: - # Add usage - api_response = api_instance.create_usage_instance(usage) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsageApi->create_usage_instance: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **usage** | [**CompoundUsage**](CompoundUsage.md)| An array of The 'Usage' objects to be created. | - -### Return type - -[**UsagePagedMetadata**](UsagePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_usage_by_id** -> UsagePagedMetadata get_usage_by_id(subscription_id, period_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Retrieve by subscription and period - -{\"nickname\":\"Retrieve by subscription and period\",\"response\":\"getUsageForPeriod.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsageApi() -subscription_id = 'subscription_id_example' # str | The subscriptionID of the usage. -period_id = 56 # int | The periodID of the usage. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Retrieve by subscription and period - api_response = api_instance.get_usage_by_id(subscription_id, period_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsageApi->get_usage_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| The subscriptionID of the usage. | - **period_id** | **int**| The periodID of the usage. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**UsagePagedMetadata**](UsagePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_usage_by_subscription_id** -> UsagePagedMetadata get_usage_by_subscription_id(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Retrieve by subscription - -{\"nickname\":\"Retrieve by subscription\",\"response\":\"getUsage.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsageApi() -subscription_id = 'subscription_id_example' # str | The subscriptionID of the subscription whose Usage instances you wish to GET. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Retrieve by subscription - api_response = api_instance.get_usage_by_subscription_id(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsageApi->get_usage_by_subscription_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| The subscriptionID of the subscription whose Usage instances you wish to GET. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**UsagePagedMetadata**](UsagePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_usage_by_subscription_id_uo_m_period_and_usage_type** -> UsagePagedMetadata get_usage_by_subscription_id_uo_m_period_and_usage_type(subscription_id, uom, period_id, usage_type, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Retrieve by subscription, period and type - -{\"nickname\":\"Retrieve by subscription, period and type\",\"response\":\"getDetailedUsageForPeriod.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsageApi() -subscription_id = 'subscription_id_example' # str | The subscriptionID of the usage. -uom = 'uom_example' # str | The uom of the usage. -period_id = 56 # int | The periodID of the usage. -usage_type = 'usage_type_example' # str | The type of the usage. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Retrieve by subscription, period and type - api_response = api_instance.get_usage_by_subscription_id_uo_m_period_and_usage_type(subscription_id, uom, period_id, usage_type, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsageApi->get_usage_by_subscription_id_uo_m_period_and_usage_type: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| The subscriptionID of the usage. | - **uom** | **str**| The uom of the usage. | - **period_id** | **int**| The periodID of the usage. | - **usage_type** | **str**| The type of the usage. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**UsagePagedMetadata**](UsagePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_usage_instance** -> UsagePagedMetadata update_usage_instance(usage) - -Update usage - -{\"nickname\":\"Update usage\",\"request\":\"updateUsageRequest.html\",\"response\":\"updateUsageResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsageApi() -usage = billforward.CompoundUsage() # CompoundUsage | An array of The 'Usage' objects to be updated. - -try: - # Update usage - api_response = api_instance.update_usage_instance(usage) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsageApi->update_usage_instance: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **usage** | [**CompoundUsage**](CompoundUsage.md)| An array of The 'Usage' objects to be updated. | - -### Return type - -[**UsagePagedMetadata**](UsagePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/UsagePagedMetadata.md b/docs/UsagePagedMetadata.md deleted file mode 100644 index bf7086b..0000000 --- a/docs/UsagePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# UsagePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Usage]**](Usage.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UsagePeriodPagedMetadata.md b/docs/UsagePeriodPagedMetadata.md deleted file mode 100644 index c8da274..0000000 --- a/docs/UsagePeriodPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# UsagePeriodPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[BillingEntityBase]**](BillingEntityBase.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UsagePricingComponentsByChargeModel.md b/docs/UsagePricingComponentsByChargeModel.md new file mode 100644 index 0000000..6df887f --- /dev/null +++ b/docs/UsagePricingComponentsByChargeModel.md @@ -0,0 +1,11 @@ +# UsagePricingComponentsByChargeModel + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**flat** | [**list[FlatUsagePricingComponent]**](FlatUsagePricingComponent.md) | | [optional] +**tiered** | [**list[TieredUsagePricingComponent]**](TieredUsagePricingComponent.md) | | [optional] +**volume** | [**list[TieredUsagePricingComponent]**](TieredUsagePricingComponent.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UsageRoundingStrategyPagedMetadata.md b/docs/UsageRoundingStrategyPagedMetadata.md deleted file mode 100644 index 673c141..0000000 --- a/docs/UsageRoundingStrategyPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# UsageRoundingStrategyPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UsageSession.md b/docs/UsageSession.md deleted file mode 100644 index 1a020ba..0000000 --- a/docs/UsageSession.md +++ /dev/null @@ -1,23 +0,0 @@ -# UsageSession - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**organization_id** | **str** | { \"description\" : \"Organization associated with this session.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**subscription_id** | **str** | { \"description\" : \"ID of the subscription to which this session pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**session_id** | **str** | { \"description\" : \"A (not guaranteed unique) identifier for this session, provided by the user. This, when combined with the subscription ID and unit of measure, uniquely identify a session.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**pricing_component_id** | **str** | { \"description\" : \"ID of the pricing-component to which this usage session applies\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**pricing_component_name** | **str** | { \"description\" : \"Name of the pricing-component to which this usage session applies\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**uom** | **str** | { \"description\" : \"Unit-of-measure to which this usage session applies\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**description** | **str** | { \"description\" : \"A description provided by the user, to record details about this session.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**sessionix** | **int** | { \"description\" : \"The current incarnation of the session. Initially 0, this number increments every time the session is 'cut' without ending. For example, a cut is taken of a session if it outlasts the end date of the billing period it started in. The session reincarnates with an incremented sessionix, in the next billing period (that is, if some period indeed follows the current one).\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**start** | **datetime** | { \"description\" : \"The start date of this session, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**stop** | **datetime** | { \"description\" : \"The end date of this session, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**state** | **str** | { \"description\" : \"The type of usage measured within this billing period. Options are '\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] }Active', Which refers to a session that is currently running 'Historic', Which refers to a session that has terminated. | [optional] -**uduration** | **int** | { \"description\" : \"The amount of time that elapsed (in milliseconds?) during this session. Initially 0. Presently updated only when a cut is taken of the session (for example if the session or billnig period ends).\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UsageSessionPagedMetadata.md b/docs/UsageSessionPagedMetadata.md deleted file mode 100644 index fe6a641..0000000 --- a/docs/UsageSessionPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# UsageSessionPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[UsageSession]**](UsageSession.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UsageperiodsApi.md b/docs/UsageperiodsApi.md deleted file mode 100644 index 8b6c207..0000000 --- a/docs/UsageperiodsApi.md +++ /dev/null @@ -1,186 +0,0 @@ -# billforward.UsageperiodsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_usage_period**](UsageperiodsApi.md#get_usage_period) | **GET** /usage-periods/{subscription-id}/{period-id} | Retrieve by subscription and period -[**get_usage_period_for_all**](UsageperiodsApi.md#get_usage_period_for_all) | **GET** /usage-periods/{subscription-id} | Retrieve by subscription -[**get_usage_period_for_invoice**](UsageperiodsApi.md#get_usage_period_for_invoice) | **GET** /usage-periods/{subscription-id}/invoice/{invoice-id} | Retrieve by invoice) - - -# **get_usage_period** -> UsagePeriodPagedMetadata get_usage_period(subscription_id, period_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Retrieve by subscription and period - -{ \"nickname\" : \"Retrieve by subscription and period\",\"response\" : \"getUsagePeriodsForPeriod.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsageperiodsApi() -subscription_id = 'subscription_id_example' # str | The subscriptionID of the usage. -period_id = 56 # int | The periodID of the usage. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Retrieve by subscription and period - api_response = api_instance.get_usage_period(subscription_id, period_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsageperiodsApi->get_usage_period: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| The subscriptionID of the usage. | - **period_id** | **int**| The periodID of the usage. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**UsagePeriodPagedMetadata**](UsagePeriodPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_usage_period_for_all** -> UsagePeriodPagedMetadata get_usage_period_for_all(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Retrieve by subscription - -{ \"nickname\" : \"Retrieve by subscription\",\"response\" : \"getUsagePeriods.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsageperiodsApi() -subscription_id = 'subscription_id_example' # str | The subscriptionID of the usage. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Retrieve by subscription - api_response = api_instance.get_usage_period_for_all(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsageperiodsApi->get_usage_period_for_all: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| The subscriptionID of the usage. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**UsagePeriodPagedMetadata**](UsagePeriodPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_usage_period_for_invoice** -> UsagePeriodPagedMetadata get_usage_period_for_invoice(subscription_id, invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Retrieve by invoice) - -{ \"nickname\" : \"Retrieve by invoice\",\"response\" : \"getUsagePeriodForInvoice.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsageperiodsApi() -subscription_id = 'subscription_id_example' # str | The subscriptionID of the usage. -invoice_id = 'invoice_id_example' # str | The invoiceID of the usage. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Retrieve by invoice) - api_response = api_instance.get_usage_period_for_invoice(subscription_id, invoice_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsageperiodsApi->get_usage_period_for_invoice: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| The subscriptionID of the usage. | - **invoice_id** | **str**| The invoiceID of the usage. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**UsagePeriodPagedMetadata**](UsagePeriodPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/UsageroundingstrategiesApi.md b/docs/UsageroundingstrategiesApi.md deleted file mode 100644 index eb1a5f5..0000000 --- a/docs/UsageroundingstrategiesApi.md +++ /dev/null @@ -1,224 +0,0 @@ -# billforward.UsageroundingstrategiesApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_usage_rounding_strategy**](UsageroundingstrategiesApi.md#create_usage_rounding_strategy) | **POST** /usage-rounding-strategies | Create a new rounding strategy -[**get_usage_rounding_strategy_by_id**](UsageroundingstrategiesApi.md#get_usage_rounding_strategy_by_id) | **GET** /usage-rounding-strategies/{usage-rounding-strategies-ID} | Returns a collection of usage-rounding-strategies, specified by the usage-rounding-strategies-id parameter. By default 10 values are returned. Records are returned in natural order. -[**get_usage_rounding_strategy_by_pricing_component_id**](UsageroundingstrategiesApi.md#get_usage_rounding_strategy_by_pricing_component_id) | **GET** /usage-rounding-strategies/pricing-component/{pricing-component-ID} | Returns a collection of usage-rounding-strategies, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. -[**update_usage_rounding_strategy**](UsageroundingstrategiesApi.md#update_usage_rounding_strategy) | **PUT** /usage-rounding-strategies | Update a rounding strategy - - -# **create_usage_rounding_strategy** -> UsageRoundingStrategyPagedMetadata create_usage_rounding_strategy(usage_rounding_strategy) - -Create a new rounding strategy - -{\"nickname\":\"Create a new rounding strategy\",\"request\":\"createUsageRoundingStrategiesRequest.html\",\"response\":\"createUsageRoundingStrategiesResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsageroundingstrategiesApi() -usage_rounding_strategy = billforward.MutableBillingEntity() # MutableBillingEntity | The usage-rounding-strategy object to be created. - -try: - # Create a new rounding strategy - api_response = api_instance.create_usage_rounding_strategy(usage_rounding_strategy) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsageroundingstrategiesApi->create_usage_rounding_strategy: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **usage_rounding_strategy** | [**MutableBillingEntity**](MutableBillingEntity.md)| The usage-rounding-strategy object to be created. | - -### Return type - -[**UsageRoundingStrategyPagedMetadata**](UsageRoundingStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_usage_rounding_strategy_by_id** -> UsageRoundingStrategyPagedMetadata get_usage_rounding_strategy_by_id(usage_rounding_strategies_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of usage-rounding-strategies, specified by the usage-rounding-strategies-id parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve an existing round strategy\",\"response\":\"getUsageRoundingStrategiesByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsageroundingstrategiesApi() -usage_rounding_strategies_id = 'usage_rounding_strategies_id_example' # str | The string ID of the usage-rounding-strategies. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-components to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of usage-rounding-strategies, specified by the usage-rounding-strategies-id parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_usage_rounding_strategy_by_id(usage_rounding_strategies_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsageroundingstrategiesApi->get_usage_rounding_strategy_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **usage_rounding_strategies_id** | **str**| The string ID of the usage-rounding-strategies. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-components to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**UsageRoundingStrategyPagedMetadata**](UsageRoundingStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_usage_rounding_strategy_by_pricing_component_id** -> UsageRoundingStrategyPagedMetadata get_usage_rounding_strategy_by_pricing_component_id(pricing_component_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - -Returns a collection of usage-rounding-strategies, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. - -{\"nickname\":\"Retrieve by pricing component\",\"response\":\"getUsageRoundingStrategiesByPricingComponent.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsageroundingstrategiesApi() -pricing_component_id = 'pricing_component_id_example' # str | The string pricing-component-ID of the pricing-component. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first pricing-component to return. (optional) (default to 0) -records = 10 # int | The maximum number of pricing-components to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of usage-rounding-strategies, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_usage_rounding_strategy_by_pricing_component_id(pricing_component_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsageroundingstrategiesApi->get_usage_rounding_strategy_by_pricing_component_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **pricing_component_id** | **str**| The string pricing-component-ID of the pricing-component. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first pricing-component to return. | [optional] [default to 0] - **records** | **int**| The maximum number of pricing-components to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] - -### Return type - -[**UsageRoundingStrategyPagedMetadata**](UsageRoundingStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_usage_rounding_strategy** -> UsageRoundingStrategyPagedMetadata update_usage_rounding_strategy(usage_rounding_strategy) - -Update a rounding strategy - -{\"nickname\":\"Update a rounding strategy\",\"request\":\"updateUsageRoundingStrategiesRequest.html\",\"response\":\"updateUsageRoundingStrategiesResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsageroundingstrategiesApi() -usage_rounding_strategy = billforward.MutableBillingEntity() # MutableBillingEntity | The usage-rounding-strategy object to be updated. - -try: - # Update a rounding strategy - api_response = api_instance.update_usage_rounding_strategy(usage_rounding_strategy) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsageroundingstrategiesApi->update_usage_rounding_strategy: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **usage_rounding_strategy** | [**MutableBillingEntity**](MutableBillingEntity.md)| The usage-rounding-strategy object to be updated. | - -### Return type - -[**UsageRoundingStrategyPagedMetadata**](UsageRoundingStrategyPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/UsagesessionsApi.md b/docs/UsagesessionsApi.md deleted file mode 100644 index 03eeecd..0000000 --- a/docs/UsagesessionsApi.md +++ /dev/null @@ -1,220 +0,0 @@ -# billforward.UsagesessionsApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**get_active_sessions_for_subscription**](UsagesessionsApi.md#get_active_sessions_for_subscription) | **GET** /usage-sessions/{subscription-id}/active | Get active by subscription -[**get_usage_list_for_usage_session**](UsagesessionsApi.md#get_usage_list_for_usage_session) | **GET** /usage-sessions/{subscription-id} | Retrieve by subscription -[**start_usage_session**](UsagesessionsApi.md#start_usage_session) | **POST** /usage-sessions/start | Start a new session -[**stop_usage_session**](UsagesessionsApi.md#stop_usage_session) | **POST** /usage-sessions/stop | Stop a specified session - - -# **get_active_sessions_for_subscription** -> UsageSessionPagedMetadata get_active_sessions_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Get active by subscription - -{\"nickname\":\"Get active by subscription\",\"response\":\"getActiveSessions.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsagesessionsApi() -subscription_id = 'subscription_id_example' # str | The subscriptionID of the subscription whose active sessions you wish to GET. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Get active by subscription - api_response = api_instance.get_active_sessions_for_subscription(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsagesessionsApi->get_active_sessions_for_subscription: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| The subscriptionID of the subscription whose active sessions you wish to GET. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**UsageSessionPagedMetadata**](UsageSessionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_usage_list_for_usage_session** -> UsageSessionPagedMetadata get_usage_list_for_usage_session(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Retrieve by subscription - -{\"nickname\":\"Retrieve by subscription\",\"response\":\"getAllSessions.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsagesessionsApi() -subscription_id = 'subscription_id_example' # str | The subscriptionID of the subscription whose sessions you wish to GET. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first amendment to return. (optional) (default to 0) -records = 8766 # int | The maximum number of amendments to return. (optional) (default to 8766) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'ASC' # str | The direction of any ordering, either ASC or DESC. (optional) (default to ASC) - -try: - # Retrieve by subscription - api_response = api_instance.get_usage_list_for_usage_session(subscription_id, organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsagesessionsApi->get_usage_list_for_usage_session: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **subscription_id** | **str**| The subscriptionID of the subscription whose sessions you wish to GET. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first amendment to return. | [optional] [default to 0] - **records** | **int**| The maximum number of amendments to return. | [optional] [default to 8766] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC] - -### Return type - -[**UsageSessionPagedMetadata**](UsageSessionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **start_usage_session** -> UsageSessionPagedMetadata start_usage_session(usage_sessions) - -Start a new session - -{\"nickname\":\"Start a new session\",\"request\":\"createStartUsageSessionRequest.html\",\"response\":\"createStartUsageSessionResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsagesessionsApi() -usage_sessions = billforward.CompoundUsageSession() # CompoundUsageSession | An array of 'Usage Session' objects whose sessions you wish to start. - -try: - # Start a new session - api_response = api_instance.start_usage_session(usage_sessions) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsagesessionsApi->start_usage_session: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **usage_sessions** | [**CompoundUsageSession**](CompoundUsageSession.md)| An array of 'Usage Session' objects whose sessions you wish to start. | - -### Return type - -[**UsageSessionPagedMetadata**](UsageSessionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **stop_usage_session** -> UsageSessionPagedMetadata stop_usage_session(usage_sessions) - -Stop a specified session - -{\"nickname\":\"Stop a specified session\",\"request\":\"createStopUsageSessionRequest.html\",\"response\":\"createStopUsageSessionResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsagesessionsApi() -usage_sessions = billforward.CompoundUsageSession() # CompoundUsageSession | An array of 'Usage Session' objects whose sessions you wish to stop. - -try: - # Stop a specified session - api_response = api_instance.stop_usage_session(usage_sessions) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsagesessionsApi->stop_usage_session: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **usage_sessions** | [**CompoundUsageSession**](CompoundUsageSession.md)| An array of 'Usage Session' objects whose sessions you wish to stop. | - -### Return type - -[**UsageSessionPagedMetadata**](UsageSessionPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/User.md b/docs/User.md index 2d8d5c9..6668c76 100644 --- a/docs/User.md +++ b/docs/User.md @@ -3,21 +3,27 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**updated** | **datetime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional] -**id** | **str** | {\"description\":\"ID of the user\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional] -**organization_id** | **str** | {\"description\":\"ID of the Organization to which the User belongs.\",\"verbs\":[\"GET\",\"POST\"]} | -**password** | [**list[Password]**](Password.md) | {\"description\":\"Passwords associated with the user. A user must have one currently active password to login.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**username** | [**list[Username]**](Username.md) | {\"description\":\"Usernames associated with the user. A user may have more than one username currently active. Usernames are enforced to be formatted as e-mail addresses.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**password_reset_valid_till** | **datetime** | {\"description\":\"The UTC DateTime when a password reset would no longer be valid with the current code.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**bf_admin** | **bool** | | [optional] [default to False] -**account_non_expired** | **bool** | {\"description\":\"Whether the User has expired.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to False] -**account_non_locked** | **bool** | {\"description\":\"Is the User locked.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [default to False] -**credentials_non_expired** | **bool** | {\"description\":\"Are the User credentials expired.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [default to False] -**enabled** | **bool** | {\"description\":\"Is the User enabled.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [default to False] -**timezone** | [**TimeZone**](TimeZone.md) | {\"description\":\"The timezone used when displaying time series data to the user.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | +**password** | [**list[Password]**](Password.md) | | [optional] +**username** | [**list[Username]**](Username.md) | | [optional] +**open_id_identifier** | **str** | | [optional] +**password_reset_code** | **str** | | [optional] +**password_reset_attempts** | **int** | | [optional] +**password_reset_valid_till** | **datetime** | | [optional] +**last_successful_login** | **datetime** | | [optional] +**successful_logins** | **int** | | [optional] +**bf_admin** | **bool** | | [optional] +**enabled** | **bool** | | +**timezone** | [**UserTimezone**](UserTimezone.md) | | +**flexcheck_user** | **bool** | | +**two_fa** | **bool** | | [optional] +**main_username** | [**Username**](Username.md) | | [optional] +**active_usernames** | **list[str]** | | [optional] +**email** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UserCreateRequest.md b/docs/UserCreateRequest.md new file mode 100644 index 0000000..c215a2c --- /dev/null +++ b/docs/UserCreateRequest.md @@ -0,0 +1,19 @@ +# UserCreateRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**email** | **str** | | [optional] +**first_name** | **str** | | [optional] +**last_name** | **str** | | [optional] +**company_name** | **str** | | [optional] +**password** | **str** | | [optional] +**roles** | **list[str]** | | [optional] +**send_email** | **bool** | | [optional] +**id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UserCreationRequest.md b/docs/UserCreationRequest.md index 8a9a009..6a739a0 100644 --- a/docs/UserCreationRequest.md +++ b/docs/UserCreationRequest.md @@ -3,17 +3,18 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**organization_id** | **str** | {\"description\":\"Organization for which the User is created.\",\"verbs\":[\"GET\",\"POST\"]} | -**email** | **str** | {\"description\":\"Login E-mail address of the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**first_name** | **str** | {\"description\":\"First Name of the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**last_name** | **str** | {\"description\":\"Last Name of the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**company_name** | **str** | {\"description\":\"User's Company.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**password** | **str** | {\"description\":\"Login Password for the User.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**roles** | **list[str]** | {\"description\":\"The permission groups the user will belong to.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | -**send_email** | **bool** | {\"description\":\"When an email should be sent upon creation.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [default to False] +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**email** | **str** | | [optional] +**first_name** | **str** | | [optional] +**last_name** | **str** | | [optional] +**company_name** | **str** | | [optional] +**password** | **str** | | [optional] +**roles** | **list[str]** | | [optional] +**send_email** | **bool** | | [optional] +**user_present** | **bool** | | [optional] +**id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UserCreationResponse.md b/docs/UserCreationResponse.md new file mode 100644 index 0000000..5fb6259 --- /dev/null +++ b/docs/UserCreationResponse.md @@ -0,0 +1,22 @@ +# UserCreationResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**email** | **str** | | [optional] +**first_name** | **str** | | [optional] +**last_name** | **str** | | [optional] +**company_name** | **str** | | [optional] +**roles** | **list[str]** | | [optional] +**email_sent** | **bool** | | [optional] +**account_id** | **str** | | [optional] +**account** | [**Account**](Account.md) | | [optional] +**user** | [**User**](User.md) | | [optional] +**request** | [**UserCreationRequest**](UserCreationRequest.md) | | [optional] +**id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UserCreationResponsePagedMetadata.md b/docs/UserCreationResponsePagedMetadata.md deleted file mode 100644 index 40e5155..0000000 --- a/docs/UserCreationResponsePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# UserCreationResponsePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[UserCreationRequest]**](UserCreationRequest.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UserInviteRequest.md b/docs/UserInviteRequest.md new file mode 100644 index 0000000..0c982c8 --- /dev/null +++ b/docs/UserInviteRequest.md @@ -0,0 +1,17 @@ +# UserInviteRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**email** | **str** | | [optional] +**first_name** | **str** | | [optional] +**last_name** | **str** | | [optional] +**company_name** | **str** | | [optional] +**roles** | **list[str]** | | [optional] +**id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UserPagedMetadata.md b/docs/UserPagedMetadata.md deleted file mode 100644 index 85ae6b4..0000000 --- a/docs/UserPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# UserPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[User]**](User.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UserPrivatePermanentTokenRefreshRequest.md b/docs/UserPrivatePermanentTokenRefreshRequest.md new file mode 100644 index 0000000..b15a04a --- /dev/null +++ b/docs/UserPrivatePermanentTokenRefreshRequest.md @@ -0,0 +1,10 @@ +# UserPrivatePermanentTokenRefreshRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **str** | | [optional] +**refresh_token** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UserPrivatePermanentTokenRequest.md b/docs/UserPrivatePermanentTokenRequest.md new file mode 100644 index 0000000..27a8c4d --- /dev/null +++ b/docs/UserPrivatePermanentTokenRequest.md @@ -0,0 +1,10 @@ +# UserPrivatePermanentTokenRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **str** | | [optional] +**code** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UserResponse.md b/docs/UserResponse.md new file mode 100644 index 0000000..666c421 --- /dev/null +++ b/docs/UserResponse.md @@ -0,0 +1,17 @@ +# UserResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**enabled** | **bool** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**username** | [**list[UsernameResponse]**](UsernameResponse.md) | | [optional] +**password_reset_valid_till** | **datetime** | | [optional] +**last_successful_login** | **datetime** | | [optional] +**successful_logins** | **int** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TimeZone.md b/docs/UserTimezone.md similarity index 96% rename from docs/TimeZone.md rename to docs/UserTimezone.md index 4ec24cb..3f55759 100644 --- a/docs/TimeZone.md +++ b/docs/UserTimezone.md @@ -1,4 +1,4 @@ -# TimeZone +# UserTimezone ## Properties Name | Type | Description | Notes @@ -10,4 +10,3 @@ Name | Type | Description | Notes [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Username.md b/docs/Username.md index f98bc32..61dcab3 100644 --- a/docs/Username.md +++ b/docs/Username.md @@ -3,13 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created** | **datetime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional] -**changed_by** | **str** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional] -**id** | **str** | { \"description\" : \"id of the username.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] -**user_id** | **str** | { \"description\" : \"User associated with the username.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**organization_id** | **str** | { \"description\" : \"Organization associated of the user\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | -**username** | **str** | { \"description\" : \"The username.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**id** | **str** | | [optional] +**user_id** | **str** | | +**organization_id** | **str** | | +**username** | **str** | | +**first_name** | **str** | | [optional] +**last_name** | **str** | | [optional] +**profile_picture** | **str** | | [optional] +**email** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UsernamePagedMetadata.md b/docs/UsernamePagedMetadata.md deleted file mode 100644 index f9be301..0000000 --- a/docs/UsernamePagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# UsernamePagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[Username]**](Username.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UsernameResponse.md b/docs/UsernameResponse.md new file mode 100644 index 0000000..133f138 --- /dev/null +++ b/docs/UsernameResponse.md @@ -0,0 +1,18 @@ +# UsernameResponse + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**id** | **str** | | [optional] +**username** | **str** | | [optional] +**last_name** | **str** | | [optional] +**user_id** | **str** | | [optional] +**first_name** | **str** | | [optional] +**email** | **str** | | [optional] +**profile_picture** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**two_fa** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UsernamesApi.md b/docs/UsernamesApi.md deleted file mode 100644 index 90bfec6..0000000 --- a/docs/UsernamesApi.md +++ /dev/null @@ -1,56 +0,0 @@ -# billforward.UsernamesApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_username**](UsernamesApi.md#create_username) | **POST** /usernames | Create a username. - - -# **create_username** -> UsernamePagedMetadata create_username(username) - -Create a username. - -{\"nickname\":\"Create\",\"request\":\"createUsernameRequest.html\",\"response\":\"createUsernameResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsernamesApi() -username = billforward.Username() # Username | The username object to be created. - -try: - # Create a username. - api_response = api_instance.create_username(username) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsernamesApi->create_username: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **username** | [**Username**](Username.md)| The username object to be created. | - -### Return type - -[**UsernamePagedMetadata**](UsernamePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/UsersApi.md b/docs/UsersApi.md deleted file mode 100644 index bf5788b..0000000 --- a/docs/UsersApi.md +++ /dev/null @@ -1,554 +0,0 @@ -# billforward.UsersApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_user**](UsersApi.md#create_user) | **POST** /users | Create a user. -[**create_user_login**](UsersApi.md#create_user_login) | **POST** /users/create-user-login | Create a user. -[**get_all_users**](UsersApi.md#get_all_users) | **GET** /users | Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. -[**get_user_by_id**](UsersApi.md#get_user_by_id) | **GET** /users/{user-ID} | Returns a single User, specified by the ID parameter. -[**get_user_by_password_reset_code**](UsersApi.md#get_user_by_password_reset_code) | **GET** /users/password-reset-code/{password-reset-code} | Returns a single User, specified by the password-reset-code parameter. -[**get_user_by_sms_password_reset_code**](UsersApi.md#get_user_by_sms_password_reset_code) | **GET** /users/sms-password-reset-code/{sms-password-reset-code} | Returns a single User, specified by the sms-password-reset-code parameter. -[**get_user_by_username**](UsersApi.md#get_user_by_username) | **GET** /users/username/{username} | Returns a single User, specified by the username parameter, this is by default the e-mail address of the user. -[**reset_user_password**](UsersApi.md#reset_user_password) | **POST** /users/password-reset | Create a password reset request. -[**retire_user**](UsersApi.md#retire_user) | **DELETE** /users/{user-ID} | Retires the user with the specified user-ID. -[**update_user**](UsersApi.md#update_user) | **PUT** /users | Update a user. -[**update_user_password**](UsersApi.md#update_user_password) | **POST** /users/password-update | Update a user's password. - - -# **create_user** -> UserPagedMetadata create_user(user) - -Create a user. - -{\"nickname\":\"Create a new user\",\"request\":\"createUserRequest.html\",\"response\":\"createUserResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsersApi() -user = billforward.User() # User | The user object to be created. - -try: - # Create a user. - api_response = api_instance.create_user(user) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsersApi->create_user: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user** | [**User**](User.md)| The user object to be created. | - -### Return type - -[**UserPagedMetadata**](UserPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_user_login** -> UserCreationResponsePagedMetadata create_user_login(user) - -Create a user. - -{\"nickname\":\"Create a new user with login\",\"request\":\"createUserWithLoginRequest.html\",\"response\":\"createUserWithLoginResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsersApi() -user = billforward.UserCreationRequest() # UserCreationRequest | The user object to be created. - -try: - # Create a user. - api_response = api_instance.create_user_login(user) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsersApi->create_user_login: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user** | [**UserCreationRequest**](UserCreationRequest.md)| The user object to be created. | - -### Return type - -[**UserCreationResponsePagedMetadata**](UserCreationResponsePagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_all_users** -> UserPagedMetadata get_all_users(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - -Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - -{ \"nickname\" : \"Get all users\",\"response\" : \"getUserAll.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsersApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first user to return. (optional) (default to 0) -records = 10 # int | The maximum number of users to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) - -try: - # Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - api_response = api_instance.get_all_users(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsersApi->get_all_users: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first user to return. | [optional] [default to 0] - **records** | **int**| The maximum number of users to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - -### Return type - -[**UserPagedMetadata**](UserPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_user_by_id** -> UserPagedMetadata get_user_by_id(user_id, organizations=organizations) - -Returns a single User, specified by the ID parameter. - -{ \"nickname\" : \"Retrieve an existing user\",\"response\" : \"getUserByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsersApi() -user_id = 'user_id_example' # str | ID of the User. -organizations = ['organizations_example'] # list[str] | A list of organization -IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single User, specified by the ID parameter. - api_response = api_instance.get_user_by_id(user_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsersApi->get_user_by_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **str**| ID of the User. | - **organizations** | [**list[str]**](str.md)| A list of organization -IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**UserPagedMetadata**](UserPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_user_by_password_reset_code** -> UserPagedMetadata get_user_by_password_reset_code(password_reset_code, organizations=organizations) - -Returns a single User, specified by the password-reset-code parameter. - -{ \"nickname\" : \"Retrieve by reset code\",\"response\" : \"getUserByPasswordResetCode.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsersApi() -password_reset_code = 'password_reset_code_example' # str | The unique password reset code of the User. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single User, specified by the password-reset-code parameter. - api_response = api_instance.get_user_by_password_reset_code(password_reset_code, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsersApi->get_user_by_password_reset_code: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **password_reset_code** | **str**| The unique password reset code of the User. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**UserPagedMetadata**](UserPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_user_by_sms_password_reset_code** -> UserPagedMetadata get_user_by_sms_password_reset_code(sms_password_reset_code, organizations=organizations) - -Returns a single User, specified by the sms-password-reset-code parameter. - -{ \"nickname\" : \"Retrieve by sms reset code\",\"response\" : \"getUserBySMSPasswordResetCode.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsersApi() -sms_password_reset_code = 'sms_password_reset_code_example' # str | The unique SMS password reset code of the User. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single User, specified by the sms-password-reset-code parameter. - api_response = api_instance.get_user_by_sms_password_reset_code(sms_password_reset_code, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsersApi->get_user_by_sms_password_reset_code: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **sms_password_reset_code** | **str**| The unique SMS password reset code of the User. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**UserPagedMetadata**](UserPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_user_by_username** -> UserPagedMetadata get_user_by_username(username, organizations=organizations) - -Returns a single User, specified by the username parameter, this is by default the e-mail address of the user. - -{ \"nickname\" : \"Retrieve by username\",\"response\" : \"getUserByUsername.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsersApi() -username = 'username_example' # str | The unique username of the User. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single User, specified by the username parameter, this is by default the e-mail address of the user. - api_response = api_instance.get_user_by_username(username, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsersApi->get_user_by_username: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **username** | **str**| The unique username of the User. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**UserPagedMetadata**](UserPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **reset_user_password** -> UserPagedMetadata reset_user_password(request) - -Create a password reset request. - -{\"nickname\":\"Create a password reset request\",\"request\":\"PasswordResetRequest.html\",\"response\":\"PasswordResetResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsersApi() -request = billforward.PasswordResetRequest() # PasswordResetRequest | - -try: - # Create a password reset request. - api_response = api_instance.reset_user_password(request) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsersApi->reset_user_password: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **request** | [**PasswordResetRequest**](PasswordResetRequest.md)| | - -### Return type - -[**UserPagedMetadata**](UserPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **retire_user** -> UserPagedMetadata retire_user(user_id, organizations) - -Retires the user with the specified user-ID. - -{ \"nickname\" : \"Delete a user\",\"response\" : \"deleteUser.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsersApi() -user_id = 'user_id_example' # str | ID of the User. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. - -try: - # Retires the user with the specified user-ID. - api_response = api_instance.retire_user(user_id, organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsersApi->retire_user: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user_id** | **str**| ID of the User. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | - -### Return type - -[**UserPagedMetadata**](UserPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_user** -> UserPagedMetadata update_user(user) - -Update a user. - -{ \"nickname\" : \"Update a user\", \"request\" : \"updateUserRequest.html\" ,\"response\" : \"updateUserResponse.html\" } - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsersApi() -user = billforward.User() # User | The user object to be updated. - -try: - # Update a user. - api_response = api_instance.update_user(user) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsersApi->update_user: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **user** | [**User**](User.md)| The user object to be updated. | - -### Return type - -[**UserPagedMetadata**](UserPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_user_password** -> UserPagedMetadata update_user_password(password_reset) - -Update a user's password. - -{ \"nickname\" : \"Update password using reset code\", \"request\" : \"updateUserPassword.html\" ,\"response\" : \"updateUserPasswordResponse.html\" } - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.UsersApi() -password_reset = billforward.BillingEntityBase() # BillingEntityBase | The password reset object. - -try: - # Update a user's password. - api_response = api_instance.update_user_password(password_reset) - pprint(api_response) -except ApiException as e: - print "Exception when calling UsersApi->update_user_password: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **password_reset** | [**BillingEntityBase**](BillingEntityBase.md)| The password reset object. | - -### Return type - -[**UserPagedMetadata**](UserPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/ValueIncrement.md b/docs/ValueIncrement.md new file mode 100644 index 0000000..4e31696 --- /dev/null +++ b/docs/ValueIncrement.md @@ -0,0 +1,10 @@ +# ValueIncrement + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pricing_component** | **str** | | +**increment_by** | **int** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/VaultedgatewaysApi.md b/docs/VaultedgatewaysApi.md deleted file mode 100644 index c138538..0000000 --- a/docs/VaultedgatewaysApi.md +++ /dev/null @@ -1,640 +0,0 @@ -# billforward.VaultedgatewaysApi - -All URIs are relative to *https://localhost:8080/RestAPI* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**create_authorize_net_token**](VaultedgatewaysApi.md#create_authorize_net_token) | **POST** /vaulted-gateways/authorize-net | Create an authorize-net-token. -[**create_braintree_token**](VaultedgatewaysApi.md#create_braintree_token) | **POST** /vaulted-gateways/braintree | Create a braintree-token. -[**create_stripe_ach_token**](VaultedgatewaysApi.md#create_stripe_ach_token) | **POST** /vaulted-gateways/stripe-ACH | Create a stripe-ACH-token. -[**create_stripe_token**](VaultedgatewaysApi.md#create_stripe_token) | **POST** /vaulted-gateways/stripe | Create a stripe-token. -[**create_trust_commerce_token**](VaultedgatewaysApi.md#create_trust_commerce_token) | **POST** /vaulted-gateways/trustCommerce | Create a trust-commerce-token. -[**get_braintree_by_account_id**](VaultedgatewaysApi.md#get_braintree_by_account_id) | **GET** /vaulted-gateways/braintree/{accountID} | Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter. -[**get_by_card_details_id**](VaultedgatewaysApi.md#get_by_card_details_id) | **GET** /vaulted-gateways/stripe/card-details-id/{cardDetailsID} | Returns a single stripe-token, specified by the cardDetailsID parameter. -[**get_stripe_ach**](VaultedgatewaysApi.md#get_stripe_ach) | **GET** /vaulted-gateways/stripe-ACH/{stripeACHTokenID} | Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter. -[**get_stripe_token**](VaultedgatewaysApi.md#get_stripe_token) | **GET** /vaulted-gateways/stripe/{stripeTokenID} | Returns a single stripe-token, specified by the stripeTokenID parameter. -[**update_stripe_ach_token**](VaultedgatewaysApi.md#update_stripe_ach_token) | **PUT** /vaulted-gateways/stripe-ACH | Update a stripe-ACH-token. -[**update_stripe_token**](VaultedgatewaysApi.md#update_stripe_token) | **PUT** /vaulted-gateways/stripe | Update a stripe-token. -[**verify_bank_account**](VaultedgatewaysApi.md#verify_bank_account) | **POST** /vaulted-gateways/stripe/verify-bank-account | Verify Stripe bank account. -[**webhook**](VaultedgatewaysApi.md#webhook) | **POST** /vaulted-gateways/stripe/webhook | Receive and handle webhook from Stripe. - - -# **create_authorize_net_token** -> AuthorizeNetTokenPagedMetadata create_authorize_net_token(authorize_net_token) - -Create an authorize-net-token. - -{\"nickname\":\"Create a authorize-net-token\",\"request\":\"createAuthorizeNetTokenRequest.html\",\"response\":\"createAuthorizeNetTokenResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.VaultedgatewaysApi() -authorize_net_token = billforward.MutableBillingEntity() # MutableBillingEntity | The authorize-net-token object to be created. - -try: - # Create an authorize-net-token. - api_response = api_instance.create_authorize_net_token(authorize_net_token) - pprint(api_response) -except ApiException as e: - print "Exception when calling VaultedgatewaysApi->create_authorize_net_token: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **authorize_net_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The authorize-net-token object to be created. | - -### Return type - -[**AuthorizeNetTokenPagedMetadata**](AuthorizeNetTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_braintree_token** -> BraintreeTokenPagedMetadata create_braintree_token(braintree_token) - -Create a braintree-token. - -{\"nickname\":\"Create a braintree-token\",\"request\":\"createBraintreeTokenRequest.html\",\"response\":\"BraintreeTokenResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.VaultedgatewaysApi() -braintree_token = billforward.MutableBillingEntity() # MutableBillingEntity | The braintree-token object to be created. - -try: - # Create a braintree-token. - api_response = api_instance.create_braintree_token(braintree_token) - pprint(api_response) -except ApiException as e: - print "Exception when calling VaultedgatewaysApi->create_braintree_token: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **braintree_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The braintree-token object to be created. | - -### Return type - -[**BraintreeTokenPagedMetadata**](BraintreeTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_stripe_ach_token** -> StripeACHTokenPagedMetadata create_stripe_ach_token(stripe_ach_token) - -Create a stripe-ACH-token. - -{\"nickname\":\"Create a stripe-ACH-token\",\"request\":\"createstripeACHTokenRequest.html\",\"response\":\"createstripeACHTokenResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.VaultedgatewaysApi() -stripe_ach_token = billforward.MutableBillingEntity() # MutableBillingEntity | The stripe-ACH-token object to be created. - -try: - # Create a stripe-ACH-token. - api_response = api_instance.create_stripe_ach_token(stripe_ach_token) - pprint(api_response) -except ApiException as e: - print "Exception when calling VaultedgatewaysApi->create_stripe_ach_token: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stripe_ach_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The stripe-ACH-token object to be created. | - -### Return type - -[**StripeACHTokenPagedMetadata**](StripeACHTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_stripe_token** -> StripeTokenPagedMetadata create_stripe_token(stripe_token) - -Create a stripe-token. - -{\"nickname\":\"Create a stripe-token\",\"request\":\"createstripeTokenRequest.html\",\"response\":\"createstripeTokenResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.VaultedgatewaysApi() -stripe_token = billforward.MutableBillingEntity() # MutableBillingEntity | The stripe-token object to be created. - -try: - # Create a stripe-token. - api_response = api_instance.create_stripe_token(stripe_token) - pprint(api_response) -except ApiException as e: - print "Exception when calling VaultedgatewaysApi->create_stripe_token: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stripe_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The stripe-token object to be created. | - -### Return type - -[**StripeTokenPagedMetadata**](StripeTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_trust_commerce_token** -> TrustCommerceTokenPagedMetadata create_trust_commerce_token(trust_commerce_token) - -Create a trust-commerce-token. - -{\"nickname\":\"Create a trust-commerce-token\",\"request\":\"createTrustCommerceTokenRequest.html\",\"response\":\"TrustCommerceTokenResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.VaultedgatewaysApi() -trust_commerce_token = billforward.MutableBillingEntity() # MutableBillingEntity | The trust-commerce-token object to be created. - -try: - # Create a trust-commerce-token. - api_response = api_instance.create_trust_commerce_token(trust_commerce_token) - pprint(api_response) -except ApiException as e: - print "Exception when calling VaultedgatewaysApi->create_trust_commerce_token: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **trust_commerce_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The trust-commerce-token object to be created. | - -### Return type - -[**TrustCommerceTokenPagedMetadata**](TrustCommerceTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_braintree_by_account_id** -> BraintreeTokenPagedMetadata get_braintree_by_account_id(account_id, organizations=organizations) - -Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter. - -{\"nickname\":\"Retrieve a list of braintree-token\",\"response\":\"getBraintreeByAccountID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.VaultedgatewaysApi() -account_id = 'account_id_example' # str | The string ID of the account-ID. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 (optional) - -try: - # Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter. - api_response = api_instance.get_braintree_by_account_id(account_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling VaultedgatewaysApi->get_braintree_by_account_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **account_id** | **str**| The string ID of the account-ID. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 | [optional] - -### Return type - -[**BraintreeTokenPagedMetadata**](BraintreeTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_by_card_details_id** -> StripeTokenPagedMetadata get_by_card_details_id(card_details_id, organizations=organizations) - -Returns a single stripe-token, specified by the cardDetailsID parameter. - -{\"nickname\":\"Retrieve a stripe-token by cardDetailsID\",\"response\":\"getStripeTokenByCardDetailsID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.VaultedgatewaysApi() -card_details_id = 'card_details_id_example' # str | The card details id of the stripe-token. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) - -try: - # Returns a single stripe-token, specified by the cardDetailsID parameter. - api_response = api_instance.get_by_card_details_id(card_details_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling VaultedgatewaysApi->get_by_card_details_id: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **card_details_id** | **str**| The card details id of the stripe-token. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - -### Return type - -[**StripeTokenPagedMetadata**](StripeTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_stripe_ach** -> StripeACHTokenPagedMetadata get_stripe_ach(stripe_ach_token_id, organizations=organizations) - -Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter. - -{\"nickname\":\"Retrieve a stripe-ACH-token\",\"response\":\"getStripeACHTokenByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.VaultedgatewaysApi() -stripe_ach_token_id = 'stripe_ach_token_id_example' # str | The string ID of the stripe-ACH-token. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 (optional) - -try: - # Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter. - api_response = api_instance.get_stripe_ach(stripe_ach_token_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling VaultedgatewaysApi->get_stripe_ach: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stripe_ach_token_id** | **str**| The string ID of the stripe-ACH-token. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 | [optional] - -### Return type - -[**StripeACHTokenPagedMetadata**](StripeACHTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_stripe_token** -> StripeTokenPagedMetadata get_stripe_token(stripe_token_id, organizations=organizations) - -Returns a single stripe-token, specified by the stripeTokenID parameter. - -{\"nickname\":\"Retrieve a stripe-token\",\"response\":\"getStripeTokenByID.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.VaultedgatewaysApi() -stripe_token_id = 'stripe_token_id_example' # str | The string ID of the stripe-token. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 (optional) - -try: - # Returns a single stripe-token, specified by the stripeTokenID parameter. - api_response = api_instance.get_stripe_token(stripe_token_id, organizations=organizations) - pprint(api_response) -except ApiException as e: - print "Exception when calling VaultedgatewaysApi->get_stripe_token: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stripe_token_id** | **str**| The string ID of the stripe-token. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2 | [optional] - -### Return type - -[**StripeTokenPagedMetadata**](StripeTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: text/plain - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_stripe_ach_token** -> StripeACHTokenPagedMetadata update_stripe_ach_token(stripe_token) - -Update a stripe-ACH-token. - -{\"nickname\":\"Update a stripe-ACH-token\",\"request\":\"updatestripeACHTokenRequest.html\",\"response\":\"updatestripeACHTokenResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.VaultedgatewaysApi() -stripe_token = billforward.MutableBillingEntity() # MutableBillingEntity | The stripe-ACH-token object to be updated. - -try: - # Update a stripe-ACH-token. - api_response = api_instance.update_stripe_ach_token(stripe_token) - pprint(api_response) -except ApiException as e: - print "Exception when calling VaultedgatewaysApi->update_stripe_ach_token: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stripe_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The stripe-ACH-token object to be updated. | - -### Return type - -[**StripeACHTokenPagedMetadata**](StripeACHTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **update_stripe_token** -> StripeTokenPagedMetadata update_stripe_token(stripe_token) - -Update a stripe-token. - -{\"nickname\":\"Update a stripe-token\",\"request\":\"updatestripeTokenRequest.html\",\"response\":\"updatestripeTokenResponse.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.VaultedgatewaysApi() -stripe_token = billforward.MutableBillingEntity() # MutableBillingEntity | The stripe-token object to be updated. - -try: - # Update a stripe-token. - api_response = api_instance.update_stripe_token(stripe_token) - pprint(api_response) -except ApiException as e: - print "Exception when calling VaultedgatewaysApi->update_stripe_token: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stripe_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The stripe-token object to be updated. | - -### Return type - -[**StripeTokenPagedMetadata**](StripeTokenPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **verify_bank_account** -> BankAccountVerificationPagedMetadata verify_bank_account(bank_account_verification) - -Verify Stripe bank account. - -{\"nickname\":\"Verify Stripe bank account\",\"response\":\"verifyStripeBankAccount.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.VaultedgatewaysApi() -bank_account_verification = billforward.BillingEntityBase() # BillingEntityBase | The Bank-Account-Verification object. - -try: - # Verify Stripe bank account. - api_response = api_instance.verify_bank_account(bank_account_verification) - pprint(api_response) -except ApiException as e: - print "Exception when calling VaultedgatewaysApi->verify_bank_account: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **bank_account_verification** | [**BillingEntityBase**](BillingEntityBase.md)| The Bank-Account-Verification object. | - -### Return type - -[**BankAccountVerificationPagedMetadata**](BankAccountVerificationPagedMetadata.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **webhook** -> str webhook(event) - -Receive and handle webhook from Stripe. - -{\"nickname\":\"Receive Stripe webhook\",\"response\":\"receiveStripeWebhook.html\"} - -### Example -```python -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - -# create an instance of the API class -api_instance = billforward.VaultedgatewaysApi() -event = billforward.Event() # Event | The event received. - -try: - # Receive and handle webhook from Stripe. - api_response = api_instance.webhook(event) - pprint(api_response) -except ApiException as e: - print "Exception when calling VaultedgatewaysApi->webhook: %s\n" % e -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **event** | [**Event**](Event.md)| The event received. | - -### Return type - -**str** - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/VerifyPaymentMethodRequest.md b/docs/VerifyPaymentMethodRequest.md new file mode 100644 index 0000000..9c95424 --- /dev/null +++ b/docs/VerifyPaymentMethodRequest.md @@ -0,0 +1,11 @@ +# VerifyPaymentMethodRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**amounts** | **list[int]** | | [optional] +**organization_id** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Webhook.md b/docs/Webhook.md new file mode 100644 index 0000000..1647953 --- /dev/null +++ b/docs/Webhook.md @@ -0,0 +1,21 @@ +# Webhook + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | [optional] +**organization_id** | **str** | | [optional] +**name** | **str** | | [optional] +**consecutive_failures** | **int** | | [optional] +**deleted** | **bool** | | [optional] +**temporarily_inactive_until** | **datetime** | | [optional] +**inactive_level** | **int** | | [optional] +**webhook_subscriptions** | [**list[WebhookSubscription]**](WebhookSubscription.md) | | [optional] +**url** | **str** | | [optional] +**url** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/WebhookPagedMetadata.md b/docs/WebhookPagedMetadata.md deleted file mode 100644 index fc38e1a..0000000 --- a/docs/WebhookPagedMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# WebhookPagedMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**next_page** | **str** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_page** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**current_offset** | **int** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_requested** | **int** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**records_returned** | **int** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**execution_time** | **int** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | -**results** | [**list[MutableBillingEntity]**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/WebhookSubscription.md b/docs/WebhookSubscription.md new file mode 100644 index 0000000..888ecc7 --- /dev/null +++ b/docs/WebhookSubscription.md @@ -0,0 +1,17 @@ +# WebhookSubscription + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**changed_by** | **str** | | [optional] +**updated** | **datetime** | | [optional] +**id** | **str** | | +**webhook_id** | **str** | | +**organization_id** | **str** | | +**domain** | **str** | | +**action** | **str** | | +**deleted** | **bool** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/WebhooksApi.md b/docs/WebhooksApi.md index 3001900..abbb3a0 100644 --- a/docs/WebhooksApi.md +++ b/docs/WebhooksApi.md @@ -1,161 +1,204 @@ # billforward.WebhooksApi -All URIs are relative to *https://localhost:8080/RestAPI* +All URIs are relative to *https://app.billforward.net/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_webhook**](WebhooksApi.md#create_webhook) | **POST** /webhooks | Create a webhook. -[**create_webhook_v2**](WebhooksApi.md#create_webhook_v2) | **POST** /webhooks/create | Create a webhook. -[**get_all_webhooks**](WebhooksApi.md#get_all_webhooks) | **GET** /webhooks | Returns a collection of Webhooks, specified by the accountID parameter. By default 10 values are returned. Records are returned in natural order. -[**get_webhook_by_id**](WebhooksApi.md#get_webhook_by_id) | **GET** /webhooks/{webhook-ID} | Returns a single webhook, specified by the webhook-ID parameter. -[**retire_webhook**](WebhooksApi.md#retire_webhook) | **DELETE** /webhooks/{webhook-ID} | Retires the specified webhook. -[**update_webhook**](WebhooksApi.md#update_webhook) | **PUT** /webhooks | Update a webhook. -[**verify_webhook**](WebhooksApi.md#verify_webhook) | **GET** /webhooks/verify/{verification-ID} | New webhooks must be verified before use, use the verificationID of the webhook to perform verification. - +[**create_webhook**](WebhooksApi.md#create_webhook) | **POST** /webhooks | +[**create_webhook_v2**](WebhooksApi.md#create_webhook_v2) | **POST** /webhooks/create | +[**get_all_webhooks**](WebhooksApi.md#get_all_webhooks) | **GET** /webhooks | +[**get_allowed_webhook_subscriptions**](WebhooksApi.md#get_allowed_webhook_subscriptions) | **GET** /webhooks/allowed-subscriptions | +[**get_webhook_by_id**](WebhooksApi.md#get_webhook_by_id) | **GET** /webhooks/{webhook-ID} | +[**retire_webhook**](WebhooksApi.md#retire_webhook) | **DELETE** /webhooks/{webhook-ID} | +[**update_webhook**](WebhooksApi.md#update_webhook) | **PUT** /webhooks | +[**verify_webhook**](WebhooksApi.md#verify_webhook) | **GET** /webhooks/verify/{verification-ID} | # **create_webhook** -> WebhookPagedMetadata create_webhook(webhook) +> InlineResponseDefault102 create_webhook(body=body) -Create a webhook. -{\"nickname\":\"Add a new webhook\",\"request\":\"createWebhookRequest.html\",\"response\":\"createWebhookResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.WebhooksApi() -webhook = billforward.MutableBillingEntity() # MutableBillingEntity | The webhook object to be created. +api_instance = billforward.WebhooksApi(billforward.ApiClient(configuration)) +body = billforward.Webhook() # Webhook | (optional) -try: - # Create a webhook. - api_response = api_instance.create_webhook(webhook) +try: + api_response = api_instance.create_webhook(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling WebhooksApi->create_webhook: %s\n" % e + print("Exception when calling WebhooksApi->create_webhook: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **webhook** | [**MutableBillingEntity**](MutableBillingEntity.md)| The webhook object to be created. | + **body** | [**Webhook**](Webhook.md)| | [optional] ### Return type -[**WebhookPagedMetadata**](WebhookPagedMetadata.md) +[**InlineResponseDefault102**](InlineResponseDefault102.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_webhook_v2** -> WebhookPagedMetadata create_webhook_v2(request) +> InlineResponseDefault102 create_webhook_v2(body=body) -Create a webhook. -{\"nickname\":\"Add a new webhook\",\"request\":\"createWebhookRequest.html\",\"response\":\"createWebhookResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.WebhooksApi() -request = billforward.BillingEntityBase() # BillingEntityBase | +api_instance = billforward.WebhooksApi(billforward.ApiClient(configuration)) +body = billforward.LegacyCreateWebhookRequest() # LegacyCreateWebhookRequest | (optional) -try: - # Create a webhook. - api_response = api_instance.create_webhook_v2(request) +try: + api_response = api_instance.create_webhook_v2(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling WebhooksApi->create_webhook_v2: %s\n" % e + print("Exception when calling WebhooksApi->create_webhook_v2: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **request** | [**BillingEntityBase**](BillingEntityBase.md)| | + **body** | [**LegacyCreateWebhookRequest**](LegacyCreateWebhookRequest.md)| | [optional] ### Return type -[**WebhookPagedMetadata**](WebhookPagedMetadata.md) +[**InlineResponseDefault102**](InlineResponseDefault102.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_webhooks** -> WebhookPagedMetadata get_all_webhooks(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault101 get_all_webhooks(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) -Returns a collection of Webhooks, specified by the accountID parameter. By default 10 values are returned. Records are returned in natural order. -{\"nickname\":\"Get all webhooks\",\"response\":\"getWebhookAll.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.WebhooksApi() -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) -offset = 0 # int | The offset from the first webhook to return. (optional) (default to 0) -records = 10 # int | The maximum number of webhooks to return. (optional) (default to 10) -order_by = 'created' # str | Specify a field used to order the result set. (optional) (default to created) -order = 'DESC' # str | Ihe direction of any ordering, either ASC or DESC. (optional) (default to DESC) -include_retired = true # bool | Whether retired products should be returned. (optional) (default to true) - -try: - # Returns a collection of Webhooks, specified by the accountID parameter. By default 10 values are returned. Records are returned in natural order. +api_instance = billforward.WebhooksApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) +offset = 0 # int | (optional) (default to 0) +records = 10 # int | (optional) (default to 10) +order_by = 'created' # str | (optional) (default to created) +order = 'DESC' # str | (optional) (default to DESC) +include_retired = true # bool | (optional) (default to true) + +try: api_response = api_instance.get_all_webhooks(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) pprint(api_response) except ApiException as e: - print "Exception when calling WebhooksApi->get_all_webhooks: %s\n" % e + print("Exception when calling WebhooksApi->get_all_webhooks: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organizations** | [**list[str]**](str.md)| | [optional] + **offset** | **int**| | [optional] [default to 0] + **records** | **int**| | [optional] [default to 10] + **order_by** | **str**| | [optional] [default to created] + **order** | **str**| | [optional] [default to DESC] + **include_retired** | **bool**| | [optional] [default to true] + +### Return type + +[**InlineResponseDefault101**](InlineResponseDefault101.md) + +### Authorization + +[bearerAuth](../README.md#bearerAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_allowed_webhook_subscriptions** +> InlineResponseDefault103 get_allowed_webhook_subscriptions(organizations=organizations) + + + +### Example +```python +from __future__ import print_function +import time +import billforward +from billforward.rest import ApiException +from pprint import pprint + + +# create an instance of the API class +api_instance = billforward.WebhooksApi(billforward.ApiClient(configuration)) +organizations = ['organizations_example'] # list[str] | (optional) + +try: + api_response = api_instance.get_allowed_webhook_subscriptions(organizations=organizations) + pprint(api_response) +except ApiException as e: + print("Exception when calling WebhooksApi->get_allowed_webhook_subscriptions: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] - **offset** | **int**| The offset from the first webhook to return. | [optional] [default to 0] - **records** | **int**| The maximum number of webhooks to return. | [optional] [default to 10] - **order_by** | **str**| Specify a field used to order the result set. | [optional] [default to created] - **order** | **str**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC] - **include_retired** | **bool**| Whether retired products should be returned. | [optional] [default to true] + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**WebhookPagedMetadata**](WebhookPagedMetadata.md) +[**InlineResponseDefault103**](InlineResponseDefault103.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -165,195 +208,191 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_webhook_by_id** -> WebhookPagedMetadata get_webhook_by_id(webhook_id, organizations=organizations) +> InlineResponseDefault102 get_webhook_by_id(webhook_id, organizations=organizations) -Returns a single webhook, specified by the webhook-ID parameter. -{\"nickname\":\"Retrieve an existing webhook\",\"response\":\"getWebhookByID.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.WebhooksApi() -webhook_id = 'webhook_id_example' # str | ID of the webhook. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +api_instance = billforward.WebhooksApi(billforward.ApiClient(configuration)) +webhook_id = 'webhook_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Returns a single webhook, specified by the webhook-ID parameter. +try: api_response = api_instance.get_webhook_by_id(webhook_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling WebhooksApi->get_webhook_by_id: %s\n" % e + print("Exception when calling WebhooksApi->get_webhook_by_id: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **webhook_id** | **str**| ID of the webhook. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **webhook_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**WebhookPagedMetadata**](WebhookPagedMetadata.md) +[**InlineResponseDefault102**](InlineResponseDefault102.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **retire_webhook** -> WebhookPagedMetadata retire_webhook(webhook_id, organizations) +> InlineResponseDefault102 retire_webhook(webhook_id, organizations=organizations) -Retires the specified webhook. -{\"nickname\":\"Remove a webhook\",\"response\":\"deleteWebhook.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.WebhooksApi() -webhook_id = 'webhook_id_example' # str | ID of the webhook. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. +api_instance = billforward.WebhooksApi(billforward.ApiClient(configuration)) +webhook_id = 'webhook_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - # Retires the specified webhook. - api_response = api_instance.retire_webhook(webhook_id, organizations) +try: + api_response = api_instance.retire_webhook(webhook_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling WebhooksApi->retire_webhook: %s\n" % e + print("Exception when calling WebhooksApi->retire_webhook: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **webhook_id** | **str**| ID of the webhook. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | + **webhook_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**WebhookPagedMetadata**](WebhookPagedMetadata.md) +[**InlineResponseDefault102**](InlineResponseDefault102.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_webhook** -> WebhookPagedMetadata update_webhook(webhook) +> InlineResponseDefault102 update_webhook(body=body) -Update a webhook. -{\"nickname\":\"Update a webhook\",\"request\":\"updateWebhookRequest.html\",\"response\":\"updateWebhookResponse.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.WebhooksApi() -webhook = billforward.MutableBillingEntity() # MutableBillingEntity | The webhook object to be updated. +api_instance = billforward.WebhooksApi(billforward.ApiClient(configuration)) +body = billforward.Webhook() # Webhook | (optional) -try: - # Update a webhook. - api_response = api_instance.update_webhook(webhook) +try: + api_response = api_instance.update_webhook(body=body) pprint(api_response) except ApiException as e: - print "Exception when calling WebhooksApi->update_webhook: %s\n" % e + print("Exception when calling WebhooksApi->update_webhook: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **webhook** | [**MutableBillingEntity**](MutableBillingEntity.md)| The webhook object to be updated. | + **body** | [**Webhook**](Webhook.md)| | [optional] ### Return type -[**WebhookPagedMetadata**](WebhookPagedMetadata.md) +[**InlineResponseDefault102**](InlineResponseDefault102.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - - **Accept**: text/xml, application/xml, application/json + - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **verify_webhook** -> WebhookPagedMetadata verify_webhook(verification_id, organizations=organizations) +> InlineResponseDefault102 verify_webhook(verification_id, organizations=organizations) -New webhooks must be verified before use, use the verificationID of the webhook to perform verification. -{\"nickname\":\"Verify a webhook\",\"response\":\"verifyWebhook.html\"} -### Example +### Example ```python +from __future__ import print_function import time import billforward from billforward.rest import ApiException from pprint import pprint + # create an instance of the API class -api_instance = billforward.WebhooksApi() -verification_id = 'verification_id_example' # str | verificationID of the webhook. -organizations = ['organizations_example'] # list[str] | A list of organization-IDs used to restrict the scope of API calls. (optional) +api_instance = billforward.WebhooksApi(billforward.ApiClient(configuration)) +verification_id = 'verification_id_example' # str | +organizations = ['organizations_example'] # list[str] | (optional) -try: - # New webhooks must be verified before use, use the verificationID of the webhook to perform verification. +try: api_response = api_instance.verify_webhook(verification_id, organizations=organizations) pprint(api_response) except ApiException as e: - print "Exception when calling WebhooksApi->verify_webhook: %s\n" % e + print("Exception when calling WebhooksApi->verify_webhook: %s\n" % e) ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **verification_id** | **str**| verificationID of the webhook. | - **organizations** | [**list[str]**](str.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] + **verification_id** | **str**| | + **organizations** | [**list[str]**](str.md)| | [optional] ### Return type -[**WebhookPagedMetadata**](WebhookPagedMetadata.md) +[**InlineResponseDefault102**](InlineResponseDefault102.md) ### Authorization -No authorization required +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: text/plain + - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/docs/ZoozCaptureRequest.md b/docs/ZoozCaptureRequest.md new file mode 100644 index 0000000..d6a1df3 --- /dev/null +++ b/docs/ZoozCaptureRequest.md @@ -0,0 +1,13 @@ +# ZoozCaptureRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **datetime** | | [optional] +**organization_id** | **str** | | [optional] +**account_id** | **str** | | [optional] +**default_payment_method** | **bool** | | [optional] +**card_token** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ZoozConfiguration.md b/docs/ZoozConfiguration.md new file mode 100644 index 0000000..41b9ee9 --- /dev/null +++ b/docs/ZoozConfiguration.md @@ -0,0 +1,8 @@ +# ZoozConfiguration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ZoozPayment.md b/docs/ZoozPayment.md new file mode 100644 index 0000000..c90029a --- /dev/null +++ b/docs/ZoozPayment.md @@ -0,0 +1,8 @@ +# ZoozPayment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/git_push.sh b/git_push.sh index ed37461..ae01b18 100644 --- a/git_push.sh +++ b/git_push.sh @@ -36,7 +36,7 @@ git_remote=`git remote` if [ "$git_remote" = "" ]; then # git remote not defined if [ "$GIT_TOKEN" = "" ]; then - echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment." + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git else git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git diff --git a/requirements.txt b/requirements.txt index f00e08f..bafdc07 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ certifi >= 14.05.14 -six == 1.8.0 +six >= 1.10 python_dateutil >= 2.5.3 setuptools >= 21.0.0 urllib3 >= 1.15.1 diff --git a/setup.py b/setup.py index 8200694..d7022de 100644 --- a/setup.py +++ b/setup.py @@ -1,32 +1,19 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ -import sys -from setuptools import setup, find_packages +from setuptools import setup, find_packages # noqa: H301 NAME = "billforward" VERSION = "1.0.0" - # To install the library, run the following # # python setup.py install @@ -39,14 +26,14 @@ setup( name=NAME, version=VERSION, - description="BillForward REST API", - author_email="", + description="Billforward API", + author_email="team@billforward.net", url="", - keywords=["Swagger", "BillForward REST API"], + keywords=["Swagger", "Billforward API"], install_requires=REQUIRES, packages=find_packages(), include_package_data=True, long_description="""\ - + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 """ ) diff --git a/test/test_account.py b/test/test_account.py index 9c08efc..5f79f61 100644 --- a/test/test_account.py +++ b/test/test_account.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.account import Account # noqa: E501 from billforward.rest import ApiException -from billforward.models.account import Account class TestAccount(unittest.TestCase): - """ Account unit test stubs """ + """Account unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testAccount(self): - """ - Test Account - """ - model = billforward.models.account.Account() + """Test Account""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.account.Account() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_account_ltv_result_paged_metadata.py b/test/test_account_ltv_result_paged_metadata.py deleted file mode 100644 index ce3338f..0000000 --- a/test/test_account_ltv_result_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.account_ltv_result_paged_metadata import AccountLTVResultPagedMetadata - - -class TestAccountLTVResultPagedMetadata(unittest.TestCase): - """ AccountLTVResultPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAccountLTVResultPagedMetadata(self): - """ - Test AccountLTVResultPagedMetadata - """ - model = billforward.models.account_ltv_result_paged_metadata.AccountLTVResultPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_account_paged_metadata.py b/test/test_account_paged_metadata.py deleted file mode 100644 index e616f79..0000000 --- a/test/test_account_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.account_paged_metadata import AccountPagedMetadata - - -class TestAccountPagedMetadata(unittest.TestCase): - """ AccountPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAccountPagedMetadata(self): - """ - Test AccountPagedMetadata - """ - model = billforward.models.account_paged_metadata.AccountPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_account_payments_result_paged_metadata.py b/test/test_account_payments_result_paged_metadata.py deleted file mode 100644 index 206605f..0000000 --- a/test/test_account_payments_result_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.account_payments_result_paged_metadata import AccountPaymentsResultPagedMetadata - - -class TestAccountPaymentsResultPagedMetadata(unittest.TestCase): - """ AccountPaymentsResultPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAccountPaymentsResultPagedMetadata(self): - """ - Test AccountPaymentsResultPagedMetadata - """ - model = billforward.models.account_payments_result_paged_metadata.AccountPaymentsResultPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_accounts_api.py b/test/test_accounts_api.py index d3c77de..d022504 100644 --- a/test/test_accounts_api.py +++ b/test/test_accounts_api.py @@ -1,187 +1,144 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.api.accounts_api import AccountsApi # noqa: E501 from billforward.rest import ApiException -from billforward.apis.accounts_api import AccountsApi class TestAccountsApi(unittest.TestCase): - """ AccountsApi unit test stubs """ + """AccountsApi unit test stubs""" def setUp(self): - self.api = billforward.apis.accounts_api.AccountsApi() + self.api = AccountsApi() # noqa: E501 def tearDown(self): pass - def test_add_credit_note_to_account(self): - """ - Test case for add_credit_note_to_account + def test_add_charge_to_account(self): + """Test case for add_charge_to_account - Creates a credit-note which may be used by any subscription of this account. """ pass - def test_add_permission_to_account(self): - """ - Test case for add_permission_to_account + def test_add_credit_note_to_account(self): + """Test case for add_credit_note_to_account - Add a role to the account """ pass def test_create_account(self): + """Test case for create_account + """ - Test case for create_account + pass + + def test_create_address(self): + """Test case for create_address - Create an Account. """ pass def test_delete_account(self): - """ - Test case for delete_account + """Test case for delete_account - Delete the account specified by the account-ID parameter. """ pass def test_delete_metadata_for_account(self): - """ - Test case for delete_metadata_for_account + """Test case for delete_metadata_for_account - Remove any associated metadata. """ pass def test_get_account_by_id(self): - """ - Test case for get_account_by_id + """Test case for get_account_by_id - Returns a single account, specified by the account-ID parameter. """ pass - def test_get_accounts_by_created(self): - """ - Test case for get_accounts_by_created + def test_get_all_accounts(self): + """Test case for get_all_accounts - Returns a collection of account objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. """ pass - def test_get_accounts_by_updated(self): - """ - Test case for get_accounts_by_updated + def test_get_available_credit_on_account(self): + """Test case for get_available_credit_on_account - Returns a collection of account objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. """ pass - def test_get_accounts_by_user_id(self): - """ - Test case for get_accounts_by_user_id + def test_get_invoices_by_account_id(self): + """Test case for get_invoices_by_account_id - Returns a collection of accounts, specified by the user-ID parameter. By default 10 values are returned. Records are returned in natural order. """ pass - def test_get_all_accounts(self): - """ - Test case for get_all_accounts + def test_get_metadata_for_account(self): + """Test case for get_metadata_for_account - Returns a collection of all account objects. By default 10 values are returned. Records are returned in natural order. """ pass - def test_get_available_credit_on_account(self): - """ - Test case for get_available_credit_on_account + def test_get_payment_method_by_account_id(self): + """Test case for get_payment_method_by_account_id - Returns all available credit-notes for the specified account. By default 10 values are returned. Records are returned in natural order. """ pass - def test_get_metadata_for_account(self): - """ - Test case for get_metadata_for_account + def test_get_subscription_charges(self): + """Test case for get_subscription_charges - Retrieve any associated metadata. """ pass - def test_get_permissions_on_account(self): - """ - Test case for get_permissions_on_account + def test_halt_aggregation(self): + """Test case for halt_aggregation - Retrieves a collection of roles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. """ pass - def test_remove_credit_from_account(self): - """ - Test case for remove_credit_from_account + def test_remove_credit_from_account2(self): + """Test case for remove_credit_from_account2 - Decrease the amount of credit by the value specified or entirely if no value provided. """ pass - def test_remove_permission_from_account(self): - """ - Test case for remove_permission_from_account + def test_set_metadata_for_account(self): + """Test case for set_metadata_for_account - Revoke the specified role. """ pass - def test_set_metadata_for_account(self): - """ - Test case for set_metadata_for_account + def test_update_account(self): + """Test case for update_account - Remove any existing metadata keys and create the provided data. """ pass - def test_update_account(self): - """ - Test case for update_account + def test_update_address(self): + """Test case for update_address - Update an Account. """ pass def test_upsert_metadata_for_account(self): - """ - Test case for upsert_metadata_for_account + """Test case for upsert_metadata_for_account - Update any existing metadata key-values and insert any new key-values, no keys will be removed. """ pass diff --git a/test/test_add_charge_request.py b/test/test_add_charge_request.py index ea74d80..328da9c 100644 --- a/test/test_add_charge_request.py +++ b/test/test_add_charge_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.add_charge_request import AddChargeRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.add_charge_request import AddChargeRequest class TestAddChargeRequest(unittest.TestCase): - """ AddChargeRequest unit test stubs """ + """AddChargeRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testAddChargeRequest(self): - """ - Test AddChargeRequest - """ - model = billforward.models.add_charge_request.AddChargeRequest() + """Test AddChargeRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.add_charge_request.AddChargeRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_add_charge_response.py b/test/test_add_charge_response.py new file mode 100644 index 0000000..ba6f4b9 --- /dev/null +++ b/test/test_add_charge_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.add_charge_response import AddChargeResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestAddChargeResponse(unittest.TestCase): + """AddChargeResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAddChargeResponse(self): + """Test AddChargeResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.add_charge_response.AddChargeResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_add_charge_to_account_response.py b/test/test_add_charge_to_account_response.py new file mode 100644 index 0000000..8a25cba --- /dev/null +++ b/test/test_add_charge_to_account_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.add_charge_to_account_response import AddChargeToAccountResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestAddChargeToAccountResponse(unittest.TestCase): + """AddChargeToAccountResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAddChargeToAccountResponse(self): + """Test AddChargeToAccountResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.add_charge_to_account_response.AddChargeToAccountResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_add_charges_to_account_api_request.py b/test/test_add_charges_to_account_api_request.py new file mode 100644 index 0000000..6806afc --- /dev/null +++ b/test/test_add_charges_to_account_api_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.add_charges_to_account_api_request import AddChargesToAccountAPIRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestAddChargesToAccountAPIRequest(unittest.TestCase): + """AddChargesToAccountAPIRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAddChargesToAccountAPIRequest(self): + """Test AddChargesToAccountAPIRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.add_charges_to_account_api_request.AddChargesToAccountAPIRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_add_contract_period_request.py b/test/test_add_contract_period_request.py new file mode 100644 index 0000000..898f546 --- /dev/null +++ b/test/test_add_contract_period_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.add_contract_period_request import AddContractPeriodRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestAddContractPeriodRequest(unittest.TestCase): + """AddContractPeriodRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAddContractPeriodRequest(self): + """Test AddContractPeriodRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.add_contract_period_request.AddContractPeriodRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_add_coupon_code_request.py b/test/test_add_coupon_code_request.py index e21dcaf..a9e98e1 100644 --- a/test/test_add_coupon_code_request.py +++ b/test/test_add_coupon_code_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.add_coupon_code_request import AddCouponCodeRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.add_coupon_code_request import AddCouponCodeRequest class TestAddCouponCodeRequest(unittest.TestCase): - """ AddCouponCodeRequest unit test stubs """ + """AddCouponCodeRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testAddCouponCodeRequest(self): - """ - Test AddCouponCodeRequest - """ - model = billforward.models.add_coupon_code_request.AddCouponCodeRequest() + """Test AddCouponCodeRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.add_coupon_code_request.AddCouponCodeRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_add_payment_method_request.py b/test/test_add_payment_method_request.py index 28b896f..f3243fd 100644 --- a/test/test_add_payment_method_request.py +++ b/test/test_add_payment_method_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.add_payment_method_request import AddPaymentMethodRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.add_payment_method_request import AddPaymentMethodRequest class TestAddPaymentMethodRequest(unittest.TestCase): - """ AddPaymentMethodRequest unit test stubs """ + """AddPaymentMethodRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testAddPaymentMethodRequest(self): - """ - Test AddPaymentMethodRequest - """ - model = billforward.models.add_payment_method_request.AddPaymentMethodRequest() + """Test AddPaymentMethodRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.add_payment_method_request.AddPaymentMethodRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_add_taxation_strategy_request.py b/test/test_add_taxation_strategy_request.py deleted file mode 100644 index 48aa7c4..0000000 --- a/test/test_add_taxation_strategy_request.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.add_taxation_strategy_request import AddTaxationStrategyRequest - - -class TestAddTaxationStrategyRequest(unittest.TestCase): - """ AddTaxationStrategyRequest unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAddTaxationStrategyRequest(self): - """ - Test AddTaxationStrategyRequest - """ - model = billforward.models.add_taxation_strategy_request.AddTaxationStrategyRequest() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_additional_data.py b/test/test_additional_data.py new file mode 100644 index 0000000..6871fab --- /dev/null +++ b/test/test_additional_data.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.additional_data import AdditionalData # noqa: E501 +from billforward.rest import ApiException + + +class TestAdditionalData(unittest.TestCase): + """AdditionalData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAdditionalData(self): + """Test AdditionalData""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.additional_data.AdditionalData() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_address.py b/test/test_address.py index 4e77a96..7c81e5a 100644 --- a/test/test_address.py +++ b/test/test_address.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.address import Address # noqa: E501 from billforward.rest import ApiException -from billforward.models.address import Address class TestAddress(unittest.TestCase): - """ Address unit test stubs """ + """Address unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testAddress(self): - """ - Test Address - """ - model = billforward.models.address.Address() + """Test Address""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.address.Address() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_address_paged_metadata.py b/test/test_address_paged_metadata.py deleted file mode 100644 index 4fc2fba..0000000 --- a/test/test_address_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.address_paged_metadata import AddressPagedMetadata - - -class TestAddressPagedMetadata(unittest.TestCase): - """ AddressPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAddressPagedMetadata(self): - """ - Test AddressPagedMetadata - """ - model = billforward.models.address_paged_metadata.AddressPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_addresses_api.py b/test/test_addresses_api.py deleted file mode 100644 index 5b91846..0000000 --- a/test/test_addresses_api.py +++ /dev/null @@ -1,62 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.addresses_api import AddressesApi - - -class TestAddressesApi(unittest.TestCase): - """ AddressesApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.addresses_api.AddressesApi() - - def tearDown(self): - pass - - def test_create_address(self): - """ - Test case for create_address - - Create - """ - pass - - def test_update_address(self): - """ - Test case for update_address - - Update - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_advance_pricing_components_by_charge_model.py b/test/test_advance_pricing_components_by_charge_model.py new file mode 100644 index 0000000..40bfbcd --- /dev/null +++ b/test/test_advance_pricing_components_by_charge_model.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.advance_pricing_components_by_charge_model import AdvancePricingComponentsByChargeModel # noqa: E501 +from billforward.rest import ApiException + + +class TestAdvancePricingComponentsByChargeModel(unittest.TestCase): + """AdvancePricingComponentsByChargeModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAdvancePricingComponentsByChargeModel(self): + """Test AdvancePricingComponentsByChargeModel""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.advance_pricing_components_by_charge_model.AdvancePricingComponentsByChargeModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_affiliate.py b/test/test_affiliate.py new file mode 100644 index 0000000..868aaeb --- /dev/null +++ b/test/test_affiliate.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.affiliate import Affiliate # noqa: E501 +from billforward.rest import ApiException + + +class TestAffiliate(unittest.TestCase): + """Affiliate unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAffiliate(self): + """Test Affiliate""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.affiliate.Affiliate() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_affiliate_commission_charge.py b/test/test_affiliate_commission_charge.py new file mode 100644 index 0000000..8548974 --- /dev/null +++ b/test/test_affiliate_commission_charge.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.affiliate_commission_charge import AffiliateCommissionCharge # noqa: E501 +from billforward.rest import ApiException + + +class TestAffiliateCommissionCharge(unittest.TestCase): + """AffiliateCommissionCharge unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAffiliateCommissionCharge(self): + """Test AffiliateCommissionCharge""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.affiliate_commission_charge.AffiliateCommissionCharge() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_affiliate_rate_plan_relationships.py b/test/test_affiliate_rate_plan_relationships.py new file mode 100644 index 0000000..29ebb83 --- /dev/null +++ b/test/test_affiliate_rate_plan_relationships.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.affiliate_rate_plan_relationships import AffiliateRatePlanRelationships # noqa: E501 +from billforward.rest import ApiException + + +class TestAffiliateRatePlanRelationships(unittest.TestCase): + """AffiliateRatePlanRelationships unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAffiliateRatePlanRelationships(self): + """Test AffiliateRatePlanRelationships""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.affiliate_rate_plan_relationships.AffiliateRatePlanRelationships() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_affiliate_subscription_relationship.py b/test/test_affiliate_subscription_relationship.py new file mode 100644 index 0000000..642cd79 --- /dev/null +++ b/test/test_affiliate_subscription_relationship.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.affiliate_subscription_relationship import AffiliateSubscriptionRelationship # noqa: E501 +from billforward.rest import ApiException + + +class TestAffiliateSubscriptionRelationship(unittest.TestCase): + """AffiliateSubscriptionRelationship unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAffiliateSubscriptionRelationship(self): + """Test AffiliateSubscriptionRelationship""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.affiliate_subscription_relationship.AffiliateSubscriptionRelationship() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_affiliation_api.py b/test/test_affiliation_api.py new file mode 100644 index 0000000..a99b1d8 --- /dev/null +++ b/test/test_affiliation_api.py @@ -0,0 +1,81 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.affiliation_api import AffiliationApi # noqa: E501 +from billforward.rest import ApiException + + +class TestAffiliationApi(unittest.TestCase): + """AffiliationApi unit test stubs""" + + def setUp(self): + self.api = AffiliationApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_invoice(self): + """Test case for create_invoice + + """ + pass + + def test_get_affiliate(self): + """Test case for get_affiliate + + """ + pass + + def test_get_affiliate1(self): + """Test case for get_affiliate1 + + """ + pass + + def test_quote_invoice(self): + """Test case for quote_invoice + + """ + pass + + def test_quote_subscription(self): + """Test case for quote_subscription + + """ + pass + + def test_set_affiliate(self): + """Test case for set_affiliate + + """ + pass + + def test_set_affiliate1(self): + """Test case for set_affiliate1 + + """ + pass + + def test_update_affiliate(self): + """Test case for update_affiliate + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_aggregating_component.py b/test/test_aggregating_component.py deleted file mode 100644 index 71cb471..0000000 --- a/test/test_aggregating_component.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.aggregating_component import AggregatingComponent - - -class TestAggregatingComponent(unittest.TestCase): - """ AggregatingComponent unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAggregatingComponent(self): - """ - Test AggregatingComponent - """ - model = billforward.models.aggregating_component.AggregatingComponent() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_aggregating_component_description.py b/test/test_aggregating_component_description.py new file mode 100644 index 0000000..1a35459 --- /dev/null +++ b/test/test_aggregating_component_description.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.aggregating_component_description import AggregatingComponentDescription # noqa: E501 +from billforward.rest import ApiException + + +class TestAggregatingComponentDescription(unittest.TestCase): + """AggregatingComponentDescription unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAggregatingComponentDescription(self): + """Test AggregatingComponentDescription""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.aggregating_component_description.AggregatingComponentDescription() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_alias.py b/test/test_alias.py deleted file mode 100644 index bc36d05..0000000 --- a/test/test_alias.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.alias import Alias - - -class TestAlias(unittest.TestCase): - """ Alias unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAlias(self): - """ - Test Alias - """ - model = billforward.models.alias.Alias() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_allowed_webhook_subscription_values.py b/test/test_allowed_webhook_subscription_values.py new file mode 100644 index 0000000..d1858e0 --- /dev/null +++ b/test/test_allowed_webhook_subscription_values.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.allowed_webhook_subscription_values import AllowedWebhookSubscriptionValues # noqa: E501 +from billforward.rest import ApiException + + +class TestAllowedWebhookSubscriptionValues(unittest.TestCase): + """AllowedWebhookSubscriptionValues unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAllowedWebhookSubscriptionValues(self): + """Test AllowedWebhookSubscriptionValues""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.allowed_webhook_subscription_values.AllowedWebhookSubscriptionValues() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_amendment.py b/test/test_amendment.py index 23bdde5..59683d7 100644 --- a/test/test_amendment.py +++ b/test/test_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.amendment import Amendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.amendment import Amendment class TestAmendment(unittest.TestCase): - """ Amendment unit test stubs """ + """Amendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testAmendment(self): - """ - Test Amendment - """ - model = billforward.models.amendment.Amendment() + """Test Amendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.amendment.Amendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_amendment_discard_amendment.py b/test/test_amendment_discard_amendment.py index 4ab3408..84ce9b5 100644 --- a/test/test_amendment_discard_amendment.py +++ b/test/test_amendment_discard_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.amendment_discard_amendment import AmendmentDiscardAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.amendment_discard_amendment import AmendmentDiscardAmendment class TestAmendmentDiscardAmendment(unittest.TestCase): - """ AmendmentDiscardAmendment unit test stubs """ + """AmendmentDiscardAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testAmendmentDiscardAmendment(self): - """ - Test AmendmentDiscardAmendment - """ - model = billforward.models.amendment_discard_amendment.AmendmentDiscardAmendment() + """Test AmendmentDiscardAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.amendment_discard_amendment.AmendmentDiscardAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_amendment_paged_metadata.py b/test/test_amendment_paged_metadata.py deleted file mode 100644 index f2c93ea..0000000 --- a/test/test_amendment_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.amendment_paged_metadata import AmendmentPagedMetadata - - -class TestAmendmentPagedMetadata(unittest.TestCase): - """ AmendmentPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAmendmentPagedMetadata(self): - """ - Test AmendmentPagedMetadata - """ - model = billforward.models.amendment_paged_metadata.AmendmentPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_amendment_price_n_time_paged_metadata.py b/test/test_amendment_price_n_time_paged_metadata.py deleted file mode 100644 index 13fa44d..0000000 --- a/test/test_amendment_price_n_time_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.amendment_price_n_time_paged_metadata import AmendmentPriceNTimePagedMetadata - - -class TestAmendmentPriceNTimePagedMetadata(unittest.TestCase): - """ AmendmentPriceNTimePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAmendmentPriceNTimePagedMetadata(self): - """ - Test AmendmentPriceNTimePagedMetadata - """ - model = billforward.models.amendment_price_n_time_paged_metadata.AmendmentPriceNTimePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_amendments_api.py b/test/test_amendments_api.py deleted file mode 100644 index 2be1ea9..0000000 --- a/test/test_amendments_api.py +++ /dev/null @@ -1,134 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.amendments_api import AmendmentsApi - - -class TestAmendmentsApi(unittest.TestCase): - """ AmendmentsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.amendments_api.AmendmentsApi() - - def tearDown(self): - pass - - def test_create_amendment(self): - """ - Test case for create_amendment - - Create an amendment. - """ - pass - - def test_get_all_amendments(self): - """ - Test case for get_all_amendments - - Returns a collection of all amendments. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_amendment_by_id(self): - """ - Test case for get_amendment_by_id - - Returns a single amendment, specified by the amendment-ID parameter. - """ - pass - - def test_get_amendment_by_state(self): - """ - Test case for get_amendment_by_state - - Returns a collection of amendments, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_amendment_by_subscription_id(self): - """ - Test case for get_amendment_by_subscription_id - - Returns a collection of amendments, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_amendment_swagger(self): - """ - Test case for get_amendment_swagger - - - """ - pass - - def test_get_amendments_by_actioning_time(self): - """ - Test case for get_amendments_by_actioning_time - - Returns a collection of amendment objects with an actioning-time within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_amendments_by_created_date(self): - """ - Test case for get_amendments_by_created_date - - Returns a collection of amendment objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_amendments_by_updated_date(self): - """ - Test case for get_amendments_by_updated_date - - Returns a collection of amendment objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_retire_amendment(self): - """ - Test case for retire_amendment - - Retires the amendment specified by the amendment-ID parameter. Retiring a amendment causes it to cancel based on the specificed retirement settings for the product. - """ - pass - - def test_update_amendment(self): - """ - Test case for update_amendment - - Update an amendment. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_analytics_api.py b/test/test_analytics_api.py deleted file mode 100644 index c020524..0000000 --- a/test/test_analytics_api.py +++ /dev/null @@ -1,134 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.analytics_api import AnalyticsApi - - -class TestAnalyticsApi(unittest.TestCase): - """ AnalyticsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.analytics_api.AnalyticsApi() - - def tearDown(self): - pass - - def test_get_account_debts(self): - """ - Test case for get_account_debts - - Gets outstanding debts per account, within a date range. - """ - pass - - def test_get_account_ltv(self): - """ - Test case for get_account_ltv - - Gets an account's life-time value, as of a given end date. - """ - pass - - def test_get_account_payments(self): - """ - Test case for get_account_payments - - Gets hourly payments per product, within a date range. - """ - pass - - def test_get_billforward_managed_payments(self): - """ - Test case for get_billforward_managed_payments - - Gets all payments managed by BillForward, within a date range. - """ - pass - - def test_get_churn(self): - """ - Test case for get_churn - - Gets churn, within a date range. - """ - pass - - def test_get_debts(self): - """ - Test case for get_debts - - Gets debts within a date range. - """ - pass - - def test_get_payments(self): - """ - Test case for get_payments - - Gets payments within a date range. - """ - pass - - def test_get_product_payments(self): - """ - Test case for get_product_payments - - Gets hourly payments per product, within a date range. - """ - pass - - def test_get_product_rate_plan_payments(self): - """ - Test case for get_product_rate_plan_payments - - Gets hourly payments per product, within a date range. - """ - pass - - def test_get_subscription_ltv(self): - """ - Test case for get_subscription_ltv - - Gets a subscription's life-time value, as of a given end date. - """ - pass - - def test_get_upgrades(self): - """ - Test case for get_upgrades - - Gets upgrades, within a date range. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_api_configuration.py b/test/test_api_configuration.py new file mode 100644 index 0000000..8bd45d7 --- /dev/null +++ b/test/test_api_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.api_configuration import APIConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestAPIConfiguration(unittest.TestCase): + """APIConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAPIConfiguration(self): + """Test APIConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.api_configuration.APIConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_api_configuration_paged_metadata.py b/test/test_api_configuration_paged_metadata.py deleted file mode 100644 index 4687ad5..0000000 --- a/test/test_api_configuration_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.api_configuration_paged_metadata import APIConfigurationPagedMetadata - - -class TestAPIConfigurationPagedMetadata(unittest.TestCase): - """ APIConfigurationPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAPIConfigurationPagedMetadata(self): - """ - Test APIConfigurationPagedMetadata - """ - model = billforward.models.api_configuration_paged_metadata.APIConfigurationPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_api_quote.py b/test/test_api_quote.py index f2a068d..f9ad9a0 100644 --- a/test/test_api_quote.py +++ b/test/test_api_quote.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.api_quote import ApiQuote # noqa: E501 from billforward.rest import ApiException -from billforward.models.api_quote import APIQuote -class TestAPIQuote(unittest.TestCase): - """ APIQuote unit test stubs """ +class TestApiQuote(unittest.TestCase): + """ApiQuote unit test stubs""" def setUp(self): pass @@ -41,11 +28,11 @@ def setUp(self): def tearDown(self): pass - def testAPIQuote(self): - """ - Test APIQuote - """ - model = billforward.models.api_quote.APIQuote() + def testApiQuote(self): + """Test ApiQuote""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.api_quote.ApiQuote() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_api_quote_paged_metadata.py b/test/test_api_quote_paged_metadata.py deleted file mode 100644 index 3f372cf..0000000 --- a/test/test_api_quote_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.api_quote_paged_metadata import APIQuotePagedMetadata - - -class TestAPIQuotePagedMetadata(unittest.TestCase): - """ APIQuotePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAPIQuotePagedMetadata(self): - """ - Test APIQuotePagedMetadata - """ - model = billforward.models.api_quote_paged_metadata.APIQuotePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_api_quote_response_quantity.py b/test/test_api_quote_response_quantity.py index d4eb7ff..8ac1bad 100644 --- a/test/test_api_quote_response_quantity.py +++ b/test/test_api_quote_response_quantity.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.api_quote_response_quantity import APIQuoteResponseQuantity # noqa: E501 from billforward.rest import ApiException -from billforward.models.api_quote_response_quantity import APIQuoteResponseQuantity class TestAPIQuoteResponseQuantity(unittest.TestCase): - """ APIQuoteResponseQuantity unit test stubs """ + """APIQuoteResponseQuantity unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testAPIQuoteResponseQuantity(self): - """ - Test APIQuoteResponseQuantity - """ - model = billforward.models.api_quote_response_quantity.APIQuoteResponseQuantity() + """Test APIQuoteResponseQuantity""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.api_quote_response_quantity.APIQuoteResponseQuantity() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_arrears_charge.py b/test/test_arrears_charge.py new file mode 100644 index 0000000..cfe16ad --- /dev/null +++ b/test/test_arrears_charge.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.arrears_charge import ArrearsCharge # noqa: E501 +from billforward.rest import ApiException + + +class TestArrearsCharge(unittest.TestCase): + """ArrearsCharge unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testArrearsCharge(self): + """Test ArrearsCharge""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.arrears_charge.ArrearsCharge() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_arrears_pricing_components_by_charge_model.py b/test/test_arrears_pricing_components_by_charge_model.py new file mode 100644 index 0000000..ea2e10d --- /dev/null +++ b/test/test_arrears_pricing_components_by_charge_model.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.arrears_pricing_components_by_charge_model import ArrearsPricingComponentsByChargeModel # noqa: E501 +from billforward.rest import ApiException + + +class TestArrearsPricingComponentsByChargeModel(unittest.TestCase): + """ArrearsPricingComponentsByChargeModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testArrearsPricingComponentsByChargeModel(self): + """Test ArrearsPricingComponentsByChargeModel""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.arrears_pricing_components_by_charge_model.ArrearsPricingComponentsByChargeModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_audit_entry.py b/test/test_audit_entry.py deleted file mode 100644 index 216618d..0000000 --- a/test/test_audit_entry.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.audit_entry import AuditEntry - - -class TestAuditEntry(unittest.TestCase): - """ AuditEntry unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAuditEntry(self): - """ - Test AuditEntry - """ - model = billforward.models.audit_entry.AuditEntry() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_audit_entry_paged_metadata.py b/test/test_audit_entry_paged_metadata.py deleted file mode 100644 index 79ef76a..0000000 --- a/test/test_audit_entry_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.audit_entry_paged_metadata import AuditEntryPagedMetadata - - -class TestAuditEntryPagedMetadata(unittest.TestCase): - """ AuditEntryPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAuditEntryPagedMetadata(self): - """ - Test AuditEntryPagedMetadata - """ - model = billforward.models.audit_entry_paged_metadata.AuditEntryPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_auditlogs_api.py b/test/test_auditlogs_api.py deleted file mode 100644 index 191a525..0000000 --- a/test/test_auditlogs_api.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.auditlogs_api import AuditlogsApi - - -class TestAuditlogsApi(unittest.TestCase): - """ AuditlogsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.auditlogs_api.AuditlogsApi() - - def tearDown(self): - pass - - def test_get_all_audit_entries(self): - """ - Test case for get_all_audit_entries - - Returns a collection of all audit-log objects. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_audit_entries_by_created_date(self): - """ - Test case for get_audit_entries_by_created_date - - Returns a collection of audit-log objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_audit_entry_by_entity_id(self): - """ - Test case for get_audit_entry_by_entity_id - - Returns a collection of audit-log entries, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_audit_entry_by_entity_type(self): - """ - Test case for get_audit_entry_by_entity_type - - Returns a collection of audit-log entries, specified by the entity-type parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_audit_entry_by_id(self): - """ - Test case for get_audit_entry_by_id - - Returns a single audit-log entry, specified by the audit-ID parameter. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_auth_capture_request.py b/test/test_auth_capture_request.py index 52944bb..66c6b10 100644 --- a/test/test_auth_capture_request.py +++ b/test/test_auth_capture_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.auth_capture_request import AuthCaptureRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.auth_capture_request import AuthCaptureRequest class TestAuthCaptureRequest(unittest.TestCase): - """ AuthCaptureRequest unit test stubs """ + """AuthCaptureRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testAuthCaptureRequest(self): - """ - Test AuthCaptureRequest - """ - model = billforward.models.auth_capture_request.AuthCaptureRequest() + """Test AuthCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.auth_capture_request.AuthCaptureRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_authorize_net_configuration.py b/test/test_authorize_net_configuration.py new file mode 100644 index 0000000..25a7ffd --- /dev/null +++ b/test/test_authorize_net_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.authorize_net_configuration import AuthorizeNetConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestAuthorizeNetConfiguration(unittest.TestCase): + """AuthorizeNetConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAuthorizeNetConfiguration(self): + """Test AuthorizeNetConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.authorize_net_configuration.AuthorizeNetConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_authorize_net_payment.py b/test/test_authorize_net_payment.py new file mode 100644 index 0000000..14cac8f --- /dev/null +++ b/test/test_authorize_net_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.authorize_net_payment import AuthorizeNetPayment # noqa: E501 +from billforward.rest import ApiException + + +class TestAuthorizeNetPayment(unittest.TestCase): + """AuthorizeNetPayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAuthorizeNetPayment(self): + """Test AuthorizeNetPayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.authorize_net_payment.AuthorizeNetPayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_authorize_net_token.py b/test/test_authorize_net_token.py new file mode 100644 index 0000000..1437e53 --- /dev/null +++ b/test/test_authorize_net_token.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.authorize_net_token import AuthorizeNetToken # noqa: E501 +from billforward.rest import ApiException + + +class TestAuthorizeNetToken(unittest.TestCase): + """AuthorizeNetToken unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAuthorizeNetToken(self): + """Test AuthorizeNetToken""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.authorize_net_token.AuthorizeNetToken() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_authorize_net_token_paged_metadata.py b/test/test_authorize_net_token_paged_metadata.py deleted file mode 100644 index b902ae4..0000000 --- a/test/test_authorize_net_token_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.authorize_net_token_paged_metadata import AuthorizeNetTokenPagedMetadata - - -class TestAuthorizeNetTokenPagedMetadata(unittest.TestCase): - """ AuthorizeNetTokenPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAuthorizeNetTokenPagedMetadata(self): - """ - Test AuthorizeNetTokenPagedMetadata - """ - model = billforward.models.authorize_net_token_paged_metadata.AuthorizeNetTokenPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_avatax_api.py b/test/test_avatax_api.py new file mode 100644 index 0000000..e0d0a6b --- /dev/null +++ b/test/test_avatax_api.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.avatax_api import AvataxApi # noqa: E501 +from billforward.rest import ApiException + + +class TestAvataxApi(unittest.TestCase): + """AvataxApi unit test stubs""" + + def setUp(self): + self.api = AvataxApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_avatax_configuration(self): + """Test case for create_avatax_configuration + + """ + pass + + def test_get_avatax_configuration(self): + """Test case for get_avatax_configuration + + """ + pass + + def test_ping(self): + """Test case for ping + + """ + pass + + def test_update_avatax_configuration(self): + """Test case for update_avatax_configuration + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_avatax_config_request.py b/test/test_avatax_config_request.py new file mode 100644 index 0000000..3004546 --- /dev/null +++ b/test/test_avatax_config_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.avatax_config_request import AvataxConfigRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestAvataxConfigRequest(unittest.TestCase): + """AvataxConfigRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAvataxConfigRequest(self): + """Test AvataxConfigRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.avatax_config_request.AvataxConfigRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_avatax_configuration.py b/test/test_avatax_configuration.py new file mode 100644 index 0000000..9512856 --- /dev/null +++ b/test/test_avatax_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.avatax_configuration import AvataxConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestAvataxConfiguration(unittest.TestCase): + """AvataxConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAvataxConfiguration(self): + """Test AvataxConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.avatax_configuration.AvataxConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_avatax_ping_request.py b/test/test_avatax_ping_request.py new file mode 100644 index 0000000..3a540e5 --- /dev/null +++ b/test/test_avatax_ping_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.avatax_ping_request import AvataxPingRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestAvataxPingRequest(unittest.TestCase): + """AvataxPingRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAvataxPingRequest(self): + """Test AvataxPingRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.avatax_ping_request.AvataxPingRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_avatax_ping_response.py b/test/test_avatax_ping_response.py new file mode 100644 index 0000000..8eea986 --- /dev/null +++ b/test/test_avatax_ping_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.avatax_ping_response import AvataxPingResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestAvataxPingResponse(unittest.TestCase): + """AvataxPingResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAvataxPingResponse(self): + """Test AvataxPingResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.avatax_ping_response.AvataxPingResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_bank_account.py b/test/test_bank_account.py new file mode 100644 index 0000000..32c3aa2 --- /dev/null +++ b/test/test_bank_account.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.bank_account import BankAccount # noqa: E501 +from billforward.rest import ApiException + + +class TestBankAccount(unittest.TestCase): + """BankAccount unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBankAccount(self): + """Test BankAccount""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.bank_account.BankAccount() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_bank_account_verification_paged_metadata.py b/test/test_bank_account_verification_paged_metadata.py deleted file mode 100644 index 90e2b9b..0000000 --- a/test/test_bank_account_verification_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.bank_account_verification_paged_metadata import BankAccountVerificationPagedMetadata - - -class TestBankAccountVerificationPagedMetadata(unittest.TestCase): - """ BankAccountVerificationPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBankAccountVerificationPagedMetadata(self): - """ - Test BankAccountVerificationPagedMetadata - """ - model = billforward.models.bank_account_verification_paged_metadata.BankAccountVerificationPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_batch_increment_values_request.py b/test/test_batch_increment_values_request.py new file mode 100644 index 0000000..997b2ec --- /dev/null +++ b/test/test_batch_increment_values_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.batch_increment_values_request import BatchIncrementValuesRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestBatchIncrementValuesRequest(unittest.TestCase): + """BatchIncrementValuesRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBatchIncrementValuesRequest(self): + """Test BatchIncrementValuesRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.batch_increment_values_request.BatchIncrementValuesRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_batch_update_pricing_component_values_request.py b/test/test_batch_update_pricing_component_values_request.py new file mode 100644 index 0000000..781192d --- /dev/null +++ b/test/test_batch_update_pricing_component_values_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.batch_update_pricing_component_values_request import BatchUpdatePricingComponentValuesRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestBatchUpdatePricingComponentValuesRequest(unittest.TestCase): + """BatchUpdatePricingComponentValuesRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBatchUpdatePricingComponentValuesRequest(self): + """Test BatchUpdatePricingComponentValuesRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.batch_update_pricing_component_values_request.BatchUpdatePricingComponentValuesRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_bf_error.py b/test/test_bf_error.py deleted file mode 100644 index 65c7b24..0000000 --- a/test/test_bf_error.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.bf_error import BFError - - -class TestBFError(unittest.TestCase): - """ BFError unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBFError(self): - """ - Test BFError - """ - model = billforward.models.bf_error.BFError() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_bf_permission.py b/test/test_bf_permission.py index 679e09c..c95d569 100644 --- a/test/test_bf_permission.py +++ b/test/test_bf_permission.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.bf_permission import BFPermission # noqa: E501 from billforward.rest import ApiException -from billforward.models.bf_permission import BFPermission class TestBFPermission(unittest.TestCase): - """ BFPermission unit test stubs """ + """BFPermission unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testBFPermission(self): - """ - Test BFPermission - """ - model = billforward.models.bf_permission.BFPermission() + """Test BFPermission""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.bf_permission.BFPermission() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_bf_permission_paged_metadata.py b/test/test_bf_permission_paged_metadata.py deleted file mode 100644 index 7a32166..0000000 --- a/test/test_bf_permission_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.bf_permission_paged_metadata import BFPermissionPagedMetadata - - -class TestBFPermissionPagedMetadata(unittest.TestCase): - """ BFPermissionPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBFPermissionPagedMetadata(self): - """ - Test BFPermissionPagedMetadata - """ - model = billforward.models.bf_permission_paged_metadata.BFPermissionPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_billforward_managed_payments_result_paged_metadata.py b/test/test_billforward_managed_payments_result_paged_metadata.py deleted file mode 100644 index 37c6354..0000000 --- a/test/test_billforward_managed_payments_result_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.billforward_managed_payments_result_paged_metadata import BillforwardManagedPaymentsResultPagedMetadata - - -class TestBillforwardManagedPaymentsResultPagedMetadata(unittest.TestCase): - """ BillforwardManagedPaymentsResultPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBillforwardManagedPaymentsResultPagedMetadata(self): - """ - Test BillforwardManagedPaymentsResultPagedMetadata - """ - model = billforward.models.billforward_managed_payments_result_paged_metadata.BillforwardManagedPaymentsResultPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_billing_entity_base.py b/test/test_billing_entity_base.py index 013b6ae..4da04f5 100644 --- a/test/test_billing_entity_base.py +++ b/test/test_billing_entity_base.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.billing_entity_base import BillingEntityBase # noqa: E501 from billforward.rest import ApiException -from billforward.models.billing_entity_base import BillingEntityBase class TestBillingEntityBase(unittest.TestCase): - """ BillingEntityBase unit test stubs """ + """BillingEntityBase unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testBillingEntityBase(self): - """ - Test BillingEntityBase - """ - model = billforward.models.billing_entity_base.BillingEntityBase() + """Test BillingEntityBase""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.billing_entity_base.BillingEntityBase() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_braintree_auth_capture_request.py b/test/test_braintree_auth_capture_request.py index 6e889c3..6f8576a 100644 --- a/test/test_braintree_auth_capture_request.py +++ b/test/test_braintree_auth_capture_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.braintree_auth_capture_request import BraintreeAuthCaptureRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.braintree_auth_capture_request import BraintreeAuthCaptureRequest class TestBraintreeAuthCaptureRequest(unittest.TestCase): - """ BraintreeAuthCaptureRequest unit test stubs """ + """BraintreeAuthCaptureRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testBraintreeAuthCaptureRequest(self): - """ - Test BraintreeAuthCaptureRequest - """ - model = billforward.models.braintree_auth_capture_request.BraintreeAuthCaptureRequest() + """Test BraintreeAuthCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.braintree_auth_capture_request.BraintreeAuthCaptureRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_braintree_capture_request.py b/test/test_braintree_capture_request.py index d9354f8..a104a89 100644 --- a/test/test_braintree_capture_request.py +++ b/test/test_braintree_capture_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.braintree_capture_request import BraintreeCaptureRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.braintree_capture_request import BraintreeCaptureRequest class TestBraintreeCaptureRequest(unittest.TestCase): - """ BraintreeCaptureRequest unit test stubs """ + """BraintreeCaptureRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testBraintreeCaptureRequest(self): - """ - Test BraintreeCaptureRequest - """ - model = billforward.models.braintree_capture_request.BraintreeCaptureRequest() + """Test BraintreeCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.braintree_capture_request.BraintreeCaptureRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_braintree_configuration.py b/test/test_braintree_configuration.py new file mode 100644 index 0000000..3c80272 --- /dev/null +++ b/test/test_braintree_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.braintree_configuration import BraintreeConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestBraintreeConfiguration(unittest.TestCase): + """BraintreeConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBraintreeConfiguration(self): + """Test BraintreeConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.braintree_configuration.BraintreeConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_braintree_merchant_account.py b/test/test_braintree_merchant_account.py new file mode 100644 index 0000000..a22aabc --- /dev/null +++ b/test/test_braintree_merchant_account.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.braintree_merchant_account import BraintreeMerchantAccount # noqa: E501 +from billforward.rest import ApiException + + +class TestBraintreeMerchantAccount(unittest.TestCase): + """BraintreeMerchantAccount unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBraintreeMerchantAccount(self): + """Test BraintreeMerchantAccount""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.braintree_merchant_account.BraintreeMerchantAccount() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_braintree_payment.py b/test/test_braintree_payment.py new file mode 100644 index 0000000..aacaa22 --- /dev/null +++ b/test/test_braintree_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.braintree_payment import BraintreePayment # noqa: E501 +from billforward.rest import ApiException + + +class TestBraintreePayment(unittest.TestCase): + """BraintreePayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBraintreePayment(self): + """Test BraintreePayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.braintree_payment.BraintreePayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_braintree_pre_auth_request.py b/test/test_braintree_pre_auth_request.py new file mode 100644 index 0000000..37c71bd --- /dev/null +++ b/test/test_braintree_pre_auth_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.braintree_pre_auth_request import BraintreePreAuthRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestBraintreePreAuthRequest(unittest.TestCase): + """BraintreePreAuthRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBraintreePreAuthRequest(self): + """Test BraintreePreAuthRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.braintree_pre_auth_request.BraintreePreAuthRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_braintree_token.py b/test/test_braintree_token.py new file mode 100644 index 0000000..ec028e9 --- /dev/null +++ b/test/test_braintree_token.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.braintree_token import BraintreeToken # noqa: E501 +from billforward.rest import ApiException + + +class TestBraintreeToken(unittest.TestCase): + """BraintreeToken unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBraintreeToken(self): + """Test BraintreeToken""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.braintree_token.BraintreeToken() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_braintree_token_paged_metadata.py b/test/test_braintree_token_paged_metadata.py deleted file mode 100644 index 07ee647..0000000 --- a/test/test_braintree_token_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.braintree_token_paged_metadata import BraintreeTokenPagedMetadata - - -class TestBraintreeTokenPagedMetadata(unittest.TestCase): - """ BraintreeTokenPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBraintreeTokenPagedMetadata(self): - """ - Test BraintreeTokenPagedMetadata - """ - model = billforward.models.braintree_token_paged_metadata.BraintreeTokenPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_calculator_result.py b/test/test_calculator_result.py new file mode 100644 index 0000000..ff5f02e --- /dev/null +++ b/test/test_calculator_result.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.calculator_result import CalculatorResult # noqa: E501 +from billforward.rest import ApiException + + +class TestCalculatorResult(unittest.TestCase): + """CalculatorResult unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCalculatorResult(self): + """Test CalculatorResult""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.calculator_result.CalculatorResult() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_cancel_subscription_request.py b/test/test_cancel_subscription_request.py deleted file mode 100644 index 3e62d78..0000000 --- a/test/test_cancel_subscription_request.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.cancel_subscription_request import CancelSubscriptionRequest - - -class TestCancelSubscriptionRequest(unittest.TestCase): - """ CancelSubscriptionRequest unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCancelSubscriptionRequest(self): - """ - Test CancelSubscriptionRequest - """ - model = billforward.models.cancel_subscription_request.CancelSubscriptionRequest() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_cancellation_amendment.py b/test/test_cancellation_amendment.py index 3dbf58c..62e8824 100644 --- a/test/test_cancellation_amendment.py +++ b/test/test_cancellation_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.cancellation_amendment import CancellationAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.cancellation_amendment import CancellationAmendment class TestCancellationAmendment(unittest.TestCase): - """ CancellationAmendment unit test stubs """ + """CancellationAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCancellationAmendment(self): - """ - Test CancellationAmendment - """ - model = billforward.models.cancellation_amendment.CancellationAmendment() + """Test CancellationAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.cancellation_amendment.CancellationAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_card_connect_api.py b/test/test_card_connect_api.py new file mode 100644 index 0000000..567dfb1 --- /dev/null +++ b/test/test_card_connect_api.py @@ -0,0 +1,51 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.card_connect_api import CardConnectApi # noqa: E501 +from billforward.rest import ApiException + + +class TestCardConnectApi(unittest.TestCase): + """CardConnectApi unit test stubs""" + + def setUp(self): + self.api = CardConnectApi() # noqa: E501 + + def tearDown(self): + pass + + def test_delete_configuration(self): + """Test case for delete_configuration + + """ + pass + + def test_get_configuration(self): + """Test case for get_configuration + + """ + pass + + def test_upsert_configuration(self): + """Test case for upsert_configuration + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_card_connect_auth_capture_request.py b/test/test_card_connect_auth_capture_request.py new file mode 100644 index 0000000..3b53d65 --- /dev/null +++ b/test/test_card_connect_auth_capture_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.card_connect_auth_capture_request import CardConnectAuthCaptureRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCardConnectAuthCaptureRequest(unittest.TestCase): + """CardConnectAuthCaptureRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCardConnectAuthCaptureRequest(self): + """Test CardConnectAuthCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.card_connect_auth_capture_request.CardConnectAuthCaptureRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_card_connect_configuration.py b/test/test_card_connect_configuration.py new file mode 100644 index 0000000..c5481a6 --- /dev/null +++ b/test/test_card_connect_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.card_connect_configuration import CardConnectConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestCardConnectConfiguration(unittest.TestCase): + """CardConnectConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCardConnectConfiguration(self): + """Test CardConnectConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.card_connect_configuration.CardConnectConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_card_connect_gateway_request.py b/test/test_card_connect_gateway_request.py new file mode 100644 index 0000000..8e11829 --- /dev/null +++ b/test/test_card_connect_gateway_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.card_connect_gateway_request import CardConnectGatewayRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCardConnectGatewayRequest(unittest.TestCase): + """CardConnectGatewayRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCardConnectGatewayRequest(self): + """Test CardConnectGatewayRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.card_connect_gateway_request.CardConnectGatewayRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_card_connect_payment.py b/test/test_card_connect_payment.py new file mode 100644 index 0000000..46044e6 --- /dev/null +++ b/test/test_card_connect_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.card_connect_payment import CardConnectPayment # noqa: E501 +from billforward.rest import ApiException + + +class TestCardConnectPayment(unittest.TestCase): + """CardConnectPayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCardConnectPayment(self): + """Test CardConnectPayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.card_connect_payment.CardConnectPayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_cass_churn_result_paged_metadata.py b/test/test_cass_churn_result_paged_metadata.py deleted file mode 100644 index 7adff51..0000000 --- a/test/test_cass_churn_result_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.cass_churn_result_paged_metadata import CassChurnResultPagedMetadata - - -class TestCassChurnResultPagedMetadata(unittest.TestCase): - """ CassChurnResultPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCassChurnResultPagedMetadata(self): - """ - Test CassChurnResultPagedMetadata - """ - model = billforward.models.cass_churn_result_paged_metadata.CassChurnResultPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_cass_payment_result_paged_metadata.py b/test/test_cass_payment_result_paged_metadata.py deleted file mode 100644 index 090f988..0000000 --- a/test/test_cass_payment_result_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.cass_payment_result_paged_metadata import CassPaymentResultPagedMetadata - - -class TestCassPaymentResultPagedMetadata(unittest.TestCase): - """ CassPaymentResultPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCassPaymentResultPagedMetadata(self): - """ - Test CassPaymentResultPagedMetadata - """ - model = billforward.models.cass_payment_result_paged_metadata.CassPaymentResultPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_cass_upgrade_result_paged_metadata.py b/test/test_cass_upgrade_result_paged_metadata.py deleted file mode 100644 index 9af45af..0000000 --- a/test/test_cass_upgrade_result_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.cass_upgrade_result_paged_metadata import CassUpgradeResultPagedMetadata - - -class TestCassUpgradeResultPagedMetadata(unittest.TestCase): - """ CassUpgradeResultPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCassUpgradeResultPagedMetadata(self): - """ - Test CassUpgradeResultPagedMetadata - """ - model = billforward.models.cass_upgrade_result_paged_metadata.CassUpgradeResultPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_charges_api.py b/test/test_charges_api.py index 4776537..113f1ac 100644 --- a/test/test_charges_api.py +++ b/test/test_charges_api.py @@ -1,99 +1,60 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.api.charges_api import ChargesApi # noqa: E501 from billforward.rest import ApiException -from billforward.apis.charges_api import ChargesApi class TestChargesApi(unittest.TestCase): - """ ChargesApi unit test stubs """ + """ChargesApi unit test stubs""" def setUp(self): - self.api = billforward.apis.charges_api.ChargesApi() + self.api = ChargesApi() # noqa: E501 def tearDown(self): pass - def test_get_all_subscription_charges(self): - """ - Test case for get_all_subscription_charges + def test_batch_recalculate_subscription_charge(self): + """Test case for batch_recalculate_subscription_charge - Retrieves a collection of all charges. By default 10 values are returned. Records are returned in natural order. """ pass - def test_get_subscription_charge_by_account_id(self): - """ - Test case for get_subscription_charge_by_account_id + def test_get_all_subscription_charges(self): + """Test case for get_all_subscription_charges - Retrieves a collection of charges, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_subscription_charge_by_id(self): - """ - Test case for get_subscription_charge_by_id - - Retrieves a single charge, specified by the charge-id parameter. - """ - pass - - def test_get_subscription_charge_by_state(self): - """ - Test case for get_subscription_charge_by_state - - Retrieves a collection of charges, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_subscription_charge_by_version_id(self): - """ - Test case for get_subscription_charge_by_version_id + """Test case for get_subscription_charge_by_id - Retrieves a single charge, specified by the version-ID parameter. """ pass def test_recalculate_subscription_charge(self): - """ - Test case for recalculate_subscription_charge + """Test case for recalculate_subscription_charge - Recalculate a charge. """ pass def test_void_subscription_charge(self): - """ - Test case for void_subscription_charge + """Test case for void_subscription_charge - Void the charge with the specified charge-ID. """ pass diff --git a/test/test_checkout_api.py b/test/test_checkout_api.py new file mode 100644 index 0000000..fabbe82 --- /dev/null +++ b/test/test_checkout_api.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.checkout_api import CheckoutApi # noqa: E501 +from billforward.rest import ApiException + + +class TestCheckoutApi(unittest.TestCase): + """CheckoutApi unit test stubs""" + + def setUp(self): + self.api = CheckoutApi() # noqa: E501 + + def tearDown(self): + pass + + def test_build_subscription_checkout(self): + """Test case for build_subscription_checkout + + """ + pass + + def test_create_account1(self): + """Test case for create_account1 + + """ + pass + + def test_create_subscription_checkout_definition(self): + """Test case for create_subscription_checkout_definition + + """ + pass + + def test_get_subscription_checkout_definition(self): + """Test case for get_subscription_checkout_definition + + """ + pass + + def test_subscription_checkout(self): + """Test case for subscription_checkout + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_client.py b/test/test_client.py deleted file mode 100644 index 13002e6..0000000 --- a/test/test_client.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.client import Client - - -class TestClient(unittest.TestCase): - """ Client unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testClient(self): - """ - Test Client - """ - model = billforward.models.client.Client() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_client_paged_metadata.py b/test/test_client_paged_metadata.py deleted file mode 100644 index 07915bb..0000000 --- a/test/test_client_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.client_paged_metadata import ClientPagedMetadata - - -class TestClientPagedMetadata(unittest.TestCase): - """ ClientPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testClientPagedMetadata(self): - """ - Test ClientPagedMetadata - """ - model = billforward.models.client_paged_metadata.ClientPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_clients_api.py b/test/test_clients_api.py deleted file mode 100644 index aa9d9a8..0000000 --- a/test/test_clients_api.py +++ /dev/null @@ -1,78 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.clients_api import ClientsApi - - -class TestClientsApi(unittest.TestCase): - """ ClientsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.clients_api.ClientsApi() - - def tearDown(self): - pass - - def test_create_client(self): - """ - Test case for create_client - - Create a client. - """ - pass - - def test_get_all_clients(self): - """ - Test case for get_all_clients - - Returns a collection of clients. - """ - pass - - def test_get_client_by_id(self): - """ - Test case for get_client_by_id - - Returns a single client, specified by the client-ID parameter. - """ - pass - - def test_update_client(self): - """ - Test case for update_client - - Update a client. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_commission_structure.py b/test/test_commission_structure.py new file mode 100644 index 0000000..fb0f4a3 --- /dev/null +++ b/test/test_commission_structure.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.commission_structure import CommissionStructure # noqa: E501 +from billforward.rest import ApiException + + +class TestCommissionStructure(unittest.TestCase): + """CommissionStructure unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCommissionStructure(self): + """Test CommissionStructure""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.commission_structure.CommissionStructure() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_component_change.py b/test/test_component_change.py index 5cb066a..78c6d4b 100644 --- a/test/test_component_change.py +++ b/test/test_component_change.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.component_change import ComponentChange # noqa: E501 from billforward.rest import ApiException -from billforward.models.component_change import ComponentChange class TestComponentChange(unittest.TestCase): - """ ComponentChange unit test stubs """ + """ComponentChange unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testComponentChange(self): - """ - Test ComponentChange - """ - model = billforward.models.component_change.ComponentChange() + """Test ComponentChange""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.component_change.ComponentChange() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_component_cost.py b/test/test_component_cost.py deleted file mode 100644 index 7e07cdf..0000000 --- a/test/test_component_cost.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.component_cost import ComponentCost - - -class TestComponentCost(unittest.TestCase): - """ ComponentCost unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testComponentCost(self): - """ - Test ComponentCost - """ - model = billforward.models.component_cost.ComponentCost() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_compound_usage.py b/test/test_compound_usage.py deleted file mode 100644 index fbb7597..0000000 --- a/test/test_compound_usage.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.compound_usage import CompoundUsage - - -class TestCompoundUsage(unittest.TestCase): - """ CompoundUsage unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCompoundUsage(self): - """ - Test CompoundUsage - """ - model = billforward.models.compound_usage.CompoundUsage() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_compound_usage_session.py b/test/test_compound_usage_session.py deleted file mode 100644 index 4276678..0000000 --- a/test/test_compound_usage_session.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.compound_usage_session import CompoundUsageSession - - -class TestCompoundUsageSession(unittest.TestCase): - """ CompoundUsageSession unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCompoundUsageSession(self): - """ - Test CompoundUsageSession - """ - model = billforward.models.compound_usage_session.CompoundUsageSession() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_configurations_api.py b/test/test_configurations_api.py deleted file mode 100644 index 548506d..0000000 --- a/test/test_configurations_api.py +++ /dev/null @@ -1,78 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.configurations_api import ConfigurationsApi - - -class TestConfigurationsApi(unittest.TestCase): - """ ConfigurationsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.configurations_api.ConfigurationsApi() - - def tearDown(self): - pass - - def test_create_api_configuration(self): - """ - Test case for create_api_configuration - - Create a configuration. - """ - pass - - def test_get_all_api_configurations(self): - """ - Test case for get_all_api_configurations - - Returns a collection of configurations. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_api_configurations_by_type(self): - """ - Test case for get_api_configurations_by_type - - Returns a single configuration, specified by the type parameter. - """ - pass - - def test_update_api_configuration(self): - """ - Test case for update_api_configuration - - Update a configuration. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_contract.py b/test/test_contract.py new file mode 100644 index 0000000..9ac46bf --- /dev/null +++ b/test/test_contract.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.contract import Contract # noqa: E501 +from billforward.rest import ApiException + + +class TestContract(unittest.TestCase): + """Contract unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testContract(self): + """Test Contract""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.contract.Contract() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_contract_period.py b/test/test_contract_period.py new file mode 100644 index 0000000..b685810 --- /dev/null +++ b/test/test_contract_period.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.contract_period import ContractPeriod # noqa: E501 +from billforward.rest import ApiException + + +class TestContractPeriod(unittest.TestCase): + """ContractPeriod unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testContractPeriod(self): + """Test ContractPeriod""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.contract_period.ContractPeriod() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_contracts_api.py b/test/test_contracts_api.py new file mode 100644 index 0000000..f6abdfd --- /dev/null +++ b/test/test_contracts_api.py @@ -0,0 +1,81 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.contracts_api import ContractsApi # noqa: E501 +from billforward.rest import ApiException + + +class TestContractsApi(unittest.TestCase): + """ContractsApi unit test stubs""" + + def setUp(self): + self.api = ContractsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_add_contract_period(self): + """Test case for add_contract_period + + """ + pass + + def test_create_contract(self): + """Test case for create_contract + + """ + pass + + def test_get_all_contracts(self): + """Test case for get_all_contracts + + """ + pass + + def test_get_contract_by_id(self): + """Test case for get_contract_by_id + + """ + pass + + def test_start_contract(self): + """Test case for start_contract + + """ + pass + + def test_update_contract(self): + """Test case for update_contract + + """ + pass + + def test_void_contract(self): + """Test case for void_contract + + """ + pass + + def test_void_final_contract_period(self): + """Test case for void_final_contract_period + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_coupon.py b/test/test_coupon.py index 98f84ae..dff4b89 100644 --- a/test/test_coupon.py +++ b/test/test_coupon.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.coupon import Coupon # noqa: E501 from billforward.rest import ApiException -from billforward.models.coupon import Coupon class TestCoupon(unittest.TestCase): - """ Coupon unit test stubs """ + """Coupon unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCoupon(self): - """ - Test Coupon - """ - model = billforward.models.coupon.Coupon() + """Test Coupon""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.coupon.Coupon() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_coupon_book.py b/test/test_coupon_book.py deleted file mode 100644 index 0e03fb1..0000000 --- a/test/test_coupon_book.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_book import CouponBook - - -class TestCouponBook(unittest.TestCase): - """ CouponBook unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponBook(self): - """ - Test CouponBook - """ - model = billforward.models.coupon_book.CouponBook() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_book_definition.py b/test/test_coupon_book_definition.py deleted file mode 100644 index e1216b5..0000000 --- a/test/test_coupon_book_definition.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_book_definition import CouponBookDefinition - - -class TestCouponBookDefinition(unittest.TestCase): - """ CouponBookDefinition unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponBookDefinition(self): - """ - Test CouponBookDefinition - """ - model = billforward.models.coupon_book_definition.CouponBookDefinition() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_book_definition_paged_metadata.py b/test/test_coupon_book_definition_paged_metadata.py deleted file mode 100644 index a5bd6ed..0000000 --- a/test/test_coupon_book_definition_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_book_definition_paged_metadata import CouponBookDefinitionPagedMetadata - - -class TestCouponBookDefinitionPagedMetadata(unittest.TestCase): - """ CouponBookDefinitionPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponBookDefinitionPagedMetadata(self): - """ - Test CouponBookDefinitionPagedMetadata - """ - model = billforward.models.coupon_book_definition_paged_metadata.CouponBookDefinitionPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_book_paged_metadata.py b/test/test_coupon_book_paged_metadata.py deleted file mode 100644 index 5a2d723..0000000 --- a/test/test_coupon_book_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_book_paged_metadata import CouponBookPagedMetadata - - -class TestCouponBookPagedMetadata(unittest.TestCase): - """ CouponBookPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponBookPagedMetadata(self): - """ - Test CouponBookPagedMetadata - """ - model = billforward.models.coupon_book_paged_metadata.CouponBookPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_charge.py b/test/test_coupon_charge.py new file mode 100644 index 0000000..0d12122 --- /dev/null +++ b/test/test_coupon_charge.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.coupon_charge import CouponCharge # noqa: E501 +from billforward.rest import ApiException + + +class TestCouponCharge(unittest.TestCase): + """CouponCharge unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCouponCharge(self): + """Test CouponCharge""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.coupon_charge.CouponCharge() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_coupon_code_response.py b/test/test_coupon_code_response.py new file mode 100644 index 0000000..f1bfbc3 --- /dev/null +++ b/test/test_coupon_code_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.coupon_code_response import CouponCodeResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestCouponCodeResponse(unittest.TestCase): + """CouponCodeResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCouponCodeResponse(self): + """Test CouponCodeResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.coupon_code_response.CouponCodeResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_coupon_definition.py b/test/test_coupon_definition.py deleted file mode 100644 index 32edb8a..0000000 --- a/test/test_coupon_definition.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_definition import CouponDefinition - - -class TestCouponDefinition(unittest.TestCase): - """ CouponDefinition unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponDefinition(self): - """ - Test CouponDefinition - """ - model = billforward.models.coupon_definition.CouponDefinition() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_definition_paged_metadata.py b/test/test_coupon_definition_paged_metadata.py deleted file mode 100644 index 733acb2..0000000 --- a/test/test_coupon_definition_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_definition_paged_metadata import CouponDefinitionPagedMetadata - - -class TestCouponDefinitionPagedMetadata(unittest.TestCase): - """ CouponDefinitionPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponDefinitionPagedMetadata(self): - """ - Test CouponDefinitionPagedMetadata - """ - model = billforward.models.coupon_definition_paged_metadata.CouponDefinitionPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_discount.py b/test/test_coupon_discount.py index f9da466..217ad34 100644 --- a/test/test_coupon_discount.py +++ b/test/test_coupon_discount.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.coupon_discount import CouponDiscount # noqa: E501 from billforward.rest import ApiException -from billforward.models.coupon_discount import CouponDiscount class TestCouponDiscount(unittest.TestCase): - """ CouponDiscount unit test stubs """ + """CouponDiscount unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCouponDiscount(self): - """ - Test CouponDiscount - """ - model = billforward.models.coupon_discount.CouponDiscount() + """Test CouponDiscount""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.coupon_discount.CouponDiscount() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_coupon_discount_estimate.py b/test/test_coupon_discount_estimate.py deleted file mode 100644 index 67a716b..0000000 --- a/test/test_coupon_discount_estimate.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_discount_estimate import CouponDiscountEstimate - - -class TestCouponDiscountEstimate(unittest.TestCase): - """ CouponDiscountEstimate unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponDiscountEstimate(self): - """ - Test CouponDiscountEstimate - """ - model = billforward.models.coupon_discount_estimate.CouponDiscountEstimate() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_instance.py b/test/test_coupon_instance.py index 1e4ab82..11d2b68 100644 --- a/test/test_coupon_instance.py +++ b/test/test_coupon_instance.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.coupon_instance import CouponInstance # noqa: E501 from billforward.rest import ApiException -from billforward.models.coupon_instance import CouponInstance class TestCouponInstance(unittest.TestCase): - """ CouponInstance unit test stubs """ + """CouponInstance unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCouponInstance(self): - """ - Test CouponInstance - """ - model = billforward.models.coupon_instance.CouponInstance() + """Test CouponInstance""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.coupon_instance.CouponInstance() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_coupon_instance_existing_value.py b/test/test_coupon_instance_existing_value.py index 97b1e60..980b09a 100644 --- a/test/test_coupon_instance_existing_value.py +++ b/test/test_coupon_instance_existing_value.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.coupon_instance_existing_value import CouponInstanceExistingValue # noqa: E501 from billforward.rest import ApiException -from billforward.models.coupon_instance_existing_value import CouponInstanceExistingValue class TestCouponInstanceExistingValue(unittest.TestCase): - """ CouponInstanceExistingValue unit test stubs """ + """CouponInstanceExistingValue unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCouponInstanceExistingValue(self): - """ - Test CouponInstanceExistingValue - """ - model = billforward.models.coupon_instance_existing_value.CouponInstanceExistingValue() + """Test CouponInstanceExistingValue""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.coupon_instance_existing_value.CouponInstanceExistingValue() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_coupon_instance_paged_metadata.py b/test/test_coupon_instance_paged_metadata.py deleted file mode 100644 index d4ca727..0000000 --- a/test/test_coupon_instance_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_instance_paged_metadata import CouponInstancePagedMetadata - - -class TestCouponInstancePagedMetadata(unittest.TestCase): - """ CouponInstancePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponInstancePagedMetadata(self): - """ - Test CouponInstancePagedMetadata - """ - model = billforward.models.coupon_instance_paged_metadata.CouponInstancePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_modifier_base.py b/test/test_coupon_modifier_base.py deleted file mode 100644 index cb35abd..0000000 --- a/test/test_coupon_modifier_base.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_modifier_base import CouponModifierBase - - -class TestCouponModifierBase(unittest.TestCase): - """ CouponModifierBase unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponModifierBase(self): - """ - Test CouponModifierBase - """ - model = billforward.models.coupon_modifier_base.CouponModifierBase() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_modifier_base_paged_metadata.py b/test/test_coupon_modifier_base_paged_metadata.py deleted file mode 100644 index e0ca89b..0000000 --- a/test/test_coupon_modifier_base_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_modifier_base_paged_metadata import CouponModifierBasePagedMetadata - - -class TestCouponModifierBasePagedMetadata(unittest.TestCase): - """ CouponModifierBasePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponModifierBasePagedMetadata(self): - """ - Test CouponModifierBasePagedMetadata - """ - model = billforward.models.coupon_modifier_base_paged_metadata.CouponModifierBasePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_paged_metadata.py b/test/test_coupon_paged_metadata.py deleted file mode 100644 index e3e026b..0000000 --- a/test/test_coupon_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_paged_metadata import CouponPagedMetadata - - -class TestCouponPagedMetadata(unittest.TestCase): - """ CouponPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponPagedMetadata(self): - """ - Test CouponPagedMetadata - """ - model = billforward.models.coupon_paged_metadata.CouponPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_payment.py b/test/test_coupon_payment.py new file mode 100644 index 0000000..753cc14 --- /dev/null +++ b/test/test_coupon_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.coupon_payment import CouponPayment # noqa: E501 +from billforward.rest import ApiException + + +class TestCouponPayment(unittest.TestCase): + """CouponPayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCouponPayment(self): + """Test CouponPayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.coupon_payment.CouponPayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_coupon_rule.py b/test/test_coupon_rule.py deleted file mode 100644 index 6c4fca7..0000000 --- a/test/test_coupon_rule.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_rule import CouponRule - - -class TestCouponRule(unittest.TestCase): - """ CouponRule unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponRule(self): - """ - Test CouponRule - """ - model = billforward.models.coupon_rule.CouponRule() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_rule_paged_metadata.py b/test/test_coupon_rule_paged_metadata.py deleted file mode 100644 index 71d22fc..0000000 --- a/test/test_coupon_rule_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_rule_paged_metadata import CouponRulePagedMetadata - - -class TestCouponRulePagedMetadata(unittest.TestCase): - """ CouponRulePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponRulePagedMetadata(self): - """ - Test CouponRulePagedMetadata - """ - model = billforward.models.coupon_rule_paged_metadata.CouponRulePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_unique_codes_request.py b/test/test_coupon_unique_codes_request.py index 2404f94..0ba5533 100644 --- a/test/test_coupon_unique_codes_request.py +++ b/test/test_coupon_unique_codes_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.coupon_unique_codes_request import CouponUniqueCodesRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.coupon_unique_codes_request import CouponUniqueCodesRequest class TestCouponUniqueCodesRequest(unittest.TestCase): - """ CouponUniqueCodesRequest unit test stubs """ + """CouponUniqueCodesRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCouponUniqueCodesRequest(self): - """ - Test CouponUniqueCodesRequest - """ - model = billforward.models.coupon_unique_codes_request.CouponUniqueCodesRequest() + """Test CouponUniqueCodesRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.coupon_unique_codes_request.CouponUniqueCodesRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_coupon_unique_codes_response.py b/test/test_coupon_unique_codes_response.py index bb601d0..e376ed4 100644 --- a/test/test_coupon_unique_codes_response.py +++ b/test/test_coupon_unique_codes_response.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.coupon_unique_codes_response import CouponUniqueCodesResponse # noqa: E501 from billforward.rest import ApiException -from billforward.models.coupon_unique_codes_response import CouponUniqueCodesResponse class TestCouponUniqueCodesResponse(unittest.TestCase): - """ CouponUniqueCodesResponse unit test stubs """ + """CouponUniqueCodesResponse unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCouponUniqueCodesResponse(self): - """ - Test CouponUniqueCodesResponse - """ - model = billforward.models.coupon_unique_codes_response.CouponUniqueCodesResponse() + """Test CouponUniqueCodesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.coupon_unique_codes_response.CouponUniqueCodesResponse() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_coupon_unique_codes_response_paged_metadata.py b/test/test_coupon_unique_codes_response_paged_metadata.py deleted file mode 100644 index 2dbe176..0000000 --- a/test/test_coupon_unique_codes_response_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.coupon_unique_codes_response_paged_metadata import CouponUniqueCodesResponsePagedMetadata - - -class TestCouponUniqueCodesResponsePagedMetadata(unittest.TestCase): - """ CouponUniqueCodesResponsePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponUniqueCodesResponsePagedMetadata(self): - """ - Test CouponUniqueCodesResponsePagedMetadata - """ - model = billforward.models.coupon_unique_codes_response_paged_metadata.CouponUniqueCodesResponsePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_wrapper_response.py b/test/test_coupon_wrapper_response.py index 0b2159f..71c202a 100644 --- a/test/test_coupon_wrapper_response.py +++ b/test/test_coupon_wrapper_response.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.coupon_wrapper_response import CouponWrapperResponse # noqa: E501 from billforward.rest import ApiException -from billforward.models.coupon_wrapper_response import CouponWrapperResponse class TestCouponWrapperResponse(unittest.TestCase): - """ CouponWrapperResponse unit test stubs """ + """CouponWrapperResponse unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCouponWrapperResponse(self): - """ - Test CouponWrapperResponse - """ - model = billforward.models.coupon_wrapper_response.CouponWrapperResponse() + """Test CouponWrapperResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.coupon_wrapper_response.CouponWrapperResponse() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_couponbook_api.py b/test/test_couponbook_api.py deleted file mode 100644 index 3c281c2..0000000 --- a/test/test_couponbook_api.py +++ /dev/null @@ -1,118 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.couponbook_api import CouponbookApi - - -class TestCouponbookApi(unittest.TestCase): - """ CouponbookApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.couponbook_api.CouponbookApi() - - def tearDown(self): - pass - - def test_create_coupon_book(self): - """ - Test case for create_coupon_book - - Create a coupon-book. - """ - pass - - def test_delete_coupon_book(self): - """ - Test case for delete_coupon_book - - Retire a coupon-book, specified by the coupon-book-ID parameter. - """ - pass - - def test_get_all_attachable_coupon_books(self): - """ - Test case for get_all_attachable_coupon_books - - Returns a collection of attachable coupon-books. An attachable coupon-book has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_all_coupon_books(self): - """ - Test case for get_all_coupon_books - - Returns a collection of coupon-books. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_coupon_book_by_book_code(self): - """ - Test case for get_coupon_book_by_book_code - - Returns a single coupon-book, specified by the book-code parameter. - """ - pass - - def test_get_coupon_book_by_coupon_book_definition_id(self): - """ - Test case for get_coupon_book_by_coupon_book_definition_id - - Returns a collection of coupon-books, specified by coupon-book-definition-ID parameter. By default 10 coupon-books are returned. Records are returned in natural order. - """ - pass - - def test_get_coupon_book_by_coupon_code(self): - """ - Test case for get_coupon_book_by_coupon_code - - Returns a single coupon-book, specified by the coupon-code parameter. - """ - pass - - def test_get_coupon_book_by_id(self): - """ - Test case for get_coupon_book_by_id - - Returns a single coupon-book, specified by the coupon-book-ID parameter. - """ - pass - - def test_update_coupon_book(self): - """ - Test case for update_coupon_book - - Update a coupon-book. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_couponbookdefinition_api.py b/test/test_couponbookdefinition_api.py deleted file mode 100644 index 217c5c3..0000000 --- a/test/test_couponbookdefinition_api.py +++ /dev/null @@ -1,94 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.couponbookdefinition_api import CouponbookdefinitionApi - - -class TestCouponbookdefinitionApi(unittest.TestCase): - """ CouponbookdefinitionApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.couponbookdefinition_api.CouponbookdefinitionApi() - - def tearDown(self): - pass - - def test_create_coupon_book_definition(self): - """ - Test case for create_coupon_book_definition - - Create a coupon-book-definition. - """ - pass - - def test_delete_coupon_book_definition(self): - """ - Test case for delete_coupon_book_definition - - Retire a coupon-book-definition, specified by the coupon-book-definition-ID parameter. - """ - pass - - def test_get_all_coupon_book_definitions(self): - """ - Test case for get_all_coupon_book_definitions - - Returns a collection of coupon-book-definitions. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_coupon_book_definition_by_coupon_definition_id(self): - """ - Test case for get_coupon_book_definition_by_coupon_definition_id - - Returns a collection of coupon-book-definitions, specified by coupon-definition-ID parameter. By default 10 coupon-book-definitions are returned. Records are returned in natural order. - """ - pass - - def test_get_coupon_book_definition_by_id(self): - """ - Test case for get_coupon_book_definition_by_id - - Returns a single coupon-book-definition, specified by the coupon-book-definition-ID parameter. - """ - pass - - def test_update_coupon_book_definition(self): - """ - Test case for update_coupon_book_definition - - Update a coupon-book-definition. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupondefinition_api.py b/test/test_coupondefinition_api.py deleted file mode 100644 index 57b0dcc..0000000 --- a/test/test_coupondefinition_api.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.coupondefinition_api import CoupondefinitionApi - - -class TestCoupondefinitionApi(unittest.TestCase): - """ CoupondefinitionApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.coupondefinition_api.CoupondefinitionApi() - - def tearDown(self): - pass - - def test_create_coupon_definition(self): - """ - Test case for create_coupon_definition - - Create a coupon-definition. - """ - pass - - def test_delete_coupon_definition(self): - """ - Test case for delete_coupon_definition - - Retire a coupon-definition, specified by the coupon-definition-ID parameter. - """ - pass - - def test_get_all_coupon_definitions(self): - """ - Test case for get_all_coupon_definitions - - Returns a collection of coupon-definitions. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_coupon_definition_by_id(self): - """ - Test case for get_coupon_definition_by_id - - Returns a single coupon-definition, specified by the coupon-definition-ID parameter. - """ - pass - - def test_update_coupon_definition(self): - """ - Test case for update_coupon_definition - - Update a coupon-definition. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_couponinstance_api.py b/test/test_couponinstance_api.py deleted file mode 100644 index 7650eae..0000000 --- a/test/test_couponinstance_api.py +++ /dev/null @@ -1,126 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.couponinstance_api import CouponinstanceApi - - -class TestCouponinstanceApi(unittest.TestCase): - """ CouponinstanceApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.couponinstance_api.CouponinstanceApi() - - def tearDown(self): - pass - - def test_create_coupon_instance(self): - """ - Test case for create_coupon_instance - - Create a coupon-instance. - """ - pass - - def test_delete_coupon_instance(self): - """ - Test case for delete_coupon_instance - - Retire a coupon-instance, specified by the coupon-instance-ID parameter. - """ - pass - - def test_get_all_attachable_coupon_instances(self): - """ - Test case for get_all_attachable_coupon_instances - - Returns a collection of attachable coupon-instances. An attachable coupon-instance has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_all_coupon_instances(self): - """ - Test case for get_all_coupon_instances - - Returns a collection of coupon-instances. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_coupon_instance_by_coupon_code(self): - """ - Test case for get_coupon_instance_by_coupon_code - - Returns a collection of coupon-instances, specified by coupon-code parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - """ - pass - - def test_get_coupon_instance_by_coupon_definition_id(self): - """ - Test case for get_coupon_instance_by_coupon_definition_id - - Returns a collection of coupon-instances, specified by coupon-definition-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - """ - pass - - def test_get_coupon_instance_by_id(self): - """ - Test case for get_coupon_instance_by_id - - Returns a single coupon-instance, specified by the coupon-instance-ID parameter. - """ - pass - - def test_get_coupon_instance_by_target_id(self): - """ - Test case for get_coupon_instance_by_target_id - - Returns a collection of coupon-instances, specified by target-ID parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - """ - pass - - def test_get_coupon_instance_by_target_type(self): - """ - Test case for get_coupon_instance_by_target_type - - Returns a collection of coupon-instances, specified by target parameter. By default 10 coupon-instances are returned. Records are returned in natural order. - """ - pass - - def test_update_coupon_instance(self): - """ - Test case for update_coupon_instance - - Update a coupon-instance. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_couponmodifier_api.py b/test/test_couponmodifier_api.py deleted file mode 100644 index 6797af3..0000000 --- a/test/test_couponmodifier_api.py +++ /dev/null @@ -1,102 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.couponmodifier_api import CouponmodifierApi - - -class TestCouponmodifierApi(unittest.TestCase): - """ CouponmodifierApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.couponmodifier_api.CouponmodifierApi() - - def tearDown(self): - pass - - def test_create_coupon_modifier(self): - """ - Test case for create_coupon_modifier - - Create a coupon-modifier. - """ - pass - - def test_delete_coupon_modifier(self): - """ - Test case for delete_coupon_modifier - - Retire a coupon-modifier, specified by the coupon-modifier-ID parameter. - """ - pass - - def test_get_all_coupon_modifiers(self): - """ - Test case for get_all_coupon_modifiers - - Returns a collection of coupon-modifiers. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_coupon_modifier_by_coupon_code(self): - """ - Test case for get_coupon_modifier_by_coupon_code - - Returns a collection of coupon-modifiers, specified by the coupon-code parameter. - """ - pass - - def test_get_coupon_modifier_by_coupon_definition_id(self): - """ - Test case for get_coupon_modifier_by_coupon_definition_id - - Returns a collection of coupon-modifiers, specified by the coupon-definition-ID parameter. - """ - pass - - def test_get_coupon_modifier_by_id(self): - """ - Test case for get_coupon_modifier_by_id - - Returns a single coupon-modifier, specified by the coupon-modifier-ID parameter. - """ - pass - - def test_update_coupon_modifier(self): - """ - Test case for update_coupon_modifier - - Update a coupon-instance. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_couponrule_api.py b/test/test_couponrule_api.py deleted file mode 100644 index efd6033..0000000 --- a/test/test_couponrule_api.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.couponrule_api import CouponruleApi - - -class TestCouponruleApi(unittest.TestCase): - """ CouponruleApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.couponrule_api.CouponruleApi() - - def tearDown(self): - pass - - def test_create_coupon_rule(self): - """ - Test case for create_coupon_rule - - Create a coupon-rule. - """ - pass - - def test_delete_coupon_rule(self): - """ - Test case for delete_coupon_rule - - Retire a coupon-rule, specified by the coupon-rule-ID parameter. - """ - pass - - def test_get_all_coupon_rules(self): - """ - Test case for get_all_coupon_rules - - Returns a collection of coupon-rules. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_coupon_rule_by_coupon_definition_id(self): - """ - Test case for get_coupon_rule_by_coupon_definition_id - - Returns a single coupon-definition, specified by the coupon-definition-ID parameter. - """ - pass - - def test_get_coupon_rule_by_id(self): - """ - Test case for get_coupon_rule_by_id - - Returns a single coupon-rule, specified by the coupon-rule-ID parameter. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupons_api.py b/test/test_coupons_api.py index 4326f38..1d0fabe 100644 --- a/test/test_coupons_api.py +++ b/test/test_coupons_api.py @@ -1,107 +1,90 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.api.coupons_api import CouponsApi # noqa: E501 from billforward.rest import ApiException -from billforward.apis.coupons_api import CouponsApi class TestCouponsApi(unittest.TestCase): - """ CouponsApi unit test stubs """ + """CouponsApi unit test stubs""" def setUp(self): - self.api = billforward.apis.coupons_api.CouponsApi() + self.api = CouponsApi() # noqa: E501 def tearDown(self): pass def test_create_coupon(self): - """ - Test case for create_coupon + """Test case for create_coupon - Create a coupon. """ pass def test_create_coupon_unique_codes(self): - """ - Test case for create_coupon_unique_codes + """Test case for create_coupon_unique_codes - Create a list of unique coupon codes that can be applied to a subscription. """ pass def test_get_all_coupons(self): - """ - Test case for get_all_coupons + """Test case for get_all_coupons - Returns a collection of all coupons. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_applied_coupons(self): - """ - Test case for get_applied_coupons + """Test case for get_applied_coupons - Returns a list of unique coupons which have been applied. """ pass def test_get_available_coupon_codes_for_code(self): + """Test case for get_available_coupon_codes_for_code + """ - Test case for get_available_coupon_codes_for_code + pass + + def test_get_available_coupon_codes_for_code_as_csv(self): + """Test case for get_available_coupon_codes_for_code_as_csv - Returns a list of available unique coupon codes for the specified parent coupon code that can be applied to a subscription. """ pass def test_get_coupon_code(self): + """Test case for get_coupon_code + """ - Test case for get_coupon_code + pass + + def test_get_plans_for_coupon(self): + """Test case for get_plans_for_coupon - Returns the coupon for the specified code that can be applied to a subscription. """ pass def test_get_subscription_applications_of_coupons(self): - """ - Test case for get_subscription_applications_of_coupons + """Test case for get_subscription_applications_of_coupons - Retrieves a collection of the coupons by this coupon code which have been applied. """ pass def test_retire_coupon(self): - """ - Test case for retire_coupon + """Test case for retire_coupon -

This method has 2 main behaviours depending on what is passed in. If the parent coupon code, for example SUMMER, is given no new coupons can be issued or claimed from this code. Deleting will result in the deleted property being set to true.

If a unique coupon code, for example SUMMER-AGH8, is given this will stop the coupon from being applied to the subscription from that point onwards. When a coupon is deleted the validUntil property is set which is the date/time it stopped applying to the target.

""" pass diff --git a/test/test_create_account_profile_request.py b/test/test_create_account_profile_request.py deleted file mode 100644 index cbea597..0000000 --- a/test/test_create_account_profile_request.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.create_account_profile_request import CreateAccountProfileRequest - - -class TestCreateAccountProfileRequest(unittest.TestCase): - """ CreateAccountProfileRequest unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateAccountProfileRequest(self): - """ - Test CreateAccountProfileRequest - """ - model = billforward.models.create_account_profile_request.CreateAccountProfileRequest() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_account_request.py b/test/test_create_account_request.py deleted file mode 100644 index 013e6e4..0000000 --- a/test/test_create_account_request.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.create_account_request import CreateAccountRequest - - -class TestCreateAccountRequest(unittest.TestCase): - """ CreateAccountRequest unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateAccountRequest(self): - """ - Test CreateAccountRequest - """ - model = billforward.models.create_account_request.CreateAccountRequest() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_address_request.py b/test/test_create_address_request.py deleted file mode 100644 index ca963bd..0000000 --- a/test/test_create_address_request.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.create_address_request import CreateAddressRequest - - -class TestCreateAddressRequest(unittest.TestCase): - """ CreateAddressRequest unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateAddressRequest(self): - """ - Test CreateAddressRequest - """ - model = billforward.models.create_address_request.CreateAddressRequest() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_aggregating_component_request.py b/test/test_create_aggregating_component_request.py index 0144fb8..06cbfef 100644 --- a/test/test_create_aggregating_component_request.py +++ b/test/test_create_aggregating_component_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.create_aggregating_component_request import CreateAggregatingComponentRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.create_aggregating_component_request import CreateAggregatingComponentRequest class TestCreateAggregatingComponentRequest(unittest.TestCase): - """ CreateAggregatingComponentRequest unit test stubs """ + """CreateAggregatingComponentRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCreateAggregatingComponentRequest(self): - """ - Test CreateAggregatingComponentRequest - """ - model = billforward.models.create_aggregating_component_request.CreateAggregatingComponentRequest() + """Test CreateAggregatingComponentRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_aggregating_component_request.CreateAggregatingComponentRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_create_aggregating_subscription_request.py b/test/test_create_aggregating_subscription_request.py index 0b5be36..4f660e2 100644 --- a/test/test_create_aggregating_subscription_request.py +++ b/test/test_create_aggregating_subscription_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.create_aggregating_subscription_request import CreateAggregatingSubscriptionRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.create_aggregating_subscription_request import CreateAggregatingSubscriptionRequest class TestCreateAggregatingSubscriptionRequest(unittest.TestCase): - """ CreateAggregatingSubscriptionRequest unit test stubs """ + """CreateAggregatingSubscriptionRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCreateAggregatingSubscriptionRequest(self): - """ - Test CreateAggregatingSubscriptionRequest - """ - model = billforward.models.create_aggregating_subscription_request.CreateAggregatingSubscriptionRequest() + """Test CreateAggregatingSubscriptionRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_aggregating_subscription_request.CreateAggregatingSubscriptionRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_create_commission_invoice_request.py b/test/test_create_commission_invoice_request.py new file mode 100644 index 0000000..8a80f21 --- /dev/null +++ b/test/test_create_commission_invoice_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_commission_invoice_request import CreateCommissionInvoiceRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreateCommissionInvoiceRequest(unittest.TestCase): + """CreateCommissionInvoiceRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateCommissionInvoiceRequest(self): + """Test CreateCommissionInvoiceRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_commission_invoice_request.CreateCommissionInvoiceRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_contract_period_request.py b/test/test_create_contract_period_request.py new file mode 100644 index 0000000..bbc8a63 --- /dev/null +++ b/test/test_create_contract_period_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_contract_period_request import CreateContractPeriodRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreateContractPeriodRequest(unittest.TestCase): + """CreateContractPeriodRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateContractPeriodRequest(self): + """Test CreateContractPeriodRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_contract_period_request.CreateContractPeriodRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_contract_request.py b/test/test_create_contract_request.py new file mode 100644 index 0000000..dee1862 --- /dev/null +++ b/test/test_create_contract_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_contract_request import CreateContractRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreateContractRequest(unittest.TestCase): + """CreateContractRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateContractRequest(self): + """Test CreateContractRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_contract_request.CreateContractRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_coupon_discount_request.py b/test/test_create_coupon_discount_request.py new file mode 100644 index 0000000..75b4dfa --- /dev/null +++ b/test/test_create_coupon_discount_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_coupon_discount_request import CreateCouponDiscountRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreateCouponDiscountRequest(unittest.TestCase): + """CreateCouponDiscountRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateCouponDiscountRequest(self): + """Test CreateCouponDiscountRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_coupon_discount_request.CreateCouponDiscountRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_coupon_request.py b/test/test_create_coupon_request.py new file mode 100644 index 0000000..eafb64f --- /dev/null +++ b/test/test_create_coupon_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_coupon_request import CreateCouponRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreateCouponRequest(unittest.TestCase): + """CreateCouponRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateCouponRequest(self): + """Test CreateCouponRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_coupon_request.CreateCouponRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_offline_payment_request.py b/test/test_create_offline_payment_request.py new file mode 100644 index 0000000..ff0aecf --- /dev/null +++ b/test/test_create_offline_payment_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_offline_payment_request import CreateOfflinePaymentRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreateOfflinePaymentRequest(unittest.TestCase): + """CreateOfflinePaymentRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateOfflinePaymentRequest(self): + """Test CreateOfflinePaymentRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_offline_payment_request.CreateOfflinePaymentRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_permission_on_role_request.py b/test/test_create_permission_on_role_request.py new file mode 100644 index 0000000..d4f61fa --- /dev/null +++ b/test/test_create_permission_on_role_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_permission_on_role_request import CreatePermissionOnRoleRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreatePermissionOnRoleRequest(unittest.TestCase): + """CreatePermissionOnRoleRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreatePermissionOnRoleRequest(self): + """Test CreatePermissionOnRoleRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_permission_on_role_request.CreatePermissionOnRoleRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_permission_request.py b/test/test_create_permission_request.py new file mode 100644 index 0000000..d8184b4 --- /dev/null +++ b/test/test_create_permission_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_permission_request import CreatePermissionRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreatePermissionRequest(unittest.TestCase): + """CreatePermissionRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreatePermissionRequest(self): + """Test CreatePermissionRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_permission_request.CreatePermissionRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_pricing_component_quantity_request.py b/test/test_create_pricing_component_quantity_request.py new file mode 100644 index 0000000..4702633 --- /dev/null +++ b/test/test_create_pricing_component_quantity_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_pricing_component_quantity_request import CreatePricingComponentQuantityRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreatePricingComponentQuantityRequest(unittest.TestCase): + """CreatePricingComponentQuantityRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreatePricingComponentQuantityRequest(self): + """Test CreatePricingComponentQuantityRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_pricing_component_quantity_request.CreatePricingComponentQuantityRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_profile_address_request.py b/test/test_create_profile_address_request.py deleted file mode 100644 index dcfe146..0000000 --- a/test/test_create_profile_address_request.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.create_profile_address_request import CreateProfileAddressRequest - - -class TestCreateProfileAddressRequest(unittest.TestCase): - """ CreateProfileAddressRequest unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateProfileAddressRequest(self): - """ - Test CreateProfileAddressRequest - """ - model = billforward.models.create_profile_address_request.CreateProfileAddressRequest() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_profile_request.py b/test/test_create_profile_request.py new file mode 100644 index 0000000..f86f708 --- /dev/null +++ b/test/test_create_profile_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_profile_request import CreateProfileRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreateProfileRequest(unittest.TestCase): + """CreateProfileRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateProfileRequest(self): + """Test CreateProfileRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_profile_request.CreateProfileRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_role_request.py b/test/test_create_role_request.py new file mode 100644 index 0000000..f21feff --- /dev/null +++ b/test/test_create_role_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_role_request import CreateRoleRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreateRoleRequest(unittest.TestCase): + """CreateRoleRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateRoleRequest(self): + """Test CreateRoleRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_role_request.CreateRoleRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_salesforce_configuration_request.py b/test/test_create_salesforce_configuration_request.py new file mode 100644 index 0000000..3781863 --- /dev/null +++ b/test/test_create_salesforce_configuration_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_salesforce_configuration_request import CreateSalesforceConfigurationRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreateSalesforceConfigurationRequest(unittest.TestCase): + """CreateSalesforceConfigurationRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateSalesforceConfigurationRequest(self): + """Test CreateSalesforceConfigurationRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_salesforce_configuration_request.CreateSalesforceConfigurationRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_subscription_batch_request.py b/test/test_create_subscription_batch_request.py index 804d3ef..aecff55 100644 --- a/test/test_create_subscription_batch_request.py +++ b/test/test_create_subscription_batch_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.create_subscription_batch_request import CreateSubscriptionBatchRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.create_subscription_batch_request import CreateSubscriptionBatchRequest class TestCreateSubscriptionBatchRequest(unittest.TestCase): - """ CreateSubscriptionBatchRequest unit test stubs """ + """CreateSubscriptionBatchRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCreateSubscriptionBatchRequest(self): - """ - Test CreateSubscriptionBatchRequest - """ - model = billforward.models.create_subscription_batch_request.CreateSubscriptionBatchRequest() + """Test CreateSubscriptionBatchRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_subscription_batch_request.CreateSubscriptionBatchRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_create_subscription_charge_amendment.py b/test/test_create_subscription_charge_amendment.py index f4c4dd7..5ccd936 100644 --- a/test/test_create_subscription_charge_amendment.py +++ b/test/test_create_subscription_charge_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.create_subscription_charge_amendment import CreateSubscriptionChargeAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.create_subscription_charge_amendment import CreateSubscriptionChargeAmendment class TestCreateSubscriptionChargeAmendment(unittest.TestCase): - """ CreateSubscriptionChargeAmendment unit test stubs """ + """CreateSubscriptionChargeAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCreateSubscriptionChargeAmendment(self): - """ - Test CreateSubscriptionChargeAmendment - """ - model = billforward.models.create_subscription_charge_amendment.CreateSubscriptionChargeAmendment() + """Test CreateSubscriptionChargeAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_subscription_charge_amendment.CreateSubscriptionChargeAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_create_subscription_checkout_definition_request.py b/test/test_create_subscription_checkout_definition_request.py new file mode 100644 index 0000000..d94efc2 --- /dev/null +++ b/test/test_create_subscription_checkout_definition_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_subscription_checkout_definition_request import CreateSubscriptionCheckoutDefinitionRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreateSubscriptionCheckoutDefinitionRequest(unittest.TestCase): + """CreateSubscriptionCheckoutDefinitionRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateSubscriptionCheckoutDefinitionRequest(self): + """Test CreateSubscriptionCheckoutDefinitionRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_subscription_checkout_definition_request.CreateSubscriptionCheckoutDefinitionRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_subscription_request.py b/test/test_create_subscription_request.py index e936cc6..77579c1 100644 --- a/test/test_create_subscription_request.py +++ b/test/test_create_subscription_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.create_subscription_request import CreateSubscriptionRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.create_subscription_request import CreateSubscriptionRequest class TestCreateSubscriptionRequest(unittest.TestCase): - """ CreateSubscriptionRequest unit test stubs """ + """CreateSubscriptionRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCreateSubscriptionRequest(self): - """ - Test CreateSubscriptionRequest - """ - model = billforward.models.create_subscription_request.CreateSubscriptionRequest() + """Test CreateSubscriptionRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_subscription_request.CreateSubscriptionRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_create_subscription_timer_request.py b/test/test_create_subscription_timer_request.py new file mode 100644 index 0000000..b5b76ad --- /dev/null +++ b/test/test_create_subscription_timer_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_subscription_timer_request import CreateSubscriptionTimerRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreateSubscriptionTimerRequest(unittest.TestCase): + """CreateSubscriptionTimerRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateSubscriptionTimerRequest(self): + """Test CreateSubscriptionTimerRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_subscription_timer_request.CreateSubscriptionTimerRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_create_totp_request.py b/test/test_create_totp_request.py new file mode 100644 index 0000000..175a688 --- /dev/null +++ b/test/test_create_totp_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.create_totp_request import CreateTOTPRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestCreateTOTPRequest(unittest.TestCase): + """CreateTOTPRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateTOTPRequest(self): + """Test CreateTOTPRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.create_totp_request.CreateTOTPRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_credit_account_request.py b/test/test_credit_account_request.py index c38faa1..034b610 100644 --- a/test/test_credit_account_request.py +++ b/test/test_credit_account_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.credit_account_request import CreditAccountRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.credit_account_request import CreditAccountRequest class TestCreditAccountRequest(unittest.TestCase): - """ CreditAccountRequest unit test stubs """ + """CreditAccountRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCreditAccountRequest(self): - """ - Test CreditAccountRequest - """ - model = billforward.models.credit_account_request.CreditAccountRequest() + """Test CreditAccountRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.credit_account_request.CreditAccountRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_credit_note.py b/test/test_credit_note.py index 9d8744f..7eb7b47 100644 --- a/test/test_credit_note.py +++ b/test/test_credit_note.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.credit_note import CreditNote # noqa: E501 from billforward.rest import ApiException -from billforward.models.credit_note import CreditNote class TestCreditNote(unittest.TestCase): - """ CreditNote unit test stubs """ + """CreditNote unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCreditNote(self): - """ - Test CreditNote - """ - model = billforward.models.credit_note.CreditNote() + """Test CreditNote""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.credit_note.CreditNote() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_credit_note_currency.py b/test/test_credit_note_currency.py new file mode 100644 index 0000000..3cfaba6 --- /dev/null +++ b/test/test_credit_note_currency.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.credit_note_currency import CreditNoteCurrency # noqa: E501 +from billforward.rest import ApiException + + +class TestCreditNoteCurrency(unittest.TestCase): + """CreditNoteCurrency unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreditNoteCurrency(self): + """Test CreditNoteCurrency""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.credit_note_currency.CreditNoteCurrency() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_credit_note_paged_metadata.py b/test/test_credit_note_paged_metadata.py deleted file mode 100644 index 614b24c..0000000 --- a/test/test_credit_note_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.credit_note_paged_metadata import CreditNotePagedMetadata - - -class TestCreditNotePagedMetadata(unittest.TestCase): - """ CreditNotePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreditNotePagedMetadata(self): - """ - Test CreditNotePagedMetadata - """ - model = billforward.models.credit_note_paged_metadata.CreditNotePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_credit_note_payment.py b/test/test_credit_note_payment.py new file mode 100644 index 0000000..470dab0 --- /dev/null +++ b/test/test_credit_note_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.credit_note_payment import CreditNotePayment # noqa: E501 +from billforward.rest import ApiException + + +class TestCreditNotePayment(unittest.TestCase): + """CreditNotePayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreditNotePayment(self): + """Test CreditNotePayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.credit_note_payment.CreditNotePayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_credit_subscription_request.py b/test/test_credit_subscription_request.py index d8edb57..3049da8 100644 --- a/test/test_credit_subscription_request.py +++ b/test/test_credit_subscription_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.credit_subscription_request import CreditSubscriptionRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.credit_subscription_request import CreditSubscriptionRequest class TestCreditSubscriptionRequest(unittest.TestCase): - """ CreditSubscriptionRequest unit test stubs """ + """CreditSubscriptionRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testCreditSubscriptionRequest(self): - """ - Test CreditSubscriptionRequest - """ - model = billforward.models.credit_subscription_request.CreditSubscriptionRequest() + """Test CreditSubscriptionRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.credit_subscription_request.CreditSubscriptionRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_creditnotes_api.py b/test/test_creditnotes_api.py deleted file mode 100644 index ea5670e..0000000 --- a/test/test_creditnotes_api.py +++ /dev/null @@ -1,94 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.creditnotes_api import CreditnotesApi - - -class TestCreditnotesApi(unittest.TestCase): - """ CreditnotesApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.creditnotes_api.CreditnotesApi() - - def tearDown(self): - pass - - def test_create_credit_note(self): - """ - Test case for create_credit_note - - Create a credit note. - """ - pass - - def test_get_credit_note_by_id(self): - """ - Test case for get_credit_note_by_id - - Returns a single credit-note, specified by the ID parameter. - """ - pass - - def test_get_credit_note_for_account(self): - """ - Test case for get_credit_note_for_account - - Returns credit notes for an account. - """ - pass - - def test_get_credit_note_for_invoice(self): - """ - Test case for get_credit_note_for_invoice - - Returns credit notes for an invoice. - """ - pass - - def test_get_credit_note_for_subscription(self): - """ - Test case for get_credit_note_for_subscription - - Returns credit notes for an subscription. - """ - pass - - def test_retire_credit_note(self): - """ - Test case for retire_credit_note - - Removes any remaining value from credit note - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_cybersource_configuration.py b/test/test_cybersource_configuration.py new file mode 100644 index 0000000..49af897 --- /dev/null +++ b/test/test_cybersource_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.cybersource_configuration import CybersourceConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestCybersourceConfiguration(unittest.TestCase): + """CybersourceConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCybersourceConfiguration(self): + """Test CybersourceConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.cybersource_configuration.CybersourceConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_cybersource_payment.py b/test/test_cybersource_payment.py new file mode 100644 index 0000000..eb39b6d --- /dev/null +++ b/test/test_cybersource_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.cybersource_payment import CybersourcePayment # noqa: E501 +from billforward.rest import ApiException + + +class TestCybersourcePayment(unittest.TestCase): + """CybersourcePayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCybersourcePayment(self): + """Test CybersourcePayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.cybersource_payment.CybersourcePayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_cybersource_token_paged_metadata.py b/test/test_cybersource_token_paged_metadata.py deleted file mode 100644 index cc9859e..0000000 --- a/test/test_cybersource_token_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.cybersource_token_paged_metadata import CybersourceTokenPagedMetadata - - -class TestCybersourceTokenPagedMetadata(unittest.TestCase): - """ CybersourceTokenPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCybersourceTokenPagedMetadata(self): - """ - Test CybersourceTokenPagedMetadata - """ - model = billforward.models.cybersource_token_paged_metadata.CybersourceTokenPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_cybersourcetokens_api.py b/test/test_cybersourcetokens_api.py deleted file mode 100644 index 2fc6868..0000000 --- a/test/test_cybersourcetokens_api.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.cybersourcetokens_api import CybersourcetokensApi - - -class TestCybersourcetokensApi(unittest.TestCase): - """ CybersourcetokensApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.cybersourcetokens_api.CybersourcetokensApi() - - def tearDown(self): - pass - - def test_create_cybersource_token(self): - """ - Test case for create_cybersource_token - - Create a cybersource-token. - """ - pass - - def test_get_cybersource_token_by_id(self): - """ - Test case for get_cybersource_token_by_id - - Returns a single cybersource-token, specified by the token-ID parameter. - """ - pass - - def test_get_cybersource_token_by_recurring_subscription_id(self): - """ - Test case for get_cybersource_token_by_recurring_subscription_id - - Returns a single cybersource-token, specified by the recurring-subscription-ID parameter. - """ - pass - - def test_retire_cybersource_token(self): - """ - Test case for retire_cybersource_token - - Retires the cybersource token specified by the token-ID parameter. - """ - pass - - def test_update_cybersource_token(self): - """ - Test case for update_cybersource_token - - Update a cybersource-token. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_data_sync_job_error_response.py b/test/test_data_sync_job_error_response.py new file mode 100644 index 0000000..7d8002d --- /dev/null +++ b/test/test_data_sync_job_error_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.data_sync_job_error_response import DataSyncJobErrorResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestDataSyncJobErrorResponse(unittest.TestCase): + """DataSyncJobErrorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDataSyncJobErrorResponse(self): + """Test DataSyncJobErrorResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.data_sync_job_error_response.DataSyncJobErrorResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_data_sync_job_response.py b/test/test_data_sync_job_response.py new file mode 100644 index 0000000..9ce6716 --- /dev/null +++ b/test/test_data_sync_job_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.data_sync_job_response import DataSyncJobResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestDataSyncJobResponse(unittest.TestCase): + """DataSyncJobResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDataSyncJobResponse(self): + """Test DataSyncJobResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.data_sync_job_response.DataSyncJobResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_data_synchronisation_app_configuration_paged_metadata.py b/test/test_data_synchronisation_app_configuration_paged_metadata.py deleted file mode 100644 index 4d9e3c8..0000000 --- a/test/test_data_synchronisation_app_configuration_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.data_synchronisation_app_configuration_paged_metadata import DataSynchronisationAppConfigurationPagedMetadata - - -class TestDataSynchronisationAppConfigurationPagedMetadata(unittest.TestCase): - """ DataSynchronisationAppConfigurationPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testDataSynchronisationAppConfigurationPagedMetadata(self): - """ - Test DataSynchronisationAppConfigurationPagedMetadata - """ - model = billforward.models.data_synchronisation_app_configuration_paged_metadata.DataSynchronisationAppConfigurationPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_data_synchronisation_configuration.py b/test/test_data_synchronisation_configuration.py deleted file mode 100644 index a01a32e..0000000 --- a/test/test_data_synchronisation_configuration.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.data_synchronisation_configuration import DataSynchronisationConfiguration - - -class TestDataSynchronisationConfiguration(unittest.TestCase): - """ DataSynchronisationConfiguration unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testDataSynchronisationConfiguration(self): - """ - Test DataSynchronisationConfiguration - """ - model = billforward.models.data_synchronisation_configuration.DataSynchronisationConfiguration() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_data_synchronisation_configuration_paged_metadata.py b/test/test_data_synchronisation_configuration_paged_metadata.py deleted file mode 100644 index 021216e..0000000 --- a/test/test_data_synchronisation_configuration_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.data_synchronisation_configuration_paged_metadata import DataSynchronisationConfigurationPagedMetadata - - -class TestDataSynchronisationConfigurationPagedMetadata(unittest.TestCase): - """ DataSynchronisationConfigurationPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testDataSynchronisationConfigurationPagedMetadata(self): - """ - Test DataSynchronisationConfigurationPagedMetadata - """ - model = billforward.models.data_synchronisation_configuration_paged_metadata.DataSynchronisationConfigurationPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_data_synchronization_job_paged_metadata.py b/test/test_data_synchronization_job_paged_metadata.py deleted file mode 100644 index bf5a37e..0000000 --- a/test/test_data_synchronization_job_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.data_synchronization_job_paged_metadata import DataSynchronizationJobPagedMetadata - - -class TestDataSynchronizationJobPagedMetadata(unittest.TestCase): - """ DataSynchronizationJobPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testDataSynchronizationJobPagedMetadata(self): - """ - Test DataSynchronizationJobPagedMetadata - """ - model = billforward.models.data_synchronization_job_paged_metadata.DataSynchronizationJobPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_debts_result_paged_metadata.py b/test/test_debts_result_paged_metadata.py deleted file mode 100644 index 110cb06..0000000 --- a/test/test_debts_result_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.debts_result_paged_metadata import DebtsResultPagedMetadata - - -class TestDebtsResultPagedMetadata(unittest.TestCase): - """ DebtsResultPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testDebtsResultPagedMetadata(self): - """ - Test DebtsResultPagedMetadata - """ - model = billforward.models.debts_result_paged_metadata.DebtsResultPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_default_api.py b/test/test_default_api.py new file mode 100644 index 0000000..0f1ee1c --- /dev/null +++ b/test/test_default_api.py @@ -0,0 +1,51 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.default_api import DefaultApi # noqa: E501 +from billforward.rest import ApiException + + +class TestDefaultApi(unittest.TestCase): + """DefaultApi unit test stubs""" + + def setUp(self): + self.api = DefaultApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_totp_secret(self): + """Test case for create_totp_secret + + """ + pass + + def test_enable2fa(self): + """Test case for enable2fa + + """ + pass + + def test_get_qr_code(self): + """Test case for get_qr_code + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_dunning_api.py b/test/test_dunning_api.py new file mode 100644 index 0000000..5d7a505 --- /dev/null +++ b/test/test_dunning_api.py @@ -0,0 +1,69 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.dunning_api import DunningApi # noqa: E501 +from billforward.rest import ApiException + + +class TestDunningApi(unittest.TestCase): + """DunningApi unit test stubs""" + + def setUp(self): + self.api = DunningApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_dunning_line(self): + """Test case for create_dunning_line + + """ + pass + + def test_get_all_dunning_lines(self): + """Test case for get_all_dunning_lines + + """ + pass + + def test_get_dunning_line_by_attempt_index(self): + """Test case for get_dunning_line_by_attempt_index + + """ + pass + + def test_get_dunning_line_by_id(self): + """Test case for get_dunning_line_by_id + + """ + pass + + def test_retire_dunning_line(self): + """Test case for retire_dunning_line + + """ + pass + + def test_update_dunning_line(self): + """Test case for update_dunning_line + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_dunning_line.py b/test/test_dunning_line.py index cbbf9ae..ef31caa 100644 --- a/test/test_dunning_line.py +++ b/test/test_dunning_line.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.dunning_line import DunningLine # noqa: E501 from billforward.rest import ApiException -from billforward.models.dunning_line import DunningLine class TestDunningLine(unittest.TestCase): - """ DunningLine unit test stubs """ + """DunningLine unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testDunningLine(self): - """ - Test DunningLine - """ - model = billforward.models.dunning_line.DunningLine() + """Test DunningLine""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.dunning_line.DunningLine() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_dunning_line_paged_metadata.py b/test/test_dunning_line_paged_metadata.py deleted file mode 100644 index 1eab5bd..0000000 --- a/test/test_dunning_line_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.dunning_line_paged_metadata import DunningLinePagedMetadata - - -class TestDunningLinePagedMetadata(unittest.TestCase): - """ DunningLinePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testDunningLinePagedMetadata(self): - """ - Test DunningLinePagedMetadata - """ - model = billforward.models.dunning_line_paged_metadata.DunningLinePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_dunninglines_api.py b/test/test_dunninglines_api.py deleted file mode 100644 index 5c96c04..0000000 --- a/test/test_dunninglines_api.py +++ /dev/null @@ -1,94 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.dunninglines_api import DunninglinesApi - - -class TestDunninglinesApi(unittest.TestCase): - """ DunninglinesApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.dunninglines_api.DunninglinesApi() - - def tearDown(self): - pass - - def test_create_dunning_line(self): - """ - Test case for create_dunning_line - - Create a dunning-line. - """ - pass - - def test_get_all_dunning_lines(self): - """ - Test case for get_all_dunning_lines - - Returns a collection of all dunning-lines. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_dunning_line_by_attempt_index(self): - """ - Test case for get_dunning_line_by_attempt_index - - Returns a collection of dunning-lines specified by the index parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_dunning_line_by_id(self): - """ - Test case for get_dunning_line_by_id - - Returns a single dunning-line, specified by the dunning-line-ID parameter. - """ - pass - - def test_retire_dunning_line(self): - """ - Test case for retire_dunning_line - - Retires the specified dunning-line. - """ - pass - - def test_update_dunning_line(self): - """ - Test case for update_dunning_line - - Update a dunning-line. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_dynamic_metadata.py b/test/test_dynamic_metadata.py deleted file mode 100644 index 43be19d..0000000 --- a/test/test_dynamic_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.dynamic_metadata import DynamicMetadata - - -class TestDynamicMetadata(unittest.TestCase): - """ DynamicMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testDynamicMetadata(self): - """ - Test DynamicMetadata - """ - model = billforward.models.dynamic_metadata.DynamicMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_ebanx_api.py b/test/test_ebanx_api.py new file mode 100644 index 0000000..2bd7a79 --- /dev/null +++ b/test/test_ebanx_api.py @@ -0,0 +1,57 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.ebanx_api import EBANXApi # noqa: E501 +from billforward.rest import ApiException + + +class TestEBANXApi(unittest.TestCase): + """EBANXApi unit test stubs""" + + def setUp(self): + self.api = EBANXApi() # noqa: E501 + + def tearDown(self): + pass + + def test_delete_configuration1(self): + """Test case for delete_configuration1 + + """ + pass + + def test_get_configuration1(self): + """Test case for get_configuration1 + + """ + pass + + def test_handle_webhook(self): + """Test case for handle_webhook + + """ + pass + + def test_upsert_configuration1(self): + """Test case for upsert_configuration1 + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ebanx_auth_capture_request.py b/test/test_ebanx_auth_capture_request.py new file mode 100644 index 0000000..c7076e3 --- /dev/null +++ b/test/test_ebanx_auth_capture_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.ebanx_auth_capture_request import EBANXAuthCaptureRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestEBANXAuthCaptureRequest(unittest.TestCase): + """EBANXAuthCaptureRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEBANXAuthCaptureRequest(self): + """Test EBANXAuthCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.ebanx_auth_capture_request.EBANXAuthCaptureRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ebanx_configuration.py b/test/test_ebanx_configuration.py new file mode 100644 index 0000000..8c669ed --- /dev/null +++ b/test/test_ebanx_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.ebanx_configuration import EBANXConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestEBANXConfiguration(unittest.TestCase): + """EBANXConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEBANXConfiguration(self): + """Test EBANXConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.ebanx_configuration.EBANXConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ebanx_gateway_request.py b/test/test_ebanx_gateway_request.py new file mode 100644 index 0000000..10aae1f --- /dev/null +++ b/test/test_ebanx_gateway_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.ebanx_gateway_request import EBANXGatewayRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestEBANXGatewayRequest(unittest.TestCase): + """EBANXGatewayRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEBANXGatewayRequest(self): + """Test EBANXGatewayRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.ebanx_gateway_request.EBANXGatewayRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ebanx_payment.py b/test/test_ebanx_payment.py new file mode 100644 index 0000000..15996a4 --- /dev/null +++ b/test/test_ebanx_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.ebanx_payment import EBANXPayment # noqa: E501 +from billforward.rest import ApiException + + +class TestEBANXPayment(unittest.TestCase): + """EBANXPayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEBANXPayment(self): + """Test EBANXPayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.ebanx_payment.EBANXPayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ebanx_webhook.py b/test/test_ebanx_webhook.py new file mode 100644 index 0000000..0799295 --- /dev/null +++ b/test/test_ebanx_webhook.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.ebanx_webhook import EBANXWebhook # noqa: E501 +from billforward.rest import ApiException + + +class TestEBANXWebhook(unittest.TestCase): + """EBANXWebhook unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEBANXWebhook(self): + """Test EBANXWebhook""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.ebanx_webhook.EBANXWebhook() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_email.py b/test/test_email.py deleted file mode 100644 index d124cac..0000000 --- a/test/test_email.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.email import Email - - -class TestEmail(unittest.TestCase): - """ Email unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEmail(self): - """ - Test Email - """ - model = billforward.models.email.Email() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_email_paged_metadata.py b/test/test_email_paged_metadata.py deleted file mode 100644 index 1cdfa60..0000000 --- a/test/test_email_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.email_paged_metadata import EmailPagedMetadata - - -class TestEmailPagedMetadata(unittest.TestCase): - """ EmailPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEmailPagedMetadata(self): - """ - Test EmailPagedMetadata - """ - model = billforward.models.email_paged_metadata.EmailPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_email_provider.py b/test/test_email_provider.py deleted file mode 100644 index 66708b5..0000000 --- a/test/test_email_provider.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.email_provider import EmailProvider - - -class TestEmailProvider(unittest.TestCase): - """ EmailProvider unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEmailProvider(self): - """ - Test EmailProvider - """ - model = billforward.models.email_provider.EmailProvider() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_email_provider_paged_metadata.py b/test/test_email_provider_paged_metadata.py deleted file mode 100644 index 69eab1c..0000000 --- a/test/test_email_provider_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.email_provider_paged_metadata import EmailProviderPagedMetadata - - -class TestEmailProviderPagedMetadata(unittest.TestCase): - """ EmailProviderPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEmailProviderPagedMetadata(self): - """ - Test EmailProviderPagedMetadata - """ - model = billforward.models.email_provider_paged_metadata.EmailProviderPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_email_subscription.py b/test/test_email_subscription.py deleted file mode 100644 index 4f990da..0000000 --- a/test/test_email_subscription.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.email_subscription import EmailSubscription - - -class TestEmailSubscription(unittest.TestCase): - """ EmailSubscription unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEmailSubscription(self): - """ - Test EmailSubscription - """ - model = billforward.models.email_subscription.EmailSubscription() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_email_subscription_paged_metadata.py b/test/test_email_subscription_paged_metadata.py deleted file mode 100644 index 6a9b4e7..0000000 --- a/test/test_email_subscription_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.email_subscription_paged_metadata import EmailSubscriptionPagedMetadata - - -class TestEmailSubscriptionPagedMetadata(unittest.TestCase): - """ EmailSubscriptionPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEmailSubscriptionPagedMetadata(self): - """ - Test EmailSubscriptionPagedMetadata - """ - model = billforward.models.email_subscription_paged_metadata.EmailSubscriptionPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_email_tokenization.py b/test/test_email_tokenization.py new file mode 100644 index 0000000..d6c3f5d --- /dev/null +++ b/test/test_email_tokenization.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.email_tokenization import EmailTokenization # noqa: E501 +from billforward.rest import ApiException + + +class TestEmailTokenization(unittest.TestCase): + """EmailTokenization unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmailTokenization(self): + """Test EmailTokenization""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.email_tokenization.EmailTokenization() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_email_tokenization_create_api_request.py b/test/test_email_tokenization_create_api_request.py new file mode 100644 index 0000000..2a4eed2 --- /dev/null +++ b/test/test_email_tokenization_create_api_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.email_tokenization_create_api_request import EmailTokenizationCreateAPIRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestEmailTokenizationCreateAPIRequest(unittest.TestCase): + """EmailTokenizationCreateAPIRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmailTokenizationCreateAPIRequest(self): + """Test EmailTokenizationCreateAPIRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.email_tokenization_create_api_request.EmailTokenizationCreateAPIRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_email_tokenization_send_api_request.py b/test/test_email_tokenization_send_api_request.py new file mode 100644 index 0000000..f2ea0cb --- /dev/null +++ b/test/test_email_tokenization_send_api_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.email_tokenization_send_api_request import EmailTokenizationSendAPIRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestEmailTokenizationSendAPIRequest(unittest.TestCase): + """EmailTokenizationSendAPIRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmailTokenizationSendAPIRequest(self): + """Test EmailTokenizationSendAPIRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.email_tokenization_send_api_request.EmailTokenizationSendAPIRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_email_tokenization_update_api_request.py b/test/test_email_tokenization_update_api_request.py new file mode 100644 index 0000000..ebe2f8d --- /dev/null +++ b/test/test_email_tokenization_update_api_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.email_tokenization_update_api_request import EmailTokenizationUpdateAPIRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestEmailTokenizationUpdateAPIRequest(unittest.TestCase): + """EmailTokenizationUpdateAPIRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmailTokenizationUpdateAPIRequest(self): + """Test EmailTokenizationUpdateAPIRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.email_tokenization_update_api_request.EmailTokenizationUpdateAPIRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_emailproviders_api.py b/test/test_emailproviders_api.py deleted file mode 100644 index d29c69d..0000000 --- a/test/test_emailproviders_api.py +++ /dev/null @@ -1,78 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.emailproviders_api import EmailprovidersApi - - -class TestEmailprovidersApi(unittest.TestCase): - """ EmailprovidersApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.emailproviders_api.EmailprovidersApi() - - def tearDown(self): - pass - - def test_create_email_provider(self): - """ - Test case for create_email_provider - - Create an email provider. - """ - pass - - def test_delete(self): - """ - Test case for delete - - Deletes a single email provider, specified by id or name parameter. - """ - pass - - def test_get_all_email_providers(self): - """ - Test case for get_all_email_providers - - Returns a collection of all email-providers. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_email_by_provider_id(self): - """ - Test case for get_email_by_provider_id - - Retrieves a single email provider, specified by the version-ID parameter. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_emails_api.py b/test/test_emails_api.py deleted file mode 100644 index 2c99492..0000000 --- a/test/test_emails_api.py +++ /dev/null @@ -1,70 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.emails_api import EmailsApi - - -class TestEmailsApi(unittest.TestCase): - """ EmailsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.emails_api.EmailsApi() - - def tearDown(self): - pass - - def test_get_email_by_id(self): - """ - Test case for get_email_by_id - - Retrieves a single invoice, specified by the version-ID parameter. - """ - pass - - def test_get_email_html_by_id(self): - """ - Test case for get_email_html_by_id - - Retrieves a single invoice, specified by the version-ID parameter. - """ - pass - - def test_get_email_text_by_id(self): - """ - Test case for get_email_text_by_id - - Retrieves a single invoice, specified by the version-ID parameter. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_emailsubscriptions_api.py b/test/test_emailsubscriptions_api.py deleted file mode 100644 index 2d18024..0000000 --- a/test/test_emailsubscriptions_api.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.emailsubscriptions_api import EmailsubscriptionsApi - - -class TestEmailsubscriptionsApi(unittest.TestCase): - """ EmailsubscriptionsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.emailsubscriptions_api.EmailsubscriptionsApi() - - def tearDown(self): - pass - - def test_create_email_subscription(self): - """ - Test case for create_email_subscription - - Create an email subscription. - """ - pass - - def test_delete_email_subscription_by_type(self): - """ - Test case for delete_email_subscription_by_type - - Unsubscribe from the email specified by the type parameter. - """ - pass - - def test_get_all_email_subscriptions(self): - """ - Test case for get_all_email_subscriptions - - Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_email_subscription_by_id(self): - """ - Test case for get_email_subscription_by_id - - Retrieves a single email subscription, specified by ID. - """ - pass - - def test_update_email_subscription(self): - """ - Test case for update_email_subscription - - Update an email subscription. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_end_trial_amendment.py b/test/test_end_trial_amendment.py index d529644..99e54fa 100644 --- a/test/test_end_trial_amendment.py +++ b/test/test_end_trial_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.end_trial_amendment import EndTrialAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.end_trial_amendment import EndTrialAmendment class TestEndTrialAmendment(unittest.TestCase): - """ EndTrialAmendment unit test stubs """ + """EndTrialAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testEndTrialAmendment(self): - """ - Test EndTrialAmendment - """ - model = billforward.models.end_trial_amendment.EndTrialAmendment() + """Test EndTrialAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.end_trial_amendment.EndTrialAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_epx_capture_request.py b/test/test_epx_capture_request.py new file mode 100644 index 0000000..b1a2a21 --- /dev/null +++ b/test/test_epx_capture_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.epx_capture_request import EpxCaptureRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestEpxCaptureRequest(unittest.TestCase): + """EpxCaptureRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEpxCaptureRequest(self): + """Test EpxCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.epx_capture_request.EpxCaptureRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_epx_configuration.py b/test/test_epx_configuration.py new file mode 100644 index 0000000..9fa5b7a --- /dev/null +++ b/test/test_epx_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.epx_configuration import EpxConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestEpxConfiguration(unittest.TestCase): + """EpxConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEpxConfiguration(self): + """Test EpxConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.epx_configuration.EpxConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_epx_payment.py b/test/test_epx_payment.py new file mode 100644 index 0000000..9306b4b --- /dev/null +++ b/test/test_epx_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.epx_payment import EpxPayment # noqa: E501 +from billforward.rest import ApiException + + +class TestEpxPayment(unittest.TestCase): + """EpxPayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEpxPayment(self): + """Test EpxPayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.epx_payment.EpxPayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_epx_pre_auth_request.py b/test/test_epx_pre_auth_request.py new file mode 100644 index 0000000..f466b50 --- /dev/null +++ b/test/test_epx_pre_auth_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.epx_pre_auth_request import EpxPreAuthRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestEpxPreAuthRequest(unittest.TestCase): + """EpxPreAuthRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEpxPreAuthRequest(self): + """Test EpxPreAuthRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.epx_pre_auth_request.EpxPreAuthRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_epx_pre_auth_response.py b/test/test_epx_pre_auth_response.py new file mode 100644 index 0000000..3f7aaf1 --- /dev/null +++ b/test/test_epx_pre_auth_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.epx_pre_auth_response import EpxPreAuthResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestEpxPreAuthResponse(unittest.TestCase): + """EpxPreAuthResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEpxPreAuthResponse(self): + """Test EpxPreAuthResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.epx_pre_auth_response.EpxPreAuthResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_event.py b/test/test_event.py deleted file mode 100644 index 1d72c8f..0000000 --- a/test/test_event.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.event import Event - - -class TestEvent(unittest.TestCase): - """ Event unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEvent(self): - """ - Test Event - """ - model = billforward.models.event.Event() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_event_data.py b/test/test_event_data.py deleted file mode 100644 index 7922dfa..0000000 --- a/test/test_event_data.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.event_data import EventData - - -class TestEventData(unittest.TestCase): - """ EventData unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEventData(self): - """ - Test EventData - """ - model = billforward.models.event_data.EventData() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_execution_receipt_response.py b/test/test_execution_receipt_response.py new file mode 100644 index 0000000..f5902fc --- /dev/null +++ b/test/test_execution_receipt_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.execution_receipt_response import ExecutionReceiptResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestExecutionReceiptResponse(unittest.TestCase): + """ExecutionReceiptResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testExecutionReceiptResponse(self): + """Test ExecutionReceiptResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.execution_receipt_response.ExecutionReceiptResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_execution_response.py b/test/test_execution_response.py new file mode 100644 index 0000000..c3c5a3e --- /dev/null +++ b/test/test_execution_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.execution_response import ExecutionResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestExecutionResponse(unittest.TestCase): + """ExecutionResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testExecutionResponse(self): + """Test ExecutionResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.execution_response.ExecutionResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_extras.py b/test/test_extras.py new file mode 100644 index 0000000..7c268ff --- /dev/null +++ b/test/test_extras.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.extras import Extras # noqa: E501 +from billforward.rest import ApiException + + +class TestExtras(unittest.TestCase): + """Extras unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testExtras(self): + """Test Extras""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.extras.Extras() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_file_sham.py b/test/test_file_sham.py deleted file mode 100644 index 2219f0a..0000000 --- a/test/test_file_sham.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.file_sham import FileSham - - -class TestFileSham(unittest.TestCase): - """ FileSham unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testFileSham(self): - """ - Test FileSham - """ - model = billforward.models.file_sham.FileSham() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_fixed_term.py b/test/test_fixed_term.py index 5aba11a..da496d2 100644 --- a/test/test_fixed_term.py +++ b/test/test_fixed_term.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.fixed_term import FixedTerm # noqa: E501 from billforward.rest import ApiException -from billforward.models.fixed_term import FixedTerm class TestFixedTerm(unittest.TestCase): - """ FixedTerm unit test stubs """ + """FixedTerm unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testFixedTerm(self): - """ - Test FixedTerm - """ - model = billforward.models.fixed_term.FixedTerm() + """Test FixedTerm""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.fixed_term.FixedTerm() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_fixed_term_definition.py b/test/test_fixed_term_definition.py new file mode 100644 index 0000000..b657db6 --- /dev/null +++ b/test/test_fixed_term_definition.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.fixed_term_definition import FixedTermDefinition # noqa: E501 +from billforward.rest import ApiException + + +class TestFixedTermDefinition(unittest.TestCase): + """FixedTermDefinition unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFixedTermDefinition(self): + """Test FixedTermDefinition""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.fixed_term_definition.FixedTermDefinition() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_fixed_term_definition_paged_metadata.py b/test/test_fixed_term_definition_paged_metadata.py deleted file mode 100644 index ea4da74..0000000 --- a/test/test_fixed_term_definition_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.fixed_term_definition_paged_metadata import FixedTermDefinitionPagedMetadata - - -class TestFixedTermDefinitionPagedMetadata(unittest.TestCase): - """ FixedTermDefinitionPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testFixedTermDefinitionPagedMetadata(self): - """ - Test FixedTermDefinitionPagedMetadata - """ - model = billforward.models.fixed_term_definition_paged_metadata.FixedTermDefinitionPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_fixed_term_expiry_amendment.py b/test/test_fixed_term_expiry_amendment.py index c8619be..d5cacbf 100644 --- a/test/test_fixed_term_expiry_amendment.py +++ b/test/test_fixed_term_expiry_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.fixed_term_expiry_amendment import FixedTermExpiryAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.fixed_term_expiry_amendment import FixedTermExpiryAmendment class TestFixedTermExpiryAmendment(unittest.TestCase): - """ FixedTermExpiryAmendment unit test stubs """ + """FixedTermExpiryAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testFixedTermExpiryAmendment(self): - """ - Test FixedTermExpiryAmendment - """ - model = billforward.models.fixed_term_expiry_amendment.FixedTermExpiryAmendment() + """Test FixedTermExpiryAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.fixed_term_expiry_amendment.FixedTermExpiryAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_fixed_term_paged_metadata.py b/test/test_fixed_term_paged_metadata.py deleted file mode 100644 index fb2b6a8..0000000 --- a/test/test_fixed_term_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.fixed_term_paged_metadata import FixedTermPagedMetadata - - -class TestFixedTermPagedMetadata(unittest.TestCase): - """ FixedTermPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testFixedTermPagedMetadata(self): - """ - Test FixedTermPagedMetadata - """ - model = billforward.models.fixed_term_paged_metadata.FixedTermPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_fixedtermdefinitions_api.py b/test/test_fixedtermdefinitions_api.py deleted file mode 100644 index ac2a75d..0000000 --- a/test/test_fixedtermdefinitions_api.py +++ /dev/null @@ -1,62 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.fixedtermdefinitions_api import FixedtermdefinitionsApi - - -class TestFixedtermdefinitionsApi(unittest.TestCase): - """ FixedtermdefinitionsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.fixedtermdefinitions_api.FixedtermdefinitionsApi() - - def tearDown(self): - pass - - def test_create_fixed_term_definition(self): - """ - Test case for create_fixed_term_definition - - Create - """ - pass - - def test_update_fixed_term_definition(self): - """ - Test case for update_fixed_term_definition - - Update - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_fixedterms_api.py b/test/test_fixedterms_api.py deleted file mode 100644 index cde9d98..0000000 --- a/test/test_fixedterms_api.py +++ /dev/null @@ -1,54 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.fixedterms_api import FixedtermsApi - - -class TestFixedtermsApi(unittest.TestCase): - """ FixedtermsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.fixedterms_api.FixedtermsApi() - - def tearDown(self): - pass - - def test_update_fixed_term(self): - """ - Test case for update_fixed_term - - Update - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_flat_advance_pricing_component.py b/test/test_flat_advance_pricing_component.py new file mode 100644 index 0000000..115bee8 --- /dev/null +++ b/test/test_flat_advance_pricing_component.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.flat_advance_pricing_component import FlatAdvancePricingComponent # noqa: E501 +from billforward.rest import ApiException + + +class TestFlatAdvancePricingComponent(unittest.TestCase): + """FlatAdvancePricingComponent unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFlatAdvancePricingComponent(self): + """Test FlatAdvancePricingComponent""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.flat_advance_pricing_component.FlatAdvancePricingComponent() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_flat_arrears_pricing_component.py b/test/test_flat_arrears_pricing_component.py new file mode 100644 index 0000000..aaf8823 --- /dev/null +++ b/test/test_flat_arrears_pricing_component.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.flat_arrears_pricing_component import FlatArrearsPricingComponent # noqa: E501 +from billforward.rest import ApiException + + +class TestFlatArrearsPricingComponent(unittest.TestCase): + """FlatArrearsPricingComponent unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFlatArrearsPricingComponent(self): + """Test FlatArrearsPricingComponent""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.flat_arrears_pricing_component.FlatArrearsPricingComponent() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_flat_pricing_component.py b/test/test_flat_pricing_component.py index 270bda4..a812cea 100644 --- a/test/test_flat_pricing_component.py +++ b/test/test_flat_pricing_component.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.flat_pricing_component import FlatPricingComponent # noqa: E501 from billforward.rest import ApiException -from billforward.models.flat_pricing_component import FlatPricingComponent class TestFlatPricingComponent(unittest.TestCase): - """ FlatPricingComponent unit test stubs """ + """FlatPricingComponent unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testFlatPricingComponent(self): - """ - Test FlatPricingComponent - """ - model = billforward.models.flat_pricing_component.FlatPricingComponent() + """Test FlatPricingComponent""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.flat_pricing_component.FlatPricingComponent() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_flat_setup_pricing_component.py b/test/test_flat_setup_pricing_component.py new file mode 100644 index 0000000..6e77c24 --- /dev/null +++ b/test/test_flat_setup_pricing_component.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.flat_setup_pricing_component import FlatSetupPricingComponent # noqa: E501 +from billforward.rest import ApiException + + +class TestFlatSetupPricingComponent(unittest.TestCase): + """FlatSetupPricingComponent unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFlatSetupPricingComponent(self): + """Test FlatSetupPricingComponent""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.flat_setup_pricing_component.FlatSetupPricingComponent() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_flat_usage_pricing_component.py b/test/test_flat_usage_pricing_component.py new file mode 100644 index 0000000..cec5b39 --- /dev/null +++ b/test/test_flat_usage_pricing_component.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.flat_usage_pricing_component import FlatUsagePricingComponent # noqa: E501 +from billforward.rest import ApiException + + +class TestFlatUsagePricingComponent(unittest.TestCase): + """FlatUsagePricingComponent unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFlatUsagePricingComponent(self): + """Test FlatUsagePricingComponent""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.flat_usage_pricing_component.FlatUsagePricingComponent() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_rate_plan_affiliate_response.py b/test/test_get_rate_plan_affiliate_response.py new file mode 100644 index 0000000..d8f6c7a --- /dev/null +++ b/test/test_get_rate_plan_affiliate_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.get_rate_plan_affiliate_response import GetRatePlanAffiliateResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestGetRatePlanAffiliateResponse(unittest.TestCase): + """GetRatePlanAffiliateResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetRatePlanAffiliateResponse(self): + """Test GetRatePlanAffiliateResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.get_rate_plan_affiliate_response.GetRatePlanAffiliateResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_get_subscription_affiliate_response.py b/test/test_get_subscription_affiliate_response.py new file mode 100644 index 0000000..1a587f8 --- /dev/null +++ b/test/test_get_subscription_affiliate_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.get_subscription_affiliate_response import GetSubscriptionAffiliateResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestGetSubscriptionAffiliateResponse(unittest.TestCase): + """GetSubscriptionAffiliateResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetSubscriptionAffiliateResponse(self): + """Test GetSubscriptionAffiliateResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.get_subscription_affiliate_response.GetSubscriptionAffiliateResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_go_cardless_configuration.py b/test/test_go_cardless_configuration.py new file mode 100644 index 0000000..c40cd66 --- /dev/null +++ b/test/test_go_cardless_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.go_cardless_configuration import GoCardlessConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestGoCardlessConfiguration(unittest.TestCase): + """GoCardlessConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGoCardlessConfiguration(self): + """Test GoCardlessConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.go_cardless_configuration.GoCardlessConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_go_cardless_tokenization_request.py b/test/test_go_cardless_tokenization_request.py new file mode 100644 index 0000000..2aee6af --- /dev/null +++ b/test/test_go_cardless_tokenization_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.go_cardless_tokenization_request import GoCardlessTokenizationRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestGoCardlessTokenizationRequest(unittest.TestCase): + """GoCardlessTokenizationRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGoCardlessTokenizationRequest(self): + """Test GoCardlessTokenizationRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.go_cardless_tokenization_request.GoCardlessTokenizationRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_halt_aggregation_request.py b/test/test_halt_aggregation_request.py new file mode 100644 index 0000000..649a664 --- /dev/null +++ b/test/test_halt_aggregation_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.halt_aggregation_request import HaltAggregationRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestHaltAggregationRequest(unittest.TestCase): + """HaltAggregationRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testHaltAggregationRequest(self): + """Test HaltAggregationRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.halt_aggregation_request.HaltAggregationRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_halt_aggregation_response.py b/test/test_halt_aggregation_response.py new file mode 100644 index 0000000..d651f0e --- /dev/null +++ b/test/test_halt_aggregation_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.halt_aggregation_response import HaltAggregationResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestHaltAggregationResponse(unittest.TestCase): + """HaltAggregationResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testHaltAggregationResponse(self): + """Test HaltAggregationResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.halt_aggregation_response.HaltAggregationResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_hosted_payment.py b/test/test_hosted_payment.py new file mode 100644 index 0000000..f554114 --- /dev/null +++ b/test/test_hosted_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.hosted_payment import HostedPayment # noqa: E501 +from billforward.rest import ApiException + + +class TestHostedPayment(unittest.TestCase): + """HostedPayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testHostedPayment(self): + """Test HostedPayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.hosted_payment.HostedPayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_hosted_payment_config.py b/test/test_hosted_payment_config.py new file mode 100644 index 0000000..3599dc2 --- /dev/null +++ b/test/test_hosted_payment_config.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.hosted_payment_config import HostedPaymentConfig # noqa: E501 +from billforward.rest import ApiException + + +class TestHostedPaymentConfig(unittest.TestCase): + """HostedPaymentConfig unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testHostedPaymentConfig(self): + """Test HostedPaymentConfig""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.hosted_payment_config.HostedPaymentConfig() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_i_discardable.py b/test/test_i_discardable.py new file mode 100644 index 0000000..578dc6c --- /dev/null +++ b/test/test_i_discardable.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.i_discardable import IDiscardable # noqa: E501 +from billforward.rest import ApiException + + +class TestIDiscardable(unittest.TestCase): + """IDiscardable unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testIDiscardable(self): + """Test IDiscardable""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.i_discardable.IDiscardable() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_import_invoice_line.py b/test/test_import_invoice_line.py index db6c72b..ad34f3f 100644 --- a/test/test_import_invoice_line.py +++ b/test/test_import_invoice_line.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.import_invoice_line import ImportInvoiceLine # noqa: E501 from billforward.rest import ApiException -from billforward.models.import_invoice_line import ImportInvoiceLine class TestImportInvoiceLine(unittest.TestCase): - """ ImportInvoiceLine unit test stubs """ + """ImportInvoiceLine unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testImportInvoiceLine(self): - """ - Test ImportInvoiceLine - """ - model = billforward.models.import_invoice_line.ImportInvoiceLine() + """Test ImportInvoiceLine""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.import_invoice_line.ImportInvoiceLine() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_import_invoice_request.py b/test/test_import_invoice_request.py new file mode 100644 index 0000000..88ad1ba --- /dev/null +++ b/test/test_import_invoice_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.import_invoice_request import ImportInvoiceRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestImportInvoiceRequest(unittest.TestCase): + """ImportInvoiceRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testImportInvoiceRequest(self): + """Test ImportInvoiceRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.import_invoice_request.ImportInvoiceRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_import_subscription_request.py b/test/test_import_subscription_request.py new file mode 100644 index 0000000..5426a89 --- /dev/null +++ b/test/test_import_subscription_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.import_subscription_request import ImportSubscriptionRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestImportSubscriptionRequest(unittest.TestCase): + """ImportSubscriptionRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testImportSubscriptionRequest(self): + """Test ImportSubscriptionRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.import_subscription_request.ImportSubscriptionRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default.py b/test/test_inline_response_default.py new file mode 100644 index 0000000..22c08c1 --- /dev/null +++ b/test/test_inline_response_default.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default import InlineResponseDefault # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault(unittest.TestCase): + """InlineResponseDefault unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault(self): + """Test InlineResponseDefault""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default.InlineResponseDefault() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default1.py b/test/test_inline_response_default1.py new file mode 100644 index 0000000..98861a5 --- /dev/null +++ b/test/test_inline_response_default1.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default1 import InlineResponseDefault1 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault1(unittest.TestCase): + """InlineResponseDefault1 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault1(self): + """Test InlineResponseDefault1""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default1.InlineResponseDefault1() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default10.py b/test/test_inline_response_default10.py new file mode 100644 index 0000000..fdcf2c3 --- /dev/null +++ b/test/test_inline_response_default10.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default10 import InlineResponseDefault10 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault10(unittest.TestCase): + """InlineResponseDefault10 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault10(self): + """Test InlineResponseDefault10""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default10.InlineResponseDefault10() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default100.py b/test/test_inline_response_default100.py new file mode 100644 index 0000000..0401836 --- /dev/null +++ b/test/test_inline_response_default100.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default100 import InlineResponseDefault100 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault100(unittest.TestCase): + """InlineResponseDefault100 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault100(self): + """Test InlineResponseDefault100""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default100.InlineResponseDefault100() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default101.py b/test/test_inline_response_default101.py new file mode 100644 index 0000000..9679f43 --- /dev/null +++ b/test/test_inline_response_default101.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default101 import InlineResponseDefault101 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault101(unittest.TestCase): + """InlineResponseDefault101 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault101(self): + """Test InlineResponseDefault101""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default101.InlineResponseDefault101() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default102.py b/test/test_inline_response_default102.py new file mode 100644 index 0000000..77410fc --- /dev/null +++ b/test/test_inline_response_default102.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default102 import InlineResponseDefault102 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault102(unittest.TestCase): + """InlineResponseDefault102 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault102(self): + """Test InlineResponseDefault102""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default102.InlineResponseDefault102() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default103.py b/test/test_inline_response_default103.py new file mode 100644 index 0000000..9b2aa73 --- /dev/null +++ b/test/test_inline_response_default103.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default103 import InlineResponseDefault103 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault103(unittest.TestCase): + """InlineResponseDefault103 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault103(self): + """Test InlineResponseDefault103""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default103.InlineResponseDefault103() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default11.py b/test/test_inline_response_default11.py new file mode 100644 index 0000000..0c48c21 --- /dev/null +++ b/test/test_inline_response_default11.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default11 import InlineResponseDefault11 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault11(unittest.TestCase): + """InlineResponseDefault11 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault11(self): + """Test InlineResponseDefault11""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default11.InlineResponseDefault11() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default12.py b/test/test_inline_response_default12.py new file mode 100644 index 0000000..07e2ea4 --- /dev/null +++ b/test/test_inline_response_default12.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default12 import InlineResponseDefault12 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault12(unittest.TestCase): + """InlineResponseDefault12 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault12(self): + """Test InlineResponseDefault12""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default12.InlineResponseDefault12() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default13.py b/test/test_inline_response_default13.py new file mode 100644 index 0000000..39a45b5 --- /dev/null +++ b/test/test_inline_response_default13.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default13 import InlineResponseDefault13 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault13(unittest.TestCase): + """InlineResponseDefault13 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault13(self): + """Test InlineResponseDefault13""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default13.InlineResponseDefault13() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default14.py b/test/test_inline_response_default14.py new file mode 100644 index 0000000..dcff552 --- /dev/null +++ b/test/test_inline_response_default14.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default14 import InlineResponseDefault14 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault14(unittest.TestCase): + """InlineResponseDefault14 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault14(self): + """Test InlineResponseDefault14""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default14.InlineResponseDefault14() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default15.py b/test/test_inline_response_default15.py new file mode 100644 index 0000000..75206d2 --- /dev/null +++ b/test/test_inline_response_default15.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default15 import InlineResponseDefault15 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault15(unittest.TestCase): + """InlineResponseDefault15 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault15(self): + """Test InlineResponseDefault15""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default15.InlineResponseDefault15() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default16.py b/test/test_inline_response_default16.py new file mode 100644 index 0000000..b39422f --- /dev/null +++ b/test/test_inline_response_default16.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default16 import InlineResponseDefault16 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault16(unittest.TestCase): + """InlineResponseDefault16 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault16(self): + """Test InlineResponseDefault16""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default16.InlineResponseDefault16() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default17.py b/test/test_inline_response_default17.py new file mode 100644 index 0000000..3d146c7 --- /dev/null +++ b/test/test_inline_response_default17.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default17 import InlineResponseDefault17 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault17(unittest.TestCase): + """InlineResponseDefault17 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault17(self): + """Test InlineResponseDefault17""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default17.InlineResponseDefault17() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default18.py b/test/test_inline_response_default18.py new file mode 100644 index 0000000..0ceada7 --- /dev/null +++ b/test/test_inline_response_default18.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default18 import InlineResponseDefault18 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault18(unittest.TestCase): + """InlineResponseDefault18 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault18(self): + """Test InlineResponseDefault18""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default18.InlineResponseDefault18() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default19.py b/test/test_inline_response_default19.py new file mode 100644 index 0000000..4e7cafa --- /dev/null +++ b/test/test_inline_response_default19.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default19 import InlineResponseDefault19 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault19(unittest.TestCase): + """InlineResponseDefault19 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault19(self): + """Test InlineResponseDefault19""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default19.InlineResponseDefault19() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default2.py b/test/test_inline_response_default2.py new file mode 100644 index 0000000..81a9f35 --- /dev/null +++ b/test/test_inline_response_default2.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default2 import InlineResponseDefault2 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault2(unittest.TestCase): + """InlineResponseDefault2 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault2(self): + """Test InlineResponseDefault2""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default2.InlineResponseDefault2() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default20.py b/test/test_inline_response_default20.py new file mode 100644 index 0000000..b2ab54a --- /dev/null +++ b/test/test_inline_response_default20.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default20 import InlineResponseDefault20 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault20(unittest.TestCase): + """InlineResponseDefault20 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault20(self): + """Test InlineResponseDefault20""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default20.InlineResponseDefault20() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default21.py b/test/test_inline_response_default21.py new file mode 100644 index 0000000..3cb3db1 --- /dev/null +++ b/test/test_inline_response_default21.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default21 import InlineResponseDefault21 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault21(unittest.TestCase): + """InlineResponseDefault21 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault21(self): + """Test InlineResponseDefault21""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default21.InlineResponseDefault21() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default22.py b/test/test_inline_response_default22.py new file mode 100644 index 0000000..68052a1 --- /dev/null +++ b/test/test_inline_response_default22.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default22 import InlineResponseDefault22 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault22(unittest.TestCase): + """InlineResponseDefault22 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault22(self): + """Test InlineResponseDefault22""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default22.InlineResponseDefault22() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default23.py b/test/test_inline_response_default23.py new file mode 100644 index 0000000..0821c7e --- /dev/null +++ b/test/test_inline_response_default23.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default23 import InlineResponseDefault23 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault23(unittest.TestCase): + """InlineResponseDefault23 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault23(self): + """Test InlineResponseDefault23""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default23.InlineResponseDefault23() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default24.py b/test/test_inline_response_default24.py new file mode 100644 index 0000000..946b3b6 --- /dev/null +++ b/test/test_inline_response_default24.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default24 import InlineResponseDefault24 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault24(unittest.TestCase): + """InlineResponseDefault24 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault24(self): + """Test InlineResponseDefault24""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default24.InlineResponseDefault24() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default25.py b/test/test_inline_response_default25.py new file mode 100644 index 0000000..e489ca5 --- /dev/null +++ b/test/test_inline_response_default25.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default25 import InlineResponseDefault25 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault25(unittest.TestCase): + """InlineResponseDefault25 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault25(self): + """Test InlineResponseDefault25""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default25.InlineResponseDefault25() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default26.py b/test/test_inline_response_default26.py new file mode 100644 index 0000000..2063a17 --- /dev/null +++ b/test/test_inline_response_default26.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default26 import InlineResponseDefault26 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault26(unittest.TestCase): + """InlineResponseDefault26 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault26(self): + """Test InlineResponseDefault26""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default26.InlineResponseDefault26() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default27.py b/test/test_inline_response_default27.py new file mode 100644 index 0000000..2f51775 --- /dev/null +++ b/test/test_inline_response_default27.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default27 import InlineResponseDefault27 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault27(unittest.TestCase): + """InlineResponseDefault27 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault27(self): + """Test InlineResponseDefault27""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default27.InlineResponseDefault27() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default28.py b/test/test_inline_response_default28.py new file mode 100644 index 0000000..ab798e9 --- /dev/null +++ b/test/test_inline_response_default28.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default28 import InlineResponseDefault28 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault28(unittest.TestCase): + """InlineResponseDefault28 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault28(self): + """Test InlineResponseDefault28""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default28.InlineResponseDefault28() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default29.py b/test/test_inline_response_default29.py new file mode 100644 index 0000000..fb2ebf7 --- /dev/null +++ b/test/test_inline_response_default29.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default29 import InlineResponseDefault29 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault29(unittest.TestCase): + """InlineResponseDefault29 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault29(self): + """Test InlineResponseDefault29""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default29.InlineResponseDefault29() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default3.py b/test/test_inline_response_default3.py new file mode 100644 index 0000000..cbd3a6f --- /dev/null +++ b/test/test_inline_response_default3.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default3 import InlineResponseDefault3 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault3(unittest.TestCase): + """InlineResponseDefault3 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault3(self): + """Test InlineResponseDefault3""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default3.InlineResponseDefault3() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default30.py b/test/test_inline_response_default30.py new file mode 100644 index 0000000..64c2b80 --- /dev/null +++ b/test/test_inline_response_default30.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default30 import InlineResponseDefault30 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault30(unittest.TestCase): + """InlineResponseDefault30 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault30(self): + """Test InlineResponseDefault30""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default30.InlineResponseDefault30() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default31.py b/test/test_inline_response_default31.py new file mode 100644 index 0000000..0e2da13 --- /dev/null +++ b/test/test_inline_response_default31.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default31 import InlineResponseDefault31 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault31(unittest.TestCase): + """InlineResponseDefault31 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault31(self): + """Test InlineResponseDefault31""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default31.InlineResponseDefault31() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default32.py b/test/test_inline_response_default32.py new file mode 100644 index 0000000..37bf00d --- /dev/null +++ b/test/test_inline_response_default32.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default32 import InlineResponseDefault32 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault32(unittest.TestCase): + """InlineResponseDefault32 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault32(self): + """Test InlineResponseDefault32""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default32.InlineResponseDefault32() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default33.py b/test/test_inline_response_default33.py new file mode 100644 index 0000000..ee54782 --- /dev/null +++ b/test/test_inline_response_default33.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default33 import InlineResponseDefault33 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault33(unittest.TestCase): + """InlineResponseDefault33 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault33(self): + """Test InlineResponseDefault33""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default33.InlineResponseDefault33() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default34.py b/test/test_inline_response_default34.py new file mode 100644 index 0000000..26cdf5b --- /dev/null +++ b/test/test_inline_response_default34.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default34 import InlineResponseDefault34 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault34(unittest.TestCase): + """InlineResponseDefault34 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault34(self): + """Test InlineResponseDefault34""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default34.InlineResponseDefault34() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default35.py b/test/test_inline_response_default35.py new file mode 100644 index 0000000..343405b --- /dev/null +++ b/test/test_inline_response_default35.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default35 import InlineResponseDefault35 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault35(unittest.TestCase): + """InlineResponseDefault35 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault35(self): + """Test InlineResponseDefault35""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default35.InlineResponseDefault35() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default36.py b/test/test_inline_response_default36.py new file mode 100644 index 0000000..f9d18ae --- /dev/null +++ b/test/test_inline_response_default36.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default36 import InlineResponseDefault36 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault36(unittest.TestCase): + """InlineResponseDefault36 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault36(self): + """Test InlineResponseDefault36""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default36.InlineResponseDefault36() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default37.py b/test/test_inline_response_default37.py new file mode 100644 index 0000000..d82f51f --- /dev/null +++ b/test/test_inline_response_default37.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default37 import InlineResponseDefault37 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault37(unittest.TestCase): + """InlineResponseDefault37 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault37(self): + """Test InlineResponseDefault37""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default37.InlineResponseDefault37() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default38.py b/test/test_inline_response_default38.py new file mode 100644 index 0000000..0619db6 --- /dev/null +++ b/test/test_inline_response_default38.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default38 import InlineResponseDefault38 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault38(unittest.TestCase): + """InlineResponseDefault38 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault38(self): + """Test InlineResponseDefault38""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default38.InlineResponseDefault38() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default39.py b/test/test_inline_response_default39.py new file mode 100644 index 0000000..8fffab2 --- /dev/null +++ b/test/test_inline_response_default39.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default39 import InlineResponseDefault39 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault39(unittest.TestCase): + """InlineResponseDefault39 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault39(self): + """Test InlineResponseDefault39""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default39.InlineResponseDefault39() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default4.py b/test/test_inline_response_default4.py new file mode 100644 index 0000000..7e9ddd4 --- /dev/null +++ b/test/test_inline_response_default4.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default4 import InlineResponseDefault4 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault4(unittest.TestCase): + """InlineResponseDefault4 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault4(self): + """Test InlineResponseDefault4""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default4.InlineResponseDefault4() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default40.py b/test/test_inline_response_default40.py new file mode 100644 index 0000000..2cf89ab --- /dev/null +++ b/test/test_inline_response_default40.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default40 import InlineResponseDefault40 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault40(unittest.TestCase): + """InlineResponseDefault40 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault40(self): + """Test InlineResponseDefault40""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default40.InlineResponseDefault40() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default41.py b/test/test_inline_response_default41.py new file mode 100644 index 0000000..282057f --- /dev/null +++ b/test/test_inline_response_default41.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default41 import InlineResponseDefault41 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault41(unittest.TestCase): + """InlineResponseDefault41 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault41(self): + """Test InlineResponseDefault41""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default41.InlineResponseDefault41() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default42.py b/test/test_inline_response_default42.py new file mode 100644 index 0000000..d432b1b --- /dev/null +++ b/test/test_inline_response_default42.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default42 import InlineResponseDefault42 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault42(unittest.TestCase): + """InlineResponseDefault42 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault42(self): + """Test InlineResponseDefault42""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default42.InlineResponseDefault42() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default43.py b/test/test_inline_response_default43.py new file mode 100644 index 0000000..9c1d151 --- /dev/null +++ b/test/test_inline_response_default43.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default43 import InlineResponseDefault43 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault43(unittest.TestCase): + """InlineResponseDefault43 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault43(self): + """Test InlineResponseDefault43""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default43.InlineResponseDefault43() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default44.py b/test/test_inline_response_default44.py new file mode 100644 index 0000000..2f16264 --- /dev/null +++ b/test/test_inline_response_default44.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default44 import InlineResponseDefault44 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault44(unittest.TestCase): + """InlineResponseDefault44 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault44(self): + """Test InlineResponseDefault44""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default44.InlineResponseDefault44() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default45.py b/test/test_inline_response_default45.py new file mode 100644 index 0000000..a3c1b58 --- /dev/null +++ b/test/test_inline_response_default45.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default45 import InlineResponseDefault45 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault45(unittest.TestCase): + """InlineResponseDefault45 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault45(self): + """Test InlineResponseDefault45""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default45.InlineResponseDefault45() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default46.py b/test/test_inline_response_default46.py new file mode 100644 index 0000000..c8ffa4b --- /dev/null +++ b/test/test_inline_response_default46.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default46 import InlineResponseDefault46 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault46(unittest.TestCase): + """InlineResponseDefault46 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault46(self): + """Test InlineResponseDefault46""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default46.InlineResponseDefault46() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default47.py b/test/test_inline_response_default47.py new file mode 100644 index 0000000..6fde643 --- /dev/null +++ b/test/test_inline_response_default47.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default47 import InlineResponseDefault47 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault47(unittest.TestCase): + """InlineResponseDefault47 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault47(self): + """Test InlineResponseDefault47""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default47.InlineResponseDefault47() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default48.py b/test/test_inline_response_default48.py new file mode 100644 index 0000000..e1dad78 --- /dev/null +++ b/test/test_inline_response_default48.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default48 import InlineResponseDefault48 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault48(unittest.TestCase): + """InlineResponseDefault48 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault48(self): + """Test InlineResponseDefault48""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default48.InlineResponseDefault48() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default49.py b/test/test_inline_response_default49.py new file mode 100644 index 0000000..83988e7 --- /dev/null +++ b/test/test_inline_response_default49.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default49 import InlineResponseDefault49 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault49(unittest.TestCase): + """InlineResponseDefault49 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault49(self): + """Test InlineResponseDefault49""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default49.InlineResponseDefault49() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default5.py b/test/test_inline_response_default5.py new file mode 100644 index 0000000..c04d707 --- /dev/null +++ b/test/test_inline_response_default5.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default5 import InlineResponseDefault5 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault5(unittest.TestCase): + """InlineResponseDefault5 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault5(self): + """Test InlineResponseDefault5""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default5.InlineResponseDefault5() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default50.py b/test/test_inline_response_default50.py new file mode 100644 index 0000000..446e51a --- /dev/null +++ b/test/test_inline_response_default50.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default50 import InlineResponseDefault50 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault50(unittest.TestCase): + """InlineResponseDefault50 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault50(self): + """Test InlineResponseDefault50""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default50.InlineResponseDefault50() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default51.py b/test/test_inline_response_default51.py new file mode 100644 index 0000000..3ab31e0 --- /dev/null +++ b/test/test_inline_response_default51.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default51 import InlineResponseDefault51 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault51(unittest.TestCase): + """InlineResponseDefault51 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault51(self): + """Test InlineResponseDefault51""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default51.InlineResponseDefault51() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default52.py b/test/test_inline_response_default52.py new file mode 100644 index 0000000..2ce876d --- /dev/null +++ b/test/test_inline_response_default52.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default52 import InlineResponseDefault52 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault52(unittest.TestCase): + """InlineResponseDefault52 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault52(self): + """Test InlineResponseDefault52""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default52.InlineResponseDefault52() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default53.py b/test/test_inline_response_default53.py new file mode 100644 index 0000000..c530acd --- /dev/null +++ b/test/test_inline_response_default53.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default53 import InlineResponseDefault53 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault53(unittest.TestCase): + """InlineResponseDefault53 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault53(self): + """Test InlineResponseDefault53""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default53.InlineResponseDefault53() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default54.py b/test/test_inline_response_default54.py new file mode 100644 index 0000000..c6092e6 --- /dev/null +++ b/test/test_inline_response_default54.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default54 import InlineResponseDefault54 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault54(unittest.TestCase): + """InlineResponseDefault54 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault54(self): + """Test InlineResponseDefault54""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default54.InlineResponseDefault54() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default55.py b/test/test_inline_response_default55.py new file mode 100644 index 0000000..3e995f7 --- /dev/null +++ b/test/test_inline_response_default55.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default55 import InlineResponseDefault55 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault55(unittest.TestCase): + """InlineResponseDefault55 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault55(self): + """Test InlineResponseDefault55""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default55.InlineResponseDefault55() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default56.py b/test/test_inline_response_default56.py new file mode 100644 index 0000000..77256e4 --- /dev/null +++ b/test/test_inline_response_default56.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default56 import InlineResponseDefault56 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault56(unittest.TestCase): + """InlineResponseDefault56 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault56(self): + """Test InlineResponseDefault56""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default56.InlineResponseDefault56() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default57.py b/test/test_inline_response_default57.py new file mode 100644 index 0000000..7d1b501 --- /dev/null +++ b/test/test_inline_response_default57.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default57 import InlineResponseDefault57 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault57(unittest.TestCase): + """InlineResponseDefault57 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault57(self): + """Test InlineResponseDefault57""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default57.InlineResponseDefault57() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default58.py b/test/test_inline_response_default58.py new file mode 100644 index 0000000..4215e55 --- /dev/null +++ b/test/test_inline_response_default58.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default58 import InlineResponseDefault58 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault58(unittest.TestCase): + """InlineResponseDefault58 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault58(self): + """Test InlineResponseDefault58""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default58.InlineResponseDefault58() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default59.py b/test/test_inline_response_default59.py new file mode 100644 index 0000000..2c8c1e9 --- /dev/null +++ b/test/test_inline_response_default59.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default59 import InlineResponseDefault59 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault59(unittest.TestCase): + """InlineResponseDefault59 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault59(self): + """Test InlineResponseDefault59""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default59.InlineResponseDefault59() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default6.py b/test/test_inline_response_default6.py new file mode 100644 index 0000000..dab6449 --- /dev/null +++ b/test/test_inline_response_default6.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default6 import InlineResponseDefault6 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault6(unittest.TestCase): + """InlineResponseDefault6 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault6(self): + """Test InlineResponseDefault6""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default6.InlineResponseDefault6() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default60.py b/test/test_inline_response_default60.py new file mode 100644 index 0000000..85fc55a --- /dev/null +++ b/test/test_inline_response_default60.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default60 import InlineResponseDefault60 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault60(unittest.TestCase): + """InlineResponseDefault60 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault60(self): + """Test InlineResponseDefault60""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default60.InlineResponseDefault60() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default61.py b/test/test_inline_response_default61.py new file mode 100644 index 0000000..70be84a --- /dev/null +++ b/test/test_inline_response_default61.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default61 import InlineResponseDefault61 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault61(unittest.TestCase): + """InlineResponseDefault61 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault61(self): + """Test InlineResponseDefault61""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default61.InlineResponseDefault61() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default62.py b/test/test_inline_response_default62.py new file mode 100644 index 0000000..fa51416 --- /dev/null +++ b/test/test_inline_response_default62.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default62 import InlineResponseDefault62 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault62(unittest.TestCase): + """InlineResponseDefault62 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault62(self): + """Test InlineResponseDefault62""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default62.InlineResponseDefault62() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default63.py b/test/test_inline_response_default63.py new file mode 100644 index 0000000..0f68c3e --- /dev/null +++ b/test/test_inline_response_default63.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default63 import InlineResponseDefault63 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault63(unittest.TestCase): + """InlineResponseDefault63 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault63(self): + """Test InlineResponseDefault63""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default63.InlineResponseDefault63() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default64.py b/test/test_inline_response_default64.py new file mode 100644 index 0000000..6ba9e9b --- /dev/null +++ b/test/test_inline_response_default64.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default64 import InlineResponseDefault64 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault64(unittest.TestCase): + """InlineResponseDefault64 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault64(self): + """Test InlineResponseDefault64""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default64.InlineResponseDefault64() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default65.py b/test/test_inline_response_default65.py new file mode 100644 index 0000000..f0c82dc --- /dev/null +++ b/test/test_inline_response_default65.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default65 import InlineResponseDefault65 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault65(unittest.TestCase): + """InlineResponseDefault65 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault65(self): + """Test InlineResponseDefault65""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default65.InlineResponseDefault65() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default66.py b/test/test_inline_response_default66.py new file mode 100644 index 0000000..7198598 --- /dev/null +++ b/test/test_inline_response_default66.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default66 import InlineResponseDefault66 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault66(unittest.TestCase): + """InlineResponseDefault66 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault66(self): + """Test InlineResponseDefault66""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default66.InlineResponseDefault66() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default67.py b/test/test_inline_response_default67.py new file mode 100644 index 0000000..1849448 --- /dev/null +++ b/test/test_inline_response_default67.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default67 import InlineResponseDefault67 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault67(unittest.TestCase): + """InlineResponseDefault67 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault67(self): + """Test InlineResponseDefault67""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default67.InlineResponseDefault67() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default68.py b/test/test_inline_response_default68.py new file mode 100644 index 0000000..6b70b28 --- /dev/null +++ b/test/test_inline_response_default68.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default68 import InlineResponseDefault68 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault68(unittest.TestCase): + """InlineResponseDefault68 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault68(self): + """Test InlineResponseDefault68""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default68.InlineResponseDefault68() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default69.py b/test/test_inline_response_default69.py new file mode 100644 index 0000000..a8c241d --- /dev/null +++ b/test/test_inline_response_default69.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default69 import InlineResponseDefault69 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault69(unittest.TestCase): + """InlineResponseDefault69 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault69(self): + """Test InlineResponseDefault69""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default69.InlineResponseDefault69() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default7.py b/test/test_inline_response_default7.py new file mode 100644 index 0000000..1bffd5a --- /dev/null +++ b/test/test_inline_response_default7.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default7 import InlineResponseDefault7 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault7(unittest.TestCase): + """InlineResponseDefault7 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault7(self): + """Test InlineResponseDefault7""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default7.InlineResponseDefault7() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default70.py b/test/test_inline_response_default70.py new file mode 100644 index 0000000..9617497 --- /dev/null +++ b/test/test_inline_response_default70.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default70 import InlineResponseDefault70 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault70(unittest.TestCase): + """InlineResponseDefault70 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault70(self): + """Test InlineResponseDefault70""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default70.InlineResponseDefault70() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default71.py b/test/test_inline_response_default71.py new file mode 100644 index 0000000..89a4c6e --- /dev/null +++ b/test/test_inline_response_default71.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default71 import InlineResponseDefault71 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault71(unittest.TestCase): + """InlineResponseDefault71 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault71(self): + """Test InlineResponseDefault71""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default71.InlineResponseDefault71() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default72.py b/test/test_inline_response_default72.py new file mode 100644 index 0000000..3d86428 --- /dev/null +++ b/test/test_inline_response_default72.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default72 import InlineResponseDefault72 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault72(unittest.TestCase): + """InlineResponseDefault72 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault72(self): + """Test InlineResponseDefault72""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default72.InlineResponseDefault72() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default73.py b/test/test_inline_response_default73.py new file mode 100644 index 0000000..8821371 --- /dev/null +++ b/test/test_inline_response_default73.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default73 import InlineResponseDefault73 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault73(unittest.TestCase): + """InlineResponseDefault73 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault73(self): + """Test InlineResponseDefault73""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default73.InlineResponseDefault73() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default74.py b/test/test_inline_response_default74.py new file mode 100644 index 0000000..3001a47 --- /dev/null +++ b/test/test_inline_response_default74.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default74 import InlineResponseDefault74 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault74(unittest.TestCase): + """InlineResponseDefault74 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault74(self): + """Test InlineResponseDefault74""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default74.InlineResponseDefault74() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default75.py b/test/test_inline_response_default75.py new file mode 100644 index 0000000..8a36f6e --- /dev/null +++ b/test/test_inline_response_default75.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default75 import InlineResponseDefault75 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault75(unittest.TestCase): + """InlineResponseDefault75 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault75(self): + """Test InlineResponseDefault75""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default75.InlineResponseDefault75() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default76.py b/test/test_inline_response_default76.py new file mode 100644 index 0000000..77615fa --- /dev/null +++ b/test/test_inline_response_default76.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default76 import InlineResponseDefault76 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault76(unittest.TestCase): + """InlineResponseDefault76 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault76(self): + """Test InlineResponseDefault76""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default76.InlineResponseDefault76() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default77.py b/test/test_inline_response_default77.py new file mode 100644 index 0000000..6838109 --- /dev/null +++ b/test/test_inline_response_default77.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default77 import InlineResponseDefault77 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault77(unittest.TestCase): + """InlineResponseDefault77 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault77(self): + """Test InlineResponseDefault77""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default77.InlineResponseDefault77() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default78.py b/test/test_inline_response_default78.py new file mode 100644 index 0000000..ada92e2 --- /dev/null +++ b/test/test_inline_response_default78.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default78 import InlineResponseDefault78 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault78(unittest.TestCase): + """InlineResponseDefault78 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault78(self): + """Test InlineResponseDefault78""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default78.InlineResponseDefault78() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default79.py b/test/test_inline_response_default79.py new file mode 100644 index 0000000..12ead53 --- /dev/null +++ b/test/test_inline_response_default79.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default79 import InlineResponseDefault79 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault79(unittest.TestCase): + """InlineResponseDefault79 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault79(self): + """Test InlineResponseDefault79""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default79.InlineResponseDefault79() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default8.py b/test/test_inline_response_default8.py new file mode 100644 index 0000000..268982d --- /dev/null +++ b/test/test_inline_response_default8.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default8 import InlineResponseDefault8 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault8(unittest.TestCase): + """InlineResponseDefault8 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault8(self): + """Test InlineResponseDefault8""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default8.InlineResponseDefault8() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default80.py b/test/test_inline_response_default80.py new file mode 100644 index 0000000..aeec8e9 --- /dev/null +++ b/test/test_inline_response_default80.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default80 import InlineResponseDefault80 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault80(unittest.TestCase): + """InlineResponseDefault80 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault80(self): + """Test InlineResponseDefault80""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default80.InlineResponseDefault80() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default81.py b/test/test_inline_response_default81.py new file mode 100644 index 0000000..5944c3e --- /dev/null +++ b/test/test_inline_response_default81.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default81 import InlineResponseDefault81 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault81(unittest.TestCase): + """InlineResponseDefault81 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault81(self): + """Test InlineResponseDefault81""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default81.InlineResponseDefault81() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default82.py b/test/test_inline_response_default82.py new file mode 100644 index 0000000..27cfef6 --- /dev/null +++ b/test/test_inline_response_default82.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default82 import InlineResponseDefault82 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault82(unittest.TestCase): + """InlineResponseDefault82 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault82(self): + """Test InlineResponseDefault82""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default82.InlineResponseDefault82() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default83.py b/test/test_inline_response_default83.py new file mode 100644 index 0000000..c051f33 --- /dev/null +++ b/test/test_inline_response_default83.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default83 import InlineResponseDefault83 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault83(unittest.TestCase): + """InlineResponseDefault83 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault83(self): + """Test InlineResponseDefault83""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default83.InlineResponseDefault83() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default84.py b/test/test_inline_response_default84.py new file mode 100644 index 0000000..f3f2010 --- /dev/null +++ b/test/test_inline_response_default84.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default84 import InlineResponseDefault84 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault84(unittest.TestCase): + """InlineResponseDefault84 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault84(self): + """Test InlineResponseDefault84""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default84.InlineResponseDefault84() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default85.py b/test/test_inline_response_default85.py new file mode 100644 index 0000000..8032578 --- /dev/null +++ b/test/test_inline_response_default85.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default85 import InlineResponseDefault85 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault85(unittest.TestCase): + """InlineResponseDefault85 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault85(self): + """Test InlineResponseDefault85""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default85.InlineResponseDefault85() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default86.py b/test/test_inline_response_default86.py new file mode 100644 index 0000000..d9aeceb --- /dev/null +++ b/test/test_inline_response_default86.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default86 import InlineResponseDefault86 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault86(unittest.TestCase): + """InlineResponseDefault86 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault86(self): + """Test InlineResponseDefault86""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default86.InlineResponseDefault86() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default87.py b/test/test_inline_response_default87.py new file mode 100644 index 0000000..5c1824e --- /dev/null +++ b/test/test_inline_response_default87.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default87 import InlineResponseDefault87 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault87(unittest.TestCase): + """InlineResponseDefault87 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault87(self): + """Test InlineResponseDefault87""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default87.InlineResponseDefault87() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default88.py b/test/test_inline_response_default88.py new file mode 100644 index 0000000..99e217d --- /dev/null +++ b/test/test_inline_response_default88.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default88 import InlineResponseDefault88 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault88(unittest.TestCase): + """InlineResponseDefault88 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault88(self): + """Test InlineResponseDefault88""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default88.InlineResponseDefault88() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default89.py b/test/test_inline_response_default89.py new file mode 100644 index 0000000..219de00 --- /dev/null +++ b/test/test_inline_response_default89.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default89 import InlineResponseDefault89 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault89(unittest.TestCase): + """InlineResponseDefault89 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault89(self): + """Test InlineResponseDefault89""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default89.InlineResponseDefault89() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default9.py b/test/test_inline_response_default9.py new file mode 100644 index 0000000..237dcb8 --- /dev/null +++ b/test/test_inline_response_default9.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default9 import InlineResponseDefault9 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault9(unittest.TestCase): + """InlineResponseDefault9 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault9(self): + """Test InlineResponseDefault9""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default9.InlineResponseDefault9() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default90.py b/test/test_inline_response_default90.py new file mode 100644 index 0000000..ce90e3b --- /dev/null +++ b/test/test_inline_response_default90.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default90 import InlineResponseDefault90 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault90(unittest.TestCase): + """InlineResponseDefault90 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault90(self): + """Test InlineResponseDefault90""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default90.InlineResponseDefault90() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default91.py b/test/test_inline_response_default91.py new file mode 100644 index 0000000..065bfd7 --- /dev/null +++ b/test/test_inline_response_default91.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default91 import InlineResponseDefault91 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault91(unittest.TestCase): + """InlineResponseDefault91 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault91(self): + """Test InlineResponseDefault91""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default91.InlineResponseDefault91() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default92.py b/test/test_inline_response_default92.py new file mode 100644 index 0000000..a461f0e --- /dev/null +++ b/test/test_inline_response_default92.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default92 import InlineResponseDefault92 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault92(unittest.TestCase): + """InlineResponseDefault92 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault92(self): + """Test InlineResponseDefault92""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default92.InlineResponseDefault92() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default93.py b/test/test_inline_response_default93.py new file mode 100644 index 0000000..76fef3a --- /dev/null +++ b/test/test_inline_response_default93.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default93 import InlineResponseDefault93 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault93(unittest.TestCase): + """InlineResponseDefault93 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault93(self): + """Test InlineResponseDefault93""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default93.InlineResponseDefault93() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default94.py b/test/test_inline_response_default94.py new file mode 100644 index 0000000..ee285e9 --- /dev/null +++ b/test/test_inline_response_default94.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default94 import InlineResponseDefault94 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault94(unittest.TestCase): + """InlineResponseDefault94 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault94(self): + """Test InlineResponseDefault94""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default94.InlineResponseDefault94() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default95.py b/test/test_inline_response_default95.py new file mode 100644 index 0000000..f7ebca5 --- /dev/null +++ b/test/test_inline_response_default95.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default95 import InlineResponseDefault95 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault95(unittest.TestCase): + """InlineResponseDefault95 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault95(self): + """Test InlineResponseDefault95""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default95.InlineResponseDefault95() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default96.py b/test/test_inline_response_default96.py new file mode 100644 index 0000000..60b9e74 --- /dev/null +++ b/test/test_inline_response_default96.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default96 import InlineResponseDefault96 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault96(unittest.TestCase): + """InlineResponseDefault96 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault96(self): + """Test InlineResponseDefault96""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default96.InlineResponseDefault96() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default97.py b/test/test_inline_response_default97.py new file mode 100644 index 0000000..183469c --- /dev/null +++ b/test/test_inline_response_default97.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default97 import InlineResponseDefault97 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault97(unittest.TestCase): + """InlineResponseDefault97 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault97(self): + """Test InlineResponseDefault97""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default97.InlineResponseDefault97() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default98.py b/test/test_inline_response_default98.py new file mode 100644 index 0000000..a4f9681 --- /dev/null +++ b/test/test_inline_response_default98.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default98 import InlineResponseDefault98 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault98(unittest.TestCase): + """InlineResponseDefault98 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault98(self): + """Test InlineResponseDefault98""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default98.InlineResponseDefault98() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response_default99.py b/test/test_inline_response_default99.py new file mode 100644 index 0000000..e09b564 --- /dev/null +++ b/test/test_inline_response_default99.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.inline_response_default99 import InlineResponseDefault99 # noqa: E501 +from billforward.rest import ApiException + + +class TestInlineResponseDefault99(unittest.TestCase): + """InlineResponseDefault99 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponseDefault99(self): + """Test InlineResponseDefault99""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.inline_response_default99.InlineResponseDefault99() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_insertable_billing_entity.py b/test/test_insertable_billing_entity.py deleted file mode 100644 index b0ed258..0000000 --- a/test/test_insertable_billing_entity.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.insertable_billing_entity import InsertableBillingEntity - - -class TestInsertableBillingEntity(unittest.TestCase): - """ InsertableBillingEntity unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInsertableBillingEntity(self): - """ - Test InsertableBillingEntity - """ - model = billforward.models.insertable_billing_entity.InsertableBillingEntity() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_interval_date.py b/test/test_interval_date.py new file mode 100644 index 0000000..5ae67ea --- /dev/null +++ b/test/test_interval_date.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.interval_date import IntervalDate # noqa: E501 +from billforward.rest import ApiException + + +class TestIntervalDate(unittest.TestCase): + """IntervalDate unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testIntervalDate(self): + """Test IntervalDate""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.interval_date.IntervalDate() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_invoice.py b/test/test_invoice.py index 65e31b0..5bee6aa 100644 --- a/test/test_invoice.py +++ b/test/test_invoice.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.invoice import Invoice # noqa: E501 from billforward.rest import ApiException -from billforward.models.invoice import Invoice class TestInvoice(unittest.TestCase): - """ Invoice unit test stubs """ + """Invoice unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testInvoice(self): - """ - Test Invoice - """ - model = billforward.models.invoice.Invoice() + """Test Invoice""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice.Invoice() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_invoice_charge_request.py b/test/test_invoice_charge_request.py index d8dcf2f..bb2f3e7 100644 --- a/test/test_invoice_charge_request.py +++ b/test/test_invoice_charge_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.invoice_charge_request import InvoiceChargeRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.invoice_charge_request import InvoiceChargeRequest class TestInvoiceChargeRequest(unittest.TestCase): - """ InvoiceChargeRequest unit test stubs """ + """InvoiceChargeRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testInvoiceChargeRequest(self): - """ - Test InvoiceChargeRequest - """ - model = billforward.models.invoice_charge_request.InvoiceChargeRequest() + """Test InvoiceChargeRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_charge_request.InvoiceChargeRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_invoice_execution_request.py b/test/test_invoice_execution_request.py new file mode 100644 index 0000000..7c1e817 --- /dev/null +++ b/test/test_invoice_execution_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.invoice_execution_request import InvoiceExecutionRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestInvoiceExecutionRequest(unittest.TestCase): + """InvoiceExecutionRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceExecutionRequest(self): + """Test InvoiceExecutionRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_execution_request.InvoiceExecutionRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_invoice_line.py b/test/test_invoice_line.py deleted file mode 100644 index 9e91ed3..0000000 --- a/test/test_invoice_line.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.invoice_line import InvoiceLine - - -class TestInvoiceLine(unittest.TestCase): - """ InvoiceLine unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceLine(self): - """ - Test InvoiceLine - """ - model = billforward.models.invoice_line.InvoiceLine() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_line_payment.py b/test/test_invoice_line_payment.py deleted file mode 100644 index b218989..0000000 --- a/test/test_invoice_line_payment.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.invoice_line_payment import InvoiceLinePayment - - -class TestInvoiceLinePayment(unittest.TestCase): - """ InvoiceLinePayment unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceLinePayment(self): - """ - Test InvoiceLinePayment - """ - model = billforward.models.invoice_line_payment.InvoiceLinePayment() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_line_payment_paged_metadata.py b/test/test_invoice_line_payment_paged_metadata.py deleted file mode 100644 index 809623d..0000000 --- a/test/test_invoice_line_payment_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.invoice_line_payment_paged_metadata import InvoiceLinePaymentPagedMetadata - - -class TestInvoiceLinePaymentPagedMetadata(unittest.TestCase): - """ InvoiceLinePaymentPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceLinePaymentPagedMetadata(self): - """ - Test InvoiceLinePaymentPagedMetadata - """ - model = billforward.models.invoice_line_payment_paged_metadata.InvoiceLinePaymentPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_line_payments.py b/test/test_invoice_line_payments.py new file mode 100644 index 0000000..b7fdb31 --- /dev/null +++ b/test/test_invoice_line_payments.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.invoice_line_payments import InvoiceLinePayments # noqa: E501 +from billforward.rest import ApiException + + +class TestInvoiceLinePayments(unittest.TestCase): + """InvoiceLinePayments unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceLinePayments(self): + """Test InvoiceLinePayments""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_line_payments.InvoiceLinePayments() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_invoice_lines.py b/test/test_invoice_lines.py new file mode 100644 index 0000000..aa1e601 --- /dev/null +++ b/test/test_invoice_lines.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.invoice_lines import InvoiceLines # noqa: E501 +from billforward.rest import ApiException + + +class TestInvoiceLines(unittest.TestCase): + """InvoiceLines unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceLines(self): + """Test InvoiceLines""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_lines.InvoiceLines() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_invoice_next_execution_attempt_amendment.py b/test/test_invoice_next_execution_attempt_amendment.py index 5d31d6d..60a4338 100644 --- a/test/test_invoice_next_execution_attempt_amendment.py +++ b/test/test_invoice_next_execution_attempt_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.invoice_next_execution_attempt_amendment import InvoiceNextExecutionAttemptAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.invoice_next_execution_attempt_amendment import InvoiceNextExecutionAttemptAmendment class TestInvoiceNextExecutionAttemptAmendment(unittest.TestCase): - """ InvoiceNextExecutionAttemptAmendment unit test stubs """ + """InvoiceNextExecutionAttemptAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testInvoiceNextExecutionAttemptAmendment(self): - """ - Test InvoiceNextExecutionAttemptAmendment - """ - model = billforward.models.invoice_next_execution_attempt_amendment.InvoiceNextExecutionAttemptAmendment() + """Test InvoiceNextExecutionAttemptAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_next_execution_attempt_amendment.InvoiceNextExecutionAttemptAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_invoice_outstanding_charges_amendment.py b/test/test_invoice_outstanding_charges_amendment.py index 0aaf533..cb2f234 100644 --- a/test/test_invoice_outstanding_charges_amendment.py +++ b/test/test_invoice_outstanding_charges_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.invoice_outstanding_charges_amendment import InvoiceOutstandingChargesAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.invoice_outstanding_charges_amendment import InvoiceOutstandingChargesAmendment class TestInvoiceOutstandingChargesAmendment(unittest.TestCase): - """ InvoiceOutstandingChargesAmendment unit test stubs """ + """InvoiceOutstandingChargesAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testInvoiceOutstandingChargesAmendment(self): - """ - Test InvoiceOutstandingChargesAmendment - """ - model = billforward.models.invoice_outstanding_charges_amendment.InvoiceOutstandingChargesAmendment() + """Test InvoiceOutstandingChargesAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_outstanding_charges_amendment.InvoiceOutstandingChargesAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_invoice_paged_metadata.py b/test/test_invoice_paged_metadata.py deleted file mode 100644 index 952ffd8..0000000 --- a/test/test_invoice_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.invoice_paged_metadata import InvoicePagedMetadata - - -class TestInvoicePagedMetadata(unittest.TestCase): - """ InvoicePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoicePagedMetadata(self): - """ - Test InvoicePagedMetadata - """ - model = billforward.models.invoice_paged_metadata.InvoicePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_payment.py b/test/test_invoice_payment.py deleted file mode 100644 index 136718a..0000000 --- a/test/test_invoice_payment.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.invoice_payment import InvoicePayment - - -class TestInvoicePayment(unittest.TestCase): - """ InvoicePayment unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoicePayment(self): - """ - Test InvoicePayment - """ - model = billforward.models.invoice_payment.InvoicePayment() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_payments.py b/test/test_invoice_payments.py new file mode 100644 index 0000000..cb24993 --- /dev/null +++ b/test/test_invoice_payments.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.invoice_payments import InvoicePayments # noqa: E501 +from billforward.rest import ApiException + + +class TestInvoicePayments(unittest.TestCase): + """InvoicePayments unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoicePayments(self): + """Test InvoicePayments""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_payments.InvoicePayments() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_invoice_recalculation_amendment.py b/test/test_invoice_recalculation_amendment.py index 510978e..a971d8d 100644 --- a/test/test_invoice_recalculation_amendment.py +++ b/test/test_invoice_recalculation_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.invoice_recalculation_amendment import InvoiceRecalculationAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.invoice_recalculation_amendment import InvoiceRecalculationAmendment class TestInvoiceRecalculationAmendment(unittest.TestCase): - """ InvoiceRecalculationAmendment unit test stubs """ + """InvoiceRecalculationAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testInvoiceRecalculationAmendment(self): - """ - Test InvoiceRecalculationAmendment - """ - model = billforward.models.invoice_recalculation_amendment.InvoiceRecalculationAmendment() + """Test InvoiceRecalculationAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_recalculation_amendment.InvoiceRecalculationAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_invoice_recalculation_request.py b/test/test_invoice_recalculation_request.py index d7641a6..2c09cbe 100644 --- a/test/test_invoice_recalculation_request.py +++ b/test/test_invoice_recalculation_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.invoice_recalculation_request import InvoiceRecalculationRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.invoice_recalculation_request import InvoiceRecalculationRequest class TestInvoiceRecalculationRequest(unittest.TestCase): - """ InvoiceRecalculationRequest unit test stubs """ + """InvoiceRecalculationRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testInvoiceRecalculationRequest(self): - """ - Test InvoiceRecalculationRequest - """ - model = billforward.models.invoice_recalculation_request.InvoiceRecalculationRequest() + """Test InvoiceRecalculationRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_recalculation_request.InvoiceRecalculationRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_invoice_refund_request.py b/test/test_invoice_refund_request.py new file mode 100644 index 0000000..55cf72f --- /dev/null +++ b/test/test_invoice_refund_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.invoice_refund_request import InvoiceRefundRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestInvoiceRefundRequest(unittest.TestCase): + """InvoiceRefundRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceRefundRequest(self): + """Test InvoiceRefundRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_refund_request.InvoiceRefundRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_invoice_refund_response.py b/test/test_invoice_refund_response.py new file mode 100644 index 0000000..78fb21f --- /dev/null +++ b/test/test_invoice_refund_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.invoice_refund_response import InvoiceRefundResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestInvoiceRefundResponse(unittest.TestCase): + """InvoiceRefundResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceRefundResponse(self): + """Test InvoiceRefundResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_refund_response.InvoiceRefundResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_invoice_split.py b/test/test_invoice_split.py new file mode 100644 index 0000000..f76d519 --- /dev/null +++ b/test/test_invoice_split.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.invoice_split import InvoiceSplit # noqa: E501 +from billforward.rest import ApiException + + +class TestInvoiceSplit(unittest.TestCase): + """InvoiceSplit unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceSplit(self): + """Test InvoiceSplit""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_split.InvoiceSplit() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_invoice_split_service_request.py b/test/test_invoice_split_service_request.py new file mode 100644 index 0000000..67d543f --- /dev/null +++ b/test/test_invoice_split_service_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.invoice_split_service_request import InvoiceSplitServiceRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestInvoiceSplitServiceRequest(unittest.TestCase): + """InvoiceSplitServiceRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceSplitServiceRequest(self): + """Test InvoiceSplitServiceRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_split_service_request.InvoiceSplitServiceRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_invoice_template_config_response.py b/test/test_invoice_template_config_response.py new file mode 100644 index 0000000..e14df6e --- /dev/null +++ b/test/test_invoice_template_config_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.invoice_template_config_response import InvoiceTemplateConfigResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestInvoiceTemplateConfigResponse(unittest.TestCase): + """InvoiceTemplateConfigResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceTemplateConfigResponse(self): + """Test InvoiceTemplateConfigResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.invoice_template_config_response.InvoiceTemplateConfigResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_invoices_api.py b/test/test_invoices_api.py index faa6c9b..81bf684 100644 --- a/test/test_invoices_api.py +++ b/test/test_invoices_api.py @@ -1,387 +1,330 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.api.invoices_api import InvoicesApi # noqa: E501 from billforward.rest import ApiException -from billforward.apis.invoices_api import InvoicesApi class TestInvoicesApi(unittest.TestCase): - """ InvoicesApi unit test stubs """ + """InvoicesApi unit test stubs""" def setUp(self): - self.api = billforward.apis.invoices_api.InvoicesApi() + self.api = InvoicesApi() # noqa: E501 def tearDown(self): pass def test_add_charge_to_invoice(self): - """ - Test case for add_charge_to_invoice - - Creates a charge on the specified invoice. - """ - pass + """Test case for add_charge_to_invoice - def test_aggregate_invoices(self): - """ - Test case for aggregate_invoices - - Aggregate Invoices into to one parent Invoice """ pass def test_execute_invoice(self): - """ - Test case for execute_invoice + """Test case for execute_invoice - Attempt payment for the outstanding value of an invoice - """ - pass - - def test_generate_line_payments_for_all_invoices(self): - """ - Test case for generate_line_payments_for_all_invoices - - Generates InvoiceLinePayments for all existing InvoicePayments. """ pass def test_get_all_invoices(self): - """ - Test case for get_all_invoices + """Test case for get_all_invoices - Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_all_invoices_as_csv(self): - """ - Test case for get_all_invoices_as_csv + """Test case for get_all_invoices_as_csv - Retrieves a collection of all invoices. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_bucketed_revenue_attributions_as_csv(self): - """ - Test case for get_bucketed_revenue_attributions_as_csv + """Test case for get_bucketed_revenue_attributions_as_csv - Retrieves (as CSV) all attributions of Invoice costs to Invoice lines, bucketed. """ pass def test_get_charges_on_invoice(self): - """ - Test case for get_charges_on_invoice + """Test case for get_charges_on_invoice - Returns all charges for the specified invoice. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_credit_invoice_line_payments_from_invoices_as_csv(self): - """ - Test case for get_credit_invoice_line_payments_from_invoices_as_csv + """Test case for get_credit_invoice_line_payments_from_invoices_as_csv - Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. """ pass def test_get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(self): - """ - Test case for get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received + """Test case for get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received - Retrieves credit note-paid from InvoicePayments upon line items, in CSV format. """ pass def test_get_debit_invoice_line_payments_from_invoices_as_csv(self): - """ - Test case for get_debit_invoice_line_payments_from_invoices_as_csv + """Test case for get_debit_invoice_line_payments_from_invoices_as_csv - Retrieves received revenue from InvoicePayments upon line items, in CSV format. """ pass def test_get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(self): + """Test case for get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received + """ - Test case for get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received + pass + + def test_get_hosted_payments(self): + """Test case for get_hosted_payments - Retrieves received revenue from InvoicePayments upon line items, in CSV format. """ pass def test_get_invoice_as_html(self): - """ - Test case for get_invoice_as_html + """Test case for get_invoice_as_html - Retrieves a single invoice specified by the ID parameter. """ pass def test_get_invoice_as_pdf(self): - """ - Test case for get_invoice_as_pdf + """Test case for get_invoice_as_pdf - Retrieves a single invoice specified by the ID parameter. """ pass def test_get_invoice_by_id(self): - """ - Test case for get_invoice_by_id + """Test case for get_invoice_by_id - Retrieves a single invoice specified by the invoice-ID parameter. """ pass def test_get_invoice_by_id_as_csv(self): - """ - Test case for get_invoice_by_id_as_csv + """Test case for get_invoice_by_id_as_csv - Retrieves a single invoice specified by the ID parameter. """ pass def test_get_invoice_by_subscription_id(self): - """ - Test case for get_invoice_by_subscription_id + """Test case for get_invoice_by_subscription_id - Retrieves a collection of invoices specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_invoice_by_subscription_version_id(self): - """ - Test case for get_invoice_by_subscription_version_id + """Test case for get_invoice_by_subscription_version_id - Retrieves a collection of invoices specified by the subscription-version-ID parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_invoice_by_version_id(self): - """ - Test case for get_invoice_by_version_id + """Test case for get_invoice_by_version_id - Retrieves a single invoice, specified by the version-ID parameter. """ pass - def test_get_invoices_by_account_id(self): + def test_get_invoice_template(self): + """Test case for get_invoice_template + """ - Test case for get_invoices_by_account_id + pass + + def test_get_invoices_by_account_id1(self): + """Test case for get_invoices_by_account_id1 - Retrieves a collection of invoices specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_invoices_by_period_end(self): - """ - Test case for get_invoices_by_period_end + """Test case for get_invoices_by_period_end - Retrieves a collection of invoice objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_invoices_by_period_start(self): - """ - Test case for get_invoices_by_period_start + """Test case for get_invoices_by_period_start - Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_invoices_by_period_start_as_csv(self): - """ - Test case for get_invoices_by_period_start_as_csv + """Test case for get_invoices_by_period_start_as_csv - Retrieves a collection of invoice objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_invoices_by_state(self): - """ - Test case for get_invoices_by_state + """Test case for get_invoices_by_state - Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_invoices_by_state_and_period_start(self): - """ - Test case for get_invoices_by_state_and_period_start + """Test case for get_invoices_by_state_and_period_start - Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_invoices_by_state_and_period_start_as_csv(self): - """ - Test case for get_invoices_by_state_and_period_start_as_csv + """Test case for get_invoices_by_state_and_period_start_as_csv - Retrieves a collection of invoice objects specified by the state parameter and with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_invoices_by_state_as_csv(self): - """ - Test case for get_invoices_by_state_as_csv + """Test case for get_invoices_by_state_as_csv - Retrieves a collection of invoices, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_line_payments(self): - """ - Test case for get_line_payments + """Test case for get_line_payments - Retrieves all InvoiceLine payment attributions. """ pass def test_get_line_payments_as_csv(self): - """ - Test case for get_line_payments_as_csv + """Test case for get_line_payments_as_csv - Retrieves (as CSV) all InvoiceLine payment attributions. """ pass def test_get_metadata_for_invoice(self): + """Test case for get_metadata_for_invoice + """ - Test case for get_metadata_for_invoice + pass + + def test_get_refund_for_refunded_invoice(self): + """Test case for get_refund_for_refunded_invoice - Retrieve any associated metadata. """ pass def test_get_refund_invoice_line_payments_from_invoices_as_csv(self): - """ - Test case for get_refund_invoice_line_payments_from_invoices_as_csv + """Test case for get_refund_invoice_line_payments_from_invoices_as_csv - Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. """ pass def test_get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(self): - """ - Test case for get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received + """Test case for get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received - Retrieves awarded refunds from InvoicePayments upon line items, in CSV format. """ pass def test_get_revenue_attributions(self): - """ - Test case for get_revenue_attributions + """Test case for get_revenue_attributions - Retrieves all attributions of Invoice costs to Invoice lines. """ pass def test_get_revenue_attributions_as_csv(self): - """ - Test case for get_revenue_attributions_as_csv + """Test case for get_revenue_attributions_as_csv - Retrieves (as CSV) all attributions of Invoice costs to Invoice lines. """ pass def test_get_swagger_for_invoice(self): - """ - Test case for get_swagger_for_invoice + """Test case for get_swagger_for_invoice - """ pass def test_import_invoice(self): + """Test case for import_invoice + + """ + pass + + def test_issue_invoice(self): + """Test case for issue_invoice + """ - Test case for import_invoice + pass + + def test_list_original_invoice(self): + """Test case for list_original_invoice + + """ + pass + + def test_list_split_invoice(self): + """Test case for list_split_invoice - Import an invoice. """ pass def test_recalculate_invoice(self): + """Test case for recalculate_invoice + """ - Test case for recalculate_invoice + pass + + def test_refund_invoice(self): + """Test case for refund_invoice - Re-calculate an Invoice. """ pass def test_remove_charge_from_invoice(self): - """ - Test case for remove_charge_from_invoice + """Test case for remove_charge_from_invoice - Removes the specified charge from the specified Invoice. """ pass def test_remove_metadata_from_invoice(self): - """ - Test case for remove_metadata_from_invoice + """Test case for remove_metadata_from_invoice - Remove any associated metadata. """ pass def test_set_metadata_for_invoice(self): + """Test case for set_metadata_for_invoice + """ - Test case for set_metadata_for_invoice + pass + + def test_split_invoice(self): + """Test case for split_invoice - Remove any existing metadata keys and create the provided data. """ pass def test_update_invoice(self): + """Test case for update_invoice + """ - Test case for update_invoice + pass + + def test_update_invoice_template(self): + """Test case for update_invoice_template - Update an Invoice. """ pass def test_upsert_metadata_for_invoice(self): - """ - Test case for upsert_metadata_for_invoice + """Test case for upsert_metadata_for_invoice - Update any existing metadata key-values and insert any new key-values, no keys will be removed. """ pass def test_void_invoice(self): - """ - Test case for void_invoice + """Test case for void_invoice - Voids the invoice specified by the invoice identifier parameter. """ pass diff --git a/test/test_issue_invoice_amendment.py b/test/test_issue_invoice_amendment.py index 9b8edd8..809ad70 100644 --- a/test/test_issue_invoice_amendment.py +++ b/test/test_issue_invoice_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.issue_invoice_amendment import IssueInvoiceAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.issue_invoice_amendment import IssueInvoiceAmendment class TestIssueInvoiceAmendment(unittest.TestCase): - """ IssueInvoiceAmendment unit test stubs """ + """IssueInvoiceAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testIssueInvoiceAmendment(self): - """ - Test IssueInvoiceAmendment - """ - model = billforward.models.issue_invoice_amendment.IssueInvoiceAmendment() + """Test IssueInvoiceAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.issue_invoice_amendment.IssueInvoiceAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_issue_invoice_request.py b/test/test_issue_invoice_request.py new file mode 100644 index 0000000..2a8dbdb --- /dev/null +++ b/test/test_issue_invoice_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.issue_invoice_request import IssueInvoiceRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestIssueInvoiceRequest(unittest.TestCase): + """IssueInvoiceRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testIssueInvoiceRequest(self): + """Test IssueInvoiceRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.issue_invoice_request.IssueInvoiceRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_issue_invoice_response.py b/test/test_issue_invoice_response.py new file mode 100644 index 0000000..9515263 --- /dev/null +++ b/test/test_issue_invoice_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.issue_invoice_response import IssueInvoiceResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestIssueInvoiceResponse(unittest.TestCase): + """IssueInvoiceResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testIssueInvoiceResponse(self): + """Test IssueInvoiceResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.issue_invoice_response.IssueInvoiceResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_kash_configuration.py b/test/test_kash_configuration.py new file mode 100644 index 0000000..c80e382 --- /dev/null +++ b/test/test_kash_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.kash_configuration import KashConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestKashConfiguration(unittest.TestCase): + """KashConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testKashConfiguration(self): + """Test KashConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.kash_configuration.KashConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_legacy_create_webhook_request.py b/test/test_legacy_create_webhook_request.py new file mode 100644 index 0000000..1a3e63a --- /dev/null +++ b/test/test_legacy_create_webhook_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.legacy_create_webhook_request import LegacyCreateWebhookRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestLegacyCreateWebhookRequest(unittest.TestCase): + """LegacyCreateWebhookRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLegacyCreateWebhookRequest(self): + """Test LegacyCreateWebhookRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.legacy_create_webhook_request.LegacyCreateWebhookRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_manual_charge.py b/test/test_manual_charge.py new file mode 100644 index 0000000..ae6e77e --- /dev/null +++ b/test/test_manual_charge.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.manual_charge import ManualCharge # noqa: E501 +from billforward.rest import ApiException + + +class TestManualCharge(unittest.TestCase): + """ManualCharge unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testManualCharge(self): + """Test ManualCharge""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.manual_charge.ManualCharge() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_marketplace_quote.py b/test/test_marketplace_quote.py new file mode 100644 index 0000000..8296c0a --- /dev/null +++ b/test/test_marketplace_quote.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.marketplace_quote import MarketplaceQuote # noqa: E501 +from billforward.rest import ApiException + + +class TestMarketplaceQuote(unittest.TestCase): + """MarketplaceQuote unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMarketplaceQuote(self): + """Test MarketplaceQuote""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.marketplace_quote.MarketplaceQuote() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_metadata.py b/test/test_metadata.py new file mode 100644 index 0000000..6b946a1 --- /dev/null +++ b/test/test_metadata.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.metadata import Metadata # noqa: E501 +from billforward.rest import ApiException + + +class TestMetadata(unittest.TestCase): + """Metadata unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMetadata(self): + """Test Metadata""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.metadata.Metadata() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_metadata_api.py b/test/test_metadata_api.py deleted file mode 100644 index bb3e104..0000000 --- a/test/test_metadata_api.py +++ /dev/null @@ -1,78 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.metadata_api import MetadataApi - - -class TestMetadataApi(unittest.TestCase): - """ MetadataApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.metadata_api.MetadataApi() - - def tearDown(self): - pass - - def test_delete_metadata_key_values(self): - """ - Test case for delete_metadata_key_values - - Remove any associated metadata. - """ - pass - - def test_get_metadata_key_values(self): - """ - Test case for get_metadata_key_values - - Retrieve any associated metadata. - """ - pass - - def test_set_metadata_key_values(self): - """ - Test case for set_metadata_key_values - - Remove any existing metadata keys and create the provided data. - """ - pass - - def test_upsert_metadata_key_values(self): - """ - Test case for upsert_metadata_key_values - - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_metadata_key_values.py b/test/test_metadata_key_values.py new file mode 100644 index 0000000..e19b95e --- /dev/null +++ b/test/test_metadata_key_values.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.metadata_key_values import MetadataKeyValues # noqa: E501 +from billforward.rest import ApiException + + +class TestMetadataKeyValues(unittest.TestCase): + """MetadataKeyValues unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMetadataKeyValues(self): + """Test MetadataKeyValues""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.metadata_key_values.MetadataKeyValues() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_metadata_key_values_paged_metadata.py b/test/test_metadata_key_values_paged_metadata.py deleted file mode 100644 index cc45f24..0000000 --- a/test/test_metadata_key_values_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.metadata_key_values_paged_metadata import MetadataKeyValuesPagedMetadata - - -class TestMetadataKeyValuesPagedMetadata(unittest.TestCase): - """ MetadataKeyValuesPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testMetadataKeyValuesPagedMetadata(self): - """ - Test MetadataKeyValuesPagedMetadata - """ - model = billforward.models.metadata_key_values_paged_metadata.MetadataKeyValuesPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_migration.py b/test/test_migration.py new file mode 100644 index 0000000..b0699b5 --- /dev/null +++ b/test/test_migration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.migration import Migration # noqa: E501 +from billforward.rest import ApiException + + +class TestMigration(unittest.TestCase): + """Migration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMigration(self): + """Test Migration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.migration.Migration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_migration_request.py b/test/test_migration_request.py index 2dd394d..e457d47 100644 --- a/test/test_migration_request.py +++ b/test/test_migration_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.migration_request import MigrationRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.migration_request import MigrationRequest class TestMigrationRequest(unittest.TestCase): - """ MigrationRequest unit test stubs """ + """MigrationRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testMigrationRequest(self): - """ - Test MigrationRequest - """ - model = billforward.models.migration_request.MigrationRequest() + """Test MigrationRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.migration_request.MigrationRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_migration_response.py b/test/test_migration_response.py new file mode 100644 index 0000000..c2ff29b --- /dev/null +++ b/test/test_migration_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.migration_response import MigrationResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestMigrationResponse(unittest.TestCase): + """MigrationResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMigrationResponse(self): + """Test MigrationResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.migration_response.MigrationResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_mutable_billing_entity.py b/test/test_mutable_billing_entity.py deleted file mode 100644 index 22e5f8d..0000000 --- a/test/test_mutable_billing_entity.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.mutable_billing_entity import MutableBillingEntity - - -class TestMutableBillingEntity(unittest.TestCase): - """ MutableBillingEntity unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testMutableBillingEntity(self): - """ - Test MutableBillingEntity - """ - model = billforward.models.mutable_billing_entity.MutableBillingEntity() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_nested_adhoc_charge_request.py b/test/test_nested_adhoc_charge_request.py new file mode 100644 index 0000000..42df30c --- /dev/null +++ b/test/test_nested_adhoc_charge_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.nested_adhoc_charge_request import NestedAdhocChargeRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestNestedAdhocChargeRequest(unittest.TestCase): + """NestedAdhocChargeRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNestedAdhocChargeRequest(self): + """Test NestedAdhocChargeRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.nested_adhoc_charge_request.NestedAdhocChargeRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_nested_charge_request.py b/test/test_nested_charge_request.py new file mode 100644 index 0000000..b5d176e --- /dev/null +++ b/test/test_nested_charge_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.nested_charge_request import NestedChargeRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestNestedChargeRequest(unittest.TestCase): + """NestedChargeRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNestedChargeRequest(self): + """Test NestedChargeRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.nested_charge_request.NestedChargeRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_notification.py b/test/test_notification.py deleted file mode 100644 index ab7dbb7..0000000 --- a/test/test_notification.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.notification import Notification - - -class TestNotification(unittest.TestCase): - """ Notification unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testNotification(self): - """ - Test Notification - """ - model = billforward.models.notification.Notification() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_notification_paged_metadata.py b/test/test_notification_paged_metadata.py deleted file mode 100644 index c868e91..0000000 --- a/test/test_notification_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.notification_paged_metadata import NotificationPagedMetadata - - -class TestNotificationPagedMetadata(unittest.TestCase): - """ NotificationPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testNotificationPagedMetadata(self): - """ - Test NotificationPagedMetadata - """ - model = billforward.models.notification_paged_metadata.NotificationPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_notification_send_request.py b/test/test_notification_send_request.py new file mode 100644 index 0000000..891b1ea --- /dev/null +++ b/test/test_notification_send_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.notification_send_request import NotificationSendRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestNotificationSendRequest(unittest.TestCase): + """NotificationSendRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNotificationSendRequest(self): + """Test NotificationSendRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.notification_send_request.NotificationSendRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_notification_send_response.py b/test/test_notification_send_response.py new file mode 100644 index 0000000..b85a5a5 --- /dev/null +++ b/test/test_notification_send_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.notification_send_response import NotificationSendResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestNotificationSendResponse(unittest.TestCase): + """NotificationSendResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNotificationSendResponse(self): + """Test NotificationSendResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.notification_send_response.NotificationSendResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_notifications.py b/test/test_notifications.py new file mode 100644 index 0000000..56f26bb --- /dev/null +++ b/test/test_notifications.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.notifications import Notifications # noqa: E501 +from billforward.rest import ApiException + + +class TestNotifications(unittest.TestCase): + """Notifications unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNotifications(self): + """Test Notifications""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.notifications.Notifications() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_notifications_api.py b/test/test_notifications_api.py index 0a481b7..40542a3 100644 --- a/test/test_notifications_api.py +++ b/test/test_notifications_api.py @@ -1,91 +1,66 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.api.notifications_api import NotificationsApi # noqa: E501 from billforward.rest import ApiException -from billforward.apis.notifications_api import NotificationsApi class TestNotificationsApi(unittest.TestCase): - """ NotificationsApi unit test stubs """ + """NotificationsApi unit test stubs""" def setUp(self): - self.api = billforward.apis.notifications_api.NotificationsApi() + self.api = NotificationsApi() # noqa: E501 def tearDown(self): pass - def test_ack_notification(self): - """ - Test case for ack_notification - - Acknowledge a newly recevied notification. - """ - pass - def test_get_all_notifications(self): - """ - Test case for get_all_notifications + """Test case for get_all_notifications - Returns a collection of all notifications. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_notification_by_entity_id(self): - """ - Test case for get_notification_by_entity_id + """Test case for get_notification_by_entity_id - Returns a collection of notifications, specified by the entity-ID parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_notification_by_id(self): - """ - Test case for get_notification_by_id + """Test case for get_notification_by_id - Returns a single notification, specified by the notification-ID parameter. """ pass def test_get_notifications_by_webhook_id(self): - """ - Test case for get_notifications_by_webhook_id + """Test case for get_notifications_by_webhook_id - Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters for the given webhook id. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_notifications_within_date_range(self): + """Test case for get_notifications_within_date_range + """ - Test case for get_notifications_within_date_range + pass + + def test_resend_notification(self): + """Test case for resend_notification - Returns a collection of notification objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. """ pass diff --git a/test/test_o_auth_token.py b/test/test_o_auth_token.py new file mode 100644 index 0000000..0dbc1ea --- /dev/null +++ b/test/test_o_auth_token.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.o_auth_token import OAuthToken # noqa: E501 +from billforward.rest import ApiException + + +class TestOAuthToken(unittest.TestCase): + """OAuthToken unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOAuthToken(self): + """Test OAuthToken""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.o_auth_token.OAuthToken() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_offline_payment.py b/test/test_offline_payment.py new file mode 100644 index 0000000..59bdd3d --- /dev/null +++ b/test/test_offline_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.offline_payment import OfflinePayment # noqa: E501 +from billforward.rest import ApiException + + +class TestOfflinePayment(unittest.TestCase): + """OfflinePayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOfflinePayment(self): + """Test OfflinePayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.offline_payment.OfflinePayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_open_id_registration_response.py b/test/test_open_id_registration_response.py new file mode 100644 index 0000000..a694a24 --- /dev/null +++ b/test/test_open_id_registration_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.open_id_registration_response import OpenIDRegistrationResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestOpenIDRegistrationResponse(unittest.TestCase): + """OpenIDRegistrationResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOpenIDRegistrationResponse(self): + """Test OpenIDRegistrationResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.open_id_registration_response.OpenIDRegistrationResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_open_id_user_link_request.py b/test/test_open_id_user_link_request.py new file mode 100644 index 0000000..8dbe7ae --- /dev/null +++ b/test/test_open_id_user_link_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.open_id_user_link_request import OpenIdUserLinkRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestOpenIdUserLinkRequest(unittest.TestCase): + """OpenIdUserLinkRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOpenIdUserLinkRequest(self): + """Test OpenIdUserLinkRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.open_id_user_link_request.OpenIdUserLinkRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_organization.py b/test/test_organization.py deleted file mode 100644 index db10507..0000000 --- a/test/test_organization.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.organization import Organization - - -class TestOrganization(unittest.TestCase): - """ Organization unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testOrganization(self): - """ - Test Organization - """ - model = billforward.models.organization.Organization() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_organization_lite_view.py b/test/test_organization_lite_view.py new file mode 100644 index 0000000..3f42b95 --- /dev/null +++ b/test/test_organization_lite_view.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.organization_lite_view import OrganizationLiteView # noqa: E501 +from billforward.rest import ApiException + + +class TestOrganizationLiteView(unittest.TestCase): + """OrganizationLiteView unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOrganizationLiteView(self): + """Test OrganizationLiteView""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.organization_lite_view.OrganizationLiteView() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_organization_paged_metadata.py b/test/test_organization_paged_metadata.py deleted file mode 100644 index 88d22e7..0000000 --- a/test/test_organization_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.organization_paged_metadata import OrganizationPagedMetadata - - -class TestOrganizationPagedMetadata(unittest.TestCase): - """ OrganizationPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testOrganizationPagedMetadata(self): - """ - Test OrganizationPagedMetadata - """ - model = billforward.models.organization_paged_metadata.OrganizationPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_organizations_api.py b/test/test_organizations_api.py deleted file mode 100644 index 95c5f7c..0000000 --- a/test/test_organizations_api.py +++ /dev/null @@ -1,102 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.organizations_api import OrganizationsApi - - -class TestOrganizationsApi(unittest.TestCase): - """ OrganizationsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.organizations_api.OrganizationsApi() - - def tearDown(self): - pass - - def test_create_organization(self): - """ - Test case for create_organization - - Create an organization. - """ - pass - - def test_get_all_my_organizations(self): - """ - Test case for get_all_my_organizations - - Returns a collection of all my asociated organizations. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_all_organizations(self): - """ - Test case for get_all_organizations - - Returns a collection of all organizations. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_organization_by_customer_code(self): - """ - Test case for get_organization_by_customer_code - - Returns a single organization, specified by the customer-code parameter. - """ - pass - - def test_get_organization_by_id(self): - """ - Test case for get_organization_by_id - - Returns a single Organization, specified by the organization-ID parameter. - """ - pass - - def test_get_organization_by_name(self): - """ - Test case for get_organization_by_name - - Returns a single Organization, specified by the name parameter. - """ - pass - - def test_update_organization(self): - """ - Test case for update_organization - - Update an organization. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_password.py b/test/test_password.py index 10ffd74..13abdb7 100644 --- a/test/test_password.py +++ b/test/test_password.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.password import Password # noqa: E501 from billforward.rest import ApiException -from billforward.models.password import Password class TestPassword(unittest.TestCase): - """ Password unit test stubs """ + """Password unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testPassword(self): - """ - Test Password - """ - model = billforward.models.password.Password() + """Test Password""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.password.Password() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_password_paged_metadata.py b/test/test_password_paged_metadata.py deleted file mode 100644 index 204645f..0000000 --- a/test/test_password_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.password_paged_metadata import PasswordPagedMetadata - - -class TestPasswordPagedMetadata(unittest.TestCase): - """ PasswordPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPasswordPagedMetadata(self): - """ - Test PasswordPagedMetadata - """ - model = billforward.models.password_paged_metadata.PasswordPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_password_reset_code_request.py b/test/test_password_reset_code_request.py new file mode 100644 index 0000000..6f27e03 --- /dev/null +++ b/test/test_password_reset_code_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.password_reset_code_request import PasswordResetCodeRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestPasswordResetCodeRequest(unittest.TestCase): + """PasswordResetCodeRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPasswordResetCodeRequest(self): + """Test PasswordResetCodeRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.password_reset_code_request.PasswordResetCodeRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_password_reset_request.py b/test/test_password_reset_request.py deleted file mode 100644 index c26db14..0000000 --- a/test/test_password_reset_request.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.password_reset_request import PasswordResetRequest - - -class TestPasswordResetRequest(unittest.TestCase): - """ PasswordResetRequest unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPasswordResetRequest(self): - """ - Test PasswordResetRequest - """ - model = billforward.models.password_reset_request.PasswordResetRequest() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_password_reset_response.py b/test/test_password_reset_response.py new file mode 100644 index 0000000..ab95dd3 --- /dev/null +++ b/test/test_password_reset_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.password_reset_response import PasswordResetResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestPasswordResetResponse(unittest.TestCase): + """PasswordResetResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPasswordResetResponse(self): + """Test PasswordResetResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.password_reset_response.PasswordResetResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_password_update_with_reset_code_request.py b/test/test_password_update_with_reset_code_request.py new file mode 100644 index 0000000..d0879c5 --- /dev/null +++ b/test/test_password_update_with_reset_code_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.password_update_with_reset_code_request import PasswordUpdateWithResetCodeRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestPasswordUpdateWithResetCodeRequest(unittest.TestCase): + """PasswordUpdateWithResetCodeRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPasswordUpdateWithResetCodeRequest(self): + """Test PasswordUpdateWithResetCodeRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.password_update_with_reset_code_request.PasswordUpdateWithResetCodeRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_passwords_api.py b/test/test_passwords_api.py deleted file mode 100644 index 929fcd0..0000000 --- a/test/test_passwords_api.py +++ /dev/null @@ -1,54 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.passwords_api import PasswordsApi - - -class TestPasswordsApi(unittest.TestCase): - """ PasswordsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.passwords_api.PasswordsApi() - - def tearDown(self): - pass - - def test_create_password(self): - """ - Test case for create_password - - Create - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pause_request.py b/test/test_pause_request.py index f973144..d6d6439 100644 --- a/test/test_pause_request.py +++ b/test/test_pause_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.pause_request import PauseRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.pause_request import PauseRequest class TestPauseRequest(unittest.TestCase): - """ PauseRequest unit test stubs """ + """PauseRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testPauseRequest(self): - """ - Test PauseRequest - """ - model = billforward.models.pause_request.PauseRequest() + """Test PauseRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pause_request.PauseRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_pay_vision_auth_capture_request.py b/test/test_pay_vision_auth_capture_request.py new file mode 100644 index 0000000..f325869 --- /dev/null +++ b/test/test_pay_vision_auth_capture_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.pay_vision_auth_capture_request import PayVisionAuthCaptureRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestPayVisionAuthCaptureRequest(unittest.TestCase): + """PayVisionAuthCaptureRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPayVisionAuthCaptureRequest(self): + """Test PayVisionAuthCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pay_vision_auth_capture_request.PayVisionAuthCaptureRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pay_vision_configuration.py b/test/test_pay_vision_configuration.py new file mode 100644 index 0000000..2c56308 --- /dev/null +++ b/test/test_pay_vision_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.pay_vision_configuration import PayVisionConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestPayVisionConfiguration(unittest.TestCase): + """PayVisionConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPayVisionConfiguration(self): + """Test PayVisionConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pay_vision_configuration.PayVisionConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pay_vision_pre_auth_request.py b/test/test_pay_vision_pre_auth_request.py new file mode 100644 index 0000000..69b17f6 --- /dev/null +++ b/test/test_pay_vision_pre_auth_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.pay_vision_pre_auth_request import PayVisionPreAuthRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestPayVisionPreAuthRequest(unittest.TestCase): + """PayVisionPreAuthRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPayVisionPreAuthRequest(self): + """Test PayVisionPreAuthRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pay_vision_pre_auth_request.PayVisionPreAuthRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_payment.py b/test/test_payment.py index a70b145..48bb07b 100644 --- a/test/test_payment.py +++ b/test/test_payment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.payment import Payment # noqa: E501 from billforward.rest import ApiException -from billforward.models.payment import Payment class TestPayment(unittest.TestCase): - """ Payment unit test stubs """ + """Payment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testPayment(self): - """ - Test Payment - """ - model = billforward.models.payment.Payment() + """Test Payment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.payment.Payment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_payment_accounting_view.py b/test/test_payment_accounting_view.py new file mode 100644 index 0000000..e73c8d3 --- /dev/null +++ b/test/test_payment_accounting_view.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.payment_accounting_view import PaymentAccountingView # noqa: E501 +from billforward.rest import ApiException + + +class TestPaymentAccountingView(unittest.TestCase): + """PaymentAccountingView unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaymentAccountingView(self): + """Test PaymentAccountingView""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.payment_accounting_view.PaymentAccountingView() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_payment_gateway_api.py b/test/test_payment_gateway_api.py new file mode 100644 index 0000000..1fd3c76 --- /dev/null +++ b/test/test_payment_gateway_api.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.payment_gateway_api import PaymentGatewayApi # noqa: E501 +from billforward.rest import ApiException + + +class TestPaymentGatewayApi(unittest.TestCase): + """PaymentGatewayApi unit test stubs""" + + def setUp(self): + self.api = PaymentGatewayApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_api_configuration(self): + """Test case for create_api_configuration + + """ + pass + + def test_get_all_api_configurations(self): + """Test case for get_all_api_configurations + + """ + pass + + def test_get_api_configurations_by_type(self): + """Test case for get_api_configurations_by_type + + """ + pass + + def test_public_configuration(self): + """Test case for public_configuration + + """ + pass + + def test_update_api_configuration(self): + """Test case for update_api_configuration + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_payment_method.py b/test/test_payment_method.py index 54ed511..b85de92 100644 --- a/test/test_payment_method.py +++ b/test/test_payment_method.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.payment_method import PaymentMethod # noqa: E501 from billforward.rest import ApiException -from billforward.models.payment_method import PaymentMethod class TestPaymentMethod(unittest.TestCase): - """ PaymentMethod unit test stubs """ + """PaymentMethod unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testPaymentMethod(self): - """ - Test PaymentMethod - """ - model = billforward.models.payment_method.PaymentMethod() + """Test PaymentMethod""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.payment_method.PaymentMethod() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_payment_method_paged_metadata.py b/test/test_payment_method_paged_metadata.py deleted file mode 100644 index d2640f6..0000000 --- a/test/test_payment_method_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.payment_method_paged_metadata import PaymentMethodPagedMetadata - - -class TestPaymentMethodPagedMetadata(unittest.TestCase): - """ PaymentMethodPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPaymentMethodPagedMetadata(self): - """ - Test PaymentMethodPagedMetadata - """ - model = billforward.models.payment_method_paged_metadata.PaymentMethodPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payment_method_subscription_link.py b/test/test_payment_method_subscription_link.py index 62294b0..6bf84d6 100644 --- a/test/test_payment_method_subscription_link.py +++ b/test/test_payment_method_subscription_link.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.payment_method_subscription_link import PaymentMethodSubscriptionLink # noqa: E501 from billforward.rest import ApiException -from billforward.models.payment_method_subscription_link import PaymentMethodSubscriptionLink class TestPaymentMethodSubscriptionLink(unittest.TestCase): - """ PaymentMethodSubscriptionLink unit test stubs """ + """PaymentMethodSubscriptionLink unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testPaymentMethodSubscriptionLink(self): - """ - Test PaymentMethodSubscriptionLink - """ - model = billforward.models.payment_method_subscription_link.PaymentMethodSubscriptionLink() + """Test PaymentMethodSubscriptionLink""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.payment_method_subscription_link.PaymentMethodSubscriptionLink() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_payment_method_subscription_link_paged_metadata.py b/test/test_payment_method_subscription_link_paged_metadata.py deleted file mode 100644 index 3eea96f..0000000 --- a/test/test_payment_method_subscription_link_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.payment_method_subscription_link_paged_metadata import PaymentMethodSubscriptionLinkPagedMetadata - - -class TestPaymentMethodSubscriptionLinkPagedMetadata(unittest.TestCase): - """ PaymentMethodSubscriptionLinkPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPaymentMethodSubscriptionLinkPagedMetadata(self): - """ - Test PaymentMethodSubscriptionLinkPagedMetadata - """ - model = billforward.models.payment_method_subscription_link_paged_metadata.PaymentMethodSubscriptionLinkPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payment_methods_api.py b/test/test_payment_methods_api.py new file mode 100644 index 0000000..2047f8f --- /dev/null +++ b/test/test_payment_methods_api.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.payment_methods_api import PaymentMethodsApi # noqa: E501 +from billforward.rest import ApiException + + +class TestPaymentMethodsApi(unittest.TestCase): + """PaymentMethodsApi unit test stubs""" + + def setUp(self): + self.api = PaymentMethodsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_payment_method(self): + """Test case for create_payment_method + + """ + pass + + def test_delete_payment_method(self): + """Test case for delete_payment_method + + """ + pass + + def test_get_all_payment_methods(self): + """Test case for get_all_payment_methods + + """ + pass + + def test_get_mandate_pdf(self): + """Test case for get_mandate_pdf + + """ + pass + + def test_get_payment_method_by_id(self): + """Test case for get_payment_method_by_id + + """ + pass + + def test_get_payment_method_by_link_id(self): + """Test case for get_payment_method_by_link_id + + """ + pass + + def test_get_payment_method_by_payment_gateway(self): + """Test case for get_payment_method_by_payment_gateway + + """ + pass + + def test_update_payment_method(self): + """Test case for update_payment_method + + """ + pass + + def test_verify_ach(self): + """Test case for verify_ach + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_payment_paged_metadata.py b/test/test_payment_paged_metadata.py deleted file mode 100644 index 14e88cf..0000000 --- a/test/test_payment_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.payment_paged_metadata import PaymentPagedMetadata - - -class TestPaymentPagedMetadata(unittest.TestCase): - """ PaymentPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPaymentPagedMetadata(self): - """ - Test PaymentPagedMetadata - """ - model = billforward.models.payment_paged_metadata.PaymentPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payment_refund_request.py b/test/test_payment_refund_request.py new file mode 100644 index 0000000..012891e --- /dev/null +++ b/test/test_payment_refund_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.payment_refund_request import PaymentRefundRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestPaymentRefundRequest(unittest.TestCase): + """PaymentRefundRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaymentRefundRequest(self): + """Test PaymentRefundRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.payment_refund_request.PaymentRefundRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_payment_refund_response.py b/test/test_payment_refund_response.py new file mode 100644 index 0000000..162e118 --- /dev/null +++ b/test/test_payment_refund_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.payment_refund_response import PaymentRefundResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestPaymentRefundResponse(unittest.TestCase): + """PaymentRefundResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaymentRefundResponse(self): + """Test PaymentRefundResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.payment_refund_response.PaymentRefundResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_payment_retry_request.py b/test/test_payment_retry_request.py index d6e02f2..c2858ad 100644 --- a/test/test_payment_retry_request.py +++ b/test/test_payment_retry_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.payment_retry_request import PaymentRetryRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.payment_retry_request import PaymentRetryRequest class TestPaymentRetryRequest(unittest.TestCase): - """ PaymentRetryRequest unit test stubs """ + """PaymentRetryRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testPaymentRetryRequest(self): - """ - Test PaymentRetryRequest - """ - model = billforward.models.payment_retry_request.PaymentRetryRequest() + """Test PaymentRetryRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.payment_retry_request.PaymentRetryRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_paymentmethods_api.py b/test/test_paymentmethods_api.py deleted file mode 100644 index cb2230d..0000000 --- a/test/test_paymentmethods_api.py +++ /dev/null @@ -1,110 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.paymentmethods_api import PaymentmethodsApi - - -class TestPaymentmethodsApi(unittest.TestCase): - """ PaymentmethodsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.paymentmethods_api.PaymentmethodsApi() - - def tearDown(self): - pass - - def test_create_payment_method(self): - """ - Test case for create_payment_method - - Create a payment-method. - """ - pass - - def test_delete_payment_method(self): - """ - Test case for delete_payment_method - - Deletes the payment-method specified by the payment-method-ID parameter. - """ - pass - - def test_get_all_payment_methods(self): - """ - Test case for get_all_payment_methods - - Returns a collection of all payment-methods. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_payment_method_by_account_id(self): - """ - Test case for get_payment_method_by_account_id - - Returns a collection of payment-methods, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_payment_method_by_id(self): - """ - Test case for get_payment_method_by_id - - Returns a single payment-method, specified by the payment-method-ID parameter. - """ - pass - - def test_get_payment_method_by_link_id(self): - """ - Test case for get_payment_method_by_link_id - - Returns a single payment-method, specified by the linkID parameter. - """ - pass - - def test_get_payment_method_by_payment_gateway(self): - """ - Test case for get_payment_method_by_payment_gateway - - Returns a collection of payment-methods, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_update_payment_method(self): - """ - Test case for update_payment_method - - Update a payment-method. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_paymentmethodsubscriptionlinks_api.py b/test/test_paymentmethodsubscriptionlinks_api.py deleted file mode 100644 index 2ac430b..0000000 --- a/test/test_paymentmethodsubscriptionlinks_api.py +++ /dev/null @@ -1,62 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.paymentmethodsubscriptionlinks_api import PaymentmethodsubscriptionlinksApi - - -class TestPaymentmethodsubscriptionlinksApi(unittest.TestCase): - """ PaymentmethodsubscriptionlinksApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.paymentmethodsubscriptionlinks_api.PaymentmethodsubscriptionlinksApi() - - def tearDown(self): - pass - - def test_create_payment_method_subscription_link(self): - """ - Test case for create_payment_method_subscription_link - - Create - """ - pass - - def test_retire_payment_method_subscription_link(self): - """ - Test case for retire_payment_method_subscription_link - - Retires the payment-method-subscription-link specified by the link-ID parameter. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payments_api.py b/test/test_payments_api.py index f357918..ec4c480 100644 --- a/test/test_payments_api.py +++ b/test/test_payments_api.py @@ -1,107 +1,90 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.api.payments_api import PaymentsApi # noqa: E501 from billforward.rest import ApiException -from billforward.apis.payments_api import PaymentsApi class TestPaymentsApi(unittest.TestCase): - """ PaymentsApi unit test stubs """ + """PaymentsApi unit test stubs""" def setUp(self): - self.api = billforward.apis.payments_api.PaymentsApi() + self.api = PaymentsApi() # noqa: E501 def tearDown(self): pass - def test_create_payment(self): + def test_create_offline_payment(self): + """Test case for create_offline_payment + """ - Test case for create_payment + pass + + def test_create_payment(self): + """Test case for create_payment - Create a payment. """ pass def test_get_all_payments(self): - """ - Test case for get_all_payments + """Test case for get_all_payments - Returns a collection of all payments. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_payment_as_csv(self): - """ - Test case for get_payment_as_csv + """Test case for get_payment_as_csv - Retrieves payments in CSV format. """ pass def test_get_payment_by_id(self): - """ - Test case for get_payment_by_id + """Test case for get_payment_by_id - Returns a single payment, specified by the payment-ID parameter. """ pass def test_get_payment_by_invoice_id(self): - """ - Test case for get_payment_by_invoice_id + """Test case for get_payment_by_invoice_id - Returns a collection of payments, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_payment_by_payment_gateway(self): - """ - Test case for get_payment_by_payment_gateway + """Test case for get_payment_by_payment_gateway - Returns a collection of payments, specified by the gateway parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_payment_by_payment_method_id(self): + """Test case for get_payment_by_payment_method_id + """ - Test case for get_payment_by_payment_method_id + pass + + def test_refund_payment(self): + """Test case for refund_payment - Returns a collection of payments, specified by the payment-method-ID parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_update_payment(self): - """ - Test case for update_payment + """Test case for update_payment - Update a payment. """ pass diff --git a/test/test_paypal_configuration.py b/test/test_paypal_configuration.py new file mode 100644 index 0000000..cd2388e --- /dev/null +++ b/test/test_paypal_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.paypal_configuration import PaypalConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestPaypalConfiguration(unittest.TestCase): + """PaypalConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaypalConfiguration(self): + """Test PaypalConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.paypal_configuration.PaypalConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_paypal_payment.py b/test/test_paypal_payment.py new file mode 100644 index 0000000..0b0e20f --- /dev/null +++ b/test/test_paypal_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.paypal_payment import PaypalPayment # noqa: E501 +from billforward.rest import ApiException + + +class TestPaypalPayment(unittest.TestCase): + """PaypalPayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaypalPayment(self): + """Test PaypalPayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.paypal_payment.PaypalPayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pending_component_value_change.py b/test/test_pending_component_value_change.py index 1b7af13..454c4a8 100644 --- a/test/test_pending_component_value_change.py +++ b/test/test_pending_component_value_change.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.pending_component_value_change import PendingComponentValueChange # noqa: E501 from billforward.rest import ApiException -from billforward.models.pending_component_value_change import PendingComponentValueChange class TestPendingComponentValueChange(unittest.TestCase): - """ PendingComponentValueChange unit test stubs """ + """PendingComponentValueChange unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testPendingComponentValueChange(self): - """ - Test PendingComponentValueChange - """ - model = billforward.models.pending_component_value_change.PendingComponentValueChange() + """Test PendingComponentValueChange""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pending_component_value_change.PendingComponentValueChange() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_period.py b/test/test_period.py deleted file mode 100644 index 7e79ead..0000000 --- a/test/test_period.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.period import Period - - -class TestPeriod(unittest.TestCase): - """ Period unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPeriod(self): - """ - Test Period - """ - model = billforward.models.period.Period() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_period_paged_metadata.py b/test/test_period_paged_metadata.py deleted file mode 100644 index 043b57f..0000000 --- a/test/test_period_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.period_paged_metadata import PeriodPagedMetadata - - -class TestPeriodPagedMetadata(unittest.TestCase): - """ PeriodPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPeriodPagedMetadata(self): - """ - Test PeriodPagedMetadata - """ - model = billforward.models.period_paged_metadata.PeriodPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_periods_api.py b/test/test_periods_api.py deleted file mode 100644 index 465a4da..0000000 --- a/test/test_periods_api.py +++ /dev/null @@ -1,62 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.periods_api import PeriodsApi - - -class TestPeriodsApi(unittest.TestCase): - """ PeriodsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.periods_api.PeriodsApi() - - def tearDown(self): - pass - - def test_get_all_periods_for_subscription(self): - """ - Test case for get_all_periods_for_subscription - - Retrieve by subscription) - """ - pass - - def test_get_latest_periods(self): - """ - Test case for get_latest_periods - - Get all periods - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_permission_action_entity.py b/test/test_permission_action_entity.py new file mode 100644 index 0000000..75ff0e7 --- /dev/null +++ b/test/test_permission_action_entity.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.permission_action_entity import PermissionActionEntity # noqa: E501 +from billforward.rest import ApiException + + +class TestPermissionActionEntity(unittest.TestCase): + """PermissionActionEntity unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPermissionActionEntity(self): + """Test PermissionActionEntity""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.permission_action_entity.PermissionActionEntity() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_permission_action_entity_paged_metadata.py b/test/test_permission_action_entity_paged_metadata.py deleted file mode 100644 index 1d6c1c2..0000000 --- a/test/test_permission_action_entity_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.permission_action_entity_paged_metadata import PermissionActionEntityPagedMetadata - - -class TestPermissionActionEntityPagedMetadata(unittest.TestCase): - """ PermissionActionEntityPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPermissionActionEntityPagedMetadata(self): - """ - Test PermissionActionEntityPagedMetadata - """ - model = billforward.models.permission_action_entity_paged_metadata.PermissionActionEntityPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_permission_resource_entity.py b/test/test_permission_resource_entity.py new file mode 100644 index 0000000..cd047fe --- /dev/null +++ b/test/test_permission_resource_entity.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.permission_resource_entity import PermissionResourceEntity # noqa: E501 +from billforward.rest import ApiException + + +class TestPermissionResourceEntity(unittest.TestCase): + """PermissionResourceEntity unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPermissionResourceEntity(self): + """Test PermissionResourceEntity""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.permission_resource_entity.PermissionResourceEntity() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_permission_resource_entity_paged_metadata.py b/test/test_permission_resource_entity_paged_metadata.py deleted file mode 100644 index c613016..0000000 --- a/test/test_permission_resource_entity_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.permission_resource_entity_paged_metadata import PermissionResourceEntityPagedMetadata - - -class TestPermissionResourceEntityPagedMetadata(unittest.TestCase): - """ PermissionResourceEntityPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPermissionResourceEntityPagedMetadata(self): - """ - Test PermissionResourceEntityPagedMetadata - """ - model = billforward.models.permission_resource_entity_paged_metadata.PermissionResourceEntityPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_permissions_api.py b/test/test_permissions_api.py index cd5ca38..b596404 100644 --- a/test/test_permissions_api.py +++ b/test/test_permissions_api.py @@ -1,91 +1,66 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.api.permissions_api import PermissionsApi # noqa: E501 from billforward.rest import ApiException -from billforward.apis.permissions_api import PermissionsApi class TestPermissionsApi(unittest.TestCase): - """ PermissionsApi unit test stubs """ + """PermissionsApi unit test stubs""" def setUp(self): - self.api = billforward.apis.permissions_api.PermissionsApi() + self.api = PermissionsApi() # noqa: E501 def tearDown(self): pass def test_create_permission(self): - """ - Test case for create_permission + """Test case for create_permission - Create a new permission. """ pass def test_get_all_permissions(self): - """ - Test case for get_all_permissions + """Test case for get_all_permissions - Retrieves a collection of all permissions. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_available_actions_for_resource(self): - """ - Test case for get_available_actions_for_resource + """Test case for get_available_actions_for_resource - Retrieves all the available actions for the specified resource. """ pass def test_get_available_resources(self): - """ - Test case for get_available_resources + """Test case for get_available_resources - Retrieves all available resource. """ pass def test_get_permission_by_id(self): - """ - Test case for get_permission_by_id + """Test case for get_permission_by_id - Retrieves a single permission, specified by the ID parameter. """ pass def test_revoke_permission(self): - """ - Test case for revoke_permission + """Test case for revoke_permission - Revokes a permission """ pass diff --git a/test/test_plan_aggregation.py b/test/test_plan_aggregation.py new file mode 100644 index 0000000..8b32995 --- /dev/null +++ b/test/test_plan_aggregation.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.plan_aggregation import PlanAggregation # noqa: E501 +from billforward.rest import ApiException + + +class TestPlanAggregation(unittest.TestCase): + """PlanAggregation unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPlanAggregation(self): + """Test PlanAggregation""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.plan_aggregation.PlanAggregation() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_plan_request.py b/test/test_plan_request.py new file mode 100644 index 0000000..92fd84e --- /dev/null +++ b/test/test_plan_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.plan_request import PlanRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestPlanRequest(unittest.TestCase): + """PlanRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPlanRequest(self): + """Test PlanRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.plan_request.PlanRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_plan_response.py b/test/test_plan_response.py new file mode 100644 index 0000000..a6c9875 --- /dev/null +++ b/test/test_plan_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.plan_response import PlanResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestPlanResponse(unittest.TestCase): + """PlanResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPlanResponse(self): + """Test PlanResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.plan_response.PlanResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_plans_api.py b/test/test_plans_api.py new file mode 100644 index 0000000..932e836 --- /dev/null +++ b/test/test_plans_api.py @@ -0,0 +1,51 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.plans_api import PlansApi # noqa: E501 +from billforward.rest import ApiException + + +class TestPlansApi(unittest.TestCase): + """PlansApi unit test stubs""" + + def setUp(self): + self.api = PlansApi() # noqa: E501 + + def tearDown(self): + pass + + def test_delete(self): + """Test case for delete + + """ + pass + + def test_find(self): + """Test case for find + + """ + pass + + def test_upsert(self): + """Test case for upsert + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_prepayment_charge.py b/test/test_prepayment_charge.py new file mode 100644 index 0000000..f4cd88d --- /dev/null +++ b/test/test_prepayment_charge.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.prepayment_charge import PrepaymentCharge # noqa: E501 +from billforward.rest import ApiException + + +class TestPrepaymentCharge(unittest.TestCase): + """PrepaymentCharge unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPrepaymentCharge(self): + """Test PrepaymentCharge""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.prepayment_charge.PrepaymentCharge() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_price_breakdown.py b/test/test_price_breakdown.py new file mode 100644 index 0000000..27de2a3 --- /dev/null +++ b/test/test_price_breakdown.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.price_breakdown import PriceBreakdown # noqa: E501 +from billforward.rest import ApiException + + +class TestPriceBreakdown(unittest.TestCase): + """PriceBreakdown unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPriceBreakdown(self): + """Test PriceBreakdown""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.price_breakdown.PriceBreakdown() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_price_calculation_paged_metadata.py b/test/test_price_calculation_paged_metadata.py deleted file mode 100644 index dd68943..0000000 --- a/test/test_price_calculation_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.price_calculation_paged_metadata import PriceCalculationPagedMetadata - - -class TestPriceCalculationPagedMetadata(unittest.TestCase): - """ PriceCalculationPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPriceCalculationPagedMetadata(self): - """ - Test PriceCalculationPagedMetadata - """ - model = billforward.models.price_calculation_paged_metadata.PriceCalculationPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_price_line.py b/test/test_price_line.py new file mode 100644 index 0000000..b58255f --- /dev/null +++ b/test/test_price_line.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.price_line import PriceLine # noqa: E501 +from billforward.rest import ApiException + + +class TestPriceLine(unittest.TestCase): + """PriceLine unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPriceLine(self): + """Test PriceLine""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.price_line.PriceLine() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pricing_component.py b/test/test_pricing_component.py index 3a08143..a162ff8 100644 --- a/test/test_pricing_component.py +++ b/test/test_pricing_component.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.pricing_component import PricingComponent # noqa: E501 from billforward.rest import ApiException -from billforward.models.pricing_component import PricingComponent class TestPricingComponent(unittest.TestCase): - """ PricingComponent unit test stubs """ + """PricingComponent unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testPricingComponent(self): - """ - Test PricingComponent - """ - model = billforward.models.pricing_component.PricingComponent() + """Test PricingComponent""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pricing_component.PricingComponent() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_pricing_component_charge.py b/test/test_pricing_component_charge.py new file mode 100644 index 0000000..a2ff3da --- /dev/null +++ b/test/test_pricing_component_charge.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.pricing_component_charge import PricingComponentCharge # noqa: E501 +from billforward.rest import ApiException + + +class TestPricingComponentCharge(unittest.TestCase): + """PricingComponentCharge unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPricingComponentCharge(self): + """Test PricingComponentCharge""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pricing_component_charge.PricingComponentCharge() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pricing_component_coupon_modifier.py b/test/test_pricing_component_coupon_modifier.py deleted file mode 100644 index 51cb549..0000000 --- a/test/test_pricing_component_coupon_modifier.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.pricing_component_coupon_modifier import PricingComponentCouponModifier - - -class TestPricingComponentCouponModifier(unittest.TestCase): - """ PricingComponentCouponModifier unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentCouponModifier(self): - """ - Test PricingComponentCouponModifier - """ - model = billforward.models.pricing_component_coupon_modifier.PricingComponentCouponModifier() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_migration_value.py b/test/test_pricing_component_migration_value.py index 079256f..912e434 100644 --- a/test/test_pricing_component_migration_value.py +++ b/test/test_pricing_component_migration_value.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.pricing_component_migration_value import PricingComponentMigrationValue # noqa: E501 from billforward.rest import ApiException -from billforward.models.pricing_component_migration_value import PricingComponentMigrationValue class TestPricingComponentMigrationValue(unittest.TestCase): - """ PricingComponentMigrationValue unit test stubs """ + """PricingComponentMigrationValue unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testPricingComponentMigrationValue(self): - """ - Test PricingComponentMigrationValue - """ - model = billforward.models.pricing_component_migration_value.PricingComponentMigrationValue() + """Test PricingComponentMigrationValue""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pricing_component_migration_value.PricingComponentMigrationValue() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_pricing_component_paged_metadata.py b/test/test_pricing_component_paged_metadata.py deleted file mode 100644 index b74c20f..0000000 --- a/test/test_pricing_component_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.pricing_component_paged_metadata import PricingComponentPagedMetadata - - -class TestPricingComponentPagedMetadata(unittest.TestCase): - """ PricingComponentPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentPagedMetadata(self): - """ - Test PricingComponentPagedMetadata - """ - model = billforward.models.pricing_component_paged_metadata.PricingComponentPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_quantity_request.py b/test/test_pricing_component_quantity_request.py deleted file mode 100644 index 3aad070..0000000 --- a/test/test_pricing_component_quantity_request.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.pricing_component_quantity_request import PricingComponentQuantityRequest - - -class TestPricingComponentQuantityRequest(unittest.TestCase): - """ PricingComponentQuantityRequest unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentQuantityRequest(self): - """ - Test PricingComponentQuantityRequest - """ - model = billforward.models.pricing_component_quantity_request.PricingComponentQuantityRequest() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_tier.py b/test/test_pricing_component_tier.py index aff33cb..da6922b 100644 --- a/test/test_pricing_component_tier.py +++ b/test/test_pricing_component_tier.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.pricing_component_tier import PricingComponentTier # noqa: E501 from billforward.rest import ApiException -from billforward.models.pricing_component_tier import PricingComponentTier class TestPricingComponentTier(unittest.TestCase): - """ PricingComponentTier unit test stubs """ + """PricingComponentTier unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testPricingComponentTier(self): - """ - Test PricingComponentTier - """ - model = billforward.models.pricing_component_tier.PricingComponentTier() + """Test PricingComponentTier""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pricing_component_tier.PricingComponentTier() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_pricing_component_tier_paged_metadata.py b/test/test_pricing_component_tier_paged_metadata.py deleted file mode 100644 index 96d903b..0000000 --- a/test/test_pricing_component_tier_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.pricing_component_tier_paged_metadata import PricingComponentTierPagedMetadata - - -class TestPricingComponentTierPagedMetadata(unittest.TestCase): - """ PricingComponentTierPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentTierPagedMetadata(self): - """ - Test PricingComponentTierPagedMetadata - """ - model = billforward.models.pricing_component_tier_paged_metadata.PricingComponentTierPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_value.py b/test/test_pricing_component_value.py index a5fe78a..edc235e 100644 --- a/test/test_pricing_component_value.py +++ b/test/test_pricing_component_value.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.pricing_component_value import PricingComponentValue # noqa: E501 from billforward.rest import ApiException -from billforward.models.pricing_component_value import PricingComponentValue class TestPricingComponentValue(unittest.TestCase): - """ PricingComponentValue unit test stubs """ + """PricingComponentValue unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testPricingComponentValue(self): - """ - Test PricingComponentValue - """ - model = billforward.models.pricing_component_value.PricingComponentValue() + """Test PricingComponentValue""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pricing_component_value.PricingComponentValue() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_pricing_component_value_amendment.py b/test/test_pricing_component_value_amendment.py new file mode 100644 index 0000000..deb03b3 --- /dev/null +++ b/test/test_pricing_component_value_amendment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.pricing_component_value_amendment import PricingComponentValueAmendment # noqa: E501 +from billforward.rest import ApiException + + +class TestPricingComponentValueAmendment(unittest.TestCase): + """PricingComponentValueAmendment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPricingComponentValueAmendment(self): + """Test PricingComponentValueAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pricing_component_value_amendment.PricingComponentValueAmendment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pricing_component_value_change.py b/test/test_pricing_component_value_change.py new file mode 100644 index 0000000..26c3637 --- /dev/null +++ b/test/test_pricing_component_value_change.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.pricing_component_value_change import PricingComponentValueChange # noqa: E501 +from billforward.rest import ApiException + + +class TestPricingComponentValueChange(unittest.TestCase): + """PricingComponentValueChange unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPricingComponentValueChange(self): + """Test PricingComponentValueChange""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pricing_component_value_change.PricingComponentValueChange() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pricing_component_value_change_amendment.py b/test/test_pricing_component_value_change_amendment.py deleted file mode 100644 index 954cb08..0000000 --- a/test/test_pricing_component_value_change_amendment.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.pricing_component_value_change_amendment import PricingComponentValueChangeAmendment - - -class TestPricingComponentValueChangeAmendment(unittest.TestCase): - """ PricingComponentValueChangeAmendment unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentValueChangeAmendment(self): - """ - Test PricingComponentValueChangeAmendment - """ - model = billforward.models.pricing_component_value_change_amendment.PricingComponentValueChangeAmendment() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_value_change_paged_metadata.py b/test/test_pricing_component_value_change_paged_metadata.py deleted file mode 100644 index 90f5d0a..0000000 --- a/test/test_pricing_component_value_change_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.pricing_component_value_change_paged_metadata import PricingComponentValueChangePagedMetadata - - -class TestPricingComponentValueChangePagedMetadata(unittest.TestCase): - """ PricingComponentValueChangePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentValueChangePagedMetadata(self): - """ - Test PricingComponentValueChangePagedMetadata - """ - model = billforward.models.pricing_component_value_change_paged_metadata.PricingComponentValueChangePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_value_migration_amendment_mapping.py b/test/test_pricing_component_value_migration_amendment_mapping.py index e073f1b..9134f84 100644 --- a/test/test_pricing_component_value_migration_amendment_mapping.py +++ b/test/test_pricing_component_value_migration_amendment_mapping.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.pricing_component_value_migration_amendment_mapping import PricingComponentValueMigrationAmendmentMapping # noqa: E501 from billforward.rest import ApiException -from billforward.models.pricing_component_value_migration_amendment_mapping import PricingComponentValueMigrationAmendmentMapping class TestPricingComponentValueMigrationAmendmentMapping(unittest.TestCase): - """ PricingComponentValueMigrationAmendmentMapping unit test stubs """ + """PricingComponentValueMigrationAmendmentMapping unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testPricingComponentValueMigrationAmendmentMapping(self): - """ - Test PricingComponentValueMigrationAmendmentMapping - """ - model = billforward.models.pricing_component_value_migration_amendment_mapping.PricingComponentValueMigrationAmendmentMapping() + """Test PricingComponentValueMigrationAmendmentMapping""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pricing_component_value_migration_amendment_mapping.PricingComponentValueMigrationAmendmentMapping() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_pricing_component_value_paged_metadata.py b/test/test_pricing_component_value_paged_metadata.py deleted file mode 100644 index 8a0a72b..0000000 --- a/test/test_pricing_component_value_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.pricing_component_value_paged_metadata import PricingComponentValuePagedMetadata - - -class TestPricingComponentValuePagedMetadata(unittest.TestCase): - """ PricingComponentValuePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentValuePagedMetadata(self): - """ - Test PricingComponentValuePagedMetadata - """ - model = billforward.models.pricing_component_value_paged_metadata.PricingComponentValuePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_value_request.py b/test/test_pricing_component_value_request.py index 4a1274e..1766757 100644 --- a/test/test_pricing_component_value_request.py +++ b/test/test_pricing_component_value_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.pricing_component_value_request import PricingComponentValueRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.pricing_component_value_request import PricingComponentValueRequest class TestPricingComponentValueRequest(unittest.TestCase): - """ PricingComponentValueRequest unit test stubs """ + """PricingComponentValueRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testPricingComponentValueRequest(self): - """ - Test PricingComponentValueRequest - """ - model = billforward.models.pricing_component_value_request.PricingComponentValueRequest() + """Test PricingComponentValueRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pricing_component_value_request.PricingComponentValueRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_pricing_component_value_response.py b/test/test_pricing_component_value_response.py new file mode 100644 index 0000000..e3725bb --- /dev/null +++ b/test/test_pricing_component_value_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.pricing_component_value_response import PricingComponentValueResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestPricingComponentValueResponse(unittest.TestCase): + """PricingComponentValueResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPricingComponentValueResponse(self): + """Test PricingComponentValueResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pricing_component_value_response.PricingComponentValueResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pricing_component_value_response_paged_metadata.py b/test/test_pricing_component_value_response_paged_metadata.py deleted file mode 100644 index a248ae5..0000000 --- a/test/test_pricing_component_value_response_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.pricing_component_value_response_paged_metadata import PricingComponentValueResponsePagedMetadata - - -class TestPricingComponentValueResponsePagedMetadata(unittest.TestCase): - """ PricingComponentValueResponsePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentValueResponsePagedMetadata(self): - """ - Test PricingComponentValueResponsePagedMetadata - """ - model = billforward.models.pricing_component_value_response_paged_metadata.PricingComponentValueResponsePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_components_by_charge_type.py b/test/test_pricing_components_by_charge_type.py new file mode 100644 index 0000000..5630423 --- /dev/null +++ b/test/test_pricing_components_by_charge_type.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.pricing_components_by_charge_type import PricingComponentsByChargeType # noqa: E501 +from billforward.rest import ApiException + + +class TestPricingComponentsByChargeType(unittest.TestCase): + """PricingComponentsByChargeType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPricingComponentsByChargeType(self): + """Test PricingComponentsByChargeType""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pricing_components_by_charge_type.PricingComponentsByChargeType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pricing_tier.py b/test/test_pricing_tier.py new file mode 100644 index 0000000..c769712 --- /dev/null +++ b/test/test_pricing_tier.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.pricing_tier import PricingTier # noqa: E501 +from billforward.rest import ApiException + + +class TestPricingTier(unittest.TestCase): + """PricingTier unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPricingTier(self): + """Test PricingTier""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.pricing_tier.PricingTier() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pricingcalculator_api.py b/test/test_pricingcalculator_api.py deleted file mode 100644 index 8b13d0d..0000000 --- a/test/test_pricingcalculator_api.py +++ /dev/null @@ -1,70 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.pricingcalculator_api import PricingcalculatorApi - - -class TestPricingcalculatorApi(unittest.TestCase): - """ PricingcalculatorApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.pricingcalculator_api.PricingcalculatorApi() - - def tearDown(self): - pass - - def test_get_amendment_cost(self): - """ - Test case for get_amendment_cost - - Calculates the price of a subscription's upgrading/downgrading to a new pricing component value. - """ - pass - - def test_get_coupon_instance_initialisation_cost(self): - """ - Test case for get_coupon_instance_initialisation_cost - - Calculates the price of a subscription to a rate plan, at specified values of pricing component values, and with the specified coupon applied. - """ - pass - - def test_get_product_rate_plan_costs(self): - """ - Test case for get_product_rate_plan_costs - - Calculates the price of a subscription to a rate plan, at specified values of pricing component values. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricingcomponents_api.py b/test/test_pricingcomponents_api.py deleted file mode 100644 index 1208fdf..0000000 --- a/test/test_pricingcomponents_api.py +++ /dev/null @@ -1,94 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.pricingcomponents_api import PricingcomponentsApi - - -class TestPricingcomponentsApi(unittest.TestCase): - """ PricingcomponentsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.pricingcomponents_api.PricingcomponentsApi() - - def tearDown(self): - pass - - def test_create_pricing_component(self): - """ - Test case for create_pricing_component - - Create a pricing-component. - """ - pass - - def test_get_all_pricing_components(self): - """ - Test case for get_all_pricing_components - - Returns a collection of pricing-components. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_pricing_component(self): - """ - Test case for get_pricing_component - - Returns a collection of pricing-components, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_pricing_component_by_product_rate_plan_id(self): - """ - Test case for get_pricing_component_by_product_rate_plan_id - - Returns a collection of pricing-components, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_retire_pricing_component(self): - """ - Test case for retire_pricing_component - - Retires the pricing-component specified by the pricing-component-ID parameter. - """ - pass - - def test_update_pricing_component(self): - """ - Test case for update_pricing_component - - Update a pricing-component. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricingcomponenttiers_api.py b/test/test_pricingcomponenttiers_api.py deleted file mode 100644 index 25912c4..0000000 --- a/test/test_pricingcomponenttiers_api.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.pricingcomponenttiers_api import PricingcomponenttiersApi - - -class TestPricingcomponenttiersApi(unittest.TestCase): - """ PricingcomponenttiersApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.pricingcomponenttiers_api.PricingcomponenttiersApi() - - def tearDown(self): - pass - - def test_create_pricing_component_tier(self): - """ - Test case for create_pricing_component_tier - - Create - """ - pass - - def test_get_all_pricing_component_tiers(self): - """ - Test case for get_all_pricing_component_tiers - - Returns a collection of pricing-component-tier-tiers. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_pricing_component_tier(self): - """ - Test case for get_pricing_component_tier - - Returns a collection of pricing-component-tier-tiers, specified by the pricing-component-tier-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_pricing_component_tier_by_product_rate_plan_id(self): - """ - Test case for get_pricing_component_tier_by_product_rate_plan_id - - Returns a collection of pricing-component-tier-tiers, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_update_pricing_component_tier(self): - """ - Test case for update_pricing_component_tier - - Update. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricingcomponentvaluechanges_api.py b/test/test_pricingcomponentvaluechanges_api.py deleted file mode 100644 index 1e29424..0000000 --- a/test/test_pricingcomponentvaluechanges_api.py +++ /dev/null @@ -1,94 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.pricingcomponentvaluechanges_api import PricingcomponentvaluechangesApi - - -class TestPricingcomponentvaluechangesApi(unittest.TestCase): - """ PricingcomponentvaluechangesApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.pricingcomponentvaluechanges_api.PricingcomponentvaluechangesApi() - - def tearDown(self): - pass - - def test_create_pricing_component_value_change(self): - """ - Test case for create_pricing_component_value_change - - Create a pricing-component-value-change. - """ - pass - - def test_get_all_pricing_component_value_changes(self): - """ - Test case for get_all_pricing_component_value_changes - - Returns a collection of pricing-component-value-changes. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_pricing_component_value_change(self): - """ - Test case for get_pricing_component_value_change - - Returns a single pricing-component-value-changes, specified by the ID parameter. - """ - pass - - def test_get_pricing_component_value_change_by_component_id(self): - """ - Test case for get_pricing_component_value_change_by_component_id - - Returns a collection of pricing-component-value-changes, specified by the pricing-component-value-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_pricing_component_value_change_by_invoice_id(self): - """ - Test case for get_pricing_component_value_change_by_invoice_id - - Returns a collection of pricing-component-value-changes, specified by the invoice-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_pricing_component_value_change_by_subscription_id(self): - """ - Test case for get_pricing_component_value_change_by_subscription_id - - Returns a collection of pricing-component-value-changes, specified by the subscription-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricingcomponentvalues_api.py b/test/test_pricingcomponentvalues_api.py deleted file mode 100644 index 04bb59c..0000000 --- a/test/test_pricingcomponentvalues_api.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.pricingcomponentvalues_api import PricingcomponentvaluesApi - - -class TestPricingcomponentvaluesApi(unittest.TestCase): - """ PricingcomponentvaluesApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.pricingcomponentvalues_api.PricingcomponentvaluesApi() - - def tearDown(self): - pass - - def test_create_pricing_component_value(self): - """ - Test case for create_pricing_component_value - - Create a pricing-component-value. - """ - pass - - def test_get_all_pricing_component_values(self): - """ - Test case for get_all_pricing_component_values - - Returns a collection of pricing-component-values.By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_pricing_component_value(self): - """ - Test case for get_pricing_component_value - - Returns a collection of pricing-component-values, specified by the pricing-component-ID parameter.By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_pricing_component_value_by_subscription_id(self): - """ - Test case for get_pricing_component_value_by_subscription_id - - Returns a collection of pricing-component-values, specified by the subscription-ID parameter.By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_update_pricing_component_value(self): - """ - Test case for update_pricing_component_value - - Update a pricing-component-value. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_product.py b/test/test_product.py deleted file mode 100644 index 0384a97..0000000 --- a/test/test_product.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.product import Product - - -class TestProduct(unittest.TestCase): - """ Product unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testProduct(self): - """ - Test Product - """ - model = billforward.models.product.Product() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_product_coupon_modifier.py b/test/test_product_coupon_modifier.py deleted file mode 100644 index 288fe34..0000000 --- a/test/test_product_coupon_modifier.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.product_coupon_modifier import ProductCouponModifier - - -class TestProductCouponModifier(unittest.TestCase): - """ ProductCouponModifier unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testProductCouponModifier(self): - """ - Test ProductCouponModifier - """ - model = billforward.models.product_coupon_modifier.ProductCouponModifier() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_product_paged_metadata.py b/test/test_product_paged_metadata.py deleted file mode 100644 index 951a68c..0000000 --- a/test/test_product_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.product_paged_metadata import ProductPagedMetadata - - -class TestProductPagedMetadata(unittest.TestCase): - """ ProductPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testProductPagedMetadata(self): - """ - Test ProductPagedMetadata - """ - model = billforward.models.product_paged_metadata.ProductPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_product_payments_result_paged_metadata.py b/test/test_product_payments_result_paged_metadata.py deleted file mode 100644 index b9d341f..0000000 --- a/test/test_product_payments_result_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.product_payments_result_paged_metadata import ProductPaymentsResultPagedMetadata - - -class TestProductPaymentsResultPagedMetadata(unittest.TestCase): - """ ProductPaymentsResultPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testProductPaymentsResultPagedMetadata(self): - """ - Test ProductPaymentsResultPagedMetadata - """ - model = billforward.models.product_payments_result_paged_metadata.ProductPaymentsResultPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_product_rate_plan.py b/test/test_product_rate_plan.py deleted file mode 100644 index c0830eb..0000000 --- a/test/test_product_rate_plan.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.product_rate_plan import ProductRatePlan - - -class TestProductRatePlan(unittest.TestCase): - """ ProductRatePlan unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testProductRatePlan(self): - """ - Test ProductRatePlan - """ - model = billforward.models.product_rate_plan.ProductRatePlan() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_product_rate_plan_migration_amendment.py b/test/test_product_rate_plan_migration_amendment.py index 7b7c1cf..50d8347 100644 --- a/test/test_product_rate_plan_migration_amendment.py +++ b/test/test_product_rate_plan_migration_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.product_rate_plan_migration_amendment import ProductRatePlanMigrationAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.product_rate_plan_migration_amendment import ProductRatePlanMigrationAmendment class TestProductRatePlanMigrationAmendment(unittest.TestCase): - """ ProductRatePlanMigrationAmendment unit test stubs """ + """ProductRatePlanMigrationAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testProductRatePlanMigrationAmendment(self): - """ - Test ProductRatePlanMigrationAmendment - """ - model = billforward.models.product_rate_plan_migration_amendment.ProductRatePlanMigrationAmendment() + """Test ProductRatePlanMigrationAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.product_rate_plan_migration_amendment.ProductRatePlanMigrationAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_product_rate_plan_migration_charge.py b/test/test_product_rate_plan_migration_charge.py new file mode 100644 index 0000000..dbe525d --- /dev/null +++ b/test/test_product_rate_plan_migration_charge.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.product_rate_plan_migration_charge import ProductRatePlanMigrationCharge # noqa: E501 +from billforward.rest import ApiException + + +class TestProductRatePlanMigrationCharge(unittest.TestCase): + """ProductRatePlanMigrationCharge unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testProductRatePlanMigrationCharge(self): + """Test ProductRatePlanMigrationCharge""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.product_rate_plan_migration_charge.ProductRatePlanMigrationCharge() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_product_rate_plan_paged_metadata.py b/test/test_product_rate_plan_paged_metadata.py deleted file mode 100644 index f320c71..0000000 --- a/test/test_product_rate_plan_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.product_rate_plan_paged_metadata import ProductRatePlanPagedMetadata - - -class TestProductRatePlanPagedMetadata(unittest.TestCase): - """ ProductRatePlanPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testProductRatePlanPagedMetadata(self): - """ - Test ProductRatePlanPagedMetadata - """ - model = billforward.models.product_rate_plan_paged_metadata.ProductRatePlanPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_product_rate_plan_payments_result_paged_metadata.py b/test/test_product_rate_plan_payments_result_paged_metadata.py deleted file mode 100644 index 0df4383..0000000 --- a/test/test_product_rate_plan_payments_result_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.product_rate_plan_payments_result_paged_metadata import ProductRatePlanPaymentsResultPagedMetadata - - -class TestProductRatePlanPaymentsResultPagedMetadata(unittest.TestCase): - """ ProductRatePlanPaymentsResultPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testProductRatePlanPaymentsResultPagedMetadata(self): - """ - Test ProductRatePlanPaymentsResultPagedMetadata - """ - model = billforward.models.product_rate_plan_payments_result_paged_metadata.ProductRatePlanPaymentsResultPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_productrateplans_api.py b/test/test_productrateplans_api.py deleted file mode 100644 index 73ff309..0000000 --- a/test/test_productrateplans_api.py +++ /dev/null @@ -1,158 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.productrateplans_api import ProductrateplansApi - - -class TestProductrateplansApi(unittest.TestCase): - """ ProductrateplansApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.productrateplans_api.ProductrateplansApi() - - def tearDown(self): - pass - - def test_add_taxation_strategy_to_rate_plan(self): - """ - Test case for add_taxation_strategy_to_rate_plan - - Adds or re-enables the specified taxation-strategy for the given product-rate-plan. - """ - pass - - def test_create_rate_plan(self): - """ - Test case for create_rate_plan - - Create a new rate-plan. - """ - pass - - def test_delete_metadata_for_rate_plan(self): - """ - Test case for delete_metadata_for_rate_plan - - Remove any associated metadata. - """ - pass - - def test_get_all_rate_plans(self): - """ - Test case for get_all_rate_plans - - Returns a collection of product-rate-plans. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_available_taxation_strategies_for_rate_plan(self): - """ - Test case for get_available_taxation_strategies_for_rate_plan - - Returns all available taxes for the specified product-rate-plan. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_metadata_for_rate_plan(self): - """ - Test case for get_metadata_for_rate_plan - - Retrieve any associated metadata. - """ - pass - - def test_get_product_rate_plan_by_id(self): - """ - Test case for get_product_rate_plan_by_id - - Returns product-rate-plans, specified by the product-rate-plan id or name. - """ - pass - - def test_get_rate_plan_by_product(self): - """ - Test case for get_rate_plan_by_product - - Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_rate_plan_by_product_and_rate_plan(self): - """ - Test case for get_rate_plan_by_product_and_rate_plan - - Returns a collection of product-rate-plans, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_remove_taxation_strategy_from_rate_plan(self): - """ - Test case for remove_taxation_strategy_from_rate_plan - - Removes the specified taxation-strategy for the given product-rate-plan. - """ - pass - - def test_retire_rate_plan(self): - """ - Test case for retire_rate_plan - - Retires the product-rate-plan specified product-rate-plan-ID. - """ - pass - - def test_set_metadata_for_rate_plan(self): - """ - Test case for set_metadata_for_rate_plan - - Remove any existing metadata keys and create the provided data. - """ - pass - - def test_update_rate_plan(self): - """ - Test case for update_rate_plan - - Update a rate-plan. - """ - pass - - def test_upsert_metadata_for_rate_plan(self): - """ - Test case for upsert_metadata_for_rate_plan - - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_products_api.py b/test/test_products_api.py deleted file mode 100644 index 938dbf9..0000000 --- a/test/test_products_api.py +++ /dev/null @@ -1,118 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.products_api import ProductsApi - - -class TestProductsApi(unittest.TestCase): - """ ProductsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.products_api.ProductsApi() - - def tearDown(self): - pass - - def test_create_product(self): - """ - Test case for create_product - - Create a product. - """ - pass - - def test_delete_metadata_for_product(self): - """ - Test case for delete_metadata_for_product - - Remove any associated metadata. - """ - pass - - def test_get_all_products(self): - """ - Test case for get_all_products - - Returns a collection of products. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_metadata_for_product(self): - """ - Test case for get_metadata_for_product - - Retrieve any associated metadata. - """ - pass - - def test_get_product_by_id(self): - """ - Test case for get_product_by_id - - Returns a single product, specified by the product-ID parameter. - """ - pass - - def test_retire_product(self): - """ - Test case for retire_product - - Deletes the product specified by the product-ID parameter. Any existing subscriptions will continue; it is a soft delete. - """ - pass - - def test_set_metadata_for_product(self): - """ - Test case for set_metadata_for_product - - Remove any existing metadata keys and create the provided data. - """ - pass - - def test_update_product(self): - """ - Test case for update_product - - Update a product. - """ - pass - - def test_upsert_metadata_for_product(self): - """ - Test case for upsert_metadata_for_product - - Update any existing metadata key-values and insert any new key-values, no keys will be removed. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_profile.py b/test/test_profile.py index 914f49f..ced4948 100644 --- a/test/test_profile.py +++ b/test/test_profile.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.profile import Profile # noqa: E501 from billforward.rest import ApiException -from billforward.models.profile import Profile class TestProfile(unittest.TestCase): - """ Profile unit test stubs """ + """Profile unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testProfile(self): - """ - Test Profile - """ - model = billforward.models.profile.Profile() + """Test Profile""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.profile.Profile() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_profile_paged_metadata.py b/test/test_profile_paged_metadata.py deleted file mode 100644 index 0df6a99..0000000 --- a/test/test_profile_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.profile_paged_metadata import ProfilePagedMetadata - - -class TestProfilePagedMetadata(unittest.TestCase): - """ ProfilePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testProfilePagedMetadata(self): - """ - Test ProfilePagedMetadata - """ - model = billforward.models.profile_paged_metadata.ProfilePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_profiles_api.py b/test/test_profiles_api.py deleted file mode 100644 index da6c524..0000000 --- a/test/test_profiles_api.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.profiles_api import ProfilesApi - - -class TestProfilesApi(unittest.TestCase): - """ ProfilesApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.profiles_api.ProfilesApi() - - def tearDown(self): - pass - - def test_get_all_profiles(self): - """ - Test case for get_all_profiles - - Returns a collection of all profiles. By default 10 values are returned. Records are returned in natural order - """ - pass - - def test_get_profile(self): - """ - Test case for get_profile - - Returns a single profile, specified by the ID parameter. - """ - pass - - def test_get_profile_by_account_id(self): - """ - Test case for get_profile_by_account_id - - Returns a collection of profiles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order - """ - pass - - def test_get_profile_by_email_address(self): - """ - Test case for get_profile_by_email_address - - Returns a single profile, specified by the email parameter. - """ - pass - - def test_update_profile(self): - """ - Test case for update_profile - - Update a profile - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_public_configuration_response.py b/test/test_public_configuration_response.py new file mode 100644 index 0000000..9131d18 --- /dev/null +++ b/test/test_public_configuration_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.public_configuration_response import PublicConfigurationResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestPublicConfigurationResponse(unittest.TestCase): + """PublicConfigurationResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPublicConfigurationResponse(self): + """Test PublicConfigurationResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.public_configuration_response.PublicConfigurationResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_quote_request.py b/test/test_quote_request.py index 28ce58c..1ba4cd6 100644 --- a/test/test_quote_request.py +++ b/test/test_quote_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.quote_request import QuoteRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.quote_request import QuoteRequest class TestQuoteRequest(unittest.TestCase): - """ QuoteRequest unit test stubs """ + """QuoteRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testQuoteRequest(self): - """ - Test QuoteRequest - """ - model = billforward.models.quote_request.QuoteRequest() + """Test QuoteRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.quote_request.QuoteRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_quote_request_value.py b/test/test_quote_request_value.py index b7b7bc5..cfc21a1 100644 --- a/test/test_quote_request_value.py +++ b/test/test_quote_request_value.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.quote_request_value import QuoteRequestValue # noqa: E501 from billforward.rest import ApiException -from billforward.models.quote_request_value import QuoteRequestValue class TestQuoteRequestValue(unittest.TestCase): - """ QuoteRequestValue unit test stubs """ + """QuoteRequestValue unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testQuoteRequestValue(self): - """ - Test QuoteRequestValue - """ - model = billforward.models.quote_request_value.QuoteRequestValue() + """Test QuoteRequestValue""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.quote_request_value.QuoteRequestValue() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_quotes_api.py b/test/test_quotes_api.py index a81013e..f466701 100644 --- a/test/test_quotes_api.py +++ b/test/test_quotes_api.py @@ -1,51 +1,48 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.api.quotes_api import QuotesApi # noqa: E501 from billforward.rest import ApiException -from billforward.apis.quotes_api import QuotesApi class TestQuotesApi(unittest.TestCase): - """ QuotesApi unit test stubs """ + """QuotesApi unit test stubs""" def setUp(self): - self.api = billforward.apis.quotes_api.QuotesApi() + self.api = QuotesApi() # noqa: E501 def tearDown(self): pass - def test_quote(self): + def test_get_all_quotes(self): + """Test case for get_all_quotes + + """ + pass + + def test_get_quote_by_id(self): + """Test case for get_quote_by_id + """ - Test case for quote + pass + + def test_quote(self): + """Test case for quote - Returns a quote. """ pass diff --git a/test/test_recalculate_charge_batch_request.py b/test/test_recalculate_charge_batch_request.py new file mode 100644 index 0000000..d445438 --- /dev/null +++ b/test/test_recalculate_charge_batch_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.recalculate_charge_batch_request import RecalculateChargeBatchRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestRecalculateChargeBatchRequest(unittest.TestCase): + """RecalculateChargeBatchRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testRecalculateChargeBatchRequest(self): + """Test RecalculateChargeBatchRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.recalculate_charge_batch_request.RecalculateChargeBatchRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_recalculate_charge_batch_response.py b/test/test_recalculate_charge_batch_response.py new file mode 100644 index 0000000..2cee164 --- /dev/null +++ b/test/test_recalculate_charge_batch_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.recalculate_charge_batch_response import RecalculateChargeBatchResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestRecalculateChargeBatchResponse(unittest.TestCase): + """RecalculateChargeBatchResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testRecalculateChargeBatchResponse(self): + """Test RecalculateChargeBatchResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.recalculate_charge_batch_response.RecalculateChargeBatchResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_recalculate_charge_request.py b/test/test_recalculate_charge_request.py index 82b56fb..0bb16fd 100644 --- a/test/test_recalculate_charge_request.py +++ b/test/test_recalculate_charge_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.recalculate_charge_request import RecalculateChargeRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.recalculate_charge_request import RecalculateChargeRequest class TestRecalculateChargeRequest(unittest.TestCase): - """ RecalculateChargeRequest unit test stubs """ + """RecalculateChargeRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testRecalculateChargeRequest(self): - """ - Test RecalculateChargeRequest - """ - model = billforward.models.recalculate_charge_request.RecalculateChargeRequest() + """Test RecalculateChargeRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.recalculate_charge_request.RecalculateChargeRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_receipt.py b/test/test_receipt.py index 1701caa..2965e02 100644 --- a/test/test_receipt.py +++ b/test/test_receipt.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.receipt import Receipt # noqa: E501 from billforward.rest import ApiException -from billforward.models.receipt import Receipt class TestReceipt(unittest.TestCase): - """ Receipt unit test stubs """ + """Receipt unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testReceipt(self): - """ - Test Receipt - """ - model = billforward.models.receipt.Receipt() + """Test Receipt""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.receipt.Receipt() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_receipt_paged_metadata.py b/test/test_receipt_paged_metadata.py deleted file mode 100644 index 17c9822..0000000 --- a/test/test_receipt_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.receipt_paged_metadata import ReceiptPagedMetadata - - -class TestReceiptPagedMetadata(unittest.TestCase): - """ ReceiptPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testReceiptPagedMetadata(self): - """ - Test ReceiptPagedMetadata - """ - model = billforward.models.receipt_paged_metadata.ReceiptPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_receipts_api.py b/test/test_receipts_api.py index 9d3b784..2332cda 100644 --- a/test/test_receipts_api.py +++ b/test/test_receipts_api.py @@ -1,99 +1,72 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.api.receipts_api import ReceiptsApi # noqa: E501 from billforward.rest import ApiException -from billforward.apis.receipts_api import ReceiptsApi class TestReceiptsApi(unittest.TestCase): - """ ReceiptsApi unit test stubs """ + """ReceiptsApi unit test stubs""" def setUp(self): - self.api = billforward.apis.receipts_api.ReceiptsApi() + self.api = ReceiptsApi() # noqa: E501 def tearDown(self): pass def test_create_receipt(self): - """ - Test case for create_receipt + """Test case for create_receipt - Create a receipt. """ pass def test_get_all_receipts(self): - """ - Test case for get_all_receipts + """Test case for get_all_receipts - Returns a collection of all receipts. By default 10 values are returned. receipts are returned in natural order """ pass def test_get_receipt_by_id(self): - """ - Test case for get_receipt_by_id + """Test case for get_receipt_by_id - Returns a single receipt, specified by the ID parameter. """ pass def test_get_receipts_by_invoice(self): - """ - Test case for get_receipts_by_invoice + """Test case for get_receipts_by_invoice - Returns a receipt for the receipt payment. """ pass def test_get_receipts_by_payment(self): - """ - Test case for get_receipts_by_payment + """Test case for get_receipts_by_payment - Returns a collection of receipts for the payment. """ pass def test_get_receipts_for_debit_payments_as_csv(self): - """ - Test case for get_receipts_for_debit_payments_as_csv + """Test case for get_receipts_for_debit_payments_as_csv - Retrieves debit payments in CSV format. """ pass def test_get_receipts_for_refund_payments_as_csv(self): - """ - Test case for get_receipts_for_refund_payments_as_csv + """Test case for get_receipts_for_refund_payments_as_csv - Retrieves refunded payments in CSV format. """ pass diff --git a/test/test_refund.py b/test/test_refund.py index 7aa63dc..3db92b5 100644 --- a/test/test_refund.py +++ b/test/test_refund.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.refund import Refund # noqa: E501 from billforward.rest import ApiException -from billforward.models.refund import Refund class TestRefund(unittest.TestCase): - """ Refund unit test stubs """ + """Refund unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testRefund(self): - """ - Test Refund - """ - model = billforward.models.refund.Refund() + """Test Refund""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.refund.Refund() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_refund_accounting_view.py b/test/test_refund_accounting_view.py new file mode 100644 index 0000000..d29ecf0 --- /dev/null +++ b/test/test_refund_accounting_view.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.refund_accounting_view import RefundAccountingView # noqa: E501 +from billforward.rest import ApiException + + +class TestRefundAccountingView(unittest.TestCase): + """RefundAccountingView unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testRefundAccountingView(self): + """Test RefundAccountingView""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.refund_accounting_view.RefundAccountingView() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_refund_paged_metadata.py b/test/test_refund_paged_metadata.py deleted file mode 100644 index 4f87cf6..0000000 --- a/test/test_refund_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.refund_paged_metadata import RefundPagedMetadata - - -class TestRefundPagedMetadata(unittest.TestCase): - """ RefundPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testRefundPagedMetadata(self): - """ - Test RefundPagedMetadata - """ - model = billforward.models.refund_paged_metadata.RefundPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_refunds_api.py b/test/test_refunds_api.py deleted file mode 100644 index 654a991..0000000 --- a/test/test_refunds_api.py +++ /dev/null @@ -1,110 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.refunds_api import RefundsApi - - -class TestRefundsApi(unittest.TestCase): - """ RefundsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.refunds_api.RefundsApi() - - def tearDown(self): - pass - - def test_create_refund(self): - """ - Test case for create_refund - -

When creating a refund either the invoice, or invoice payment must be specified.

Creating a refund by specifying the invoiceID will refund any un-refunded value up to the full value of the payment. When refunding via the invoicePaymentID the same rules apply. Refunds will be processed by the same payment methods that took the payment.

Refunds can be for a partial amount of the payment. It is possible to create refunds up to the value of the total payment.

Once a payment or invoice is fully refunded, no more refunds can be created. Errors will be returned if the payment is greater than available refund funds.

- """ - pass - - def test_get_all_refunds(self): - """ - Test case for get_all_refunds - - Returns a collection of all refunds. By default 10 values are returned. Refunds are returned in natural order - """ - pass - - def test_get_refund_by_id(self): - """ - Test case for get_refund_by_id - - Returns a single refund, specified by the ID parameter. - """ - pass - - def test_get_refund_for_original_payment(self): - """ - Test case for get_refund_for_original_payment - - Returns a refund for the original payment. - """ - pass - - def test_get_refund_for_refund_payment(self): - """ - Test case for get_refund_for_refund_payment - - Returns a refund for the refund payment. - """ - pass - - def test_get_refund_for_refunded_invoice(self): - """ - Test case for get_refund_for_refunded_invoice - - Returns a refund for the refund payment. - """ - pass - - def test_get_refunds_as_csv(self): - """ - Test case for get_refunds_as_csv - - Retrieves refunds in CSV format. - """ - pass - - def test_update_refund(self): - """ - Test case for update_refund - - Update a refund - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_remove_credit_account_request.py b/test/test_remove_credit_account_request.py new file mode 100644 index 0000000..a382533 --- /dev/null +++ b/test/test_remove_credit_account_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.remove_credit_account_request import RemoveCreditAccountRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestRemoveCreditAccountRequest(unittest.TestCase): + """RemoveCreditAccountRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testRemoveCreditAccountRequest(self): + """Test RemoveCreditAccountRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.remove_credit_account_request.RemoveCreditAccountRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_reports_api.py b/test/test_reports_api.py new file mode 100644 index 0000000..18c89dd --- /dev/null +++ b/test/test_reports_api.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.reports_api import ReportsApi # noqa: E501 +from billforward.rest import ApiException + + +class TestReportsApi(unittest.TestCase): + """ReportsApi unit test stubs""" + + def setUp(self): + self.api = ReportsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_get_accounts_overview(self): + """Test case for get_accounts_overview + + """ + pass + + def test_get_affiliate_charge_report(self): + """Test case for get_affiliate_charge_report + + """ + pass + + def test_get_coupon_report(self): + """Test case for get_coupon_report + + """ + pass + + def test_get_csv_report_invoice_line_payments_bucketed(self): + """Test case for get_csv_report_invoice_line_payments_bucketed + + """ + pass + + def test_get_csv_report_invoice_line_payments_raw(self): + """Test case for get_csv_report_invoice_line_payments_raw + + """ + pass + + def test_get_csv_report_revenue_attributions_bucketed(self): + """Test case for get_csv_report_revenue_attributions_bucketed + + """ + pass + + def test_get_csv_report_revenue_attributions_raw(self): + """Test case for get_csv_report_revenue_attributions_raw + + """ + pass + + def test_get_csv_revenue_schedule(self): + """Test case for get_csv_revenue_schedule + + """ + pass + + def test_get_payment_transactions(self): + """Test case for get_payment_transactions + + """ + pass + + def test_get_refunds_as_csv(self): + """Test case for get_refunds_as_csv + + """ + pass + + def test_get_shipments_report(self): + """Test case for get_shipments_report + + """ + pass + + def test_get_subscriptions_overview(self): + """Test case for get_subscriptions_overview + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_resume_request.py b/test/test_resume_request.py index 472ee89..b7cf0cb 100644 --- a/test/test_resume_request.py +++ b/test/test_resume_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.resume_request import ResumeRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.resume_request import ResumeRequest class TestResumeRequest(unittest.TestCase): - """ ResumeRequest unit test stubs """ + """ResumeRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testResumeRequest(self): - """ - Test ResumeRequest - """ - model = billforward.models.resume_request.ResumeRequest() + """Test ResumeRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.resume_request.ResumeRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_resume_subscription_amendment.py b/test/test_resume_subscription_amendment.py index b409dd5..efc5497 100644 --- a/test/test_resume_subscription_amendment.py +++ b/test/test_resume_subscription_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.resume_subscription_amendment import ResumeSubscriptionAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.resume_subscription_amendment import ResumeSubscriptionAmendment class TestResumeSubscriptionAmendment(unittest.TestCase): - """ ResumeSubscriptionAmendment unit test stubs """ + """ResumeSubscriptionAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testResumeSubscriptionAmendment(self): - """ - Test ResumeSubscriptionAmendment - """ - model = billforward.models.resume_subscription_amendment.ResumeSubscriptionAmendment() + """Test ResumeSubscriptionAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.resume_subscription_amendment.ResumeSubscriptionAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_revenue_attribution.py b/test/test_revenue_attribution.py deleted file mode 100644 index a689fa0..0000000 --- a/test/test_revenue_attribution.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.revenue_attribution import RevenueAttribution - - -class TestRevenueAttribution(unittest.TestCase): - """ RevenueAttribution unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testRevenueAttribution(self): - """ - Test RevenueAttribution - """ - model = billforward.models.revenue_attribution.RevenueAttribution() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_revenue_attribution_paged_metadata.py b/test/test_revenue_attribution_paged_metadata.py deleted file mode 100644 index e6c92e3..0000000 --- a/test/test_revenue_attribution_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.revenue_attribution_paged_metadata import RevenueAttributionPagedMetadata - - -class TestRevenueAttributionPagedMetadata(unittest.TestCase): - """ RevenueAttributionPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testRevenueAttributionPagedMetadata(self): - """ - Test RevenueAttributionPagedMetadata - """ - model = billforward.models.revenue_attribution_paged_metadata.RevenueAttributionPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_revenue_attributions.py b/test/test_revenue_attributions.py new file mode 100644 index 0000000..985abe5 --- /dev/null +++ b/test/test_revenue_attributions.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.revenue_attributions import RevenueAttributions # noqa: E501 +from billforward.rest import ApiException + + +class TestRevenueAttributions(unittest.TestCase): + """RevenueAttributions unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testRevenueAttributions(self): + """Test RevenueAttributions""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.revenue_attributions.RevenueAttributions() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_revive_subscription_request.py b/test/test_revive_subscription_request.py deleted file mode 100644 index 00df875..0000000 --- a/test/test_revive_subscription_request.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.revive_subscription_request import ReviveSubscriptionRequest - - -class TestReviveSubscriptionRequest(unittest.TestCase): - """ ReviveSubscriptionRequest unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testReviveSubscriptionRequest(self): - """ - Test ReviveSubscriptionRequest - """ - model = billforward.models.revive_subscription_request.ReviveSubscriptionRequest() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_role.py b/test/test_role.py index 8796177..ac46b25 100644 --- a/test/test_role.py +++ b/test/test_role.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.role import Role # noqa: E501 from billforward.rest import ApiException -from billforward.models.role import Role class TestRole(unittest.TestCase): - """ Role unit test stubs """ + """Role unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testRole(self): - """ - Test Role - """ - model = billforward.models.role.Role() + """Test Role""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.role.Role() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_role_paged_metadata.py b/test/test_role_paged_metadata.py deleted file mode 100644 index 9e102fa..0000000 --- a/test/test_role_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.role_paged_metadata import RolePagedMetadata - - -class TestRolePagedMetadata(unittest.TestCase): - """ RolePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testRolePagedMetadata(self): - """ - Test RolePagedMetadata - """ - model = billforward.models.role_paged_metadata.RolePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_roles_api.py b/test/test_roles_api.py deleted file mode 100644 index 0f3ac02..0000000 --- a/test/test_roles_api.py +++ /dev/null @@ -1,94 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.roles_api import RolesApi - - -class TestRolesApi(unittest.TestCase): - """ RolesApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.roles_api.RolesApi() - - def tearDown(self): - pass - - def test_create_role(self): - """ - Test case for create_role - - Create a new role. - """ - pass - - def test_get_all_roles(self): - """ - Test case for get_all_roles - - Retrieves a collection of all roles. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_role_by_id(self): - """ - Test case for get_role_by_id - - Retrieves a single role, specified by the ID parameter. - """ - pass - - def test_remove_permission_from_role(self): - """ - Test case for remove_permission_from_role - - Revokes a particular permission - """ - pass - - def test_revoke_role(self): - """ - Test case for revoke_role - - Revokes a role - """ - pass - - def test_update_role(self): - """ - Test case for update_role - - Update a role. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_rule_satisfaction.py b/test/test_rule_satisfaction.py deleted file mode 100644 index 0b275a5..0000000 --- a/test/test_rule_satisfaction.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.rule_satisfaction import RuleSatisfaction - - -class TestRuleSatisfaction(unittest.TestCase): - """ RuleSatisfaction unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testRuleSatisfaction(self): - """ - Test RuleSatisfaction - """ - model = billforward.models.rule_satisfaction.RuleSatisfaction() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_sage_pay_auth_capture_request.py b/test/test_sage_pay_auth_capture_request.py new file mode 100644 index 0000000..d5f1265 --- /dev/null +++ b/test/test_sage_pay_auth_capture_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.sage_pay_auth_capture_request import SagePayAuthCaptureRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestSagePayAuthCaptureRequest(unittest.TestCase): + """SagePayAuthCaptureRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSagePayAuthCaptureRequest(self): + """Test SagePayAuthCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.sage_pay_auth_capture_request.SagePayAuthCaptureRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_sage_pay_card_payment.py b/test/test_sage_pay_card_payment.py new file mode 100644 index 0000000..90a4c58 --- /dev/null +++ b/test/test_sage_pay_card_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.sage_pay_card_payment import SagePayCardPayment # noqa: E501 +from billforward.rest import ApiException + + +class TestSagePayCardPayment(unittest.TestCase): + """SagePayCardPayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSagePayCardPayment(self): + """Test SagePayCardPayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.sage_pay_card_payment.SagePayCardPayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_sage_pay_configuration.py b/test/test_sage_pay_configuration.py new file mode 100644 index 0000000..871d900 --- /dev/null +++ b/test/test_sage_pay_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.sage_pay_configuration import SagePayConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestSagePayConfiguration(unittest.TestCase): + """SagePayConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSagePayConfiguration(self): + """Test SagePayConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.sage_pay_configuration.SagePayConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_sage_pay_enabled_card_type.py b/test/test_sage_pay_enabled_card_type.py new file mode 100644 index 0000000..0ea67d7 --- /dev/null +++ b/test/test_sage_pay_enabled_card_type.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.sage_pay_enabled_card_type import SagePayEnabledCardType # noqa: E501 +from billforward.rest import ApiException + + +class TestSagePayEnabledCardType(unittest.TestCase): + """SagePayEnabledCardType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSagePayEnabledCardType(self): + """Test SagePayEnabledCardType""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.sage_pay_enabled_card_type.SagePayEnabledCardType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_sage_pay_pre_auth_request.py b/test/test_sage_pay_pre_auth_request.py new file mode 100644 index 0000000..f47ab59 --- /dev/null +++ b/test/test_sage_pay_pre_auth_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.sage_pay_pre_auth_request import SagePayPreAuthRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestSagePayPreAuthRequest(unittest.TestCase): + """SagePayPreAuthRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSagePayPreAuthRequest(self): + """Test SagePayPreAuthRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.sage_pay_pre_auth_request.SagePayPreAuthRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_salesforce_api.py b/test/test_salesforce_api.py new file mode 100644 index 0000000..a156f88 --- /dev/null +++ b/test/test_salesforce_api.py @@ -0,0 +1,63 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.salesforce_api import SalesforceApi # noqa: E501 +from billforward.rest import ApiException + + +class TestSalesforceApi(unittest.TestCase): + """SalesforceApi unit test stubs""" + + def setUp(self): + self.api = SalesforceApi() # noqa: E501 + + def tearDown(self): + pass + + def test_change_salesforce_job_state(self): + """Test case for change_salesforce_job_state + + """ + pass + + def test_connect_to_salesforce(self): + """Test case for connect_to_salesforce + + """ + pass + + def test_get_all_salesforce_jobs(self): + """Test case for get_all_salesforce_jobs + + """ + pass + + def test_get_salesforce_configuration(self): + """Test case for get_salesforce_configuration + + """ + pass + + def test_update_salesforce_configuration(self): + """Test case for update_salesforce_configuration + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_salesforce_configuration_response.py b/test/test_salesforce_configuration_response.py new file mode 100644 index 0000000..cdda204 --- /dev/null +++ b/test/test_salesforce_configuration_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.salesforce_configuration_response import SalesforceConfigurationResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestSalesforceConfigurationResponse(unittest.TestCase): + """SalesforceConfigurationResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSalesforceConfigurationResponse(self): + """Test SalesforceConfigurationResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.salesforce_configuration_response.SalesforceConfigurationResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_search_api.py b/test/test_search_api.py deleted file mode 100644 index 9f363b5..0000000 --- a/test/test_search_api.py +++ /dev/null @@ -1,54 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.search_api import SearchApi - - -class TestSearchApi(unittest.TestCase): - """ SearchApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.search_api.SearchApi() - - def tearDown(self): - pass - - def test_perform_search(self): - """ - Test case for perform_search - - Returns the results of the global search specified by the query-string. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_search_result_paged_metadata.py b/test/test_search_result_paged_metadata.py deleted file mode 100644 index e893ac7..0000000 --- a/test/test_search_result_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.search_result_paged_metadata import SearchResultPagedMetadata - - -class TestSearchResultPagedMetadata(unittest.TestCase): - """ SearchResultPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSearchResultPagedMetadata(self): - """ - Test SearchResultPagedMetadata - """ - model = billforward.models.search_result_paged_metadata.SearchResultPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_security_api.py b/test/test_security_api.py new file mode 100644 index 0000000..1dd8c6d --- /dev/null +++ b/test/test_security_api.py @@ -0,0 +1,165 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.security_api import SecurityApi # noqa: E501 +from billforward.rest import ApiException + + +class TestSecurityApi(unittest.TestCase): + """SecurityApi unit test stubs""" + + def setUp(self): + self.api = SecurityApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_flexcheck_user_login(self): + """Test case for create_flexcheck_user_login + + """ + pass + + def test_create_role(self): + """Test case for create_role + + """ + pass + + def test_create_user_login(self): + """Test case for create_user_login + + """ + pass + + def test_get_all_roles(self): + """Test case for get_all_roles + + """ + pass + + def test_get_current_user(self): + """Test case for get_current_user + + """ + pass + + def test_get_my_organizations(self): + """Test case for get_my_organizations + + """ + pass + + def test_get_private_permanent_api_token(self): + """Test case for get_private_permanent_api_token + + """ + pass + + def test_get_role_by_id(self): + """Test case for get_role_by_id + + """ + pass + + def test_get_simple_all_users(self): + """Test case for get_simple_all_users + + """ + pass + + def test_get_temporary_api_tokens(self): + """Test case for get_temporary_api_tokens + + """ + pass + + def test_get_user_by_username(self): + """Test case for get_user_by_username + + """ + pass + + def test_invite_user_login(self): + """Test case for invite_user_login + + """ + pass + + def test_link_open_id_token_to_user(self): + """Test case for link_open_id_token_to_user + + """ + pass + + def test_refresh_permanent_api_token(self): + """Test case for refresh_permanent_api_token + + """ + pass + + def test_remove_permission_from_role(self): + """Test case for remove_permission_from_role + + """ + pass + + def test_request_password_reset_code(self): + """Test case for request_password_reset_code + + """ + pass + + def test_revoke_role(self): + """Test case for revoke_role + + """ + pass + + def test_update_email(self): + """Test case for update_email + + """ + pass + + def test_update_role(self): + """Test case for update_role + + """ + pass + + def test_update_user_infos(self): + """Test case for update_user_infos + + """ + pass + + def test_update_user_password(self): + """Test case for update_user_password + + """ + pass + + def test_update_user_password_with_reset_code(self): + """Test case for update_user_password_with_reset_code + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_service_end_amendment.py b/test/test_service_end_amendment.py index 1b00c0e..2dda94d 100644 --- a/test/test_service_end_amendment.py +++ b/test/test_service_end_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.service_end_amendment import ServiceEndAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.service_end_amendment import ServiceEndAmendment class TestServiceEndAmendment(unittest.TestCase): - """ ServiceEndAmendment unit test stubs """ + """ServiceEndAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testServiceEndAmendment(self): - """ - Test ServiceEndAmendment - """ - model = billforward.models.service_end_amendment.ServiceEndAmendment() + """Test ServiceEndAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.service_end_amendment.ServiceEndAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_set_rate_plan_affiliate_request.py b/test/test_set_rate_plan_affiliate_request.py new file mode 100644 index 0000000..1d69012 --- /dev/null +++ b/test/test_set_rate_plan_affiliate_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.set_rate_plan_affiliate_request import SetRatePlanAffiliateRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestSetRatePlanAffiliateRequest(unittest.TestCase): + """SetRatePlanAffiliateRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSetRatePlanAffiliateRequest(self): + """Test SetRatePlanAffiliateRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.set_rate_plan_affiliate_request.SetRatePlanAffiliateRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_set_subscription_affiliate_request.py b/test/test_set_subscription_affiliate_request.py new file mode 100644 index 0000000..13924a3 --- /dev/null +++ b/test/test_set_subscription_affiliate_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.set_subscription_affiliate_request import SetSubscriptionAffiliateRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestSetSubscriptionAffiliateRequest(unittest.TestCase): + """SetSubscriptionAffiliateRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSetSubscriptionAffiliateRequest(self): + """Test SetSubscriptionAffiliateRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.set_subscription_affiliate_request.SetSubscriptionAffiliateRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_setup_charge.py b/test/test_setup_charge.py new file mode 100644 index 0000000..a7aad84 --- /dev/null +++ b/test/test_setup_charge.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.setup_charge import SetupCharge # noqa: E501 +from billforward.rest import ApiException + + +class TestSetupCharge(unittest.TestCase): + """SetupCharge unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSetupCharge(self): + """Test SetupCharge""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.setup_charge.SetupCharge() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_setup_pricing_components_by_charge_model.py b/test/test_setup_pricing_components_by_charge_model.py new file mode 100644 index 0000000..a65cede --- /dev/null +++ b/test/test_setup_pricing_components_by_charge_model.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.setup_pricing_components_by_charge_model import SetupPricingComponentsByChargeModel # noqa: E501 +from billforward.rest import ApiException + + +class TestSetupPricingComponentsByChargeModel(unittest.TestCase): + """SetupPricingComponentsByChargeModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSetupPricingComponentsByChargeModel(self): + """Test SetupPricingComponentsByChargeModel""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.setup_pricing_components_by_charge_model.SetupPricingComponentsByChargeModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_shuttle_auth_capture_request.py b/test/test_shuttle_auth_capture_request.py new file mode 100644 index 0000000..82d29ef --- /dev/null +++ b/test/test_shuttle_auth_capture_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.shuttle_auth_capture_request import ShuttleAuthCaptureRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestShuttleAuthCaptureRequest(unittest.TestCase): + """ShuttleAuthCaptureRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testShuttleAuthCaptureRequest(self): + """Test ShuttleAuthCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.shuttle_auth_capture_request.ShuttleAuthCaptureRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_shuttle_configuration.py b/test/test_shuttle_configuration.py new file mode 100644 index 0000000..3ef6fdb --- /dev/null +++ b/test/test_shuttle_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.shuttle_configuration import ShuttleConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestShuttleConfiguration(unittest.TestCase): + """ShuttleConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testShuttleConfiguration(self): + """Test ShuttleConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.shuttle_configuration.ShuttleConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_shuttle_payment.py b/test/test_shuttle_payment.py new file mode 100644 index 0000000..eed2de7 --- /dev/null +++ b/test/test_shuttle_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.shuttle_payment import ShuttlePayment # noqa: E501 +from billforward.rest import ApiException + + +class TestShuttlePayment(unittest.TestCase): + """ShuttlePayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testShuttlePayment(self): + """Test ShuttlePayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.shuttle_payment.ShuttlePayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_shuttle_pre_auth_request.py b/test/test_shuttle_pre_auth_request.py new file mode 100644 index 0000000..9964af6 --- /dev/null +++ b/test/test_shuttle_pre_auth_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.shuttle_pre_auth_request import ShuttlePreAuthRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestShuttlePreAuthRequest(unittest.TestCase): + """ShuttlePreAuthRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testShuttlePreAuthRequest(self): + """Test ShuttlePreAuthRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.shuttle_pre_auth_request.ShuttlePreAuthRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_simple_date_param.py b/test/test_simple_date_param.py new file mode 100644 index 0000000..8546843 --- /dev/null +++ b/test/test_simple_date_param.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.simple_date_param import SimpleDateParam # noqa: E501 +from billforward.rest import ApiException + + +class TestSimpleDateParam(unittest.TestCase): + """SimpleDateParam unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSimpleDateParam(self): + """Test SimpleDateParam""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.simple_date_param.SimpleDateParam() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_simple_user.py b/test/test_simple_user.py new file mode 100644 index 0000000..3cbe1da --- /dev/null +++ b/test/test_simple_user.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.simple_user import SimpleUser # noqa: E501 +from billforward.rest import ApiException + + +class TestSimpleUser(unittest.TestCase): + """SimpleUser unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSimpleUser(self): + """Test SimpleUser""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.simple_user.SimpleUser() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_single_recalculate_charge_request.py b/test/test_single_recalculate_charge_request.py new file mode 100644 index 0000000..739f90b --- /dev/null +++ b/test/test_single_recalculate_charge_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.single_recalculate_charge_request import SingleRecalculateChargeRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestSingleRecalculateChargeRequest(unittest.TestCase): + """SingleRecalculateChargeRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSingleRecalculateChargeRequest(self): + """Test SingleRecalculateChargeRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.single_recalculate_charge_request.SingleRecalculateChargeRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_spreedly_auth_capture_request.py b/test/test_spreedly_auth_capture_request.py new file mode 100644 index 0000000..408e4df --- /dev/null +++ b/test/test_spreedly_auth_capture_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.spreedly_auth_capture_request import SpreedlyAuthCaptureRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestSpreedlyAuthCaptureRequest(unittest.TestCase): + """SpreedlyAuthCaptureRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSpreedlyAuthCaptureRequest(self): + """Test SpreedlyAuthCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.spreedly_auth_capture_request.SpreedlyAuthCaptureRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_spreedly_configuration.py b/test/test_spreedly_configuration.py new file mode 100644 index 0000000..cb162a4 --- /dev/null +++ b/test/test_spreedly_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.spreedly_configuration import SpreedlyConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestSpreedlyConfiguration(unittest.TestCase): + """SpreedlyConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSpreedlyConfiguration(self): + """Test SpreedlyConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.spreedly_configuration.SpreedlyConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_spreedly_pre_auth_request.py b/test/test_spreedly_pre_auth_request.py new file mode 100644 index 0000000..523f136 --- /dev/null +++ b/test/test_spreedly_pre_auth_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.spreedly_pre_auth_request import SpreedlyPreAuthRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestSpreedlyPreAuthRequest(unittest.TestCase): + """SpreedlyPreAuthRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSpreedlyPreAuthRequest(self): + """Test SpreedlyPreAuthRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.spreedly_pre_auth_request.SpreedlyPreAuthRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_square_auth_capture_request.py b/test/test_square_auth_capture_request.py new file mode 100644 index 0000000..d3f1d49 --- /dev/null +++ b/test/test_square_auth_capture_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.square_auth_capture_request import SquareAuthCaptureRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestSquareAuthCaptureRequest(unittest.TestCase): + """SquareAuthCaptureRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSquareAuthCaptureRequest(self): + """Test SquareAuthCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.square_auth_capture_request.SquareAuthCaptureRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_square_configuration.py b/test/test_square_configuration.py new file mode 100644 index 0000000..0560d6c --- /dev/null +++ b/test/test_square_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.square_configuration import SquareConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestSquareConfiguration(unittest.TestCase): + """SquareConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSquareConfiguration(self): + """Test SquareConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.square_configuration.SquareConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_square_configuration_data.py b/test/test_square_configuration_data.py new file mode 100644 index 0000000..202d47e --- /dev/null +++ b/test/test_square_configuration_data.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.square_configuration_data import SquareConfigurationData # noqa: E501 +from billforward.rest import ApiException + + +class TestSquareConfigurationData(unittest.TestCase): + """SquareConfigurationData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSquareConfigurationData(self): + """Test SquareConfigurationData""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.square_configuration_data.SquareConfigurationData() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_square_data.py b/test/test_square_data.py new file mode 100644 index 0000000..fb4c5ae --- /dev/null +++ b/test/test_square_data.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.square_data import SquareData # noqa: E501 +from billforward.rest import ApiException + + +class TestSquareData(unittest.TestCase): + """SquareData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSquareData(self): + """Test SquareData""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.square_data.SquareData() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_square_payment.py b/test/test_square_payment.py new file mode 100644 index 0000000..4452d6d --- /dev/null +++ b/test/test_square_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.square_payment import SquarePayment # noqa: E501 +from billforward.rest import ApiException + + +class TestSquarePayment(unittest.TestCase): + """SquarePayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSquarePayment(self): + """Test SquarePayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.square_payment.SquarePayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_square_subscription.py b/test/test_square_subscription.py new file mode 100644 index 0000000..a1172ec --- /dev/null +++ b/test/test_square_subscription.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.square_subscription import SquareSubscription # noqa: E501 +from billforward.rest import ApiException + + +class TestSquareSubscription(unittest.TestCase): + """SquareSubscription unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSquareSubscription(self): + """Test SquareSubscription""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.square_subscription.SquareSubscription() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_start_all_subscriptions_request.py b/test/test_start_all_subscriptions_request.py new file mode 100644 index 0000000..d8296ab --- /dev/null +++ b/test/test_start_all_subscriptions_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.start_all_subscriptions_request import StartAllSubscriptionsRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestStartAllSubscriptionsRequest(unittest.TestCase): + """StartAllSubscriptionsRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStartAllSubscriptionsRequest(self): + """Test StartAllSubscriptionsRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.start_all_subscriptions_request.StartAllSubscriptionsRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_start_all_subscriptions_response.py b/test/test_start_all_subscriptions_response.py new file mode 100644 index 0000000..ae932ac --- /dev/null +++ b/test/test_start_all_subscriptions_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.start_all_subscriptions_response import StartAllSubscriptionsResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestStartAllSubscriptionsResponse(unittest.TestCase): + """StartAllSubscriptionsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStartAllSubscriptionsResponse(self): + """Test StartAllSubscriptionsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.start_all_subscriptions_response.StartAllSubscriptionsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_start_contract_request.py b/test/test_start_contract_request.py new file mode 100644 index 0000000..6e26cc2 --- /dev/null +++ b/test/test_start_contract_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.start_contract_request import StartContractRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestStartContractRequest(unittest.TestCase): + """StartContractRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStartContractRequest(self): + """Test StartContractRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.start_contract_request.StartContractRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_start_contract_response.py b/test/test_start_contract_response.py new file mode 100644 index 0000000..86e7bb9 --- /dev/null +++ b/test/test_start_contract_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.start_contract_response import StartContractResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestStartContractResponse(unittest.TestCase): + """StartContractResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStartContractResponse(self): + """Test StartContractResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.start_contract_response.StartContractResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_stripe_ach_capture_request.py b/test/test_stripe_ach_capture_request.py new file mode 100644 index 0000000..215bdbe --- /dev/null +++ b/test/test_stripe_ach_capture_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.stripe_ach_capture_request import StripeACHCaptureRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestStripeACHCaptureRequest(unittest.TestCase): + """StripeACHCaptureRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStripeACHCaptureRequest(self): + """Test StripeACHCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.stripe_ach_capture_request.StripeACHCaptureRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_stripe_ach_payment.py b/test/test_stripe_ach_payment.py new file mode 100644 index 0000000..fc5a9bd --- /dev/null +++ b/test/test_stripe_ach_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.stripe_ach_payment import StripeACHPayment # noqa: E501 +from billforward.rest import ApiException + + +class TestStripeACHPayment(unittest.TestCase): + """StripeACHPayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStripeACHPayment(self): + """Test StripeACHPayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.stripe_ach_payment.StripeACHPayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_stripe_ach_token.py b/test/test_stripe_ach_token.py new file mode 100644 index 0000000..f775908 --- /dev/null +++ b/test/test_stripe_ach_token.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.stripe_ach_token import StripeAchToken # noqa: E501 +from billforward.rest import ApiException + + +class TestStripeAchToken(unittest.TestCase): + """StripeAchToken unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStripeAchToken(self): + """Test StripeAchToken""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.stripe_ach_token.StripeAchToken() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_stripe_ach_token_paged_metadata.py b/test/test_stripe_ach_token_paged_metadata.py deleted file mode 100644 index d684f0e..0000000 --- a/test/test_stripe_ach_token_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.stripe_ach_token_paged_metadata import StripeACHTokenPagedMetadata - - -class TestStripeACHTokenPagedMetadata(unittest.TestCase): - """ StripeACHTokenPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStripeACHTokenPagedMetadata(self): - """ - Test StripeACHTokenPagedMetadata - """ - model = billforward.models.stripe_ach_token_paged_metadata.StripeACHTokenPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_stripe_additional_data.py b/test/test_stripe_additional_data.py new file mode 100644 index 0000000..b77d534 --- /dev/null +++ b/test/test_stripe_additional_data.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.stripe_additional_data import StripeAdditionalData # noqa: E501 +from billforward.rest import ApiException + + +class TestStripeAdditionalData(unittest.TestCase): + """StripeAdditionalData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStripeAdditionalData(self): + """Test StripeAdditionalData""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.stripe_additional_data.StripeAdditionalData() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_stripe_auth_capture_request.py b/test/test_stripe_auth_capture_request.py index 06dbec8..abae33b 100644 --- a/test/test_stripe_auth_capture_request.py +++ b/test/test_stripe_auth_capture_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.stripe_auth_capture_request import StripeAuthCaptureRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.stripe_auth_capture_request import StripeAuthCaptureRequest class TestStripeAuthCaptureRequest(unittest.TestCase): - """ StripeAuthCaptureRequest unit test stubs """ + """StripeAuthCaptureRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testStripeAuthCaptureRequest(self): - """ - Test StripeAuthCaptureRequest - """ - model = billforward.models.stripe_auth_capture_request.StripeAuthCaptureRequest() + """Test StripeAuthCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.stripe_auth_capture_request.StripeAuthCaptureRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_stripe_card_payment.py b/test/test_stripe_card_payment.py new file mode 100644 index 0000000..ff0d780 --- /dev/null +++ b/test/test_stripe_card_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.stripe_card_payment import StripeCardPayment # noqa: E501 +from billforward.rest import ApiException + + +class TestStripeCardPayment(unittest.TestCase): + """StripeCardPayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStripeCardPayment(self): + """Test StripeCardPayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.stripe_card_payment.StripeCardPayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_stripe_configuration.py b/test/test_stripe_configuration.py new file mode 100644 index 0000000..e7b7e34 --- /dev/null +++ b/test/test_stripe_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.stripe_configuration import StripeConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestStripeConfiguration(unittest.TestCase): + """StripeConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStripeConfiguration(self): + """Test StripeConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.stripe_configuration.StripeConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_stripe_object.py b/test/test_stripe_object.py deleted file mode 100644 index 3bc4a54..0000000 --- a/test/test_stripe_object.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.stripe_object import StripeObject - - -class TestStripeObject(unittest.TestCase): - """ StripeObject unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStripeObject(self): - """ - Test StripeObject - """ - model = billforward.models.stripe_object.StripeObject() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_stripe_pre_auth_request.py b/test/test_stripe_pre_auth_request.py new file mode 100644 index 0000000..ce40961 --- /dev/null +++ b/test/test_stripe_pre_auth_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.stripe_pre_auth_request import StripePreAuthRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestStripePreAuthRequest(unittest.TestCase): + """StripePreAuthRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStripePreAuthRequest(self): + """Test StripePreAuthRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.stripe_pre_auth_request.StripePreAuthRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_stripe_token.py b/test/test_stripe_token.py new file mode 100644 index 0000000..2d2072a --- /dev/null +++ b/test/test_stripe_token.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.stripe_token import StripeToken # noqa: E501 +from billforward.rest import ApiException + + +class TestStripeToken(unittest.TestCase): + """StripeToken unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStripeToken(self): + """Test StripeToken""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.stripe_token.StripeToken() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_stripe_token_paged_metadata.py b/test/test_stripe_token_paged_metadata.py deleted file mode 100644 index e2bde38..0000000 --- a/test/test_stripe_token_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.stripe_token_paged_metadata import StripeTokenPagedMetadata - - -class TestStripeTokenPagedMetadata(unittest.TestCase): - """ StripeTokenPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStripeTokenPagedMetadata(self): - """ - Test StripeTokenPagedMetadata - """ - model = billforward.models.stripe_token_paged_metadata.StripeTokenPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription.py b/test/test_subscription.py index bb4b907..0c72289 100644 --- a/test/test_subscription.py +++ b/test/test_subscription.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.subscription import Subscription # noqa: E501 from billforward.rest import ApiException -from billforward.models.subscription import Subscription class TestSubscription(unittest.TestCase): - """ Subscription unit test stubs """ + """Subscription unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testSubscription(self): - """ - Test Subscription - """ - model = billforward.models.subscription.Subscription() + """Test Subscription""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.subscription.Subscription() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_subscription_cancellation.py b/test/test_subscription_cancellation.py new file mode 100644 index 0000000..4f23b84 --- /dev/null +++ b/test/test_subscription_cancellation.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.subscription_cancellation import SubscriptionCancellation # noqa: E501 +from billforward.rest import ApiException + + +class TestSubscriptionCancellation(unittest.TestCase): + """SubscriptionCancellation unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSubscriptionCancellation(self): + """Test SubscriptionCancellation""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.subscription_cancellation.SubscriptionCancellation() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_subscription_cancellation_paged_metadata.py b/test/test_subscription_cancellation_paged_metadata.py deleted file mode 100644 index 5e121cf..0000000 --- a/test/test_subscription_cancellation_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.subscription_cancellation_paged_metadata import SubscriptionCancellationPagedMetadata - - -class TestSubscriptionCancellationPagedMetadata(unittest.TestCase): - """ SubscriptionCancellationPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSubscriptionCancellationPagedMetadata(self): - """ - Test SubscriptionCancellationPagedMetadata - """ - model = billforward.models.subscription_cancellation_paged_metadata.SubscriptionCancellationPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription_charge.py b/test/test_subscription_charge.py index 6c73d2e..8d9fed4 100644 --- a/test/test_subscription_charge.py +++ b/test/test_subscription_charge.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.subscription_charge import SubscriptionCharge # noqa: E501 from billforward.rest import ApiException -from billforward.models.subscription_charge import SubscriptionCharge class TestSubscriptionCharge(unittest.TestCase): - """ SubscriptionCharge unit test stubs """ + """SubscriptionCharge unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testSubscriptionCharge(self): - """ - Test SubscriptionCharge - """ - model = billforward.models.subscription_charge.SubscriptionCharge() + """Test SubscriptionCharge""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.subscription_charge.SubscriptionCharge() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_subscription_charge_paged_metadata.py b/test/test_subscription_charge_paged_metadata.py deleted file mode 100644 index 8f6253d..0000000 --- a/test/test_subscription_charge_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.subscription_charge_paged_metadata import SubscriptionChargePagedMetadata - - -class TestSubscriptionChargePagedMetadata(unittest.TestCase): - """ SubscriptionChargePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSubscriptionChargePagedMetadata(self): - """ - Test SubscriptionChargePagedMetadata - """ - model = billforward.models.subscription_charge_paged_metadata.SubscriptionChargePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription_checkout_action_request.py b/test/test_subscription_checkout_action_request.py new file mode 100644 index 0000000..06ea9de --- /dev/null +++ b/test/test_subscription_checkout_action_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.subscription_checkout_action_request import SubscriptionCheckoutActionRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestSubscriptionCheckoutActionRequest(unittest.TestCase): + """SubscriptionCheckoutActionRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSubscriptionCheckoutActionRequest(self): + """Test SubscriptionCheckoutActionRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.subscription_checkout_action_request.SubscriptionCheckoutActionRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_subscription_checkout_definition_description.py b/test/test_subscription_checkout_definition_description.py new file mode 100644 index 0000000..61dc701 --- /dev/null +++ b/test/test_subscription_checkout_definition_description.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.subscription_checkout_definition_description import SubscriptionCheckoutDefinitionDescription # noqa: E501 +from billforward.rest import ApiException + + +class TestSubscriptionCheckoutDefinitionDescription(unittest.TestCase): + """SubscriptionCheckoutDefinitionDescription unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSubscriptionCheckoutDefinitionDescription(self): + """Test SubscriptionCheckoutDefinitionDescription""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.subscription_checkout_definition_description.SubscriptionCheckoutDefinitionDescription() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_subscription_checkout_response.py b/test/test_subscription_checkout_response.py new file mode 100644 index 0000000..719dec2 --- /dev/null +++ b/test/test_subscription_checkout_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.subscription_checkout_response import SubscriptionCheckoutResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestSubscriptionCheckoutResponse(unittest.TestCase): + """SubscriptionCheckoutResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSubscriptionCheckoutResponse(self): + """Test SubscriptionCheckoutResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.subscription_checkout_response.SubscriptionCheckoutResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_subscription_ltv_result_paged_metadata.py b/test/test_subscription_ltv_result_paged_metadata.py deleted file mode 100644 index 1788cc3..0000000 --- a/test/test_subscription_ltv_result_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.subscription_ltv_result_paged_metadata import SubscriptionLTVResultPagedMetadata - - -class TestSubscriptionLTVResultPagedMetadata(unittest.TestCase): - """ SubscriptionLTVResultPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSubscriptionLTVResultPagedMetadata(self): - """ - Test SubscriptionLTVResultPagedMetadata - """ - model = billforward.models.subscription_ltv_result_paged_metadata.SubscriptionLTVResultPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription_paged_metadata.py b/test/test_subscription_paged_metadata.py deleted file mode 100644 index 617d558..0000000 --- a/test/test_subscription_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.subscription_paged_metadata import SubscriptionPagedMetadata - - -class TestSubscriptionPagedMetadata(unittest.TestCase): - """ SubscriptionPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSubscriptionPagedMetadata(self): - """ - Test SubscriptionPagedMetadata - """ - model = billforward.models.subscription_paged_metadata.SubscriptionPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription_revive_amendment.py b/test/test_subscription_revive_amendment.py new file mode 100644 index 0000000..47fc634 --- /dev/null +++ b/test/test_subscription_revive_amendment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.subscription_revive_amendment import SubscriptionReviveAmendment # noqa: E501 +from billforward.rest import ApiException + + +class TestSubscriptionReviveAmendment(unittest.TestCase): + """SubscriptionReviveAmendment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSubscriptionReviveAmendment(self): + """Test SubscriptionReviveAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.subscription_revive_amendment.SubscriptionReviveAmendment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_subscription_revive_partial_request.py b/test/test_subscription_revive_partial_request.py new file mode 100644 index 0000000..5d5cf68 --- /dev/null +++ b/test/test_subscription_revive_partial_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.subscription_revive_partial_request import SubscriptionRevivePartialRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestSubscriptionRevivePartialRequest(unittest.TestCase): + """SubscriptionRevivePartialRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSubscriptionRevivePartialRequest(self): + """Test SubscriptionRevivePartialRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.subscription_revive_partial_request.SubscriptionRevivePartialRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_subscription_revive_request.py b/test/test_subscription_revive_request.py new file mode 100644 index 0000000..5a6007f --- /dev/null +++ b/test/test_subscription_revive_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.subscription_revive_request import SubscriptionReviveRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestSubscriptionReviveRequest(unittest.TestCase): + """SubscriptionReviveRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSubscriptionReviveRequest(self): + """Test SubscriptionReviveRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.subscription_revive_request.SubscriptionReviveRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_subscriptions_api.py b/test/test_subscriptions_api.py index 4545b2c..cf8f44b 100644 --- a/test/test_subscriptions_api.py +++ b/test/test_subscriptions_api.py @@ -1,451 +1,354 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.api.subscriptions_api import SubscriptionsApi # noqa: E501 from billforward.rest import ApiException -from billforward.apis.subscriptions_api import SubscriptionsApi class TestSubscriptionsApi(unittest.TestCase): - """ SubscriptionsApi unit test stubs """ + """SubscriptionsApi unit test stubs""" def setUp(self): - self.api = billforward.apis.subscriptions_api.SubscriptionsApi() + self.api = SubscriptionsApi() # noqa: E501 def tearDown(self): pass def test_add_charge_to_subscription(self): - """ - Test case for add_charge_to_subscription + """Test case for add_charge_to_subscription - Creates a charge on the specified subscription. """ pass def test_add_coupon_to_subscription(self): - """ - Test case for add_coupon_to_subscription + """Test case for add_coupon_to_subscription - Applies a coupon to a subscription. """ pass def test_add_credit_note_to_subscription(self): - """ - Test case for add_credit_note_to_subscription + """Test case for add_credit_note_to_subscription - Creates a credit-note which may be used by only the specified subscription. """ pass def test_add_payment_method_to_subscription(self): - """ - Test case for add_payment_method_to_subscription + """Test case for add_payment_method_to_subscription - Enables the payment method to pay invoices of this subscription. """ pass def test_advance_subscription(self): - """ - Test case for advance_subscription + """Test case for advance_subscription - Advance the subscription through time. """ pass def test_available_payment_methods_for_subscription(self): - """ - Test case for available_payment_methods_for_subscription + """Test case for available_payment_methods_for_subscription - Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order. """ pass def test_batch_create_subscriptions(self): - """ - Test case for batch_create_subscriptions + """Test case for batch_create_subscriptions - Create multiple subscriptions. """ pass - def test_cancel_subscription(self): - """ - Test case for cancel_subscription + def test_batch_increment_usage(self): + """Test case for batch_increment_usage - Retires the subscription specified by the subscription-ID parameter. Retiring a subscription causes it to cancel based on the specified retirement settings for the product. """ pass - def test_create_aggregating_subscription(self): - """ - Test case for create_aggregating_subscription + def test_cancel_subscription(self): + """Test case for cancel_subscription - Create an aggregating subscription. """ pass - def test_create_subscription(self): - """ - Test case for create_subscription + def test_create_aggregating_subscription(self): + """Test case for create_aggregating_subscription - Create a new subscription. """ pass - def test_create_subscription_v2(self): - """ - Test case for create_subscription_v2 + def test_create_subscription_from_request(self): + """Test case for create_subscription_from_request - Create a subscription (V2). """ pass def test_create_timer(self): - """ - Test case for create_timer + """Test case for create_timer - Create a timer for a subscription event. """ pass def test_delete_metadata_for_subscription(self): - """ - Test case for delete_metadata_for_subscription + """Test case for delete_metadata_for_subscription - Remove any associated metadata. """ pass def test_freeze_subscription(self): - """ - Test case for freeze_subscription + """Test case for freeze_subscription - Freeze the subscription. """ pass - def test_get_all_subscriptions(self): - """ - Test case for get_all_subscriptions + def test_get_affiliate1(self): + """Test case for get_affiliate1 - Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_applicable_coupons_for_subscription(self): - """ - Test case for get_applicable_coupons_for_subscription + """Test case for get_applicable_coupons_for_subscription - Retrieves a collection of the coupons which can be applied to this subscription. """ pass def test_get_available_credit_subscription(self): - """ - Test case for get_available_credit_subscription + """Test case for get_available_credit_subscription - Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_charges_on_subscription(self): - """ - Test case for get_charges_on_subscription + """Test case for get_charges_on_subscription - Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_children_of_subscription(self): - """ - Test case for get_children_of_subscription + """Test case for get_children_of_subscription - Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order. """ pass def test_get_coupons_on_subscription(self): - """ - Test case for get_coupons_on_subscription + """Test case for get_coupons_on_subscription - Retrieves a collection of the coupons and the unique codes currently applied to the subscription. """ pass def test_get_invoices_for_subscription_by_state(self): - """ - Test case for get_invoices_for_subscription_by_state + """Test case for get_invoices_for_subscription_by_state - Retrieves a collection of invoice objects of the specified state for the given subscription. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_metadata_for_subscription(self): - """ - Test case for get_metadata_for_subscription + """Test case for get_metadata_for_subscription - Retrieve any associated metadata. """ pass def test_get_parent_subscription(self): - """ - Test case for get_parent_subscription + """Test case for get_parent_subscription - Return the parent of the given subscription. """ pass def test_get_pricing_component_values_of_subscription(self): - """ - Test case for get_pricing_component_values_of_subscription + """Test case for get_pricing_component_values_of_subscription - Gets the subscription's current pricing-component values. """ pass def test_get_subscription_by_account_id(self): - """ - Test case for get_subscription_by_account_id + """Test case for get_subscription_by_account_id - Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_subscription_by_id(self): - """ - Test case for get_subscription_by_id + """Test case for get_subscription_by_id - Retrieves a single subscription, specified by the ID parameter. """ pass def test_get_subscription_by_product_id(self): - """ - Test case for get_subscription_by_product_id + """Test case for get_subscription_by_product_id - Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_subscription_by_product_rate_plan_id(self): - """ - Test case for get_subscription_by_product_rate_plan_id + """Test case for get_subscription_by_product_rate_plan_id - Retrieves a collection of subscriptions, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_subscription_by_state(self): - """ - Test case for get_subscription_by_state + """Test case for get_subscription_by_state - Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_subscription_by_version_id(self): - """ - Test case for get_subscription_by_version_id + """Test case for get_subscription_by_version_id - Retrieves a single subscription, specified by the version-ID parameter. """ pass def test_get_subscriptions_by_initial_period_start(self): - """ - Test case for get_subscriptions_by_initial_period_start + """Test case for get_subscriptions_by_initial_period_start - Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_subscriptions_by_period_end(self): - """ - Test case for get_subscriptions_by_period_end + """Test case for get_subscriptions_by_period_end - Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_subscriptions_by_period_start(self): - """ - Test case for get_subscriptions_by_period_start + """Test case for get_subscriptions_by_period_start - Retrieves a collection of subscription objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_subscriptions_by_successful_periods(self): - """ - Test case for get_subscriptions_by_successful_periods + """Test case for get_subscriptions_by_successful_periods - Retrieves a collection of subscription objects whose successful periods count falls within the range specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_swagger_subscription(self): - """ - Test case for get_swagger_subscription + """Test case for get_swagger_subscription - """ pass def test_get_timers_for_subscription(self): - """ - Test case for get_timers_for_subscription + """Test case for get_timers_for_subscription - Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order. """ pass def test_import_subscription(self): - """ - Test case for import_subscription + """Test case for import_subscription - Import a subscription. """ pass def test_invoice_charges_on_subscription(self): - """ - Test case for invoice_charges_on_subscription + """Test case for invoice_charges_on_subscription - Invoice any outstanding charges for the subscription. """ pass def test_migrate_subscription(self): + """Test case for migrate_subscription + """ - Test case for migrate_subscription + pass + + def test_pause_subscription(self): + """Test case for pause_subscription - Migrate the subscription to a new plan. """ pass def test_remove_coupon_from_subscription(self): - """ - Test case for remove_coupon_from_subscription + """Test case for remove_coupon_from_subscription - Removes the coupon from the subscription. """ pass def test_remove_credit_from_subscription(self): - """ - Test case for remove_credit_from_subscription + """Test case for remove_credit_from_subscription - Decrease the amount of credit available to the specified subscription. """ pass def test_remove_payment_method_from_subscription(self): - """ - Test case for remove_payment_method_from_subscription + """Test case for remove_payment_method_from_subscription - Removes the specified payment method for the given subscription. """ pass def test_remove_pricing_component_value_change_from_subscription(self): - """ - Test case for remove_pricing_component_value_change_from_subscription + """Test case for remove_pricing_component_value_change_from_subscription - Discards from the subscription any scheduled changes in the value of the specified pricing-component. """ pass def test_resume_subscription(self): - """ - Test case for resume_subscription + """Test case for resume_subscription - Resume the frozen subscription. """ pass def test_revive_subscription(self): + """Test case for revive_subscription + """ - Test case for revive_subscription + pass + + def test_set_affiliate1(self): + """Test case for set_affiliate1 - Revives a cancelled subscription and returns it to its previous state """ pass def test_set_metadata_for_subscription(self): - """ - Test case for set_metadata_for_subscription + """Test case for set_metadata_for_subscription - Remove any existing metadata keys and create the provided data. """ pass def test_set_pricing_component_value_on_subscription(self): - """ - Test case for set_pricing_component_value_on_subscription + """Test case for set_pricing_component_value_on_subscription - Sets upon this subscription a new value for the specified pricing-component without performing an upgrade. """ pass - def test_set_pricing_component_value_on_subscription_v2(self): - """ - Test case for set_pricing_component_value_on_subscription_v2 + def test_set_pricing_component_value_on_subscription1(self): + """Test case for set_pricing_component_value_on_subscription1 - Upgrades/downgrades this subscription to some new value for the specified pricing-component. """ pass - def test_update_subscription(self): - """ - Test case for update_subscription + def test_set_pricing_component_value_on_subscription_batch_update(self): + """Test case for set_pricing_component_value_on_subscription_batch_update - Update a subscription. """ pass - def test_update_subscription_v2(self): + def test_start_all_subscriptions(self): + """Test case for start_all_subscriptions + """ - Test case for update_subscription_v2 + pass + + def test_update_subscription_from_request(self): + """Test case for update_subscription_from_request - Update a subscription (V2). """ pass def test_upsert_metadata_for_subscription(self): - """ - Test case for upsert_metadata_for_subscription + """Test case for upsert_metadata_for_subscription - Update any existing metadata key-values and insert any new key-values, no keys will be removed. """ pass diff --git a/test/test_swagger_type_list.py b/test/test_swagger_type_list.py deleted file mode 100644 index de4c0e1..0000000 --- a/test/test_swagger_type_list.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.swagger_type_list import SwaggerTypeList - - -class TestSwaggerTypeList(unittest.TestCase): - """ SwaggerTypeList unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSwaggerTypeList(self): - """ - Test SwaggerTypeList - """ - model = billforward.models.swagger_type_list.SwaggerTypeList() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_swagger_type_list_inv.py b/test/test_swagger_type_list_inv.py index d5e842c..39cc996 100644 --- a/test/test_swagger_type_list_inv.py +++ b/test/test_swagger_type_list_inv.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.swagger_type_list_inv import SwaggerTypeListInv # noqa: E501 from billforward.rest import ApiException -from billforward.models.swagger_type_list_inv import SwaggerTypeListInv class TestSwaggerTypeListInv(unittest.TestCase): - """ SwaggerTypeListInv unit test stubs """ + """SwaggerTypeListInv unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testSwaggerTypeListInv(self): - """ - Test SwaggerTypeListInv - """ - model = billforward.models.swagger_type_list_inv.SwaggerTypeListInv() + """Test SwaggerTypeListInv""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.swagger_type_list_inv.SwaggerTypeListInv() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_swagger_type_list_subs.py b/test/test_swagger_type_list_subs.py index 04715e3..e301595 100644 --- a/test/test_swagger_type_list_subs.py +++ b/test/test_swagger_type_list_subs.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.swagger_type_list_subs import SwaggerTypeListSubs # noqa: E501 from billforward.rest import ApiException -from billforward.models.swagger_type_list_subs import SwaggerTypeListSubs class TestSwaggerTypeListSubs(unittest.TestCase): - """ SwaggerTypeListSubs unit test stubs """ + """SwaggerTypeListSubs unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testSwaggerTypeListSubs(self): - """ - Test SwaggerTypeListSubs - """ - model = billforward.models.swagger_type_list_subs.SwaggerTypeListSubs() + """Test SwaggerTypeListSubs""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.swagger_type_list_subs.SwaggerTypeListSubs() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_sync_action_request.py b/test/test_sync_action_request.py new file mode 100644 index 0000000..1817241 --- /dev/null +++ b/test/test_sync_action_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.sync_action_request import SyncActionRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestSyncActionRequest(unittest.TestCase): + """SyncActionRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSyncActionRequest(self): + """Test SyncActionRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.sync_action_request.SyncActionRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_synch_app_configs_api.py b/test/test_synch_app_configs_api.py deleted file mode 100644 index 8ff891e..0000000 --- a/test/test_synch_app_configs_api.py +++ /dev/null @@ -1,78 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.synch_app_configs_api import SynchAppConfigsApi - - -class TestSynchAppConfigsApi(unittest.TestCase): - """ SynchAppConfigsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.synch_app_configs_api.SynchAppConfigsApi() - - def tearDown(self): - pass - - def test_create_sync_app_config(self): - """ - Test case for create_sync_app_config - - Create a synch app configuration. - """ - pass - - def test_get_sync_app_config(self): - """ - Test case for get_sync_app_config - - Returns a single config, specified by the ID parameter. - """ - pass - - def test_get_sync_app_config_by_platform(self): - """ - Test case for get_sync_app_config_by_platform - - Returns a collection configurations, specified by the platform parameter. - """ - pass - - def test_update_sync_app_config(self): - """ - Test case for update_sync_app_config - - Update a synch app configuration. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_synch_configs_api.py b/test/test_synch_configs_api.py deleted file mode 100644 index fedd005..0000000 --- a/test/test_synch_configs_api.py +++ /dev/null @@ -1,94 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.synch_configs_api import SynchConfigsApi - - -class TestSynchConfigsApi(unittest.TestCase): - """ SynchConfigsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.synch_configs_api.SynchConfigsApi() - - def tearDown(self): - pass - - def test_create_sync_config(self): - """ - Test case for create_sync_config - - Create a synch configuration. - """ - pass - - def test_get_all_sync_configs(self): - """ - Test case for get_all_sync_configs - - Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_sync_config(self): - """ - Test case for get_sync_config - - Returns a single config, specified by the ID parameter. - """ - pass - - def test_get_sync_config_by_platform(self): - """ - Test case for get_sync_config_by_platform - - Returns a collection configurations, specified by the platform parameter. - """ - pass - - def test_get_sync_config_by_username(self): - """ - Test case for get_sync_config_by_username - - Returns a collection configurations, specified by the username parameter. - """ - pass - - def test_update_sync_config(self): - """ - Test case for update_sync_config - - Update a synch configuration. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_synch_jobs_api.py b/test/test_synch_jobs_api.py deleted file mode 100644 index 66cc2f6..0000000 --- a/test/test_synch_jobs_api.py +++ /dev/null @@ -1,110 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.synch_jobs_api import SynchJobsApi - - -class TestSynchJobsApi(unittest.TestCase): - """ SynchJobsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.synch_jobs_api.SynchJobsApi() - - def tearDown(self): - pass - - def test_create_sync_job(self): - """ - Test case for create_sync_job - - Create a synch job. - """ - pass - - def test_get_all_sync_jobs(self): - """ - Test case for get_all_sync_jobs - - Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_sync_job_by_id(self): - """ - Test case for get_sync_job_by_id - - Returns a single job, specified by the ID parameter. - """ - pass - - def test_get_sync_job_by_scope(self): - """ - Test case for get_sync_job_by_scope - - Returns a collection jobs, specified by the scope parameter. - """ - pass - - def test_get_sync_job_by_state(self): - """ - Test case for get_sync_job_by_state - - Returns a collection jobs, specified by the state parameter. - """ - pass - - def test_get_sync_job_by_target(self): - """ - Test case for get_sync_job_by_target - - Returns a collection jobs, specified by the target parameter. - """ - pass - - def test_get_sync_job_by_type(self): - """ - Test case for get_sync_job_by_type - - Returns a collection jobs, specified by the type parameter. - """ - pass - - def test_update_sync_job(self): - """ - Test case for update_sync_job - - Update a synch job. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tax_line.py b/test/test_tax_line.py new file mode 100644 index 0000000..29fc0b0 --- /dev/null +++ b/test/test_tax_line.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.tax_line import TaxLine # noqa: E501 +from billforward.rest import ApiException + + +class TestTaxLine(unittest.TestCase): + """TaxLine unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTaxLine(self): + """Test TaxLine""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.tax_line.TaxLine() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_taxation_link_paged_metadata.py b/test/test_taxation_link_paged_metadata.py deleted file mode 100644 index f7b1473..0000000 --- a/test/test_taxation_link_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.taxation_link_paged_metadata import TaxationLinkPagedMetadata - - -class TestTaxationLinkPagedMetadata(unittest.TestCase): - """ TaxationLinkPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTaxationLinkPagedMetadata(self): - """ - Test TaxationLinkPagedMetadata - """ - model = billforward.models.taxation_link_paged_metadata.TaxationLinkPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_taxation_strategy.py b/test/test_taxation_strategy.py new file mode 100644 index 0000000..597303a --- /dev/null +++ b/test/test_taxation_strategy.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.taxation_strategy import TaxationStrategy # noqa: E501 +from billforward.rest import ApiException + + +class TestTaxationStrategy(unittest.TestCase): + """TaxationStrategy unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTaxationStrategy(self): + """Test TaxationStrategy""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.taxation_strategy.TaxationStrategy() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_taxation_strategy_paged_metadata.py b/test/test_taxation_strategy_paged_metadata.py deleted file mode 100644 index a948860..0000000 --- a/test/test_taxation_strategy_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.taxation_strategy_paged_metadata import TaxationStrategyPagedMetadata - - -class TestTaxationStrategyPagedMetadata(unittest.TestCase): - """ TaxationStrategyPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTaxationStrategyPagedMetadata(self): - """ - Test TaxationStrategyPagedMetadata - """ - model = billforward.models.taxation_strategy_paged_metadata.TaxationStrategyPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_taxationlinks_api.py b/test/test_taxationlinks_api.py deleted file mode 100644 index e0f23f0..0000000 --- a/test/test_taxationlinks_api.py +++ /dev/null @@ -1,94 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.taxationlinks_api import TaxationlinksApi - - -class TestTaxationlinksApi(unittest.TestCase): - """ TaxationlinksApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.taxationlinks_api.TaxationlinksApi() - - def tearDown(self): - pass - - def test_create_taxation_link(self): - """ - Test case for create_taxation_link - - Create - """ - pass - - def test_get_all_taxation_links(self): - """ - Test case for get_all_taxation_links - - Returns a collection of all taxation-links. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_taxation_link_by_id(self): - """ - Test case for get_taxation_link_by_id - - Returns a single taxation-link, specified by the taxation-link-ID parameter. - """ - pass - - def test_get_taxation_link_by_product_rate_plan(self): - """ - Test case for get_taxation_link_by_product_rate_plan - - Returns a collection of taxation-links, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_taxation_link_by_taxation_strategy(self): - """ - Test case for get_taxation_link_by_taxation_strategy - - Returns a collection of taxation-links, specified by the taxation-strategy-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_update_taxation_link(self): - """ - Test case for update_taxation_link - - Update - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_taxationstrategies_api.py b/test/test_taxationstrategies_api.py deleted file mode 100644 index 6dd7f08..0000000 --- a/test/test_taxationstrategies_api.py +++ /dev/null @@ -1,118 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.taxationstrategies_api import TaxationstrategiesApi - - -class TestTaxationstrategiesApi(unittest.TestCase): - """ TaxationstrategiesApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.taxationstrategies_api.TaxationstrategiesApi() - - def tearDown(self): - pass - - def test_create_taxation_strategy(self): - """ - Test case for create_taxation_strategy - -

Add a new tax or schedule changes in an existing tax.

Add a new tax by providing the location and tax percentage. To schedule a tax change specify the ID of the current Tax. A new version of the will be created validFrom the specified date, the existing tax validTill the start of this new tax.

- """ - pass - - def test_get_all_taxation_strategies(self): - """ - Test case for get_all_taxation_strategies - - Returns a collection of all taxation-strategies. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_taxation_strategy_by_consistent_id(self): - """ - Test case for get_taxation_strategy_by_consistent_id - - Returns the tax currently being applied for the taxation-strategy-ID. To return schedule or historic tax changes the include_retired query parameter should be set to true. - """ - pass - - def test_get_taxation_strategy_by_country(self): - """ - Test case for get_taxation_strategy_by_country - - Returns a collection of taxation-strategies, specified by the country parameter. By default 10 values are returned. Records are returned in natural order. To return schedule or historic tax changes the include_retired query parameter should be set to true. - """ - pass - - def test_get_taxation_strategy_by_currency(self): - """ - Test case for get_taxation_strategy_by_currency - - Returns a collection of taxation-strategies, specified by the currency parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_taxation_strategy_by_province(self): - """ - Test case for get_taxation_strategy_by_province - - Returns a collection of taxation-strategies, specified by the province parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_taxation_strategy_by_version_id(self): - """ - Test case for get_taxation_strategy_by_version_id - - Returns a single taxation-strategy, specified by the taxation-strategy-ID parameter. - """ - pass - - def test_retire_taxation_strategy(self): - """ - Test case for retire_taxation_strategy - - Retires the taxation-strategy specified by taxation-strategy-ID parameter. Only the version of the tax which has an unbounded (null) validTill can be removed. Removing a tax change will make the previous tax come into effect. For example if you have a Tax in January and 5% and a new tax at 7% from February onwards, you can remove the February tax. Remove the February tax will re-instate the January tax. - """ - pass - - def test_update_taxation_strategy(self): - """ - Test case for update_taxation_strategy - - Update a tax. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_taxes_api.py b/test/test_taxes_api.py new file mode 100644 index 0000000..94a4ab7 --- /dev/null +++ b/test/test_taxes_api.py @@ -0,0 +1,87 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.api.taxes_api import TaxesApi # noqa: E501 +from billforward.rest import ApiException + + +class TestTaxesApi(unittest.TestCase): + """TaxesApi unit test stubs""" + + def setUp(self): + self.api = TaxesApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_taxation_strategy(self): + """Test case for create_taxation_strategy + + """ + pass + + def test_get_all_taxation_strategies(self): + """Test case for get_all_taxation_strategies + + """ + pass + + def test_get_taxation_strategy_by_consistent_id(self): + """Test case for get_taxation_strategy_by_consistent_id + + """ + pass + + def test_get_taxation_strategy_by_country(self): + """Test case for get_taxation_strategy_by_country + + """ + pass + + def test_get_taxation_strategy_by_currency(self): + """Test case for get_taxation_strategy_by_currency + + """ + pass + + def test_get_taxation_strategy_by_province(self): + """Test case for get_taxation_strategy_by_province + + """ + pass + + def test_get_taxation_strategy_by_version_id(self): + """Test case for get_taxation_strategy_by_version_id + + """ + pass + + def test_retire_taxation_strategy(self): + """Test case for retire_taxation_strategy + + """ + pass + + def test_update_taxation_strategy(self): + """Test case for update_taxation_strategy + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tiered_advance_pricing_component.py b/test/test_tiered_advance_pricing_component.py new file mode 100644 index 0000000..d15f5c6 --- /dev/null +++ b/test/test_tiered_advance_pricing_component.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.tiered_advance_pricing_component import TieredAdvancePricingComponent # noqa: E501 +from billforward.rest import ApiException + + +class TestTieredAdvancePricingComponent(unittest.TestCase): + """TieredAdvancePricingComponent unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTieredAdvancePricingComponent(self): + """Test TieredAdvancePricingComponent""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.tiered_advance_pricing_component.TieredAdvancePricingComponent() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tiered_arrears_pricing_component.py b/test/test_tiered_arrears_pricing_component.py new file mode 100644 index 0000000..3b399d8 --- /dev/null +++ b/test/test_tiered_arrears_pricing_component.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.tiered_arrears_pricing_component import TieredArrearsPricingComponent # noqa: E501 +from billforward.rest import ApiException + + +class TestTieredArrearsPricingComponent(unittest.TestCase): + """TieredArrearsPricingComponent unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTieredArrearsPricingComponent(self): + """Test TieredArrearsPricingComponent""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.tiered_arrears_pricing_component.TieredArrearsPricingComponent() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tiered_pricing_component.py b/test/test_tiered_pricing_component.py index 653c21f..aa42605 100644 --- a/test/test_tiered_pricing_component.py +++ b/test/test_tiered_pricing_component.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.tiered_pricing_component import TieredPricingComponent # noqa: E501 from billforward.rest import ApiException -from billforward.models.tiered_pricing_component import TieredPricingComponent class TestTieredPricingComponent(unittest.TestCase): - """ TieredPricingComponent unit test stubs """ + """TieredPricingComponent unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testTieredPricingComponent(self): - """ - Test TieredPricingComponent - """ - model = billforward.models.tiered_pricing_component.TieredPricingComponent() + """Test TieredPricingComponent""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.tiered_pricing_component.TieredPricingComponent() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_tiered_setup_pricing_component.py b/test/test_tiered_setup_pricing_component.py new file mode 100644 index 0000000..94b6a72 --- /dev/null +++ b/test/test_tiered_setup_pricing_component.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.tiered_setup_pricing_component import TieredSetupPricingComponent # noqa: E501 +from billforward.rest import ApiException + + +class TestTieredSetupPricingComponent(unittest.TestCase): + """TieredSetupPricingComponent unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTieredSetupPricingComponent(self): + """Test TieredSetupPricingComponent""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.tiered_setup_pricing_component.TieredSetupPricingComponent() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tiered_usage_pricing_component.py b/test/test_tiered_usage_pricing_component.py new file mode 100644 index 0000000..6d77eff --- /dev/null +++ b/test/test_tiered_usage_pricing_component.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.tiered_usage_pricing_component import TieredUsagePricingComponent # noqa: E501 +from billforward.rest import ApiException + + +class TestTieredUsagePricingComponent(unittest.TestCase): + """TieredUsagePricingComponent unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTieredUsagePricingComponent(self): + """Test TieredUsagePricingComponent""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.tiered_usage_pricing_component.TieredUsagePricingComponent() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tiered_volume_pricing_component.py b/test/test_tiered_volume_pricing_component.py index d6f3da8..890ca6e 100644 --- a/test/test_tiered_volume_pricing_component.py +++ b/test/test_tiered_volume_pricing_component.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.tiered_volume_pricing_component import TieredVolumePricingComponent # noqa: E501 from billforward.rest import ApiException -from billforward.models.tiered_volume_pricing_component import TieredVolumePricingComponent class TestTieredVolumePricingComponent(unittest.TestCase): - """ TieredVolumePricingComponent unit test stubs """ + """TieredVolumePricingComponent unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testTieredVolumePricingComponent(self): - """ - Test TieredVolumePricingComponent - """ - model = billforward.models.tiered_volume_pricing_component.TieredVolumePricingComponent() + """Test TieredVolumePricingComponent""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.tiered_volume_pricing_component.TieredVolumePricingComponent() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_time_api.py b/test/test_time_api.py deleted file mode 100644 index d2277de..0000000 --- a/test/test_time_api.py +++ /dev/null @@ -1,54 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.time_api import TimeApi - - -class TestTimeApi(unittest.TestCase): - """ TimeApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.time_api.TimeApi() - - def tearDown(self): - pass - - def test_get_time_swagger(self): - """ - Test case for get_time_swagger - - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_time_request.py b/test/test_time_request.py index 7c4b658..e38d3ee 100644 --- a/test/test_time_request.py +++ b/test/test_time_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.time_request import TimeRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.time_request import TimeRequest class TestTimeRequest(unittest.TestCase): - """ TimeRequest unit test stubs """ + """TimeRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testTimeRequest(self): - """ - Test TimeRequest - """ - model = billforward.models.time_request.TimeRequest() + """Test TimeRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.time_request.TimeRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_time_response.py b/test/test_time_response.py index ddc81d9..1a61557 100644 --- a/test/test_time_response.py +++ b/test/test_time_response.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.time_response import TimeResponse # noqa: E501 from billforward.rest import ApiException -from billforward.models.time_response import TimeResponse class TestTimeResponse(unittest.TestCase): - """ TimeResponse unit test stubs """ + """TimeResponse unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testTimeResponse(self): - """ - Test TimeResponse - """ - model = billforward.models.time_response.TimeResponse() + """Test TimeResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.time_response.TimeResponse() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_time_response_paged_metadata.py b/test/test_time_response_paged_metadata.py deleted file mode 100644 index 5bdc56c..0000000 --- a/test/test_time_response_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.time_response_paged_metadata import TimeResponsePagedMetadata - - -class TestTimeResponsePagedMetadata(unittest.TestCase): - """ TimeResponsePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTimeResponsePagedMetadata(self): - """ - Test TimeResponsePagedMetadata - """ - model = billforward.models.time_response_paged_metadata.TimeResponsePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_time_zone.py b/test/test_time_zone.py deleted file mode 100644 index 09a7b92..0000000 --- a/test/test_time_zone.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.time_zone import TimeZone - - -class TestTimeZone(unittest.TestCase): - """ TimeZone unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTimeZone(self): - """ - Test TimeZone - """ - model = billforward.models.time_zone.TimeZone() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_timer_amendment.py b/test/test_timer_amendment.py index 9951d96..f309667 100644 --- a/test/test_timer_amendment.py +++ b/test/test_timer_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.timer_amendment import TimerAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.timer_amendment import TimerAmendment class TestTimerAmendment(unittest.TestCase): - """ TimerAmendment unit test stubs """ + """TimerAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testTimerAmendment(self): - """ - Test TimerAmendment - """ - model = billforward.models.timer_amendment.TimerAmendment() + """Test TimerAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.timer_amendment.TimerAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_tokenization_api.py b/test/test_tokenization_api.py index de395a5..cc0d0c5 100644 --- a/test/test_tokenization_api.py +++ b/test/test_tokenization_api.py @@ -1,91 +1,234 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.api.tokenization_api import TokenizationApi # noqa: E501 from billforward.rest import ApiException -from billforward.apis.tokenization_api import TokenizationApi class TestTokenizationApi(unittest.TestCase): - """ TokenizationApi unit test stubs """ + """TokenizationApi unit test stubs""" def setUp(self): - self.api = billforward.apis.tokenization_api.TokenizationApi() + self.api = TokenizationApi() # noqa: E501 def tearDown(self): pass def test_auth_capture(self): - """ - Test case for auth_capture + """Test case for auth_capture - [Note: this API can be invoked more simply by our client-side card capture library, BillForward.js; you should not need to interact with this API manually unless you have particularly bespoke requirements] """ pass def test_braintree_card_capture(self): + """Test case for braintree_card_capture + """ - Test case for braintree_card_capture + pass + + def test_create_authorize_net_token(self): + """Test case for create_authorize_net_token - [Warning: for use only in PCI-compliant environments; for more information, contact us regarding provisioning of your own on-premise BillForward instance] Captures raw credit card details into Braintree's vault. """ pass - def test_pay_vision_shout_v1(self): + def test_create_braintree_token(self): + """Test case for create_braintree_token + """ - Test case for pay_vision_shout_v1 + pass + + def test_create_stripe_ach_token(self): + """Test case for create_stripe_ach_token - [Note: this API is intended to be invoked by the PayVision servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. """ pass - def test_pre_auth(self): + def test_create_stripe_token(self): + """Test case for create_stripe_token + + """ + pass + + def test_create_trust_commerce_token(self): + """Test case for create_trust_commerce_token + """ - Test case for pre_auth + pass + + def test_display_card_capture_form(self): + """Test case for display_card_capture_form - [Note: this API can be invoked more simply by our client-side card capture library, BillForward.js; you should not need to interact with this API manually unless you have particularly bespoke requirements] """ pass - def test_sage_pay_notify_v300(self): + def test_epx_card_capture(self): + """Test case for epx_card_capture + """ - Test case for sage_pay_notify_v300 + pass + + def test_epx_pre_auth(self): + """Test case for epx_pre_auth + + """ + pass + + def test_epx_pre_auth_response(self): + """Test case for epx_pre_auth_response + + """ + pass + + def test_expire_email_redirect_capture(self): + """Test case for expire_email_redirect_capture + + """ + pass + + def test_get_all_email_redirect_capture(self): + """Test case for get_all_email_redirect_capture + + """ + pass + + def test_get_braintree_by_account_id(self): + """Test case for get_braintree_by_account_id + + """ + pass + + def test_get_by_card_details_id(self): + """Test case for get_by_card_details_id + + """ + pass + + def test_get_email_redirect_capture(self): + """Test case for get_email_redirect_capture + + """ + pass + + def test_get_email_redirect_capture_invoice_html(self): + """Test case for get_email_redirect_capture_invoice_html + + """ + pass + + def test_get_stripe_ach(self): + """Test case for get_stripe_ach + + """ + pass + + def test_get_stripe_token(self): + """Test case for get_stripe_token + + """ + pass + + def test_go_cardless_bank_account_capture(self): + """Test case for go_cardless_bank_account_capture + + """ + pass + + def test_pay_vision_shout_v1(self): + """Test case for pay_vision_shout_v1 + + """ + pass + + def test_pre_auth(self): + """Test case for pre_auth + + """ + pass + + def test_sage_pay_notify_v300(self): + """Test case for sage_pay_notify_v300 - [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of receiving a callback from a SagePay card capture operation, using SagePay's FORM Protocol, v3.0] Handles SagePay Notification. """ pass def test_sage_pay_shout_v300(self): + """Test case for sage_pay_shout_v300 + + """ + pass + + def test_send_email_redirect_capture(self): + """Test case for send_email_redirect_capture + + """ + pass + + def test_start_email_redirect_capture(self): + """Test case for start_email_redirect_capture + + """ + pass + + def test_stripe_ach_bank_account_capture(self): + """Test case for stripe_ach_bank_account_capture + + """ + pass + + def test_stripe_web_hook(self): + """Test case for stripe_web_hook + + """ + pass + + def test_update_email_redirect_capture(self): + """Test case for update_email_redirect_capture + + """ + pass + + def test_update_profile_with_token(self): + """Test case for update_profile_with_token + """ - Test case for sage_pay_shout_v300 + pass + + def test_update_stripe_ach_token(self): + """Test case for update_stripe_ach_token + + """ + pass + + def test_update_stripe_token(self): + """Test case for update_stripe_token + + """ + pass + + def test_zooz_card_capture(self): + """Test case for zooz_card_capture + + """ + pass + + def test_zooz_web_hook(self): + """Test case for zooz_web_hook - [Note: this API is intended to be invoked by the SagePay servers -- they are BillForward's way of informing client-side of the result of card-capture from within an iframe, using SagePay's FORM Protocol, v3.0] Generates iframe to which customer will be directed upon success or failure. The iframe contains JavaScript which attempts to send a message to BillForward.js on the client-side, which will handle the result. """ pass diff --git a/test/test_tokenization_epxredirect_body.py b/test/test_tokenization_epxredirect_body.py new file mode 100644 index 0000000..a26a557 --- /dev/null +++ b/test/test_tokenization_epxredirect_body.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.tokenization_epxredirect_body import TokenizationEpxredirectBody # noqa: E501 +from billforward.rest import ApiException + + +class TestTokenizationEpxredirectBody(unittest.TestCase): + """TokenizationEpxredirectBody unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTokenizationEpxredirectBody(self): + """Test TokenizationEpxredirectBody""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.tokenization_epxredirect_body.TokenizationEpxredirectBody() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tokenization_payvisionshoutv1_body.py b/test/test_tokenization_payvisionshoutv1_body.py new file mode 100644 index 0000000..fc5247f --- /dev/null +++ b/test/test_tokenization_payvisionshoutv1_body.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.tokenization_payvisionshoutv1_body import TokenizationPayvisionshoutv1Body # noqa: E501 +from billforward.rest import ApiException + + +class TestTokenizationPayvisionshoutv1Body(unittest.TestCase): + """TokenizationPayvisionshoutv1Body unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTokenizationPayvisionshoutv1Body(self): + """Test TokenizationPayvisionshoutv1Body""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.tokenization_payvisionshoutv1_body.TokenizationPayvisionshoutv1Body() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tokenization_pre_auth.py b/test/test_tokenization_pre_auth.py new file mode 100644 index 0000000..70382b9 --- /dev/null +++ b/test/test_tokenization_pre_auth.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.tokenization_pre_auth import TokenizationPreAuth # noqa: E501 +from billforward.rest import ApiException + + +class TestTokenizationPreAuth(unittest.TestCase): + """TokenizationPreAuth unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTokenizationPreAuth(self): + """Test TokenizationPreAuth""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.tokenization_pre_auth.TokenizationPreAuth() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tokenization_pre_auth_paged_metadata.py b/test/test_tokenization_pre_auth_paged_metadata.py deleted file mode 100644 index 2afd832..0000000 --- a/test/test_tokenization_pre_auth_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.tokenization_pre_auth_paged_metadata import TokenizationPreAuthPagedMetadata - - -class TestTokenizationPreAuthPagedMetadata(unittest.TestCase): - """ TokenizationPreAuthPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTokenizationPreAuthPagedMetadata(self): - """ - Test TokenizationPreAuthPagedMetadata - """ - model = billforward.models.tokenization_pre_auth_paged_metadata.TokenizationPreAuthPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tokenization_pre_auth_request.py b/test/test_tokenization_pre_auth_request.py new file mode 100644 index 0000000..ef9f73b --- /dev/null +++ b/test/test_tokenization_pre_auth_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.tokenization_pre_auth_request import TokenizationPreAuthRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestTokenizationPreAuthRequest(unittest.TestCase): + """TokenizationPreAuthRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTokenizationPreAuthRequest(self): + """Test TokenizationPreAuthRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.tokenization_pre_auth_request.TokenizationPreAuthRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tokenization_sagepaynotifyv300_body.py b/test/test_tokenization_sagepaynotifyv300_body.py new file mode 100644 index 0000000..bdac5ec --- /dev/null +++ b/test/test_tokenization_sagepaynotifyv300_body.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.tokenization_sagepaynotifyv300_body import TokenizationSagepaynotifyv300Body # noqa: E501 +from billforward.rest import ApiException + + +class TestTokenizationSagepaynotifyv300Body(unittest.TestCase): + """TokenizationSagepaynotifyv300Body unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTokenizationSagepaynotifyv300Body(self): + """Test TokenizationSagepaynotifyv300Body""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.tokenization_sagepaynotifyv300_body.TokenizationSagepaynotifyv300Body() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tokens_response.py b/test/test_tokens_response.py new file mode 100644 index 0000000..120b894 --- /dev/null +++ b/test/test_tokens_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.tokens_response import TokensResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestTokensResponse(unittest.TestCase): + """TokensResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTokensResponse(self): + """Test TokensResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.tokens_response.TokensResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_trust_commerce_configuration.py b/test/test_trust_commerce_configuration.py new file mode 100644 index 0000000..0a1f2a3 --- /dev/null +++ b/test/test_trust_commerce_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.trust_commerce_configuration import TrustCommerceConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestTrustCommerceConfiguration(unittest.TestCase): + """TrustCommerceConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTrustCommerceConfiguration(self): + """Test TrustCommerceConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.trust_commerce_configuration.TrustCommerceConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_trust_commerce_token.py b/test/test_trust_commerce_token.py new file mode 100644 index 0000000..5c691a1 --- /dev/null +++ b/test/test_trust_commerce_token.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.trust_commerce_token import TrustCommerceToken # noqa: E501 +from billforward.rest import ApiException + + +class TestTrustCommerceToken(unittest.TestCase): + """TrustCommerceToken unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTrustCommerceToken(self): + """Test TrustCommerceToken""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.trust_commerce_token.TrustCommerceToken() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_trust_commerce_token_paged_metadata.py b/test/test_trust_commerce_token_paged_metadata.py deleted file mode 100644 index b711f5b..0000000 --- a/test/test_trust_commerce_token_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.trust_commerce_token_paged_metadata import TrustCommerceTokenPagedMetadata - - -class TestTrustCommerceTokenPagedMetadata(unittest.TestCase): - """ TrustCommerceTokenPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTrustCommerceTokenPagedMetadata(self): - """ - Test TrustCommerceTokenPagedMetadata - """ - model = billforward.models.trust_commerce_token_paged_metadata.TrustCommerceTokenPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_account.py b/test/test_typed_query_result_wrapper_account.py new file mode 100644 index 0000000..eac6145 --- /dev/null +++ b/test/test_typed_query_result_wrapper_account.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_account import TypedQueryResultWrapperAccount # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperAccount(unittest.TestCase): + """TypedQueryResultWrapperAccount unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperAccount(self): + """Test TypedQueryResultWrapperAccount""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_account.TypedQueryResultWrapperAccount() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_address.py b/test/test_typed_query_result_wrapper_address.py new file mode 100644 index 0000000..db82c51 --- /dev/null +++ b/test/test_typed_query_result_wrapper_address.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_address import TypedQueryResultWrapperAddress # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperAddress(unittest.TestCase): + """TypedQueryResultWrapperAddress unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperAddress(self): + """Test TypedQueryResultWrapperAddress""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_address.TypedQueryResultWrapperAddress() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_amendment.py b/test/test_typed_query_result_wrapper_amendment.py new file mode 100644 index 0000000..81e7f97 --- /dev/null +++ b/test/test_typed_query_result_wrapper_amendment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_amendment import TypedQueryResultWrapperAmendment # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperAmendment(unittest.TestCase): + """TypedQueryResultWrapperAmendment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperAmendment(self): + """Test TypedQueryResultWrapperAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_amendment.TypedQueryResultWrapperAmendment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_api_quote.py b/test/test_typed_query_result_wrapper_api_quote.py new file mode 100644 index 0000000..d0be7ff --- /dev/null +++ b/test/test_typed_query_result_wrapper_api_quote.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_api_quote import TypedQueryResultWrapperAPIQuote # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperAPIQuote(unittest.TestCase): + """TypedQueryResultWrapperAPIQuote unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperAPIQuote(self): + """Test TypedQueryResultWrapperAPIQuote""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_api_quote.TypedQueryResultWrapperAPIQuote() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_avatax_configuration.py b/test/test_typed_query_result_wrapper_avatax_configuration.py new file mode 100644 index 0000000..dfdca25 --- /dev/null +++ b/test/test_typed_query_result_wrapper_avatax_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_avatax_configuration import TypedQueryResultWrapperAvataxConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperAvataxConfiguration(unittest.TestCase): + """TypedQueryResultWrapperAvataxConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperAvataxConfiguration(self): + """Test TypedQueryResultWrapperAvataxConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_avatax_configuration.TypedQueryResultWrapperAvataxConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_bf_permission.py b/test/test_typed_query_result_wrapper_bf_permission.py new file mode 100644 index 0000000..9d764b9 --- /dev/null +++ b/test/test_typed_query_result_wrapper_bf_permission.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_bf_permission import TypedQueryResultWrapperBFPermission # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperBFPermission(unittest.TestCase): + """TypedQueryResultWrapperBFPermission unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperBFPermission(self): + """Test TypedQueryResultWrapperBFPermission""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_bf_permission.TypedQueryResultWrapperBFPermission() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_braintree_token.py b/test/test_typed_query_result_wrapper_braintree_token.py new file mode 100644 index 0000000..2de70cf --- /dev/null +++ b/test/test_typed_query_result_wrapper_braintree_token.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_braintree_token import TypedQueryResultWrapperBraintreeToken # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperBraintreeToken(unittest.TestCase): + """TypedQueryResultWrapperBraintreeToken unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperBraintreeToken(self): + """Test TypedQueryResultWrapperBraintreeToken""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_braintree_token.TypedQueryResultWrapperBraintreeToken() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_contract.py b/test/test_typed_query_result_wrapper_contract.py new file mode 100644 index 0000000..6407b11 --- /dev/null +++ b/test/test_typed_query_result_wrapper_contract.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_contract import TypedQueryResultWrapperContract # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperContract(unittest.TestCase): + """TypedQueryResultWrapperContract unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperContract(self): + """Test TypedQueryResultWrapperContract""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_contract.TypedQueryResultWrapperContract() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_coupon.py b/test/test_typed_query_result_wrapper_coupon.py new file mode 100644 index 0000000..4592676 --- /dev/null +++ b/test/test_typed_query_result_wrapper_coupon.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_coupon import TypedQueryResultWrapperCoupon # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperCoupon(unittest.TestCase): + """TypedQueryResultWrapperCoupon unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperCoupon(self): + """Test TypedQueryResultWrapperCoupon""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_coupon.TypedQueryResultWrapperCoupon() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_credit_note.py b/test/test_typed_query_result_wrapper_credit_note.py new file mode 100644 index 0000000..0437c74 --- /dev/null +++ b/test/test_typed_query_result_wrapper_credit_note.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_credit_note import TypedQueryResultWrapperCreditNote # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperCreditNote(unittest.TestCase): + """TypedQueryResultWrapperCreditNote unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperCreditNote(self): + """Test TypedQueryResultWrapperCreditNote""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_credit_note.TypedQueryResultWrapperCreditNote() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_data_sync_job_response.py b/test/test_typed_query_result_wrapper_data_sync_job_response.py new file mode 100644 index 0000000..2370bc8 --- /dev/null +++ b/test/test_typed_query_result_wrapper_data_sync_job_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_data_sync_job_response import TypedQueryResultWrapperDataSyncJobResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperDataSyncJobResponse(unittest.TestCase): + """TypedQueryResultWrapperDataSyncJobResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperDataSyncJobResponse(self): + """Test TypedQueryResultWrapperDataSyncJobResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_data_sync_job_response.TypedQueryResultWrapperDataSyncJobResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_dunning_line.py b/test/test_typed_query_result_wrapper_dunning_line.py new file mode 100644 index 0000000..5d90ef2 --- /dev/null +++ b/test/test_typed_query_result_wrapper_dunning_line.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_dunning_line import TypedQueryResultWrapperDunningLine # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperDunningLine(unittest.TestCase): + """TypedQueryResultWrapperDunningLine unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperDunningLine(self): + """Test TypedQueryResultWrapperDunningLine""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_dunning_line.TypedQueryResultWrapperDunningLine() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_invoice.py b/test/test_typed_query_result_wrapper_invoice.py new file mode 100644 index 0000000..4705ee3 --- /dev/null +++ b/test/test_typed_query_result_wrapper_invoice.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_invoice import TypedQueryResultWrapperInvoice # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperInvoice(unittest.TestCase): + """TypedQueryResultWrapperInvoice unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperInvoice(self): + """Test TypedQueryResultWrapperInvoice""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_invoice.TypedQueryResultWrapperInvoice() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_invoice_line_payment.py b/test/test_typed_query_result_wrapper_invoice_line_payment.py new file mode 100644 index 0000000..a00f5f0 --- /dev/null +++ b/test/test_typed_query_result_wrapper_invoice_line_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_invoice_line_payment import TypedQueryResultWrapperInvoiceLinePayment # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperInvoiceLinePayment(unittest.TestCase): + """TypedQueryResultWrapperInvoiceLinePayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperInvoiceLinePayment(self): + """Test TypedQueryResultWrapperInvoiceLinePayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_invoice_line_payment.TypedQueryResultWrapperInvoiceLinePayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_notification.py b/test/test_typed_query_result_wrapper_notification.py new file mode 100644 index 0000000..0937cf9 --- /dev/null +++ b/test/test_typed_query_result_wrapper_notification.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_notification import TypedQueryResultWrapperNotification # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperNotification(unittest.TestCase): + """TypedQueryResultWrapperNotification unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperNotification(self): + """Test TypedQueryResultWrapperNotification""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_notification.TypedQueryResultWrapperNotification() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_payment.py b/test/test_typed_query_result_wrapper_payment.py new file mode 100644 index 0000000..5b46707 --- /dev/null +++ b/test/test_typed_query_result_wrapper_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_payment import TypedQueryResultWrapperPayment # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperPayment(unittest.TestCase): + """TypedQueryResultWrapperPayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperPayment(self): + """Test TypedQueryResultWrapperPayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_payment.TypedQueryResultWrapperPayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_payment_method.py b/test/test_typed_query_result_wrapper_payment_method.py new file mode 100644 index 0000000..7b0a36d --- /dev/null +++ b/test/test_typed_query_result_wrapper_payment_method.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_payment_method import TypedQueryResultWrapperPaymentMethod # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperPaymentMethod(unittest.TestCase): + """TypedQueryResultWrapperPaymentMethod unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperPaymentMethod(self): + """Test TypedQueryResultWrapperPaymentMethod""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_payment_method.TypedQueryResultWrapperPaymentMethod() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_plan_response.py b/test/test_typed_query_result_wrapper_plan_response.py new file mode 100644 index 0000000..6574075 --- /dev/null +++ b/test/test_typed_query_result_wrapper_plan_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_plan_response import TypedQueryResultWrapperPlanResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperPlanResponse(unittest.TestCase): + """TypedQueryResultWrapperPlanResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperPlanResponse(self): + """Test TypedQueryResultWrapperPlanResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_plan_response.TypedQueryResultWrapperPlanResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_profile.py b/test/test_typed_query_result_wrapper_profile.py new file mode 100644 index 0000000..a64c64a --- /dev/null +++ b/test/test_typed_query_result_wrapper_profile.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_profile import TypedQueryResultWrapperProfile # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperProfile(unittest.TestCase): + """TypedQueryResultWrapperProfile unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperProfile(self): + """Test TypedQueryResultWrapperProfile""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_profile.TypedQueryResultWrapperProfile() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_receipt.py b/test/test_typed_query_result_wrapper_receipt.py new file mode 100644 index 0000000..0429041 --- /dev/null +++ b/test/test_typed_query_result_wrapper_receipt.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_receipt import TypedQueryResultWrapperReceipt # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperReceipt(unittest.TestCase): + """TypedQueryResultWrapperReceipt unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperReceipt(self): + """Test TypedQueryResultWrapperReceipt""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_receipt.TypedQueryResultWrapperReceipt() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_refund.py b/test/test_typed_query_result_wrapper_refund.py new file mode 100644 index 0000000..3049dea --- /dev/null +++ b/test/test_typed_query_result_wrapper_refund.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_refund import TypedQueryResultWrapperRefund # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperRefund(unittest.TestCase): + """TypedQueryResultWrapperRefund unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperRefund(self): + """Test TypedQueryResultWrapperRefund""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_refund.TypedQueryResultWrapperRefund() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_revenue_attribution.py b/test/test_typed_query_result_wrapper_revenue_attribution.py new file mode 100644 index 0000000..ffd31ba --- /dev/null +++ b/test/test_typed_query_result_wrapper_revenue_attribution.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_revenue_attribution import TypedQueryResultWrapperRevenueAttribution # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperRevenueAttribution(unittest.TestCase): + """TypedQueryResultWrapperRevenueAttribution unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperRevenueAttribution(self): + """Test TypedQueryResultWrapperRevenueAttribution""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_revenue_attribution.TypedQueryResultWrapperRevenueAttribution() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_role.py b/test/test_typed_query_result_wrapper_role.py new file mode 100644 index 0000000..d8cd804 --- /dev/null +++ b/test/test_typed_query_result_wrapper_role.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_role import TypedQueryResultWrapperRole # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperRole(unittest.TestCase): + """TypedQueryResultWrapperRole unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperRole(self): + """Test TypedQueryResultWrapperRole""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_role.TypedQueryResultWrapperRole() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_stripe_ach_token.py b/test/test_typed_query_result_wrapper_stripe_ach_token.py new file mode 100644 index 0000000..a7f629a --- /dev/null +++ b/test/test_typed_query_result_wrapper_stripe_ach_token.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_stripe_ach_token import TypedQueryResultWrapperStripeACHToken # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperStripeACHToken(unittest.TestCase): + """TypedQueryResultWrapperStripeACHToken unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperStripeACHToken(self): + """Test TypedQueryResultWrapperStripeACHToken""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_stripe_ach_token.TypedQueryResultWrapperStripeACHToken() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_stripe_token.py b/test/test_typed_query_result_wrapper_stripe_token.py new file mode 100644 index 0000000..ed0e49c --- /dev/null +++ b/test/test_typed_query_result_wrapper_stripe_token.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_stripe_token import TypedQueryResultWrapperStripeToken # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperStripeToken(unittest.TestCase): + """TypedQueryResultWrapperStripeToken unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperStripeToken(self): + """Test TypedQueryResultWrapperStripeToken""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_stripe_token.TypedQueryResultWrapperStripeToken() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_subscription.py b/test/test_typed_query_result_wrapper_subscription.py new file mode 100644 index 0000000..433cc05 --- /dev/null +++ b/test/test_typed_query_result_wrapper_subscription.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_subscription import TypedQueryResultWrapperSubscription # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperSubscription(unittest.TestCase): + """TypedQueryResultWrapperSubscription unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperSubscription(self): + """Test TypedQueryResultWrapperSubscription""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_subscription.TypedQueryResultWrapperSubscription() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_subscription_charge.py b/test/test_typed_query_result_wrapper_subscription_charge.py new file mode 100644 index 0000000..e18eb63 --- /dev/null +++ b/test/test_typed_query_result_wrapper_subscription_charge.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_subscription_charge import TypedQueryResultWrapperSubscriptionCharge # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperSubscriptionCharge(unittest.TestCase): + """TypedQueryResultWrapperSubscriptionCharge unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperSubscriptionCharge(self): + """Test TypedQueryResultWrapperSubscriptionCharge""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_subscription_charge.TypedQueryResultWrapperSubscriptionCharge() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_taxation_strategy.py b/test/test_typed_query_result_wrapper_taxation_strategy.py new file mode 100644 index 0000000..2e7c941 --- /dev/null +++ b/test/test_typed_query_result_wrapper_taxation_strategy.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_taxation_strategy import TypedQueryResultWrapperTaxationStrategy # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperTaxationStrategy(unittest.TestCase): + """TypedQueryResultWrapperTaxationStrategy unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperTaxationStrategy(self): + """Test TypedQueryResultWrapperTaxationStrategy""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_taxation_strategy.TypedQueryResultWrapperTaxationStrategy() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_user_response.py b/test/test_typed_query_result_wrapper_user_response.py new file mode 100644 index 0000000..8fa49fc --- /dev/null +++ b/test/test_typed_query_result_wrapper_user_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_user_response import TypedQueryResultWrapperUserResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperUserResponse(unittest.TestCase): + """TypedQueryResultWrapperUserResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperUserResponse(self): + """Test TypedQueryResultWrapperUserResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_user_response.TypedQueryResultWrapperUserResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_typed_query_result_wrapper_webhook.py b/test/test_typed_query_result_wrapper_webhook.py new file mode 100644 index 0000000..afdef06 --- /dev/null +++ b/test/test_typed_query_result_wrapper_webhook.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.typed_query_result_wrapper_webhook import TypedQueryResultWrapperWebhook # noqa: E501 +from billforward.rest import ApiException + + +class TestTypedQueryResultWrapperWebhook(unittest.TestCase): + """TypedQueryResultWrapperWebhook unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTypedQueryResultWrapperWebhook(self): + """Test TypedQueryResultWrapperWebhook""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.typed_query_result_wrapper_webhook.TypedQueryResultWrapperWebhook() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_unit_discount.py b/test/test_unit_discount.py deleted file mode 100644 index cab9ea4..0000000 --- a/test/test_unit_discount.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.unit_discount import UnitDiscount - - -class TestUnitDiscount(unittest.TestCase): - """ UnitDiscount unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUnitDiscount(self): - """ - Test UnitDiscount - """ - model = billforward.models.unit_discount.UnitDiscount() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_unit_of_measure.py b/test/test_unit_of_measure.py index 45be329..bedff40 100644 --- a/test/test_unit_of_measure.py +++ b/test/test_unit_of_measure.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.unit_of_measure import UnitOfMeasure # noqa: E501 from billforward.rest import ApiException -from billforward.models.unit_of_measure import UnitOfMeasure class TestUnitOfMeasure(unittest.TestCase): - """ UnitOfMeasure unit test stubs """ + """UnitOfMeasure unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testUnitOfMeasure(self): - """ - Test UnitOfMeasure - """ - model = billforward.models.unit_of_measure.UnitOfMeasure() + """Test UnitOfMeasure""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.unit_of_measure.UnitOfMeasure() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_unit_of_measure_coupon_modifier.py b/test/test_unit_of_measure_coupon_modifier.py deleted file mode 100644 index 130bdbc..0000000 --- a/test/test_unit_of_measure_coupon_modifier.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.unit_of_measure_coupon_modifier import UnitOfMeasureCouponModifier - - -class TestUnitOfMeasureCouponModifier(unittest.TestCase): - """ UnitOfMeasureCouponModifier unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUnitOfMeasureCouponModifier(self): - """ - Test UnitOfMeasureCouponModifier - """ - model = billforward.models.unit_of_measure_coupon_modifier.UnitOfMeasureCouponModifier() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_unit_of_measure_paged_metadata.py b/test/test_unit_of_measure_paged_metadata.py deleted file mode 100644 index fb87718..0000000 --- a/test/test_unit_of_measure_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.unit_of_measure_paged_metadata import UnitOfMeasurePagedMetadata - - -class TestUnitOfMeasurePagedMetadata(unittest.TestCase): - """ UnitOfMeasurePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUnitOfMeasurePagedMetadata(self): - """ - Test UnitOfMeasurePagedMetadata - """ - model = billforward.models.unit_of_measure_paged_metadata.UnitOfMeasurePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_unitofmeasure_api.py b/test/test_unitofmeasure_api.py deleted file mode 100644 index a9291f6..0000000 --- a/test/test_unitofmeasure_api.py +++ /dev/null @@ -1,78 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.unitofmeasure_api import UnitofmeasureApi - - -class TestUnitofmeasureApi(unittest.TestCase): - """ UnitofmeasureApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.unitofmeasure_api.UnitofmeasureApi() - - def tearDown(self): - pass - - def test_create_unit_of_measure(self): - """ - Test case for create_unit_of_measure - - Create a unit-of-measure. - """ - pass - - def test_get_all_units_of_measure(self): - """ - Test case for get_all_units_of_measure - - Returns a collection of all unit-of-measure objects. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_unit_of_measure_by_id(self): - """ - Test case for get_unit_of_measure_by_id - - Returns a single unit-of-measure corresponding to the unique id or name specified. - """ - pass - - def test_update_unit_of_measure(self): - """ - Test case for update_unit_of_measure - - Update a unit-of-measure. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_address_request.py b/test/test_update_address_request.py deleted file mode 100644 index ae59019..0000000 --- a/test/test_update_address_request.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.update_address_request import UpdateAddressRequest - - -class TestUpdateAddressRequest(unittest.TestCase): - """ UpdateAddressRequest unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdateAddressRequest(self): - """ - Test UpdateAddressRequest - """ - model = billforward.models.update_address_request.UpdateAddressRequest() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_component_value_amendment.py b/test/test_update_component_value_amendment.py index 55952db..93e1041 100644 --- a/test/test_update_component_value_amendment.py +++ b/test/test_update_component_value_amendment.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.update_component_value_amendment import UpdateComponentValueAmendment # noqa: E501 from billforward.rest import ApiException -from billforward.models.update_component_value_amendment import UpdateComponentValueAmendment class TestUpdateComponentValueAmendment(unittest.TestCase): - """ UpdateComponentValueAmendment unit test stubs """ + """UpdateComponentValueAmendment unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testUpdateComponentValueAmendment(self): - """ - Test UpdateComponentValueAmendment - """ - model = billforward.models.update_component_value_amendment.UpdateComponentValueAmendment() + """Test UpdateComponentValueAmendment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_component_value_amendment.UpdateComponentValueAmendment() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_update_contract_request.py b/test/test_update_contract_request.py new file mode 100644 index 0000000..59f1eac --- /dev/null +++ b/test/test_update_contract_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.update_contract_request import UpdateContractRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestUpdateContractRequest(unittest.TestCase): + """UpdateContractRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateContractRequest(self): + """Test UpdateContractRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_contract_request.UpdateContractRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_email_request.py b/test/test_update_email_request.py new file mode 100644 index 0000000..25020d9 --- /dev/null +++ b/test/test_update_email_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.update_email_request import UpdateEmailRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestUpdateEmailRequest(unittest.TestCase): + """UpdateEmailRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateEmailRequest(self): + """Test UpdateEmailRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_email_request.UpdateEmailRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_invoice_request.py b/test/test_update_invoice_request.py new file mode 100644 index 0000000..ce7e23b --- /dev/null +++ b/test/test_update_invoice_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.update_invoice_request import UpdateInvoiceRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestUpdateInvoiceRequest(unittest.TestCase): + """UpdateInvoiceRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateInvoiceRequest(self): + """Test UpdateInvoiceRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_invoice_request.UpdateInvoiceRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_invoice_template_request.py b/test/test_update_invoice_template_request.py new file mode 100644 index 0000000..639715c --- /dev/null +++ b/test/test_update_invoice_template_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.update_invoice_template_request import UpdateInvoiceTemplateRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestUpdateInvoiceTemplateRequest(unittest.TestCase): + """UpdateInvoiceTemplateRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateInvoiceTemplateRequest(self): + """Test UpdateInvoiceTemplateRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_invoice_template_request.UpdateInvoiceTemplateRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_password_request.py b/test/test_update_password_request.py new file mode 100644 index 0000000..a59d84d --- /dev/null +++ b/test/test_update_password_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.update_password_request import UpdatePasswordRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestUpdatePasswordRequest(unittest.TestCase): + """UpdatePasswordRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdatePasswordRequest(self): + """Test UpdatePasswordRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_password_request.UpdatePasswordRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_password_response.py b/test/test_update_password_response.py new file mode 100644 index 0000000..5904b9e --- /dev/null +++ b/test/test_update_password_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.update_password_response import UpdatePasswordResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestUpdatePasswordResponse(unittest.TestCase): + """UpdatePasswordResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdatePasswordResponse(self): + """Test UpdatePasswordResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_password_response.UpdatePasswordResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_pricing_component_value_change_result.py b/test/test_update_pricing_component_value_change_result.py new file mode 100644 index 0000000..8909e4a --- /dev/null +++ b/test/test_update_pricing_component_value_change_result.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.update_pricing_component_value_change_result import UpdatePricingComponentValueChangeResult # noqa: E501 +from billforward.rest import ApiException + + +class TestUpdatePricingComponentValueChangeResult(unittest.TestCase): + """UpdatePricingComponentValueChangeResult unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdatePricingComponentValueChangeResult(self): + """Test UpdatePricingComponentValueChangeResult""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_pricing_component_value_change_result.UpdatePricingComponentValueChangeResult() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_pricing_component_value_request.py b/test/test_update_pricing_component_value_request.py new file mode 100644 index 0000000..04cc5ff --- /dev/null +++ b/test/test_update_pricing_component_value_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.update_pricing_component_value_request import UpdatePricingComponentValueRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestUpdatePricingComponentValueRequest(unittest.TestCase): + """UpdatePricingComponentValueRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdatePricingComponentValueRequest(self): + """Test UpdatePricingComponentValueRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_pricing_component_value_request.UpdatePricingComponentValueRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_pricing_component_value_response.py b/test/test_update_pricing_component_value_response.py new file mode 100644 index 0000000..5831ec8 --- /dev/null +++ b/test/test_update_pricing_component_value_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.update_pricing_component_value_response import UpdatePricingComponentValueResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestUpdatePricingComponentValueResponse(unittest.TestCase): + """UpdatePricingComponentValueResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdatePricingComponentValueResponse(self): + """Test UpdatePricingComponentValueResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_pricing_component_value_response.UpdatePricingComponentValueResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_profile_request.py b/test/test_update_profile_request.py deleted file mode 100644 index d4b1dd7..0000000 --- a/test/test_update_profile_request.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.update_profile_request import UpdateProfileRequest - - -class TestUpdateProfileRequest(unittest.TestCase): - """ UpdateProfileRequest unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdateProfileRequest(self): - """ - Test UpdateProfileRequest - """ - model = billforward.models.update_profile_request.UpdateProfileRequest() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_rate_plan_affiliate_request.py b/test/test_update_rate_plan_affiliate_request.py new file mode 100644 index 0000000..56b79e2 --- /dev/null +++ b/test/test_update_rate_plan_affiliate_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.update_rate_plan_affiliate_request import UpdateRatePlanAffiliateRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestUpdateRatePlanAffiliateRequest(unittest.TestCase): + """UpdateRatePlanAffiliateRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateRatePlanAffiliateRequest(self): + """Test UpdateRatePlanAffiliateRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_rate_plan_affiliate_request.UpdateRatePlanAffiliateRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_role_request.py b/test/test_update_role_request.py index ada6c97..1b37865 100644 --- a/test/test_update_role_request.py +++ b/test/test_update_role_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.update_role_request import UpdateRoleRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.update_role_request import UpdateRoleRequest class TestUpdateRoleRequest(unittest.TestCase): - """ UpdateRoleRequest unit test stubs """ + """UpdateRoleRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testUpdateRoleRequest(self): - """ - Test UpdateRoleRequest - """ - model = billforward.models.update_role_request.UpdateRoleRequest() + """Test UpdateRoleRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_role_request.UpdateRoleRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_update_salesforce_configuration_request.py b/test/test_update_salesforce_configuration_request.py new file mode 100644 index 0000000..dcc691a --- /dev/null +++ b/test/test_update_salesforce_configuration_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.update_salesforce_configuration_request import UpdateSalesforceConfigurationRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestUpdateSalesforceConfigurationRequest(unittest.TestCase): + """UpdateSalesforceConfigurationRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateSalesforceConfigurationRequest(self): + """Test UpdateSalesforceConfigurationRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_salesforce_configuration_request.UpdateSalesforceConfigurationRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_update_subscription_request.py b/test/test_update_subscription_request.py index b7fe3e7..748958e 100644 --- a/test/test_update_subscription_request.py +++ b/test/test_update_subscription_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.update_subscription_request import UpdateSubscriptionRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.update_subscription_request import UpdateSubscriptionRequest class TestUpdateSubscriptionRequest(unittest.TestCase): - """ UpdateSubscriptionRequest unit test stubs """ + """UpdateSubscriptionRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testUpdateSubscriptionRequest(self): - """ - Test UpdateSubscriptionRequest - """ - model = billforward.models.update_subscription_request.UpdateSubscriptionRequest() + """Test UpdateSubscriptionRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_subscription_request.UpdateSubscriptionRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_update_user_info_request.py b/test/test_update_user_info_request.py new file mode 100644 index 0000000..be61e3f --- /dev/null +++ b/test/test_update_user_info_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.update_user_info_request import UpdateUserInfoRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestUpdateUserInfoRequest(unittest.TestCase): + """UpdateUserInfoRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateUserInfoRequest(self): + """Test UpdateUserInfoRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.update_user_info_request.UpdateUserInfoRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_upgrade_charge.py b/test/test_upgrade_charge.py new file mode 100644 index 0000000..c41df6a --- /dev/null +++ b/test/test_upgrade_charge.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.upgrade_charge import UpgradeCharge # noqa: E501 +from billforward.rest import ApiException + + +class TestUpgradeCharge(unittest.TestCase): + """UpgradeCharge unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpgradeCharge(self): + """Test UpgradeCharge""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.upgrade_charge.UpgradeCharge() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_usage.py b/test/test_usage.py deleted file mode 100644 index a604571..0000000 --- a/test/test_usage.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.usage import Usage - - -class TestUsage(unittest.TestCase): - """ Usage unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUsage(self): - """ - Test Usage - """ - model = billforward.models.usage.Usage() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_usage_api.py b/test/test_usage_api.py deleted file mode 100644 index ebb118a..0000000 --- a/test/test_usage_api.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.usage_api import UsageApi - - -class TestUsageApi(unittest.TestCase): - """ UsageApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.usage_api.UsageApi() - - def tearDown(self): - pass - - def test_create_usage_instance(self): - """ - Test case for create_usage_instance - - Add usage - """ - pass - - def test_get_usage_by_id(self): - """ - Test case for get_usage_by_id - - Retrieve by subscription and period - """ - pass - - def test_get_usage_by_subscription_id(self): - """ - Test case for get_usage_by_subscription_id - - Retrieve by subscription - """ - pass - - def test_get_usage_by_subscription_id_uo_m_period_and_usage_type(self): - """ - Test case for get_usage_by_subscription_id_uo_m_period_and_usage_type - - Retrieve by subscription, period and type - """ - pass - - def test_update_usage_instance(self): - """ - Test case for update_usage_instance - - Update usage - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_usage_paged_metadata.py b/test/test_usage_paged_metadata.py deleted file mode 100644 index 44da765..0000000 --- a/test/test_usage_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.usage_paged_metadata import UsagePagedMetadata - - -class TestUsagePagedMetadata(unittest.TestCase): - """ UsagePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUsagePagedMetadata(self): - """ - Test UsagePagedMetadata - """ - model = billforward.models.usage_paged_metadata.UsagePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_usage_period_paged_metadata.py b/test/test_usage_period_paged_metadata.py deleted file mode 100644 index 76569b4..0000000 --- a/test/test_usage_period_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.usage_period_paged_metadata import UsagePeriodPagedMetadata - - -class TestUsagePeriodPagedMetadata(unittest.TestCase): - """ UsagePeriodPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUsagePeriodPagedMetadata(self): - """ - Test UsagePeriodPagedMetadata - """ - model = billforward.models.usage_period_paged_metadata.UsagePeriodPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_usage_pricing_components_by_charge_model.py b/test/test_usage_pricing_components_by_charge_model.py new file mode 100644 index 0000000..a485745 --- /dev/null +++ b/test/test_usage_pricing_components_by_charge_model.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.usage_pricing_components_by_charge_model import UsagePricingComponentsByChargeModel # noqa: E501 +from billforward.rest import ApiException + + +class TestUsagePricingComponentsByChargeModel(unittest.TestCase): + """UsagePricingComponentsByChargeModel unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUsagePricingComponentsByChargeModel(self): + """Test UsagePricingComponentsByChargeModel""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.usage_pricing_components_by_charge_model.UsagePricingComponentsByChargeModel() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_usage_rounding_strategy_paged_metadata.py b/test/test_usage_rounding_strategy_paged_metadata.py deleted file mode 100644 index d7aa8ea..0000000 --- a/test/test_usage_rounding_strategy_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.usage_rounding_strategy_paged_metadata import UsageRoundingStrategyPagedMetadata - - -class TestUsageRoundingStrategyPagedMetadata(unittest.TestCase): - """ UsageRoundingStrategyPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUsageRoundingStrategyPagedMetadata(self): - """ - Test UsageRoundingStrategyPagedMetadata - """ - model = billforward.models.usage_rounding_strategy_paged_metadata.UsageRoundingStrategyPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_usage_session.py b/test/test_usage_session.py deleted file mode 100644 index 5f5e651..0000000 --- a/test/test_usage_session.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.usage_session import UsageSession - - -class TestUsageSession(unittest.TestCase): - """ UsageSession unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUsageSession(self): - """ - Test UsageSession - """ - model = billforward.models.usage_session.UsageSession() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_usage_session_paged_metadata.py b/test/test_usage_session_paged_metadata.py deleted file mode 100644 index e752e34..0000000 --- a/test/test_usage_session_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.usage_session_paged_metadata import UsageSessionPagedMetadata - - -class TestUsageSessionPagedMetadata(unittest.TestCase): - """ UsageSessionPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUsageSessionPagedMetadata(self): - """ - Test UsageSessionPagedMetadata - """ - model = billforward.models.usage_session_paged_metadata.UsageSessionPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_usageperiods_api.py b/test/test_usageperiods_api.py deleted file mode 100644 index 95b49cd..0000000 --- a/test/test_usageperiods_api.py +++ /dev/null @@ -1,70 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.usageperiods_api import UsageperiodsApi - - -class TestUsageperiodsApi(unittest.TestCase): - """ UsageperiodsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.usageperiods_api.UsageperiodsApi() - - def tearDown(self): - pass - - def test_get_usage_period(self): - """ - Test case for get_usage_period - - Retrieve by subscription and period - """ - pass - - def test_get_usage_period_for_all(self): - """ - Test case for get_usage_period_for_all - - Retrieve by subscription - """ - pass - - def test_get_usage_period_for_invoice(self): - """ - Test case for get_usage_period_for_invoice - - Retrieve by invoice) - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_usageroundingstrategies_api.py b/test/test_usageroundingstrategies_api.py deleted file mode 100644 index f8358c0..0000000 --- a/test/test_usageroundingstrategies_api.py +++ /dev/null @@ -1,78 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.usageroundingstrategies_api import UsageroundingstrategiesApi - - -class TestUsageroundingstrategiesApi(unittest.TestCase): - """ UsageroundingstrategiesApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.usageroundingstrategies_api.UsageroundingstrategiesApi() - - def tearDown(self): - pass - - def test_create_usage_rounding_strategy(self): - """ - Test case for create_usage_rounding_strategy - - Create a new rounding strategy - """ - pass - - def test_get_usage_rounding_strategy_by_id(self): - """ - Test case for get_usage_rounding_strategy_by_id - - Returns a collection of usage-rounding-strategies, specified by the usage-rounding-strategies-id parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_usage_rounding_strategy_by_pricing_component_id(self): - """ - Test case for get_usage_rounding_strategy_by_pricing_component_id - - Returns a collection of usage-rounding-strategies, specified by the pricing-component-ID parameter. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_update_usage_rounding_strategy(self): - """ - Test case for update_usage_rounding_strategy - - Update a rounding strategy - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_usagesessions_api.py b/test/test_usagesessions_api.py deleted file mode 100644 index c4d5896..0000000 --- a/test/test_usagesessions_api.py +++ /dev/null @@ -1,78 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.usagesessions_api import UsagesessionsApi - - -class TestUsagesessionsApi(unittest.TestCase): - """ UsagesessionsApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.usagesessions_api.UsagesessionsApi() - - def tearDown(self): - pass - - def test_get_active_sessions_for_subscription(self): - """ - Test case for get_active_sessions_for_subscription - - Get active by subscription - """ - pass - - def test_get_usage_list_for_usage_session(self): - """ - Test case for get_usage_list_for_usage_session - - Retrieve by subscription - """ - pass - - def test_start_usage_session(self): - """ - Test case for start_usage_session - - Start a new session - """ - pass - - def test_stop_usage_session(self): - """ - Test case for stop_usage_session - - Stop a specified session - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_user.py b/test/test_user.py index 6a7b6d6..4145164 100644 --- a/test/test_user.py +++ b/test/test_user.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.user import User # noqa: E501 from billforward.rest import ApiException -from billforward.models.user import User class TestUser(unittest.TestCase): - """ User unit test stubs """ + """User unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testUser(self): - """ - Test User - """ - model = billforward.models.user.User() + """Test User""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.user.User() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_user_create_request.py b/test/test_user_create_request.py new file mode 100644 index 0000000..878abd7 --- /dev/null +++ b/test/test_user_create_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.user_create_request import UserCreateRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestUserCreateRequest(unittest.TestCase): + """UserCreateRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUserCreateRequest(self): + """Test UserCreateRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.user_create_request.UserCreateRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_user_creation_request.py b/test/test_user_creation_request.py index 15fda50..4864a54 100644 --- a/test/test_user_creation_request.py +++ b/test/test_user_creation_request.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.user_creation_request import UserCreationRequest # noqa: E501 from billforward.rest import ApiException -from billforward.models.user_creation_request import UserCreationRequest class TestUserCreationRequest(unittest.TestCase): - """ UserCreationRequest unit test stubs """ + """UserCreationRequest unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testUserCreationRequest(self): - """ - Test UserCreationRequest - """ - model = billforward.models.user_creation_request.UserCreationRequest() + """Test UserCreationRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.user_creation_request.UserCreationRequest() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_user_creation_response.py b/test/test_user_creation_response.py new file mode 100644 index 0000000..545c017 --- /dev/null +++ b/test/test_user_creation_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.user_creation_response import UserCreationResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestUserCreationResponse(unittest.TestCase): + """UserCreationResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUserCreationResponse(self): + """Test UserCreationResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.user_creation_response.UserCreationResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_user_creation_response_paged_metadata.py b/test/test_user_creation_response_paged_metadata.py deleted file mode 100644 index cb80d7e..0000000 --- a/test/test_user_creation_response_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.user_creation_response_paged_metadata import UserCreationResponsePagedMetadata - - -class TestUserCreationResponsePagedMetadata(unittest.TestCase): - """ UserCreationResponsePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUserCreationResponsePagedMetadata(self): - """ - Test UserCreationResponsePagedMetadata - """ - model = billforward.models.user_creation_response_paged_metadata.UserCreationResponsePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_user_invite_request.py b/test/test_user_invite_request.py new file mode 100644 index 0000000..d7846bf --- /dev/null +++ b/test/test_user_invite_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.user_invite_request import UserInviteRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestUserInviteRequest(unittest.TestCase): + """UserInviteRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUserInviteRequest(self): + """Test UserInviteRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.user_invite_request.UserInviteRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_user_paged_metadata.py b/test/test_user_paged_metadata.py deleted file mode 100644 index 82d3c67..0000000 --- a/test/test_user_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.user_paged_metadata import UserPagedMetadata - - -class TestUserPagedMetadata(unittest.TestCase): - """ UserPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUserPagedMetadata(self): - """ - Test UserPagedMetadata - """ - model = billforward.models.user_paged_metadata.UserPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_user_private_permanent_token_refresh_request.py b/test/test_user_private_permanent_token_refresh_request.py new file mode 100644 index 0000000..b7c0571 --- /dev/null +++ b/test/test_user_private_permanent_token_refresh_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.user_private_permanent_token_refresh_request import UserPrivatePermanentTokenRefreshRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestUserPrivatePermanentTokenRefreshRequest(unittest.TestCase): + """UserPrivatePermanentTokenRefreshRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUserPrivatePermanentTokenRefreshRequest(self): + """Test UserPrivatePermanentTokenRefreshRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.user_private_permanent_token_refresh_request.UserPrivatePermanentTokenRefreshRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_user_private_permanent_token_request.py b/test/test_user_private_permanent_token_request.py new file mode 100644 index 0000000..486284a --- /dev/null +++ b/test/test_user_private_permanent_token_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.user_private_permanent_token_request import UserPrivatePermanentTokenRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestUserPrivatePermanentTokenRequest(unittest.TestCase): + """UserPrivatePermanentTokenRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUserPrivatePermanentTokenRequest(self): + """Test UserPrivatePermanentTokenRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.user_private_permanent_token_request.UserPrivatePermanentTokenRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_user_response.py b/test/test_user_response.py new file mode 100644 index 0000000..5881366 --- /dev/null +++ b/test/test_user_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.user_response import UserResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestUserResponse(unittest.TestCase): + """UserResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUserResponse(self): + """Test UserResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.user_response.UserResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_user_timezone.py b/test/test_user_timezone.py new file mode 100644 index 0000000..f3db644 --- /dev/null +++ b/test/test_user_timezone.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.user_timezone import UserTimezone # noqa: E501 +from billforward.rest import ApiException + + +class TestUserTimezone(unittest.TestCase): + """UserTimezone unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUserTimezone(self): + """Test UserTimezone""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.user_timezone.UserTimezone() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_username.py b/test/test_username.py index 5df6cff..77dfa61 100644 --- a/test/test_username.py +++ b/test/test_username.py @@ -1,39 +1,26 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.models.username import Username # noqa: E501 from billforward.rest import ApiException -from billforward.models.username import Username class TestUsername(unittest.TestCase): - """ Username unit test stubs """ + """Username unit test stubs""" def setUp(self): pass @@ -42,10 +29,10 @@ def tearDown(self): pass def testUsername(self): - """ - Test Username - """ - model = billforward.models.username.Username() + """Test Username""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.username.Username() # noqa: E501 + pass if __name__ == '__main__': diff --git a/test/test_username_paged_metadata.py b/test/test_username_paged_metadata.py deleted file mode 100644 index 32f9294..0000000 --- a/test/test_username_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.username_paged_metadata import UsernamePagedMetadata - - -class TestUsernamePagedMetadata(unittest.TestCase): - """ UsernamePagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUsernamePagedMetadata(self): - """ - Test UsernamePagedMetadata - """ - model = billforward.models.username_paged_metadata.UsernamePagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_username_response.py b/test/test_username_response.py new file mode 100644 index 0000000..017c2c7 --- /dev/null +++ b/test/test_username_response.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.username_response import UsernameResponse # noqa: E501 +from billforward.rest import ApiException + + +class TestUsernameResponse(unittest.TestCase): + """UsernameResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUsernameResponse(self): + """Test UsernameResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.username_response.UsernameResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_usernames_api.py b/test/test_usernames_api.py deleted file mode 100644 index 705819b..0000000 --- a/test/test_usernames_api.py +++ /dev/null @@ -1,54 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.usernames_api import UsernamesApi - - -class TestUsernamesApi(unittest.TestCase): - """ UsernamesApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.usernames_api.UsernamesApi() - - def tearDown(self): - pass - - def test_create_username(self): - """ - Test case for create_username - - Create a username. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_users_api.py b/test/test_users_api.py deleted file mode 100644 index 1925226..0000000 --- a/test/test_users_api.py +++ /dev/null @@ -1,134 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.users_api import UsersApi - - -class TestUsersApi(unittest.TestCase): - """ UsersApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.users_api.UsersApi() - - def tearDown(self): - pass - - def test_create_user(self): - """ - Test case for create_user - - Create a user. - """ - pass - - def test_create_user_login(self): - """ - Test case for create_user_login - - Create a user. - """ - pass - - def test_get_all_users(self): - """ - Test case for get_all_users - - Returns a collection of Users. By default 10 values are returned. Records are returned in natural order. - """ - pass - - def test_get_user_by_id(self): - """ - Test case for get_user_by_id - - Returns a single User, specified by the ID parameter. - """ - pass - - def test_get_user_by_password_reset_code(self): - """ - Test case for get_user_by_password_reset_code - - Returns a single User, specified by the password-reset-code parameter. - """ - pass - - def test_get_user_by_sms_password_reset_code(self): - """ - Test case for get_user_by_sms_password_reset_code - - Returns a single User, specified by the sms-password-reset-code parameter. - """ - pass - - def test_get_user_by_username(self): - """ - Test case for get_user_by_username - - Returns a single User, specified by the username parameter, this is by default the e-mail address of the user. - """ - pass - - def test_reset_user_password(self): - """ - Test case for reset_user_password - - Create a password reset request. - """ - pass - - def test_retire_user(self): - """ - Test case for retire_user - - Retires the user with the specified user-ID. - """ - pass - - def test_update_user(self): - """ - Test case for update_user - - Update a user. - """ - pass - - def test_update_user_password(self): - """ - Test case for update_user_password - - Update a user's password. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_value_increment.py b/test/test_value_increment.py new file mode 100644 index 0000000..c625959 --- /dev/null +++ b/test/test_value_increment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.value_increment import ValueIncrement # noqa: E501 +from billforward.rest import ApiException + + +class TestValueIncrement(unittest.TestCase): + """ValueIncrement unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testValueIncrement(self): + """Test ValueIncrement""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.value_increment.ValueIncrement() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_vaultedgateways_api.py b/test/test_vaultedgateways_api.py deleted file mode 100644 index b4b5175..0000000 --- a/test/test_vaultedgateways_api.py +++ /dev/null @@ -1,150 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.apis.vaultedgateways_api import VaultedgatewaysApi - - -class TestVaultedgatewaysApi(unittest.TestCase): - """ VaultedgatewaysApi unit test stubs """ - - def setUp(self): - self.api = billforward.apis.vaultedgateways_api.VaultedgatewaysApi() - - def tearDown(self): - pass - - def test_create_authorize_net_token(self): - """ - Test case for create_authorize_net_token - - Create an authorize-net-token. - """ - pass - - def test_create_braintree_token(self): - """ - Test case for create_braintree_token - - Create a braintree-token. - """ - pass - - def test_create_stripe_ach_token(self): - """ - Test case for create_stripe_ach_token - - Create a stripe-ACH-token. - """ - pass - - def test_create_stripe_token(self): - """ - Test case for create_stripe_token - - Create a stripe-token. - """ - pass - - def test_create_trust_commerce_token(self): - """ - Test case for create_trust_commerce_token - - Create a trust-commerce-token. - """ - pass - - def test_get_braintree_by_account_id(self): - """ - Test case for get_braintree_by_account_id - - Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter. - """ - pass - - def test_get_by_card_details_id(self): - """ - Test case for get_by_card_details_id - - Returns a single stripe-token, specified by the cardDetailsID parameter. - """ - pass - - def test_get_stripe_ach(self): - """ - Test case for get_stripe_ach - - Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter. - """ - pass - - def test_get_stripe_token(self): - """ - Test case for get_stripe_token - - Returns a single stripe-token, specified by the stripeTokenID parameter. - """ - pass - - def test_update_stripe_ach_token(self): - """ - Test case for update_stripe_ach_token - - Update a stripe-ACH-token. - """ - pass - - def test_update_stripe_token(self): - """ - Test case for update_stripe_token - - Update a stripe-token. - """ - pass - - def test_verify_bank_account(self): - """ - Test case for verify_bank_account - - Verify Stripe bank account. - """ - pass - - def test_webhook(self): - """ - Test case for webhook - - Receive and handle webhook from Stripe. - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_verify_payment_method_request.py b/test/test_verify_payment_method_request.py new file mode 100644 index 0000000..2e59e34 --- /dev/null +++ b/test/test_verify_payment_method_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.verify_payment_method_request import VerifyPaymentMethodRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestVerifyPaymentMethodRequest(unittest.TestCase): + """VerifyPaymentMethodRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testVerifyPaymentMethodRequest(self): + """Test VerifyPaymentMethodRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.verify_payment_method_request.VerifyPaymentMethodRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_webhook.py b/test/test_webhook.py new file mode 100644 index 0000000..1a2b592 --- /dev/null +++ b/test/test_webhook.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.webhook import Webhook # noqa: E501 +from billforward.rest import ApiException + + +class TestWebhook(unittest.TestCase): + """Webhook unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWebhook(self): + """Test Webhook""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.webhook.Webhook() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_webhook_paged_metadata.py b/test/test_webhook_paged_metadata.py deleted file mode 100644 index a6fad29..0000000 --- a/test/test_webhook_paged_metadata.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 - -""" - BillForward REST API - - - OpenAPI spec version: 1.0.0 - - Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import billforward -from billforward.rest import ApiException -from billforward.models.webhook_paged_metadata import WebhookPagedMetadata - - -class TestWebhookPagedMetadata(unittest.TestCase): - """ WebhookPagedMetadata unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testWebhookPagedMetadata(self): - """ - Test WebhookPagedMetadata - """ - model = billforward.models.webhook_paged_metadata.WebhookPagedMetadata() - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_webhook_subscription.py b/test/test_webhook_subscription.py new file mode 100644 index 0000000..d7862e3 --- /dev/null +++ b/test/test_webhook_subscription.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.webhook_subscription import WebhookSubscription # noqa: E501 +from billforward.rest import ApiException + + +class TestWebhookSubscription(unittest.TestCase): + """WebhookSubscription unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWebhookSubscription(self): + """Test WebhookSubscription""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.webhook_subscription.WebhookSubscription() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_webhooks_api.py b/test/test_webhooks_api.py index b1517f6..2bbb882 100644 --- a/test/test_webhooks_api.py +++ b/test/test_webhooks_api.py @@ -1,99 +1,78 @@ # coding: utf-8 """ - BillForward REST API + Billforward API + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - OpenAPI spec version: 1.0.0 - + OpenAPI spec version: 1.0 + Contact: team@billforward.net Generated by: https://github.com/swagger-api/swagger-codegen.git - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. """ from __future__ import absolute_import -import os -import sys import unittest import billforward +from billforward.api.webhooks_api import WebhooksApi # noqa: E501 from billforward.rest import ApiException -from billforward.apis.webhooks_api import WebhooksApi class TestWebhooksApi(unittest.TestCase): - """ WebhooksApi unit test stubs """ + """WebhooksApi unit test stubs""" def setUp(self): - self.api = billforward.apis.webhooks_api.WebhooksApi() + self.api = WebhooksApi() # noqa: E501 def tearDown(self): pass def test_create_webhook(self): - """ - Test case for create_webhook + """Test case for create_webhook - Create a webhook. """ pass def test_create_webhook_v2(self): - """ - Test case for create_webhook_v2 + """Test case for create_webhook_v2 - Create a webhook. """ pass def test_get_all_webhooks(self): + """Test case for get_all_webhooks + """ - Test case for get_all_webhooks + pass + + def test_get_allowed_webhook_subscriptions(self): + """Test case for get_allowed_webhook_subscriptions - Returns a collection of Webhooks, specified by the accountID parameter. By default 10 values are returned. Records are returned in natural order. """ pass def test_get_webhook_by_id(self): - """ - Test case for get_webhook_by_id + """Test case for get_webhook_by_id - Returns a single webhook, specified by the webhook-ID parameter. """ pass def test_retire_webhook(self): - """ - Test case for retire_webhook + """Test case for retire_webhook - Retires the specified webhook. """ pass def test_update_webhook(self): - """ - Test case for update_webhook + """Test case for update_webhook - Update a webhook. """ pass def test_verify_webhook(self): - """ - Test case for verify_webhook + """Test case for verify_webhook - New webhooks must be verified before use, use the verificationID of the webhook to perform verification. """ pass diff --git a/test/test_zooz_capture_request.py b/test/test_zooz_capture_request.py new file mode 100644 index 0000000..df1b3fd --- /dev/null +++ b/test/test_zooz_capture_request.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.zooz_capture_request import ZoozCaptureRequest # noqa: E501 +from billforward.rest import ApiException + + +class TestZoozCaptureRequest(unittest.TestCase): + """ZoozCaptureRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testZoozCaptureRequest(self): + """Test ZoozCaptureRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.zooz_capture_request.ZoozCaptureRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_zooz_configuration.py b/test/test_zooz_configuration.py new file mode 100644 index 0000000..ad3e7a7 --- /dev/null +++ b/test/test_zooz_configuration.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.zooz_configuration import ZoozConfiguration # noqa: E501 +from billforward.rest import ApiException + + +class TestZoozConfiguration(unittest.TestCase): + """ZoozConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testZoozConfiguration(self): + """Test ZoozConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.zooz_configuration.ZoozConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_zooz_payment.py b/test/test_zooz_payment.py new file mode 100644 index 0000000..6f2557e --- /dev/null +++ b/test/test_zooz_payment.py @@ -0,0 +1,39 @@ +# coding: utf-8 + +""" + Billforward API + + This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 + + OpenAPI spec version: 1.0 + Contact: team@billforward.net + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import unittest + +import billforward +from billforward.models.zooz_payment import ZoozPayment # noqa: E501 +from billforward.rest import ApiException + + +class TestZoozPayment(unittest.TestCase): + """ZoozPayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testZoozPayment(self): + """Test ZoozPayment""" + # FIXME: construct object with mandatory attributes with example values + # model = billforward.models.zooz_payment.ZoozPayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/tox.ini b/tox.ini index d99517b..a310bec 100644 --- a/tox.ini +++ b/tox.ini @@ -1,10 +1,10 @@ [tox] -envlist = py27, py34 +envlist = py3 [testenv] deps=-r{toxinidir}/requirements.txt -r{toxinidir}/test-requirements.txt - + commands= nosetests \ - [] \ No newline at end of file + [] From b15a572cdaef8050169a1898b97fe6238e8efcfe Mon Sep 17 00:00:00 2001 From: Mat Jaggard Date: Mon, 6 Dec 2021 13:01:10 +0000 Subject: [PATCH 2/8] Removing unused tests --- test/__init__.py | 0 test/test_account.py | 39 -- test/test_accounts_api.py | 147 -------- test/test_add_charge_request.py | 39 -- test/test_add_charge_response.py | 39 -- test/test_add_charge_to_account_response.py | 39 -- ...test_add_charges_to_account_api_request.py | 39 -- test/test_add_contract_period_request.py | 39 -- test/test_add_coupon_code_request.py | 39 -- test/test_add_payment_method_request.py | 39 -- test/test_additional_data.py | 39 -- test/test_address.py | 39 -- ...ance_pricing_components_by_charge_model.py | 39 -- test/test_affiliate.py | 39 -- test/test_affiliate_commission_charge.py | 39 -- .../test_affiliate_rate_plan_relationships.py | 39 -- ...est_affiliate_subscription_relationship.py | 39 -- test/test_affiliation_api.py | 81 ---- .../test_aggregating_component_description.py | 39 -- ...est_allowed_webhook_subscription_values.py | 39 -- test/test_amendment.py | 39 -- test/test_amendment_discard_amendment.py | 39 -- test/test_api_configuration.py | 39 -- test/test_api_quote.py | 39 -- test/test_api_quote_response_quantity.py | 39 -- test/test_arrears_charge.py | 39 -- ...ears_pricing_components_by_charge_model.py | 39 -- test/test_auth_capture_request.py | 39 -- test/test_authorize_net_configuration.py | 39 -- test/test_authorize_net_payment.py | 39 -- test/test_authorize_net_token.py | 39 -- test/test_avatax_api.py | 57 --- test/test_avatax_config_request.py | 39 -- test/test_avatax_configuration.py | 39 -- test/test_avatax_ping_request.py | 39 -- test/test_avatax_ping_response.py | 39 -- test/test_bank_account.py | 39 -- test/test_batch_increment_values_request.py | 39 -- ...update_pricing_component_values_request.py | 39 -- test/test_bf_permission.py | 39 -- test/test_billing_entity_base.py | 39 -- test/test_braintree_auth_capture_request.py | 39 -- test/test_braintree_capture_request.py | 39 -- test/test_braintree_configuration.py | 39 -- test/test_braintree_merchant_account.py | 39 -- test/test_braintree_payment.py | 39 -- test/test_braintree_pre_auth_request.py | 39 -- test/test_braintree_token.py | 39 -- test/test_calculator_result.py | 39 -- test/test_cancellation_amendment.py | 39 -- test/test_card_connect_api.py | 51 --- .../test_card_connect_auth_capture_request.py | 39 -- test/test_card_connect_configuration.py | 39 -- test/test_card_connect_gateway_request.py | 39 -- test/test_card_connect_payment.py | 39 -- test/test_charges_api.py | 63 ---- test/test_checkout_api.py | 63 ---- test/test_commission_structure.py | 39 -- test/test_component_change.py | 39 -- test/test_contract.py | 39 -- test/test_contract_period.py | 39 -- test/test_contracts_api.py | 81 ---- test/test_coupon.py | 39 -- test/test_coupon_charge.py | 39 -- test/test_coupon_code_response.py | 39 -- test/test_coupon_discount.py | 39 -- test/test_coupon_instance.py | 39 -- test/test_coupon_instance_existing_value.py | 39 -- test/test_coupon_payment.py | 39 -- test/test_coupon_unique_codes_request.py | 39 -- test/test_coupon_unique_codes_response.py | 39 -- test/test_coupon_wrapper_response.py | 39 -- test/test_coupons_api.py | 93 ----- ...st_create_aggregating_component_request.py | 39 -- ...create_aggregating_subscription_request.py | 39 -- .../test_create_commission_invoice_request.py | 39 -- test/test_create_contract_period_request.py | 39 -- test/test_create_contract_request.py | 39 -- test/test_create_coupon_discount_request.py | 39 -- test/test_create_coupon_request.py | 39 -- test/test_create_offline_payment_request.py | 39 -- .../test_create_permission_on_role_request.py | 39 -- test/test_create_permission_request.py | 39 -- ...eate_pricing_component_quantity_request.py | 39 -- test/test_create_profile_request.py | 39 -- test/test_create_role_request.py | 39 -- ...create_salesforce_configuration_request.py | 39 -- .../test_create_subscription_batch_request.py | 39 -- ...st_create_subscription_charge_amendment.py | 39 -- ...ubscription_checkout_definition_request.py | 39 -- test/test_create_subscription_request.py | 39 -- .../test_create_subscription_timer_request.py | 39 -- test/test_create_totp_request.py | 39 -- test/test_credit_account_request.py | 39 -- test/test_credit_note.py | 39 -- test/test_credit_note_currency.py | 39 -- test/test_credit_note_payment.py | 39 -- test/test_credit_subscription_request.py | 39 -- test/test_cybersource_configuration.py | 39 -- test/test_cybersource_payment.py | 39 -- test/test_data_sync_job_error_response.py | 39 -- test/test_data_sync_job_response.py | 39 -- test/test_default_api.py | 51 --- test/test_dunning_api.py | 69 ---- test/test_dunning_line.py | 39 -- test/test_ebanx_api.py | 57 --- test/test_ebanx_auth_capture_request.py | 39 -- test/test_ebanx_configuration.py | 39 -- test/test_ebanx_gateway_request.py | 39 -- test/test_ebanx_payment.py | 39 -- test/test_ebanx_webhook.py | 39 -- test/test_email_tokenization.py | 39 -- ...t_email_tokenization_create_api_request.py | 39 -- ...est_email_tokenization_send_api_request.py | 39 -- ...t_email_tokenization_update_api_request.py | 39 -- test/test_end_trial_amendment.py | 39 -- test/test_epx_capture_request.py | 39 -- test/test_epx_configuration.py | 39 -- test/test_epx_payment.py | 39 -- test/test_epx_pre_auth_request.py | 39 -- test/test_epx_pre_auth_response.py | 39 -- test/test_execution_receipt_response.py | 39 -- test/test_execution_response.py | 39 -- test/test_extras.py | 39 -- test/test_fixed_term.py | 39 -- test/test_fixed_term_definition.py | 39 -- test/test_fixed_term_expiry_amendment.py | 39 -- test/test_flat_advance_pricing_component.py | 39 -- test/test_flat_arrears_pricing_component.py | 39 -- test/test_flat_pricing_component.py | 39 -- test/test_flat_setup_pricing_component.py | 39 -- test/test_flat_usage_pricing_component.py | 39 -- test/test_get_rate_plan_affiliate_response.py | 39 -- ...est_get_subscription_affiliate_response.py | 39 -- test/test_go_cardless_configuration.py | 39 -- test/test_go_cardless_tokenization_request.py | 39 -- test/test_halt_aggregation_request.py | 39 -- test/test_halt_aggregation_response.py | 39 -- test/test_hosted_payment.py | 39 -- test/test_hosted_payment_config.py | 39 -- test/test_i_discardable.py | 39 -- test/test_import_invoice_line.py | 39 -- test/test_import_invoice_request.py | 39 -- test/test_import_subscription_request.py | 39 -- test/test_inline_response_default.py | 39 -- test/test_inline_response_default1.py | 39 -- test/test_inline_response_default10.py | 39 -- test/test_inline_response_default100.py | 39 -- test/test_inline_response_default101.py | 39 -- test/test_inline_response_default102.py | 39 -- test/test_inline_response_default103.py | 39 -- test/test_inline_response_default11.py | 39 -- test/test_inline_response_default12.py | 39 -- test/test_inline_response_default13.py | 39 -- test/test_inline_response_default14.py | 39 -- test/test_inline_response_default15.py | 39 -- test/test_inline_response_default16.py | 39 -- test/test_inline_response_default17.py | 39 -- test/test_inline_response_default18.py | 39 -- test/test_inline_response_default19.py | 39 -- test/test_inline_response_default2.py | 39 -- test/test_inline_response_default20.py | 39 -- test/test_inline_response_default21.py | 39 -- test/test_inline_response_default22.py | 39 -- test/test_inline_response_default23.py | 39 -- test/test_inline_response_default24.py | 39 -- test/test_inline_response_default25.py | 39 -- test/test_inline_response_default26.py | 39 -- test/test_inline_response_default27.py | 39 -- test/test_inline_response_default28.py | 39 -- test/test_inline_response_default29.py | 39 -- test/test_inline_response_default3.py | 39 -- test/test_inline_response_default30.py | 39 -- test/test_inline_response_default31.py | 39 -- test/test_inline_response_default32.py | 39 -- test/test_inline_response_default33.py | 39 -- test/test_inline_response_default34.py | 39 -- test/test_inline_response_default35.py | 39 -- test/test_inline_response_default36.py | 39 -- test/test_inline_response_default37.py | 39 -- test/test_inline_response_default38.py | 39 -- test/test_inline_response_default39.py | 39 -- test/test_inline_response_default4.py | 39 -- test/test_inline_response_default40.py | 39 -- test/test_inline_response_default41.py | 39 -- test/test_inline_response_default42.py | 39 -- test/test_inline_response_default43.py | 39 -- test/test_inline_response_default44.py | 39 -- test/test_inline_response_default45.py | 39 -- test/test_inline_response_default46.py | 39 -- test/test_inline_response_default47.py | 39 -- test/test_inline_response_default48.py | 39 -- test/test_inline_response_default49.py | 39 -- test/test_inline_response_default5.py | 39 -- test/test_inline_response_default50.py | 39 -- test/test_inline_response_default51.py | 39 -- test/test_inline_response_default52.py | 39 -- test/test_inline_response_default53.py | 39 -- test/test_inline_response_default54.py | 39 -- test/test_inline_response_default55.py | 39 -- test/test_inline_response_default56.py | 39 -- test/test_inline_response_default57.py | 39 -- test/test_inline_response_default58.py | 39 -- test/test_inline_response_default59.py | 39 -- test/test_inline_response_default6.py | 39 -- test/test_inline_response_default60.py | 39 -- test/test_inline_response_default61.py | 39 -- test/test_inline_response_default62.py | 39 -- test/test_inline_response_default63.py | 39 -- test/test_inline_response_default64.py | 39 -- test/test_inline_response_default65.py | 39 -- test/test_inline_response_default66.py | 39 -- test/test_inline_response_default67.py | 39 -- test/test_inline_response_default68.py | 39 -- test/test_inline_response_default69.py | 39 -- test/test_inline_response_default7.py | 39 -- test/test_inline_response_default70.py | 39 -- test/test_inline_response_default71.py | 39 -- test/test_inline_response_default72.py | 39 -- test/test_inline_response_default73.py | 39 -- test/test_inline_response_default74.py | 39 -- test/test_inline_response_default75.py | 39 -- test/test_inline_response_default76.py | 39 -- test/test_inline_response_default77.py | 39 -- test/test_inline_response_default78.py | 39 -- test/test_inline_response_default79.py | 39 -- test/test_inline_response_default8.py | 39 -- test/test_inline_response_default80.py | 39 -- test/test_inline_response_default81.py | 39 -- test/test_inline_response_default82.py | 39 -- test/test_inline_response_default83.py | 39 -- test/test_inline_response_default84.py | 39 -- test/test_inline_response_default85.py | 39 -- test/test_inline_response_default86.py | 39 -- test/test_inline_response_default87.py | 39 -- test/test_inline_response_default88.py | 39 -- test/test_inline_response_default89.py | 39 -- test/test_inline_response_default9.py | 39 -- test/test_inline_response_default90.py | 39 -- test/test_inline_response_default91.py | 39 -- test/test_inline_response_default92.py | 39 -- test/test_inline_response_default93.py | 39 -- test/test_inline_response_default94.py | 39 -- test/test_inline_response_default95.py | 39 -- test/test_inline_response_default96.py | 39 -- test/test_inline_response_default97.py | 39 -- test/test_inline_response_default98.py | 39 -- test/test_inline_response_default99.py | 39 -- test/test_interval_date.py | 39 -- test/test_invoice.py | 39 -- test/test_invoice_charge_request.py | 39 -- test/test_invoice_execution_request.py | 39 -- test/test_invoice_line_payments.py | 39 -- test/test_invoice_lines.py | 39 -- ...nvoice_next_execution_attempt_amendment.py | 39 -- ...t_invoice_outstanding_charges_amendment.py | 39 -- test/test_invoice_payments.py | 39 -- test/test_invoice_recalculation_amendment.py | 39 -- test/test_invoice_recalculation_request.py | 39 -- test/test_invoice_refund_request.py | 39 -- test/test_invoice_refund_response.py | 39 -- test/test_invoice_split.py | 39 -- test/test_invoice_split_service_request.py | 39 -- test/test_invoice_template_config_response.py | 39 -- test/test_invoices_api.py | 333 ---------------- test/test_issue_invoice_amendment.py | 39 -- test/test_issue_invoice_request.py | 39 -- test/test_issue_invoice_response.py | 39 -- test/test_kash_configuration.py | 39 -- test/test_legacy_create_webhook_request.py | 39 -- test/test_manual_charge.py | 39 -- test/test_marketplace_quote.py | 39 -- test/test_metadata.py | 39 -- test/test_metadata_key_values.py | 39 -- test/test_migration.py | 39 -- test/test_migration_request.py | 39 -- test/test_migration_response.py | 39 -- test/test_nested_adhoc_charge_request.py | 39 -- test/test_nested_charge_request.py | 39 -- test/test_notification_send_request.py | 39 -- test/test_notification_send_response.py | 39 -- test/test_notifications.py | 39 -- test/test_notifications_api.py | 69 ---- test/test_o_auth_token.py | 39 -- test/test_offline_payment.py | 39 -- test/test_open_id_registration_response.py | 39 -- test/test_open_id_user_link_request.py | 39 -- test/test_organization_lite_view.py | 39 -- test/test_password.py | 39 -- test/test_password_reset_code_request.py | 39 -- test/test_password_reset_response.py | 39 -- ...password_update_with_reset_code_request.py | 39 -- test/test_pause_request.py | 39 -- test/test_pay_vision_auth_capture_request.py | 39 -- test/test_pay_vision_configuration.py | 39 -- test/test_pay_vision_pre_auth_request.py | 39 -- test/test_payment.py | 39 -- test/test_payment_accounting_view.py | 39 -- test/test_payment_gateway_api.py | 63 ---- test/test_payment_method.py | 39 -- test/test_payment_method_subscription_link.py | 39 -- test/test_payment_methods_api.py | 87 ----- test/test_payment_refund_request.py | 39 -- test/test_payment_refund_response.py | 39 -- test/test_payment_retry_request.py | 39 -- test/test_payments_api.py | 93 ----- test/test_paypal_configuration.py | 39 -- test/test_paypal_payment.py | 39 -- test/test_pending_component_value_change.py | 39 -- test/test_permission_action_entity.py | 39 -- test/test_permission_resource_entity.py | 39 -- test/test_permissions_api.py | 69 ---- test/test_plan_aggregation.py | 39 -- test/test_plan_request.py | 39 -- test/test_plan_response.py | 39 -- test/test_plans_api.py | 51 --- test/test_prepayment_charge.py | 39 -- test/test_price_breakdown.py | 39 -- test/test_price_line.py | 39 -- test/test_pricing_component.py | 39 -- test/test_pricing_component_charge.py | 39 -- .../test_pricing_component_migration_value.py | 39 -- test/test_pricing_component_tier.py | 39 -- test/test_pricing_component_value.py | 39 -- .../test_pricing_component_value_amendment.py | 39 -- test/test_pricing_component_value_change.py | 39 -- ...onent_value_migration_amendment_mapping.py | 39 -- test/test_pricing_component_value_request.py | 39 -- test/test_pricing_component_value_response.py | 39 -- .../test_pricing_components_by_charge_type.py | 39 -- test/test_pricing_tier.py | 39 -- ...t_product_rate_plan_migration_amendment.py | 39 -- ...test_product_rate_plan_migration_charge.py | 39 -- test/test_profile.py | 39 -- test/test_public_configuration_response.py | 39 -- test/test_quote_request.py | 39 -- test/test_quote_request_value.py | 39 -- test/test_quotes_api.py | 51 --- test/test_recalculate_charge_batch_request.py | 39 -- .../test_recalculate_charge_batch_response.py | 39 -- test/test_recalculate_charge_request.py | 39 -- test/test_receipt.py | 39 -- test/test_receipts_api.py | 75 ---- test/test_refund.py | 39 -- test/test_refund_accounting_view.py | 39 -- test/test_remove_credit_account_request.py | 39 -- test/test_reports_api.py | 105 ------ test/test_resume_request.py | 39 -- test/test_resume_subscription_amendment.py | 39 -- test/test_revenue_attributions.py | 39 -- test/test_role.py | 39 -- test/test_sage_pay_auth_capture_request.py | 39 -- test/test_sage_pay_card_payment.py | 39 -- test/test_sage_pay_configuration.py | 39 -- test/test_sage_pay_enabled_card_type.py | 39 -- test/test_sage_pay_pre_auth_request.py | 39 -- test/test_salesforce_api.py | 63 ---- .../test_salesforce_configuration_response.py | 39 -- test/test_security_api.py | 165 -------- test/test_service_end_amendment.py | 39 -- test/test_set_rate_plan_affiliate_request.py | 39 -- ...test_set_subscription_affiliate_request.py | 39 -- test/test_setup_charge.py | 39 -- ...etup_pricing_components_by_charge_model.py | 39 -- test/test_shuttle_auth_capture_request.py | 39 -- test/test_shuttle_configuration.py | 39 -- test/test_shuttle_payment.py | 39 -- test/test_shuttle_pre_auth_request.py | 39 -- test/test_simple_date_param.py | 39 -- test/test_simple_user.py | 39 -- .../test_single_recalculate_charge_request.py | 39 -- test/test_spreedly_auth_capture_request.py | 39 -- test/test_spreedly_configuration.py | 39 -- test/test_spreedly_pre_auth_request.py | 39 -- test/test_square_auth_capture_request.py | 39 -- test/test_square_configuration.py | 39 -- test/test_square_configuration_data.py | 39 -- test/test_square_data.py | 39 -- test/test_square_payment.py | 39 -- test/test_square_subscription.py | 39 -- test/test_start_all_subscriptions_request.py | 39 -- test/test_start_all_subscriptions_response.py | 39 -- test/test_start_contract_request.py | 39 -- test/test_start_contract_response.py | 39 -- test/test_stripe_ach_capture_request.py | 39 -- test/test_stripe_ach_payment.py | 39 -- test/test_stripe_ach_token.py | 39 -- test/test_stripe_additional_data.py | 39 -- test/test_stripe_auth_capture_request.py | 39 -- test/test_stripe_card_payment.py | 39 -- test/test_stripe_configuration.py | 39 -- test/test_stripe_pre_auth_request.py | 39 -- test/test_stripe_token.py | 39 -- test/test_subscription.py | 39 -- test/test_subscription_cancellation.py | 39 -- test/test_subscription_charge.py | 39 -- ...st_subscription_checkout_action_request.py | 39 -- ...ription_checkout_definition_description.py | 39 -- test/test_subscription_checkout_response.py | 39 -- test/test_subscription_revive_amendment.py | 39 -- ...est_subscription_revive_partial_request.py | 39 -- test/test_subscription_revive_request.py | 39 -- test/test_subscriptions_api.py | 357 ------------------ test/test_swagger_type_list_inv.py | 39 -- test/test_swagger_type_list_subs.py | 39 -- test/test_sync_action_request.py | 39 -- test/test_tax_line.py | 39 -- test/test_taxation_strategy.py | 39 -- test/test_taxes_api.py | 87 ----- test/test_tiered_advance_pricing_component.py | 39 -- test/test_tiered_arrears_pricing_component.py | 39 -- test/test_tiered_pricing_component.py | 39 -- test/test_tiered_setup_pricing_component.py | 39 -- test/test_tiered_usage_pricing_component.py | 39 -- test/test_tiered_volume_pricing_component.py | 39 -- test/test_time_request.py | 39 -- test/test_time_response.py | 39 -- test/test_timer_amendment.py | 39 -- test/test_tokenization_api.py | 237 ------------ test/test_tokenization_epxredirect_body.py | 39 -- ...test_tokenization_payvisionshoutv1_body.py | 39 -- test/test_tokenization_pre_auth.py | 39 -- test/test_tokenization_pre_auth_request.py | 39 -- ...est_tokenization_sagepaynotifyv300_body.py | 39 -- test/test_tokens_response.py | 39 -- test/test_trust_commerce_configuration.py | 39 -- test/test_trust_commerce_token.py | 39 -- ...test_typed_query_result_wrapper_account.py | 39 -- ...test_typed_query_result_wrapper_address.py | 39 -- ...st_typed_query_result_wrapper_amendment.py | 39 -- ...st_typed_query_result_wrapper_api_quote.py | 39 -- ...ery_result_wrapper_avatax_configuration.py | 39 -- ...yped_query_result_wrapper_bf_permission.py | 39 -- ...ed_query_result_wrapper_braintree_token.py | 39 -- ...est_typed_query_result_wrapper_contract.py | 39 -- .../test_typed_query_result_wrapper_coupon.py | 39 -- ..._typed_query_result_wrapper_credit_note.py | 39 -- ...y_result_wrapper_data_sync_job_response.py | 39 -- ...typed_query_result_wrapper_dunning_line.py | 39 -- ...test_typed_query_result_wrapper_invoice.py | 39 -- ...ery_result_wrapper_invoice_line_payment.py | 39 -- ...typed_query_result_wrapper_notification.py | 39 -- ...test_typed_query_result_wrapper_payment.py | 39 -- ...ped_query_result_wrapper_payment_method.py | 39 -- ...yped_query_result_wrapper_plan_response.py | 39 -- ...test_typed_query_result_wrapper_profile.py | 39 -- ...test_typed_query_result_wrapper_receipt.py | 39 -- .../test_typed_query_result_wrapper_refund.py | 39 -- ...uery_result_wrapper_revenue_attribution.py | 39 -- test/test_typed_query_result_wrapper_role.py | 39 -- ...d_query_result_wrapper_stripe_ach_token.py | 39 -- ...typed_query_result_wrapper_stripe_token.py | 39 -- ...typed_query_result_wrapper_subscription.py | 39 -- ...uery_result_wrapper_subscription_charge.py | 39 -- ..._query_result_wrapper_taxation_strategy.py | 39 -- ...yped_query_result_wrapper_user_response.py | 39 -- ...test_typed_query_result_wrapper_webhook.py | 39 -- test/test_unit_of_measure.py | 39 -- test/test_update_component_value_amendment.py | 39 -- test/test_update_contract_request.py | 39 -- test/test_update_email_request.py | 39 -- test/test_update_invoice_request.py | 39 -- test/test_update_invoice_template_request.py | 39 -- test/test_update_password_request.py | 39 -- test/test_update_password_response.py | 39 -- ...e_pricing_component_value_change_result.py | 39 -- ..._update_pricing_component_value_request.py | 39 -- ...update_pricing_component_value_response.py | 39 -- ...test_update_rate_plan_affiliate_request.py | 39 -- test/test_update_role_request.py | 39 -- ...update_salesforce_configuration_request.py | 39 -- test/test_update_subscription_request.py | 39 -- test/test_update_user_info_request.py | 39 -- test/test_upgrade_charge.py | 39 -- ...sage_pricing_components_by_charge_model.py | 39 -- test/test_user.py | 39 -- test/test_user_create_request.py | 39 -- test/test_user_creation_request.py | 39 -- test/test_user_creation_response.py | 39 -- test/test_user_invite_request.py | 39 -- ...private_permanent_token_refresh_request.py | 39 -- ...st_user_private_permanent_token_request.py | 39 -- test/test_user_response.py | 39 -- test/test_user_timezone.py | 39 -- test/test_username.py | 39 -- test/test_username_response.py | 39 -- test/test_value_increment.py | 39 -- test/test_verify_payment_method_request.py | 39 -- test/test_webhook.py | 39 -- test/test_webhook_subscription.py | 39 -- test/test_webhooks_api.py | 81 ---- test/test_zooz_capture_request.py | 39 -- test/test_zooz_configuration.py | 39 -- test/test_zooz_payment.py | 39 -- 494 files changed, 20973 deletions(-) delete mode 100644 test/__init__.py delete mode 100644 test/test_account.py delete mode 100644 test/test_accounts_api.py delete mode 100644 test/test_add_charge_request.py delete mode 100644 test/test_add_charge_response.py delete mode 100644 test/test_add_charge_to_account_response.py delete mode 100644 test/test_add_charges_to_account_api_request.py delete mode 100644 test/test_add_contract_period_request.py delete mode 100644 test/test_add_coupon_code_request.py delete mode 100644 test/test_add_payment_method_request.py delete mode 100644 test/test_additional_data.py delete mode 100644 test/test_address.py delete mode 100644 test/test_advance_pricing_components_by_charge_model.py delete mode 100644 test/test_affiliate.py delete mode 100644 test/test_affiliate_commission_charge.py delete mode 100644 test/test_affiliate_rate_plan_relationships.py delete mode 100644 test/test_affiliate_subscription_relationship.py delete mode 100644 test/test_affiliation_api.py delete mode 100644 test/test_aggregating_component_description.py delete mode 100644 test/test_allowed_webhook_subscription_values.py delete mode 100644 test/test_amendment.py delete mode 100644 test/test_amendment_discard_amendment.py delete mode 100644 test/test_api_configuration.py delete mode 100644 test/test_api_quote.py delete mode 100644 test/test_api_quote_response_quantity.py delete mode 100644 test/test_arrears_charge.py delete mode 100644 test/test_arrears_pricing_components_by_charge_model.py delete mode 100644 test/test_auth_capture_request.py delete mode 100644 test/test_authorize_net_configuration.py delete mode 100644 test/test_authorize_net_payment.py delete mode 100644 test/test_authorize_net_token.py delete mode 100644 test/test_avatax_api.py delete mode 100644 test/test_avatax_config_request.py delete mode 100644 test/test_avatax_configuration.py delete mode 100644 test/test_avatax_ping_request.py delete mode 100644 test/test_avatax_ping_response.py delete mode 100644 test/test_bank_account.py delete mode 100644 test/test_batch_increment_values_request.py delete mode 100644 test/test_batch_update_pricing_component_values_request.py delete mode 100644 test/test_bf_permission.py delete mode 100644 test/test_billing_entity_base.py delete mode 100644 test/test_braintree_auth_capture_request.py delete mode 100644 test/test_braintree_capture_request.py delete mode 100644 test/test_braintree_configuration.py delete mode 100644 test/test_braintree_merchant_account.py delete mode 100644 test/test_braintree_payment.py delete mode 100644 test/test_braintree_pre_auth_request.py delete mode 100644 test/test_braintree_token.py delete mode 100644 test/test_calculator_result.py delete mode 100644 test/test_cancellation_amendment.py delete mode 100644 test/test_card_connect_api.py delete mode 100644 test/test_card_connect_auth_capture_request.py delete mode 100644 test/test_card_connect_configuration.py delete mode 100644 test/test_card_connect_gateway_request.py delete mode 100644 test/test_card_connect_payment.py delete mode 100644 test/test_charges_api.py delete mode 100644 test/test_checkout_api.py delete mode 100644 test/test_commission_structure.py delete mode 100644 test/test_component_change.py delete mode 100644 test/test_contract.py delete mode 100644 test/test_contract_period.py delete mode 100644 test/test_contracts_api.py delete mode 100644 test/test_coupon.py delete mode 100644 test/test_coupon_charge.py delete mode 100644 test/test_coupon_code_response.py delete mode 100644 test/test_coupon_discount.py delete mode 100644 test/test_coupon_instance.py delete mode 100644 test/test_coupon_instance_existing_value.py delete mode 100644 test/test_coupon_payment.py delete mode 100644 test/test_coupon_unique_codes_request.py delete mode 100644 test/test_coupon_unique_codes_response.py delete mode 100644 test/test_coupon_wrapper_response.py delete mode 100644 test/test_coupons_api.py delete mode 100644 test/test_create_aggregating_component_request.py delete mode 100644 test/test_create_aggregating_subscription_request.py delete mode 100644 test/test_create_commission_invoice_request.py delete mode 100644 test/test_create_contract_period_request.py delete mode 100644 test/test_create_contract_request.py delete mode 100644 test/test_create_coupon_discount_request.py delete mode 100644 test/test_create_coupon_request.py delete mode 100644 test/test_create_offline_payment_request.py delete mode 100644 test/test_create_permission_on_role_request.py delete mode 100644 test/test_create_permission_request.py delete mode 100644 test/test_create_pricing_component_quantity_request.py delete mode 100644 test/test_create_profile_request.py delete mode 100644 test/test_create_role_request.py delete mode 100644 test/test_create_salesforce_configuration_request.py delete mode 100644 test/test_create_subscription_batch_request.py delete mode 100644 test/test_create_subscription_charge_amendment.py delete mode 100644 test/test_create_subscription_checkout_definition_request.py delete mode 100644 test/test_create_subscription_request.py delete mode 100644 test/test_create_subscription_timer_request.py delete mode 100644 test/test_create_totp_request.py delete mode 100644 test/test_credit_account_request.py delete mode 100644 test/test_credit_note.py delete mode 100644 test/test_credit_note_currency.py delete mode 100644 test/test_credit_note_payment.py delete mode 100644 test/test_credit_subscription_request.py delete mode 100644 test/test_cybersource_configuration.py delete mode 100644 test/test_cybersource_payment.py delete mode 100644 test/test_data_sync_job_error_response.py delete mode 100644 test/test_data_sync_job_response.py delete mode 100644 test/test_default_api.py delete mode 100644 test/test_dunning_api.py delete mode 100644 test/test_dunning_line.py delete mode 100644 test/test_ebanx_api.py delete mode 100644 test/test_ebanx_auth_capture_request.py delete mode 100644 test/test_ebanx_configuration.py delete mode 100644 test/test_ebanx_gateway_request.py delete mode 100644 test/test_ebanx_payment.py delete mode 100644 test/test_ebanx_webhook.py delete mode 100644 test/test_email_tokenization.py delete mode 100644 test/test_email_tokenization_create_api_request.py delete mode 100644 test/test_email_tokenization_send_api_request.py delete mode 100644 test/test_email_tokenization_update_api_request.py delete mode 100644 test/test_end_trial_amendment.py delete mode 100644 test/test_epx_capture_request.py delete mode 100644 test/test_epx_configuration.py delete mode 100644 test/test_epx_payment.py delete mode 100644 test/test_epx_pre_auth_request.py delete mode 100644 test/test_epx_pre_auth_response.py delete mode 100644 test/test_execution_receipt_response.py delete mode 100644 test/test_execution_response.py delete mode 100644 test/test_extras.py delete mode 100644 test/test_fixed_term.py delete mode 100644 test/test_fixed_term_definition.py delete mode 100644 test/test_fixed_term_expiry_amendment.py delete mode 100644 test/test_flat_advance_pricing_component.py delete mode 100644 test/test_flat_arrears_pricing_component.py delete mode 100644 test/test_flat_pricing_component.py delete mode 100644 test/test_flat_setup_pricing_component.py delete mode 100644 test/test_flat_usage_pricing_component.py delete mode 100644 test/test_get_rate_plan_affiliate_response.py delete mode 100644 test/test_get_subscription_affiliate_response.py delete mode 100644 test/test_go_cardless_configuration.py delete mode 100644 test/test_go_cardless_tokenization_request.py delete mode 100644 test/test_halt_aggregation_request.py delete mode 100644 test/test_halt_aggregation_response.py delete mode 100644 test/test_hosted_payment.py delete mode 100644 test/test_hosted_payment_config.py delete mode 100644 test/test_i_discardable.py delete mode 100644 test/test_import_invoice_line.py delete mode 100644 test/test_import_invoice_request.py delete mode 100644 test/test_import_subscription_request.py delete mode 100644 test/test_inline_response_default.py delete mode 100644 test/test_inline_response_default1.py delete mode 100644 test/test_inline_response_default10.py delete mode 100644 test/test_inline_response_default100.py delete mode 100644 test/test_inline_response_default101.py delete mode 100644 test/test_inline_response_default102.py delete mode 100644 test/test_inline_response_default103.py delete mode 100644 test/test_inline_response_default11.py delete mode 100644 test/test_inline_response_default12.py delete mode 100644 test/test_inline_response_default13.py delete mode 100644 test/test_inline_response_default14.py delete mode 100644 test/test_inline_response_default15.py delete mode 100644 test/test_inline_response_default16.py delete mode 100644 test/test_inline_response_default17.py delete mode 100644 test/test_inline_response_default18.py delete mode 100644 test/test_inline_response_default19.py delete mode 100644 test/test_inline_response_default2.py delete mode 100644 test/test_inline_response_default20.py delete mode 100644 test/test_inline_response_default21.py delete mode 100644 test/test_inline_response_default22.py delete mode 100644 test/test_inline_response_default23.py delete mode 100644 test/test_inline_response_default24.py delete mode 100644 test/test_inline_response_default25.py delete mode 100644 test/test_inline_response_default26.py delete mode 100644 test/test_inline_response_default27.py delete mode 100644 test/test_inline_response_default28.py delete mode 100644 test/test_inline_response_default29.py delete mode 100644 test/test_inline_response_default3.py delete mode 100644 test/test_inline_response_default30.py delete mode 100644 test/test_inline_response_default31.py delete mode 100644 test/test_inline_response_default32.py delete mode 100644 test/test_inline_response_default33.py delete mode 100644 test/test_inline_response_default34.py delete mode 100644 test/test_inline_response_default35.py delete mode 100644 test/test_inline_response_default36.py delete mode 100644 test/test_inline_response_default37.py delete mode 100644 test/test_inline_response_default38.py delete mode 100644 test/test_inline_response_default39.py delete mode 100644 test/test_inline_response_default4.py delete mode 100644 test/test_inline_response_default40.py delete mode 100644 test/test_inline_response_default41.py delete mode 100644 test/test_inline_response_default42.py delete mode 100644 test/test_inline_response_default43.py delete mode 100644 test/test_inline_response_default44.py delete mode 100644 test/test_inline_response_default45.py delete mode 100644 test/test_inline_response_default46.py delete mode 100644 test/test_inline_response_default47.py delete mode 100644 test/test_inline_response_default48.py delete mode 100644 test/test_inline_response_default49.py delete mode 100644 test/test_inline_response_default5.py delete mode 100644 test/test_inline_response_default50.py delete mode 100644 test/test_inline_response_default51.py delete mode 100644 test/test_inline_response_default52.py delete mode 100644 test/test_inline_response_default53.py delete mode 100644 test/test_inline_response_default54.py delete mode 100644 test/test_inline_response_default55.py delete mode 100644 test/test_inline_response_default56.py delete mode 100644 test/test_inline_response_default57.py delete mode 100644 test/test_inline_response_default58.py delete mode 100644 test/test_inline_response_default59.py delete mode 100644 test/test_inline_response_default6.py delete mode 100644 test/test_inline_response_default60.py delete mode 100644 test/test_inline_response_default61.py delete mode 100644 test/test_inline_response_default62.py delete mode 100644 test/test_inline_response_default63.py delete mode 100644 test/test_inline_response_default64.py delete mode 100644 test/test_inline_response_default65.py delete mode 100644 test/test_inline_response_default66.py delete mode 100644 test/test_inline_response_default67.py delete mode 100644 test/test_inline_response_default68.py delete mode 100644 test/test_inline_response_default69.py delete mode 100644 test/test_inline_response_default7.py delete mode 100644 test/test_inline_response_default70.py delete mode 100644 test/test_inline_response_default71.py delete mode 100644 test/test_inline_response_default72.py delete mode 100644 test/test_inline_response_default73.py delete mode 100644 test/test_inline_response_default74.py delete mode 100644 test/test_inline_response_default75.py delete mode 100644 test/test_inline_response_default76.py delete mode 100644 test/test_inline_response_default77.py delete mode 100644 test/test_inline_response_default78.py delete mode 100644 test/test_inline_response_default79.py delete mode 100644 test/test_inline_response_default8.py delete mode 100644 test/test_inline_response_default80.py delete mode 100644 test/test_inline_response_default81.py delete mode 100644 test/test_inline_response_default82.py delete mode 100644 test/test_inline_response_default83.py delete mode 100644 test/test_inline_response_default84.py delete mode 100644 test/test_inline_response_default85.py delete mode 100644 test/test_inline_response_default86.py delete mode 100644 test/test_inline_response_default87.py delete mode 100644 test/test_inline_response_default88.py delete mode 100644 test/test_inline_response_default89.py delete mode 100644 test/test_inline_response_default9.py delete mode 100644 test/test_inline_response_default90.py delete mode 100644 test/test_inline_response_default91.py delete mode 100644 test/test_inline_response_default92.py delete mode 100644 test/test_inline_response_default93.py delete mode 100644 test/test_inline_response_default94.py delete mode 100644 test/test_inline_response_default95.py delete mode 100644 test/test_inline_response_default96.py delete mode 100644 test/test_inline_response_default97.py delete mode 100644 test/test_inline_response_default98.py delete mode 100644 test/test_inline_response_default99.py delete mode 100644 test/test_interval_date.py delete mode 100644 test/test_invoice.py delete mode 100644 test/test_invoice_charge_request.py delete mode 100644 test/test_invoice_execution_request.py delete mode 100644 test/test_invoice_line_payments.py delete mode 100644 test/test_invoice_lines.py delete mode 100644 test/test_invoice_next_execution_attempt_amendment.py delete mode 100644 test/test_invoice_outstanding_charges_amendment.py delete mode 100644 test/test_invoice_payments.py delete mode 100644 test/test_invoice_recalculation_amendment.py delete mode 100644 test/test_invoice_recalculation_request.py delete mode 100644 test/test_invoice_refund_request.py delete mode 100644 test/test_invoice_refund_response.py delete mode 100644 test/test_invoice_split.py delete mode 100644 test/test_invoice_split_service_request.py delete mode 100644 test/test_invoice_template_config_response.py delete mode 100644 test/test_invoices_api.py delete mode 100644 test/test_issue_invoice_amendment.py delete mode 100644 test/test_issue_invoice_request.py delete mode 100644 test/test_issue_invoice_response.py delete mode 100644 test/test_kash_configuration.py delete mode 100644 test/test_legacy_create_webhook_request.py delete mode 100644 test/test_manual_charge.py delete mode 100644 test/test_marketplace_quote.py delete mode 100644 test/test_metadata.py delete mode 100644 test/test_metadata_key_values.py delete mode 100644 test/test_migration.py delete mode 100644 test/test_migration_request.py delete mode 100644 test/test_migration_response.py delete mode 100644 test/test_nested_adhoc_charge_request.py delete mode 100644 test/test_nested_charge_request.py delete mode 100644 test/test_notification_send_request.py delete mode 100644 test/test_notification_send_response.py delete mode 100644 test/test_notifications.py delete mode 100644 test/test_notifications_api.py delete mode 100644 test/test_o_auth_token.py delete mode 100644 test/test_offline_payment.py delete mode 100644 test/test_open_id_registration_response.py delete mode 100644 test/test_open_id_user_link_request.py delete mode 100644 test/test_organization_lite_view.py delete mode 100644 test/test_password.py delete mode 100644 test/test_password_reset_code_request.py delete mode 100644 test/test_password_reset_response.py delete mode 100644 test/test_password_update_with_reset_code_request.py delete mode 100644 test/test_pause_request.py delete mode 100644 test/test_pay_vision_auth_capture_request.py delete mode 100644 test/test_pay_vision_configuration.py delete mode 100644 test/test_pay_vision_pre_auth_request.py delete mode 100644 test/test_payment.py delete mode 100644 test/test_payment_accounting_view.py delete mode 100644 test/test_payment_gateway_api.py delete mode 100644 test/test_payment_method.py delete mode 100644 test/test_payment_method_subscription_link.py delete mode 100644 test/test_payment_methods_api.py delete mode 100644 test/test_payment_refund_request.py delete mode 100644 test/test_payment_refund_response.py delete mode 100644 test/test_payment_retry_request.py delete mode 100644 test/test_payments_api.py delete mode 100644 test/test_paypal_configuration.py delete mode 100644 test/test_paypal_payment.py delete mode 100644 test/test_pending_component_value_change.py delete mode 100644 test/test_permission_action_entity.py delete mode 100644 test/test_permission_resource_entity.py delete mode 100644 test/test_permissions_api.py delete mode 100644 test/test_plan_aggregation.py delete mode 100644 test/test_plan_request.py delete mode 100644 test/test_plan_response.py delete mode 100644 test/test_plans_api.py delete mode 100644 test/test_prepayment_charge.py delete mode 100644 test/test_price_breakdown.py delete mode 100644 test/test_price_line.py delete mode 100644 test/test_pricing_component.py delete mode 100644 test/test_pricing_component_charge.py delete mode 100644 test/test_pricing_component_migration_value.py delete mode 100644 test/test_pricing_component_tier.py delete mode 100644 test/test_pricing_component_value.py delete mode 100644 test/test_pricing_component_value_amendment.py delete mode 100644 test/test_pricing_component_value_change.py delete mode 100644 test/test_pricing_component_value_migration_amendment_mapping.py delete mode 100644 test/test_pricing_component_value_request.py delete mode 100644 test/test_pricing_component_value_response.py delete mode 100644 test/test_pricing_components_by_charge_type.py delete mode 100644 test/test_pricing_tier.py delete mode 100644 test/test_product_rate_plan_migration_amendment.py delete mode 100644 test/test_product_rate_plan_migration_charge.py delete mode 100644 test/test_profile.py delete mode 100644 test/test_public_configuration_response.py delete mode 100644 test/test_quote_request.py delete mode 100644 test/test_quote_request_value.py delete mode 100644 test/test_quotes_api.py delete mode 100644 test/test_recalculate_charge_batch_request.py delete mode 100644 test/test_recalculate_charge_batch_response.py delete mode 100644 test/test_recalculate_charge_request.py delete mode 100644 test/test_receipt.py delete mode 100644 test/test_receipts_api.py delete mode 100644 test/test_refund.py delete mode 100644 test/test_refund_accounting_view.py delete mode 100644 test/test_remove_credit_account_request.py delete mode 100644 test/test_reports_api.py delete mode 100644 test/test_resume_request.py delete mode 100644 test/test_resume_subscription_amendment.py delete mode 100644 test/test_revenue_attributions.py delete mode 100644 test/test_role.py delete mode 100644 test/test_sage_pay_auth_capture_request.py delete mode 100644 test/test_sage_pay_card_payment.py delete mode 100644 test/test_sage_pay_configuration.py delete mode 100644 test/test_sage_pay_enabled_card_type.py delete mode 100644 test/test_sage_pay_pre_auth_request.py delete mode 100644 test/test_salesforce_api.py delete mode 100644 test/test_salesforce_configuration_response.py delete mode 100644 test/test_security_api.py delete mode 100644 test/test_service_end_amendment.py delete mode 100644 test/test_set_rate_plan_affiliate_request.py delete mode 100644 test/test_set_subscription_affiliate_request.py delete mode 100644 test/test_setup_charge.py delete mode 100644 test/test_setup_pricing_components_by_charge_model.py delete mode 100644 test/test_shuttle_auth_capture_request.py delete mode 100644 test/test_shuttle_configuration.py delete mode 100644 test/test_shuttle_payment.py delete mode 100644 test/test_shuttle_pre_auth_request.py delete mode 100644 test/test_simple_date_param.py delete mode 100644 test/test_simple_user.py delete mode 100644 test/test_single_recalculate_charge_request.py delete mode 100644 test/test_spreedly_auth_capture_request.py delete mode 100644 test/test_spreedly_configuration.py delete mode 100644 test/test_spreedly_pre_auth_request.py delete mode 100644 test/test_square_auth_capture_request.py delete mode 100644 test/test_square_configuration.py delete mode 100644 test/test_square_configuration_data.py delete mode 100644 test/test_square_data.py delete mode 100644 test/test_square_payment.py delete mode 100644 test/test_square_subscription.py delete mode 100644 test/test_start_all_subscriptions_request.py delete mode 100644 test/test_start_all_subscriptions_response.py delete mode 100644 test/test_start_contract_request.py delete mode 100644 test/test_start_contract_response.py delete mode 100644 test/test_stripe_ach_capture_request.py delete mode 100644 test/test_stripe_ach_payment.py delete mode 100644 test/test_stripe_ach_token.py delete mode 100644 test/test_stripe_additional_data.py delete mode 100644 test/test_stripe_auth_capture_request.py delete mode 100644 test/test_stripe_card_payment.py delete mode 100644 test/test_stripe_configuration.py delete mode 100644 test/test_stripe_pre_auth_request.py delete mode 100644 test/test_stripe_token.py delete mode 100644 test/test_subscription.py delete mode 100644 test/test_subscription_cancellation.py delete mode 100644 test/test_subscription_charge.py delete mode 100644 test/test_subscription_checkout_action_request.py delete mode 100644 test/test_subscription_checkout_definition_description.py delete mode 100644 test/test_subscription_checkout_response.py delete mode 100644 test/test_subscription_revive_amendment.py delete mode 100644 test/test_subscription_revive_partial_request.py delete mode 100644 test/test_subscription_revive_request.py delete mode 100644 test/test_subscriptions_api.py delete mode 100644 test/test_swagger_type_list_inv.py delete mode 100644 test/test_swagger_type_list_subs.py delete mode 100644 test/test_sync_action_request.py delete mode 100644 test/test_tax_line.py delete mode 100644 test/test_taxation_strategy.py delete mode 100644 test/test_taxes_api.py delete mode 100644 test/test_tiered_advance_pricing_component.py delete mode 100644 test/test_tiered_arrears_pricing_component.py delete mode 100644 test/test_tiered_pricing_component.py delete mode 100644 test/test_tiered_setup_pricing_component.py delete mode 100644 test/test_tiered_usage_pricing_component.py delete mode 100644 test/test_tiered_volume_pricing_component.py delete mode 100644 test/test_time_request.py delete mode 100644 test/test_time_response.py delete mode 100644 test/test_timer_amendment.py delete mode 100644 test/test_tokenization_api.py delete mode 100644 test/test_tokenization_epxredirect_body.py delete mode 100644 test/test_tokenization_payvisionshoutv1_body.py delete mode 100644 test/test_tokenization_pre_auth.py delete mode 100644 test/test_tokenization_pre_auth_request.py delete mode 100644 test/test_tokenization_sagepaynotifyv300_body.py delete mode 100644 test/test_tokens_response.py delete mode 100644 test/test_trust_commerce_configuration.py delete mode 100644 test/test_trust_commerce_token.py delete mode 100644 test/test_typed_query_result_wrapper_account.py delete mode 100644 test/test_typed_query_result_wrapper_address.py delete mode 100644 test/test_typed_query_result_wrapper_amendment.py delete mode 100644 test/test_typed_query_result_wrapper_api_quote.py delete mode 100644 test/test_typed_query_result_wrapper_avatax_configuration.py delete mode 100644 test/test_typed_query_result_wrapper_bf_permission.py delete mode 100644 test/test_typed_query_result_wrapper_braintree_token.py delete mode 100644 test/test_typed_query_result_wrapper_contract.py delete mode 100644 test/test_typed_query_result_wrapper_coupon.py delete mode 100644 test/test_typed_query_result_wrapper_credit_note.py delete mode 100644 test/test_typed_query_result_wrapper_data_sync_job_response.py delete mode 100644 test/test_typed_query_result_wrapper_dunning_line.py delete mode 100644 test/test_typed_query_result_wrapper_invoice.py delete mode 100644 test/test_typed_query_result_wrapper_invoice_line_payment.py delete mode 100644 test/test_typed_query_result_wrapper_notification.py delete mode 100644 test/test_typed_query_result_wrapper_payment.py delete mode 100644 test/test_typed_query_result_wrapper_payment_method.py delete mode 100644 test/test_typed_query_result_wrapper_plan_response.py delete mode 100644 test/test_typed_query_result_wrapper_profile.py delete mode 100644 test/test_typed_query_result_wrapper_receipt.py delete mode 100644 test/test_typed_query_result_wrapper_refund.py delete mode 100644 test/test_typed_query_result_wrapper_revenue_attribution.py delete mode 100644 test/test_typed_query_result_wrapper_role.py delete mode 100644 test/test_typed_query_result_wrapper_stripe_ach_token.py delete mode 100644 test/test_typed_query_result_wrapper_stripe_token.py delete mode 100644 test/test_typed_query_result_wrapper_subscription.py delete mode 100644 test/test_typed_query_result_wrapper_subscription_charge.py delete mode 100644 test/test_typed_query_result_wrapper_taxation_strategy.py delete mode 100644 test/test_typed_query_result_wrapper_user_response.py delete mode 100644 test/test_typed_query_result_wrapper_webhook.py delete mode 100644 test/test_unit_of_measure.py delete mode 100644 test/test_update_component_value_amendment.py delete mode 100644 test/test_update_contract_request.py delete mode 100644 test/test_update_email_request.py delete mode 100644 test/test_update_invoice_request.py delete mode 100644 test/test_update_invoice_template_request.py delete mode 100644 test/test_update_password_request.py delete mode 100644 test/test_update_password_response.py delete mode 100644 test/test_update_pricing_component_value_change_result.py delete mode 100644 test/test_update_pricing_component_value_request.py delete mode 100644 test/test_update_pricing_component_value_response.py delete mode 100644 test/test_update_rate_plan_affiliate_request.py delete mode 100644 test/test_update_role_request.py delete mode 100644 test/test_update_salesforce_configuration_request.py delete mode 100644 test/test_update_subscription_request.py delete mode 100644 test/test_update_user_info_request.py delete mode 100644 test/test_upgrade_charge.py delete mode 100644 test/test_usage_pricing_components_by_charge_model.py delete mode 100644 test/test_user.py delete mode 100644 test/test_user_create_request.py delete mode 100644 test/test_user_creation_request.py delete mode 100644 test/test_user_creation_response.py delete mode 100644 test/test_user_invite_request.py delete mode 100644 test/test_user_private_permanent_token_refresh_request.py delete mode 100644 test/test_user_private_permanent_token_request.py delete mode 100644 test/test_user_response.py delete mode 100644 test/test_user_timezone.py delete mode 100644 test/test_username.py delete mode 100644 test/test_username_response.py delete mode 100644 test/test_value_increment.py delete mode 100644 test/test_verify_payment_method_request.py delete mode 100644 test/test_webhook.py delete mode 100644 test/test_webhook_subscription.py delete mode 100644 test/test_webhooks_api.py delete mode 100644 test/test_zooz_capture_request.py delete mode 100644 test/test_zooz_configuration.py delete mode 100644 test/test_zooz_payment.py diff --git a/test/__init__.py b/test/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/test/test_account.py b/test/test_account.py deleted file mode 100644 index 5f79f61..0000000 --- a/test/test_account.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.account import Account # noqa: E501 -from billforward.rest import ApiException - - -class TestAccount(unittest.TestCase): - """Account unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAccount(self): - """Test Account""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.account.Account() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_accounts_api.py b/test/test_accounts_api.py deleted file mode 100644 index d022504..0000000 --- a/test/test_accounts_api.py +++ /dev/null @@ -1,147 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.accounts_api import AccountsApi # noqa: E501 -from billforward.rest import ApiException - - -class TestAccountsApi(unittest.TestCase): - """AccountsApi unit test stubs""" - - def setUp(self): - self.api = AccountsApi() # noqa: E501 - - def tearDown(self): - pass - - def test_add_charge_to_account(self): - """Test case for add_charge_to_account - - """ - pass - - def test_add_credit_note_to_account(self): - """Test case for add_credit_note_to_account - - """ - pass - - def test_create_account(self): - """Test case for create_account - - """ - pass - - def test_create_address(self): - """Test case for create_address - - """ - pass - - def test_delete_account(self): - """Test case for delete_account - - """ - pass - - def test_delete_metadata_for_account(self): - """Test case for delete_metadata_for_account - - """ - pass - - def test_get_account_by_id(self): - """Test case for get_account_by_id - - """ - pass - - def test_get_all_accounts(self): - """Test case for get_all_accounts - - """ - pass - - def test_get_available_credit_on_account(self): - """Test case for get_available_credit_on_account - - """ - pass - - def test_get_invoices_by_account_id(self): - """Test case for get_invoices_by_account_id - - """ - pass - - def test_get_metadata_for_account(self): - """Test case for get_metadata_for_account - - """ - pass - - def test_get_payment_method_by_account_id(self): - """Test case for get_payment_method_by_account_id - - """ - pass - - def test_get_subscription_charges(self): - """Test case for get_subscription_charges - - """ - pass - - def test_halt_aggregation(self): - """Test case for halt_aggregation - - """ - pass - - def test_remove_credit_from_account2(self): - """Test case for remove_credit_from_account2 - - """ - pass - - def test_set_metadata_for_account(self): - """Test case for set_metadata_for_account - - """ - pass - - def test_update_account(self): - """Test case for update_account - - """ - pass - - def test_update_address(self): - """Test case for update_address - - """ - pass - - def test_upsert_metadata_for_account(self): - """Test case for upsert_metadata_for_account - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_add_charge_request.py b/test/test_add_charge_request.py deleted file mode 100644 index 328da9c..0000000 --- a/test/test_add_charge_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.add_charge_request import AddChargeRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestAddChargeRequest(unittest.TestCase): - """AddChargeRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAddChargeRequest(self): - """Test AddChargeRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.add_charge_request.AddChargeRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_add_charge_response.py b/test/test_add_charge_response.py deleted file mode 100644 index ba6f4b9..0000000 --- a/test/test_add_charge_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.add_charge_response import AddChargeResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestAddChargeResponse(unittest.TestCase): - """AddChargeResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAddChargeResponse(self): - """Test AddChargeResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.add_charge_response.AddChargeResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_add_charge_to_account_response.py b/test/test_add_charge_to_account_response.py deleted file mode 100644 index 8a25cba..0000000 --- a/test/test_add_charge_to_account_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.add_charge_to_account_response import AddChargeToAccountResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestAddChargeToAccountResponse(unittest.TestCase): - """AddChargeToAccountResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAddChargeToAccountResponse(self): - """Test AddChargeToAccountResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.add_charge_to_account_response.AddChargeToAccountResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_add_charges_to_account_api_request.py b/test/test_add_charges_to_account_api_request.py deleted file mode 100644 index 6806afc..0000000 --- a/test/test_add_charges_to_account_api_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.add_charges_to_account_api_request import AddChargesToAccountAPIRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestAddChargesToAccountAPIRequest(unittest.TestCase): - """AddChargesToAccountAPIRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAddChargesToAccountAPIRequest(self): - """Test AddChargesToAccountAPIRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.add_charges_to_account_api_request.AddChargesToAccountAPIRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_add_contract_period_request.py b/test/test_add_contract_period_request.py deleted file mode 100644 index 898f546..0000000 --- a/test/test_add_contract_period_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.add_contract_period_request import AddContractPeriodRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestAddContractPeriodRequest(unittest.TestCase): - """AddContractPeriodRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAddContractPeriodRequest(self): - """Test AddContractPeriodRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.add_contract_period_request.AddContractPeriodRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_add_coupon_code_request.py b/test/test_add_coupon_code_request.py deleted file mode 100644 index a9e98e1..0000000 --- a/test/test_add_coupon_code_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.add_coupon_code_request import AddCouponCodeRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestAddCouponCodeRequest(unittest.TestCase): - """AddCouponCodeRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAddCouponCodeRequest(self): - """Test AddCouponCodeRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.add_coupon_code_request.AddCouponCodeRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_add_payment_method_request.py b/test/test_add_payment_method_request.py deleted file mode 100644 index f3243fd..0000000 --- a/test/test_add_payment_method_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.add_payment_method_request import AddPaymentMethodRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestAddPaymentMethodRequest(unittest.TestCase): - """AddPaymentMethodRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAddPaymentMethodRequest(self): - """Test AddPaymentMethodRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.add_payment_method_request.AddPaymentMethodRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_additional_data.py b/test/test_additional_data.py deleted file mode 100644 index 6871fab..0000000 --- a/test/test_additional_data.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.additional_data import AdditionalData # noqa: E501 -from billforward.rest import ApiException - - -class TestAdditionalData(unittest.TestCase): - """AdditionalData unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAdditionalData(self): - """Test AdditionalData""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.additional_data.AdditionalData() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_address.py b/test/test_address.py deleted file mode 100644 index 7c81e5a..0000000 --- a/test/test_address.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.address import Address # noqa: E501 -from billforward.rest import ApiException - - -class TestAddress(unittest.TestCase): - """Address unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAddress(self): - """Test Address""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.address.Address() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_advance_pricing_components_by_charge_model.py b/test/test_advance_pricing_components_by_charge_model.py deleted file mode 100644 index 40bfbcd..0000000 --- a/test/test_advance_pricing_components_by_charge_model.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.advance_pricing_components_by_charge_model import AdvancePricingComponentsByChargeModel # noqa: E501 -from billforward.rest import ApiException - - -class TestAdvancePricingComponentsByChargeModel(unittest.TestCase): - """AdvancePricingComponentsByChargeModel unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAdvancePricingComponentsByChargeModel(self): - """Test AdvancePricingComponentsByChargeModel""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.advance_pricing_components_by_charge_model.AdvancePricingComponentsByChargeModel() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_affiliate.py b/test/test_affiliate.py deleted file mode 100644 index 868aaeb..0000000 --- a/test/test_affiliate.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.affiliate import Affiliate # noqa: E501 -from billforward.rest import ApiException - - -class TestAffiliate(unittest.TestCase): - """Affiliate unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAffiliate(self): - """Test Affiliate""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.affiliate.Affiliate() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_affiliate_commission_charge.py b/test/test_affiliate_commission_charge.py deleted file mode 100644 index 8548974..0000000 --- a/test/test_affiliate_commission_charge.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.affiliate_commission_charge import AffiliateCommissionCharge # noqa: E501 -from billforward.rest import ApiException - - -class TestAffiliateCommissionCharge(unittest.TestCase): - """AffiliateCommissionCharge unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAffiliateCommissionCharge(self): - """Test AffiliateCommissionCharge""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.affiliate_commission_charge.AffiliateCommissionCharge() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_affiliate_rate_plan_relationships.py b/test/test_affiliate_rate_plan_relationships.py deleted file mode 100644 index 29ebb83..0000000 --- a/test/test_affiliate_rate_plan_relationships.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.affiliate_rate_plan_relationships import AffiliateRatePlanRelationships # noqa: E501 -from billforward.rest import ApiException - - -class TestAffiliateRatePlanRelationships(unittest.TestCase): - """AffiliateRatePlanRelationships unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAffiliateRatePlanRelationships(self): - """Test AffiliateRatePlanRelationships""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.affiliate_rate_plan_relationships.AffiliateRatePlanRelationships() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_affiliate_subscription_relationship.py b/test/test_affiliate_subscription_relationship.py deleted file mode 100644 index 642cd79..0000000 --- a/test/test_affiliate_subscription_relationship.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.affiliate_subscription_relationship import AffiliateSubscriptionRelationship # noqa: E501 -from billforward.rest import ApiException - - -class TestAffiliateSubscriptionRelationship(unittest.TestCase): - """AffiliateSubscriptionRelationship unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAffiliateSubscriptionRelationship(self): - """Test AffiliateSubscriptionRelationship""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.affiliate_subscription_relationship.AffiliateSubscriptionRelationship() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_affiliation_api.py b/test/test_affiliation_api.py deleted file mode 100644 index a99b1d8..0000000 --- a/test/test_affiliation_api.py +++ /dev/null @@ -1,81 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.affiliation_api import AffiliationApi # noqa: E501 -from billforward.rest import ApiException - - -class TestAffiliationApi(unittest.TestCase): - """AffiliationApi unit test stubs""" - - def setUp(self): - self.api = AffiliationApi() # noqa: E501 - - def tearDown(self): - pass - - def test_create_invoice(self): - """Test case for create_invoice - - """ - pass - - def test_get_affiliate(self): - """Test case for get_affiliate - - """ - pass - - def test_get_affiliate1(self): - """Test case for get_affiliate1 - - """ - pass - - def test_quote_invoice(self): - """Test case for quote_invoice - - """ - pass - - def test_quote_subscription(self): - """Test case for quote_subscription - - """ - pass - - def test_set_affiliate(self): - """Test case for set_affiliate - - """ - pass - - def test_set_affiliate1(self): - """Test case for set_affiliate1 - - """ - pass - - def test_update_affiliate(self): - """Test case for update_affiliate - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_aggregating_component_description.py b/test/test_aggregating_component_description.py deleted file mode 100644 index 1a35459..0000000 --- a/test/test_aggregating_component_description.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.aggregating_component_description import AggregatingComponentDescription # noqa: E501 -from billforward.rest import ApiException - - -class TestAggregatingComponentDescription(unittest.TestCase): - """AggregatingComponentDescription unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAggregatingComponentDescription(self): - """Test AggregatingComponentDescription""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.aggregating_component_description.AggregatingComponentDescription() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_allowed_webhook_subscription_values.py b/test/test_allowed_webhook_subscription_values.py deleted file mode 100644 index d1858e0..0000000 --- a/test/test_allowed_webhook_subscription_values.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.allowed_webhook_subscription_values import AllowedWebhookSubscriptionValues # noqa: E501 -from billforward.rest import ApiException - - -class TestAllowedWebhookSubscriptionValues(unittest.TestCase): - """AllowedWebhookSubscriptionValues unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAllowedWebhookSubscriptionValues(self): - """Test AllowedWebhookSubscriptionValues""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.allowed_webhook_subscription_values.AllowedWebhookSubscriptionValues() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_amendment.py b/test/test_amendment.py deleted file mode 100644 index 59683d7..0000000 --- a/test/test_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.amendment import Amendment # noqa: E501 -from billforward.rest import ApiException - - -class TestAmendment(unittest.TestCase): - """Amendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAmendment(self): - """Test Amendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.amendment.Amendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_amendment_discard_amendment.py b/test/test_amendment_discard_amendment.py deleted file mode 100644 index 84ce9b5..0000000 --- a/test/test_amendment_discard_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.amendment_discard_amendment import AmendmentDiscardAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestAmendmentDiscardAmendment(unittest.TestCase): - """AmendmentDiscardAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAmendmentDiscardAmendment(self): - """Test AmendmentDiscardAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.amendment_discard_amendment.AmendmentDiscardAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_api_configuration.py b/test/test_api_configuration.py deleted file mode 100644 index 8bd45d7..0000000 --- a/test/test_api_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.api_configuration import APIConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestAPIConfiguration(unittest.TestCase): - """APIConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAPIConfiguration(self): - """Test APIConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.api_configuration.APIConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_api_quote.py b/test/test_api_quote.py deleted file mode 100644 index f9ad9a0..0000000 --- a/test/test_api_quote.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.api_quote import ApiQuote # noqa: E501 -from billforward.rest import ApiException - - -class TestApiQuote(unittest.TestCase): - """ApiQuote unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testApiQuote(self): - """Test ApiQuote""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.api_quote.ApiQuote() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_api_quote_response_quantity.py b/test/test_api_quote_response_quantity.py deleted file mode 100644 index 8ac1bad..0000000 --- a/test/test_api_quote_response_quantity.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.api_quote_response_quantity import APIQuoteResponseQuantity # noqa: E501 -from billforward.rest import ApiException - - -class TestAPIQuoteResponseQuantity(unittest.TestCase): - """APIQuoteResponseQuantity unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAPIQuoteResponseQuantity(self): - """Test APIQuoteResponseQuantity""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.api_quote_response_quantity.APIQuoteResponseQuantity() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_arrears_charge.py b/test/test_arrears_charge.py deleted file mode 100644 index cfe16ad..0000000 --- a/test/test_arrears_charge.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.arrears_charge import ArrearsCharge # noqa: E501 -from billforward.rest import ApiException - - -class TestArrearsCharge(unittest.TestCase): - """ArrearsCharge unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testArrearsCharge(self): - """Test ArrearsCharge""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.arrears_charge.ArrearsCharge() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_arrears_pricing_components_by_charge_model.py b/test/test_arrears_pricing_components_by_charge_model.py deleted file mode 100644 index ea2e10d..0000000 --- a/test/test_arrears_pricing_components_by_charge_model.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.arrears_pricing_components_by_charge_model import ArrearsPricingComponentsByChargeModel # noqa: E501 -from billforward.rest import ApiException - - -class TestArrearsPricingComponentsByChargeModel(unittest.TestCase): - """ArrearsPricingComponentsByChargeModel unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testArrearsPricingComponentsByChargeModel(self): - """Test ArrearsPricingComponentsByChargeModel""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.arrears_pricing_components_by_charge_model.ArrearsPricingComponentsByChargeModel() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_auth_capture_request.py b/test/test_auth_capture_request.py deleted file mode 100644 index 66c6b10..0000000 --- a/test/test_auth_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.auth_capture_request import AuthCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestAuthCaptureRequest(unittest.TestCase): - """AuthCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAuthCaptureRequest(self): - """Test AuthCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.auth_capture_request.AuthCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_authorize_net_configuration.py b/test/test_authorize_net_configuration.py deleted file mode 100644 index 25a7ffd..0000000 --- a/test/test_authorize_net_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.authorize_net_configuration import AuthorizeNetConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestAuthorizeNetConfiguration(unittest.TestCase): - """AuthorizeNetConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAuthorizeNetConfiguration(self): - """Test AuthorizeNetConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.authorize_net_configuration.AuthorizeNetConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_authorize_net_payment.py b/test/test_authorize_net_payment.py deleted file mode 100644 index 14cac8f..0000000 --- a/test/test_authorize_net_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.authorize_net_payment import AuthorizeNetPayment # noqa: E501 -from billforward.rest import ApiException - - -class TestAuthorizeNetPayment(unittest.TestCase): - """AuthorizeNetPayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAuthorizeNetPayment(self): - """Test AuthorizeNetPayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.authorize_net_payment.AuthorizeNetPayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_authorize_net_token.py b/test/test_authorize_net_token.py deleted file mode 100644 index 1437e53..0000000 --- a/test/test_authorize_net_token.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.authorize_net_token import AuthorizeNetToken # noqa: E501 -from billforward.rest import ApiException - - -class TestAuthorizeNetToken(unittest.TestCase): - """AuthorizeNetToken unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAuthorizeNetToken(self): - """Test AuthorizeNetToken""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.authorize_net_token.AuthorizeNetToken() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_avatax_api.py b/test/test_avatax_api.py deleted file mode 100644 index e0d0a6b..0000000 --- a/test/test_avatax_api.py +++ /dev/null @@ -1,57 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.avatax_api import AvataxApi # noqa: E501 -from billforward.rest import ApiException - - -class TestAvataxApi(unittest.TestCase): - """AvataxApi unit test stubs""" - - def setUp(self): - self.api = AvataxApi() # noqa: E501 - - def tearDown(self): - pass - - def test_create_avatax_configuration(self): - """Test case for create_avatax_configuration - - """ - pass - - def test_get_avatax_configuration(self): - """Test case for get_avatax_configuration - - """ - pass - - def test_ping(self): - """Test case for ping - - """ - pass - - def test_update_avatax_configuration(self): - """Test case for update_avatax_configuration - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_avatax_config_request.py b/test/test_avatax_config_request.py deleted file mode 100644 index 3004546..0000000 --- a/test/test_avatax_config_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.avatax_config_request import AvataxConfigRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestAvataxConfigRequest(unittest.TestCase): - """AvataxConfigRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAvataxConfigRequest(self): - """Test AvataxConfigRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.avatax_config_request.AvataxConfigRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_avatax_configuration.py b/test/test_avatax_configuration.py deleted file mode 100644 index 9512856..0000000 --- a/test/test_avatax_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.avatax_configuration import AvataxConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestAvataxConfiguration(unittest.TestCase): - """AvataxConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAvataxConfiguration(self): - """Test AvataxConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.avatax_configuration.AvataxConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_avatax_ping_request.py b/test/test_avatax_ping_request.py deleted file mode 100644 index 3a540e5..0000000 --- a/test/test_avatax_ping_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.avatax_ping_request import AvataxPingRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestAvataxPingRequest(unittest.TestCase): - """AvataxPingRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAvataxPingRequest(self): - """Test AvataxPingRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.avatax_ping_request.AvataxPingRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_avatax_ping_response.py b/test/test_avatax_ping_response.py deleted file mode 100644 index 8eea986..0000000 --- a/test/test_avatax_ping_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.avatax_ping_response import AvataxPingResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestAvataxPingResponse(unittest.TestCase): - """AvataxPingResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testAvataxPingResponse(self): - """Test AvataxPingResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.avatax_ping_response.AvataxPingResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_bank_account.py b/test/test_bank_account.py deleted file mode 100644 index 32c3aa2..0000000 --- a/test/test_bank_account.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.bank_account import BankAccount # noqa: E501 -from billforward.rest import ApiException - - -class TestBankAccount(unittest.TestCase): - """BankAccount unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBankAccount(self): - """Test BankAccount""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.bank_account.BankAccount() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_batch_increment_values_request.py b/test/test_batch_increment_values_request.py deleted file mode 100644 index 997b2ec..0000000 --- a/test/test_batch_increment_values_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.batch_increment_values_request import BatchIncrementValuesRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestBatchIncrementValuesRequest(unittest.TestCase): - """BatchIncrementValuesRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBatchIncrementValuesRequest(self): - """Test BatchIncrementValuesRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.batch_increment_values_request.BatchIncrementValuesRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_batch_update_pricing_component_values_request.py b/test/test_batch_update_pricing_component_values_request.py deleted file mode 100644 index 781192d..0000000 --- a/test/test_batch_update_pricing_component_values_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.batch_update_pricing_component_values_request import BatchUpdatePricingComponentValuesRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestBatchUpdatePricingComponentValuesRequest(unittest.TestCase): - """BatchUpdatePricingComponentValuesRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBatchUpdatePricingComponentValuesRequest(self): - """Test BatchUpdatePricingComponentValuesRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.batch_update_pricing_component_values_request.BatchUpdatePricingComponentValuesRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_bf_permission.py b/test/test_bf_permission.py deleted file mode 100644 index c95d569..0000000 --- a/test/test_bf_permission.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.bf_permission import BFPermission # noqa: E501 -from billforward.rest import ApiException - - -class TestBFPermission(unittest.TestCase): - """BFPermission unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBFPermission(self): - """Test BFPermission""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.bf_permission.BFPermission() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_billing_entity_base.py b/test/test_billing_entity_base.py deleted file mode 100644 index 4da04f5..0000000 --- a/test/test_billing_entity_base.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.billing_entity_base import BillingEntityBase # noqa: E501 -from billforward.rest import ApiException - - -class TestBillingEntityBase(unittest.TestCase): - """BillingEntityBase unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBillingEntityBase(self): - """Test BillingEntityBase""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.billing_entity_base.BillingEntityBase() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_braintree_auth_capture_request.py b/test/test_braintree_auth_capture_request.py deleted file mode 100644 index 6f8576a..0000000 --- a/test/test_braintree_auth_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.braintree_auth_capture_request import BraintreeAuthCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestBraintreeAuthCaptureRequest(unittest.TestCase): - """BraintreeAuthCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBraintreeAuthCaptureRequest(self): - """Test BraintreeAuthCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.braintree_auth_capture_request.BraintreeAuthCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_braintree_capture_request.py b/test/test_braintree_capture_request.py deleted file mode 100644 index a104a89..0000000 --- a/test/test_braintree_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.braintree_capture_request import BraintreeCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestBraintreeCaptureRequest(unittest.TestCase): - """BraintreeCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBraintreeCaptureRequest(self): - """Test BraintreeCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.braintree_capture_request.BraintreeCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_braintree_configuration.py b/test/test_braintree_configuration.py deleted file mode 100644 index 3c80272..0000000 --- a/test/test_braintree_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.braintree_configuration import BraintreeConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestBraintreeConfiguration(unittest.TestCase): - """BraintreeConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBraintreeConfiguration(self): - """Test BraintreeConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.braintree_configuration.BraintreeConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_braintree_merchant_account.py b/test/test_braintree_merchant_account.py deleted file mode 100644 index a22aabc..0000000 --- a/test/test_braintree_merchant_account.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.braintree_merchant_account import BraintreeMerchantAccount # noqa: E501 -from billforward.rest import ApiException - - -class TestBraintreeMerchantAccount(unittest.TestCase): - """BraintreeMerchantAccount unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBraintreeMerchantAccount(self): - """Test BraintreeMerchantAccount""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.braintree_merchant_account.BraintreeMerchantAccount() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_braintree_payment.py b/test/test_braintree_payment.py deleted file mode 100644 index aacaa22..0000000 --- a/test/test_braintree_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.braintree_payment import BraintreePayment # noqa: E501 -from billforward.rest import ApiException - - -class TestBraintreePayment(unittest.TestCase): - """BraintreePayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBraintreePayment(self): - """Test BraintreePayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.braintree_payment.BraintreePayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_braintree_pre_auth_request.py b/test/test_braintree_pre_auth_request.py deleted file mode 100644 index 37c71bd..0000000 --- a/test/test_braintree_pre_auth_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.braintree_pre_auth_request import BraintreePreAuthRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestBraintreePreAuthRequest(unittest.TestCase): - """BraintreePreAuthRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBraintreePreAuthRequest(self): - """Test BraintreePreAuthRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.braintree_pre_auth_request.BraintreePreAuthRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_braintree_token.py b/test/test_braintree_token.py deleted file mode 100644 index ec028e9..0000000 --- a/test/test_braintree_token.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.braintree_token import BraintreeToken # noqa: E501 -from billforward.rest import ApiException - - -class TestBraintreeToken(unittest.TestCase): - """BraintreeToken unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testBraintreeToken(self): - """Test BraintreeToken""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.braintree_token.BraintreeToken() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_calculator_result.py b/test/test_calculator_result.py deleted file mode 100644 index ff5f02e..0000000 --- a/test/test_calculator_result.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.calculator_result import CalculatorResult # noqa: E501 -from billforward.rest import ApiException - - -class TestCalculatorResult(unittest.TestCase): - """CalculatorResult unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCalculatorResult(self): - """Test CalculatorResult""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.calculator_result.CalculatorResult() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_cancellation_amendment.py b/test/test_cancellation_amendment.py deleted file mode 100644 index 62e8824..0000000 --- a/test/test_cancellation_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.cancellation_amendment import CancellationAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestCancellationAmendment(unittest.TestCase): - """CancellationAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCancellationAmendment(self): - """Test CancellationAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.cancellation_amendment.CancellationAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_card_connect_api.py b/test/test_card_connect_api.py deleted file mode 100644 index 567dfb1..0000000 --- a/test/test_card_connect_api.py +++ /dev/null @@ -1,51 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.card_connect_api import CardConnectApi # noqa: E501 -from billforward.rest import ApiException - - -class TestCardConnectApi(unittest.TestCase): - """CardConnectApi unit test stubs""" - - def setUp(self): - self.api = CardConnectApi() # noqa: E501 - - def tearDown(self): - pass - - def test_delete_configuration(self): - """Test case for delete_configuration - - """ - pass - - def test_get_configuration(self): - """Test case for get_configuration - - """ - pass - - def test_upsert_configuration(self): - """Test case for upsert_configuration - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_card_connect_auth_capture_request.py b/test/test_card_connect_auth_capture_request.py deleted file mode 100644 index 3b53d65..0000000 --- a/test/test_card_connect_auth_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.card_connect_auth_capture_request import CardConnectAuthCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCardConnectAuthCaptureRequest(unittest.TestCase): - """CardConnectAuthCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCardConnectAuthCaptureRequest(self): - """Test CardConnectAuthCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.card_connect_auth_capture_request.CardConnectAuthCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_card_connect_configuration.py b/test/test_card_connect_configuration.py deleted file mode 100644 index c5481a6..0000000 --- a/test/test_card_connect_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.card_connect_configuration import CardConnectConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestCardConnectConfiguration(unittest.TestCase): - """CardConnectConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCardConnectConfiguration(self): - """Test CardConnectConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.card_connect_configuration.CardConnectConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_card_connect_gateway_request.py b/test/test_card_connect_gateway_request.py deleted file mode 100644 index 8e11829..0000000 --- a/test/test_card_connect_gateway_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.card_connect_gateway_request import CardConnectGatewayRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCardConnectGatewayRequest(unittest.TestCase): - """CardConnectGatewayRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCardConnectGatewayRequest(self): - """Test CardConnectGatewayRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.card_connect_gateway_request.CardConnectGatewayRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_card_connect_payment.py b/test/test_card_connect_payment.py deleted file mode 100644 index 46044e6..0000000 --- a/test/test_card_connect_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.card_connect_payment import CardConnectPayment # noqa: E501 -from billforward.rest import ApiException - - -class TestCardConnectPayment(unittest.TestCase): - """CardConnectPayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCardConnectPayment(self): - """Test CardConnectPayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.card_connect_payment.CardConnectPayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_charges_api.py b/test/test_charges_api.py deleted file mode 100644 index 113f1ac..0000000 --- a/test/test_charges_api.py +++ /dev/null @@ -1,63 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.charges_api import ChargesApi # noqa: E501 -from billforward.rest import ApiException - - -class TestChargesApi(unittest.TestCase): - """ChargesApi unit test stubs""" - - def setUp(self): - self.api = ChargesApi() # noqa: E501 - - def tearDown(self): - pass - - def test_batch_recalculate_subscription_charge(self): - """Test case for batch_recalculate_subscription_charge - - """ - pass - - def test_get_all_subscription_charges(self): - """Test case for get_all_subscription_charges - - """ - pass - - def test_get_subscription_charge_by_id(self): - """Test case for get_subscription_charge_by_id - - """ - pass - - def test_recalculate_subscription_charge(self): - """Test case for recalculate_subscription_charge - - """ - pass - - def test_void_subscription_charge(self): - """Test case for void_subscription_charge - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_checkout_api.py b/test/test_checkout_api.py deleted file mode 100644 index fabbe82..0000000 --- a/test/test_checkout_api.py +++ /dev/null @@ -1,63 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.checkout_api import CheckoutApi # noqa: E501 -from billforward.rest import ApiException - - -class TestCheckoutApi(unittest.TestCase): - """CheckoutApi unit test stubs""" - - def setUp(self): - self.api = CheckoutApi() # noqa: E501 - - def tearDown(self): - pass - - def test_build_subscription_checkout(self): - """Test case for build_subscription_checkout - - """ - pass - - def test_create_account1(self): - """Test case for create_account1 - - """ - pass - - def test_create_subscription_checkout_definition(self): - """Test case for create_subscription_checkout_definition - - """ - pass - - def test_get_subscription_checkout_definition(self): - """Test case for get_subscription_checkout_definition - - """ - pass - - def test_subscription_checkout(self): - """Test case for subscription_checkout - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_commission_structure.py b/test/test_commission_structure.py deleted file mode 100644 index fb0f4a3..0000000 --- a/test/test_commission_structure.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.commission_structure import CommissionStructure # noqa: E501 -from billforward.rest import ApiException - - -class TestCommissionStructure(unittest.TestCase): - """CommissionStructure unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCommissionStructure(self): - """Test CommissionStructure""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.commission_structure.CommissionStructure() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_component_change.py b/test/test_component_change.py deleted file mode 100644 index 78c6d4b..0000000 --- a/test/test_component_change.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.component_change import ComponentChange # noqa: E501 -from billforward.rest import ApiException - - -class TestComponentChange(unittest.TestCase): - """ComponentChange unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testComponentChange(self): - """Test ComponentChange""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.component_change.ComponentChange() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_contract.py b/test/test_contract.py deleted file mode 100644 index 9ac46bf..0000000 --- a/test/test_contract.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.contract import Contract # noqa: E501 -from billforward.rest import ApiException - - -class TestContract(unittest.TestCase): - """Contract unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testContract(self): - """Test Contract""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.contract.Contract() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_contract_period.py b/test/test_contract_period.py deleted file mode 100644 index b685810..0000000 --- a/test/test_contract_period.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.contract_period import ContractPeriod # noqa: E501 -from billforward.rest import ApiException - - -class TestContractPeriod(unittest.TestCase): - """ContractPeriod unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testContractPeriod(self): - """Test ContractPeriod""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.contract_period.ContractPeriod() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_contracts_api.py b/test/test_contracts_api.py deleted file mode 100644 index f6abdfd..0000000 --- a/test/test_contracts_api.py +++ /dev/null @@ -1,81 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.contracts_api import ContractsApi # noqa: E501 -from billforward.rest import ApiException - - -class TestContractsApi(unittest.TestCase): - """ContractsApi unit test stubs""" - - def setUp(self): - self.api = ContractsApi() # noqa: E501 - - def tearDown(self): - pass - - def test_add_contract_period(self): - """Test case for add_contract_period - - """ - pass - - def test_create_contract(self): - """Test case for create_contract - - """ - pass - - def test_get_all_contracts(self): - """Test case for get_all_contracts - - """ - pass - - def test_get_contract_by_id(self): - """Test case for get_contract_by_id - - """ - pass - - def test_start_contract(self): - """Test case for start_contract - - """ - pass - - def test_update_contract(self): - """Test case for update_contract - - """ - pass - - def test_void_contract(self): - """Test case for void_contract - - """ - pass - - def test_void_final_contract_period(self): - """Test case for void_final_contract_period - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon.py b/test/test_coupon.py deleted file mode 100644 index dff4b89..0000000 --- a/test/test_coupon.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.coupon import Coupon # noqa: E501 -from billforward.rest import ApiException - - -class TestCoupon(unittest.TestCase): - """Coupon unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCoupon(self): - """Test Coupon""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.coupon.Coupon() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_charge.py b/test/test_coupon_charge.py deleted file mode 100644 index 0d12122..0000000 --- a/test/test_coupon_charge.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.coupon_charge import CouponCharge # noqa: E501 -from billforward.rest import ApiException - - -class TestCouponCharge(unittest.TestCase): - """CouponCharge unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponCharge(self): - """Test CouponCharge""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.coupon_charge.CouponCharge() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_code_response.py b/test/test_coupon_code_response.py deleted file mode 100644 index f1bfbc3..0000000 --- a/test/test_coupon_code_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.coupon_code_response import CouponCodeResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestCouponCodeResponse(unittest.TestCase): - """CouponCodeResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponCodeResponse(self): - """Test CouponCodeResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.coupon_code_response.CouponCodeResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_discount.py b/test/test_coupon_discount.py deleted file mode 100644 index 217ad34..0000000 --- a/test/test_coupon_discount.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.coupon_discount import CouponDiscount # noqa: E501 -from billforward.rest import ApiException - - -class TestCouponDiscount(unittest.TestCase): - """CouponDiscount unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponDiscount(self): - """Test CouponDiscount""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.coupon_discount.CouponDiscount() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_instance.py b/test/test_coupon_instance.py deleted file mode 100644 index 11d2b68..0000000 --- a/test/test_coupon_instance.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.coupon_instance import CouponInstance # noqa: E501 -from billforward.rest import ApiException - - -class TestCouponInstance(unittest.TestCase): - """CouponInstance unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponInstance(self): - """Test CouponInstance""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.coupon_instance.CouponInstance() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_instance_existing_value.py b/test/test_coupon_instance_existing_value.py deleted file mode 100644 index 980b09a..0000000 --- a/test/test_coupon_instance_existing_value.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.coupon_instance_existing_value import CouponInstanceExistingValue # noqa: E501 -from billforward.rest import ApiException - - -class TestCouponInstanceExistingValue(unittest.TestCase): - """CouponInstanceExistingValue unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponInstanceExistingValue(self): - """Test CouponInstanceExistingValue""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.coupon_instance_existing_value.CouponInstanceExistingValue() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_payment.py b/test/test_coupon_payment.py deleted file mode 100644 index 753cc14..0000000 --- a/test/test_coupon_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.coupon_payment import CouponPayment # noqa: E501 -from billforward.rest import ApiException - - -class TestCouponPayment(unittest.TestCase): - """CouponPayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponPayment(self): - """Test CouponPayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.coupon_payment.CouponPayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_unique_codes_request.py b/test/test_coupon_unique_codes_request.py deleted file mode 100644 index 0ba5533..0000000 --- a/test/test_coupon_unique_codes_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.coupon_unique_codes_request import CouponUniqueCodesRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCouponUniqueCodesRequest(unittest.TestCase): - """CouponUniqueCodesRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponUniqueCodesRequest(self): - """Test CouponUniqueCodesRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.coupon_unique_codes_request.CouponUniqueCodesRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_unique_codes_response.py b/test/test_coupon_unique_codes_response.py deleted file mode 100644 index e376ed4..0000000 --- a/test/test_coupon_unique_codes_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.coupon_unique_codes_response import CouponUniqueCodesResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestCouponUniqueCodesResponse(unittest.TestCase): - """CouponUniqueCodesResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponUniqueCodesResponse(self): - """Test CouponUniqueCodesResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.coupon_unique_codes_response.CouponUniqueCodesResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupon_wrapper_response.py b/test/test_coupon_wrapper_response.py deleted file mode 100644 index 71c202a..0000000 --- a/test/test_coupon_wrapper_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.coupon_wrapper_response import CouponWrapperResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestCouponWrapperResponse(unittest.TestCase): - """CouponWrapperResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCouponWrapperResponse(self): - """Test CouponWrapperResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.coupon_wrapper_response.CouponWrapperResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_coupons_api.py b/test/test_coupons_api.py deleted file mode 100644 index 1d0fabe..0000000 --- a/test/test_coupons_api.py +++ /dev/null @@ -1,93 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.coupons_api import CouponsApi # noqa: E501 -from billforward.rest import ApiException - - -class TestCouponsApi(unittest.TestCase): - """CouponsApi unit test stubs""" - - def setUp(self): - self.api = CouponsApi() # noqa: E501 - - def tearDown(self): - pass - - def test_create_coupon(self): - """Test case for create_coupon - - """ - pass - - def test_create_coupon_unique_codes(self): - """Test case for create_coupon_unique_codes - - """ - pass - - def test_get_all_coupons(self): - """Test case for get_all_coupons - - """ - pass - - def test_get_applied_coupons(self): - """Test case for get_applied_coupons - - """ - pass - - def test_get_available_coupon_codes_for_code(self): - """Test case for get_available_coupon_codes_for_code - - """ - pass - - def test_get_available_coupon_codes_for_code_as_csv(self): - """Test case for get_available_coupon_codes_for_code_as_csv - - """ - pass - - def test_get_coupon_code(self): - """Test case for get_coupon_code - - """ - pass - - def test_get_plans_for_coupon(self): - """Test case for get_plans_for_coupon - - """ - pass - - def test_get_subscription_applications_of_coupons(self): - """Test case for get_subscription_applications_of_coupons - - """ - pass - - def test_retire_coupon(self): - """Test case for retire_coupon - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_aggregating_component_request.py b/test/test_create_aggregating_component_request.py deleted file mode 100644 index 06cbfef..0000000 --- a/test/test_create_aggregating_component_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_aggregating_component_request import CreateAggregatingComponentRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateAggregatingComponentRequest(unittest.TestCase): - """CreateAggregatingComponentRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateAggregatingComponentRequest(self): - """Test CreateAggregatingComponentRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_aggregating_component_request.CreateAggregatingComponentRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_aggregating_subscription_request.py b/test/test_create_aggregating_subscription_request.py deleted file mode 100644 index 4f660e2..0000000 --- a/test/test_create_aggregating_subscription_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_aggregating_subscription_request import CreateAggregatingSubscriptionRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateAggregatingSubscriptionRequest(unittest.TestCase): - """CreateAggregatingSubscriptionRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateAggregatingSubscriptionRequest(self): - """Test CreateAggregatingSubscriptionRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_aggregating_subscription_request.CreateAggregatingSubscriptionRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_commission_invoice_request.py b/test/test_create_commission_invoice_request.py deleted file mode 100644 index 8a80f21..0000000 --- a/test/test_create_commission_invoice_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_commission_invoice_request import CreateCommissionInvoiceRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateCommissionInvoiceRequest(unittest.TestCase): - """CreateCommissionInvoiceRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateCommissionInvoiceRequest(self): - """Test CreateCommissionInvoiceRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_commission_invoice_request.CreateCommissionInvoiceRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_contract_period_request.py b/test/test_create_contract_period_request.py deleted file mode 100644 index bbc8a63..0000000 --- a/test/test_create_contract_period_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_contract_period_request import CreateContractPeriodRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateContractPeriodRequest(unittest.TestCase): - """CreateContractPeriodRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateContractPeriodRequest(self): - """Test CreateContractPeriodRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_contract_period_request.CreateContractPeriodRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_contract_request.py b/test/test_create_contract_request.py deleted file mode 100644 index dee1862..0000000 --- a/test/test_create_contract_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_contract_request import CreateContractRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateContractRequest(unittest.TestCase): - """CreateContractRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateContractRequest(self): - """Test CreateContractRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_contract_request.CreateContractRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_coupon_discount_request.py b/test/test_create_coupon_discount_request.py deleted file mode 100644 index 75b4dfa..0000000 --- a/test/test_create_coupon_discount_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_coupon_discount_request import CreateCouponDiscountRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateCouponDiscountRequest(unittest.TestCase): - """CreateCouponDiscountRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateCouponDiscountRequest(self): - """Test CreateCouponDiscountRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_coupon_discount_request.CreateCouponDiscountRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_coupon_request.py b/test/test_create_coupon_request.py deleted file mode 100644 index eafb64f..0000000 --- a/test/test_create_coupon_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_coupon_request import CreateCouponRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateCouponRequest(unittest.TestCase): - """CreateCouponRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateCouponRequest(self): - """Test CreateCouponRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_coupon_request.CreateCouponRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_offline_payment_request.py b/test/test_create_offline_payment_request.py deleted file mode 100644 index ff0aecf..0000000 --- a/test/test_create_offline_payment_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_offline_payment_request import CreateOfflinePaymentRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateOfflinePaymentRequest(unittest.TestCase): - """CreateOfflinePaymentRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateOfflinePaymentRequest(self): - """Test CreateOfflinePaymentRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_offline_payment_request.CreateOfflinePaymentRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_permission_on_role_request.py b/test/test_create_permission_on_role_request.py deleted file mode 100644 index d4f61fa..0000000 --- a/test/test_create_permission_on_role_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_permission_on_role_request import CreatePermissionOnRoleRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreatePermissionOnRoleRequest(unittest.TestCase): - """CreatePermissionOnRoleRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreatePermissionOnRoleRequest(self): - """Test CreatePermissionOnRoleRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_permission_on_role_request.CreatePermissionOnRoleRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_permission_request.py b/test/test_create_permission_request.py deleted file mode 100644 index d8184b4..0000000 --- a/test/test_create_permission_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_permission_request import CreatePermissionRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreatePermissionRequest(unittest.TestCase): - """CreatePermissionRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreatePermissionRequest(self): - """Test CreatePermissionRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_permission_request.CreatePermissionRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_pricing_component_quantity_request.py b/test/test_create_pricing_component_quantity_request.py deleted file mode 100644 index 4702633..0000000 --- a/test/test_create_pricing_component_quantity_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_pricing_component_quantity_request import CreatePricingComponentQuantityRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreatePricingComponentQuantityRequest(unittest.TestCase): - """CreatePricingComponentQuantityRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreatePricingComponentQuantityRequest(self): - """Test CreatePricingComponentQuantityRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_pricing_component_quantity_request.CreatePricingComponentQuantityRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_profile_request.py b/test/test_create_profile_request.py deleted file mode 100644 index f86f708..0000000 --- a/test/test_create_profile_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_profile_request import CreateProfileRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateProfileRequest(unittest.TestCase): - """CreateProfileRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateProfileRequest(self): - """Test CreateProfileRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_profile_request.CreateProfileRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_role_request.py b/test/test_create_role_request.py deleted file mode 100644 index f21feff..0000000 --- a/test/test_create_role_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_role_request import CreateRoleRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateRoleRequest(unittest.TestCase): - """CreateRoleRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateRoleRequest(self): - """Test CreateRoleRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_role_request.CreateRoleRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_salesforce_configuration_request.py b/test/test_create_salesforce_configuration_request.py deleted file mode 100644 index 3781863..0000000 --- a/test/test_create_salesforce_configuration_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_salesforce_configuration_request import CreateSalesforceConfigurationRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateSalesforceConfigurationRequest(unittest.TestCase): - """CreateSalesforceConfigurationRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateSalesforceConfigurationRequest(self): - """Test CreateSalesforceConfigurationRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_salesforce_configuration_request.CreateSalesforceConfigurationRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_subscription_batch_request.py b/test/test_create_subscription_batch_request.py deleted file mode 100644 index aecff55..0000000 --- a/test/test_create_subscription_batch_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_subscription_batch_request import CreateSubscriptionBatchRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateSubscriptionBatchRequest(unittest.TestCase): - """CreateSubscriptionBatchRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateSubscriptionBatchRequest(self): - """Test CreateSubscriptionBatchRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_subscription_batch_request.CreateSubscriptionBatchRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_subscription_charge_amendment.py b/test/test_create_subscription_charge_amendment.py deleted file mode 100644 index 5ccd936..0000000 --- a/test/test_create_subscription_charge_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_subscription_charge_amendment import CreateSubscriptionChargeAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateSubscriptionChargeAmendment(unittest.TestCase): - """CreateSubscriptionChargeAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateSubscriptionChargeAmendment(self): - """Test CreateSubscriptionChargeAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_subscription_charge_amendment.CreateSubscriptionChargeAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_subscription_checkout_definition_request.py b/test/test_create_subscription_checkout_definition_request.py deleted file mode 100644 index d94efc2..0000000 --- a/test/test_create_subscription_checkout_definition_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_subscription_checkout_definition_request import CreateSubscriptionCheckoutDefinitionRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateSubscriptionCheckoutDefinitionRequest(unittest.TestCase): - """CreateSubscriptionCheckoutDefinitionRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateSubscriptionCheckoutDefinitionRequest(self): - """Test CreateSubscriptionCheckoutDefinitionRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_subscription_checkout_definition_request.CreateSubscriptionCheckoutDefinitionRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_subscription_request.py b/test/test_create_subscription_request.py deleted file mode 100644 index 77579c1..0000000 --- a/test/test_create_subscription_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_subscription_request import CreateSubscriptionRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateSubscriptionRequest(unittest.TestCase): - """CreateSubscriptionRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateSubscriptionRequest(self): - """Test CreateSubscriptionRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_subscription_request.CreateSubscriptionRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_subscription_timer_request.py b/test/test_create_subscription_timer_request.py deleted file mode 100644 index b5b76ad..0000000 --- a/test/test_create_subscription_timer_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_subscription_timer_request import CreateSubscriptionTimerRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateSubscriptionTimerRequest(unittest.TestCase): - """CreateSubscriptionTimerRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateSubscriptionTimerRequest(self): - """Test CreateSubscriptionTimerRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_subscription_timer_request.CreateSubscriptionTimerRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_create_totp_request.py b/test/test_create_totp_request.py deleted file mode 100644 index 175a688..0000000 --- a/test/test_create_totp_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.create_totp_request import CreateTOTPRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreateTOTPRequest(unittest.TestCase): - """CreateTOTPRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreateTOTPRequest(self): - """Test CreateTOTPRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.create_totp_request.CreateTOTPRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_credit_account_request.py b/test/test_credit_account_request.py deleted file mode 100644 index 034b610..0000000 --- a/test/test_credit_account_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.credit_account_request import CreditAccountRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreditAccountRequest(unittest.TestCase): - """CreditAccountRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreditAccountRequest(self): - """Test CreditAccountRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.credit_account_request.CreditAccountRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_credit_note.py b/test/test_credit_note.py deleted file mode 100644 index 7eb7b47..0000000 --- a/test/test_credit_note.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.credit_note import CreditNote # noqa: E501 -from billforward.rest import ApiException - - -class TestCreditNote(unittest.TestCase): - """CreditNote unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreditNote(self): - """Test CreditNote""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.credit_note.CreditNote() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_credit_note_currency.py b/test/test_credit_note_currency.py deleted file mode 100644 index 3cfaba6..0000000 --- a/test/test_credit_note_currency.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.credit_note_currency import CreditNoteCurrency # noqa: E501 -from billforward.rest import ApiException - - -class TestCreditNoteCurrency(unittest.TestCase): - """CreditNoteCurrency unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreditNoteCurrency(self): - """Test CreditNoteCurrency""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.credit_note_currency.CreditNoteCurrency() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_credit_note_payment.py b/test/test_credit_note_payment.py deleted file mode 100644 index 470dab0..0000000 --- a/test/test_credit_note_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.credit_note_payment import CreditNotePayment # noqa: E501 -from billforward.rest import ApiException - - -class TestCreditNotePayment(unittest.TestCase): - """CreditNotePayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreditNotePayment(self): - """Test CreditNotePayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.credit_note_payment.CreditNotePayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_credit_subscription_request.py b/test/test_credit_subscription_request.py deleted file mode 100644 index 3049da8..0000000 --- a/test/test_credit_subscription_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.credit_subscription_request import CreditSubscriptionRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestCreditSubscriptionRequest(unittest.TestCase): - """CreditSubscriptionRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCreditSubscriptionRequest(self): - """Test CreditSubscriptionRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.credit_subscription_request.CreditSubscriptionRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_cybersource_configuration.py b/test/test_cybersource_configuration.py deleted file mode 100644 index 49af897..0000000 --- a/test/test_cybersource_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.cybersource_configuration import CybersourceConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestCybersourceConfiguration(unittest.TestCase): - """CybersourceConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCybersourceConfiguration(self): - """Test CybersourceConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.cybersource_configuration.CybersourceConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_cybersource_payment.py b/test/test_cybersource_payment.py deleted file mode 100644 index eb39b6d..0000000 --- a/test/test_cybersource_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.cybersource_payment import CybersourcePayment # noqa: E501 -from billforward.rest import ApiException - - -class TestCybersourcePayment(unittest.TestCase): - """CybersourcePayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testCybersourcePayment(self): - """Test CybersourcePayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.cybersource_payment.CybersourcePayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_data_sync_job_error_response.py b/test/test_data_sync_job_error_response.py deleted file mode 100644 index 7d8002d..0000000 --- a/test/test_data_sync_job_error_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.data_sync_job_error_response import DataSyncJobErrorResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestDataSyncJobErrorResponse(unittest.TestCase): - """DataSyncJobErrorResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testDataSyncJobErrorResponse(self): - """Test DataSyncJobErrorResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.data_sync_job_error_response.DataSyncJobErrorResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_data_sync_job_response.py b/test/test_data_sync_job_response.py deleted file mode 100644 index 9ce6716..0000000 --- a/test/test_data_sync_job_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.data_sync_job_response import DataSyncJobResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestDataSyncJobResponse(unittest.TestCase): - """DataSyncJobResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testDataSyncJobResponse(self): - """Test DataSyncJobResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.data_sync_job_response.DataSyncJobResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_default_api.py b/test/test_default_api.py deleted file mode 100644 index 0f1ee1c..0000000 --- a/test/test_default_api.py +++ /dev/null @@ -1,51 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.default_api import DefaultApi # noqa: E501 -from billforward.rest import ApiException - - -class TestDefaultApi(unittest.TestCase): - """DefaultApi unit test stubs""" - - def setUp(self): - self.api = DefaultApi() # noqa: E501 - - def tearDown(self): - pass - - def test_create_totp_secret(self): - """Test case for create_totp_secret - - """ - pass - - def test_enable2fa(self): - """Test case for enable2fa - - """ - pass - - def test_get_qr_code(self): - """Test case for get_qr_code - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_dunning_api.py b/test/test_dunning_api.py deleted file mode 100644 index 5d7a505..0000000 --- a/test/test_dunning_api.py +++ /dev/null @@ -1,69 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.dunning_api import DunningApi # noqa: E501 -from billforward.rest import ApiException - - -class TestDunningApi(unittest.TestCase): - """DunningApi unit test stubs""" - - def setUp(self): - self.api = DunningApi() # noqa: E501 - - def tearDown(self): - pass - - def test_create_dunning_line(self): - """Test case for create_dunning_line - - """ - pass - - def test_get_all_dunning_lines(self): - """Test case for get_all_dunning_lines - - """ - pass - - def test_get_dunning_line_by_attempt_index(self): - """Test case for get_dunning_line_by_attempt_index - - """ - pass - - def test_get_dunning_line_by_id(self): - """Test case for get_dunning_line_by_id - - """ - pass - - def test_retire_dunning_line(self): - """Test case for retire_dunning_line - - """ - pass - - def test_update_dunning_line(self): - """Test case for update_dunning_line - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_dunning_line.py b/test/test_dunning_line.py deleted file mode 100644 index ef31caa..0000000 --- a/test/test_dunning_line.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.dunning_line import DunningLine # noqa: E501 -from billforward.rest import ApiException - - -class TestDunningLine(unittest.TestCase): - """DunningLine unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testDunningLine(self): - """Test DunningLine""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.dunning_line.DunningLine() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_ebanx_api.py b/test/test_ebanx_api.py deleted file mode 100644 index 2bd7a79..0000000 --- a/test/test_ebanx_api.py +++ /dev/null @@ -1,57 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.ebanx_api import EBANXApi # noqa: E501 -from billforward.rest import ApiException - - -class TestEBANXApi(unittest.TestCase): - """EBANXApi unit test stubs""" - - def setUp(self): - self.api = EBANXApi() # noqa: E501 - - def tearDown(self): - pass - - def test_delete_configuration1(self): - """Test case for delete_configuration1 - - """ - pass - - def test_get_configuration1(self): - """Test case for get_configuration1 - - """ - pass - - def test_handle_webhook(self): - """Test case for handle_webhook - - """ - pass - - def test_upsert_configuration1(self): - """Test case for upsert_configuration1 - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_ebanx_auth_capture_request.py b/test/test_ebanx_auth_capture_request.py deleted file mode 100644 index c7076e3..0000000 --- a/test/test_ebanx_auth_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.ebanx_auth_capture_request import EBANXAuthCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestEBANXAuthCaptureRequest(unittest.TestCase): - """EBANXAuthCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEBANXAuthCaptureRequest(self): - """Test EBANXAuthCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.ebanx_auth_capture_request.EBANXAuthCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_ebanx_configuration.py b/test/test_ebanx_configuration.py deleted file mode 100644 index 8c669ed..0000000 --- a/test/test_ebanx_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.ebanx_configuration import EBANXConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestEBANXConfiguration(unittest.TestCase): - """EBANXConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEBANXConfiguration(self): - """Test EBANXConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.ebanx_configuration.EBANXConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_ebanx_gateway_request.py b/test/test_ebanx_gateway_request.py deleted file mode 100644 index 10aae1f..0000000 --- a/test/test_ebanx_gateway_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.ebanx_gateway_request import EBANXGatewayRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestEBANXGatewayRequest(unittest.TestCase): - """EBANXGatewayRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEBANXGatewayRequest(self): - """Test EBANXGatewayRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.ebanx_gateway_request.EBANXGatewayRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_ebanx_payment.py b/test/test_ebanx_payment.py deleted file mode 100644 index 15996a4..0000000 --- a/test/test_ebanx_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.ebanx_payment import EBANXPayment # noqa: E501 -from billforward.rest import ApiException - - -class TestEBANXPayment(unittest.TestCase): - """EBANXPayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEBANXPayment(self): - """Test EBANXPayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.ebanx_payment.EBANXPayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_ebanx_webhook.py b/test/test_ebanx_webhook.py deleted file mode 100644 index 0799295..0000000 --- a/test/test_ebanx_webhook.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.ebanx_webhook import EBANXWebhook # noqa: E501 -from billforward.rest import ApiException - - -class TestEBANXWebhook(unittest.TestCase): - """EBANXWebhook unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEBANXWebhook(self): - """Test EBANXWebhook""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.ebanx_webhook.EBANXWebhook() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_email_tokenization.py b/test/test_email_tokenization.py deleted file mode 100644 index d6c3f5d..0000000 --- a/test/test_email_tokenization.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.email_tokenization import EmailTokenization # noqa: E501 -from billforward.rest import ApiException - - -class TestEmailTokenization(unittest.TestCase): - """EmailTokenization unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEmailTokenization(self): - """Test EmailTokenization""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.email_tokenization.EmailTokenization() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_email_tokenization_create_api_request.py b/test/test_email_tokenization_create_api_request.py deleted file mode 100644 index 2a4eed2..0000000 --- a/test/test_email_tokenization_create_api_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.email_tokenization_create_api_request import EmailTokenizationCreateAPIRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestEmailTokenizationCreateAPIRequest(unittest.TestCase): - """EmailTokenizationCreateAPIRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEmailTokenizationCreateAPIRequest(self): - """Test EmailTokenizationCreateAPIRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.email_tokenization_create_api_request.EmailTokenizationCreateAPIRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_email_tokenization_send_api_request.py b/test/test_email_tokenization_send_api_request.py deleted file mode 100644 index f2ea0cb..0000000 --- a/test/test_email_tokenization_send_api_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.email_tokenization_send_api_request import EmailTokenizationSendAPIRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestEmailTokenizationSendAPIRequest(unittest.TestCase): - """EmailTokenizationSendAPIRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEmailTokenizationSendAPIRequest(self): - """Test EmailTokenizationSendAPIRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.email_tokenization_send_api_request.EmailTokenizationSendAPIRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_email_tokenization_update_api_request.py b/test/test_email_tokenization_update_api_request.py deleted file mode 100644 index ebe2f8d..0000000 --- a/test/test_email_tokenization_update_api_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.email_tokenization_update_api_request import EmailTokenizationUpdateAPIRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestEmailTokenizationUpdateAPIRequest(unittest.TestCase): - """EmailTokenizationUpdateAPIRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEmailTokenizationUpdateAPIRequest(self): - """Test EmailTokenizationUpdateAPIRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.email_tokenization_update_api_request.EmailTokenizationUpdateAPIRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_end_trial_amendment.py b/test/test_end_trial_amendment.py deleted file mode 100644 index 99e54fa..0000000 --- a/test/test_end_trial_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.end_trial_amendment import EndTrialAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestEndTrialAmendment(unittest.TestCase): - """EndTrialAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEndTrialAmendment(self): - """Test EndTrialAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.end_trial_amendment.EndTrialAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_epx_capture_request.py b/test/test_epx_capture_request.py deleted file mode 100644 index b1a2a21..0000000 --- a/test/test_epx_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.epx_capture_request import EpxCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestEpxCaptureRequest(unittest.TestCase): - """EpxCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEpxCaptureRequest(self): - """Test EpxCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.epx_capture_request.EpxCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_epx_configuration.py b/test/test_epx_configuration.py deleted file mode 100644 index 9fa5b7a..0000000 --- a/test/test_epx_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.epx_configuration import EpxConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestEpxConfiguration(unittest.TestCase): - """EpxConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEpxConfiguration(self): - """Test EpxConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.epx_configuration.EpxConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_epx_payment.py b/test/test_epx_payment.py deleted file mode 100644 index 9306b4b..0000000 --- a/test/test_epx_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.epx_payment import EpxPayment # noqa: E501 -from billforward.rest import ApiException - - -class TestEpxPayment(unittest.TestCase): - """EpxPayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEpxPayment(self): - """Test EpxPayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.epx_payment.EpxPayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_epx_pre_auth_request.py b/test/test_epx_pre_auth_request.py deleted file mode 100644 index f466b50..0000000 --- a/test/test_epx_pre_auth_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.epx_pre_auth_request import EpxPreAuthRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestEpxPreAuthRequest(unittest.TestCase): - """EpxPreAuthRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEpxPreAuthRequest(self): - """Test EpxPreAuthRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.epx_pre_auth_request.EpxPreAuthRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_epx_pre_auth_response.py b/test/test_epx_pre_auth_response.py deleted file mode 100644 index 3f7aaf1..0000000 --- a/test/test_epx_pre_auth_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.epx_pre_auth_response import EpxPreAuthResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestEpxPreAuthResponse(unittest.TestCase): - """EpxPreAuthResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testEpxPreAuthResponse(self): - """Test EpxPreAuthResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.epx_pre_auth_response.EpxPreAuthResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_execution_receipt_response.py b/test/test_execution_receipt_response.py deleted file mode 100644 index f5902fc..0000000 --- a/test/test_execution_receipt_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.execution_receipt_response import ExecutionReceiptResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestExecutionReceiptResponse(unittest.TestCase): - """ExecutionReceiptResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testExecutionReceiptResponse(self): - """Test ExecutionReceiptResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.execution_receipt_response.ExecutionReceiptResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_execution_response.py b/test/test_execution_response.py deleted file mode 100644 index c3c5a3e..0000000 --- a/test/test_execution_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.execution_response import ExecutionResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestExecutionResponse(unittest.TestCase): - """ExecutionResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testExecutionResponse(self): - """Test ExecutionResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.execution_response.ExecutionResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_extras.py b/test/test_extras.py deleted file mode 100644 index 7c268ff..0000000 --- a/test/test_extras.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.extras import Extras # noqa: E501 -from billforward.rest import ApiException - - -class TestExtras(unittest.TestCase): - """Extras unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testExtras(self): - """Test Extras""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.extras.Extras() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_fixed_term.py b/test/test_fixed_term.py deleted file mode 100644 index da496d2..0000000 --- a/test/test_fixed_term.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.fixed_term import FixedTerm # noqa: E501 -from billforward.rest import ApiException - - -class TestFixedTerm(unittest.TestCase): - """FixedTerm unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testFixedTerm(self): - """Test FixedTerm""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.fixed_term.FixedTerm() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_fixed_term_definition.py b/test/test_fixed_term_definition.py deleted file mode 100644 index b657db6..0000000 --- a/test/test_fixed_term_definition.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.fixed_term_definition import FixedTermDefinition # noqa: E501 -from billforward.rest import ApiException - - -class TestFixedTermDefinition(unittest.TestCase): - """FixedTermDefinition unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testFixedTermDefinition(self): - """Test FixedTermDefinition""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.fixed_term_definition.FixedTermDefinition() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_fixed_term_expiry_amendment.py b/test/test_fixed_term_expiry_amendment.py deleted file mode 100644 index d5cacbf..0000000 --- a/test/test_fixed_term_expiry_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.fixed_term_expiry_amendment import FixedTermExpiryAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestFixedTermExpiryAmendment(unittest.TestCase): - """FixedTermExpiryAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testFixedTermExpiryAmendment(self): - """Test FixedTermExpiryAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.fixed_term_expiry_amendment.FixedTermExpiryAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_flat_advance_pricing_component.py b/test/test_flat_advance_pricing_component.py deleted file mode 100644 index 115bee8..0000000 --- a/test/test_flat_advance_pricing_component.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.flat_advance_pricing_component import FlatAdvancePricingComponent # noqa: E501 -from billforward.rest import ApiException - - -class TestFlatAdvancePricingComponent(unittest.TestCase): - """FlatAdvancePricingComponent unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testFlatAdvancePricingComponent(self): - """Test FlatAdvancePricingComponent""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.flat_advance_pricing_component.FlatAdvancePricingComponent() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_flat_arrears_pricing_component.py b/test/test_flat_arrears_pricing_component.py deleted file mode 100644 index aaf8823..0000000 --- a/test/test_flat_arrears_pricing_component.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.flat_arrears_pricing_component import FlatArrearsPricingComponent # noqa: E501 -from billforward.rest import ApiException - - -class TestFlatArrearsPricingComponent(unittest.TestCase): - """FlatArrearsPricingComponent unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testFlatArrearsPricingComponent(self): - """Test FlatArrearsPricingComponent""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.flat_arrears_pricing_component.FlatArrearsPricingComponent() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_flat_pricing_component.py b/test/test_flat_pricing_component.py deleted file mode 100644 index a812cea..0000000 --- a/test/test_flat_pricing_component.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.flat_pricing_component import FlatPricingComponent # noqa: E501 -from billforward.rest import ApiException - - -class TestFlatPricingComponent(unittest.TestCase): - """FlatPricingComponent unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testFlatPricingComponent(self): - """Test FlatPricingComponent""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.flat_pricing_component.FlatPricingComponent() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_flat_setup_pricing_component.py b/test/test_flat_setup_pricing_component.py deleted file mode 100644 index 6e77c24..0000000 --- a/test/test_flat_setup_pricing_component.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.flat_setup_pricing_component import FlatSetupPricingComponent # noqa: E501 -from billforward.rest import ApiException - - -class TestFlatSetupPricingComponent(unittest.TestCase): - """FlatSetupPricingComponent unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testFlatSetupPricingComponent(self): - """Test FlatSetupPricingComponent""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.flat_setup_pricing_component.FlatSetupPricingComponent() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_flat_usage_pricing_component.py b/test/test_flat_usage_pricing_component.py deleted file mode 100644 index cec5b39..0000000 --- a/test/test_flat_usage_pricing_component.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.flat_usage_pricing_component import FlatUsagePricingComponent # noqa: E501 -from billforward.rest import ApiException - - -class TestFlatUsagePricingComponent(unittest.TestCase): - """FlatUsagePricingComponent unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testFlatUsagePricingComponent(self): - """Test FlatUsagePricingComponent""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.flat_usage_pricing_component.FlatUsagePricingComponent() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_get_rate_plan_affiliate_response.py b/test/test_get_rate_plan_affiliate_response.py deleted file mode 100644 index d8f6c7a..0000000 --- a/test/test_get_rate_plan_affiliate_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.get_rate_plan_affiliate_response import GetRatePlanAffiliateResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestGetRatePlanAffiliateResponse(unittest.TestCase): - """GetRatePlanAffiliateResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testGetRatePlanAffiliateResponse(self): - """Test GetRatePlanAffiliateResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.get_rate_plan_affiliate_response.GetRatePlanAffiliateResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_get_subscription_affiliate_response.py b/test/test_get_subscription_affiliate_response.py deleted file mode 100644 index 1a587f8..0000000 --- a/test/test_get_subscription_affiliate_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.get_subscription_affiliate_response import GetSubscriptionAffiliateResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestGetSubscriptionAffiliateResponse(unittest.TestCase): - """GetSubscriptionAffiliateResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testGetSubscriptionAffiliateResponse(self): - """Test GetSubscriptionAffiliateResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.get_subscription_affiliate_response.GetSubscriptionAffiliateResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_go_cardless_configuration.py b/test/test_go_cardless_configuration.py deleted file mode 100644 index c40cd66..0000000 --- a/test/test_go_cardless_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.go_cardless_configuration import GoCardlessConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestGoCardlessConfiguration(unittest.TestCase): - """GoCardlessConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testGoCardlessConfiguration(self): - """Test GoCardlessConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.go_cardless_configuration.GoCardlessConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_go_cardless_tokenization_request.py b/test/test_go_cardless_tokenization_request.py deleted file mode 100644 index 2aee6af..0000000 --- a/test/test_go_cardless_tokenization_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.go_cardless_tokenization_request import GoCardlessTokenizationRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestGoCardlessTokenizationRequest(unittest.TestCase): - """GoCardlessTokenizationRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testGoCardlessTokenizationRequest(self): - """Test GoCardlessTokenizationRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.go_cardless_tokenization_request.GoCardlessTokenizationRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_halt_aggregation_request.py b/test/test_halt_aggregation_request.py deleted file mode 100644 index 649a664..0000000 --- a/test/test_halt_aggregation_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.halt_aggregation_request import HaltAggregationRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestHaltAggregationRequest(unittest.TestCase): - """HaltAggregationRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testHaltAggregationRequest(self): - """Test HaltAggregationRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.halt_aggregation_request.HaltAggregationRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_halt_aggregation_response.py b/test/test_halt_aggregation_response.py deleted file mode 100644 index d651f0e..0000000 --- a/test/test_halt_aggregation_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.halt_aggregation_response import HaltAggregationResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestHaltAggregationResponse(unittest.TestCase): - """HaltAggregationResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testHaltAggregationResponse(self): - """Test HaltAggregationResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.halt_aggregation_response.HaltAggregationResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_hosted_payment.py b/test/test_hosted_payment.py deleted file mode 100644 index f554114..0000000 --- a/test/test_hosted_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.hosted_payment import HostedPayment # noqa: E501 -from billforward.rest import ApiException - - -class TestHostedPayment(unittest.TestCase): - """HostedPayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testHostedPayment(self): - """Test HostedPayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.hosted_payment.HostedPayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_hosted_payment_config.py b/test/test_hosted_payment_config.py deleted file mode 100644 index 3599dc2..0000000 --- a/test/test_hosted_payment_config.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.hosted_payment_config import HostedPaymentConfig # noqa: E501 -from billforward.rest import ApiException - - -class TestHostedPaymentConfig(unittest.TestCase): - """HostedPaymentConfig unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testHostedPaymentConfig(self): - """Test HostedPaymentConfig""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.hosted_payment_config.HostedPaymentConfig() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_i_discardable.py b/test/test_i_discardable.py deleted file mode 100644 index 578dc6c..0000000 --- a/test/test_i_discardable.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.i_discardable import IDiscardable # noqa: E501 -from billforward.rest import ApiException - - -class TestIDiscardable(unittest.TestCase): - """IDiscardable unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testIDiscardable(self): - """Test IDiscardable""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.i_discardable.IDiscardable() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_import_invoice_line.py b/test/test_import_invoice_line.py deleted file mode 100644 index ad34f3f..0000000 --- a/test/test_import_invoice_line.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.import_invoice_line import ImportInvoiceLine # noqa: E501 -from billforward.rest import ApiException - - -class TestImportInvoiceLine(unittest.TestCase): - """ImportInvoiceLine unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testImportInvoiceLine(self): - """Test ImportInvoiceLine""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.import_invoice_line.ImportInvoiceLine() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_import_invoice_request.py b/test/test_import_invoice_request.py deleted file mode 100644 index 88ad1ba..0000000 --- a/test/test_import_invoice_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.import_invoice_request import ImportInvoiceRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestImportInvoiceRequest(unittest.TestCase): - """ImportInvoiceRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testImportInvoiceRequest(self): - """Test ImportInvoiceRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.import_invoice_request.ImportInvoiceRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_import_subscription_request.py b/test/test_import_subscription_request.py deleted file mode 100644 index 5426a89..0000000 --- a/test/test_import_subscription_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.import_subscription_request import ImportSubscriptionRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestImportSubscriptionRequest(unittest.TestCase): - """ImportSubscriptionRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testImportSubscriptionRequest(self): - """Test ImportSubscriptionRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.import_subscription_request.ImportSubscriptionRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default.py b/test/test_inline_response_default.py deleted file mode 100644 index 22c08c1..0000000 --- a/test/test_inline_response_default.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default import InlineResponseDefault # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault(unittest.TestCase): - """InlineResponseDefault unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault(self): - """Test InlineResponseDefault""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default.InlineResponseDefault() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default1.py b/test/test_inline_response_default1.py deleted file mode 100644 index 98861a5..0000000 --- a/test/test_inline_response_default1.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default1 import InlineResponseDefault1 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault1(unittest.TestCase): - """InlineResponseDefault1 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault1(self): - """Test InlineResponseDefault1""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default1.InlineResponseDefault1() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default10.py b/test/test_inline_response_default10.py deleted file mode 100644 index fdcf2c3..0000000 --- a/test/test_inline_response_default10.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default10 import InlineResponseDefault10 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault10(unittest.TestCase): - """InlineResponseDefault10 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault10(self): - """Test InlineResponseDefault10""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default10.InlineResponseDefault10() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default100.py b/test/test_inline_response_default100.py deleted file mode 100644 index 0401836..0000000 --- a/test/test_inline_response_default100.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default100 import InlineResponseDefault100 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault100(unittest.TestCase): - """InlineResponseDefault100 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault100(self): - """Test InlineResponseDefault100""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default100.InlineResponseDefault100() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default101.py b/test/test_inline_response_default101.py deleted file mode 100644 index 9679f43..0000000 --- a/test/test_inline_response_default101.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default101 import InlineResponseDefault101 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault101(unittest.TestCase): - """InlineResponseDefault101 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault101(self): - """Test InlineResponseDefault101""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default101.InlineResponseDefault101() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default102.py b/test/test_inline_response_default102.py deleted file mode 100644 index 77410fc..0000000 --- a/test/test_inline_response_default102.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default102 import InlineResponseDefault102 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault102(unittest.TestCase): - """InlineResponseDefault102 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault102(self): - """Test InlineResponseDefault102""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default102.InlineResponseDefault102() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default103.py b/test/test_inline_response_default103.py deleted file mode 100644 index 9b2aa73..0000000 --- a/test/test_inline_response_default103.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default103 import InlineResponseDefault103 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault103(unittest.TestCase): - """InlineResponseDefault103 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault103(self): - """Test InlineResponseDefault103""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default103.InlineResponseDefault103() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default11.py b/test/test_inline_response_default11.py deleted file mode 100644 index 0c48c21..0000000 --- a/test/test_inline_response_default11.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default11 import InlineResponseDefault11 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault11(unittest.TestCase): - """InlineResponseDefault11 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault11(self): - """Test InlineResponseDefault11""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default11.InlineResponseDefault11() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default12.py b/test/test_inline_response_default12.py deleted file mode 100644 index 07e2ea4..0000000 --- a/test/test_inline_response_default12.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default12 import InlineResponseDefault12 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault12(unittest.TestCase): - """InlineResponseDefault12 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault12(self): - """Test InlineResponseDefault12""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default12.InlineResponseDefault12() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default13.py b/test/test_inline_response_default13.py deleted file mode 100644 index 39a45b5..0000000 --- a/test/test_inline_response_default13.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default13 import InlineResponseDefault13 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault13(unittest.TestCase): - """InlineResponseDefault13 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault13(self): - """Test InlineResponseDefault13""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default13.InlineResponseDefault13() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default14.py b/test/test_inline_response_default14.py deleted file mode 100644 index dcff552..0000000 --- a/test/test_inline_response_default14.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default14 import InlineResponseDefault14 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault14(unittest.TestCase): - """InlineResponseDefault14 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault14(self): - """Test InlineResponseDefault14""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default14.InlineResponseDefault14() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default15.py b/test/test_inline_response_default15.py deleted file mode 100644 index 75206d2..0000000 --- a/test/test_inline_response_default15.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default15 import InlineResponseDefault15 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault15(unittest.TestCase): - """InlineResponseDefault15 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault15(self): - """Test InlineResponseDefault15""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default15.InlineResponseDefault15() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default16.py b/test/test_inline_response_default16.py deleted file mode 100644 index b39422f..0000000 --- a/test/test_inline_response_default16.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default16 import InlineResponseDefault16 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault16(unittest.TestCase): - """InlineResponseDefault16 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault16(self): - """Test InlineResponseDefault16""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default16.InlineResponseDefault16() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default17.py b/test/test_inline_response_default17.py deleted file mode 100644 index 3d146c7..0000000 --- a/test/test_inline_response_default17.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default17 import InlineResponseDefault17 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault17(unittest.TestCase): - """InlineResponseDefault17 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault17(self): - """Test InlineResponseDefault17""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default17.InlineResponseDefault17() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default18.py b/test/test_inline_response_default18.py deleted file mode 100644 index 0ceada7..0000000 --- a/test/test_inline_response_default18.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default18 import InlineResponseDefault18 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault18(unittest.TestCase): - """InlineResponseDefault18 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault18(self): - """Test InlineResponseDefault18""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default18.InlineResponseDefault18() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default19.py b/test/test_inline_response_default19.py deleted file mode 100644 index 4e7cafa..0000000 --- a/test/test_inline_response_default19.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default19 import InlineResponseDefault19 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault19(unittest.TestCase): - """InlineResponseDefault19 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault19(self): - """Test InlineResponseDefault19""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default19.InlineResponseDefault19() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default2.py b/test/test_inline_response_default2.py deleted file mode 100644 index 81a9f35..0000000 --- a/test/test_inline_response_default2.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default2 import InlineResponseDefault2 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault2(unittest.TestCase): - """InlineResponseDefault2 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault2(self): - """Test InlineResponseDefault2""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default2.InlineResponseDefault2() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default20.py b/test/test_inline_response_default20.py deleted file mode 100644 index b2ab54a..0000000 --- a/test/test_inline_response_default20.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default20 import InlineResponseDefault20 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault20(unittest.TestCase): - """InlineResponseDefault20 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault20(self): - """Test InlineResponseDefault20""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default20.InlineResponseDefault20() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default21.py b/test/test_inline_response_default21.py deleted file mode 100644 index 3cb3db1..0000000 --- a/test/test_inline_response_default21.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default21 import InlineResponseDefault21 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault21(unittest.TestCase): - """InlineResponseDefault21 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault21(self): - """Test InlineResponseDefault21""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default21.InlineResponseDefault21() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default22.py b/test/test_inline_response_default22.py deleted file mode 100644 index 68052a1..0000000 --- a/test/test_inline_response_default22.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default22 import InlineResponseDefault22 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault22(unittest.TestCase): - """InlineResponseDefault22 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault22(self): - """Test InlineResponseDefault22""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default22.InlineResponseDefault22() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default23.py b/test/test_inline_response_default23.py deleted file mode 100644 index 0821c7e..0000000 --- a/test/test_inline_response_default23.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default23 import InlineResponseDefault23 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault23(unittest.TestCase): - """InlineResponseDefault23 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault23(self): - """Test InlineResponseDefault23""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default23.InlineResponseDefault23() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default24.py b/test/test_inline_response_default24.py deleted file mode 100644 index 946b3b6..0000000 --- a/test/test_inline_response_default24.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default24 import InlineResponseDefault24 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault24(unittest.TestCase): - """InlineResponseDefault24 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault24(self): - """Test InlineResponseDefault24""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default24.InlineResponseDefault24() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default25.py b/test/test_inline_response_default25.py deleted file mode 100644 index e489ca5..0000000 --- a/test/test_inline_response_default25.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default25 import InlineResponseDefault25 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault25(unittest.TestCase): - """InlineResponseDefault25 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault25(self): - """Test InlineResponseDefault25""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default25.InlineResponseDefault25() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default26.py b/test/test_inline_response_default26.py deleted file mode 100644 index 2063a17..0000000 --- a/test/test_inline_response_default26.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default26 import InlineResponseDefault26 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault26(unittest.TestCase): - """InlineResponseDefault26 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault26(self): - """Test InlineResponseDefault26""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default26.InlineResponseDefault26() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default27.py b/test/test_inline_response_default27.py deleted file mode 100644 index 2f51775..0000000 --- a/test/test_inline_response_default27.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default27 import InlineResponseDefault27 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault27(unittest.TestCase): - """InlineResponseDefault27 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault27(self): - """Test InlineResponseDefault27""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default27.InlineResponseDefault27() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default28.py b/test/test_inline_response_default28.py deleted file mode 100644 index ab798e9..0000000 --- a/test/test_inline_response_default28.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default28 import InlineResponseDefault28 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault28(unittest.TestCase): - """InlineResponseDefault28 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault28(self): - """Test InlineResponseDefault28""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default28.InlineResponseDefault28() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default29.py b/test/test_inline_response_default29.py deleted file mode 100644 index fb2ebf7..0000000 --- a/test/test_inline_response_default29.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default29 import InlineResponseDefault29 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault29(unittest.TestCase): - """InlineResponseDefault29 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault29(self): - """Test InlineResponseDefault29""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default29.InlineResponseDefault29() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default3.py b/test/test_inline_response_default3.py deleted file mode 100644 index cbd3a6f..0000000 --- a/test/test_inline_response_default3.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default3 import InlineResponseDefault3 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault3(unittest.TestCase): - """InlineResponseDefault3 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault3(self): - """Test InlineResponseDefault3""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default3.InlineResponseDefault3() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default30.py b/test/test_inline_response_default30.py deleted file mode 100644 index 64c2b80..0000000 --- a/test/test_inline_response_default30.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default30 import InlineResponseDefault30 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault30(unittest.TestCase): - """InlineResponseDefault30 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault30(self): - """Test InlineResponseDefault30""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default30.InlineResponseDefault30() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default31.py b/test/test_inline_response_default31.py deleted file mode 100644 index 0e2da13..0000000 --- a/test/test_inline_response_default31.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default31 import InlineResponseDefault31 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault31(unittest.TestCase): - """InlineResponseDefault31 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault31(self): - """Test InlineResponseDefault31""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default31.InlineResponseDefault31() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default32.py b/test/test_inline_response_default32.py deleted file mode 100644 index 37bf00d..0000000 --- a/test/test_inline_response_default32.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default32 import InlineResponseDefault32 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault32(unittest.TestCase): - """InlineResponseDefault32 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault32(self): - """Test InlineResponseDefault32""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default32.InlineResponseDefault32() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default33.py b/test/test_inline_response_default33.py deleted file mode 100644 index ee54782..0000000 --- a/test/test_inline_response_default33.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default33 import InlineResponseDefault33 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault33(unittest.TestCase): - """InlineResponseDefault33 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault33(self): - """Test InlineResponseDefault33""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default33.InlineResponseDefault33() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default34.py b/test/test_inline_response_default34.py deleted file mode 100644 index 26cdf5b..0000000 --- a/test/test_inline_response_default34.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default34 import InlineResponseDefault34 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault34(unittest.TestCase): - """InlineResponseDefault34 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault34(self): - """Test InlineResponseDefault34""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default34.InlineResponseDefault34() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default35.py b/test/test_inline_response_default35.py deleted file mode 100644 index 343405b..0000000 --- a/test/test_inline_response_default35.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default35 import InlineResponseDefault35 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault35(unittest.TestCase): - """InlineResponseDefault35 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault35(self): - """Test InlineResponseDefault35""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default35.InlineResponseDefault35() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default36.py b/test/test_inline_response_default36.py deleted file mode 100644 index f9d18ae..0000000 --- a/test/test_inline_response_default36.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default36 import InlineResponseDefault36 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault36(unittest.TestCase): - """InlineResponseDefault36 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault36(self): - """Test InlineResponseDefault36""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default36.InlineResponseDefault36() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default37.py b/test/test_inline_response_default37.py deleted file mode 100644 index d82f51f..0000000 --- a/test/test_inline_response_default37.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default37 import InlineResponseDefault37 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault37(unittest.TestCase): - """InlineResponseDefault37 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault37(self): - """Test InlineResponseDefault37""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default37.InlineResponseDefault37() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default38.py b/test/test_inline_response_default38.py deleted file mode 100644 index 0619db6..0000000 --- a/test/test_inline_response_default38.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default38 import InlineResponseDefault38 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault38(unittest.TestCase): - """InlineResponseDefault38 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault38(self): - """Test InlineResponseDefault38""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default38.InlineResponseDefault38() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default39.py b/test/test_inline_response_default39.py deleted file mode 100644 index 8fffab2..0000000 --- a/test/test_inline_response_default39.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default39 import InlineResponseDefault39 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault39(unittest.TestCase): - """InlineResponseDefault39 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault39(self): - """Test InlineResponseDefault39""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default39.InlineResponseDefault39() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default4.py b/test/test_inline_response_default4.py deleted file mode 100644 index 7e9ddd4..0000000 --- a/test/test_inline_response_default4.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default4 import InlineResponseDefault4 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault4(unittest.TestCase): - """InlineResponseDefault4 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault4(self): - """Test InlineResponseDefault4""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default4.InlineResponseDefault4() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default40.py b/test/test_inline_response_default40.py deleted file mode 100644 index 2cf89ab..0000000 --- a/test/test_inline_response_default40.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default40 import InlineResponseDefault40 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault40(unittest.TestCase): - """InlineResponseDefault40 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault40(self): - """Test InlineResponseDefault40""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default40.InlineResponseDefault40() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default41.py b/test/test_inline_response_default41.py deleted file mode 100644 index 282057f..0000000 --- a/test/test_inline_response_default41.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default41 import InlineResponseDefault41 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault41(unittest.TestCase): - """InlineResponseDefault41 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault41(self): - """Test InlineResponseDefault41""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default41.InlineResponseDefault41() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default42.py b/test/test_inline_response_default42.py deleted file mode 100644 index d432b1b..0000000 --- a/test/test_inline_response_default42.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default42 import InlineResponseDefault42 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault42(unittest.TestCase): - """InlineResponseDefault42 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault42(self): - """Test InlineResponseDefault42""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default42.InlineResponseDefault42() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default43.py b/test/test_inline_response_default43.py deleted file mode 100644 index 9c1d151..0000000 --- a/test/test_inline_response_default43.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default43 import InlineResponseDefault43 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault43(unittest.TestCase): - """InlineResponseDefault43 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault43(self): - """Test InlineResponseDefault43""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default43.InlineResponseDefault43() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default44.py b/test/test_inline_response_default44.py deleted file mode 100644 index 2f16264..0000000 --- a/test/test_inline_response_default44.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default44 import InlineResponseDefault44 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault44(unittest.TestCase): - """InlineResponseDefault44 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault44(self): - """Test InlineResponseDefault44""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default44.InlineResponseDefault44() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default45.py b/test/test_inline_response_default45.py deleted file mode 100644 index a3c1b58..0000000 --- a/test/test_inline_response_default45.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default45 import InlineResponseDefault45 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault45(unittest.TestCase): - """InlineResponseDefault45 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault45(self): - """Test InlineResponseDefault45""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default45.InlineResponseDefault45() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default46.py b/test/test_inline_response_default46.py deleted file mode 100644 index c8ffa4b..0000000 --- a/test/test_inline_response_default46.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default46 import InlineResponseDefault46 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault46(unittest.TestCase): - """InlineResponseDefault46 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault46(self): - """Test InlineResponseDefault46""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default46.InlineResponseDefault46() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default47.py b/test/test_inline_response_default47.py deleted file mode 100644 index 6fde643..0000000 --- a/test/test_inline_response_default47.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default47 import InlineResponseDefault47 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault47(unittest.TestCase): - """InlineResponseDefault47 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault47(self): - """Test InlineResponseDefault47""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default47.InlineResponseDefault47() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default48.py b/test/test_inline_response_default48.py deleted file mode 100644 index e1dad78..0000000 --- a/test/test_inline_response_default48.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default48 import InlineResponseDefault48 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault48(unittest.TestCase): - """InlineResponseDefault48 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault48(self): - """Test InlineResponseDefault48""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default48.InlineResponseDefault48() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default49.py b/test/test_inline_response_default49.py deleted file mode 100644 index 83988e7..0000000 --- a/test/test_inline_response_default49.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default49 import InlineResponseDefault49 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault49(unittest.TestCase): - """InlineResponseDefault49 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault49(self): - """Test InlineResponseDefault49""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default49.InlineResponseDefault49() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default5.py b/test/test_inline_response_default5.py deleted file mode 100644 index c04d707..0000000 --- a/test/test_inline_response_default5.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default5 import InlineResponseDefault5 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault5(unittest.TestCase): - """InlineResponseDefault5 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault5(self): - """Test InlineResponseDefault5""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default5.InlineResponseDefault5() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default50.py b/test/test_inline_response_default50.py deleted file mode 100644 index 446e51a..0000000 --- a/test/test_inline_response_default50.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default50 import InlineResponseDefault50 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault50(unittest.TestCase): - """InlineResponseDefault50 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault50(self): - """Test InlineResponseDefault50""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default50.InlineResponseDefault50() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default51.py b/test/test_inline_response_default51.py deleted file mode 100644 index 3ab31e0..0000000 --- a/test/test_inline_response_default51.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default51 import InlineResponseDefault51 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault51(unittest.TestCase): - """InlineResponseDefault51 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault51(self): - """Test InlineResponseDefault51""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default51.InlineResponseDefault51() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default52.py b/test/test_inline_response_default52.py deleted file mode 100644 index 2ce876d..0000000 --- a/test/test_inline_response_default52.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default52 import InlineResponseDefault52 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault52(unittest.TestCase): - """InlineResponseDefault52 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault52(self): - """Test InlineResponseDefault52""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default52.InlineResponseDefault52() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default53.py b/test/test_inline_response_default53.py deleted file mode 100644 index c530acd..0000000 --- a/test/test_inline_response_default53.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default53 import InlineResponseDefault53 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault53(unittest.TestCase): - """InlineResponseDefault53 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault53(self): - """Test InlineResponseDefault53""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default53.InlineResponseDefault53() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default54.py b/test/test_inline_response_default54.py deleted file mode 100644 index c6092e6..0000000 --- a/test/test_inline_response_default54.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default54 import InlineResponseDefault54 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault54(unittest.TestCase): - """InlineResponseDefault54 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault54(self): - """Test InlineResponseDefault54""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default54.InlineResponseDefault54() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default55.py b/test/test_inline_response_default55.py deleted file mode 100644 index 3e995f7..0000000 --- a/test/test_inline_response_default55.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default55 import InlineResponseDefault55 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault55(unittest.TestCase): - """InlineResponseDefault55 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault55(self): - """Test InlineResponseDefault55""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default55.InlineResponseDefault55() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default56.py b/test/test_inline_response_default56.py deleted file mode 100644 index 77256e4..0000000 --- a/test/test_inline_response_default56.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default56 import InlineResponseDefault56 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault56(unittest.TestCase): - """InlineResponseDefault56 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault56(self): - """Test InlineResponseDefault56""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default56.InlineResponseDefault56() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default57.py b/test/test_inline_response_default57.py deleted file mode 100644 index 7d1b501..0000000 --- a/test/test_inline_response_default57.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default57 import InlineResponseDefault57 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault57(unittest.TestCase): - """InlineResponseDefault57 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault57(self): - """Test InlineResponseDefault57""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default57.InlineResponseDefault57() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default58.py b/test/test_inline_response_default58.py deleted file mode 100644 index 4215e55..0000000 --- a/test/test_inline_response_default58.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default58 import InlineResponseDefault58 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault58(unittest.TestCase): - """InlineResponseDefault58 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault58(self): - """Test InlineResponseDefault58""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default58.InlineResponseDefault58() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default59.py b/test/test_inline_response_default59.py deleted file mode 100644 index 2c8c1e9..0000000 --- a/test/test_inline_response_default59.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default59 import InlineResponseDefault59 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault59(unittest.TestCase): - """InlineResponseDefault59 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault59(self): - """Test InlineResponseDefault59""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default59.InlineResponseDefault59() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default6.py b/test/test_inline_response_default6.py deleted file mode 100644 index dab6449..0000000 --- a/test/test_inline_response_default6.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default6 import InlineResponseDefault6 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault6(unittest.TestCase): - """InlineResponseDefault6 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault6(self): - """Test InlineResponseDefault6""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default6.InlineResponseDefault6() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default60.py b/test/test_inline_response_default60.py deleted file mode 100644 index 85fc55a..0000000 --- a/test/test_inline_response_default60.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default60 import InlineResponseDefault60 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault60(unittest.TestCase): - """InlineResponseDefault60 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault60(self): - """Test InlineResponseDefault60""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default60.InlineResponseDefault60() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default61.py b/test/test_inline_response_default61.py deleted file mode 100644 index 70be84a..0000000 --- a/test/test_inline_response_default61.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default61 import InlineResponseDefault61 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault61(unittest.TestCase): - """InlineResponseDefault61 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault61(self): - """Test InlineResponseDefault61""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default61.InlineResponseDefault61() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default62.py b/test/test_inline_response_default62.py deleted file mode 100644 index fa51416..0000000 --- a/test/test_inline_response_default62.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default62 import InlineResponseDefault62 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault62(unittest.TestCase): - """InlineResponseDefault62 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault62(self): - """Test InlineResponseDefault62""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default62.InlineResponseDefault62() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default63.py b/test/test_inline_response_default63.py deleted file mode 100644 index 0f68c3e..0000000 --- a/test/test_inline_response_default63.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default63 import InlineResponseDefault63 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault63(unittest.TestCase): - """InlineResponseDefault63 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault63(self): - """Test InlineResponseDefault63""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default63.InlineResponseDefault63() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default64.py b/test/test_inline_response_default64.py deleted file mode 100644 index 6ba9e9b..0000000 --- a/test/test_inline_response_default64.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default64 import InlineResponseDefault64 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault64(unittest.TestCase): - """InlineResponseDefault64 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault64(self): - """Test InlineResponseDefault64""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default64.InlineResponseDefault64() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default65.py b/test/test_inline_response_default65.py deleted file mode 100644 index f0c82dc..0000000 --- a/test/test_inline_response_default65.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default65 import InlineResponseDefault65 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault65(unittest.TestCase): - """InlineResponseDefault65 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault65(self): - """Test InlineResponseDefault65""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default65.InlineResponseDefault65() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default66.py b/test/test_inline_response_default66.py deleted file mode 100644 index 7198598..0000000 --- a/test/test_inline_response_default66.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default66 import InlineResponseDefault66 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault66(unittest.TestCase): - """InlineResponseDefault66 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault66(self): - """Test InlineResponseDefault66""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default66.InlineResponseDefault66() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default67.py b/test/test_inline_response_default67.py deleted file mode 100644 index 1849448..0000000 --- a/test/test_inline_response_default67.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default67 import InlineResponseDefault67 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault67(unittest.TestCase): - """InlineResponseDefault67 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault67(self): - """Test InlineResponseDefault67""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default67.InlineResponseDefault67() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default68.py b/test/test_inline_response_default68.py deleted file mode 100644 index 6b70b28..0000000 --- a/test/test_inline_response_default68.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default68 import InlineResponseDefault68 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault68(unittest.TestCase): - """InlineResponseDefault68 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault68(self): - """Test InlineResponseDefault68""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default68.InlineResponseDefault68() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default69.py b/test/test_inline_response_default69.py deleted file mode 100644 index a8c241d..0000000 --- a/test/test_inline_response_default69.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default69 import InlineResponseDefault69 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault69(unittest.TestCase): - """InlineResponseDefault69 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault69(self): - """Test InlineResponseDefault69""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default69.InlineResponseDefault69() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default7.py b/test/test_inline_response_default7.py deleted file mode 100644 index 1bffd5a..0000000 --- a/test/test_inline_response_default7.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default7 import InlineResponseDefault7 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault7(unittest.TestCase): - """InlineResponseDefault7 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault7(self): - """Test InlineResponseDefault7""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default7.InlineResponseDefault7() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default70.py b/test/test_inline_response_default70.py deleted file mode 100644 index 9617497..0000000 --- a/test/test_inline_response_default70.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default70 import InlineResponseDefault70 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault70(unittest.TestCase): - """InlineResponseDefault70 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault70(self): - """Test InlineResponseDefault70""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default70.InlineResponseDefault70() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default71.py b/test/test_inline_response_default71.py deleted file mode 100644 index 89a4c6e..0000000 --- a/test/test_inline_response_default71.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default71 import InlineResponseDefault71 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault71(unittest.TestCase): - """InlineResponseDefault71 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault71(self): - """Test InlineResponseDefault71""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default71.InlineResponseDefault71() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default72.py b/test/test_inline_response_default72.py deleted file mode 100644 index 3d86428..0000000 --- a/test/test_inline_response_default72.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default72 import InlineResponseDefault72 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault72(unittest.TestCase): - """InlineResponseDefault72 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault72(self): - """Test InlineResponseDefault72""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default72.InlineResponseDefault72() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default73.py b/test/test_inline_response_default73.py deleted file mode 100644 index 8821371..0000000 --- a/test/test_inline_response_default73.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default73 import InlineResponseDefault73 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault73(unittest.TestCase): - """InlineResponseDefault73 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault73(self): - """Test InlineResponseDefault73""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default73.InlineResponseDefault73() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default74.py b/test/test_inline_response_default74.py deleted file mode 100644 index 3001a47..0000000 --- a/test/test_inline_response_default74.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default74 import InlineResponseDefault74 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault74(unittest.TestCase): - """InlineResponseDefault74 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault74(self): - """Test InlineResponseDefault74""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default74.InlineResponseDefault74() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default75.py b/test/test_inline_response_default75.py deleted file mode 100644 index 8a36f6e..0000000 --- a/test/test_inline_response_default75.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default75 import InlineResponseDefault75 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault75(unittest.TestCase): - """InlineResponseDefault75 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault75(self): - """Test InlineResponseDefault75""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default75.InlineResponseDefault75() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default76.py b/test/test_inline_response_default76.py deleted file mode 100644 index 77615fa..0000000 --- a/test/test_inline_response_default76.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default76 import InlineResponseDefault76 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault76(unittest.TestCase): - """InlineResponseDefault76 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault76(self): - """Test InlineResponseDefault76""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default76.InlineResponseDefault76() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default77.py b/test/test_inline_response_default77.py deleted file mode 100644 index 6838109..0000000 --- a/test/test_inline_response_default77.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default77 import InlineResponseDefault77 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault77(unittest.TestCase): - """InlineResponseDefault77 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault77(self): - """Test InlineResponseDefault77""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default77.InlineResponseDefault77() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default78.py b/test/test_inline_response_default78.py deleted file mode 100644 index ada92e2..0000000 --- a/test/test_inline_response_default78.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default78 import InlineResponseDefault78 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault78(unittest.TestCase): - """InlineResponseDefault78 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault78(self): - """Test InlineResponseDefault78""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default78.InlineResponseDefault78() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default79.py b/test/test_inline_response_default79.py deleted file mode 100644 index 12ead53..0000000 --- a/test/test_inline_response_default79.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default79 import InlineResponseDefault79 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault79(unittest.TestCase): - """InlineResponseDefault79 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault79(self): - """Test InlineResponseDefault79""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default79.InlineResponseDefault79() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default8.py b/test/test_inline_response_default8.py deleted file mode 100644 index 268982d..0000000 --- a/test/test_inline_response_default8.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default8 import InlineResponseDefault8 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault8(unittest.TestCase): - """InlineResponseDefault8 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault8(self): - """Test InlineResponseDefault8""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default8.InlineResponseDefault8() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default80.py b/test/test_inline_response_default80.py deleted file mode 100644 index aeec8e9..0000000 --- a/test/test_inline_response_default80.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default80 import InlineResponseDefault80 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault80(unittest.TestCase): - """InlineResponseDefault80 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault80(self): - """Test InlineResponseDefault80""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default80.InlineResponseDefault80() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default81.py b/test/test_inline_response_default81.py deleted file mode 100644 index 5944c3e..0000000 --- a/test/test_inline_response_default81.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default81 import InlineResponseDefault81 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault81(unittest.TestCase): - """InlineResponseDefault81 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault81(self): - """Test InlineResponseDefault81""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default81.InlineResponseDefault81() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default82.py b/test/test_inline_response_default82.py deleted file mode 100644 index 27cfef6..0000000 --- a/test/test_inline_response_default82.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default82 import InlineResponseDefault82 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault82(unittest.TestCase): - """InlineResponseDefault82 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault82(self): - """Test InlineResponseDefault82""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default82.InlineResponseDefault82() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default83.py b/test/test_inline_response_default83.py deleted file mode 100644 index c051f33..0000000 --- a/test/test_inline_response_default83.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default83 import InlineResponseDefault83 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault83(unittest.TestCase): - """InlineResponseDefault83 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault83(self): - """Test InlineResponseDefault83""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default83.InlineResponseDefault83() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default84.py b/test/test_inline_response_default84.py deleted file mode 100644 index f3f2010..0000000 --- a/test/test_inline_response_default84.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default84 import InlineResponseDefault84 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault84(unittest.TestCase): - """InlineResponseDefault84 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault84(self): - """Test InlineResponseDefault84""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default84.InlineResponseDefault84() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default85.py b/test/test_inline_response_default85.py deleted file mode 100644 index 8032578..0000000 --- a/test/test_inline_response_default85.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default85 import InlineResponseDefault85 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault85(unittest.TestCase): - """InlineResponseDefault85 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault85(self): - """Test InlineResponseDefault85""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default85.InlineResponseDefault85() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default86.py b/test/test_inline_response_default86.py deleted file mode 100644 index d9aeceb..0000000 --- a/test/test_inline_response_default86.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default86 import InlineResponseDefault86 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault86(unittest.TestCase): - """InlineResponseDefault86 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault86(self): - """Test InlineResponseDefault86""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default86.InlineResponseDefault86() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default87.py b/test/test_inline_response_default87.py deleted file mode 100644 index 5c1824e..0000000 --- a/test/test_inline_response_default87.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default87 import InlineResponseDefault87 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault87(unittest.TestCase): - """InlineResponseDefault87 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault87(self): - """Test InlineResponseDefault87""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default87.InlineResponseDefault87() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default88.py b/test/test_inline_response_default88.py deleted file mode 100644 index 99e217d..0000000 --- a/test/test_inline_response_default88.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default88 import InlineResponseDefault88 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault88(unittest.TestCase): - """InlineResponseDefault88 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault88(self): - """Test InlineResponseDefault88""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default88.InlineResponseDefault88() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default89.py b/test/test_inline_response_default89.py deleted file mode 100644 index 219de00..0000000 --- a/test/test_inline_response_default89.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default89 import InlineResponseDefault89 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault89(unittest.TestCase): - """InlineResponseDefault89 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault89(self): - """Test InlineResponseDefault89""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default89.InlineResponseDefault89() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default9.py b/test/test_inline_response_default9.py deleted file mode 100644 index 237dcb8..0000000 --- a/test/test_inline_response_default9.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default9 import InlineResponseDefault9 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault9(unittest.TestCase): - """InlineResponseDefault9 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault9(self): - """Test InlineResponseDefault9""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default9.InlineResponseDefault9() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default90.py b/test/test_inline_response_default90.py deleted file mode 100644 index ce90e3b..0000000 --- a/test/test_inline_response_default90.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default90 import InlineResponseDefault90 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault90(unittest.TestCase): - """InlineResponseDefault90 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault90(self): - """Test InlineResponseDefault90""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default90.InlineResponseDefault90() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default91.py b/test/test_inline_response_default91.py deleted file mode 100644 index 065bfd7..0000000 --- a/test/test_inline_response_default91.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default91 import InlineResponseDefault91 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault91(unittest.TestCase): - """InlineResponseDefault91 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault91(self): - """Test InlineResponseDefault91""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default91.InlineResponseDefault91() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default92.py b/test/test_inline_response_default92.py deleted file mode 100644 index a461f0e..0000000 --- a/test/test_inline_response_default92.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default92 import InlineResponseDefault92 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault92(unittest.TestCase): - """InlineResponseDefault92 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault92(self): - """Test InlineResponseDefault92""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default92.InlineResponseDefault92() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default93.py b/test/test_inline_response_default93.py deleted file mode 100644 index 76fef3a..0000000 --- a/test/test_inline_response_default93.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default93 import InlineResponseDefault93 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault93(unittest.TestCase): - """InlineResponseDefault93 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault93(self): - """Test InlineResponseDefault93""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default93.InlineResponseDefault93() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default94.py b/test/test_inline_response_default94.py deleted file mode 100644 index ee285e9..0000000 --- a/test/test_inline_response_default94.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default94 import InlineResponseDefault94 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault94(unittest.TestCase): - """InlineResponseDefault94 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault94(self): - """Test InlineResponseDefault94""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default94.InlineResponseDefault94() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default95.py b/test/test_inline_response_default95.py deleted file mode 100644 index f7ebca5..0000000 --- a/test/test_inline_response_default95.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default95 import InlineResponseDefault95 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault95(unittest.TestCase): - """InlineResponseDefault95 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault95(self): - """Test InlineResponseDefault95""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default95.InlineResponseDefault95() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default96.py b/test/test_inline_response_default96.py deleted file mode 100644 index 60b9e74..0000000 --- a/test/test_inline_response_default96.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default96 import InlineResponseDefault96 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault96(unittest.TestCase): - """InlineResponseDefault96 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault96(self): - """Test InlineResponseDefault96""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default96.InlineResponseDefault96() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default97.py b/test/test_inline_response_default97.py deleted file mode 100644 index 183469c..0000000 --- a/test/test_inline_response_default97.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default97 import InlineResponseDefault97 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault97(unittest.TestCase): - """InlineResponseDefault97 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault97(self): - """Test InlineResponseDefault97""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default97.InlineResponseDefault97() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default98.py b/test/test_inline_response_default98.py deleted file mode 100644 index a4f9681..0000000 --- a/test/test_inline_response_default98.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default98 import InlineResponseDefault98 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault98(unittest.TestCase): - """InlineResponseDefault98 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault98(self): - """Test InlineResponseDefault98""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default98.InlineResponseDefault98() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_inline_response_default99.py b/test/test_inline_response_default99.py deleted file mode 100644 index e09b564..0000000 --- a/test/test_inline_response_default99.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.inline_response_default99 import InlineResponseDefault99 # noqa: E501 -from billforward.rest import ApiException - - -class TestInlineResponseDefault99(unittest.TestCase): - """InlineResponseDefault99 unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInlineResponseDefault99(self): - """Test InlineResponseDefault99""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.inline_response_default99.InlineResponseDefault99() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_interval_date.py b/test/test_interval_date.py deleted file mode 100644 index 5ae67ea..0000000 --- a/test/test_interval_date.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.interval_date import IntervalDate # noqa: E501 -from billforward.rest import ApiException - - -class TestIntervalDate(unittest.TestCase): - """IntervalDate unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testIntervalDate(self): - """Test IntervalDate""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.interval_date.IntervalDate() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice.py b/test/test_invoice.py deleted file mode 100644 index 5bee6aa..0000000 --- a/test/test_invoice.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice import Invoice # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoice(unittest.TestCase): - """Invoice unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoice(self): - """Test Invoice""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice.Invoice() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_charge_request.py b/test/test_invoice_charge_request.py deleted file mode 100644 index bb2f3e7..0000000 --- a/test/test_invoice_charge_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_charge_request import InvoiceChargeRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoiceChargeRequest(unittest.TestCase): - """InvoiceChargeRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceChargeRequest(self): - """Test InvoiceChargeRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_charge_request.InvoiceChargeRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_execution_request.py b/test/test_invoice_execution_request.py deleted file mode 100644 index 7c1e817..0000000 --- a/test/test_invoice_execution_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_execution_request import InvoiceExecutionRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoiceExecutionRequest(unittest.TestCase): - """InvoiceExecutionRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceExecutionRequest(self): - """Test InvoiceExecutionRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_execution_request.InvoiceExecutionRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_line_payments.py b/test/test_invoice_line_payments.py deleted file mode 100644 index b7fdb31..0000000 --- a/test/test_invoice_line_payments.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_line_payments import InvoiceLinePayments # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoiceLinePayments(unittest.TestCase): - """InvoiceLinePayments unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceLinePayments(self): - """Test InvoiceLinePayments""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_line_payments.InvoiceLinePayments() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_lines.py b/test/test_invoice_lines.py deleted file mode 100644 index aa1e601..0000000 --- a/test/test_invoice_lines.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_lines import InvoiceLines # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoiceLines(unittest.TestCase): - """InvoiceLines unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceLines(self): - """Test InvoiceLines""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_lines.InvoiceLines() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_next_execution_attempt_amendment.py b/test/test_invoice_next_execution_attempt_amendment.py deleted file mode 100644 index 60a4338..0000000 --- a/test/test_invoice_next_execution_attempt_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_next_execution_attempt_amendment import InvoiceNextExecutionAttemptAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoiceNextExecutionAttemptAmendment(unittest.TestCase): - """InvoiceNextExecutionAttemptAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceNextExecutionAttemptAmendment(self): - """Test InvoiceNextExecutionAttemptAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_next_execution_attempt_amendment.InvoiceNextExecutionAttemptAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_outstanding_charges_amendment.py b/test/test_invoice_outstanding_charges_amendment.py deleted file mode 100644 index cb2f234..0000000 --- a/test/test_invoice_outstanding_charges_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_outstanding_charges_amendment import InvoiceOutstandingChargesAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoiceOutstandingChargesAmendment(unittest.TestCase): - """InvoiceOutstandingChargesAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceOutstandingChargesAmendment(self): - """Test InvoiceOutstandingChargesAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_outstanding_charges_amendment.InvoiceOutstandingChargesAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_payments.py b/test/test_invoice_payments.py deleted file mode 100644 index cb24993..0000000 --- a/test/test_invoice_payments.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_payments import InvoicePayments # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoicePayments(unittest.TestCase): - """InvoicePayments unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoicePayments(self): - """Test InvoicePayments""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_payments.InvoicePayments() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_recalculation_amendment.py b/test/test_invoice_recalculation_amendment.py deleted file mode 100644 index a971d8d..0000000 --- a/test/test_invoice_recalculation_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_recalculation_amendment import InvoiceRecalculationAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoiceRecalculationAmendment(unittest.TestCase): - """InvoiceRecalculationAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceRecalculationAmendment(self): - """Test InvoiceRecalculationAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_recalculation_amendment.InvoiceRecalculationAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_recalculation_request.py b/test/test_invoice_recalculation_request.py deleted file mode 100644 index 2c09cbe..0000000 --- a/test/test_invoice_recalculation_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_recalculation_request import InvoiceRecalculationRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoiceRecalculationRequest(unittest.TestCase): - """InvoiceRecalculationRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceRecalculationRequest(self): - """Test InvoiceRecalculationRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_recalculation_request.InvoiceRecalculationRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_refund_request.py b/test/test_invoice_refund_request.py deleted file mode 100644 index 55cf72f..0000000 --- a/test/test_invoice_refund_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_refund_request import InvoiceRefundRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoiceRefundRequest(unittest.TestCase): - """InvoiceRefundRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceRefundRequest(self): - """Test InvoiceRefundRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_refund_request.InvoiceRefundRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_refund_response.py b/test/test_invoice_refund_response.py deleted file mode 100644 index 78fb21f..0000000 --- a/test/test_invoice_refund_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_refund_response import InvoiceRefundResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoiceRefundResponse(unittest.TestCase): - """InvoiceRefundResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceRefundResponse(self): - """Test InvoiceRefundResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_refund_response.InvoiceRefundResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_split.py b/test/test_invoice_split.py deleted file mode 100644 index f76d519..0000000 --- a/test/test_invoice_split.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_split import InvoiceSplit # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoiceSplit(unittest.TestCase): - """InvoiceSplit unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceSplit(self): - """Test InvoiceSplit""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_split.InvoiceSplit() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_split_service_request.py b/test/test_invoice_split_service_request.py deleted file mode 100644 index 67d543f..0000000 --- a/test/test_invoice_split_service_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_split_service_request import InvoiceSplitServiceRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoiceSplitServiceRequest(unittest.TestCase): - """InvoiceSplitServiceRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceSplitServiceRequest(self): - """Test InvoiceSplitServiceRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_split_service_request.InvoiceSplitServiceRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoice_template_config_response.py b/test/test_invoice_template_config_response.py deleted file mode 100644 index e14df6e..0000000 --- a/test/test_invoice_template_config_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.invoice_template_config_response import InvoiceTemplateConfigResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoiceTemplateConfigResponse(unittest.TestCase): - """InvoiceTemplateConfigResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testInvoiceTemplateConfigResponse(self): - """Test InvoiceTemplateConfigResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.invoice_template_config_response.InvoiceTemplateConfigResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_invoices_api.py b/test/test_invoices_api.py deleted file mode 100644 index 81bf684..0000000 --- a/test/test_invoices_api.py +++ /dev/null @@ -1,333 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.invoices_api import InvoicesApi # noqa: E501 -from billforward.rest import ApiException - - -class TestInvoicesApi(unittest.TestCase): - """InvoicesApi unit test stubs""" - - def setUp(self): - self.api = InvoicesApi() # noqa: E501 - - def tearDown(self): - pass - - def test_add_charge_to_invoice(self): - """Test case for add_charge_to_invoice - - """ - pass - - def test_execute_invoice(self): - """Test case for execute_invoice - - """ - pass - - def test_get_all_invoices(self): - """Test case for get_all_invoices - - """ - pass - - def test_get_all_invoices_as_csv(self): - """Test case for get_all_invoices_as_csv - - """ - pass - - def test_get_bucketed_revenue_attributions_as_csv(self): - """Test case for get_bucketed_revenue_attributions_as_csv - - """ - pass - - def test_get_charges_on_invoice(self): - """Test case for get_charges_on_invoice - - """ - pass - - def test_get_credit_invoice_line_payments_from_invoices_as_csv(self): - """Test case for get_credit_invoice_line_payments_from_invoices_as_csv - - """ - pass - - def test_get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received(self): - """Test case for get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received - - """ - pass - - def test_get_debit_invoice_line_payments_from_invoices_as_csv(self): - """Test case for get_debit_invoice_line_payments_from_invoices_as_csv - - """ - pass - - def test_get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received(self): - """Test case for get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received - - """ - pass - - def test_get_hosted_payments(self): - """Test case for get_hosted_payments - - """ - pass - - def test_get_invoice_as_html(self): - """Test case for get_invoice_as_html - - """ - pass - - def test_get_invoice_as_pdf(self): - """Test case for get_invoice_as_pdf - - """ - pass - - def test_get_invoice_by_id(self): - """Test case for get_invoice_by_id - - """ - pass - - def test_get_invoice_by_id_as_csv(self): - """Test case for get_invoice_by_id_as_csv - - """ - pass - - def test_get_invoice_by_subscription_id(self): - """Test case for get_invoice_by_subscription_id - - """ - pass - - def test_get_invoice_by_subscription_version_id(self): - """Test case for get_invoice_by_subscription_version_id - - """ - pass - - def test_get_invoice_by_version_id(self): - """Test case for get_invoice_by_version_id - - """ - pass - - def test_get_invoice_template(self): - """Test case for get_invoice_template - - """ - pass - - def test_get_invoices_by_account_id1(self): - """Test case for get_invoices_by_account_id1 - - """ - pass - - def test_get_invoices_by_period_end(self): - """Test case for get_invoices_by_period_end - - """ - pass - - def test_get_invoices_by_period_start(self): - """Test case for get_invoices_by_period_start - - """ - pass - - def test_get_invoices_by_period_start_as_csv(self): - """Test case for get_invoices_by_period_start_as_csv - - """ - pass - - def test_get_invoices_by_state(self): - """Test case for get_invoices_by_state - - """ - pass - - def test_get_invoices_by_state_and_period_start(self): - """Test case for get_invoices_by_state_and_period_start - - """ - pass - - def test_get_invoices_by_state_and_period_start_as_csv(self): - """Test case for get_invoices_by_state_and_period_start_as_csv - - """ - pass - - def test_get_invoices_by_state_as_csv(self): - """Test case for get_invoices_by_state_as_csv - - """ - pass - - def test_get_line_payments(self): - """Test case for get_line_payments - - """ - pass - - def test_get_line_payments_as_csv(self): - """Test case for get_line_payments_as_csv - - """ - pass - - def test_get_metadata_for_invoice(self): - """Test case for get_metadata_for_invoice - - """ - pass - - def test_get_refund_for_refunded_invoice(self): - """Test case for get_refund_for_refunded_invoice - - """ - pass - - def test_get_refund_invoice_line_payments_from_invoices_as_csv(self): - """Test case for get_refund_invoice_line_payments_from_invoices_as_csv - - """ - pass - - def test_get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received(self): - """Test case for get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received - - """ - pass - - def test_get_revenue_attributions(self): - """Test case for get_revenue_attributions - - """ - pass - - def test_get_revenue_attributions_as_csv(self): - """Test case for get_revenue_attributions_as_csv - - """ - pass - - def test_get_swagger_for_invoice(self): - """Test case for get_swagger_for_invoice - - """ - pass - - def test_import_invoice(self): - """Test case for import_invoice - - """ - pass - - def test_issue_invoice(self): - """Test case for issue_invoice - - """ - pass - - def test_list_original_invoice(self): - """Test case for list_original_invoice - - """ - pass - - def test_list_split_invoice(self): - """Test case for list_split_invoice - - """ - pass - - def test_recalculate_invoice(self): - """Test case for recalculate_invoice - - """ - pass - - def test_refund_invoice(self): - """Test case for refund_invoice - - """ - pass - - def test_remove_charge_from_invoice(self): - """Test case for remove_charge_from_invoice - - """ - pass - - def test_remove_metadata_from_invoice(self): - """Test case for remove_metadata_from_invoice - - """ - pass - - def test_set_metadata_for_invoice(self): - """Test case for set_metadata_for_invoice - - """ - pass - - def test_split_invoice(self): - """Test case for split_invoice - - """ - pass - - def test_update_invoice(self): - """Test case for update_invoice - - """ - pass - - def test_update_invoice_template(self): - """Test case for update_invoice_template - - """ - pass - - def test_upsert_metadata_for_invoice(self): - """Test case for upsert_metadata_for_invoice - - """ - pass - - def test_void_invoice(self): - """Test case for void_invoice - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_issue_invoice_amendment.py b/test/test_issue_invoice_amendment.py deleted file mode 100644 index 809ad70..0000000 --- a/test/test_issue_invoice_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.issue_invoice_amendment import IssueInvoiceAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestIssueInvoiceAmendment(unittest.TestCase): - """IssueInvoiceAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testIssueInvoiceAmendment(self): - """Test IssueInvoiceAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.issue_invoice_amendment.IssueInvoiceAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_issue_invoice_request.py b/test/test_issue_invoice_request.py deleted file mode 100644 index 2a8dbdb..0000000 --- a/test/test_issue_invoice_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.issue_invoice_request import IssueInvoiceRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestIssueInvoiceRequest(unittest.TestCase): - """IssueInvoiceRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testIssueInvoiceRequest(self): - """Test IssueInvoiceRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.issue_invoice_request.IssueInvoiceRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_issue_invoice_response.py b/test/test_issue_invoice_response.py deleted file mode 100644 index 9515263..0000000 --- a/test/test_issue_invoice_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.issue_invoice_response import IssueInvoiceResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestIssueInvoiceResponse(unittest.TestCase): - """IssueInvoiceResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testIssueInvoiceResponse(self): - """Test IssueInvoiceResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.issue_invoice_response.IssueInvoiceResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_kash_configuration.py b/test/test_kash_configuration.py deleted file mode 100644 index c80e382..0000000 --- a/test/test_kash_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.kash_configuration import KashConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestKashConfiguration(unittest.TestCase): - """KashConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testKashConfiguration(self): - """Test KashConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.kash_configuration.KashConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_legacy_create_webhook_request.py b/test/test_legacy_create_webhook_request.py deleted file mode 100644 index 1a3e63a..0000000 --- a/test/test_legacy_create_webhook_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.legacy_create_webhook_request import LegacyCreateWebhookRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestLegacyCreateWebhookRequest(unittest.TestCase): - """LegacyCreateWebhookRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testLegacyCreateWebhookRequest(self): - """Test LegacyCreateWebhookRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.legacy_create_webhook_request.LegacyCreateWebhookRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_manual_charge.py b/test/test_manual_charge.py deleted file mode 100644 index ae6e77e..0000000 --- a/test/test_manual_charge.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.manual_charge import ManualCharge # noqa: E501 -from billforward.rest import ApiException - - -class TestManualCharge(unittest.TestCase): - """ManualCharge unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testManualCharge(self): - """Test ManualCharge""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.manual_charge.ManualCharge() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_marketplace_quote.py b/test/test_marketplace_quote.py deleted file mode 100644 index 8296c0a..0000000 --- a/test/test_marketplace_quote.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.marketplace_quote import MarketplaceQuote # noqa: E501 -from billforward.rest import ApiException - - -class TestMarketplaceQuote(unittest.TestCase): - """MarketplaceQuote unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testMarketplaceQuote(self): - """Test MarketplaceQuote""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.marketplace_quote.MarketplaceQuote() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_metadata.py b/test/test_metadata.py deleted file mode 100644 index 6b946a1..0000000 --- a/test/test_metadata.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.metadata import Metadata # noqa: E501 -from billforward.rest import ApiException - - -class TestMetadata(unittest.TestCase): - """Metadata unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testMetadata(self): - """Test Metadata""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.metadata.Metadata() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_metadata_key_values.py b/test/test_metadata_key_values.py deleted file mode 100644 index e19b95e..0000000 --- a/test/test_metadata_key_values.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.metadata_key_values import MetadataKeyValues # noqa: E501 -from billforward.rest import ApiException - - -class TestMetadataKeyValues(unittest.TestCase): - """MetadataKeyValues unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testMetadataKeyValues(self): - """Test MetadataKeyValues""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.metadata_key_values.MetadataKeyValues() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_migration.py b/test/test_migration.py deleted file mode 100644 index b0699b5..0000000 --- a/test/test_migration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.migration import Migration # noqa: E501 -from billforward.rest import ApiException - - -class TestMigration(unittest.TestCase): - """Migration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testMigration(self): - """Test Migration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.migration.Migration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_migration_request.py b/test/test_migration_request.py deleted file mode 100644 index e457d47..0000000 --- a/test/test_migration_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.migration_request import MigrationRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestMigrationRequest(unittest.TestCase): - """MigrationRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testMigrationRequest(self): - """Test MigrationRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.migration_request.MigrationRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_migration_response.py b/test/test_migration_response.py deleted file mode 100644 index c2ff29b..0000000 --- a/test/test_migration_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.migration_response import MigrationResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestMigrationResponse(unittest.TestCase): - """MigrationResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testMigrationResponse(self): - """Test MigrationResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.migration_response.MigrationResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_nested_adhoc_charge_request.py b/test/test_nested_adhoc_charge_request.py deleted file mode 100644 index 42df30c..0000000 --- a/test/test_nested_adhoc_charge_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.nested_adhoc_charge_request import NestedAdhocChargeRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestNestedAdhocChargeRequest(unittest.TestCase): - """NestedAdhocChargeRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testNestedAdhocChargeRequest(self): - """Test NestedAdhocChargeRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.nested_adhoc_charge_request.NestedAdhocChargeRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_nested_charge_request.py b/test/test_nested_charge_request.py deleted file mode 100644 index b5d176e..0000000 --- a/test/test_nested_charge_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.nested_charge_request import NestedChargeRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestNestedChargeRequest(unittest.TestCase): - """NestedChargeRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testNestedChargeRequest(self): - """Test NestedChargeRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.nested_charge_request.NestedChargeRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_notification_send_request.py b/test/test_notification_send_request.py deleted file mode 100644 index 891b1ea..0000000 --- a/test/test_notification_send_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.notification_send_request import NotificationSendRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestNotificationSendRequest(unittest.TestCase): - """NotificationSendRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testNotificationSendRequest(self): - """Test NotificationSendRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.notification_send_request.NotificationSendRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_notification_send_response.py b/test/test_notification_send_response.py deleted file mode 100644 index b85a5a5..0000000 --- a/test/test_notification_send_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.notification_send_response import NotificationSendResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestNotificationSendResponse(unittest.TestCase): - """NotificationSendResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testNotificationSendResponse(self): - """Test NotificationSendResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.notification_send_response.NotificationSendResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_notifications.py b/test/test_notifications.py deleted file mode 100644 index 56f26bb..0000000 --- a/test/test_notifications.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.notifications import Notifications # noqa: E501 -from billforward.rest import ApiException - - -class TestNotifications(unittest.TestCase): - """Notifications unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testNotifications(self): - """Test Notifications""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.notifications.Notifications() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_notifications_api.py b/test/test_notifications_api.py deleted file mode 100644 index 40542a3..0000000 --- a/test/test_notifications_api.py +++ /dev/null @@ -1,69 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.notifications_api import NotificationsApi # noqa: E501 -from billforward.rest import ApiException - - -class TestNotificationsApi(unittest.TestCase): - """NotificationsApi unit test stubs""" - - def setUp(self): - self.api = NotificationsApi() # noqa: E501 - - def tearDown(self): - pass - - def test_get_all_notifications(self): - """Test case for get_all_notifications - - """ - pass - - def test_get_notification_by_entity_id(self): - """Test case for get_notification_by_entity_id - - """ - pass - - def test_get_notification_by_id(self): - """Test case for get_notification_by_id - - """ - pass - - def test_get_notifications_by_webhook_id(self): - """Test case for get_notifications_by_webhook_id - - """ - pass - - def test_get_notifications_within_date_range(self): - """Test case for get_notifications_within_date_range - - """ - pass - - def test_resend_notification(self): - """Test case for resend_notification - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_o_auth_token.py b/test/test_o_auth_token.py deleted file mode 100644 index 0dbc1ea..0000000 --- a/test/test_o_auth_token.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.o_auth_token import OAuthToken # noqa: E501 -from billforward.rest import ApiException - - -class TestOAuthToken(unittest.TestCase): - """OAuthToken unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testOAuthToken(self): - """Test OAuthToken""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.o_auth_token.OAuthToken() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_offline_payment.py b/test/test_offline_payment.py deleted file mode 100644 index 59bdd3d..0000000 --- a/test/test_offline_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.offline_payment import OfflinePayment # noqa: E501 -from billforward.rest import ApiException - - -class TestOfflinePayment(unittest.TestCase): - """OfflinePayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testOfflinePayment(self): - """Test OfflinePayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.offline_payment.OfflinePayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_open_id_registration_response.py b/test/test_open_id_registration_response.py deleted file mode 100644 index a694a24..0000000 --- a/test/test_open_id_registration_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.open_id_registration_response import OpenIDRegistrationResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestOpenIDRegistrationResponse(unittest.TestCase): - """OpenIDRegistrationResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testOpenIDRegistrationResponse(self): - """Test OpenIDRegistrationResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.open_id_registration_response.OpenIDRegistrationResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_open_id_user_link_request.py b/test/test_open_id_user_link_request.py deleted file mode 100644 index 8dbe7ae..0000000 --- a/test/test_open_id_user_link_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.open_id_user_link_request import OpenIdUserLinkRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestOpenIdUserLinkRequest(unittest.TestCase): - """OpenIdUserLinkRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testOpenIdUserLinkRequest(self): - """Test OpenIdUserLinkRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.open_id_user_link_request.OpenIdUserLinkRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_organization_lite_view.py b/test/test_organization_lite_view.py deleted file mode 100644 index 3f42b95..0000000 --- a/test/test_organization_lite_view.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.organization_lite_view import OrganizationLiteView # noqa: E501 -from billforward.rest import ApiException - - -class TestOrganizationLiteView(unittest.TestCase): - """OrganizationLiteView unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testOrganizationLiteView(self): - """Test OrganizationLiteView""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.organization_lite_view.OrganizationLiteView() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_password.py b/test/test_password.py deleted file mode 100644 index 13abdb7..0000000 --- a/test/test_password.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.password import Password # noqa: E501 -from billforward.rest import ApiException - - -class TestPassword(unittest.TestCase): - """Password unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPassword(self): - """Test Password""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.password.Password() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_password_reset_code_request.py b/test/test_password_reset_code_request.py deleted file mode 100644 index 6f27e03..0000000 --- a/test/test_password_reset_code_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.password_reset_code_request import PasswordResetCodeRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestPasswordResetCodeRequest(unittest.TestCase): - """PasswordResetCodeRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPasswordResetCodeRequest(self): - """Test PasswordResetCodeRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.password_reset_code_request.PasswordResetCodeRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_password_reset_response.py b/test/test_password_reset_response.py deleted file mode 100644 index ab95dd3..0000000 --- a/test/test_password_reset_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.password_reset_response import PasswordResetResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestPasswordResetResponse(unittest.TestCase): - """PasswordResetResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPasswordResetResponse(self): - """Test PasswordResetResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.password_reset_response.PasswordResetResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_password_update_with_reset_code_request.py b/test/test_password_update_with_reset_code_request.py deleted file mode 100644 index d0879c5..0000000 --- a/test/test_password_update_with_reset_code_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.password_update_with_reset_code_request import PasswordUpdateWithResetCodeRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestPasswordUpdateWithResetCodeRequest(unittest.TestCase): - """PasswordUpdateWithResetCodeRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPasswordUpdateWithResetCodeRequest(self): - """Test PasswordUpdateWithResetCodeRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.password_update_with_reset_code_request.PasswordUpdateWithResetCodeRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pause_request.py b/test/test_pause_request.py deleted file mode 100644 index d6d6439..0000000 --- a/test/test_pause_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pause_request import PauseRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestPauseRequest(unittest.TestCase): - """PauseRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPauseRequest(self): - """Test PauseRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pause_request.PauseRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pay_vision_auth_capture_request.py b/test/test_pay_vision_auth_capture_request.py deleted file mode 100644 index f325869..0000000 --- a/test/test_pay_vision_auth_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pay_vision_auth_capture_request import PayVisionAuthCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestPayVisionAuthCaptureRequest(unittest.TestCase): - """PayVisionAuthCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPayVisionAuthCaptureRequest(self): - """Test PayVisionAuthCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pay_vision_auth_capture_request.PayVisionAuthCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pay_vision_configuration.py b/test/test_pay_vision_configuration.py deleted file mode 100644 index 2c56308..0000000 --- a/test/test_pay_vision_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pay_vision_configuration import PayVisionConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestPayVisionConfiguration(unittest.TestCase): - """PayVisionConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPayVisionConfiguration(self): - """Test PayVisionConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pay_vision_configuration.PayVisionConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pay_vision_pre_auth_request.py b/test/test_pay_vision_pre_auth_request.py deleted file mode 100644 index 69b17f6..0000000 --- a/test/test_pay_vision_pre_auth_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pay_vision_pre_auth_request import PayVisionPreAuthRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestPayVisionPreAuthRequest(unittest.TestCase): - """PayVisionPreAuthRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPayVisionPreAuthRequest(self): - """Test PayVisionPreAuthRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pay_vision_pre_auth_request.PayVisionPreAuthRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payment.py b/test/test_payment.py deleted file mode 100644 index 48bb07b..0000000 --- a/test/test_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.payment import Payment # noqa: E501 -from billforward.rest import ApiException - - -class TestPayment(unittest.TestCase): - """Payment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPayment(self): - """Test Payment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.payment.Payment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payment_accounting_view.py b/test/test_payment_accounting_view.py deleted file mode 100644 index e73c8d3..0000000 --- a/test/test_payment_accounting_view.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.payment_accounting_view import PaymentAccountingView # noqa: E501 -from billforward.rest import ApiException - - -class TestPaymentAccountingView(unittest.TestCase): - """PaymentAccountingView unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPaymentAccountingView(self): - """Test PaymentAccountingView""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.payment_accounting_view.PaymentAccountingView() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payment_gateway_api.py b/test/test_payment_gateway_api.py deleted file mode 100644 index 1fd3c76..0000000 --- a/test/test_payment_gateway_api.py +++ /dev/null @@ -1,63 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.payment_gateway_api import PaymentGatewayApi # noqa: E501 -from billforward.rest import ApiException - - -class TestPaymentGatewayApi(unittest.TestCase): - """PaymentGatewayApi unit test stubs""" - - def setUp(self): - self.api = PaymentGatewayApi() # noqa: E501 - - def tearDown(self): - pass - - def test_create_api_configuration(self): - """Test case for create_api_configuration - - """ - pass - - def test_get_all_api_configurations(self): - """Test case for get_all_api_configurations - - """ - pass - - def test_get_api_configurations_by_type(self): - """Test case for get_api_configurations_by_type - - """ - pass - - def test_public_configuration(self): - """Test case for public_configuration - - """ - pass - - def test_update_api_configuration(self): - """Test case for update_api_configuration - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payment_method.py b/test/test_payment_method.py deleted file mode 100644 index b85de92..0000000 --- a/test/test_payment_method.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.payment_method import PaymentMethod # noqa: E501 -from billforward.rest import ApiException - - -class TestPaymentMethod(unittest.TestCase): - """PaymentMethod unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPaymentMethod(self): - """Test PaymentMethod""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.payment_method.PaymentMethod() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payment_method_subscription_link.py b/test/test_payment_method_subscription_link.py deleted file mode 100644 index 6bf84d6..0000000 --- a/test/test_payment_method_subscription_link.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.payment_method_subscription_link import PaymentMethodSubscriptionLink # noqa: E501 -from billforward.rest import ApiException - - -class TestPaymentMethodSubscriptionLink(unittest.TestCase): - """PaymentMethodSubscriptionLink unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPaymentMethodSubscriptionLink(self): - """Test PaymentMethodSubscriptionLink""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.payment_method_subscription_link.PaymentMethodSubscriptionLink() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payment_methods_api.py b/test/test_payment_methods_api.py deleted file mode 100644 index 2047f8f..0000000 --- a/test/test_payment_methods_api.py +++ /dev/null @@ -1,87 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.payment_methods_api import PaymentMethodsApi # noqa: E501 -from billforward.rest import ApiException - - -class TestPaymentMethodsApi(unittest.TestCase): - """PaymentMethodsApi unit test stubs""" - - def setUp(self): - self.api = PaymentMethodsApi() # noqa: E501 - - def tearDown(self): - pass - - def test_create_payment_method(self): - """Test case for create_payment_method - - """ - pass - - def test_delete_payment_method(self): - """Test case for delete_payment_method - - """ - pass - - def test_get_all_payment_methods(self): - """Test case for get_all_payment_methods - - """ - pass - - def test_get_mandate_pdf(self): - """Test case for get_mandate_pdf - - """ - pass - - def test_get_payment_method_by_id(self): - """Test case for get_payment_method_by_id - - """ - pass - - def test_get_payment_method_by_link_id(self): - """Test case for get_payment_method_by_link_id - - """ - pass - - def test_get_payment_method_by_payment_gateway(self): - """Test case for get_payment_method_by_payment_gateway - - """ - pass - - def test_update_payment_method(self): - """Test case for update_payment_method - - """ - pass - - def test_verify_ach(self): - """Test case for verify_ach - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payment_refund_request.py b/test/test_payment_refund_request.py deleted file mode 100644 index 012891e..0000000 --- a/test/test_payment_refund_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.payment_refund_request import PaymentRefundRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestPaymentRefundRequest(unittest.TestCase): - """PaymentRefundRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPaymentRefundRequest(self): - """Test PaymentRefundRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.payment_refund_request.PaymentRefundRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payment_refund_response.py b/test/test_payment_refund_response.py deleted file mode 100644 index 162e118..0000000 --- a/test/test_payment_refund_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.payment_refund_response import PaymentRefundResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestPaymentRefundResponse(unittest.TestCase): - """PaymentRefundResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPaymentRefundResponse(self): - """Test PaymentRefundResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.payment_refund_response.PaymentRefundResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payment_retry_request.py b/test/test_payment_retry_request.py deleted file mode 100644 index c2858ad..0000000 --- a/test/test_payment_retry_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.payment_retry_request import PaymentRetryRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestPaymentRetryRequest(unittest.TestCase): - """PaymentRetryRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPaymentRetryRequest(self): - """Test PaymentRetryRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.payment_retry_request.PaymentRetryRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_payments_api.py b/test/test_payments_api.py deleted file mode 100644 index ec4c480..0000000 --- a/test/test_payments_api.py +++ /dev/null @@ -1,93 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.payments_api import PaymentsApi # noqa: E501 -from billforward.rest import ApiException - - -class TestPaymentsApi(unittest.TestCase): - """PaymentsApi unit test stubs""" - - def setUp(self): - self.api = PaymentsApi() # noqa: E501 - - def tearDown(self): - pass - - def test_create_offline_payment(self): - """Test case for create_offline_payment - - """ - pass - - def test_create_payment(self): - """Test case for create_payment - - """ - pass - - def test_get_all_payments(self): - """Test case for get_all_payments - - """ - pass - - def test_get_payment_as_csv(self): - """Test case for get_payment_as_csv - - """ - pass - - def test_get_payment_by_id(self): - """Test case for get_payment_by_id - - """ - pass - - def test_get_payment_by_invoice_id(self): - """Test case for get_payment_by_invoice_id - - """ - pass - - def test_get_payment_by_payment_gateway(self): - """Test case for get_payment_by_payment_gateway - - """ - pass - - def test_get_payment_by_payment_method_id(self): - """Test case for get_payment_by_payment_method_id - - """ - pass - - def test_refund_payment(self): - """Test case for refund_payment - - """ - pass - - def test_update_payment(self): - """Test case for update_payment - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_paypal_configuration.py b/test/test_paypal_configuration.py deleted file mode 100644 index cd2388e..0000000 --- a/test/test_paypal_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.paypal_configuration import PaypalConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestPaypalConfiguration(unittest.TestCase): - """PaypalConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPaypalConfiguration(self): - """Test PaypalConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.paypal_configuration.PaypalConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_paypal_payment.py b/test/test_paypal_payment.py deleted file mode 100644 index 0b0e20f..0000000 --- a/test/test_paypal_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.paypal_payment import PaypalPayment # noqa: E501 -from billforward.rest import ApiException - - -class TestPaypalPayment(unittest.TestCase): - """PaypalPayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPaypalPayment(self): - """Test PaypalPayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.paypal_payment.PaypalPayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pending_component_value_change.py b/test/test_pending_component_value_change.py deleted file mode 100644 index 454c4a8..0000000 --- a/test/test_pending_component_value_change.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pending_component_value_change import PendingComponentValueChange # noqa: E501 -from billforward.rest import ApiException - - -class TestPendingComponentValueChange(unittest.TestCase): - """PendingComponentValueChange unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPendingComponentValueChange(self): - """Test PendingComponentValueChange""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pending_component_value_change.PendingComponentValueChange() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_permission_action_entity.py b/test/test_permission_action_entity.py deleted file mode 100644 index 75ff0e7..0000000 --- a/test/test_permission_action_entity.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.permission_action_entity import PermissionActionEntity # noqa: E501 -from billforward.rest import ApiException - - -class TestPermissionActionEntity(unittest.TestCase): - """PermissionActionEntity unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPermissionActionEntity(self): - """Test PermissionActionEntity""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.permission_action_entity.PermissionActionEntity() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_permission_resource_entity.py b/test/test_permission_resource_entity.py deleted file mode 100644 index cd047fe..0000000 --- a/test/test_permission_resource_entity.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.permission_resource_entity import PermissionResourceEntity # noqa: E501 -from billforward.rest import ApiException - - -class TestPermissionResourceEntity(unittest.TestCase): - """PermissionResourceEntity unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPermissionResourceEntity(self): - """Test PermissionResourceEntity""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.permission_resource_entity.PermissionResourceEntity() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_permissions_api.py b/test/test_permissions_api.py deleted file mode 100644 index b596404..0000000 --- a/test/test_permissions_api.py +++ /dev/null @@ -1,69 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.permissions_api import PermissionsApi # noqa: E501 -from billforward.rest import ApiException - - -class TestPermissionsApi(unittest.TestCase): - """PermissionsApi unit test stubs""" - - def setUp(self): - self.api = PermissionsApi() # noqa: E501 - - def tearDown(self): - pass - - def test_create_permission(self): - """Test case for create_permission - - """ - pass - - def test_get_all_permissions(self): - """Test case for get_all_permissions - - """ - pass - - def test_get_available_actions_for_resource(self): - """Test case for get_available_actions_for_resource - - """ - pass - - def test_get_available_resources(self): - """Test case for get_available_resources - - """ - pass - - def test_get_permission_by_id(self): - """Test case for get_permission_by_id - - """ - pass - - def test_revoke_permission(self): - """Test case for revoke_permission - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_plan_aggregation.py b/test/test_plan_aggregation.py deleted file mode 100644 index 8b32995..0000000 --- a/test/test_plan_aggregation.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.plan_aggregation import PlanAggregation # noqa: E501 -from billforward.rest import ApiException - - -class TestPlanAggregation(unittest.TestCase): - """PlanAggregation unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPlanAggregation(self): - """Test PlanAggregation""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.plan_aggregation.PlanAggregation() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_plan_request.py b/test/test_plan_request.py deleted file mode 100644 index 92fd84e..0000000 --- a/test/test_plan_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.plan_request import PlanRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestPlanRequest(unittest.TestCase): - """PlanRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPlanRequest(self): - """Test PlanRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.plan_request.PlanRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_plan_response.py b/test/test_plan_response.py deleted file mode 100644 index a6c9875..0000000 --- a/test/test_plan_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.plan_response import PlanResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestPlanResponse(unittest.TestCase): - """PlanResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPlanResponse(self): - """Test PlanResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.plan_response.PlanResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_plans_api.py b/test/test_plans_api.py deleted file mode 100644 index 932e836..0000000 --- a/test/test_plans_api.py +++ /dev/null @@ -1,51 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.plans_api import PlansApi # noqa: E501 -from billforward.rest import ApiException - - -class TestPlansApi(unittest.TestCase): - """PlansApi unit test stubs""" - - def setUp(self): - self.api = PlansApi() # noqa: E501 - - def tearDown(self): - pass - - def test_delete(self): - """Test case for delete - - """ - pass - - def test_find(self): - """Test case for find - - """ - pass - - def test_upsert(self): - """Test case for upsert - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_prepayment_charge.py b/test/test_prepayment_charge.py deleted file mode 100644 index f4cd88d..0000000 --- a/test/test_prepayment_charge.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.prepayment_charge import PrepaymentCharge # noqa: E501 -from billforward.rest import ApiException - - -class TestPrepaymentCharge(unittest.TestCase): - """PrepaymentCharge unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPrepaymentCharge(self): - """Test PrepaymentCharge""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.prepayment_charge.PrepaymentCharge() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_price_breakdown.py b/test/test_price_breakdown.py deleted file mode 100644 index 27de2a3..0000000 --- a/test/test_price_breakdown.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.price_breakdown import PriceBreakdown # noqa: E501 -from billforward.rest import ApiException - - -class TestPriceBreakdown(unittest.TestCase): - """PriceBreakdown unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPriceBreakdown(self): - """Test PriceBreakdown""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.price_breakdown.PriceBreakdown() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_price_line.py b/test/test_price_line.py deleted file mode 100644 index b58255f..0000000 --- a/test/test_price_line.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.price_line import PriceLine # noqa: E501 -from billforward.rest import ApiException - - -class TestPriceLine(unittest.TestCase): - """PriceLine unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPriceLine(self): - """Test PriceLine""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.price_line.PriceLine() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component.py b/test/test_pricing_component.py deleted file mode 100644 index a162ff8..0000000 --- a/test/test_pricing_component.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pricing_component import PricingComponent # noqa: E501 -from billforward.rest import ApiException - - -class TestPricingComponent(unittest.TestCase): - """PricingComponent unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponent(self): - """Test PricingComponent""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pricing_component.PricingComponent() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_charge.py b/test/test_pricing_component_charge.py deleted file mode 100644 index a2ff3da..0000000 --- a/test/test_pricing_component_charge.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pricing_component_charge import PricingComponentCharge # noqa: E501 -from billforward.rest import ApiException - - -class TestPricingComponentCharge(unittest.TestCase): - """PricingComponentCharge unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentCharge(self): - """Test PricingComponentCharge""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pricing_component_charge.PricingComponentCharge() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_migration_value.py b/test/test_pricing_component_migration_value.py deleted file mode 100644 index 912e434..0000000 --- a/test/test_pricing_component_migration_value.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pricing_component_migration_value import PricingComponentMigrationValue # noqa: E501 -from billforward.rest import ApiException - - -class TestPricingComponentMigrationValue(unittest.TestCase): - """PricingComponentMigrationValue unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentMigrationValue(self): - """Test PricingComponentMigrationValue""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pricing_component_migration_value.PricingComponentMigrationValue() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_tier.py b/test/test_pricing_component_tier.py deleted file mode 100644 index da6922b..0000000 --- a/test/test_pricing_component_tier.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pricing_component_tier import PricingComponentTier # noqa: E501 -from billforward.rest import ApiException - - -class TestPricingComponentTier(unittest.TestCase): - """PricingComponentTier unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentTier(self): - """Test PricingComponentTier""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pricing_component_tier.PricingComponentTier() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_value.py b/test/test_pricing_component_value.py deleted file mode 100644 index edc235e..0000000 --- a/test/test_pricing_component_value.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pricing_component_value import PricingComponentValue # noqa: E501 -from billforward.rest import ApiException - - -class TestPricingComponentValue(unittest.TestCase): - """PricingComponentValue unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentValue(self): - """Test PricingComponentValue""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pricing_component_value.PricingComponentValue() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_value_amendment.py b/test/test_pricing_component_value_amendment.py deleted file mode 100644 index deb03b3..0000000 --- a/test/test_pricing_component_value_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pricing_component_value_amendment import PricingComponentValueAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestPricingComponentValueAmendment(unittest.TestCase): - """PricingComponentValueAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentValueAmendment(self): - """Test PricingComponentValueAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pricing_component_value_amendment.PricingComponentValueAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_value_change.py b/test/test_pricing_component_value_change.py deleted file mode 100644 index 26c3637..0000000 --- a/test/test_pricing_component_value_change.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pricing_component_value_change import PricingComponentValueChange # noqa: E501 -from billforward.rest import ApiException - - -class TestPricingComponentValueChange(unittest.TestCase): - """PricingComponentValueChange unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentValueChange(self): - """Test PricingComponentValueChange""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pricing_component_value_change.PricingComponentValueChange() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_value_migration_amendment_mapping.py b/test/test_pricing_component_value_migration_amendment_mapping.py deleted file mode 100644 index 9134f84..0000000 --- a/test/test_pricing_component_value_migration_amendment_mapping.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pricing_component_value_migration_amendment_mapping import PricingComponentValueMigrationAmendmentMapping # noqa: E501 -from billforward.rest import ApiException - - -class TestPricingComponentValueMigrationAmendmentMapping(unittest.TestCase): - """PricingComponentValueMigrationAmendmentMapping unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentValueMigrationAmendmentMapping(self): - """Test PricingComponentValueMigrationAmendmentMapping""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pricing_component_value_migration_amendment_mapping.PricingComponentValueMigrationAmendmentMapping() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_value_request.py b/test/test_pricing_component_value_request.py deleted file mode 100644 index 1766757..0000000 --- a/test/test_pricing_component_value_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pricing_component_value_request import PricingComponentValueRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestPricingComponentValueRequest(unittest.TestCase): - """PricingComponentValueRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentValueRequest(self): - """Test PricingComponentValueRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pricing_component_value_request.PricingComponentValueRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_component_value_response.py b/test/test_pricing_component_value_response.py deleted file mode 100644 index e3725bb..0000000 --- a/test/test_pricing_component_value_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pricing_component_value_response import PricingComponentValueResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestPricingComponentValueResponse(unittest.TestCase): - """PricingComponentValueResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentValueResponse(self): - """Test PricingComponentValueResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pricing_component_value_response.PricingComponentValueResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_components_by_charge_type.py b/test/test_pricing_components_by_charge_type.py deleted file mode 100644 index 5630423..0000000 --- a/test/test_pricing_components_by_charge_type.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pricing_components_by_charge_type import PricingComponentsByChargeType # noqa: E501 -from billforward.rest import ApiException - - -class TestPricingComponentsByChargeType(unittest.TestCase): - """PricingComponentsByChargeType unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingComponentsByChargeType(self): - """Test PricingComponentsByChargeType""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pricing_components_by_charge_type.PricingComponentsByChargeType() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_pricing_tier.py b/test/test_pricing_tier.py deleted file mode 100644 index c769712..0000000 --- a/test/test_pricing_tier.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.pricing_tier import PricingTier # noqa: E501 -from billforward.rest import ApiException - - -class TestPricingTier(unittest.TestCase): - """PricingTier unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPricingTier(self): - """Test PricingTier""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.pricing_tier.PricingTier() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_product_rate_plan_migration_amendment.py b/test/test_product_rate_plan_migration_amendment.py deleted file mode 100644 index 50d8347..0000000 --- a/test/test_product_rate_plan_migration_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.product_rate_plan_migration_amendment import ProductRatePlanMigrationAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestProductRatePlanMigrationAmendment(unittest.TestCase): - """ProductRatePlanMigrationAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testProductRatePlanMigrationAmendment(self): - """Test ProductRatePlanMigrationAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.product_rate_plan_migration_amendment.ProductRatePlanMigrationAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_product_rate_plan_migration_charge.py b/test/test_product_rate_plan_migration_charge.py deleted file mode 100644 index dbe525d..0000000 --- a/test/test_product_rate_plan_migration_charge.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.product_rate_plan_migration_charge import ProductRatePlanMigrationCharge # noqa: E501 -from billforward.rest import ApiException - - -class TestProductRatePlanMigrationCharge(unittest.TestCase): - """ProductRatePlanMigrationCharge unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testProductRatePlanMigrationCharge(self): - """Test ProductRatePlanMigrationCharge""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.product_rate_plan_migration_charge.ProductRatePlanMigrationCharge() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_profile.py b/test/test_profile.py deleted file mode 100644 index ced4948..0000000 --- a/test/test_profile.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.profile import Profile # noqa: E501 -from billforward.rest import ApiException - - -class TestProfile(unittest.TestCase): - """Profile unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testProfile(self): - """Test Profile""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.profile.Profile() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_public_configuration_response.py b/test/test_public_configuration_response.py deleted file mode 100644 index 9131d18..0000000 --- a/test/test_public_configuration_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.public_configuration_response import PublicConfigurationResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestPublicConfigurationResponse(unittest.TestCase): - """PublicConfigurationResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testPublicConfigurationResponse(self): - """Test PublicConfigurationResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.public_configuration_response.PublicConfigurationResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_quote_request.py b/test/test_quote_request.py deleted file mode 100644 index 1ba4cd6..0000000 --- a/test/test_quote_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.quote_request import QuoteRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestQuoteRequest(unittest.TestCase): - """QuoteRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testQuoteRequest(self): - """Test QuoteRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.quote_request.QuoteRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_quote_request_value.py b/test/test_quote_request_value.py deleted file mode 100644 index cfc21a1..0000000 --- a/test/test_quote_request_value.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.quote_request_value import QuoteRequestValue # noqa: E501 -from billforward.rest import ApiException - - -class TestQuoteRequestValue(unittest.TestCase): - """QuoteRequestValue unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testQuoteRequestValue(self): - """Test QuoteRequestValue""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.quote_request_value.QuoteRequestValue() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_quotes_api.py b/test/test_quotes_api.py deleted file mode 100644 index f466701..0000000 --- a/test/test_quotes_api.py +++ /dev/null @@ -1,51 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.quotes_api import QuotesApi # noqa: E501 -from billforward.rest import ApiException - - -class TestQuotesApi(unittest.TestCase): - """QuotesApi unit test stubs""" - - def setUp(self): - self.api = QuotesApi() # noqa: E501 - - def tearDown(self): - pass - - def test_get_all_quotes(self): - """Test case for get_all_quotes - - """ - pass - - def test_get_quote_by_id(self): - """Test case for get_quote_by_id - - """ - pass - - def test_quote(self): - """Test case for quote - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_recalculate_charge_batch_request.py b/test/test_recalculate_charge_batch_request.py deleted file mode 100644 index d445438..0000000 --- a/test/test_recalculate_charge_batch_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.recalculate_charge_batch_request import RecalculateChargeBatchRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestRecalculateChargeBatchRequest(unittest.TestCase): - """RecalculateChargeBatchRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testRecalculateChargeBatchRequest(self): - """Test RecalculateChargeBatchRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.recalculate_charge_batch_request.RecalculateChargeBatchRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_recalculate_charge_batch_response.py b/test/test_recalculate_charge_batch_response.py deleted file mode 100644 index 2cee164..0000000 --- a/test/test_recalculate_charge_batch_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.recalculate_charge_batch_response import RecalculateChargeBatchResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestRecalculateChargeBatchResponse(unittest.TestCase): - """RecalculateChargeBatchResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testRecalculateChargeBatchResponse(self): - """Test RecalculateChargeBatchResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.recalculate_charge_batch_response.RecalculateChargeBatchResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_recalculate_charge_request.py b/test/test_recalculate_charge_request.py deleted file mode 100644 index 0bb16fd..0000000 --- a/test/test_recalculate_charge_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.recalculate_charge_request import RecalculateChargeRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestRecalculateChargeRequest(unittest.TestCase): - """RecalculateChargeRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testRecalculateChargeRequest(self): - """Test RecalculateChargeRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.recalculate_charge_request.RecalculateChargeRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_receipt.py b/test/test_receipt.py deleted file mode 100644 index 2965e02..0000000 --- a/test/test_receipt.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.receipt import Receipt # noqa: E501 -from billforward.rest import ApiException - - -class TestReceipt(unittest.TestCase): - """Receipt unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testReceipt(self): - """Test Receipt""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.receipt.Receipt() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_receipts_api.py b/test/test_receipts_api.py deleted file mode 100644 index 2332cda..0000000 --- a/test/test_receipts_api.py +++ /dev/null @@ -1,75 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.receipts_api import ReceiptsApi # noqa: E501 -from billforward.rest import ApiException - - -class TestReceiptsApi(unittest.TestCase): - """ReceiptsApi unit test stubs""" - - def setUp(self): - self.api = ReceiptsApi() # noqa: E501 - - def tearDown(self): - pass - - def test_create_receipt(self): - """Test case for create_receipt - - """ - pass - - def test_get_all_receipts(self): - """Test case for get_all_receipts - - """ - pass - - def test_get_receipt_by_id(self): - """Test case for get_receipt_by_id - - """ - pass - - def test_get_receipts_by_invoice(self): - """Test case for get_receipts_by_invoice - - """ - pass - - def test_get_receipts_by_payment(self): - """Test case for get_receipts_by_payment - - """ - pass - - def test_get_receipts_for_debit_payments_as_csv(self): - """Test case for get_receipts_for_debit_payments_as_csv - - """ - pass - - def test_get_receipts_for_refund_payments_as_csv(self): - """Test case for get_receipts_for_refund_payments_as_csv - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_refund.py b/test/test_refund.py deleted file mode 100644 index 3db92b5..0000000 --- a/test/test_refund.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.refund import Refund # noqa: E501 -from billforward.rest import ApiException - - -class TestRefund(unittest.TestCase): - """Refund unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testRefund(self): - """Test Refund""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.refund.Refund() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_refund_accounting_view.py b/test/test_refund_accounting_view.py deleted file mode 100644 index d29ecf0..0000000 --- a/test/test_refund_accounting_view.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.refund_accounting_view import RefundAccountingView # noqa: E501 -from billforward.rest import ApiException - - -class TestRefundAccountingView(unittest.TestCase): - """RefundAccountingView unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testRefundAccountingView(self): - """Test RefundAccountingView""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.refund_accounting_view.RefundAccountingView() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_remove_credit_account_request.py b/test/test_remove_credit_account_request.py deleted file mode 100644 index a382533..0000000 --- a/test/test_remove_credit_account_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.remove_credit_account_request import RemoveCreditAccountRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestRemoveCreditAccountRequest(unittest.TestCase): - """RemoveCreditAccountRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testRemoveCreditAccountRequest(self): - """Test RemoveCreditAccountRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.remove_credit_account_request.RemoveCreditAccountRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_reports_api.py b/test/test_reports_api.py deleted file mode 100644 index 18c89dd..0000000 --- a/test/test_reports_api.py +++ /dev/null @@ -1,105 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.reports_api import ReportsApi # noqa: E501 -from billforward.rest import ApiException - - -class TestReportsApi(unittest.TestCase): - """ReportsApi unit test stubs""" - - def setUp(self): - self.api = ReportsApi() # noqa: E501 - - def tearDown(self): - pass - - def test_get_accounts_overview(self): - """Test case for get_accounts_overview - - """ - pass - - def test_get_affiliate_charge_report(self): - """Test case for get_affiliate_charge_report - - """ - pass - - def test_get_coupon_report(self): - """Test case for get_coupon_report - - """ - pass - - def test_get_csv_report_invoice_line_payments_bucketed(self): - """Test case for get_csv_report_invoice_line_payments_bucketed - - """ - pass - - def test_get_csv_report_invoice_line_payments_raw(self): - """Test case for get_csv_report_invoice_line_payments_raw - - """ - pass - - def test_get_csv_report_revenue_attributions_bucketed(self): - """Test case for get_csv_report_revenue_attributions_bucketed - - """ - pass - - def test_get_csv_report_revenue_attributions_raw(self): - """Test case for get_csv_report_revenue_attributions_raw - - """ - pass - - def test_get_csv_revenue_schedule(self): - """Test case for get_csv_revenue_schedule - - """ - pass - - def test_get_payment_transactions(self): - """Test case for get_payment_transactions - - """ - pass - - def test_get_refunds_as_csv(self): - """Test case for get_refunds_as_csv - - """ - pass - - def test_get_shipments_report(self): - """Test case for get_shipments_report - - """ - pass - - def test_get_subscriptions_overview(self): - """Test case for get_subscriptions_overview - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_resume_request.py b/test/test_resume_request.py deleted file mode 100644 index b7cf0cb..0000000 --- a/test/test_resume_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.resume_request import ResumeRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestResumeRequest(unittest.TestCase): - """ResumeRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testResumeRequest(self): - """Test ResumeRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.resume_request.ResumeRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_resume_subscription_amendment.py b/test/test_resume_subscription_amendment.py deleted file mode 100644 index efc5497..0000000 --- a/test/test_resume_subscription_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.resume_subscription_amendment import ResumeSubscriptionAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestResumeSubscriptionAmendment(unittest.TestCase): - """ResumeSubscriptionAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testResumeSubscriptionAmendment(self): - """Test ResumeSubscriptionAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.resume_subscription_amendment.ResumeSubscriptionAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_revenue_attributions.py b/test/test_revenue_attributions.py deleted file mode 100644 index 985abe5..0000000 --- a/test/test_revenue_attributions.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.revenue_attributions import RevenueAttributions # noqa: E501 -from billforward.rest import ApiException - - -class TestRevenueAttributions(unittest.TestCase): - """RevenueAttributions unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testRevenueAttributions(self): - """Test RevenueAttributions""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.revenue_attributions.RevenueAttributions() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_role.py b/test/test_role.py deleted file mode 100644 index ac46b25..0000000 --- a/test/test_role.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.role import Role # noqa: E501 -from billforward.rest import ApiException - - -class TestRole(unittest.TestCase): - """Role unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testRole(self): - """Test Role""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.role.Role() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_sage_pay_auth_capture_request.py b/test/test_sage_pay_auth_capture_request.py deleted file mode 100644 index d5f1265..0000000 --- a/test/test_sage_pay_auth_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.sage_pay_auth_capture_request import SagePayAuthCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestSagePayAuthCaptureRequest(unittest.TestCase): - """SagePayAuthCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSagePayAuthCaptureRequest(self): - """Test SagePayAuthCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.sage_pay_auth_capture_request.SagePayAuthCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_sage_pay_card_payment.py b/test/test_sage_pay_card_payment.py deleted file mode 100644 index 90a4c58..0000000 --- a/test/test_sage_pay_card_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.sage_pay_card_payment import SagePayCardPayment # noqa: E501 -from billforward.rest import ApiException - - -class TestSagePayCardPayment(unittest.TestCase): - """SagePayCardPayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSagePayCardPayment(self): - """Test SagePayCardPayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.sage_pay_card_payment.SagePayCardPayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_sage_pay_configuration.py b/test/test_sage_pay_configuration.py deleted file mode 100644 index 871d900..0000000 --- a/test/test_sage_pay_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.sage_pay_configuration import SagePayConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestSagePayConfiguration(unittest.TestCase): - """SagePayConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSagePayConfiguration(self): - """Test SagePayConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.sage_pay_configuration.SagePayConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_sage_pay_enabled_card_type.py b/test/test_sage_pay_enabled_card_type.py deleted file mode 100644 index 0ea67d7..0000000 --- a/test/test_sage_pay_enabled_card_type.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.sage_pay_enabled_card_type import SagePayEnabledCardType # noqa: E501 -from billforward.rest import ApiException - - -class TestSagePayEnabledCardType(unittest.TestCase): - """SagePayEnabledCardType unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSagePayEnabledCardType(self): - """Test SagePayEnabledCardType""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.sage_pay_enabled_card_type.SagePayEnabledCardType() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_sage_pay_pre_auth_request.py b/test/test_sage_pay_pre_auth_request.py deleted file mode 100644 index f47ab59..0000000 --- a/test/test_sage_pay_pre_auth_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.sage_pay_pre_auth_request import SagePayPreAuthRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestSagePayPreAuthRequest(unittest.TestCase): - """SagePayPreAuthRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSagePayPreAuthRequest(self): - """Test SagePayPreAuthRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.sage_pay_pre_auth_request.SagePayPreAuthRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_salesforce_api.py b/test/test_salesforce_api.py deleted file mode 100644 index a156f88..0000000 --- a/test/test_salesforce_api.py +++ /dev/null @@ -1,63 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.salesforce_api import SalesforceApi # noqa: E501 -from billforward.rest import ApiException - - -class TestSalesforceApi(unittest.TestCase): - """SalesforceApi unit test stubs""" - - def setUp(self): - self.api = SalesforceApi() # noqa: E501 - - def tearDown(self): - pass - - def test_change_salesforce_job_state(self): - """Test case for change_salesforce_job_state - - """ - pass - - def test_connect_to_salesforce(self): - """Test case for connect_to_salesforce - - """ - pass - - def test_get_all_salesforce_jobs(self): - """Test case for get_all_salesforce_jobs - - """ - pass - - def test_get_salesforce_configuration(self): - """Test case for get_salesforce_configuration - - """ - pass - - def test_update_salesforce_configuration(self): - """Test case for update_salesforce_configuration - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_salesforce_configuration_response.py b/test/test_salesforce_configuration_response.py deleted file mode 100644 index cdda204..0000000 --- a/test/test_salesforce_configuration_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.salesforce_configuration_response import SalesforceConfigurationResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestSalesforceConfigurationResponse(unittest.TestCase): - """SalesforceConfigurationResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSalesforceConfigurationResponse(self): - """Test SalesforceConfigurationResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.salesforce_configuration_response.SalesforceConfigurationResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_security_api.py b/test/test_security_api.py deleted file mode 100644 index 1dd8c6d..0000000 --- a/test/test_security_api.py +++ /dev/null @@ -1,165 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.security_api import SecurityApi # noqa: E501 -from billforward.rest import ApiException - - -class TestSecurityApi(unittest.TestCase): - """SecurityApi unit test stubs""" - - def setUp(self): - self.api = SecurityApi() # noqa: E501 - - def tearDown(self): - pass - - def test_create_flexcheck_user_login(self): - """Test case for create_flexcheck_user_login - - """ - pass - - def test_create_role(self): - """Test case for create_role - - """ - pass - - def test_create_user_login(self): - """Test case for create_user_login - - """ - pass - - def test_get_all_roles(self): - """Test case for get_all_roles - - """ - pass - - def test_get_current_user(self): - """Test case for get_current_user - - """ - pass - - def test_get_my_organizations(self): - """Test case for get_my_organizations - - """ - pass - - def test_get_private_permanent_api_token(self): - """Test case for get_private_permanent_api_token - - """ - pass - - def test_get_role_by_id(self): - """Test case for get_role_by_id - - """ - pass - - def test_get_simple_all_users(self): - """Test case for get_simple_all_users - - """ - pass - - def test_get_temporary_api_tokens(self): - """Test case for get_temporary_api_tokens - - """ - pass - - def test_get_user_by_username(self): - """Test case for get_user_by_username - - """ - pass - - def test_invite_user_login(self): - """Test case for invite_user_login - - """ - pass - - def test_link_open_id_token_to_user(self): - """Test case for link_open_id_token_to_user - - """ - pass - - def test_refresh_permanent_api_token(self): - """Test case for refresh_permanent_api_token - - """ - pass - - def test_remove_permission_from_role(self): - """Test case for remove_permission_from_role - - """ - pass - - def test_request_password_reset_code(self): - """Test case for request_password_reset_code - - """ - pass - - def test_revoke_role(self): - """Test case for revoke_role - - """ - pass - - def test_update_email(self): - """Test case for update_email - - """ - pass - - def test_update_role(self): - """Test case for update_role - - """ - pass - - def test_update_user_infos(self): - """Test case for update_user_infos - - """ - pass - - def test_update_user_password(self): - """Test case for update_user_password - - """ - pass - - def test_update_user_password_with_reset_code(self): - """Test case for update_user_password_with_reset_code - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_service_end_amendment.py b/test/test_service_end_amendment.py deleted file mode 100644 index 2dda94d..0000000 --- a/test/test_service_end_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.service_end_amendment import ServiceEndAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestServiceEndAmendment(unittest.TestCase): - """ServiceEndAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testServiceEndAmendment(self): - """Test ServiceEndAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.service_end_amendment.ServiceEndAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_set_rate_plan_affiliate_request.py b/test/test_set_rate_plan_affiliate_request.py deleted file mode 100644 index 1d69012..0000000 --- a/test/test_set_rate_plan_affiliate_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.set_rate_plan_affiliate_request import SetRatePlanAffiliateRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestSetRatePlanAffiliateRequest(unittest.TestCase): - """SetRatePlanAffiliateRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSetRatePlanAffiliateRequest(self): - """Test SetRatePlanAffiliateRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.set_rate_plan_affiliate_request.SetRatePlanAffiliateRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_set_subscription_affiliate_request.py b/test/test_set_subscription_affiliate_request.py deleted file mode 100644 index 13924a3..0000000 --- a/test/test_set_subscription_affiliate_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.set_subscription_affiliate_request import SetSubscriptionAffiliateRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestSetSubscriptionAffiliateRequest(unittest.TestCase): - """SetSubscriptionAffiliateRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSetSubscriptionAffiliateRequest(self): - """Test SetSubscriptionAffiliateRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.set_subscription_affiliate_request.SetSubscriptionAffiliateRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_setup_charge.py b/test/test_setup_charge.py deleted file mode 100644 index a7aad84..0000000 --- a/test/test_setup_charge.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.setup_charge import SetupCharge # noqa: E501 -from billforward.rest import ApiException - - -class TestSetupCharge(unittest.TestCase): - """SetupCharge unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSetupCharge(self): - """Test SetupCharge""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.setup_charge.SetupCharge() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_setup_pricing_components_by_charge_model.py b/test/test_setup_pricing_components_by_charge_model.py deleted file mode 100644 index a65cede..0000000 --- a/test/test_setup_pricing_components_by_charge_model.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.setup_pricing_components_by_charge_model import SetupPricingComponentsByChargeModel # noqa: E501 -from billforward.rest import ApiException - - -class TestSetupPricingComponentsByChargeModel(unittest.TestCase): - """SetupPricingComponentsByChargeModel unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSetupPricingComponentsByChargeModel(self): - """Test SetupPricingComponentsByChargeModel""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.setup_pricing_components_by_charge_model.SetupPricingComponentsByChargeModel() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_shuttle_auth_capture_request.py b/test/test_shuttle_auth_capture_request.py deleted file mode 100644 index 82d29ef..0000000 --- a/test/test_shuttle_auth_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.shuttle_auth_capture_request import ShuttleAuthCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestShuttleAuthCaptureRequest(unittest.TestCase): - """ShuttleAuthCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testShuttleAuthCaptureRequest(self): - """Test ShuttleAuthCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.shuttle_auth_capture_request.ShuttleAuthCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_shuttle_configuration.py b/test/test_shuttle_configuration.py deleted file mode 100644 index 3ef6fdb..0000000 --- a/test/test_shuttle_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.shuttle_configuration import ShuttleConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestShuttleConfiguration(unittest.TestCase): - """ShuttleConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testShuttleConfiguration(self): - """Test ShuttleConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.shuttle_configuration.ShuttleConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_shuttle_payment.py b/test/test_shuttle_payment.py deleted file mode 100644 index eed2de7..0000000 --- a/test/test_shuttle_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.shuttle_payment import ShuttlePayment # noqa: E501 -from billforward.rest import ApiException - - -class TestShuttlePayment(unittest.TestCase): - """ShuttlePayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testShuttlePayment(self): - """Test ShuttlePayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.shuttle_payment.ShuttlePayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_shuttle_pre_auth_request.py b/test/test_shuttle_pre_auth_request.py deleted file mode 100644 index 9964af6..0000000 --- a/test/test_shuttle_pre_auth_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.shuttle_pre_auth_request import ShuttlePreAuthRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestShuttlePreAuthRequest(unittest.TestCase): - """ShuttlePreAuthRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testShuttlePreAuthRequest(self): - """Test ShuttlePreAuthRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.shuttle_pre_auth_request.ShuttlePreAuthRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_simple_date_param.py b/test/test_simple_date_param.py deleted file mode 100644 index 8546843..0000000 --- a/test/test_simple_date_param.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.simple_date_param import SimpleDateParam # noqa: E501 -from billforward.rest import ApiException - - -class TestSimpleDateParam(unittest.TestCase): - """SimpleDateParam unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSimpleDateParam(self): - """Test SimpleDateParam""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.simple_date_param.SimpleDateParam() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_simple_user.py b/test/test_simple_user.py deleted file mode 100644 index 3cbe1da..0000000 --- a/test/test_simple_user.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.simple_user import SimpleUser # noqa: E501 -from billforward.rest import ApiException - - -class TestSimpleUser(unittest.TestCase): - """SimpleUser unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSimpleUser(self): - """Test SimpleUser""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.simple_user.SimpleUser() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_single_recalculate_charge_request.py b/test/test_single_recalculate_charge_request.py deleted file mode 100644 index 739f90b..0000000 --- a/test/test_single_recalculate_charge_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.single_recalculate_charge_request import SingleRecalculateChargeRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestSingleRecalculateChargeRequest(unittest.TestCase): - """SingleRecalculateChargeRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSingleRecalculateChargeRequest(self): - """Test SingleRecalculateChargeRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.single_recalculate_charge_request.SingleRecalculateChargeRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_spreedly_auth_capture_request.py b/test/test_spreedly_auth_capture_request.py deleted file mode 100644 index 408e4df..0000000 --- a/test/test_spreedly_auth_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.spreedly_auth_capture_request import SpreedlyAuthCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestSpreedlyAuthCaptureRequest(unittest.TestCase): - """SpreedlyAuthCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSpreedlyAuthCaptureRequest(self): - """Test SpreedlyAuthCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.spreedly_auth_capture_request.SpreedlyAuthCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_spreedly_configuration.py b/test/test_spreedly_configuration.py deleted file mode 100644 index cb162a4..0000000 --- a/test/test_spreedly_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.spreedly_configuration import SpreedlyConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestSpreedlyConfiguration(unittest.TestCase): - """SpreedlyConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSpreedlyConfiguration(self): - """Test SpreedlyConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.spreedly_configuration.SpreedlyConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_spreedly_pre_auth_request.py b/test/test_spreedly_pre_auth_request.py deleted file mode 100644 index 523f136..0000000 --- a/test/test_spreedly_pre_auth_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.spreedly_pre_auth_request import SpreedlyPreAuthRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestSpreedlyPreAuthRequest(unittest.TestCase): - """SpreedlyPreAuthRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSpreedlyPreAuthRequest(self): - """Test SpreedlyPreAuthRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.spreedly_pre_auth_request.SpreedlyPreAuthRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_square_auth_capture_request.py b/test/test_square_auth_capture_request.py deleted file mode 100644 index d3f1d49..0000000 --- a/test/test_square_auth_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.square_auth_capture_request import SquareAuthCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestSquareAuthCaptureRequest(unittest.TestCase): - """SquareAuthCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSquareAuthCaptureRequest(self): - """Test SquareAuthCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.square_auth_capture_request.SquareAuthCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_square_configuration.py b/test/test_square_configuration.py deleted file mode 100644 index 0560d6c..0000000 --- a/test/test_square_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.square_configuration import SquareConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestSquareConfiguration(unittest.TestCase): - """SquareConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSquareConfiguration(self): - """Test SquareConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.square_configuration.SquareConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_square_configuration_data.py b/test/test_square_configuration_data.py deleted file mode 100644 index 202d47e..0000000 --- a/test/test_square_configuration_data.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.square_configuration_data import SquareConfigurationData # noqa: E501 -from billforward.rest import ApiException - - -class TestSquareConfigurationData(unittest.TestCase): - """SquareConfigurationData unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSquareConfigurationData(self): - """Test SquareConfigurationData""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.square_configuration_data.SquareConfigurationData() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_square_data.py b/test/test_square_data.py deleted file mode 100644 index fb4c5ae..0000000 --- a/test/test_square_data.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.square_data import SquareData # noqa: E501 -from billforward.rest import ApiException - - -class TestSquareData(unittest.TestCase): - """SquareData unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSquareData(self): - """Test SquareData""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.square_data.SquareData() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_square_payment.py b/test/test_square_payment.py deleted file mode 100644 index 4452d6d..0000000 --- a/test/test_square_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.square_payment import SquarePayment # noqa: E501 -from billforward.rest import ApiException - - -class TestSquarePayment(unittest.TestCase): - """SquarePayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSquarePayment(self): - """Test SquarePayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.square_payment.SquarePayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_square_subscription.py b/test/test_square_subscription.py deleted file mode 100644 index a1172ec..0000000 --- a/test/test_square_subscription.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.square_subscription import SquareSubscription # noqa: E501 -from billforward.rest import ApiException - - -class TestSquareSubscription(unittest.TestCase): - """SquareSubscription unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSquareSubscription(self): - """Test SquareSubscription""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.square_subscription.SquareSubscription() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_start_all_subscriptions_request.py b/test/test_start_all_subscriptions_request.py deleted file mode 100644 index d8296ab..0000000 --- a/test/test_start_all_subscriptions_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.start_all_subscriptions_request import StartAllSubscriptionsRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestStartAllSubscriptionsRequest(unittest.TestCase): - """StartAllSubscriptionsRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStartAllSubscriptionsRequest(self): - """Test StartAllSubscriptionsRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.start_all_subscriptions_request.StartAllSubscriptionsRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_start_all_subscriptions_response.py b/test/test_start_all_subscriptions_response.py deleted file mode 100644 index ae932ac..0000000 --- a/test/test_start_all_subscriptions_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.start_all_subscriptions_response import StartAllSubscriptionsResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestStartAllSubscriptionsResponse(unittest.TestCase): - """StartAllSubscriptionsResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStartAllSubscriptionsResponse(self): - """Test StartAllSubscriptionsResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.start_all_subscriptions_response.StartAllSubscriptionsResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_start_contract_request.py b/test/test_start_contract_request.py deleted file mode 100644 index 6e26cc2..0000000 --- a/test/test_start_contract_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.start_contract_request import StartContractRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestStartContractRequest(unittest.TestCase): - """StartContractRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStartContractRequest(self): - """Test StartContractRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.start_contract_request.StartContractRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_start_contract_response.py b/test/test_start_contract_response.py deleted file mode 100644 index 86e7bb9..0000000 --- a/test/test_start_contract_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.start_contract_response import StartContractResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestStartContractResponse(unittest.TestCase): - """StartContractResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStartContractResponse(self): - """Test StartContractResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.start_contract_response.StartContractResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_stripe_ach_capture_request.py b/test/test_stripe_ach_capture_request.py deleted file mode 100644 index 215bdbe..0000000 --- a/test/test_stripe_ach_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.stripe_ach_capture_request import StripeACHCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestStripeACHCaptureRequest(unittest.TestCase): - """StripeACHCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStripeACHCaptureRequest(self): - """Test StripeACHCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.stripe_ach_capture_request.StripeACHCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_stripe_ach_payment.py b/test/test_stripe_ach_payment.py deleted file mode 100644 index fc5a9bd..0000000 --- a/test/test_stripe_ach_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.stripe_ach_payment import StripeACHPayment # noqa: E501 -from billforward.rest import ApiException - - -class TestStripeACHPayment(unittest.TestCase): - """StripeACHPayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStripeACHPayment(self): - """Test StripeACHPayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.stripe_ach_payment.StripeACHPayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_stripe_ach_token.py b/test/test_stripe_ach_token.py deleted file mode 100644 index f775908..0000000 --- a/test/test_stripe_ach_token.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.stripe_ach_token import StripeAchToken # noqa: E501 -from billforward.rest import ApiException - - -class TestStripeAchToken(unittest.TestCase): - """StripeAchToken unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStripeAchToken(self): - """Test StripeAchToken""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.stripe_ach_token.StripeAchToken() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_stripe_additional_data.py b/test/test_stripe_additional_data.py deleted file mode 100644 index b77d534..0000000 --- a/test/test_stripe_additional_data.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.stripe_additional_data import StripeAdditionalData # noqa: E501 -from billforward.rest import ApiException - - -class TestStripeAdditionalData(unittest.TestCase): - """StripeAdditionalData unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStripeAdditionalData(self): - """Test StripeAdditionalData""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.stripe_additional_data.StripeAdditionalData() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_stripe_auth_capture_request.py b/test/test_stripe_auth_capture_request.py deleted file mode 100644 index abae33b..0000000 --- a/test/test_stripe_auth_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.stripe_auth_capture_request import StripeAuthCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestStripeAuthCaptureRequest(unittest.TestCase): - """StripeAuthCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStripeAuthCaptureRequest(self): - """Test StripeAuthCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.stripe_auth_capture_request.StripeAuthCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_stripe_card_payment.py b/test/test_stripe_card_payment.py deleted file mode 100644 index ff0d780..0000000 --- a/test/test_stripe_card_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.stripe_card_payment import StripeCardPayment # noqa: E501 -from billforward.rest import ApiException - - -class TestStripeCardPayment(unittest.TestCase): - """StripeCardPayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStripeCardPayment(self): - """Test StripeCardPayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.stripe_card_payment.StripeCardPayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_stripe_configuration.py b/test/test_stripe_configuration.py deleted file mode 100644 index e7b7e34..0000000 --- a/test/test_stripe_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.stripe_configuration import StripeConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestStripeConfiguration(unittest.TestCase): - """StripeConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStripeConfiguration(self): - """Test StripeConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.stripe_configuration.StripeConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_stripe_pre_auth_request.py b/test/test_stripe_pre_auth_request.py deleted file mode 100644 index ce40961..0000000 --- a/test/test_stripe_pre_auth_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.stripe_pre_auth_request import StripePreAuthRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestStripePreAuthRequest(unittest.TestCase): - """StripePreAuthRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStripePreAuthRequest(self): - """Test StripePreAuthRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.stripe_pre_auth_request.StripePreAuthRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_stripe_token.py b/test/test_stripe_token.py deleted file mode 100644 index 2d2072a..0000000 --- a/test/test_stripe_token.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.stripe_token import StripeToken # noqa: E501 -from billforward.rest import ApiException - - -class TestStripeToken(unittest.TestCase): - """StripeToken unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testStripeToken(self): - """Test StripeToken""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.stripe_token.StripeToken() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription.py b/test/test_subscription.py deleted file mode 100644 index 0c72289..0000000 --- a/test/test_subscription.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.subscription import Subscription # noqa: E501 -from billforward.rest import ApiException - - -class TestSubscription(unittest.TestCase): - """Subscription unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSubscription(self): - """Test Subscription""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.subscription.Subscription() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription_cancellation.py b/test/test_subscription_cancellation.py deleted file mode 100644 index 4f23b84..0000000 --- a/test/test_subscription_cancellation.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.subscription_cancellation import SubscriptionCancellation # noqa: E501 -from billforward.rest import ApiException - - -class TestSubscriptionCancellation(unittest.TestCase): - """SubscriptionCancellation unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSubscriptionCancellation(self): - """Test SubscriptionCancellation""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.subscription_cancellation.SubscriptionCancellation() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription_charge.py b/test/test_subscription_charge.py deleted file mode 100644 index 8d9fed4..0000000 --- a/test/test_subscription_charge.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.subscription_charge import SubscriptionCharge # noqa: E501 -from billforward.rest import ApiException - - -class TestSubscriptionCharge(unittest.TestCase): - """SubscriptionCharge unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSubscriptionCharge(self): - """Test SubscriptionCharge""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.subscription_charge.SubscriptionCharge() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription_checkout_action_request.py b/test/test_subscription_checkout_action_request.py deleted file mode 100644 index 06ea9de..0000000 --- a/test/test_subscription_checkout_action_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.subscription_checkout_action_request import SubscriptionCheckoutActionRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestSubscriptionCheckoutActionRequest(unittest.TestCase): - """SubscriptionCheckoutActionRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSubscriptionCheckoutActionRequest(self): - """Test SubscriptionCheckoutActionRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.subscription_checkout_action_request.SubscriptionCheckoutActionRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription_checkout_definition_description.py b/test/test_subscription_checkout_definition_description.py deleted file mode 100644 index 61dc701..0000000 --- a/test/test_subscription_checkout_definition_description.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.subscription_checkout_definition_description import SubscriptionCheckoutDefinitionDescription # noqa: E501 -from billforward.rest import ApiException - - -class TestSubscriptionCheckoutDefinitionDescription(unittest.TestCase): - """SubscriptionCheckoutDefinitionDescription unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSubscriptionCheckoutDefinitionDescription(self): - """Test SubscriptionCheckoutDefinitionDescription""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.subscription_checkout_definition_description.SubscriptionCheckoutDefinitionDescription() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription_checkout_response.py b/test/test_subscription_checkout_response.py deleted file mode 100644 index 719dec2..0000000 --- a/test/test_subscription_checkout_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.subscription_checkout_response import SubscriptionCheckoutResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestSubscriptionCheckoutResponse(unittest.TestCase): - """SubscriptionCheckoutResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSubscriptionCheckoutResponse(self): - """Test SubscriptionCheckoutResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.subscription_checkout_response.SubscriptionCheckoutResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription_revive_amendment.py b/test/test_subscription_revive_amendment.py deleted file mode 100644 index 47fc634..0000000 --- a/test/test_subscription_revive_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.subscription_revive_amendment import SubscriptionReviveAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestSubscriptionReviveAmendment(unittest.TestCase): - """SubscriptionReviveAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSubscriptionReviveAmendment(self): - """Test SubscriptionReviveAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.subscription_revive_amendment.SubscriptionReviveAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription_revive_partial_request.py b/test/test_subscription_revive_partial_request.py deleted file mode 100644 index 5d5cf68..0000000 --- a/test/test_subscription_revive_partial_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.subscription_revive_partial_request import SubscriptionRevivePartialRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestSubscriptionRevivePartialRequest(unittest.TestCase): - """SubscriptionRevivePartialRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSubscriptionRevivePartialRequest(self): - """Test SubscriptionRevivePartialRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.subscription_revive_partial_request.SubscriptionRevivePartialRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscription_revive_request.py b/test/test_subscription_revive_request.py deleted file mode 100644 index 5a6007f..0000000 --- a/test/test_subscription_revive_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.subscription_revive_request import SubscriptionReviveRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestSubscriptionReviveRequest(unittest.TestCase): - """SubscriptionReviveRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSubscriptionReviveRequest(self): - """Test SubscriptionReviveRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.subscription_revive_request.SubscriptionReviveRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_subscriptions_api.py b/test/test_subscriptions_api.py deleted file mode 100644 index cf8f44b..0000000 --- a/test/test_subscriptions_api.py +++ /dev/null @@ -1,357 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.subscriptions_api import SubscriptionsApi # noqa: E501 -from billforward.rest import ApiException - - -class TestSubscriptionsApi(unittest.TestCase): - """SubscriptionsApi unit test stubs""" - - def setUp(self): - self.api = SubscriptionsApi() # noqa: E501 - - def tearDown(self): - pass - - def test_add_charge_to_subscription(self): - """Test case for add_charge_to_subscription - - """ - pass - - def test_add_coupon_to_subscription(self): - """Test case for add_coupon_to_subscription - - """ - pass - - def test_add_credit_note_to_subscription(self): - """Test case for add_credit_note_to_subscription - - """ - pass - - def test_add_payment_method_to_subscription(self): - """Test case for add_payment_method_to_subscription - - """ - pass - - def test_advance_subscription(self): - """Test case for advance_subscription - - """ - pass - - def test_available_payment_methods_for_subscription(self): - """Test case for available_payment_methods_for_subscription - - """ - pass - - def test_batch_create_subscriptions(self): - """Test case for batch_create_subscriptions - - """ - pass - - def test_batch_increment_usage(self): - """Test case for batch_increment_usage - - """ - pass - - def test_cancel_subscription(self): - """Test case for cancel_subscription - - """ - pass - - def test_create_aggregating_subscription(self): - """Test case for create_aggregating_subscription - - """ - pass - - def test_create_subscription_from_request(self): - """Test case for create_subscription_from_request - - """ - pass - - def test_create_timer(self): - """Test case for create_timer - - """ - pass - - def test_delete_metadata_for_subscription(self): - """Test case for delete_metadata_for_subscription - - """ - pass - - def test_freeze_subscription(self): - """Test case for freeze_subscription - - """ - pass - - def test_get_affiliate1(self): - """Test case for get_affiliate1 - - """ - pass - - def test_get_applicable_coupons_for_subscription(self): - """Test case for get_applicable_coupons_for_subscription - - """ - pass - - def test_get_available_credit_subscription(self): - """Test case for get_available_credit_subscription - - """ - pass - - def test_get_charges_on_subscription(self): - """Test case for get_charges_on_subscription - - """ - pass - - def test_get_children_of_subscription(self): - """Test case for get_children_of_subscription - - """ - pass - - def test_get_coupons_on_subscription(self): - """Test case for get_coupons_on_subscription - - """ - pass - - def test_get_invoices_for_subscription_by_state(self): - """Test case for get_invoices_for_subscription_by_state - - """ - pass - - def test_get_metadata_for_subscription(self): - """Test case for get_metadata_for_subscription - - """ - pass - - def test_get_parent_subscription(self): - """Test case for get_parent_subscription - - """ - pass - - def test_get_pricing_component_values_of_subscription(self): - """Test case for get_pricing_component_values_of_subscription - - """ - pass - - def test_get_subscription_by_account_id(self): - """Test case for get_subscription_by_account_id - - """ - pass - - def test_get_subscription_by_id(self): - """Test case for get_subscription_by_id - - """ - pass - - def test_get_subscription_by_product_id(self): - """Test case for get_subscription_by_product_id - - """ - pass - - def test_get_subscription_by_product_rate_plan_id(self): - """Test case for get_subscription_by_product_rate_plan_id - - """ - pass - - def test_get_subscription_by_state(self): - """Test case for get_subscription_by_state - - """ - pass - - def test_get_subscription_by_version_id(self): - """Test case for get_subscription_by_version_id - - """ - pass - - def test_get_subscriptions_by_initial_period_start(self): - """Test case for get_subscriptions_by_initial_period_start - - """ - pass - - def test_get_subscriptions_by_period_end(self): - """Test case for get_subscriptions_by_period_end - - """ - pass - - def test_get_subscriptions_by_period_start(self): - """Test case for get_subscriptions_by_period_start - - """ - pass - - def test_get_subscriptions_by_successful_periods(self): - """Test case for get_subscriptions_by_successful_periods - - """ - pass - - def test_get_swagger_subscription(self): - """Test case for get_swagger_subscription - - """ - pass - - def test_get_timers_for_subscription(self): - """Test case for get_timers_for_subscription - - """ - pass - - def test_import_subscription(self): - """Test case for import_subscription - - """ - pass - - def test_invoice_charges_on_subscription(self): - """Test case for invoice_charges_on_subscription - - """ - pass - - def test_migrate_subscription(self): - """Test case for migrate_subscription - - """ - pass - - def test_pause_subscription(self): - """Test case for pause_subscription - - """ - pass - - def test_remove_coupon_from_subscription(self): - """Test case for remove_coupon_from_subscription - - """ - pass - - def test_remove_credit_from_subscription(self): - """Test case for remove_credit_from_subscription - - """ - pass - - def test_remove_payment_method_from_subscription(self): - """Test case for remove_payment_method_from_subscription - - """ - pass - - def test_remove_pricing_component_value_change_from_subscription(self): - """Test case for remove_pricing_component_value_change_from_subscription - - """ - pass - - def test_resume_subscription(self): - """Test case for resume_subscription - - """ - pass - - def test_revive_subscription(self): - """Test case for revive_subscription - - """ - pass - - def test_set_affiliate1(self): - """Test case for set_affiliate1 - - """ - pass - - def test_set_metadata_for_subscription(self): - """Test case for set_metadata_for_subscription - - """ - pass - - def test_set_pricing_component_value_on_subscription(self): - """Test case for set_pricing_component_value_on_subscription - - """ - pass - - def test_set_pricing_component_value_on_subscription1(self): - """Test case for set_pricing_component_value_on_subscription1 - - """ - pass - - def test_set_pricing_component_value_on_subscription_batch_update(self): - """Test case for set_pricing_component_value_on_subscription_batch_update - - """ - pass - - def test_start_all_subscriptions(self): - """Test case for start_all_subscriptions - - """ - pass - - def test_update_subscription_from_request(self): - """Test case for update_subscription_from_request - - """ - pass - - def test_upsert_metadata_for_subscription(self): - """Test case for upsert_metadata_for_subscription - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_swagger_type_list_inv.py b/test/test_swagger_type_list_inv.py deleted file mode 100644 index 39cc996..0000000 --- a/test/test_swagger_type_list_inv.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.swagger_type_list_inv import SwaggerTypeListInv # noqa: E501 -from billforward.rest import ApiException - - -class TestSwaggerTypeListInv(unittest.TestCase): - """SwaggerTypeListInv unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSwaggerTypeListInv(self): - """Test SwaggerTypeListInv""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.swagger_type_list_inv.SwaggerTypeListInv() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_swagger_type_list_subs.py b/test/test_swagger_type_list_subs.py deleted file mode 100644 index e301595..0000000 --- a/test/test_swagger_type_list_subs.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.swagger_type_list_subs import SwaggerTypeListSubs # noqa: E501 -from billforward.rest import ApiException - - -class TestSwaggerTypeListSubs(unittest.TestCase): - """SwaggerTypeListSubs unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSwaggerTypeListSubs(self): - """Test SwaggerTypeListSubs""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.swagger_type_list_subs.SwaggerTypeListSubs() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_sync_action_request.py b/test/test_sync_action_request.py deleted file mode 100644 index 1817241..0000000 --- a/test/test_sync_action_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.sync_action_request import SyncActionRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestSyncActionRequest(unittest.TestCase): - """SyncActionRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testSyncActionRequest(self): - """Test SyncActionRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.sync_action_request.SyncActionRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tax_line.py b/test/test_tax_line.py deleted file mode 100644 index 29fc0b0..0000000 --- a/test/test_tax_line.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.tax_line import TaxLine # noqa: E501 -from billforward.rest import ApiException - - -class TestTaxLine(unittest.TestCase): - """TaxLine unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTaxLine(self): - """Test TaxLine""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.tax_line.TaxLine() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_taxation_strategy.py b/test/test_taxation_strategy.py deleted file mode 100644 index 597303a..0000000 --- a/test/test_taxation_strategy.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.taxation_strategy import TaxationStrategy # noqa: E501 -from billforward.rest import ApiException - - -class TestTaxationStrategy(unittest.TestCase): - """TaxationStrategy unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTaxationStrategy(self): - """Test TaxationStrategy""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.taxation_strategy.TaxationStrategy() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_taxes_api.py b/test/test_taxes_api.py deleted file mode 100644 index 94a4ab7..0000000 --- a/test/test_taxes_api.py +++ /dev/null @@ -1,87 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.taxes_api import TaxesApi # noqa: E501 -from billforward.rest import ApiException - - -class TestTaxesApi(unittest.TestCase): - """TaxesApi unit test stubs""" - - def setUp(self): - self.api = TaxesApi() # noqa: E501 - - def tearDown(self): - pass - - def test_create_taxation_strategy(self): - """Test case for create_taxation_strategy - - """ - pass - - def test_get_all_taxation_strategies(self): - """Test case for get_all_taxation_strategies - - """ - pass - - def test_get_taxation_strategy_by_consistent_id(self): - """Test case for get_taxation_strategy_by_consistent_id - - """ - pass - - def test_get_taxation_strategy_by_country(self): - """Test case for get_taxation_strategy_by_country - - """ - pass - - def test_get_taxation_strategy_by_currency(self): - """Test case for get_taxation_strategy_by_currency - - """ - pass - - def test_get_taxation_strategy_by_province(self): - """Test case for get_taxation_strategy_by_province - - """ - pass - - def test_get_taxation_strategy_by_version_id(self): - """Test case for get_taxation_strategy_by_version_id - - """ - pass - - def test_retire_taxation_strategy(self): - """Test case for retire_taxation_strategy - - """ - pass - - def test_update_taxation_strategy(self): - """Test case for update_taxation_strategy - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tiered_advance_pricing_component.py b/test/test_tiered_advance_pricing_component.py deleted file mode 100644 index d15f5c6..0000000 --- a/test/test_tiered_advance_pricing_component.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.tiered_advance_pricing_component import TieredAdvancePricingComponent # noqa: E501 -from billforward.rest import ApiException - - -class TestTieredAdvancePricingComponent(unittest.TestCase): - """TieredAdvancePricingComponent unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTieredAdvancePricingComponent(self): - """Test TieredAdvancePricingComponent""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.tiered_advance_pricing_component.TieredAdvancePricingComponent() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tiered_arrears_pricing_component.py b/test/test_tiered_arrears_pricing_component.py deleted file mode 100644 index 3b399d8..0000000 --- a/test/test_tiered_arrears_pricing_component.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.tiered_arrears_pricing_component import TieredArrearsPricingComponent # noqa: E501 -from billforward.rest import ApiException - - -class TestTieredArrearsPricingComponent(unittest.TestCase): - """TieredArrearsPricingComponent unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTieredArrearsPricingComponent(self): - """Test TieredArrearsPricingComponent""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.tiered_arrears_pricing_component.TieredArrearsPricingComponent() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tiered_pricing_component.py b/test/test_tiered_pricing_component.py deleted file mode 100644 index aa42605..0000000 --- a/test/test_tiered_pricing_component.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.tiered_pricing_component import TieredPricingComponent # noqa: E501 -from billforward.rest import ApiException - - -class TestTieredPricingComponent(unittest.TestCase): - """TieredPricingComponent unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTieredPricingComponent(self): - """Test TieredPricingComponent""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.tiered_pricing_component.TieredPricingComponent() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tiered_setup_pricing_component.py b/test/test_tiered_setup_pricing_component.py deleted file mode 100644 index 94b6a72..0000000 --- a/test/test_tiered_setup_pricing_component.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.tiered_setup_pricing_component import TieredSetupPricingComponent # noqa: E501 -from billforward.rest import ApiException - - -class TestTieredSetupPricingComponent(unittest.TestCase): - """TieredSetupPricingComponent unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTieredSetupPricingComponent(self): - """Test TieredSetupPricingComponent""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.tiered_setup_pricing_component.TieredSetupPricingComponent() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tiered_usage_pricing_component.py b/test/test_tiered_usage_pricing_component.py deleted file mode 100644 index 6d77eff..0000000 --- a/test/test_tiered_usage_pricing_component.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.tiered_usage_pricing_component import TieredUsagePricingComponent # noqa: E501 -from billforward.rest import ApiException - - -class TestTieredUsagePricingComponent(unittest.TestCase): - """TieredUsagePricingComponent unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTieredUsagePricingComponent(self): - """Test TieredUsagePricingComponent""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.tiered_usage_pricing_component.TieredUsagePricingComponent() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tiered_volume_pricing_component.py b/test/test_tiered_volume_pricing_component.py deleted file mode 100644 index 890ca6e..0000000 --- a/test/test_tiered_volume_pricing_component.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.tiered_volume_pricing_component import TieredVolumePricingComponent # noqa: E501 -from billforward.rest import ApiException - - -class TestTieredVolumePricingComponent(unittest.TestCase): - """TieredVolumePricingComponent unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTieredVolumePricingComponent(self): - """Test TieredVolumePricingComponent""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.tiered_volume_pricing_component.TieredVolumePricingComponent() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_time_request.py b/test/test_time_request.py deleted file mode 100644 index e38d3ee..0000000 --- a/test/test_time_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.time_request import TimeRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestTimeRequest(unittest.TestCase): - """TimeRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTimeRequest(self): - """Test TimeRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.time_request.TimeRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_time_response.py b/test/test_time_response.py deleted file mode 100644 index 1a61557..0000000 --- a/test/test_time_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.time_response import TimeResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestTimeResponse(unittest.TestCase): - """TimeResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTimeResponse(self): - """Test TimeResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.time_response.TimeResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_timer_amendment.py b/test/test_timer_amendment.py deleted file mode 100644 index f309667..0000000 --- a/test/test_timer_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.timer_amendment import TimerAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestTimerAmendment(unittest.TestCase): - """TimerAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTimerAmendment(self): - """Test TimerAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.timer_amendment.TimerAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tokenization_api.py b/test/test_tokenization_api.py deleted file mode 100644 index cc0d0c5..0000000 --- a/test/test_tokenization_api.py +++ /dev/null @@ -1,237 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.tokenization_api import TokenizationApi # noqa: E501 -from billforward.rest import ApiException - - -class TestTokenizationApi(unittest.TestCase): - """TokenizationApi unit test stubs""" - - def setUp(self): - self.api = TokenizationApi() # noqa: E501 - - def tearDown(self): - pass - - def test_auth_capture(self): - """Test case for auth_capture - - """ - pass - - def test_braintree_card_capture(self): - """Test case for braintree_card_capture - - """ - pass - - def test_create_authorize_net_token(self): - """Test case for create_authorize_net_token - - """ - pass - - def test_create_braintree_token(self): - """Test case for create_braintree_token - - """ - pass - - def test_create_stripe_ach_token(self): - """Test case for create_stripe_ach_token - - """ - pass - - def test_create_stripe_token(self): - """Test case for create_stripe_token - - """ - pass - - def test_create_trust_commerce_token(self): - """Test case for create_trust_commerce_token - - """ - pass - - def test_display_card_capture_form(self): - """Test case for display_card_capture_form - - """ - pass - - def test_epx_card_capture(self): - """Test case for epx_card_capture - - """ - pass - - def test_epx_pre_auth(self): - """Test case for epx_pre_auth - - """ - pass - - def test_epx_pre_auth_response(self): - """Test case for epx_pre_auth_response - - """ - pass - - def test_expire_email_redirect_capture(self): - """Test case for expire_email_redirect_capture - - """ - pass - - def test_get_all_email_redirect_capture(self): - """Test case for get_all_email_redirect_capture - - """ - pass - - def test_get_braintree_by_account_id(self): - """Test case for get_braintree_by_account_id - - """ - pass - - def test_get_by_card_details_id(self): - """Test case for get_by_card_details_id - - """ - pass - - def test_get_email_redirect_capture(self): - """Test case for get_email_redirect_capture - - """ - pass - - def test_get_email_redirect_capture_invoice_html(self): - """Test case for get_email_redirect_capture_invoice_html - - """ - pass - - def test_get_stripe_ach(self): - """Test case for get_stripe_ach - - """ - pass - - def test_get_stripe_token(self): - """Test case for get_stripe_token - - """ - pass - - def test_go_cardless_bank_account_capture(self): - """Test case for go_cardless_bank_account_capture - - """ - pass - - def test_pay_vision_shout_v1(self): - """Test case for pay_vision_shout_v1 - - """ - pass - - def test_pre_auth(self): - """Test case for pre_auth - - """ - pass - - def test_sage_pay_notify_v300(self): - """Test case for sage_pay_notify_v300 - - """ - pass - - def test_sage_pay_shout_v300(self): - """Test case for sage_pay_shout_v300 - - """ - pass - - def test_send_email_redirect_capture(self): - """Test case for send_email_redirect_capture - - """ - pass - - def test_start_email_redirect_capture(self): - """Test case for start_email_redirect_capture - - """ - pass - - def test_stripe_ach_bank_account_capture(self): - """Test case for stripe_ach_bank_account_capture - - """ - pass - - def test_stripe_web_hook(self): - """Test case for stripe_web_hook - - """ - pass - - def test_update_email_redirect_capture(self): - """Test case for update_email_redirect_capture - - """ - pass - - def test_update_profile_with_token(self): - """Test case for update_profile_with_token - - """ - pass - - def test_update_stripe_ach_token(self): - """Test case for update_stripe_ach_token - - """ - pass - - def test_update_stripe_token(self): - """Test case for update_stripe_token - - """ - pass - - def test_zooz_card_capture(self): - """Test case for zooz_card_capture - - """ - pass - - def test_zooz_web_hook(self): - """Test case for zooz_web_hook - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tokenization_epxredirect_body.py b/test/test_tokenization_epxredirect_body.py deleted file mode 100644 index a26a557..0000000 --- a/test/test_tokenization_epxredirect_body.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.tokenization_epxredirect_body import TokenizationEpxredirectBody # noqa: E501 -from billforward.rest import ApiException - - -class TestTokenizationEpxredirectBody(unittest.TestCase): - """TokenizationEpxredirectBody unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTokenizationEpxredirectBody(self): - """Test TokenizationEpxredirectBody""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.tokenization_epxredirect_body.TokenizationEpxredirectBody() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tokenization_payvisionshoutv1_body.py b/test/test_tokenization_payvisionshoutv1_body.py deleted file mode 100644 index fc5247f..0000000 --- a/test/test_tokenization_payvisionshoutv1_body.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.tokenization_payvisionshoutv1_body import TokenizationPayvisionshoutv1Body # noqa: E501 -from billforward.rest import ApiException - - -class TestTokenizationPayvisionshoutv1Body(unittest.TestCase): - """TokenizationPayvisionshoutv1Body unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTokenizationPayvisionshoutv1Body(self): - """Test TokenizationPayvisionshoutv1Body""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.tokenization_payvisionshoutv1_body.TokenizationPayvisionshoutv1Body() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tokenization_pre_auth.py b/test/test_tokenization_pre_auth.py deleted file mode 100644 index 70382b9..0000000 --- a/test/test_tokenization_pre_auth.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.tokenization_pre_auth import TokenizationPreAuth # noqa: E501 -from billforward.rest import ApiException - - -class TestTokenizationPreAuth(unittest.TestCase): - """TokenizationPreAuth unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTokenizationPreAuth(self): - """Test TokenizationPreAuth""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.tokenization_pre_auth.TokenizationPreAuth() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tokenization_pre_auth_request.py b/test/test_tokenization_pre_auth_request.py deleted file mode 100644 index ef9f73b..0000000 --- a/test/test_tokenization_pre_auth_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.tokenization_pre_auth_request import TokenizationPreAuthRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestTokenizationPreAuthRequest(unittest.TestCase): - """TokenizationPreAuthRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTokenizationPreAuthRequest(self): - """Test TokenizationPreAuthRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.tokenization_pre_auth_request.TokenizationPreAuthRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tokenization_sagepaynotifyv300_body.py b/test/test_tokenization_sagepaynotifyv300_body.py deleted file mode 100644 index bdac5ec..0000000 --- a/test/test_tokenization_sagepaynotifyv300_body.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.tokenization_sagepaynotifyv300_body import TokenizationSagepaynotifyv300Body # noqa: E501 -from billforward.rest import ApiException - - -class TestTokenizationSagepaynotifyv300Body(unittest.TestCase): - """TokenizationSagepaynotifyv300Body unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTokenizationSagepaynotifyv300Body(self): - """Test TokenizationSagepaynotifyv300Body""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.tokenization_sagepaynotifyv300_body.TokenizationSagepaynotifyv300Body() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_tokens_response.py b/test/test_tokens_response.py deleted file mode 100644 index 120b894..0000000 --- a/test/test_tokens_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.tokens_response import TokensResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestTokensResponse(unittest.TestCase): - """TokensResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTokensResponse(self): - """Test TokensResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.tokens_response.TokensResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_trust_commerce_configuration.py b/test/test_trust_commerce_configuration.py deleted file mode 100644 index 0a1f2a3..0000000 --- a/test/test_trust_commerce_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.trust_commerce_configuration import TrustCommerceConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestTrustCommerceConfiguration(unittest.TestCase): - """TrustCommerceConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTrustCommerceConfiguration(self): - """Test TrustCommerceConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.trust_commerce_configuration.TrustCommerceConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_trust_commerce_token.py b/test/test_trust_commerce_token.py deleted file mode 100644 index 5c691a1..0000000 --- a/test/test_trust_commerce_token.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.trust_commerce_token import TrustCommerceToken # noqa: E501 -from billforward.rest import ApiException - - -class TestTrustCommerceToken(unittest.TestCase): - """TrustCommerceToken unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTrustCommerceToken(self): - """Test TrustCommerceToken""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.trust_commerce_token.TrustCommerceToken() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_account.py b/test/test_typed_query_result_wrapper_account.py deleted file mode 100644 index eac6145..0000000 --- a/test/test_typed_query_result_wrapper_account.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_account import TypedQueryResultWrapperAccount # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperAccount(unittest.TestCase): - """TypedQueryResultWrapperAccount unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperAccount(self): - """Test TypedQueryResultWrapperAccount""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_account.TypedQueryResultWrapperAccount() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_address.py b/test/test_typed_query_result_wrapper_address.py deleted file mode 100644 index db82c51..0000000 --- a/test/test_typed_query_result_wrapper_address.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_address import TypedQueryResultWrapperAddress # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperAddress(unittest.TestCase): - """TypedQueryResultWrapperAddress unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperAddress(self): - """Test TypedQueryResultWrapperAddress""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_address.TypedQueryResultWrapperAddress() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_amendment.py b/test/test_typed_query_result_wrapper_amendment.py deleted file mode 100644 index 81e7f97..0000000 --- a/test/test_typed_query_result_wrapper_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_amendment import TypedQueryResultWrapperAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperAmendment(unittest.TestCase): - """TypedQueryResultWrapperAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperAmendment(self): - """Test TypedQueryResultWrapperAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_amendment.TypedQueryResultWrapperAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_api_quote.py b/test/test_typed_query_result_wrapper_api_quote.py deleted file mode 100644 index d0be7ff..0000000 --- a/test/test_typed_query_result_wrapper_api_quote.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_api_quote import TypedQueryResultWrapperAPIQuote # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperAPIQuote(unittest.TestCase): - """TypedQueryResultWrapperAPIQuote unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperAPIQuote(self): - """Test TypedQueryResultWrapperAPIQuote""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_api_quote.TypedQueryResultWrapperAPIQuote() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_avatax_configuration.py b/test/test_typed_query_result_wrapper_avatax_configuration.py deleted file mode 100644 index dfdca25..0000000 --- a/test/test_typed_query_result_wrapper_avatax_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_avatax_configuration import TypedQueryResultWrapperAvataxConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperAvataxConfiguration(unittest.TestCase): - """TypedQueryResultWrapperAvataxConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperAvataxConfiguration(self): - """Test TypedQueryResultWrapperAvataxConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_avatax_configuration.TypedQueryResultWrapperAvataxConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_bf_permission.py b/test/test_typed_query_result_wrapper_bf_permission.py deleted file mode 100644 index 9d764b9..0000000 --- a/test/test_typed_query_result_wrapper_bf_permission.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_bf_permission import TypedQueryResultWrapperBFPermission # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperBFPermission(unittest.TestCase): - """TypedQueryResultWrapperBFPermission unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperBFPermission(self): - """Test TypedQueryResultWrapperBFPermission""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_bf_permission.TypedQueryResultWrapperBFPermission() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_braintree_token.py b/test/test_typed_query_result_wrapper_braintree_token.py deleted file mode 100644 index 2de70cf..0000000 --- a/test/test_typed_query_result_wrapper_braintree_token.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_braintree_token import TypedQueryResultWrapperBraintreeToken # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperBraintreeToken(unittest.TestCase): - """TypedQueryResultWrapperBraintreeToken unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperBraintreeToken(self): - """Test TypedQueryResultWrapperBraintreeToken""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_braintree_token.TypedQueryResultWrapperBraintreeToken() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_contract.py b/test/test_typed_query_result_wrapper_contract.py deleted file mode 100644 index 6407b11..0000000 --- a/test/test_typed_query_result_wrapper_contract.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_contract import TypedQueryResultWrapperContract # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperContract(unittest.TestCase): - """TypedQueryResultWrapperContract unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperContract(self): - """Test TypedQueryResultWrapperContract""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_contract.TypedQueryResultWrapperContract() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_coupon.py b/test/test_typed_query_result_wrapper_coupon.py deleted file mode 100644 index 4592676..0000000 --- a/test/test_typed_query_result_wrapper_coupon.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_coupon import TypedQueryResultWrapperCoupon # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperCoupon(unittest.TestCase): - """TypedQueryResultWrapperCoupon unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperCoupon(self): - """Test TypedQueryResultWrapperCoupon""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_coupon.TypedQueryResultWrapperCoupon() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_credit_note.py b/test/test_typed_query_result_wrapper_credit_note.py deleted file mode 100644 index 0437c74..0000000 --- a/test/test_typed_query_result_wrapper_credit_note.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_credit_note import TypedQueryResultWrapperCreditNote # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperCreditNote(unittest.TestCase): - """TypedQueryResultWrapperCreditNote unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperCreditNote(self): - """Test TypedQueryResultWrapperCreditNote""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_credit_note.TypedQueryResultWrapperCreditNote() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_data_sync_job_response.py b/test/test_typed_query_result_wrapper_data_sync_job_response.py deleted file mode 100644 index 2370bc8..0000000 --- a/test/test_typed_query_result_wrapper_data_sync_job_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_data_sync_job_response import TypedQueryResultWrapperDataSyncJobResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperDataSyncJobResponse(unittest.TestCase): - """TypedQueryResultWrapperDataSyncJobResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperDataSyncJobResponse(self): - """Test TypedQueryResultWrapperDataSyncJobResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_data_sync_job_response.TypedQueryResultWrapperDataSyncJobResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_dunning_line.py b/test/test_typed_query_result_wrapper_dunning_line.py deleted file mode 100644 index 5d90ef2..0000000 --- a/test/test_typed_query_result_wrapper_dunning_line.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_dunning_line import TypedQueryResultWrapperDunningLine # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperDunningLine(unittest.TestCase): - """TypedQueryResultWrapperDunningLine unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperDunningLine(self): - """Test TypedQueryResultWrapperDunningLine""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_dunning_line.TypedQueryResultWrapperDunningLine() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_invoice.py b/test/test_typed_query_result_wrapper_invoice.py deleted file mode 100644 index 4705ee3..0000000 --- a/test/test_typed_query_result_wrapper_invoice.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_invoice import TypedQueryResultWrapperInvoice # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperInvoice(unittest.TestCase): - """TypedQueryResultWrapperInvoice unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperInvoice(self): - """Test TypedQueryResultWrapperInvoice""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_invoice.TypedQueryResultWrapperInvoice() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_invoice_line_payment.py b/test/test_typed_query_result_wrapper_invoice_line_payment.py deleted file mode 100644 index a00f5f0..0000000 --- a/test/test_typed_query_result_wrapper_invoice_line_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_invoice_line_payment import TypedQueryResultWrapperInvoiceLinePayment # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperInvoiceLinePayment(unittest.TestCase): - """TypedQueryResultWrapperInvoiceLinePayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperInvoiceLinePayment(self): - """Test TypedQueryResultWrapperInvoiceLinePayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_invoice_line_payment.TypedQueryResultWrapperInvoiceLinePayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_notification.py b/test/test_typed_query_result_wrapper_notification.py deleted file mode 100644 index 0937cf9..0000000 --- a/test/test_typed_query_result_wrapper_notification.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_notification import TypedQueryResultWrapperNotification # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperNotification(unittest.TestCase): - """TypedQueryResultWrapperNotification unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperNotification(self): - """Test TypedQueryResultWrapperNotification""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_notification.TypedQueryResultWrapperNotification() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_payment.py b/test/test_typed_query_result_wrapper_payment.py deleted file mode 100644 index 5b46707..0000000 --- a/test/test_typed_query_result_wrapper_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_payment import TypedQueryResultWrapperPayment # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperPayment(unittest.TestCase): - """TypedQueryResultWrapperPayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperPayment(self): - """Test TypedQueryResultWrapperPayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_payment.TypedQueryResultWrapperPayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_payment_method.py b/test/test_typed_query_result_wrapper_payment_method.py deleted file mode 100644 index 7b0a36d..0000000 --- a/test/test_typed_query_result_wrapper_payment_method.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_payment_method import TypedQueryResultWrapperPaymentMethod # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperPaymentMethod(unittest.TestCase): - """TypedQueryResultWrapperPaymentMethod unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperPaymentMethod(self): - """Test TypedQueryResultWrapperPaymentMethod""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_payment_method.TypedQueryResultWrapperPaymentMethod() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_plan_response.py b/test/test_typed_query_result_wrapper_plan_response.py deleted file mode 100644 index 6574075..0000000 --- a/test/test_typed_query_result_wrapper_plan_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_plan_response import TypedQueryResultWrapperPlanResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperPlanResponse(unittest.TestCase): - """TypedQueryResultWrapperPlanResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperPlanResponse(self): - """Test TypedQueryResultWrapperPlanResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_plan_response.TypedQueryResultWrapperPlanResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_profile.py b/test/test_typed_query_result_wrapper_profile.py deleted file mode 100644 index a64c64a..0000000 --- a/test/test_typed_query_result_wrapper_profile.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_profile import TypedQueryResultWrapperProfile # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperProfile(unittest.TestCase): - """TypedQueryResultWrapperProfile unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperProfile(self): - """Test TypedQueryResultWrapperProfile""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_profile.TypedQueryResultWrapperProfile() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_receipt.py b/test/test_typed_query_result_wrapper_receipt.py deleted file mode 100644 index 0429041..0000000 --- a/test/test_typed_query_result_wrapper_receipt.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_receipt import TypedQueryResultWrapperReceipt # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperReceipt(unittest.TestCase): - """TypedQueryResultWrapperReceipt unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperReceipt(self): - """Test TypedQueryResultWrapperReceipt""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_receipt.TypedQueryResultWrapperReceipt() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_refund.py b/test/test_typed_query_result_wrapper_refund.py deleted file mode 100644 index 3049dea..0000000 --- a/test/test_typed_query_result_wrapper_refund.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_refund import TypedQueryResultWrapperRefund # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperRefund(unittest.TestCase): - """TypedQueryResultWrapperRefund unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperRefund(self): - """Test TypedQueryResultWrapperRefund""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_refund.TypedQueryResultWrapperRefund() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_revenue_attribution.py b/test/test_typed_query_result_wrapper_revenue_attribution.py deleted file mode 100644 index ffd31ba..0000000 --- a/test/test_typed_query_result_wrapper_revenue_attribution.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_revenue_attribution import TypedQueryResultWrapperRevenueAttribution # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperRevenueAttribution(unittest.TestCase): - """TypedQueryResultWrapperRevenueAttribution unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperRevenueAttribution(self): - """Test TypedQueryResultWrapperRevenueAttribution""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_revenue_attribution.TypedQueryResultWrapperRevenueAttribution() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_role.py b/test/test_typed_query_result_wrapper_role.py deleted file mode 100644 index d8cd804..0000000 --- a/test/test_typed_query_result_wrapper_role.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_role import TypedQueryResultWrapperRole # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperRole(unittest.TestCase): - """TypedQueryResultWrapperRole unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperRole(self): - """Test TypedQueryResultWrapperRole""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_role.TypedQueryResultWrapperRole() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_stripe_ach_token.py b/test/test_typed_query_result_wrapper_stripe_ach_token.py deleted file mode 100644 index a7f629a..0000000 --- a/test/test_typed_query_result_wrapper_stripe_ach_token.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_stripe_ach_token import TypedQueryResultWrapperStripeACHToken # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperStripeACHToken(unittest.TestCase): - """TypedQueryResultWrapperStripeACHToken unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperStripeACHToken(self): - """Test TypedQueryResultWrapperStripeACHToken""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_stripe_ach_token.TypedQueryResultWrapperStripeACHToken() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_stripe_token.py b/test/test_typed_query_result_wrapper_stripe_token.py deleted file mode 100644 index ed0e49c..0000000 --- a/test/test_typed_query_result_wrapper_stripe_token.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_stripe_token import TypedQueryResultWrapperStripeToken # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperStripeToken(unittest.TestCase): - """TypedQueryResultWrapperStripeToken unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperStripeToken(self): - """Test TypedQueryResultWrapperStripeToken""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_stripe_token.TypedQueryResultWrapperStripeToken() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_subscription.py b/test/test_typed_query_result_wrapper_subscription.py deleted file mode 100644 index 433cc05..0000000 --- a/test/test_typed_query_result_wrapper_subscription.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_subscription import TypedQueryResultWrapperSubscription # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperSubscription(unittest.TestCase): - """TypedQueryResultWrapperSubscription unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperSubscription(self): - """Test TypedQueryResultWrapperSubscription""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_subscription.TypedQueryResultWrapperSubscription() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_subscription_charge.py b/test/test_typed_query_result_wrapper_subscription_charge.py deleted file mode 100644 index e18eb63..0000000 --- a/test/test_typed_query_result_wrapper_subscription_charge.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_subscription_charge import TypedQueryResultWrapperSubscriptionCharge # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperSubscriptionCharge(unittest.TestCase): - """TypedQueryResultWrapperSubscriptionCharge unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperSubscriptionCharge(self): - """Test TypedQueryResultWrapperSubscriptionCharge""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_subscription_charge.TypedQueryResultWrapperSubscriptionCharge() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_taxation_strategy.py b/test/test_typed_query_result_wrapper_taxation_strategy.py deleted file mode 100644 index 2e7c941..0000000 --- a/test/test_typed_query_result_wrapper_taxation_strategy.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_taxation_strategy import TypedQueryResultWrapperTaxationStrategy # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperTaxationStrategy(unittest.TestCase): - """TypedQueryResultWrapperTaxationStrategy unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperTaxationStrategy(self): - """Test TypedQueryResultWrapperTaxationStrategy""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_taxation_strategy.TypedQueryResultWrapperTaxationStrategy() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_user_response.py b/test/test_typed_query_result_wrapper_user_response.py deleted file mode 100644 index 8fa49fc..0000000 --- a/test/test_typed_query_result_wrapper_user_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_user_response import TypedQueryResultWrapperUserResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperUserResponse(unittest.TestCase): - """TypedQueryResultWrapperUserResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperUserResponse(self): - """Test TypedQueryResultWrapperUserResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_user_response.TypedQueryResultWrapperUserResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_typed_query_result_wrapper_webhook.py b/test/test_typed_query_result_wrapper_webhook.py deleted file mode 100644 index afdef06..0000000 --- a/test/test_typed_query_result_wrapper_webhook.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.typed_query_result_wrapper_webhook import TypedQueryResultWrapperWebhook # noqa: E501 -from billforward.rest import ApiException - - -class TestTypedQueryResultWrapperWebhook(unittest.TestCase): - """TypedQueryResultWrapperWebhook unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTypedQueryResultWrapperWebhook(self): - """Test TypedQueryResultWrapperWebhook""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.typed_query_result_wrapper_webhook.TypedQueryResultWrapperWebhook() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_unit_of_measure.py b/test/test_unit_of_measure.py deleted file mode 100644 index bedff40..0000000 --- a/test/test_unit_of_measure.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.unit_of_measure import UnitOfMeasure # noqa: E501 -from billforward.rest import ApiException - - -class TestUnitOfMeasure(unittest.TestCase): - """UnitOfMeasure unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUnitOfMeasure(self): - """Test UnitOfMeasure""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.unit_of_measure.UnitOfMeasure() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_component_value_amendment.py b/test/test_update_component_value_amendment.py deleted file mode 100644 index 93e1041..0000000 --- a/test/test_update_component_value_amendment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_component_value_amendment import UpdateComponentValueAmendment # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdateComponentValueAmendment(unittest.TestCase): - """UpdateComponentValueAmendment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdateComponentValueAmendment(self): - """Test UpdateComponentValueAmendment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_component_value_amendment.UpdateComponentValueAmendment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_contract_request.py b/test/test_update_contract_request.py deleted file mode 100644 index 59f1eac..0000000 --- a/test/test_update_contract_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_contract_request import UpdateContractRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdateContractRequest(unittest.TestCase): - """UpdateContractRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdateContractRequest(self): - """Test UpdateContractRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_contract_request.UpdateContractRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_email_request.py b/test/test_update_email_request.py deleted file mode 100644 index 25020d9..0000000 --- a/test/test_update_email_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_email_request import UpdateEmailRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdateEmailRequest(unittest.TestCase): - """UpdateEmailRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdateEmailRequest(self): - """Test UpdateEmailRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_email_request.UpdateEmailRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_invoice_request.py b/test/test_update_invoice_request.py deleted file mode 100644 index ce7e23b..0000000 --- a/test/test_update_invoice_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_invoice_request import UpdateInvoiceRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdateInvoiceRequest(unittest.TestCase): - """UpdateInvoiceRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdateInvoiceRequest(self): - """Test UpdateInvoiceRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_invoice_request.UpdateInvoiceRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_invoice_template_request.py b/test/test_update_invoice_template_request.py deleted file mode 100644 index 639715c..0000000 --- a/test/test_update_invoice_template_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_invoice_template_request import UpdateInvoiceTemplateRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdateInvoiceTemplateRequest(unittest.TestCase): - """UpdateInvoiceTemplateRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdateInvoiceTemplateRequest(self): - """Test UpdateInvoiceTemplateRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_invoice_template_request.UpdateInvoiceTemplateRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_password_request.py b/test/test_update_password_request.py deleted file mode 100644 index a59d84d..0000000 --- a/test/test_update_password_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_password_request import UpdatePasswordRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdatePasswordRequest(unittest.TestCase): - """UpdatePasswordRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdatePasswordRequest(self): - """Test UpdatePasswordRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_password_request.UpdatePasswordRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_password_response.py b/test/test_update_password_response.py deleted file mode 100644 index 5904b9e..0000000 --- a/test/test_update_password_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_password_response import UpdatePasswordResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdatePasswordResponse(unittest.TestCase): - """UpdatePasswordResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdatePasswordResponse(self): - """Test UpdatePasswordResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_password_response.UpdatePasswordResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_pricing_component_value_change_result.py b/test/test_update_pricing_component_value_change_result.py deleted file mode 100644 index 8909e4a..0000000 --- a/test/test_update_pricing_component_value_change_result.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_pricing_component_value_change_result import UpdatePricingComponentValueChangeResult # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdatePricingComponentValueChangeResult(unittest.TestCase): - """UpdatePricingComponentValueChangeResult unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdatePricingComponentValueChangeResult(self): - """Test UpdatePricingComponentValueChangeResult""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_pricing_component_value_change_result.UpdatePricingComponentValueChangeResult() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_pricing_component_value_request.py b/test/test_update_pricing_component_value_request.py deleted file mode 100644 index 04cc5ff..0000000 --- a/test/test_update_pricing_component_value_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_pricing_component_value_request import UpdatePricingComponentValueRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdatePricingComponentValueRequest(unittest.TestCase): - """UpdatePricingComponentValueRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdatePricingComponentValueRequest(self): - """Test UpdatePricingComponentValueRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_pricing_component_value_request.UpdatePricingComponentValueRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_pricing_component_value_response.py b/test/test_update_pricing_component_value_response.py deleted file mode 100644 index 5831ec8..0000000 --- a/test/test_update_pricing_component_value_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_pricing_component_value_response import UpdatePricingComponentValueResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdatePricingComponentValueResponse(unittest.TestCase): - """UpdatePricingComponentValueResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdatePricingComponentValueResponse(self): - """Test UpdatePricingComponentValueResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_pricing_component_value_response.UpdatePricingComponentValueResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_rate_plan_affiliate_request.py b/test/test_update_rate_plan_affiliate_request.py deleted file mode 100644 index 56b79e2..0000000 --- a/test/test_update_rate_plan_affiliate_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_rate_plan_affiliate_request import UpdateRatePlanAffiliateRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdateRatePlanAffiliateRequest(unittest.TestCase): - """UpdateRatePlanAffiliateRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdateRatePlanAffiliateRequest(self): - """Test UpdateRatePlanAffiliateRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_rate_plan_affiliate_request.UpdateRatePlanAffiliateRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_role_request.py b/test/test_update_role_request.py deleted file mode 100644 index 1b37865..0000000 --- a/test/test_update_role_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_role_request import UpdateRoleRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdateRoleRequest(unittest.TestCase): - """UpdateRoleRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdateRoleRequest(self): - """Test UpdateRoleRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_role_request.UpdateRoleRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_salesforce_configuration_request.py b/test/test_update_salesforce_configuration_request.py deleted file mode 100644 index dcc691a..0000000 --- a/test/test_update_salesforce_configuration_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_salesforce_configuration_request import UpdateSalesforceConfigurationRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdateSalesforceConfigurationRequest(unittest.TestCase): - """UpdateSalesforceConfigurationRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdateSalesforceConfigurationRequest(self): - """Test UpdateSalesforceConfigurationRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_salesforce_configuration_request.UpdateSalesforceConfigurationRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_subscription_request.py b/test/test_update_subscription_request.py deleted file mode 100644 index 748958e..0000000 --- a/test/test_update_subscription_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_subscription_request import UpdateSubscriptionRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdateSubscriptionRequest(unittest.TestCase): - """UpdateSubscriptionRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdateSubscriptionRequest(self): - """Test UpdateSubscriptionRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_subscription_request.UpdateSubscriptionRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_update_user_info_request.py b/test/test_update_user_info_request.py deleted file mode 100644 index be61e3f..0000000 --- a/test/test_update_user_info_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.update_user_info_request import UpdateUserInfoRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUpdateUserInfoRequest(unittest.TestCase): - """UpdateUserInfoRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpdateUserInfoRequest(self): - """Test UpdateUserInfoRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.update_user_info_request.UpdateUserInfoRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_upgrade_charge.py b/test/test_upgrade_charge.py deleted file mode 100644 index c41df6a..0000000 --- a/test/test_upgrade_charge.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.upgrade_charge import UpgradeCharge # noqa: E501 -from billforward.rest import ApiException - - -class TestUpgradeCharge(unittest.TestCase): - """UpgradeCharge unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUpgradeCharge(self): - """Test UpgradeCharge""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.upgrade_charge.UpgradeCharge() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_usage_pricing_components_by_charge_model.py b/test/test_usage_pricing_components_by_charge_model.py deleted file mode 100644 index a485745..0000000 --- a/test/test_usage_pricing_components_by_charge_model.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.usage_pricing_components_by_charge_model import UsagePricingComponentsByChargeModel # noqa: E501 -from billforward.rest import ApiException - - -class TestUsagePricingComponentsByChargeModel(unittest.TestCase): - """UsagePricingComponentsByChargeModel unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUsagePricingComponentsByChargeModel(self): - """Test UsagePricingComponentsByChargeModel""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.usage_pricing_components_by_charge_model.UsagePricingComponentsByChargeModel() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_user.py b/test/test_user.py deleted file mode 100644 index 4145164..0000000 --- a/test/test_user.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.user import User # noqa: E501 -from billforward.rest import ApiException - - -class TestUser(unittest.TestCase): - """User unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUser(self): - """Test User""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.user.User() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_user_create_request.py b/test/test_user_create_request.py deleted file mode 100644 index 878abd7..0000000 --- a/test/test_user_create_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.user_create_request import UserCreateRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUserCreateRequest(unittest.TestCase): - """UserCreateRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUserCreateRequest(self): - """Test UserCreateRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.user_create_request.UserCreateRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_user_creation_request.py b/test/test_user_creation_request.py deleted file mode 100644 index 4864a54..0000000 --- a/test/test_user_creation_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.user_creation_request import UserCreationRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUserCreationRequest(unittest.TestCase): - """UserCreationRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUserCreationRequest(self): - """Test UserCreationRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.user_creation_request.UserCreationRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_user_creation_response.py b/test/test_user_creation_response.py deleted file mode 100644 index 545c017..0000000 --- a/test/test_user_creation_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.user_creation_response import UserCreationResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestUserCreationResponse(unittest.TestCase): - """UserCreationResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUserCreationResponse(self): - """Test UserCreationResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.user_creation_response.UserCreationResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_user_invite_request.py b/test/test_user_invite_request.py deleted file mode 100644 index d7846bf..0000000 --- a/test/test_user_invite_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.user_invite_request import UserInviteRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUserInviteRequest(unittest.TestCase): - """UserInviteRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUserInviteRequest(self): - """Test UserInviteRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.user_invite_request.UserInviteRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_user_private_permanent_token_refresh_request.py b/test/test_user_private_permanent_token_refresh_request.py deleted file mode 100644 index b7c0571..0000000 --- a/test/test_user_private_permanent_token_refresh_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.user_private_permanent_token_refresh_request import UserPrivatePermanentTokenRefreshRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUserPrivatePermanentTokenRefreshRequest(unittest.TestCase): - """UserPrivatePermanentTokenRefreshRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUserPrivatePermanentTokenRefreshRequest(self): - """Test UserPrivatePermanentTokenRefreshRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.user_private_permanent_token_refresh_request.UserPrivatePermanentTokenRefreshRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_user_private_permanent_token_request.py b/test/test_user_private_permanent_token_request.py deleted file mode 100644 index 486284a..0000000 --- a/test/test_user_private_permanent_token_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.user_private_permanent_token_request import UserPrivatePermanentTokenRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestUserPrivatePermanentTokenRequest(unittest.TestCase): - """UserPrivatePermanentTokenRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUserPrivatePermanentTokenRequest(self): - """Test UserPrivatePermanentTokenRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.user_private_permanent_token_request.UserPrivatePermanentTokenRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_user_response.py b/test/test_user_response.py deleted file mode 100644 index 5881366..0000000 --- a/test/test_user_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.user_response import UserResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestUserResponse(unittest.TestCase): - """UserResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUserResponse(self): - """Test UserResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.user_response.UserResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_user_timezone.py b/test/test_user_timezone.py deleted file mode 100644 index f3db644..0000000 --- a/test/test_user_timezone.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.user_timezone import UserTimezone # noqa: E501 -from billforward.rest import ApiException - - -class TestUserTimezone(unittest.TestCase): - """UserTimezone unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUserTimezone(self): - """Test UserTimezone""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.user_timezone.UserTimezone() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_username.py b/test/test_username.py deleted file mode 100644 index 77dfa61..0000000 --- a/test/test_username.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.username import Username # noqa: E501 -from billforward.rest import ApiException - - -class TestUsername(unittest.TestCase): - """Username unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUsername(self): - """Test Username""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.username.Username() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_username_response.py b/test/test_username_response.py deleted file mode 100644 index 017c2c7..0000000 --- a/test/test_username_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.username_response import UsernameResponse # noqa: E501 -from billforward.rest import ApiException - - -class TestUsernameResponse(unittest.TestCase): - """UsernameResponse unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testUsernameResponse(self): - """Test UsernameResponse""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.username_response.UsernameResponse() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_value_increment.py b/test/test_value_increment.py deleted file mode 100644 index c625959..0000000 --- a/test/test_value_increment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.value_increment import ValueIncrement # noqa: E501 -from billforward.rest import ApiException - - -class TestValueIncrement(unittest.TestCase): - """ValueIncrement unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testValueIncrement(self): - """Test ValueIncrement""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.value_increment.ValueIncrement() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_verify_payment_method_request.py b/test/test_verify_payment_method_request.py deleted file mode 100644 index 2e59e34..0000000 --- a/test/test_verify_payment_method_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.verify_payment_method_request import VerifyPaymentMethodRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestVerifyPaymentMethodRequest(unittest.TestCase): - """VerifyPaymentMethodRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testVerifyPaymentMethodRequest(self): - """Test VerifyPaymentMethodRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.verify_payment_method_request.VerifyPaymentMethodRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_webhook.py b/test/test_webhook.py deleted file mode 100644 index 1a2b592..0000000 --- a/test/test_webhook.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.webhook import Webhook # noqa: E501 -from billforward.rest import ApiException - - -class TestWebhook(unittest.TestCase): - """Webhook unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testWebhook(self): - """Test Webhook""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.webhook.Webhook() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_webhook_subscription.py b/test/test_webhook_subscription.py deleted file mode 100644 index d7862e3..0000000 --- a/test/test_webhook_subscription.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.webhook_subscription import WebhookSubscription # noqa: E501 -from billforward.rest import ApiException - - -class TestWebhookSubscription(unittest.TestCase): - """WebhookSubscription unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testWebhookSubscription(self): - """Test WebhookSubscription""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.webhook_subscription.WebhookSubscription() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_webhooks_api.py b/test/test_webhooks_api.py deleted file mode 100644 index 2bbb882..0000000 --- a/test/test_webhooks_api.py +++ /dev/null @@ -1,81 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.api.webhooks_api import WebhooksApi # noqa: E501 -from billforward.rest import ApiException - - -class TestWebhooksApi(unittest.TestCase): - """WebhooksApi unit test stubs""" - - def setUp(self): - self.api = WebhooksApi() # noqa: E501 - - def tearDown(self): - pass - - def test_create_webhook(self): - """Test case for create_webhook - - """ - pass - - def test_create_webhook_v2(self): - """Test case for create_webhook_v2 - - """ - pass - - def test_get_all_webhooks(self): - """Test case for get_all_webhooks - - """ - pass - - def test_get_allowed_webhook_subscriptions(self): - """Test case for get_allowed_webhook_subscriptions - - """ - pass - - def test_get_webhook_by_id(self): - """Test case for get_webhook_by_id - - """ - pass - - def test_retire_webhook(self): - """Test case for retire_webhook - - """ - pass - - def test_update_webhook(self): - """Test case for update_webhook - - """ - pass - - def test_verify_webhook(self): - """Test case for verify_webhook - - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_zooz_capture_request.py b/test/test_zooz_capture_request.py deleted file mode 100644 index df1b3fd..0000000 --- a/test/test_zooz_capture_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.zooz_capture_request import ZoozCaptureRequest # noqa: E501 -from billforward.rest import ApiException - - -class TestZoozCaptureRequest(unittest.TestCase): - """ZoozCaptureRequest unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testZoozCaptureRequest(self): - """Test ZoozCaptureRequest""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.zooz_capture_request.ZoozCaptureRequest() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_zooz_configuration.py b/test/test_zooz_configuration.py deleted file mode 100644 index ad3e7a7..0000000 --- a/test/test_zooz_configuration.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.zooz_configuration import ZoozConfiguration # noqa: E501 -from billforward.rest import ApiException - - -class TestZoozConfiguration(unittest.TestCase): - """ZoozConfiguration unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testZoozConfiguration(self): - """Test ZoozConfiguration""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.zooz_configuration.ZoozConfiguration() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/test/test_zooz_payment.py b/test/test_zooz_payment.py deleted file mode 100644 index 6f2557e..0000000 --- a/test/test_zooz_payment.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import unittest - -import billforward -from billforward.models.zooz_payment import ZoozPayment # noqa: E501 -from billforward.rest import ApiException - - -class TestZoozPayment(unittest.TestCase): - """ZoozPayment unit test stubs""" - - def setUp(self): - pass - - def tearDown(self): - pass - - def testZoozPayment(self): - """Test ZoozPayment""" - # FIXME: construct object with mandatory attributes with example values - # model = billforward.models.zooz_payment.ZoozPayment() # noqa: E501 - pass - - -if __name__ == '__main__': - unittest.main() From 38a02740ca281435a37fba890a502162ea83fbee Mon Sep 17 00:00:00 2001 From: Mat Jaggard Date: Mon, 6 Dec 2021 13:01:55 +0000 Subject: [PATCH 3/8] Revert removal of license --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 201 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. From 3fcb04c90fa62356b5cfd778f5fa9cb00af24637 Mon Sep 17 00:00:00 2001 From: Mat Jaggard Date: Mon, 6 Dec 2021 13:14:02 +0000 Subject: [PATCH 4/8] Add configuration info --- README.md | 677 +++++++++++++++++++++++++++--------------------------- 1 file changed, 340 insertions(+), 337 deletions(-) diff --git a/README.md b/README.md index b44a509..31314e7 100644 --- a/README.md +++ b/README.md @@ -9,21 +9,21 @@ This Python package is automatically generated by the [Swagger Codegen](https:// ## Requirements. -Python 2.7 and 3.4+ +Python 3.4+ ## Installation & Usage ### pip install -If the python package is hosted on Github, you can install directly from Github +The python package is hosted on Github, you can install directly from Github ```sh -pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git +pip install git+https://github.com/billforward/bf-python.git ``` -(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`) +(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/billforward/bf-python.git`) Then import the package: ```python -import billforward +import billforward ``` ### Setuptools @@ -51,10 +51,13 @@ import billforward from billforward.rest import ApiException from pprint import pprint +billforward.Configuration.api_key = ' Date: Mon, 6 Dec 2021 13:30:22 +0000 Subject: [PATCH 5/8] Update with zero value flag --- README.md | 664 +++++++++--------- billforward/api/reports_api.py | 6 +- .../affiliate_rate_plan_relationships.py | 58 +- billforward/models/amendment.py | 54 +- billforward/models/api_configuration.py | 54 +- .../models/pay_vision_configuration.py | 48 +- billforward/models/refund.py | 54 +- billforward/models/shuttle_configuration.py | 58 +- billforward/models/user.py | 58 +- docs/APIConfiguration.md | 2 +- docs/AffiliateRatePlanRelationships.md | 2 +- docs/Amendment.md | 2 +- docs/PayVisionConfiguration.md | 2 +- docs/Refund.md | 2 +- docs/ReportsApi.md | 6 +- docs/ShuttleConfiguration.md | 2 +- docs/User.md | 2 +- update_api.sh | 3 + 18 files changed, 543 insertions(+), 534 deletions(-) create mode 100755 update_api.sh diff --git a/README.md b/README.md index 31314e7..ae8145d 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ billforward.Configuration.host = 'https://app-sandbox.billforward.net/v1' # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | body = billforward.AddChargesToAccountAPIRequest() # AddChargesToAccountAPIRequest | (optional) try: @@ -69,7 +69,7 @@ except ApiException as e: # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | body = billforward.CreditAccountRequest() # CreditAccountRequest | (optional) try: @@ -103,7 +103,7 @@ except ApiException as e: # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | delete_gateway_data = false # bool | (optional) (default to false) delete_personal_data = false # bool | (optional) (default to false) organizations = ['organizations_example'] # list[str] | (optional) @@ -117,7 +117,7 @@ except ApiException as e: # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | organizations = ['organizations_example'] # list[str] | (optional) try: @@ -129,7 +129,7 @@ except ApiException as e: # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | organizations = ['organizations_example'] # list[str] | (optional) try: @@ -156,7 +156,7 @@ except ApiException as e: # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | organizations = ['organizations_example'] # list[str] | (optional) include_retired = false # bool | (optional) (default to false) @@ -169,7 +169,7 @@ except ApiException as e: # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | organizations = ['organizations_example'] # list[str] | (optional) offset = 0 # int | (optional) (default to 0) records = 10 # int | (optional) (default to 10) @@ -187,7 +187,7 @@ except ApiException as e: # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | organizations = ['organizations_example'] # list[str] | (optional) try: @@ -199,7 +199,7 @@ except ApiException as e: # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | organizations = ['organizations_example'] # list[str] | (optional) offset = 0 # int | (optional) (default to 0) records = 10 # int | (optional) (default to 10) @@ -217,7 +217,7 @@ except ApiException as e: # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | organizations = ['organizations_example'] # list[str] | (optional) offset = 0 # int | (optional) (default to 0) records = 10 # int | (optional) (default to 10) @@ -234,7 +234,7 @@ except ApiException as e: # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | body = billforward.HaltAggregationRequest() # HaltAggregationRequest | (optional) try: @@ -246,7 +246,7 @@ except ApiException as e: # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | body = billforward.RemoveCreditAccountRequest() # RemoveCreditAccountRequest | (optional) organizations = ['organizations_example'] # list[str] | (optional) @@ -259,7 +259,7 @@ except ApiException as e: # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | body = 'body_example' # str | (optional) organizations = ['organizations_example'] # list[str] | (optional) @@ -294,7 +294,7 @@ except ApiException as e: # create an instance of the API class api_instance = billforward.AccountsApi(billforward.ApiClient(configuration)) -account_id = 'account_id_example' # str | +account_id = 'account_id_example' # str | body = 'body_example' # str | (optional) organizations = ['organizations_example'] # list[str] | (optional) @@ -311,324 +311,324 @@ All URIs are relative to *https://app.billforward.net/v1* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*AccountsApi* | [**add_charge_to_account**](docs/AccountsApi.md#add_charge_to_account) | **POST** /accounts/{account-ID}/invoice | -*AccountsApi* | [**add_credit_note_to_account**](docs/AccountsApi.md#add_credit_note_to_account) | **POST** /accounts/{account-ID}/credit | -*AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /accounts | -*AccountsApi* | [**create_address**](docs/AccountsApi.md#create_address) | **POST** /addresses | -*AccountsApi* | [**delete_account**](docs/AccountsApi.md#delete_account) | **DELETE** /accounts/{account-ID} | -*AccountsApi* | [**delete_metadata_for_account**](docs/AccountsApi.md#delete_metadata_for_account) | **DELETE** /accounts/{account-ID}/metadata | -*AccountsApi* | [**get_account_by_id**](docs/AccountsApi.md#get_account_by_id) | **GET** /accounts/{account-ID} | -*AccountsApi* | [**get_all_accounts**](docs/AccountsApi.md#get_all_accounts) | **GET** /accounts | -*AccountsApi* | [**get_available_credit_on_account**](docs/AccountsApi.md#get_available_credit_on_account) | **GET** /accounts/{account-ID}/credit | -*AccountsApi* | [**get_invoices_by_account_id**](docs/AccountsApi.md#get_invoices_by_account_id) | **GET** /accounts/{account-ID}/invoices | -*AccountsApi* | [**get_metadata_for_account**](docs/AccountsApi.md#get_metadata_for_account) | **GET** /accounts/{account-ID}/metadata | -*AccountsApi* | [**get_payment_method_by_account_id**](docs/AccountsApi.md#get_payment_method_by_account_id) | **GET** /accounts/{account-ID}/payment-methods | -*AccountsApi* | [**get_subscription_charges**](docs/AccountsApi.md#get_subscription_charges) | **GET** /accounts/{account-ID}/charges | -*AccountsApi* | [**halt_aggregation**](docs/AccountsApi.md#halt_aggregation) | **POST** /accounts/{account-ID}/halt-aggregation | -*AccountsApi* | [**remove_credit_from_account2**](docs/AccountsApi.md#remove_credit_from_account2) | **DELETE** /accounts/{account-ID}/credit | -*AccountsApi* | [**set_metadata_for_account**](docs/AccountsApi.md#set_metadata_for_account) | **POST** /accounts/{account-ID}/metadata | -*AccountsApi* | [**update_account**](docs/AccountsApi.md#update_account) | **PUT** /accounts | -*AccountsApi* | [**update_address**](docs/AccountsApi.md#update_address) | **PUT** /addresses | -*AccountsApi* | [**upsert_metadata_for_account**](docs/AccountsApi.md#upsert_metadata_for_account) | **PUT** /accounts/{account-ID}/metadata | -*AffiliationApi* | [**create_invoice**](docs/AffiliationApi.md#create_invoice) | **POST** /affiliate/{account-id}/invoice | -*AffiliationApi* | [**get_affiliate**](docs/AffiliationApi.md#get_affiliate) | **GET** /product-rate-plans/{productRatePlanID}/affiliate | -*AffiliationApi* | [**get_affiliate1**](docs/AffiliationApi.md#get_affiliate1) | **GET** /subscriptions/{subscriptionID}/affiliate | -*AffiliationApi* | [**quote_invoice**](docs/AffiliationApi.md#quote_invoice) | **GET** /affiliate/{account-id}/quote/invoice/{invoice-id} | -*AffiliationApi* | [**quote_subscription**](docs/AffiliationApi.md#quote_subscription) | **GET** /affiliate/{account-id}/quote/subscription/{subscription-id} | -*AffiliationApi* | [**set_affiliate**](docs/AffiliationApi.md#set_affiliate) | **POST** /product-rate-plans/{product-rate-plan-ID}/affiliate | -*AffiliationApi* | [**set_affiliate1**](docs/AffiliationApi.md#set_affiliate1) | **POST** /subscriptions/{subscriptionID}/affiliate | -*AffiliationApi* | [**update_affiliate**](docs/AffiliationApi.md#update_affiliate) | **PUT** /product-rate-plans/{product-rate-plan-ID}/affiliate | -*AvataxApi* | [**create_avatax_configuration**](docs/AvataxApi.md#create_avatax_configuration) | **POST** /tax/avatax | -*AvataxApi* | [**get_avatax_configuration**](docs/AvataxApi.md#get_avatax_configuration) | **GET** /tax/avatax | -*AvataxApi* | [**ping**](docs/AvataxApi.md#ping) | **POST** /tax/avatax/ping | -*AvataxApi* | [**update_avatax_configuration**](docs/AvataxApi.md#update_avatax_configuration) | **PUT** /tax/avatax/{avatax-config-ID} | -*CardConnectApi* | [**delete_configuration**](docs/CardConnectApi.md#delete_configuration) | **DELETE** /cardconnect | -*CardConnectApi* | [**get_configuration**](docs/CardConnectApi.md#get_configuration) | **GET** /cardconnect | -*CardConnectApi* | [**upsert_configuration**](docs/CardConnectApi.md#upsert_configuration) | **POST** /cardconnect | -*ChargesApi* | [**batch_recalculate_subscription_charge**](docs/ChargesApi.md#batch_recalculate_subscription_charge) | **POST** /charges/recalculate | -*ChargesApi* | [**get_all_subscription_charges**](docs/ChargesApi.md#get_all_subscription_charges) | **GET** /charges | -*ChargesApi* | [**get_subscription_charge_by_id**](docs/ChargesApi.md#get_subscription_charge_by_id) | **GET** /charges/{charge-id} | -*ChargesApi* | [**recalculate_subscription_charge**](docs/ChargesApi.md#recalculate_subscription_charge) | **POST** /charges/{charge-ID}/recalculate | -*ChargesApi* | [**void_subscription_charge**](docs/ChargesApi.md#void_subscription_charge) | **DELETE** /charges/{charge-id} | -*CheckoutApi* | [**build_subscription_checkout**](docs/CheckoutApi.md#build_subscription_checkout) | **GET** /public/checkouts/subscriptions/{checkout-definition-path} | -*CheckoutApi* | [**create_account1**](docs/CheckoutApi.md#create_account1) | **POST** /public/accounts | -*CheckoutApi* | [**create_subscription_checkout_definition**](docs/CheckoutApi.md#create_subscription_checkout_definition) | **POST** /checkouts/subscriptions | -*CheckoutApi* | [**get_subscription_checkout_definition**](docs/CheckoutApi.md#get_subscription_checkout_definition) | **GET** /checkouts/subscriptions/{checkout-definition-path} | -*CheckoutApi* | [**subscription_checkout**](docs/CheckoutApi.md#subscription_checkout) | **POST** /public/checkouts/subscriptions | -*ContractsApi* | [**add_contract_period**](docs/ContractsApi.md#add_contract_period) | **POST** /contracts/{contract}/period | -*ContractsApi* | [**create_contract**](docs/ContractsApi.md#create_contract) | **POST** /contracts | -*ContractsApi* | [**get_all_contracts**](docs/ContractsApi.md#get_all_contracts) | **GET** /contracts | -*ContractsApi* | [**get_contract_by_id**](docs/ContractsApi.md#get_contract_by_id) | **GET** /contracts/{contract} | -*ContractsApi* | [**start_contract**](docs/ContractsApi.md#start_contract) | **POST** /contracts/{contract}/start | -*ContractsApi* | [**update_contract**](docs/ContractsApi.md#update_contract) | **PUT** /contracts | -*ContractsApi* | [**void_contract**](docs/ContractsApi.md#void_contract) | **DELETE** /contracts/{contract} | -*ContractsApi* | [**void_final_contract_period**](docs/ContractsApi.md#void_final_contract_period) | **DELETE** /contracts/{contract}/period | -*CouponsApi* | [**create_coupon**](docs/CouponsApi.md#create_coupon) | **POST** /coupons | -*CouponsApi* | [**create_coupon_unique_codes**](docs/CouponsApi.md#create_coupon_unique_codes) | **POST** /coupons/{code}/codes | -*CouponsApi* | [**get_all_coupons**](docs/CouponsApi.md#get_all_coupons) | **GET** /coupons | -*CouponsApi* | [**get_applied_coupons**](docs/CouponsApi.md#get_applied_coupons) | **GET** /coupons/{code}/applied | -*CouponsApi* | [**get_available_coupon_codes_for_code**](docs/CouponsApi.md#get_available_coupon_codes_for_code) | **GET** /coupons/{code}/codes | -*CouponsApi* | [**get_available_coupon_codes_for_code_as_csv**](docs/CouponsApi.md#get_available_coupon_codes_for_code_as_csv) | **GET** /coupons/{code}/codes.csv | -*CouponsApi* | [**get_coupon_code**](docs/CouponsApi.md#get_coupon_code) | **GET** /coupons/{code} | -*CouponsApi* | [**get_plans_for_coupon**](docs/CouponsApi.md#get_plans_for_coupon) | **GET** /coupons/{code}/plans | -*CouponsApi* | [**get_subscription_applications_of_coupons**](docs/CouponsApi.md#get_subscription_applications_of_coupons) | **GET** /coupons/{code}/subscriptions | -*CouponsApi* | [**retire_coupon**](docs/CouponsApi.md#retire_coupon) | **DELETE** /coupons/{code} | -*DunningApi* | [**create_dunning_line**](docs/DunningApi.md#create_dunning_line) | **POST** /dunning-lines | -*DunningApi* | [**get_all_dunning_lines**](docs/DunningApi.md#get_all_dunning_lines) | **GET** /dunning-lines | -*DunningApi* | [**get_dunning_line_by_attempt_index**](docs/DunningApi.md#get_dunning_line_by_attempt_index) | **GET** /dunning-lines/attempt-index/{index} | -*DunningApi* | [**get_dunning_line_by_id**](docs/DunningApi.md#get_dunning_line_by_id) | **GET** /dunning-lines/{dunning-line-ID} | -*DunningApi* | [**retire_dunning_line**](docs/DunningApi.md#retire_dunning_line) | **DELETE** /dunning-lines/{dunning-line-ID} | -*DunningApi* | [**update_dunning_line**](docs/DunningApi.md#update_dunning_line) | **PUT** /dunning-lines | -*EBANXApi* | [**delete_configuration1**](docs/EBANXApi.md#delete_configuration1) | **DELETE** /ebanx | -*EBANXApi* | [**get_configuration1**](docs/EBANXApi.md#get_configuration1) | **GET** /ebanx | -*EBANXApi* | [**handle_webhook**](docs/EBANXApi.md#handle_webhook) | **POST** /ebanx/webhook/{organization_id} | -*EBANXApi* | [**upsert_configuration1**](docs/EBANXApi.md#upsert_configuration1) | **POST** /ebanx | -*InvoicesApi* | [**add_charge_to_invoice**](docs/InvoicesApi.md#add_charge_to_invoice) | **POST** /invoices/{invoice-ID}/charges | -*InvoicesApi* | [**execute_invoice**](docs/InvoicesApi.md#execute_invoice) | **POST** /invoices/{invoice-ID}/execute | -*InvoicesApi* | [**get_all_invoices**](docs/InvoicesApi.md#get_all_invoices) | **GET** /invoices | -*InvoicesApi* | [**get_all_invoices_as_csv**](docs/InvoicesApi.md#get_all_invoices_as_csv) | **GET** /invoices/all.csv | -*InvoicesApi* | [**get_bucketed_revenue_attributions_as_csv**](docs/InvoicesApi.md#get_bucketed_revenue_attributions_as_csv) | **GET** /invoices/bucketed-revenue-attributions.csv | -*InvoicesApi* | [**get_charges_on_invoice**](docs/InvoicesApi.md#get_charges_on_invoice) | **GET** /invoices/{invoice-ID}/charges | -*InvoicesApi* | [**get_credit_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/credit.csv | -*InvoicesApi* | [**get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](docs/InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/credit.csv | -*InvoicesApi* | [**get_debit_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/revenue.csv | -*InvoicesApi* | [**get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](docs/InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/revenue.csv | -*InvoicesApi* | [**get_hosted_payments**](docs/InvoicesApi.md#get_hosted_payments) | **GET** /invoices/{invoiceID}/hosted-payments | -*InvoicesApi* | [**get_invoice_as_html**](docs/InvoicesApi.md#get_invoice_as_html) | **GET** /invoices/{ID}.html | -*InvoicesApi* | [**get_invoice_as_pdf**](docs/InvoicesApi.md#get_invoice_as_pdf) | **GET** /invoices/{id}.pdf | -*InvoicesApi* | [**get_invoice_by_id**](docs/InvoicesApi.md#get_invoice_by_id) | **GET** /invoices/{invoice-ID} | -*InvoicesApi* | [**get_invoice_by_id_as_csv**](docs/InvoicesApi.md#get_invoice_by_id_as_csv) | **GET** /invoices/{ID}.csv | -*InvoicesApi* | [**get_invoice_by_subscription_id**](docs/InvoicesApi.md#get_invoice_by_subscription_id) | **GET** /invoices/subscription/{subscription-ID} | -*InvoicesApi* | [**get_invoice_by_subscription_version_id**](docs/InvoicesApi.md#get_invoice_by_subscription_version_id) | **GET** /invoices/subscription/version/{subscription-version-ID} | -*InvoicesApi* | [**get_invoice_by_version_id**](docs/InvoicesApi.md#get_invoice_by_version_id) | **GET** /invoices/version/{version-ID} | -*InvoicesApi* | [**get_invoice_template**](docs/InvoicesApi.md#get_invoice_template) | **GET** /invoices/template | -*InvoicesApi* | [**get_invoices_by_account_id1**](docs/InvoicesApi.md#get_invoices_by_account_id1) | **GET** /invoices/account/{account-ID} | -*InvoicesApi* | [**get_invoices_by_period_end**](docs/InvoicesApi.md#get_invoices_by_period_end) | **GET** /invoices/period-end/{lower-threshold}/{upper-threshold} | -*InvoicesApi* | [**get_invoices_by_period_start**](docs/InvoicesApi.md#get_invoices_by_period_start) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold} | -*InvoicesApi* | [**get_invoices_by_period_start_as_csv**](docs/InvoicesApi.md#get_invoices_by_period_start_as_csv) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold}.csv | -*InvoicesApi* | [**get_invoices_by_state**](docs/InvoicesApi.md#get_invoices_by_state) | **GET** /invoices/state/{state} | -*InvoicesApi* | [**get_invoices_by_state_and_period_start**](docs/InvoicesApi.md#get_invoices_by_state_and_period_start) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold} | -*InvoicesApi* | [**get_invoices_by_state_and_period_start_as_csv**](docs/InvoicesApi.md#get_invoices_by_state_and_period_start_as_csv) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}.csv | -*InvoicesApi* | [**get_invoices_by_state_as_csv**](docs/InvoicesApi.md#get_invoices_by_state_as_csv) | **GET** /invoices/state/{state}.csv | -*InvoicesApi* | [**get_line_payments**](docs/InvoicesApi.md#get_line_payments) | **GET** /invoices/line-payments | -*InvoicesApi* | [**get_line_payments_as_csv**](docs/InvoicesApi.md#get_line_payments_as_csv) | **GET** /invoices/line-payments.csv | -*InvoicesApi* | [**get_metadata_for_invoice**](docs/InvoicesApi.md#get_metadata_for_invoice) | **GET** /invoices/{invoice-ID}/metadata | -*InvoicesApi* | [**get_refund_for_refunded_invoice**](docs/InvoicesApi.md#get_refund_for_refunded_invoice) | **GET** /invoices/{invoice-ID}/refunds | -*InvoicesApi* | [**get_refund_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/refund.csv | -*InvoicesApi* | [**get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received**](docs/InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received) | **GET** /invoices/payment-received/refund.csv | -*InvoicesApi* | [**get_revenue_attributions**](docs/InvoicesApi.md#get_revenue_attributions) | **GET** /invoices/revenue-attributions | -*InvoicesApi* | [**get_revenue_attributions_as_csv**](docs/InvoicesApi.md#get_revenue_attributions_as_csv) | **GET** /invoices/revenue-attributions.csv | -*InvoicesApi* | [**get_swagger_for_invoice**](docs/InvoicesApi.md#get_swagger_for_invoice) | **GET** /invoices/swagger-end-point/{query-string} | -*InvoicesApi* | [**import_invoice**](docs/InvoicesApi.md#import_invoice) | **POST** /invoices/import | -*InvoicesApi* | [**issue_invoice**](docs/InvoicesApi.md#issue_invoice) | **PUT** /invoices/{invoice-id}/issue | -*InvoicesApi* | [**list_original_invoice**](docs/InvoicesApi.md#list_original_invoice) | **GET** /invoices/{invoice-id}/original | -*InvoicesApi* | [**list_split_invoice**](docs/InvoicesApi.md#list_split_invoice) | **GET** /invoices/{invoice-id}/split | -*InvoicesApi* | [**recalculate_invoice**](docs/InvoicesApi.md#recalculate_invoice) | **POST** /invoices/{invoice-ID}/recalculate | -*InvoicesApi* | [**refund_invoice**](docs/InvoicesApi.md#refund_invoice) | **POST** /invoices/{invoice-id}/refund | -*InvoicesApi* | [**remove_charge_from_invoice**](docs/InvoicesApi.md#remove_charge_from_invoice) | **DELETE** /invoices/{invoice-ID}/charges/{charge-ID} | -*InvoicesApi* | [**remove_metadata_from_invoice**](docs/InvoicesApi.md#remove_metadata_from_invoice) | **DELETE** /invoices/{invoice-ID}/metadata | -*InvoicesApi* | [**set_metadata_for_invoice**](docs/InvoicesApi.md#set_metadata_for_invoice) | **POST** /invoices/{invoice-ID}/metadata | -*InvoicesApi* | [**split_invoice**](docs/InvoicesApi.md#split_invoice) | **POST** /invoices/{invoice-id}/split | -*InvoicesApi* | [**update_invoice**](docs/InvoicesApi.md#update_invoice) | **PUT** /invoices | -*InvoicesApi* | [**update_invoice_template**](docs/InvoicesApi.md#update_invoice_template) | **PUT** /invoices/template | -*InvoicesApi* | [**upsert_metadata_for_invoice**](docs/InvoicesApi.md#upsert_metadata_for_invoice) | **PUT** /invoices/{invoice-ID}/metadata | -*InvoicesApi* | [**void_invoice**](docs/InvoicesApi.md#void_invoice) | **DELETE** /invoices/{invoice-ID} | -*NotificationsApi* | [**get_all_notifications**](docs/NotificationsApi.md#get_all_notifications) | **GET** /notifications | -*NotificationsApi* | [**get_notification_by_entity_id**](docs/NotificationsApi.md#get_notification_by_entity_id) | **GET** /notifications/entity-ID/{entity-ID} | -*NotificationsApi* | [**get_notification_by_id**](docs/NotificationsApi.md#get_notification_by_id) | **GET** /notifications/{notification-ID} | -*NotificationsApi* | [**get_notifications_by_webhook_id**](docs/NotificationsApi.md#get_notifications_by_webhook_id) | **GET** /notifications/{lower-threshold}/{upper-threshold}/{webhookID} | -*NotificationsApi* | [**get_notifications_within_date_range**](docs/NotificationsApi.md#get_notifications_within_date_range) | **GET** /notifications/{lower-threshold}/{upper-threshold} | -*NotificationsApi* | [**resend_notification**](docs/NotificationsApi.md#resend_notification) | **POST** /notifications/{notification-ID}/resend | -*PaymentGatewayApi* | [**create_api_configuration**](docs/PaymentGatewayApi.md#create_api_configuration) | **POST** /configurations | -*PaymentGatewayApi* | [**get_all_api_configurations**](docs/PaymentGatewayApi.md#get_all_api_configurations) | **GET** /configurations | -*PaymentGatewayApi* | [**get_api_configurations_by_type**](docs/PaymentGatewayApi.md#get_api_configurations_by_type) | **GET** /configurations/type/{configuration-type} | -*PaymentGatewayApi* | [**public_configuration**](docs/PaymentGatewayApi.md#public_configuration) | **GET** /configurations/public | -*PaymentGatewayApi* | [**update_api_configuration**](docs/PaymentGatewayApi.md#update_api_configuration) | **PUT** /configurations | -*PaymentMethodsApi* | [**create_payment_method**](docs/PaymentMethodsApi.md#create_payment_method) | **POST** /payment-methods | -*PaymentMethodsApi* | [**delete_payment_method**](docs/PaymentMethodsApi.md#delete_payment_method) | **DELETE** /payment-methods/{payment-method-ID} | -*PaymentMethodsApi* | [**get_all_payment_methods**](docs/PaymentMethodsApi.md#get_all_payment_methods) | **GET** /payment-methods | -*PaymentMethodsApi* | [**get_mandate_pdf**](docs/PaymentMethodsApi.md#get_mandate_pdf) | **GET** /payment-methods/{payment-method-ID}/mandate.pdf | -*PaymentMethodsApi* | [**get_payment_method_by_id**](docs/PaymentMethodsApi.md#get_payment_method_by_id) | **GET** /payment-methods/{payment-method-ID} | -*PaymentMethodsApi* | [**get_payment_method_by_link_id**](docs/PaymentMethodsApi.md#get_payment_method_by_link_id) | **GET** /payment-methods/link-id/{linkID} | -*PaymentMethodsApi* | [**get_payment_method_by_payment_gateway**](docs/PaymentMethodsApi.md#get_payment_method_by_payment_gateway) | **GET** /payment-methods/gateway/{gateway} | -*PaymentMethodsApi* | [**update_payment_method**](docs/PaymentMethodsApi.md#update_payment_method) | **PUT** /payment-methods | -*PaymentMethodsApi* | [**verify_ach**](docs/PaymentMethodsApi.md#verify_ach) | **POST** /payment-methods/{payment-method-ID}/verify/micro-deposits | -*PaymentsApi* | [**create_offline_payment**](docs/PaymentsApi.md#create_offline_payment) | **POST** /payments/offline | -*PaymentsApi* | [**create_payment**](docs/PaymentsApi.md#create_payment) | **POST** /payments | -*PaymentsApi* | [**get_all_payments**](docs/PaymentsApi.md#get_all_payments) | **GET** /payments | -*PaymentsApi* | [**get_payment_as_csv**](docs/PaymentsApi.md#get_payment_as_csv) | **GET** /payments/csv | -*PaymentsApi* | [**get_payment_by_id**](docs/PaymentsApi.md#get_payment_by_id) | **GET** /payments/{payment-ID} | -*PaymentsApi* | [**get_payment_by_invoice_id**](docs/PaymentsApi.md#get_payment_by_invoice_id) | **GET** /payments/invoice/{invoice-ID} | -*PaymentsApi* | [**get_payment_by_payment_gateway**](docs/PaymentsApi.md#get_payment_by_payment_gateway) | **GET** /payments/gateway/{gateway} | -*PaymentsApi* | [**get_payment_by_payment_method_id**](docs/PaymentsApi.md#get_payment_by_payment_method_id) | **GET** /payments/payment-method/{payment-method-ID} | -*PaymentsApi* | [**refund_payment**](docs/PaymentsApi.md#refund_payment) | **POST** /payments/{payment_id}/refund | -*PaymentsApi* | [**update_payment**](docs/PaymentsApi.md#update_payment) | **PUT** /payments | -*PermissionsApi* | [**create_permission**](docs/PermissionsApi.md#create_permission) | **POST** /permissions | -*PermissionsApi* | [**get_all_permissions**](docs/PermissionsApi.md#get_all_permissions) | **GET** /permissions | -*PermissionsApi* | [**get_available_actions_for_resource**](docs/PermissionsApi.md#get_available_actions_for_resource) | **GET** /permissions/resources/{resource} | -*PermissionsApi* | [**get_available_resources**](docs/PermissionsApi.md#get_available_resources) | **GET** /permissions/resources | -*PermissionsApi* | [**get_permission_by_id**](docs/PermissionsApi.md#get_permission_by_id) | **GET** /permissions/{permission-ID} | -*PermissionsApi* | [**revoke_permission**](docs/PermissionsApi.md#revoke_permission) | **DELETE** /permissions/{permission-ID} | -*PlansApi* | [**delete**](docs/PlansApi.md#delete) | **DELETE** /plans/{path} | -*PlansApi* | [**find**](docs/PlansApi.md#find) | **GET** /plans/{path} | -*PlansApi* | [**upsert**](docs/PlansApi.md#upsert) | **PUT** /plans | -*QuotesApi* | [**get_all_quotes**](docs/QuotesApi.md#get_all_quotes) | **GET** /quotes | -*QuotesApi* | [**get_quote_by_id**](docs/QuotesApi.md#get_quote_by_id) | **GET** /quotes/{id} | -*QuotesApi* | [**quote**](docs/QuotesApi.md#quote) | **POST** /quotes | -*ReceiptsApi* | [**create_receipt**](docs/ReceiptsApi.md#create_receipt) | **POST** /receipts | -*ReceiptsApi* | [**get_all_receipts**](docs/ReceiptsApi.md#get_all_receipts) | **GET** /receipts | -*ReceiptsApi* | [**get_receipt_by_id**](docs/ReceiptsApi.md#get_receipt_by_id) | **GET** /receipts/{receipt-ID} | -*ReceiptsApi* | [**get_receipts_by_invoice**](docs/ReceiptsApi.md#get_receipts_by_invoice) | **GET** /receipts/invoice/{invoice-ID} | -*ReceiptsApi* | [**get_receipts_by_payment**](docs/ReceiptsApi.md#get_receipts_by_payment) | **GET** /receipts/payment/{payment-ID} | -*ReceiptsApi* | [**get_receipts_for_debit_payments_as_csv**](docs/ReceiptsApi.md#get_receipts_for_debit_payments_as_csv) | **GET** /receipts/debits.csv | -*ReceiptsApi* | [**get_receipts_for_refund_payments_as_csv**](docs/ReceiptsApi.md#get_receipts_for_refund_payments_as_csv) | **GET** /receipts/refunds.csv | -*ReportsApi* | [**get_accounts_overview**](docs/ReportsApi.md#get_accounts_overview) | **GET** /reports/accounts/overview.csv | -*ReportsApi* | [**get_affiliate_charge_report**](docs/ReportsApi.md#get_affiliate_charge_report) | **GET** /reports/affiliate/overview.csv | -*ReportsApi* | [**get_coupon_report**](docs/ReportsApi.md#get_coupon_report) | **GET** /reports/coupons/overview.csv | -*ReportsApi* | [**get_csv_report_invoice_line_payments_bucketed**](docs/ReportsApi.md#get_csv_report_invoice_line_payments_bucketed) | **GET** /reports/fulfilled/bucketed.csv | -*ReportsApi* | [**get_csv_report_invoice_line_payments_raw**](docs/ReportsApi.md#get_csv_report_invoice_line_payments_raw) | **GET** /reports/fulfilled/raw.csv | -*ReportsApi* | [**get_csv_report_revenue_attributions_bucketed**](docs/ReportsApi.md#get_csv_report_revenue_attributions_bucketed) | **GET** /reports/invoiced/bucketed.csv | -*ReportsApi* | [**get_csv_report_revenue_attributions_raw**](docs/ReportsApi.md#get_csv_report_revenue_attributions_raw) | **GET** /reports/invoiced/raw.csv | -*ReportsApi* | [**get_csv_revenue_schedule**](docs/ReportsApi.md#get_csv_revenue_schedule) | **GET** /reports/revenue-schedule/raw.csv | -*ReportsApi* | [**get_payment_transactions**](docs/ReportsApi.md#get_payment_transactions) | **GET** /reports/transactions/payments.csv | -*ReportsApi* | [**get_refunds_as_csv**](docs/ReportsApi.md#get_refunds_as_csv) | **GET** /refunds/csv | -*ReportsApi* | [**get_shipments_report**](docs/ReportsApi.md#get_shipments_report) | **GET** /reports/shipments/overview.csv | -*ReportsApi* | [**get_subscriptions_overview**](docs/ReportsApi.md#get_subscriptions_overview) | **GET** /reports/subscriptions/overview.csv | -*SalesforceApi* | [**change_salesforce_job_state**](docs/SalesforceApi.md#change_salesforce_job_state) | **POST** /salesforce/sync/action | -*SalesforceApi* | [**connect_to_salesforce**](docs/SalesforceApi.md#connect_to_salesforce) | **POST** /salesforce/connect | -*SalesforceApi* | [**get_all_salesforce_jobs**](docs/SalesforceApi.md#get_all_salesforce_jobs) | **GET** /salesforce/sync | -*SalesforceApi* | [**get_salesforce_configuration**](docs/SalesforceApi.md#get_salesforce_configuration) | **GET** /salesforce/configuration | -*SalesforceApi* | [**update_salesforce_configuration**](docs/SalesforceApi.md#update_salesforce_configuration) | **PUT** /salesforce/configuration | -*SecurityApi* | [**create_flexcheck_user_login**](docs/SecurityApi.md#create_flexcheck_user_login) | **POST** /users/flexcheck | -*SecurityApi* | [**create_role**](docs/SecurityApi.md#create_role) | **POST** /roles | -*SecurityApi* | [**create_user_login**](docs/SecurityApi.md#create_user_login) | **POST** /users | -*SecurityApi* | [**get_all_roles**](docs/SecurityApi.md#get_all_roles) | **GET** /roles | -*SecurityApi* | [**get_current_user**](docs/SecurityApi.md#get_current_user) | **GET** /users/mine | -*SecurityApi* | [**get_my_organizations**](docs/SecurityApi.md#get_my_organizations) | **GET** /users/mine/organizations | -*SecurityApi* | [**get_private_permanent_api_token**](docs/SecurityApi.md#get_private_permanent_api_token) | **POST** /users/generate-permanent-api-token | -*SecurityApi* | [**get_role_by_id**](docs/SecurityApi.md#get_role_by_id) | **GET** /roles/{role} | -*SecurityApi* | [**get_simple_all_users**](docs/SecurityApi.md#get_simple_all_users) | **GET** /users | -*SecurityApi* | [**get_temporary_api_tokens**](docs/SecurityApi.md#get_temporary_api_tokens) | **GET** /users/generate-tokens | -*SecurityApi* | [**get_user_by_username**](docs/SecurityApi.md#get_user_by_username) | **GET** /users/username/{email} | -*SecurityApi* | [**invite_user_login**](docs/SecurityApi.md#invite_user_login) | **POST** /users/invite | -*SecurityApi* | [**link_open_id_token_to_user**](docs/SecurityApi.md#link_open_id_token_to_user) | **POST** /users/invite/openid | -*SecurityApi* | [**refresh_permanent_api_token**](docs/SecurityApi.md#refresh_permanent_api_token) | **POST** /users/refresh-permanent-api-token | -*SecurityApi* | [**remove_permission_from_role**](docs/SecurityApi.md#remove_permission_from_role) | **DELETE** /roles/{role}/permission/{resource}/{action} | -*SecurityApi* | [**request_password_reset_code**](docs/SecurityApi.md#request_password_reset_code) | **POST** /users/password-reset/request-reset-code | -*SecurityApi* | [**revoke_role**](docs/SecurityApi.md#revoke_role) | **DELETE** /roles/{role} | -*SecurityApi* | [**update_email**](docs/SecurityApi.md#update_email) | **PUT** /users/{email}/email | -*SecurityApi* | [**update_role**](docs/SecurityApi.md#update_role) | **PUT** /roles | -*SecurityApi* | [**update_user_infos**](docs/SecurityApi.md#update_user_infos) | **PUT** /users/{email} | -*SecurityApi* | [**update_user_password**](docs/SecurityApi.md#update_user_password) | **PUT** /users/{email}/password | -*SecurityApi* | [**update_user_password_with_reset_code**](docs/SecurityApi.md#update_user_password_with_reset_code) | **POST** /users/password-reset/password-update | -*SubscriptionsApi* | [**add_charge_to_subscription**](docs/SubscriptionsApi.md#add_charge_to_subscription) | **POST** /subscriptions/{subscription-ID}/charge | -*SubscriptionsApi* | [**add_coupon_to_subscription**](docs/SubscriptionsApi.md#add_coupon_to_subscription) | **POST** /subscriptions/{subscription-ID}/coupons | -*SubscriptionsApi* | [**add_credit_note_to_subscription**](docs/SubscriptionsApi.md#add_credit_note_to_subscription) | **POST** /subscriptions/{subscription-ID}/credit | -*SubscriptionsApi* | [**add_payment_method_to_subscription**](docs/SubscriptionsApi.md#add_payment_method_to_subscription) | **POST** /subscriptions/{subscription-ID}/payment-methods | -*SubscriptionsApi* | [**advance_subscription**](docs/SubscriptionsApi.md#advance_subscription) | **POST** /subscriptions/{subscription-ID}/advance | -*SubscriptionsApi* | [**available_payment_methods_for_subscription**](docs/SubscriptionsApi.md#available_payment_methods_for_subscription) | **GET** /subscriptions/{subscription-ID}/payment-methods | -*SubscriptionsApi* | [**batch_create_subscriptions**](docs/SubscriptionsApi.md#batch_create_subscriptions) | **POST** /subscriptions/batch | -*SubscriptionsApi* | [**batch_increment_usage**](docs/SubscriptionsApi.md#batch_increment_usage) | **POST** /subscriptions/{subscriptionID}/increment-values | -*SubscriptionsApi* | [**cancel_subscription**](docs/SubscriptionsApi.md#cancel_subscription) | **POST** /subscriptions/{subscription-ID}/cancel | -*SubscriptionsApi* | [**create_aggregating_subscription**](docs/SubscriptionsApi.md#create_aggregating_subscription) | **POST** /subscriptions/aggregating | -*SubscriptionsApi* | [**create_subscription_from_request**](docs/SubscriptionsApi.md#create_subscription_from_request) | **POST** /subscriptions/create | -*SubscriptionsApi* | [**create_timer**](docs/SubscriptionsApi.md#create_timer) | **POST** /subscriptions/{subscription-ID}/timer | -*SubscriptionsApi* | [**delete_metadata_for_subscription**](docs/SubscriptionsApi.md#delete_metadata_for_subscription) | **DELETE** /subscriptions/{subscription-ID}/metadata | -*SubscriptionsApi* | [**freeze_subscription**](docs/SubscriptionsApi.md#freeze_subscription) | **POST** /subscriptions/{subscription-ID}/freeze | -*SubscriptionsApi* | [**get_affiliate1**](docs/SubscriptionsApi.md#get_affiliate1) | **GET** /subscriptions/{subscriptionID}/affiliate | -*SubscriptionsApi* | [**get_applicable_coupons_for_subscription**](docs/SubscriptionsApi.md#get_applicable_coupons_for_subscription) | **GET** /subscriptions/{subscription-ID}/applicable-coupons | -*SubscriptionsApi* | [**get_available_credit_subscription**](docs/SubscriptionsApi.md#get_available_credit_subscription) | **GET** /subscriptions/{subscription-ID}/credit | -*SubscriptionsApi* | [**get_charges_on_subscription**](docs/SubscriptionsApi.md#get_charges_on_subscription) | **GET** /subscriptions/{subscription-ID}/charges | -*SubscriptionsApi* | [**get_children_of_subscription**](docs/SubscriptionsApi.md#get_children_of_subscription) | **GET** /subscriptions/{subscription-ID}/children | -*SubscriptionsApi* | [**get_coupons_on_subscription**](docs/SubscriptionsApi.md#get_coupons_on_subscription) | **GET** /subscriptions/{subscription-ID}/coupons | -*SubscriptionsApi* | [**get_invoices_for_subscription_by_state**](docs/SubscriptionsApi.md#get_invoices_for_subscription_by_state) | **GET** /subscriptions/{subscriptionID}/invoices/{state} | -*SubscriptionsApi* | [**get_metadata_for_subscription**](docs/SubscriptionsApi.md#get_metadata_for_subscription) | **GET** /subscriptions/{subscription-ID}/metadata | -*SubscriptionsApi* | [**get_parent_subscription**](docs/SubscriptionsApi.md#get_parent_subscription) | **GET** /subscriptions/{subscription-ID}/parent | -*SubscriptionsApi* | [**get_pricing_component_values_of_subscription**](docs/SubscriptionsApi.md#get_pricing_component_values_of_subscription) | **GET** /subscriptions/{subscription-ID}/values | -*SubscriptionsApi* | [**get_subscription_by_account_id**](docs/SubscriptionsApi.md#get_subscription_by_account_id) | **GET** /subscriptions/account/{account-ID} | -*SubscriptionsApi* | [**get_subscription_by_id**](docs/SubscriptionsApi.md#get_subscription_by_id) | **GET** /subscriptions/{subscription-ID} | -*SubscriptionsApi* | [**get_subscription_by_product_id**](docs/SubscriptionsApi.md#get_subscription_by_product_id) | **GET** /subscriptions/product/{product-ID} | -*SubscriptionsApi* | [**get_subscription_by_product_rate_plan_id**](docs/SubscriptionsApi.md#get_subscription_by_product_rate_plan_id) | **GET** /subscriptions/product-rate-plan/{product-rate-plan-ID} | -*SubscriptionsApi* | [**get_subscription_by_state**](docs/SubscriptionsApi.md#get_subscription_by_state) | **GET** /subscriptions/state/{state} | -*SubscriptionsApi* | [**get_subscription_by_version_id**](docs/SubscriptionsApi.md#get_subscription_by_version_id) | **GET** /subscriptions/version/{version-ID} | -*SubscriptionsApi* | [**get_subscriptions_by_initial_period_start**](docs/SubscriptionsApi.md#get_subscriptions_by_initial_period_start) | **GET** /subscriptions/initial-period-start/{lower-threshold}/{upper-threshold} | -*SubscriptionsApi* | [**get_subscriptions_by_period_end**](docs/SubscriptionsApi.md#get_subscriptions_by_period_end) | **GET** /subscriptions/period-end/{lower-threshold}/{upper-threshold} | -*SubscriptionsApi* | [**get_subscriptions_by_period_start**](docs/SubscriptionsApi.md#get_subscriptions_by_period_start) | **GET** /subscriptions/period-start/{lower-threshold}/{upper-threshold} | -*SubscriptionsApi* | [**get_subscriptions_by_successful_periods**](docs/SubscriptionsApi.md#get_subscriptions_by_successful_periods) | **GET** /subscriptions/successful-periods/{lower-threshold}/{upper-threshold} | -*SubscriptionsApi* | [**get_swagger_subscription**](docs/SubscriptionsApi.md#get_swagger_subscription) | **GET** /subscriptions/swagger-end-point/{query-string} | -*SubscriptionsApi* | [**get_timers_for_subscription**](docs/SubscriptionsApi.md#get_timers_for_subscription) | **GET** /subscriptions/{subscription-ID}/timer | -*SubscriptionsApi* | [**import_subscription**](docs/SubscriptionsApi.md#import_subscription) | **POST** /subscriptions/import | -*SubscriptionsApi* | [**invoice_charges_on_subscription**](docs/SubscriptionsApi.md#invoice_charges_on_subscription) | **POST** /subscriptions/{subscription-ID}/invoice-charges | -*SubscriptionsApi* | [**migrate_subscription**](docs/SubscriptionsApi.md#migrate_subscription) | **POST** /subscriptions/{subscription-ID}/migrate | -*SubscriptionsApi* | [**pause_subscription**](docs/SubscriptionsApi.md#pause_subscription) | **POST** /subscriptions/{subscription-ID}/pause | -*SubscriptionsApi* | [**remove_coupon_from_subscription**](docs/SubscriptionsApi.md#remove_coupon_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/coupons/{coupon-code} | -*SubscriptionsApi* | [**remove_credit_from_subscription**](docs/SubscriptionsApi.md#remove_credit_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/credit/{value} | -*SubscriptionsApi* | [**remove_payment_method_from_subscription**](docs/SubscriptionsApi.md#remove_payment_method_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/payment-methods/{payment-method-ID} | -*SubscriptionsApi* | [**remove_pricing_component_value_change_from_subscription**](docs/SubscriptionsApi.md#remove_pricing_component_value_change_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/values/{pricing-component} | -*SubscriptionsApi* | [**resume_subscription**](docs/SubscriptionsApi.md#resume_subscription) | **POST** /subscriptions/{subscription-ID}/resume | -*SubscriptionsApi* | [**revive_subscription**](docs/SubscriptionsApi.md#revive_subscription) | **POST** /subscriptions/{subscription-ID}/revive | -*SubscriptionsApi* | [**set_affiliate1**](docs/SubscriptionsApi.md#set_affiliate1) | **POST** /subscriptions/{subscriptionID}/affiliate | -*SubscriptionsApi* | [**set_metadata_for_subscription**](docs/SubscriptionsApi.md#set_metadata_for_subscription) | **POST** /subscriptions/{subscription-ID}/metadata | -*SubscriptionsApi* | [**set_pricing_component_value_on_subscription**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription) | **POST** /subscriptions/{subscription-ID}/pricing-component-values | -*SubscriptionsApi* | [**set_pricing_component_value_on_subscription1**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription1) | **POST** /subscriptions/{subscription-ID}/values/{pricing-component} | -*SubscriptionsApi* | [**set_pricing_component_value_on_subscription_batch_update**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription_batch_update) | **POST** /subscriptions/{subscription-ID}/values | -*SubscriptionsApi* | [**start_all_subscriptions**](docs/SubscriptionsApi.md#start_all_subscriptions) | **POST** /subscriptions/{accountID}/start | -*SubscriptionsApi* | [**update_subscription_from_request**](docs/SubscriptionsApi.md#update_subscription_from_request) | **PUT** /subscriptions/update | -*SubscriptionsApi* | [**upsert_metadata_for_subscription**](docs/SubscriptionsApi.md#upsert_metadata_for_subscription) | **PUT** /subscriptions/{subscription-ID}/metadata | -*TaxesApi* | [**create_taxation_strategy**](docs/TaxesApi.md#create_taxation_strategy) | **POST** /taxation-strategies | -*TaxesApi* | [**get_all_taxation_strategies**](docs/TaxesApi.md#get_all_taxation_strategies) | **GET** /taxation-strategies | -*TaxesApi* | [**get_taxation_strategy_by_consistent_id**](docs/TaxesApi.md#get_taxation_strategy_by_consistent_id) | **GET** /taxation-strategies/{taxation-strategy-ID} | -*TaxesApi* | [**get_taxation_strategy_by_country**](docs/TaxesApi.md#get_taxation_strategy_by_country) | **GET** /taxation-strategies/country/{country} | -*TaxesApi* | [**get_taxation_strategy_by_currency**](docs/TaxesApi.md#get_taxation_strategy_by_currency) | **GET** /taxation-strategies/currency/{currency} | -*TaxesApi* | [**get_taxation_strategy_by_province**](docs/TaxesApi.md#get_taxation_strategy_by_province) | **GET** /taxation-strategies/province/{province} | -*TaxesApi* | [**get_taxation_strategy_by_version_id**](docs/TaxesApi.md#get_taxation_strategy_by_version_id) | **GET** /taxation-strategies/version/{version-ID} | -*TaxesApi* | [**retire_taxation_strategy**](docs/TaxesApi.md#retire_taxation_strategy) | **DELETE** /taxation-strategies/version/{version-ID} | -*TaxesApi* | [**update_taxation_strategy**](docs/TaxesApi.md#update_taxation_strategy) | **PUT** /taxation-strategies | -*TokenizationApi* | [**auth_capture**](docs/TokenizationApi.md#auth_capture) | **POST** /tokenization/auth-capture | -*TokenizationApi* | [**braintree_card_capture**](docs/TokenizationApi.md#braintree_card_capture) | **POST** /tokenization/braintree | -*TokenizationApi* | [**create_authorize_net_token**](docs/TokenizationApi.md#create_authorize_net_token) | **POST** /vaulted-gateways/authorize-net | -*TokenizationApi* | [**create_braintree_token**](docs/TokenizationApi.md#create_braintree_token) | **POST** /vaulted-gateways/braintree | -*TokenizationApi* | [**create_stripe_ach_token**](docs/TokenizationApi.md#create_stripe_ach_token) | **POST** /vaulted-gateways/stripe-ACH | -*TokenizationApi* | [**create_stripe_token**](docs/TokenizationApi.md#create_stripe_token) | **POST** /vaulted-gateways/stripe | -*TokenizationApi* | [**create_trust_commerce_token**](docs/TokenizationApi.md#create_trust_commerce_token) | **POST** /vaulted-gateways/trustCommerce | -*TokenizationApi* | [**display_card_capture_form**](docs/TokenizationApi.md#display_card_capture_form) | **GET** /tokenization/card-capture-form | -*TokenizationApi* | [**epx_card_capture**](docs/TokenizationApi.md#epx_card_capture) | **POST** /tokenization/epx | -*TokenizationApi* | [**epx_pre_auth**](docs/TokenizationApi.md#epx_pre_auth) | **POST** /tokenization/epx-pre-auth | -*TokenizationApi* | [**epx_pre_auth_response**](docs/TokenizationApi.md#epx_pre_auth_response) | **POST** /tokenization/epx-redirect | -*TokenizationApi* | [**expire_email_redirect_capture**](docs/TokenizationApi.md#expire_email_redirect_capture) | **DELETE** /tokenization/email-redirect/{id} | -*TokenizationApi* | [**get_all_email_redirect_capture**](docs/TokenizationApi.md#get_all_email_redirect_capture) | **GET** /tokenization/email-redirect | -*TokenizationApi* | [**get_braintree_by_account_id**](docs/TokenizationApi.md#get_braintree_by_account_id) | **GET** /vaulted-gateways/braintree/{accountID} | -*TokenizationApi* | [**get_by_card_details_id**](docs/TokenizationApi.md#get_by_card_details_id) | **GET** /vaulted-gateways/stripe/card-details-id/{cardDetailsID} | -*TokenizationApi* | [**get_email_redirect_capture**](docs/TokenizationApi.md#get_email_redirect_capture) | **GET** /tokenization/email-redirect/{id} | -*TokenizationApi* | [**get_email_redirect_capture_invoice_html**](docs/TokenizationApi.md#get_email_redirect_capture_invoice_html) | **GET** /tokenization/email-redirect/{id}/invoice.html | -*TokenizationApi* | [**get_stripe_ach**](docs/TokenizationApi.md#get_stripe_ach) | **GET** /vaulted-gateways/stripe-ACH/{stripeACHTokenID} | -*TokenizationApi* | [**get_stripe_token**](docs/TokenizationApi.md#get_stripe_token) | **GET** /vaulted-gateways/stripe/{stripeTokenID} | -*TokenizationApi* | [**go_cardless_bank_account_capture**](docs/TokenizationApi.md#go_cardless_bank_account_capture) | **POST** /tokenization/direct-debit | -*TokenizationApi* | [**pay_vision_shout_v1**](docs/TokenizationApi.md#pay_vision_shout_v1) | **POST** /tokenization/payvision-shout-v1 | -*TokenizationApi* | [**pre_auth**](docs/TokenizationApi.md#pre_auth) | **POST** /tokenization/pre-auth | -*TokenizationApi* | [**sage_pay_notify_v300**](docs/TokenizationApi.md#sage_pay_notify_v300) | **POST** /tokenization/sagepay-notify-v3-00 | -*TokenizationApi* | [**sage_pay_shout_v300**](docs/TokenizationApi.md#sage_pay_shout_v300) | **GET** /tokenization/sagepay-shout-v3-00 | -*TokenizationApi* | [**send_email_redirect_capture**](docs/TokenizationApi.md#send_email_redirect_capture) | **POST** /tokenization/email-redirect/{id}/send | -*TokenizationApi* | [**start_email_redirect_capture**](docs/TokenizationApi.md#start_email_redirect_capture) | **POST** /tokenization/email-redirect | -*TokenizationApi* | [**stripe_ach_bank_account_capture**](docs/TokenizationApi.md#stripe_ach_bank_account_capture) | **POST** /tokenization/ach | -*TokenizationApi* | [**stripe_web_hook**](docs/TokenizationApi.md#stripe_web_hook) | **POST** /vaulted-gateways/stripe/webhook | -*TokenizationApi* | [**update_email_redirect_capture**](docs/TokenizationApi.md#update_email_redirect_capture) | **PUT** /tokenization/email-redirect/{id} | -*TokenizationApi* | [**update_profile_with_token**](docs/TokenizationApi.md#update_profile_with_token) | **PUT** /tokenization/profile | -*TokenizationApi* | [**update_stripe_ach_token**](docs/TokenizationApi.md#update_stripe_ach_token) | **PUT** /vaulted-gateways/stripe-ACH | -*TokenizationApi* | [**update_stripe_token**](docs/TokenizationApi.md#update_stripe_token) | **PUT** /vaulted-gateways/stripe | -*TokenizationApi* | [**zooz_card_capture**](docs/TokenizationApi.md#zooz_card_capture) | **POST** /tokenization/zooz | -*TokenizationApi* | [**zooz_web_hook**](docs/TokenizationApi.md#zooz_web_hook) | **POST** /vaulted-gateways/zooz/webhook | -*WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | -*WebhooksApi* | [**create_webhook_v2**](docs/WebhooksApi.md#create_webhook_v2) | **POST** /webhooks/create | -*WebhooksApi* | [**get_all_webhooks**](docs/WebhooksApi.md#get_all_webhooks) | **GET** /webhooks | -*WebhooksApi* | [**get_allowed_webhook_subscriptions**](docs/WebhooksApi.md#get_allowed_webhook_subscriptions) | **GET** /webhooks/allowed-subscriptions | -*WebhooksApi* | [**get_webhook_by_id**](docs/WebhooksApi.md#get_webhook_by_id) | **GET** /webhooks/{webhook-ID} | -*WebhooksApi* | [**retire_webhook**](docs/WebhooksApi.md#retire_webhook) | **DELETE** /webhooks/{webhook-ID} | -*WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /webhooks | -*WebhooksApi* | [**verify_webhook**](docs/WebhooksApi.md#verify_webhook) | **GET** /webhooks/verify/{verification-ID} | -*DefaultApi* | [**create_totp_secret**](docs/DefaultApi.md#create_totp_secret) | **POST** /2fa/totp | -*DefaultApi* | [**enable2fa**](docs/DefaultApi.md#enable2fa) | **POST** /2fa/enable | -*DefaultApi* | [**get_qr_code**](docs/DefaultApi.md#get_qr_code) | **GET** /barcode/qr/acc/{accountId} | +*AccountsApi* | [**add_charge_to_account**](docs/AccountsApi.md#add_charge_to_account) | **POST** /accounts/{account-ID}/invoice | +*AccountsApi* | [**add_credit_note_to_account**](docs/AccountsApi.md#add_credit_note_to_account) | **POST** /accounts/{account-ID}/credit | +*AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /accounts | +*AccountsApi* | [**create_address**](docs/AccountsApi.md#create_address) | **POST** /addresses | +*AccountsApi* | [**delete_account**](docs/AccountsApi.md#delete_account) | **DELETE** /accounts/{account-ID} | +*AccountsApi* | [**delete_metadata_for_account**](docs/AccountsApi.md#delete_metadata_for_account) | **DELETE** /accounts/{account-ID}/metadata | +*AccountsApi* | [**get_account_by_id**](docs/AccountsApi.md#get_account_by_id) | **GET** /accounts/{account-ID} | +*AccountsApi* | [**get_all_accounts**](docs/AccountsApi.md#get_all_accounts) | **GET** /accounts | +*AccountsApi* | [**get_available_credit_on_account**](docs/AccountsApi.md#get_available_credit_on_account) | **GET** /accounts/{account-ID}/credit | +*AccountsApi* | [**get_invoices_by_account_id**](docs/AccountsApi.md#get_invoices_by_account_id) | **GET** /accounts/{account-ID}/invoices | +*AccountsApi* | [**get_metadata_for_account**](docs/AccountsApi.md#get_metadata_for_account) | **GET** /accounts/{account-ID}/metadata | +*AccountsApi* | [**get_payment_method_by_account_id**](docs/AccountsApi.md#get_payment_method_by_account_id) | **GET** /accounts/{account-ID}/payment-methods | +*AccountsApi* | [**get_subscription_charges**](docs/AccountsApi.md#get_subscription_charges) | **GET** /accounts/{account-ID}/charges | +*AccountsApi* | [**halt_aggregation**](docs/AccountsApi.md#halt_aggregation) | **POST** /accounts/{account-ID}/halt-aggregation | +*AccountsApi* | [**remove_credit_from_account2**](docs/AccountsApi.md#remove_credit_from_account2) | **DELETE** /accounts/{account-ID}/credit | +*AccountsApi* | [**set_metadata_for_account**](docs/AccountsApi.md#set_metadata_for_account) | **POST** /accounts/{account-ID}/metadata | +*AccountsApi* | [**update_account**](docs/AccountsApi.md#update_account) | **PUT** /accounts | +*AccountsApi* | [**update_address**](docs/AccountsApi.md#update_address) | **PUT** /addresses | +*AccountsApi* | [**upsert_metadata_for_account**](docs/AccountsApi.md#upsert_metadata_for_account) | **PUT** /accounts/{account-ID}/metadata | +*AffiliationApi* | [**create_invoice**](docs/AffiliationApi.md#create_invoice) | **POST** /affiliate/{account-id}/invoice | +*AffiliationApi* | [**get_affiliate**](docs/AffiliationApi.md#get_affiliate) | **GET** /product-rate-plans/{productRatePlanID}/affiliate | +*AffiliationApi* | [**get_affiliate1**](docs/AffiliationApi.md#get_affiliate1) | **GET** /subscriptions/{subscriptionID}/affiliate | +*AffiliationApi* | [**quote_invoice**](docs/AffiliationApi.md#quote_invoice) | **GET** /affiliate/{account-id}/quote/invoice/{invoice-id} | +*AffiliationApi* | [**quote_subscription**](docs/AffiliationApi.md#quote_subscription) | **GET** /affiliate/{account-id}/quote/subscription/{subscription-id} | +*AffiliationApi* | [**set_affiliate**](docs/AffiliationApi.md#set_affiliate) | **POST** /product-rate-plans/{product-rate-plan-ID}/affiliate | +*AffiliationApi* | [**set_affiliate1**](docs/AffiliationApi.md#set_affiliate1) | **POST** /subscriptions/{subscriptionID}/affiliate | +*AffiliationApi* | [**update_affiliate**](docs/AffiliationApi.md#update_affiliate) | **PUT** /product-rate-plans/{product-rate-plan-ID}/affiliate | +*AvataxApi* | [**create_avatax_configuration**](docs/AvataxApi.md#create_avatax_configuration) | **POST** /tax/avatax | +*AvataxApi* | [**get_avatax_configuration**](docs/AvataxApi.md#get_avatax_configuration) | **GET** /tax/avatax | +*AvataxApi* | [**ping**](docs/AvataxApi.md#ping) | **POST** /tax/avatax/ping | +*AvataxApi* | [**update_avatax_configuration**](docs/AvataxApi.md#update_avatax_configuration) | **PUT** /tax/avatax/{avatax-config-ID} | +*CardConnectApi* | [**delete_configuration**](docs/CardConnectApi.md#delete_configuration) | **DELETE** /cardconnect | +*CardConnectApi* | [**get_configuration**](docs/CardConnectApi.md#get_configuration) | **GET** /cardconnect | +*CardConnectApi* | [**upsert_configuration**](docs/CardConnectApi.md#upsert_configuration) | **POST** /cardconnect | +*ChargesApi* | [**batch_recalculate_subscription_charge**](docs/ChargesApi.md#batch_recalculate_subscription_charge) | **POST** /charges/recalculate | +*ChargesApi* | [**get_all_subscription_charges**](docs/ChargesApi.md#get_all_subscription_charges) | **GET** /charges | +*ChargesApi* | [**get_subscription_charge_by_id**](docs/ChargesApi.md#get_subscription_charge_by_id) | **GET** /charges/{charge-id} | +*ChargesApi* | [**recalculate_subscription_charge**](docs/ChargesApi.md#recalculate_subscription_charge) | **POST** /charges/{charge-ID}/recalculate | +*ChargesApi* | [**void_subscription_charge**](docs/ChargesApi.md#void_subscription_charge) | **DELETE** /charges/{charge-id} | +*CheckoutApi* | [**build_subscription_checkout**](docs/CheckoutApi.md#build_subscription_checkout) | **GET** /public/checkouts/subscriptions/{checkout-definition-path} | +*CheckoutApi* | [**create_account1**](docs/CheckoutApi.md#create_account1) | **POST** /public/accounts | +*CheckoutApi* | [**create_subscription_checkout_definition**](docs/CheckoutApi.md#create_subscription_checkout_definition) | **POST** /checkouts/subscriptions | +*CheckoutApi* | [**get_subscription_checkout_definition**](docs/CheckoutApi.md#get_subscription_checkout_definition) | **GET** /checkouts/subscriptions/{checkout-definition-path} | +*CheckoutApi* | [**subscription_checkout**](docs/CheckoutApi.md#subscription_checkout) | **POST** /public/checkouts/subscriptions | +*ContractsApi* | [**add_contract_period**](docs/ContractsApi.md#add_contract_period) | **POST** /contracts/{contract}/period | +*ContractsApi* | [**create_contract**](docs/ContractsApi.md#create_contract) | **POST** /contracts | +*ContractsApi* | [**get_all_contracts**](docs/ContractsApi.md#get_all_contracts) | **GET** /contracts | +*ContractsApi* | [**get_contract_by_id**](docs/ContractsApi.md#get_contract_by_id) | **GET** /contracts/{contract} | +*ContractsApi* | [**start_contract**](docs/ContractsApi.md#start_contract) | **POST** /contracts/{contract}/start | +*ContractsApi* | [**update_contract**](docs/ContractsApi.md#update_contract) | **PUT** /contracts | +*ContractsApi* | [**void_contract**](docs/ContractsApi.md#void_contract) | **DELETE** /contracts/{contract} | +*ContractsApi* | [**void_final_contract_period**](docs/ContractsApi.md#void_final_contract_period) | **DELETE** /contracts/{contract}/period | +*CouponsApi* | [**create_coupon**](docs/CouponsApi.md#create_coupon) | **POST** /coupons | +*CouponsApi* | [**create_coupon_unique_codes**](docs/CouponsApi.md#create_coupon_unique_codes) | **POST** /coupons/{code}/codes | +*CouponsApi* | [**get_all_coupons**](docs/CouponsApi.md#get_all_coupons) | **GET** /coupons | +*CouponsApi* | [**get_applied_coupons**](docs/CouponsApi.md#get_applied_coupons) | **GET** /coupons/{code}/applied | +*CouponsApi* | [**get_available_coupon_codes_for_code**](docs/CouponsApi.md#get_available_coupon_codes_for_code) | **GET** /coupons/{code}/codes | +*CouponsApi* | [**get_available_coupon_codes_for_code_as_csv**](docs/CouponsApi.md#get_available_coupon_codes_for_code_as_csv) | **GET** /coupons/{code}/codes.csv | +*CouponsApi* | [**get_coupon_code**](docs/CouponsApi.md#get_coupon_code) | **GET** /coupons/{code} | +*CouponsApi* | [**get_plans_for_coupon**](docs/CouponsApi.md#get_plans_for_coupon) | **GET** /coupons/{code}/plans | +*CouponsApi* | [**get_subscription_applications_of_coupons**](docs/CouponsApi.md#get_subscription_applications_of_coupons) | **GET** /coupons/{code}/subscriptions | +*CouponsApi* | [**retire_coupon**](docs/CouponsApi.md#retire_coupon) | **DELETE** /coupons/{code} | +*DunningApi* | [**create_dunning_line**](docs/DunningApi.md#create_dunning_line) | **POST** /dunning-lines | +*DunningApi* | [**get_all_dunning_lines**](docs/DunningApi.md#get_all_dunning_lines) | **GET** /dunning-lines | +*DunningApi* | [**get_dunning_line_by_attempt_index**](docs/DunningApi.md#get_dunning_line_by_attempt_index) | **GET** /dunning-lines/attempt-index/{index} | +*DunningApi* | [**get_dunning_line_by_id**](docs/DunningApi.md#get_dunning_line_by_id) | **GET** /dunning-lines/{dunning-line-ID} | +*DunningApi* | [**retire_dunning_line**](docs/DunningApi.md#retire_dunning_line) | **DELETE** /dunning-lines/{dunning-line-ID} | +*DunningApi* | [**update_dunning_line**](docs/DunningApi.md#update_dunning_line) | **PUT** /dunning-lines | +*EBANXApi* | [**delete_configuration1**](docs/EBANXApi.md#delete_configuration1) | **DELETE** /ebanx | +*EBANXApi* | [**get_configuration1**](docs/EBANXApi.md#get_configuration1) | **GET** /ebanx | +*EBANXApi* | [**handle_webhook**](docs/EBANXApi.md#handle_webhook) | **POST** /ebanx/webhook/{organization_id} | +*EBANXApi* | [**upsert_configuration1**](docs/EBANXApi.md#upsert_configuration1) | **POST** /ebanx | +*InvoicesApi* | [**add_charge_to_invoice**](docs/InvoicesApi.md#add_charge_to_invoice) | **POST** /invoices/{invoice-ID}/charges | +*InvoicesApi* | [**execute_invoice**](docs/InvoicesApi.md#execute_invoice) | **POST** /invoices/{invoice-ID}/execute | +*InvoicesApi* | [**get_all_invoices**](docs/InvoicesApi.md#get_all_invoices) | **GET** /invoices | +*InvoicesApi* | [**get_all_invoices_as_csv**](docs/InvoicesApi.md#get_all_invoices_as_csv) | **GET** /invoices/all.csv | +*InvoicesApi* | [**get_bucketed_revenue_attributions_as_csv**](docs/InvoicesApi.md#get_bucketed_revenue_attributions_as_csv) | **GET** /invoices/bucketed-revenue-attributions.csv | +*InvoicesApi* | [**get_charges_on_invoice**](docs/InvoicesApi.md#get_charges_on_invoice) | **GET** /invoices/{invoice-ID}/charges | +*InvoicesApi* | [**get_credit_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/credit.csv | +*InvoicesApi* | [**get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](docs/InvoicesApi.md#get_credit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/credit.csv | +*InvoicesApi* | [**get_debit_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/revenue.csv | +*InvoicesApi* | [**get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received**](docs/InvoicesApi.md#get_debit_invoice_line_payments_from_invoices_as_csv_by_payment_received) | **GET** /invoices/payment-received/revenue.csv | +*InvoicesApi* | [**get_hosted_payments**](docs/InvoicesApi.md#get_hosted_payments) | **GET** /invoices/{invoiceID}/hosted-payments | +*InvoicesApi* | [**get_invoice_as_html**](docs/InvoicesApi.md#get_invoice_as_html) | **GET** /invoices/{ID}.html | +*InvoicesApi* | [**get_invoice_as_pdf**](docs/InvoicesApi.md#get_invoice_as_pdf) | **GET** /invoices/{id}.pdf | +*InvoicesApi* | [**get_invoice_by_id**](docs/InvoicesApi.md#get_invoice_by_id) | **GET** /invoices/{invoice-ID} | +*InvoicesApi* | [**get_invoice_by_id_as_csv**](docs/InvoicesApi.md#get_invoice_by_id_as_csv) | **GET** /invoices/{ID}.csv | +*InvoicesApi* | [**get_invoice_by_subscription_id**](docs/InvoicesApi.md#get_invoice_by_subscription_id) | **GET** /invoices/subscription/{subscription-ID} | +*InvoicesApi* | [**get_invoice_by_subscription_version_id**](docs/InvoicesApi.md#get_invoice_by_subscription_version_id) | **GET** /invoices/subscription/version/{subscription-version-ID} | +*InvoicesApi* | [**get_invoice_by_version_id**](docs/InvoicesApi.md#get_invoice_by_version_id) | **GET** /invoices/version/{version-ID} | +*InvoicesApi* | [**get_invoice_template**](docs/InvoicesApi.md#get_invoice_template) | **GET** /invoices/template | +*InvoicesApi* | [**get_invoices_by_account_id1**](docs/InvoicesApi.md#get_invoices_by_account_id1) | **GET** /invoices/account/{account-ID} | +*InvoicesApi* | [**get_invoices_by_period_end**](docs/InvoicesApi.md#get_invoices_by_period_end) | **GET** /invoices/period-end/{lower-threshold}/{upper-threshold} | +*InvoicesApi* | [**get_invoices_by_period_start**](docs/InvoicesApi.md#get_invoices_by_period_start) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold} | +*InvoicesApi* | [**get_invoices_by_period_start_as_csv**](docs/InvoicesApi.md#get_invoices_by_period_start_as_csv) | **GET** /invoices/period-start/{lower-threshold}/{upper-threshold}.csv | +*InvoicesApi* | [**get_invoices_by_state**](docs/InvoicesApi.md#get_invoices_by_state) | **GET** /invoices/state/{state} | +*InvoicesApi* | [**get_invoices_by_state_and_period_start**](docs/InvoicesApi.md#get_invoices_by_state_and_period_start) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold} | +*InvoicesApi* | [**get_invoices_by_state_and_period_start_as_csv**](docs/InvoicesApi.md#get_invoices_by_state_and_period_start_as_csv) | **GET** /invoices/state/{state}/period-start/{lower-threshold}/{upper-threshold}.csv | +*InvoicesApi* | [**get_invoices_by_state_as_csv**](docs/InvoicesApi.md#get_invoices_by_state_as_csv) | **GET** /invoices/state/{state}.csv | +*InvoicesApi* | [**get_line_payments**](docs/InvoicesApi.md#get_line_payments) | **GET** /invoices/line-payments | +*InvoicesApi* | [**get_line_payments_as_csv**](docs/InvoicesApi.md#get_line_payments_as_csv) | **GET** /invoices/line-payments.csv | +*InvoicesApi* | [**get_metadata_for_invoice**](docs/InvoicesApi.md#get_metadata_for_invoice) | **GET** /invoices/{invoice-ID}/metadata | +*InvoicesApi* | [**get_refund_for_refunded_invoice**](docs/InvoicesApi.md#get_refund_for_refunded_invoice) | **GET** /invoices/{invoice-ID}/refunds | +*InvoicesApi* | [**get_refund_invoice_line_payments_from_invoices_as_csv**](docs/InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv) | **GET** /invoices/refund.csv | +*InvoicesApi* | [**get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received**](docs/InvoicesApi.md#get_refund_invoice_line_payments_from_invoices_as_csv_by_refund_received) | **GET** /invoices/payment-received/refund.csv | +*InvoicesApi* | [**get_revenue_attributions**](docs/InvoicesApi.md#get_revenue_attributions) | **GET** /invoices/revenue-attributions | +*InvoicesApi* | [**get_revenue_attributions_as_csv**](docs/InvoicesApi.md#get_revenue_attributions_as_csv) | **GET** /invoices/revenue-attributions.csv | +*InvoicesApi* | [**get_swagger_for_invoice**](docs/InvoicesApi.md#get_swagger_for_invoice) | **GET** /invoices/swagger-end-point/{query-string} | +*InvoicesApi* | [**import_invoice**](docs/InvoicesApi.md#import_invoice) | **POST** /invoices/import | +*InvoicesApi* | [**issue_invoice**](docs/InvoicesApi.md#issue_invoice) | **PUT** /invoices/{invoice-id}/issue | +*InvoicesApi* | [**list_original_invoice**](docs/InvoicesApi.md#list_original_invoice) | **GET** /invoices/{invoice-id}/original | +*InvoicesApi* | [**list_split_invoice**](docs/InvoicesApi.md#list_split_invoice) | **GET** /invoices/{invoice-id}/split | +*InvoicesApi* | [**recalculate_invoice**](docs/InvoicesApi.md#recalculate_invoice) | **POST** /invoices/{invoice-ID}/recalculate | +*InvoicesApi* | [**refund_invoice**](docs/InvoicesApi.md#refund_invoice) | **POST** /invoices/{invoice-id}/refund | +*InvoicesApi* | [**remove_charge_from_invoice**](docs/InvoicesApi.md#remove_charge_from_invoice) | **DELETE** /invoices/{invoice-ID}/charges/{charge-ID} | +*InvoicesApi* | [**remove_metadata_from_invoice**](docs/InvoicesApi.md#remove_metadata_from_invoice) | **DELETE** /invoices/{invoice-ID}/metadata | +*InvoicesApi* | [**set_metadata_for_invoice**](docs/InvoicesApi.md#set_metadata_for_invoice) | **POST** /invoices/{invoice-ID}/metadata | +*InvoicesApi* | [**split_invoice**](docs/InvoicesApi.md#split_invoice) | **POST** /invoices/{invoice-id}/split | +*InvoicesApi* | [**update_invoice**](docs/InvoicesApi.md#update_invoice) | **PUT** /invoices | +*InvoicesApi* | [**update_invoice_template**](docs/InvoicesApi.md#update_invoice_template) | **PUT** /invoices/template | +*InvoicesApi* | [**upsert_metadata_for_invoice**](docs/InvoicesApi.md#upsert_metadata_for_invoice) | **PUT** /invoices/{invoice-ID}/metadata | +*InvoicesApi* | [**void_invoice**](docs/InvoicesApi.md#void_invoice) | **DELETE** /invoices/{invoice-ID} | +*NotificationsApi* | [**get_all_notifications**](docs/NotificationsApi.md#get_all_notifications) | **GET** /notifications | +*NotificationsApi* | [**get_notification_by_entity_id**](docs/NotificationsApi.md#get_notification_by_entity_id) | **GET** /notifications/entity-ID/{entity-ID} | +*NotificationsApi* | [**get_notification_by_id**](docs/NotificationsApi.md#get_notification_by_id) | **GET** /notifications/{notification-ID} | +*NotificationsApi* | [**get_notifications_by_webhook_id**](docs/NotificationsApi.md#get_notifications_by_webhook_id) | **GET** /notifications/{lower-threshold}/{upper-threshold}/{webhookID} | +*NotificationsApi* | [**get_notifications_within_date_range**](docs/NotificationsApi.md#get_notifications_within_date_range) | **GET** /notifications/{lower-threshold}/{upper-threshold} | +*NotificationsApi* | [**resend_notification**](docs/NotificationsApi.md#resend_notification) | **POST** /notifications/{notification-ID}/resend | +*PaymentGatewayApi* | [**create_api_configuration**](docs/PaymentGatewayApi.md#create_api_configuration) | **POST** /configurations | +*PaymentGatewayApi* | [**get_all_api_configurations**](docs/PaymentGatewayApi.md#get_all_api_configurations) | **GET** /configurations | +*PaymentGatewayApi* | [**get_api_configurations_by_type**](docs/PaymentGatewayApi.md#get_api_configurations_by_type) | **GET** /configurations/type/{configuration-type} | +*PaymentGatewayApi* | [**public_configuration**](docs/PaymentGatewayApi.md#public_configuration) | **GET** /configurations/public | +*PaymentGatewayApi* | [**update_api_configuration**](docs/PaymentGatewayApi.md#update_api_configuration) | **PUT** /configurations | +*PaymentMethodsApi* | [**create_payment_method**](docs/PaymentMethodsApi.md#create_payment_method) | **POST** /payment-methods | +*PaymentMethodsApi* | [**delete_payment_method**](docs/PaymentMethodsApi.md#delete_payment_method) | **DELETE** /payment-methods/{payment-method-ID} | +*PaymentMethodsApi* | [**get_all_payment_methods**](docs/PaymentMethodsApi.md#get_all_payment_methods) | **GET** /payment-methods | +*PaymentMethodsApi* | [**get_mandate_pdf**](docs/PaymentMethodsApi.md#get_mandate_pdf) | **GET** /payment-methods/{payment-method-ID}/mandate.pdf | +*PaymentMethodsApi* | [**get_payment_method_by_id**](docs/PaymentMethodsApi.md#get_payment_method_by_id) | **GET** /payment-methods/{payment-method-ID} | +*PaymentMethodsApi* | [**get_payment_method_by_link_id**](docs/PaymentMethodsApi.md#get_payment_method_by_link_id) | **GET** /payment-methods/link-id/{linkID} | +*PaymentMethodsApi* | [**get_payment_method_by_payment_gateway**](docs/PaymentMethodsApi.md#get_payment_method_by_payment_gateway) | **GET** /payment-methods/gateway/{gateway} | +*PaymentMethodsApi* | [**update_payment_method**](docs/PaymentMethodsApi.md#update_payment_method) | **PUT** /payment-methods | +*PaymentMethodsApi* | [**verify_ach**](docs/PaymentMethodsApi.md#verify_ach) | **POST** /payment-methods/{payment-method-ID}/verify/micro-deposits | +*PaymentsApi* | [**create_offline_payment**](docs/PaymentsApi.md#create_offline_payment) | **POST** /payments/offline | +*PaymentsApi* | [**create_payment**](docs/PaymentsApi.md#create_payment) | **POST** /payments | +*PaymentsApi* | [**get_all_payments**](docs/PaymentsApi.md#get_all_payments) | **GET** /payments | +*PaymentsApi* | [**get_payment_as_csv**](docs/PaymentsApi.md#get_payment_as_csv) | **GET** /payments/csv | +*PaymentsApi* | [**get_payment_by_id**](docs/PaymentsApi.md#get_payment_by_id) | **GET** /payments/{payment-ID} | +*PaymentsApi* | [**get_payment_by_invoice_id**](docs/PaymentsApi.md#get_payment_by_invoice_id) | **GET** /payments/invoice/{invoice-ID} | +*PaymentsApi* | [**get_payment_by_payment_gateway**](docs/PaymentsApi.md#get_payment_by_payment_gateway) | **GET** /payments/gateway/{gateway} | +*PaymentsApi* | [**get_payment_by_payment_method_id**](docs/PaymentsApi.md#get_payment_by_payment_method_id) | **GET** /payments/payment-method/{payment-method-ID} | +*PaymentsApi* | [**refund_payment**](docs/PaymentsApi.md#refund_payment) | **POST** /payments/{payment_id}/refund | +*PaymentsApi* | [**update_payment**](docs/PaymentsApi.md#update_payment) | **PUT** /payments | +*PermissionsApi* | [**create_permission**](docs/PermissionsApi.md#create_permission) | **POST** /permissions | +*PermissionsApi* | [**get_all_permissions**](docs/PermissionsApi.md#get_all_permissions) | **GET** /permissions | +*PermissionsApi* | [**get_available_actions_for_resource**](docs/PermissionsApi.md#get_available_actions_for_resource) | **GET** /permissions/resources/{resource} | +*PermissionsApi* | [**get_available_resources**](docs/PermissionsApi.md#get_available_resources) | **GET** /permissions/resources | +*PermissionsApi* | [**get_permission_by_id**](docs/PermissionsApi.md#get_permission_by_id) | **GET** /permissions/{permission-ID} | +*PermissionsApi* | [**revoke_permission**](docs/PermissionsApi.md#revoke_permission) | **DELETE** /permissions/{permission-ID} | +*PlansApi* | [**delete**](docs/PlansApi.md#delete) | **DELETE** /plans/{path} | +*PlansApi* | [**find**](docs/PlansApi.md#find) | **GET** /plans/{path} | +*PlansApi* | [**upsert**](docs/PlansApi.md#upsert) | **PUT** /plans | +*QuotesApi* | [**get_all_quotes**](docs/QuotesApi.md#get_all_quotes) | **GET** /quotes | +*QuotesApi* | [**get_quote_by_id**](docs/QuotesApi.md#get_quote_by_id) | **GET** /quotes/{id} | +*QuotesApi* | [**quote**](docs/QuotesApi.md#quote) | **POST** /quotes | +*ReceiptsApi* | [**create_receipt**](docs/ReceiptsApi.md#create_receipt) | **POST** /receipts | +*ReceiptsApi* | [**get_all_receipts**](docs/ReceiptsApi.md#get_all_receipts) | **GET** /receipts | +*ReceiptsApi* | [**get_receipt_by_id**](docs/ReceiptsApi.md#get_receipt_by_id) | **GET** /receipts/{receipt-ID} | +*ReceiptsApi* | [**get_receipts_by_invoice**](docs/ReceiptsApi.md#get_receipts_by_invoice) | **GET** /receipts/invoice/{invoice-ID} | +*ReceiptsApi* | [**get_receipts_by_payment**](docs/ReceiptsApi.md#get_receipts_by_payment) | **GET** /receipts/payment/{payment-ID} | +*ReceiptsApi* | [**get_receipts_for_debit_payments_as_csv**](docs/ReceiptsApi.md#get_receipts_for_debit_payments_as_csv) | **GET** /receipts/debits.csv | +*ReceiptsApi* | [**get_receipts_for_refund_payments_as_csv**](docs/ReceiptsApi.md#get_receipts_for_refund_payments_as_csv) | **GET** /receipts/refunds.csv | +*ReportsApi* | [**get_accounts_overview**](docs/ReportsApi.md#get_accounts_overview) | **GET** /reports/accounts/overview.csv | +*ReportsApi* | [**get_affiliate_charge_report**](docs/ReportsApi.md#get_affiliate_charge_report) | **GET** /reports/affiliate/overview.csv | +*ReportsApi* | [**get_coupon_report**](docs/ReportsApi.md#get_coupon_report) | **GET** /reports/coupons/overview.csv | +*ReportsApi* | [**get_csv_report_invoice_line_payments_bucketed**](docs/ReportsApi.md#get_csv_report_invoice_line_payments_bucketed) | **GET** /reports/fulfilled/bucketed.csv | +*ReportsApi* | [**get_csv_report_invoice_line_payments_raw**](docs/ReportsApi.md#get_csv_report_invoice_line_payments_raw) | **GET** /reports/fulfilled/raw.csv | +*ReportsApi* | [**get_csv_report_revenue_attributions_bucketed**](docs/ReportsApi.md#get_csv_report_revenue_attributions_bucketed) | **GET** /reports/invoiced/bucketed.csv | +*ReportsApi* | [**get_csv_report_revenue_attributions_raw**](docs/ReportsApi.md#get_csv_report_revenue_attributions_raw) | **GET** /reports/invoiced/raw.csv | +*ReportsApi* | [**get_csv_revenue_schedule**](docs/ReportsApi.md#get_csv_revenue_schedule) | **GET** /reports/revenue-schedule/raw.csv | +*ReportsApi* | [**get_payment_transactions**](docs/ReportsApi.md#get_payment_transactions) | **GET** /reports/transactions/payments.csv | +*ReportsApi* | [**get_refunds_as_csv**](docs/ReportsApi.md#get_refunds_as_csv) | **GET** /refunds/csv | +*ReportsApi* | [**get_shipments_report**](docs/ReportsApi.md#get_shipments_report) | **GET** /reports/shipments/overview.csv | +*ReportsApi* | [**get_subscriptions_overview**](docs/ReportsApi.md#get_subscriptions_overview) | **GET** /reports/subscriptions/overview.csv | +*SalesforceApi* | [**change_salesforce_job_state**](docs/SalesforceApi.md#change_salesforce_job_state) | **POST** /salesforce/sync/action | +*SalesforceApi* | [**connect_to_salesforce**](docs/SalesforceApi.md#connect_to_salesforce) | **POST** /salesforce/connect | +*SalesforceApi* | [**get_all_salesforce_jobs**](docs/SalesforceApi.md#get_all_salesforce_jobs) | **GET** /salesforce/sync | +*SalesforceApi* | [**get_salesforce_configuration**](docs/SalesforceApi.md#get_salesforce_configuration) | **GET** /salesforce/configuration | +*SalesforceApi* | [**update_salesforce_configuration**](docs/SalesforceApi.md#update_salesforce_configuration) | **PUT** /salesforce/configuration | +*SecurityApi* | [**create_flexcheck_user_login**](docs/SecurityApi.md#create_flexcheck_user_login) | **POST** /users/flexcheck | +*SecurityApi* | [**create_role**](docs/SecurityApi.md#create_role) | **POST** /roles | +*SecurityApi* | [**create_user_login**](docs/SecurityApi.md#create_user_login) | **POST** /users | +*SecurityApi* | [**get_all_roles**](docs/SecurityApi.md#get_all_roles) | **GET** /roles | +*SecurityApi* | [**get_current_user**](docs/SecurityApi.md#get_current_user) | **GET** /users/mine | +*SecurityApi* | [**get_my_organizations**](docs/SecurityApi.md#get_my_organizations) | **GET** /users/mine/organizations | +*SecurityApi* | [**get_private_permanent_api_token**](docs/SecurityApi.md#get_private_permanent_api_token) | **POST** /users/generate-permanent-api-token | +*SecurityApi* | [**get_role_by_id**](docs/SecurityApi.md#get_role_by_id) | **GET** /roles/{role} | +*SecurityApi* | [**get_simple_all_users**](docs/SecurityApi.md#get_simple_all_users) | **GET** /users | +*SecurityApi* | [**get_temporary_api_tokens**](docs/SecurityApi.md#get_temporary_api_tokens) | **GET** /users/generate-tokens | +*SecurityApi* | [**get_user_by_username**](docs/SecurityApi.md#get_user_by_username) | **GET** /users/username/{email} | +*SecurityApi* | [**invite_user_login**](docs/SecurityApi.md#invite_user_login) | **POST** /users/invite | +*SecurityApi* | [**link_open_id_token_to_user**](docs/SecurityApi.md#link_open_id_token_to_user) | **POST** /users/invite/openid | +*SecurityApi* | [**refresh_permanent_api_token**](docs/SecurityApi.md#refresh_permanent_api_token) | **POST** /users/refresh-permanent-api-token | +*SecurityApi* | [**remove_permission_from_role**](docs/SecurityApi.md#remove_permission_from_role) | **DELETE** /roles/{role}/permission/{resource}/{action} | +*SecurityApi* | [**request_password_reset_code**](docs/SecurityApi.md#request_password_reset_code) | **POST** /users/password-reset/request-reset-code | +*SecurityApi* | [**revoke_role**](docs/SecurityApi.md#revoke_role) | **DELETE** /roles/{role} | +*SecurityApi* | [**update_email**](docs/SecurityApi.md#update_email) | **PUT** /users/{email}/email | +*SecurityApi* | [**update_role**](docs/SecurityApi.md#update_role) | **PUT** /roles | +*SecurityApi* | [**update_user_infos**](docs/SecurityApi.md#update_user_infos) | **PUT** /users/{email} | +*SecurityApi* | [**update_user_password**](docs/SecurityApi.md#update_user_password) | **PUT** /users/{email}/password | +*SecurityApi* | [**update_user_password_with_reset_code**](docs/SecurityApi.md#update_user_password_with_reset_code) | **POST** /users/password-reset/password-update | +*SubscriptionsApi* | [**add_charge_to_subscription**](docs/SubscriptionsApi.md#add_charge_to_subscription) | **POST** /subscriptions/{subscription-ID}/charge | +*SubscriptionsApi* | [**add_coupon_to_subscription**](docs/SubscriptionsApi.md#add_coupon_to_subscription) | **POST** /subscriptions/{subscription-ID}/coupons | +*SubscriptionsApi* | [**add_credit_note_to_subscription**](docs/SubscriptionsApi.md#add_credit_note_to_subscription) | **POST** /subscriptions/{subscription-ID}/credit | +*SubscriptionsApi* | [**add_payment_method_to_subscription**](docs/SubscriptionsApi.md#add_payment_method_to_subscription) | **POST** /subscriptions/{subscription-ID}/payment-methods | +*SubscriptionsApi* | [**advance_subscription**](docs/SubscriptionsApi.md#advance_subscription) | **POST** /subscriptions/{subscription-ID}/advance | +*SubscriptionsApi* | [**available_payment_methods_for_subscription**](docs/SubscriptionsApi.md#available_payment_methods_for_subscription) | **GET** /subscriptions/{subscription-ID}/payment-methods | +*SubscriptionsApi* | [**batch_create_subscriptions**](docs/SubscriptionsApi.md#batch_create_subscriptions) | **POST** /subscriptions/batch | +*SubscriptionsApi* | [**batch_increment_usage**](docs/SubscriptionsApi.md#batch_increment_usage) | **POST** /subscriptions/{subscriptionID}/increment-values | +*SubscriptionsApi* | [**cancel_subscription**](docs/SubscriptionsApi.md#cancel_subscription) | **POST** /subscriptions/{subscription-ID}/cancel | +*SubscriptionsApi* | [**create_aggregating_subscription**](docs/SubscriptionsApi.md#create_aggregating_subscription) | **POST** /subscriptions/aggregating | +*SubscriptionsApi* | [**create_subscription_from_request**](docs/SubscriptionsApi.md#create_subscription_from_request) | **POST** /subscriptions/create | +*SubscriptionsApi* | [**create_timer**](docs/SubscriptionsApi.md#create_timer) | **POST** /subscriptions/{subscription-ID}/timer | +*SubscriptionsApi* | [**delete_metadata_for_subscription**](docs/SubscriptionsApi.md#delete_metadata_for_subscription) | **DELETE** /subscriptions/{subscription-ID}/metadata | +*SubscriptionsApi* | [**freeze_subscription**](docs/SubscriptionsApi.md#freeze_subscription) | **POST** /subscriptions/{subscription-ID}/freeze | +*SubscriptionsApi* | [**get_affiliate1**](docs/SubscriptionsApi.md#get_affiliate1) | **GET** /subscriptions/{subscriptionID}/affiliate | +*SubscriptionsApi* | [**get_applicable_coupons_for_subscription**](docs/SubscriptionsApi.md#get_applicable_coupons_for_subscription) | **GET** /subscriptions/{subscription-ID}/applicable-coupons | +*SubscriptionsApi* | [**get_available_credit_subscription**](docs/SubscriptionsApi.md#get_available_credit_subscription) | **GET** /subscriptions/{subscription-ID}/credit | +*SubscriptionsApi* | [**get_charges_on_subscription**](docs/SubscriptionsApi.md#get_charges_on_subscription) | **GET** /subscriptions/{subscription-ID}/charges | +*SubscriptionsApi* | [**get_children_of_subscription**](docs/SubscriptionsApi.md#get_children_of_subscription) | **GET** /subscriptions/{subscription-ID}/children | +*SubscriptionsApi* | [**get_coupons_on_subscription**](docs/SubscriptionsApi.md#get_coupons_on_subscription) | **GET** /subscriptions/{subscription-ID}/coupons | +*SubscriptionsApi* | [**get_invoices_for_subscription_by_state**](docs/SubscriptionsApi.md#get_invoices_for_subscription_by_state) | **GET** /subscriptions/{subscriptionID}/invoices/{state} | +*SubscriptionsApi* | [**get_metadata_for_subscription**](docs/SubscriptionsApi.md#get_metadata_for_subscription) | **GET** /subscriptions/{subscription-ID}/metadata | +*SubscriptionsApi* | [**get_parent_subscription**](docs/SubscriptionsApi.md#get_parent_subscription) | **GET** /subscriptions/{subscription-ID}/parent | +*SubscriptionsApi* | [**get_pricing_component_values_of_subscription**](docs/SubscriptionsApi.md#get_pricing_component_values_of_subscription) | **GET** /subscriptions/{subscription-ID}/values | +*SubscriptionsApi* | [**get_subscription_by_account_id**](docs/SubscriptionsApi.md#get_subscription_by_account_id) | **GET** /subscriptions/account/{account-ID} | +*SubscriptionsApi* | [**get_subscription_by_id**](docs/SubscriptionsApi.md#get_subscription_by_id) | **GET** /subscriptions/{subscription-ID} | +*SubscriptionsApi* | [**get_subscription_by_product_id**](docs/SubscriptionsApi.md#get_subscription_by_product_id) | **GET** /subscriptions/product/{product-ID} | +*SubscriptionsApi* | [**get_subscription_by_product_rate_plan_id**](docs/SubscriptionsApi.md#get_subscription_by_product_rate_plan_id) | **GET** /subscriptions/product-rate-plan/{product-rate-plan-ID} | +*SubscriptionsApi* | [**get_subscription_by_state**](docs/SubscriptionsApi.md#get_subscription_by_state) | **GET** /subscriptions/state/{state} | +*SubscriptionsApi* | [**get_subscription_by_version_id**](docs/SubscriptionsApi.md#get_subscription_by_version_id) | **GET** /subscriptions/version/{version-ID} | +*SubscriptionsApi* | [**get_subscriptions_by_initial_period_start**](docs/SubscriptionsApi.md#get_subscriptions_by_initial_period_start) | **GET** /subscriptions/initial-period-start/{lower-threshold}/{upper-threshold} | +*SubscriptionsApi* | [**get_subscriptions_by_period_end**](docs/SubscriptionsApi.md#get_subscriptions_by_period_end) | **GET** /subscriptions/period-end/{lower-threshold}/{upper-threshold} | +*SubscriptionsApi* | [**get_subscriptions_by_period_start**](docs/SubscriptionsApi.md#get_subscriptions_by_period_start) | **GET** /subscriptions/period-start/{lower-threshold}/{upper-threshold} | +*SubscriptionsApi* | [**get_subscriptions_by_successful_periods**](docs/SubscriptionsApi.md#get_subscriptions_by_successful_periods) | **GET** /subscriptions/successful-periods/{lower-threshold}/{upper-threshold} | +*SubscriptionsApi* | [**get_swagger_subscription**](docs/SubscriptionsApi.md#get_swagger_subscription) | **GET** /subscriptions/swagger-end-point/{query-string} | +*SubscriptionsApi* | [**get_timers_for_subscription**](docs/SubscriptionsApi.md#get_timers_for_subscription) | **GET** /subscriptions/{subscription-ID}/timer | +*SubscriptionsApi* | [**import_subscription**](docs/SubscriptionsApi.md#import_subscription) | **POST** /subscriptions/import | +*SubscriptionsApi* | [**invoice_charges_on_subscription**](docs/SubscriptionsApi.md#invoice_charges_on_subscription) | **POST** /subscriptions/{subscription-ID}/invoice-charges | +*SubscriptionsApi* | [**migrate_subscription**](docs/SubscriptionsApi.md#migrate_subscription) | **POST** /subscriptions/{subscription-ID}/migrate | +*SubscriptionsApi* | [**pause_subscription**](docs/SubscriptionsApi.md#pause_subscription) | **POST** /subscriptions/{subscription-ID}/pause | +*SubscriptionsApi* | [**remove_coupon_from_subscription**](docs/SubscriptionsApi.md#remove_coupon_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/coupons/{coupon-code} | +*SubscriptionsApi* | [**remove_credit_from_subscription**](docs/SubscriptionsApi.md#remove_credit_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/credit/{value} | +*SubscriptionsApi* | [**remove_payment_method_from_subscription**](docs/SubscriptionsApi.md#remove_payment_method_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/payment-methods/{payment-method-ID} | +*SubscriptionsApi* | [**remove_pricing_component_value_change_from_subscription**](docs/SubscriptionsApi.md#remove_pricing_component_value_change_from_subscription) | **DELETE** /subscriptions/{subscription-ID}/values/{pricing-component} | +*SubscriptionsApi* | [**resume_subscription**](docs/SubscriptionsApi.md#resume_subscription) | **POST** /subscriptions/{subscription-ID}/resume | +*SubscriptionsApi* | [**revive_subscription**](docs/SubscriptionsApi.md#revive_subscription) | **POST** /subscriptions/{subscription-ID}/revive | +*SubscriptionsApi* | [**set_affiliate1**](docs/SubscriptionsApi.md#set_affiliate1) | **POST** /subscriptions/{subscriptionID}/affiliate | +*SubscriptionsApi* | [**set_metadata_for_subscription**](docs/SubscriptionsApi.md#set_metadata_for_subscription) | **POST** /subscriptions/{subscription-ID}/metadata | +*SubscriptionsApi* | [**set_pricing_component_value_on_subscription**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription) | **POST** /subscriptions/{subscription-ID}/pricing-component-values | +*SubscriptionsApi* | [**set_pricing_component_value_on_subscription1**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription1) | **POST** /subscriptions/{subscription-ID}/values/{pricing-component} | +*SubscriptionsApi* | [**set_pricing_component_value_on_subscription_batch_update**](docs/SubscriptionsApi.md#set_pricing_component_value_on_subscription_batch_update) | **POST** /subscriptions/{subscription-ID}/values | +*SubscriptionsApi* | [**start_all_subscriptions**](docs/SubscriptionsApi.md#start_all_subscriptions) | **POST** /subscriptions/{accountID}/start | +*SubscriptionsApi* | [**update_subscription_from_request**](docs/SubscriptionsApi.md#update_subscription_from_request) | **PUT** /subscriptions/update | +*SubscriptionsApi* | [**upsert_metadata_for_subscription**](docs/SubscriptionsApi.md#upsert_metadata_for_subscription) | **PUT** /subscriptions/{subscription-ID}/metadata | +*TaxesApi* | [**create_taxation_strategy**](docs/TaxesApi.md#create_taxation_strategy) | **POST** /taxation-strategies | +*TaxesApi* | [**get_all_taxation_strategies**](docs/TaxesApi.md#get_all_taxation_strategies) | **GET** /taxation-strategies | +*TaxesApi* | [**get_taxation_strategy_by_consistent_id**](docs/TaxesApi.md#get_taxation_strategy_by_consistent_id) | **GET** /taxation-strategies/{taxation-strategy-ID} | +*TaxesApi* | [**get_taxation_strategy_by_country**](docs/TaxesApi.md#get_taxation_strategy_by_country) | **GET** /taxation-strategies/country/{country} | +*TaxesApi* | [**get_taxation_strategy_by_currency**](docs/TaxesApi.md#get_taxation_strategy_by_currency) | **GET** /taxation-strategies/currency/{currency} | +*TaxesApi* | [**get_taxation_strategy_by_province**](docs/TaxesApi.md#get_taxation_strategy_by_province) | **GET** /taxation-strategies/province/{province} | +*TaxesApi* | [**get_taxation_strategy_by_version_id**](docs/TaxesApi.md#get_taxation_strategy_by_version_id) | **GET** /taxation-strategies/version/{version-ID} | +*TaxesApi* | [**retire_taxation_strategy**](docs/TaxesApi.md#retire_taxation_strategy) | **DELETE** /taxation-strategies/version/{version-ID} | +*TaxesApi* | [**update_taxation_strategy**](docs/TaxesApi.md#update_taxation_strategy) | **PUT** /taxation-strategies | +*TokenizationApi* | [**auth_capture**](docs/TokenizationApi.md#auth_capture) | **POST** /tokenization/auth-capture | +*TokenizationApi* | [**braintree_card_capture**](docs/TokenizationApi.md#braintree_card_capture) | **POST** /tokenization/braintree | +*TokenizationApi* | [**create_authorize_net_token**](docs/TokenizationApi.md#create_authorize_net_token) | **POST** /vaulted-gateways/authorize-net | +*TokenizationApi* | [**create_braintree_token**](docs/TokenizationApi.md#create_braintree_token) | **POST** /vaulted-gateways/braintree | +*TokenizationApi* | [**create_stripe_ach_token**](docs/TokenizationApi.md#create_stripe_ach_token) | **POST** /vaulted-gateways/stripe-ACH | +*TokenizationApi* | [**create_stripe_token**](docs/TokenizationApi.md#create_stripe_token) | **POST** /vaulted-gateways/stripe | +*TokenizationApi* | [**create_trust_commerce_token**](docs/TokenizationApi.md#create_trust_commerce_token) | **POST** /vaulted-gateways/trustCommerce | +*TokenizationApi* | [**display_card_capture_form**](docs/TokenizationApi.md#display_card_capture_form) | **GET** /tokenization/card-capture-form | +*TokenizationApi* | [**epx_card_capture**](docs/TokenizationApi.md#epx_card_capture) | **POST** /tokenization/epx | +*TokenizationApi* | [**epx_pre_auth**](docs/TokenizationApi.md#epx_pre_auth) | **POST** /tokenization/epx-pre-auth | +*TokenizationApi* | [**epx_pre_auth_response**](docs/TokenizationApi.md#epx_pre_auth_response) | **POST** /tokenization/epx-redirect | +*TokenizationApi* | [**expire_email_redirect_capture**](docs/TokenizationApi.md#expire_email_redirect_capture) | **DELETE** /tokenization/email-redirect/{id} | +*TokenizationApi* | [**get_all_email_redirect_capture**](docs/TokenizationApi.md#get_all_email_redirect_capture) | **GET** /tokenization/email-redirect | +*TokenizationApi* | [**get_braintree_by_account_id**](docs/TokenizationApi.md#get_braintree_by_account_id) | **GET** /vaulted-gateways/braintree/{accountID} | +*TokenizationApi* | [**get_by_card_details_id**](docs/TokenizationApi.md#get_by_card_details_id) | **GET** /vaulted-gateways/stripe/card-details-id/{cardDetailsID} | +*TokenizationApi* | [**get_email_redirect_capture**](docs/TokenizationApi.md#get_email_redirect_capture) | **GET** /tokenization/email-redirect/{id} | +*TokenizationApi* | [**get_email_redirect_capture_invoice_html**](docs/TokenizationApi.md#get_email_redirect_capture_invoice_html) | **GET** /tokenization/email-redirect/{id}/invoice.html | +*TokenizationApi* | [**get_stripe_ach**](docs/TokenizationApi.md#get_stripe_ach) | **GET** /vaulted-gateways/stripe-ACH/{stripeACHTokenID} | +*TokenizationApi* | [**get_stripe_token**](docs/TokenizationApi.md#get_stripe_token) | **GET** /vaulted-gateways/stripe/{stripeTokenID} | +*TokenizationApi* | [**go_cardless_bank_account_capture**](docs/TokenizationApi.md#go_cardless_bank_account_capture) | **POST** /tokenization/direct-debit | +*TokenizationApi* | [**pay_vision_shout_v1**](docs/TokenizationApi.md#pay_vision_shout_v1) | **POST** /tokenization/payvision-shout-v1 | +*TokenizationApi* | [**pre_auth**](docs/TokenizationApi.md#pre_auth) | **POST** /tokenization/pre-auth | +*TokenizationApi* | [**sage_pay_notify_v300**](docs/TokenizationApi.md#sage_pay_notify_v300) | **POST** /tokenization/sagepay-notify-v3-00 | +*TokenizationApi* | [**sage_pay_shout_v300**](docs/TokenizationApi.md#sage_pay_shout_v300) | **GET** /tokenization/sagepay-shout-v3-00 | +*TokenizationApi* | [**send_email_redirect_capture**](docs/TokenizationApi.md#send_email_redirect_capture) | **POST** /tokenization/email-redirect/{id}/send | +*TokenizationApi* | [**start_email_redirect_capture**](docs/TokenizationApi.md#start_email_redirect_capture) | **POST** /tokenization/email-redirect | +*TokenizationApi* | [**stripe_ach_bank_account_capture**](docs/TokenizationApi.md#stripe_ach_bank_account_capture) | **POST** /tokenization/ach | +*TokenizationApi* | [**stripe_web_hook**](docs/TokenizationApi.md#stripe_web_hook) | **POST** /vaulted-gateways/stripe/webhook | +*TokenizationApi* | [**update_email_redirect_capture**](docs/TokenizationApi.md#update_email_redirect_capture) | **PUT** /tokenization/email-redirect/{id} | +*TokenizationApi* | [**update_profile_with_token**](docs/TokenizationApi.md#update_profile_with_token) | **PUT** /tokenization/profile | +*TokenizationApi* | [**update_stripe_ach_token**](docs/TokenizationApi.md#update_stripe_ach_token) | **PUT** /vaulted-gateways/stripe-ACH | +*TokenizationApi* | [**update_stripe_token**](docs/TokenizationApi.md#update_stripe_token) | **PUT** /vaulted-gateways/stripe | +*TokenizationApi* | [**zooz_card_capture**](docs/TokenizationApi.md#zooz_card_capture) | **POST** /tokenization/zooz | +*TokenizationApi* | [**zooz_web_hook**](docs/TokenizationApi.md#zooz_web_hook) | **POST** /vaulted-gateways/zooz/webhook | +*WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /webhooks | +*WebhooksApi* | [**create_webhook_v2**](docs/WebhooksApi.md#create_webhook_v2) | **POST** /webhooks/create | +*WebhooksApi* | [**get_all_webhooks**](docs/WebhooksApi.md#get_all_webhooks) | **GET** /webhooks | +*WebhooksApi* | [**get_allowed_webhook_subscriptions**](docs/WebhooksApi.md#get_allowed_webhook_subscriptions) | **GET** /webhooks/allowed-subscriptions | +*WebhooksApi* | [**get_webhook_by_id**](docs/WebhooksApi.md#get_webhook_by_id) | **GET** /webhooks/{webhook-ID} | +*WebhooksApi* | [**retire_webhook**](docs/WebhooksApi.md#retire_webhook) | **DELETE** /webhooks/{webhook-ID} | +*WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PUT** /webhooks | +*WebhooksApi* | [**verify_webhook**](docs/WebhooksApi.md#verify_webhook) | **GET** /webhooks/verify/{verification-ID} | +*DefaultApi* | [**create_totp_secret**](docs/DefaultApi.md#create_totp_secret) | **POST** /2fa/totp | +*DefaultApi* | [**enable2fa**](docs/DefaultApi.md#enable2fa) | **POST** /2fa/enable | +*DefaultApi* | [**get_qr_code**](docs/DefaultApi.md#get_qr_code) | **GET** /barcode/qr/acc/{accountId} | ## Documentation For Models diff --git a/billforward/api/reports_api.py b/billforward/api/reports_api.py index 82c6895..f82d6df 100644 --- a/billforward/api/reports_api.py +++ b/billforward/api/reports_api.py @@ -799,6 +799,7 @@ def get_csv_report_revenue_attributions_raw(self, **kwargs): # noqa: E501 :param str monetary_amount_format: :param list[str] meta_column_account: :param list[str] meta_column_sub_child: + :param bool include_zero_value: :return: None If the method is called asynchronously, returns the request thread. @@ -830,12 +831,13 @@ def get_csv_report_revenue_attributions_raw_with_http_info(self, **kwargs): # n :param str monetary_amount_format: :param list[str] meta_column_account: :param list[str] meta_column_sub_child: + :param bool include_zero_value: :return: None If the method is called asynchronously, returns the request thread. """ - all_params = ['organizations', 'date_discriminator', 'recognition_start', 'recognition_end', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format', 'meta_column_account', 'meta_column_sub_child'] # noqa: E501 + all_params = ['organizations', 'date_discriminator', 'recognition_start', 'recognition_end', 'date_interval_inclusivity', 'date_time_format', 'date_granularity', 'boolean_format', 'monetary_amount_format', 'meta_column_account', 'meta_column_sub_child', 'include_zero_value'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') @@ -881,6 +883,8 @@ def get_csv_report_revenue_attributions_raw_with_http_info(self, **kwargs): # n if 'meta_column_sub_child' in params: query_params.append(('meta_column_sub_child[]', params['meta_column_sub_child'])) # noqa: E501 collection_formats['meta_column_sub_child[]'] = 'multi' # noqa: E501 + if 'include_zero_value' in params: + query_params.append(('includeZeroValue', params['include_zero_value'])) # noqa: E501 header_params = {} diff --git a/billforward/models/affiliate_rate_plan_relationships.py b/billforward/models/affiliate_rate_plan_relationships.py index 7358899..94e8b78 100644 --- a/billforward/models/affiliate_rate_plan_relationships.py +++ b/billforward/models/affiliate_rate_plan_relationships.py @@ -37,8 +37,8 @@ class AffiliateRatePlanRelationships(object): 'product_rate_plan_id': 'str', 'start_date': 'datetime', 'end_date': 'datetime', - 'interval': 'IntervalDate', - 'account_id': 'str' + 'account_id': 'str', + 'interval': 'IntervalDate' } attribute_map = { @@ -51,11 +51,11 @@ class AffiliateRatePlanRelationships(object): 'product_rate_plan_id': 'productRatePlanID', 'start_date': 'startDate', 'end_date': 'endDate', - 'interval': 'interval', - 'account_id': 'accountID' + 'account_id': 'accountID', + 'interval': 'interval' } - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, commission_structure=None, product_rate_plan_id=None, start_date=None, end_date=None, interval=None, account_id=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, commission_structure=None, product_rate_plan_id=None, start_date=None, end_date=None, account_id=None, interval=None): # noqa: E501 """AffiliateRatePlanRelationships - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -66,8 +66,8 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self._product_rate_plan_id = None self._start_date = None self._end_date = None - self._interval = None self._account_id = None + self._interval = None self.discriminator = None if created is not None: self.created = created @@ -87,10 +87,10 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self.start_date = start_date if end_date is not None: self.end_date = end_date - if interval is not None: - self.interval = interval if account_id is not None: self.account_id = account_id + if interval is not None: + self.interval = interval @property def created(self): @@ -281,27 +281,6 @@ def end_date(self, end_date): self._end_date = end_date - @property - def interval(self): - """Gets the interval of this AffiliateRatePlanRelationships. # noqa: E501 - - - :return: The interval of this AffiliateRatePlanRelationships. # noqa: E501 - :rtype: IntervalDate - """ - return self._interval - - @interval.setter - def interval(self, interval): - """Sets the interval of this AffiliateRatePlanRelationships. - - - :param interval: The interval of this AffiliateRatePlanRelationships. # noqa: E501 - :type: IntervalDate - """ - - self._interval = interval - @property def account_id(self): """Gets the account_id of this AffiliateRatePlanRelationships. # noqa: E501 @@ -323,6 +302,27 @@ def account_id(self, account_id): self._account_id = account_id + @property + def interval(self): + """Gets the interval of this AffiliateRatePlanRelationships. # noqa: E501 + + + :return: The interval of this AffiliateRatePlanRelationships. # noqa: E501 + :rtype: IntervalDate + """ + return self._interval + + @interval.setter + def interval(self, interval): + """Sets the interval of this AffiliateRatePlanRelationships. + + + :param interval: The interval of this AffiliateRatePlanRelationships. # noqa: E501 + :type: IntervalDate + """ + + self._interval = interval + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/billforward/models/amendment.py b/billforward/models/amendment.py index 4964dd9..2165db5 100644 --- a/billforward/models/amendment.py +++ b/billforward/models/amendment.py @@ -40,8 +40,8 @@ class Amendment(object): 'actioned_time': 'datetime', 'state': 'str', 'deleted': 'bool', - 'amendment_type': 'str', 'discardable_subsystem_object': 'IDiscardable', + 'amendment_type': 'str', 'type': 'str' } @@ -58,8 +58,8 @@ class Amendment(object): 'actioned_time': 'actionedTime', 'state': 'state', 'deleted': 'deleted', - 'amendment_type': 'amendmentType', 'discardable_subsystem_object': 'discardableSubsystemObject', + 'amendment_type': 'amendmentType', 'type': '@type' } @@ -81,7 +81,7 @@ class Amendment(object): 'ServiceEndAmendment': 'ServiceEndAmendment', 'TimerAmendment': 'TimerAmendment' } - def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None, id=None, organization_id=None, subscription_id=None, description=None, actioning_time=None, actioned_time=None, state=None, deleted=None, amendment_type=None, discardable_subsystem_object=None, type=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None, id=None, organization_id=None, subscription_id=None, description=None, actioning_time=None, actioned_time=None, state=None, deleted=None, discardable_subsystem_object=None, amendment_type=None, type=None): # noqa: E501 """Amendment - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -95,8 +95,8 @@ def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None self._actioned_time = None self._state = None self._deleted = None - self._amendment_type = None self._discardable_subsystem_object = None + self._amendment_type = None self._type = None self.discriminator = '@type' if created is not None: @@ -121,10 +121,10 @@ def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None self.actioned_time = actioned_time self.state = state self.deleted = deleted - if amendment_type is not None: - self.amendment_type = amendment_type if discardable_subsystem_object is not None: self.discardable_subsystem_object = discardable_subsystem_object + if amendment_type is not None: + self.amendment_type = amendment_type self.type = type @property @@ -389,6 +389,27 @@ def deleted(self, deleted): self._deleted = deleted + @property + def discardable_subsystem_object(self): + """Gets the discardable_subsystem_object of this Amendment. # noqa: E501 + + + :return: The discardable_subsystem_object of this Amendment. # noqa: E501 + :rtype: IDiscardable + """ + return self._discardable_subsystem_object + + @discardable_subsystem_object.setter + def discardable_subsystem_object(self, discardable_subsystem_object): + """Sets the discardable_subsystem_object of this Amendment. + + + :param discardable_subsystem_object: The discardable_subsystem_object of this Amendment. # noqa: E501 + :type: IDiscardable + """ + + self._discardable_subsystem_object = discardable_subsystem_object + @property def amendment_type(self): """Gets the amendment_type of this Amendment. # noqa: E501 @@ -416,27 +437,6 @@ def amendment_type(self, amendment_type): self._amendment_type = amendment_type - @property - def discardable_subsystem_object(self): - """Gets the discardable_subsystem_object of this Amendment. # noqa: E501 - - - :return: The discardable_subsystem_object of this Amendment. # noqa: E501 - :rtype: IDiscardable - """ - return self._discardable_subsystem_object - - @discardable_subsystem_object.setter - def discardable_subsystem_object(self, discardable_subsystem_object): - """Sets the discardable_subsystem_object of this Amendment. - - - :param discardable_subsystem_object: The discardable_subsystem_object of this Amendment. # noqa: E501 - :type: IDiscardable - """ - - self._discardable_subsystem_object = discardable_subsystem_object - @property def type(self): """Gets the type of this Amendment. # noqa: E501 diff --git a/billforward/models/api_configuration.py b/billforward/models/api_configuration.py index bf7d6ad..7499f39 100644 --- a/billforward/models/api_configuration.py +++ b/billforward/models/api_configuration.py @@ -49,8 +49,8 @@ class APIConfiguration(object): 'expires_at': 'datetime', 'migrations': 'list[Migration]', 'gateway_type': 'str', - 'environment_type': 'str', 'production': 'bool', + 'environment_type': 'str', 'apilogin_id': 'str', 'apikey': 'str' } @@ -77,13 +77,13 @@ class APIConfiguration(object): 'expires_at': 'expiresAt', 'migrations': 'migrations', 'gateway_type': 'gatewayType', - 'environment_type': 'environmentType', 'production': 'production', + 'environment_type': 'environmentType', 'apilogin_id': 'apiloginID', 'apikey': 'apikey' } - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, type=None, environment=None, merchant_id=None, public_key=None, private_key=None, endpoint=None, client_id=None, client_secret=None, gateway_account_id=None, refresh_token=None, deleted=None, api_login_id=None, transaction_key=None, expires_at=None, migrations=None, gateway_type=None, environment_type=None, production=None, apilogin_id=None, apikey=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, type=None, environment=None, merchant_id=None, public_key=None, private_key=None, endpoint=None, client_id=None, client_secret=None, gateway_account_id=None, refresh_token=None, deleted=None, api_login_id=None, transaction_key=None, expires_at=None, migrations=None, gateway_type=None, production=None, environment_type=None, apilogin_id=None, apikey=None): # noqa: E501 """APIConfiguration - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -106,8 +106,8 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self._expires_at = None self._migrations = None self._gateway_type = None - self._environment_type = None self._production = None + self._environment_type = None self._apilogin_id = None self._apikey = None self.discriminator = None @@ -152,10 +152,10 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self.migrations = migrations if gateway_type is not None: self.gateway_type = gateway_type - if environment_type is not None: - self.environment_type = environment_type if production is not None: self.production = production + if environment_type is not None: + self.environment_type = environment_type if apilogin_id is not None: self.apilogin_id = apilogin_id if apikey is not None: @@ -622,6 +622,27 @@ def gateway_type(self, gateway_type): self._gateway_type = gateway_type + @property + def production(self): + """Gets the production of this APIConfiguration. # noqa: E501 + + + :return: The production of this APIConfiguration. # noqa: E501 + :rtype: bool + """ + return self._production + + @production.setter + def production(self, production): + """Sets the production of this APIConfiguration. + + + :param production: The production of this APIConfiguration. # noqa: E501 + :type: bool + """ + + self._production = production + @property def environment_type(self): """Gets the environment_type of this APIConfiguration. # noqa: E501 @@ -649,27 +670,6 @@ def environment_type(self, environment_type): self._environment_type = environment_type - @property - def production(self): - """Gets the production of this APIConfiguration. # noqa: E501 - - - :return: The production of this APIConfiguration. # noqa: E501 - :rtype: bool - """ - return self._production - - @production.setter - def production(self, production): - """Sets the production of this APIConfiguration. - - - :param production: The production of this APIConfiguration. # noqa: E501 - :type: bool - """ - - self._production = production - @property def apilogin_id(self): """Gets the apilogin_id of this APIConfiguration. # noqa: E501 diff --git a/billforward/models/pay_vision_configuration.py b/billforward/models/pay_vision_configuration.py index 8edcec4..3009811 100644 --- a/billforward/models/pay_vision_configuration.py +++ b/billforward/models/pay_vision_configuration.py @@ -31,8 +31,8 @@ class PayVisionConfiguration(APIConfiguration): swagger_types = { 'key_filename': 'str', 'domain': 'str', - 'entity_id': 'str', 'password': 'str', + 'entity_id': 'str', 'user_id': 'str' } if hasattr(APIConfiguration, "swagger_types"): @@ -41,29 +41,29 @@ class PayVisionConfiguration(APIConfiguration): attribute_map = { 'key_filename': 'keyFilename', 'domain': 'domain', - 'entity_id': 'entityID', 'password': 'password', + 'entity_id': 'entityID', 'user_id': 'userID' } if hasattr(APIConfiguration, "attribute_map"): attribute_map.update(APIConfiguration.attribute_map) - def __init__(self, key_filename=None, domain=None, entity_id=None, password=None, user_id=None, *args, **kwargs): # noqa: E501 + def __init__(self, key_filename=None, domain=None, password=None, entity_id=None, user_id=None, *args, **kwargs): # noqa: E501 """PayVisionConfiguration - a model defined in Swagger""" # noqa: E501 self._key_filename = None self._domain = None - self._entity_id = None self._password = None + self._entity_id = None self._user_id = None self.discriminator = None if key_filename is not None: self.key_filename = key_filename if domain is not None: self.domain = domain - if entity_id is not None: - self.entity_id = entity_id if password is not None: self.password = password + if entity_id is not None: + self.entity_id = entity_id if user_id is not None: self.user_id = user_id APIConfiguration.__init__(self, *args, **kwargs) @@ -111,46 +111,46 @@ def domain(self, domain): self._domain = domain @property - def entity_id(self): - """Gets the entity_id of this PayVisionConfiguration. # noqa: E501 + def password(self): + """Gets the password of this PayVisionConfiguration. # noqa: E501 - :return: The entity_id of this PayVisionConfiguration. # noqa: E501 + :return: The password of this PayVisionConfiguration. # noqa: E501 :rtype: str """ - return self._entity_id + return self._password - @entity_id.setter - def entity_id(self, entity_id): - """Sets the entity_id of this PayVisionConfiguration. + @password.setter + def password(self, password): + """Sets the password of this PayVisionConfiguration. - :param entity_id: The entity_id of this PayVisionConfiguration. # noqa: E501 + :param password: The password of this PayVisionConfiguration. # noqa: E501 :type: str """ - self._entity_id = entity_id + self._password = password @property - def password(self): - """Gets the password of this PayVisionConfiguration. # noqa: E501 + def entity_id(self): + """Gets the entity_id of this PayVisionConfiguration. # noqa: E501 - :return: The password of this PayVisionConfiguration. # noqa: E501 + :return: The entity_id of this PayVisionConfiguration. # noqa: E501 :rtype: str """ - return self._password + return self._entity_id - @password.setter - def password(self, password): - """Sets the password of this PayVisionConfiguration. + @entity_id.setter + def entity_id(self, entity_id): + """Sets the entity_id of this PayVisionConfiguration. - :param password: The password of this PayVisionConfiguration. # noqa: E501 + :param entity_id: The entity_id of this PayVisionConfiguration. # noqa: E501 :type: str """ - self._password = password + self._entity_id = entity_id @property def user_id(self): diff --git a/billforward/models/refund.py b/billforward/models/refund.py index 35394b8..71bf647 100644 --- a/billforward/models/refund.py +++ b/billforward/models/refund.py @@ -61,8 +61,8 @@ class Refund(object): 'created_by': 'str', 'type': 'str', 'state': 'str', - 'refunded_value': 'float', 'refunded_payment': 'Payment', + 'refunded_value': 'float', 'account': 'str' } @@ -100,12 +100,12 @@ class Refund(object): 'created_by': 'createdBy', 'type': 'type', 'state': 'state', - 'refunded_value': 'refundedValue', 'refunded_payment': 'refundedPayment', + 'refunded_value': 'refundedValue', 'account': 'account' } - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, account_id=None, reason=None, nominal_value=None, value=None, refunded=None, actual_value=None, nominal_refunded_value=None, actual_refunded_value=None, refund_state=None, refund_type=None, refund_nature=None, last_execution_attempt=None, next_execution_attempt=None, final_execution_attempt=None, refund_completed=None, currency=None, payment_method_id=None, invoice_payment_id=None, refund_invoice_payment_id=None, original_payment_id=None, original_gateway_payment_reference=None, refund_payment_id=None, invoice_id=None, receipt_id=None, original_receipt_id=None, created_by=None, type=None, state=None, refunded_value=None, refunded_payment=None, account=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, account_id=None, reason=None, nominal_value=None, value=None, refunded=None, actual_value=None, nominal_refunded_value=None, actual_refunded_value=None, refund_state=None, refund_type=None, refund_nature=None, last_execution_attempt=None, next_execution_attempt=None, final_execution_attempt=None, refund_completed=None, currency=None, payment_method_id=None, invoice_payment_id=None, refund_invoice_payment_id=None, original_payment_id=None, original_gateway_payment_reference=None, refund_payment_id=None, invoice_id=None, receipt_id=None, original_receipt_id=None, created_by=None, type=None, state=None, refunded_payment=None, refunded_value=None, account=None): # noqa: E501 """Refund - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -140,8 +140,8 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self._created_by = None self._type = None self._state = None - self._refunded_value = None self._refunded_payment = None + self._refunded_value = None self._account = None self.discriminator = None if created is not None: @@ -202,10 +202,10 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self.type = type if state is not None: self.state = state - if refunded_value is not None: - self.refunded_value = refunded_value if refunded_payment is not None: self.refunded_payment = refunded_payment + if refunded_value is not None: + self.refunded_value = refunded_value if account is not None: self.account = account @@ -948,27 +948,6 @@ def state(self, state): self._state = state - @property - def refunded_value(self): - """Gets the refunded_value of this Refund. # noqa: E501 - - - :return: The refunded_value of this Refund. # noqa: E501 - :rtype: float - """ - return self._refunded_value - - @refunded_value.setter - def refunded_value(self, refunded_value): - """Sets the refunded_value of this Refund. - - - :param refunded_value: The refunded_value of this Refund. # noqa: E501 - :type: float - """ - - self._refunded_value = refunded_value - @property def refunded_payment(self): """Gets the refunded_payment of this Refund. # noqa: E501 @@ -990,6 +969,27 @@ def refunded_payment(self, refunded_payment): self._refunded_payment = refunded_payment + @property + def refunded_value(self): + """Gets the refunded_value of this Refund. # noqa: E501 + + + :return: The refunded_value of this Refund. # noqa: E501 + :rtype: float + """ + return self._refunded_value + + @refunded_value.setter + def refunded_value(self, refunded_value): + """Sets the refunded_value of this Refund. + + + :param refunded_value: The refunded_value of this Refund. # noqa: E501 + :type: float + """ + + self._refunded_value = refunded_value + @property def account(self): """Gets the account of this Refund. # noqa: E501 diff --git a/billforward/models/shuttle_configuration.py b/billforward/models/shuttle_configuration.py index 2860549..6b5eae0 100644 --- a/billforward/models/shuttle_configuration.py +++ b/billforward/models/shuttle_configuration.py @@ -29,35 +29,56 @@ class ShuttleConfiguration(APIConfiguration): and the value is json key in definition. """ swagger_types = { + 'percentage_for_other_payment_methods': 'float', 'hosted_payment_config': 'HostedPaymentConfig', - 'instance_key': 'str', - 'percentage_for_other_payment_methods': 'float' + 'instance_key': 'str' } if hasattr(APIConfiguration, "swagger_types"): swagger_types.update(APIConfiguration.swagger_types) attribute_map = { + 'percentage_for_other_payment_methods': 'percentageForOtherPaymentMethods', 'hosted_payment_config': 'hostedPaymentConfig', - 'instance_key': 'instanceKey', - 'percentage_for_other_payment_methods': 'percentageForOtherPaymentMethods' + 'instance_key': 'instanceKey' } if hasattr(APIConfiguration, "attribute_map"): attribute_map.update(APIConfiguration.attribute_map) - def __init__(self, hosted_payment_config=None, instance_key=None, percentage_for_other_payment_methods=None, *args, **kwargs): # noqa: E501 + def __init__(self, percentage_for_other_payment_methods=None, hosted_payment_config=None, instance_key=None, *args, **kwargs): # noqa: E501 """ShuttleConfiguration - a model defined in Swagger""" # noqa: E501 + self._percentage_for_other_payment_methods = None self._hosted_payment_config = None self._instance_key = None - self._percentage_for_other_payment_methods = None self.discriminator = None + if percentage_for_other_payment_methods is not None: + self.percentage_for_other_payment_methods = percentage_for_other_payment_methods if hosted_payment_config is not None: self.hosted_payment_config = hosted_payment_config if instance_key is not None: self.instance_key = instance_key - if percentage_for_other_payment_methods is not None: - self.percentage_for_other_payment_methods = percentage_for_other_payment_methods APIConfiguration.__init__(self, *args, **kwargs) + @property + def percentage_for_other_payment_methods(self): + """Gets the percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 + + + :return: The percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 + :rtype: float + """ + return self._percentage_for_other_payment_methods + + @percentage_for_other_payment_methods.setter + def percentage_for_other_payment_methods(self, percentage_for_other_payment_methods): + """Sets the percentage_for_other_payment_methods of this ShuttleConfiguration. + + + :param percentage_for_other_payment_methods: The percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 + :type: float + """ + + self._percentage_for_other_payment_methods = percentage_for_other_payment_methods + @property def hosted_payment_config(self): """Gets the hosted_payment_config of this ShuttleConfiguration. # noqa: E501 @@ -100,27 +121,6 @@ def instance_key(self, instance_key): self._instance_key = instance_key - @property - def percentage_for_other_payment_methods(self): - """Gets the percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 - - - :return: The percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 - :rtype: float - """ - return self._percentage_for_other_payment_methods - - @percentage_for_other_payment_methods.setter - def percentage_for_other_payment_methods(self, percentage_for_other_payment_methods): - """Sets the percentage_for_other_payment_methods of this ShuttleConfiguration. - - - :param percentage_for_other_payment_methods: The percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 - :type: float - """ - - self._percentage_for_other_payment_methods = percentage_for_other_payment_methods - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/billforward/models/user.py b/billforward/models/user.py index ad350e0..de47eb3 100644 --- a/billforward/models/user.py +++ b/billforward/models/user.py @@ -46,9 +46,9 @@ class User(object): 'timezone': 'UserTimezone', 'flexcheck_user': 'bool', 'two_fa': 'bool', + 'email': 'str', 'main_username': 'Username', - 'active_usernames': 'list[str]', - 'email': 'str' + 'active_usernames': 'list[str]' } attribute_map = { @@ -70,12 +70,12 @@ class User(object): 'timezone': 'timezone', 'flexcheck_user': 'flexcheckUser', 'two_fa': 'twoFA', + 'email': 'email', 'main_username': 'mainUsername', - 'active_usernames': 'activeUsernames', - 'email': 'email' + 'active_usernames': 'activeUsernames' } - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, password=None, username=None, open_id_identifier=None, password_reset_code=None, password_reset_attempts=None, password_reset_valid_till=None, last_successful_login=None, successful_logins=None, bf_admin=None, enabled=None, timezone=None, flexcheck_user=None, two_fa=None, main_username=None, active_usernames=None, email=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, password=None, username=None, open_id_identifier=None, password_reset_code=None, password_reset_attempts=None, password_reset_valid_till=None, last_successful_login=None, successful_logins=None, bf_admin=None, enabled=None, timezone=None, flexcheck_user=None, two_fa=None, email=None, main_username=None, active_usernames=None): # noqa: E501 """User - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -95,9 +95,9 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self._timezone = None self._flexcheck_user = None self._two_fa = None + self._email = None self._main_username = None self._active_usernames = None - self._email = None self.discriminator = None if created is not None: self.created = created @@ -131,12 +131,12 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self.flexcheck_user = flexcheck_user if two_fa is not None: self.two_fa = two_fa + if email is not None: + self.email = email if main_username is not None: self.main_username = main_username if active_usernames is not None: self.active_usernames = active_usernames - if email is not None: - self.email = email @property def created(self): @@ -524,6 +524,27 @@ def two_fa(self, two_fa): self._two_fa = two_fa + @property + def email(self): + """Gets the email of this User. # noqa: E501 + + + :return: The email of this User. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this User. + + + :param email: The email of this User. # noqa: E501 + :type: str + """ + + self._email = email + @property def main_username(self): """Gets the main_username of this User. # noqa: E501 @@ -566,27 +587,6 @@ def active_usernames(self, active_usernames): self._active_usernames = active_usernames - @property - def email(self): - """Gets the email of this User. # noqa: E501 - - - :return: The email of this User. # noqa: E501 - :rtype: str - """ - return self._email - - @email.setter - def email(self, email): - """Sets the email of this User. - - - :param email: The email of this User. # noqa: E501 - :type: str - """ - - self._email = email - def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/docs/APIConfiguration.md b/docs/APIConfiguration.md index 28094bf..1aff6ad 100644 --- a/docs/APIConfiguration.md +++ b/docs/APIConfiguration.md @@ -24,8 +24,8 @@ Name | Type | Description | Notes **expires_at** | **datetime** | | [optional] **migrations** | [**list[Migration]**](Migration.md) | | [optional] **gateway_type** | **str** | | [optional] -**environment_type** | **str** | | [optional] **production** | **bool** | | [optional] +**environment_type** | **str** | | [optional] **apilogin_id** | **str** | | [optional] **apikey** | **str** | | [optional] diff --git a/docs/AffiliateRatePlanRelationships.md b/docs/AffiliateRatePlanRelationships.md index 0e0d5b0..92e942c 100644 --- a/docs/AffiliateRatePlanRelationships.md +++ b/docs/AffiliateRatePlanRelationships.md @@ -12,8 +12,8 @@ Name | Type | Description | Notes **product_rate_plan_id** | **str** | | [optional] **start_date** | **datetime** | | [optional] **end_date** | **datetime** | | [optional] -**interval** | [**IntervalDate**](IntervalDate.md) | | [optional] **account_id** | **str** | | [optional] +**interval** | [**IntervalDate**](IntervalDate.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Amendment.md b/docs/Amendment.md index f75889d..44ce319 100644 --- a/docs/Amendment.md +++ b/docs/Amendment.md @@ -15,8 +15,8 @@ Name | Type | Description | Notes **actioned_time** | **datetime** | | [optional] **state** | **str** | | **deleted** | **bool** | | -**amendment_type** | **str** | | [optional] **discardable_subsystem_object** | [**IDiscardable**](IDiscardable.md) | | [optional] +**amendment_type** | **str** | | [optional] **type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PayVisionConfiguration.md b/docs/PayVisionConfiguration.md index 2b825ed..cd610bd 100644 --- a/docs/PayVisionConfiguration.md +++ b/docs/PayVisionConfiguration.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **key_filename** | **str** | | [optional] **domain** | **str** | | [optional] -**entity_id** | **str** | | [optional] **password** | **str** | | [optional] +**entity_id** | **str** | | [optional] **user_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Refund.md b/docs/Refund.md index ef3d8ae..f1c67c1 100644 --- a/docs/Refund.md +++ b/docs/Refund.md @@ -36,8 +36,8 @@ Name | Type | Description | Notes **created_by** | **str** | | [optional] **type** | **str** | | [optional] **state** | **str** | | [optional] -**refunded_value** | **float** | | [optional] **refunded_payment** | [**Payment**](Payment.md) | | [optional] +**refunded_value** | **float** | | [optional] **account** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ReportsApi.md b/docs/ReportsApi.md index 735180b..242e97b 100644 --- a/docs/ReportsApi.md +++ b/docs/ReportsApi.md @@ -396,7 +396,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_csv_report_revenue_attributions_raw** -> get_csv_report_revenue_attributions_raw(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child) +> get_csv_report_revenue_attributions_raw(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child, include_zero_value=include_zero_value) @@ -422,9 +422,10 @@ boolean_format = 'TrueFalseLowercase' # str | (optional) (default to TrueFalseL monetary_amount_format = 'NoCommasPeriod2DP' # str | (optional) (default to NoCommasPeriod2DP) meta_column_account = ['meta_column_account_example'] # list[str] | (optional) meta_column_sub_child = ['meta_column_sub_child_example'] # list[str] | (optional) +include_zero_value = true # bool | (optional) try: - api_instance.get_csv_report_revenue_attributions_raw(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child) + api_instance.get_csv_report_revenue_attributions_raw(organizations=organizations, date_discriminator=date_discriminator, recognition_start=recognition_start, recognition_end=recognition_end, date_interval_inclusivity=date_interval_inclusivity, date_time_format=date_time_format, date_granularity=date_granularity, boolean_format=boolean_format, monetary_amount_format=monetary_amount_format, meta_column_account=meta_column_account, meta_column_sub_child=meta_column_sub_child, include_zero_value=include_zero_value) except ApiException as e: print("Exception when calling ReportsApi->get_csv_report_revenue_attributions_raw: %s\n" % e) ``` @@ -444,6 +445,7 @@ Name | Type | Description | Notes **monetary_amount_format** | **str**| | [optional] [default to NoCommasPeriod2DP] **meta_column_account** | [**list[str]**](str.md)| | [optional] **meta_column_sub_child** | [**list[str]**](str.md)| | [optional] + **include_zero_value** | **bool**| | [optional] ### Return type diff --git a/docs/ShuttleConfiguration.md b/docs/ShuttleConfiguration.md index ec7af81..f1262ba 100644 --- a/docs/ShuttleConfiguration.md +++ b/docs/ShuttleConfiguration.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**percentage_for_other_payment_methods** | **float** | | [optional] **hosted_payment_config** | [**HostedPaymentConfig**](HostedPaymentConfig.md) | | [optional] **instance_key** | **str** | | [optional] -**percentage_for_other_payment_methods** | **float** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/User.md b/docs/User.md index 6668c76..92365ba 100644 --- a/docs/User.md +++ b/docs/User.md @@ -21,9 +21,9 @@ Name | Type | Description | Notes **timezone** | [**UserTimezone**](UserTimezone.md) | | **flexcheck_user** | **bool** | | **two_fa** | **bool** | | [optional] +**email** | **str** | | [optional] **main_username** | [**Username**](Username.md) | | [optional] **active_usernames** | **list[str]** | | [optional] -**email** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/update_api.sh b/update_api.sh new file mode 100755 index 0000000..9442098 --- /dev/null +++ b/update_api.sh @@ -0,0 +1,3 @@ +#! /bin/bash +swagger-codegen generate -i ../billforward/backend/api-v1/target/generated-openapi/non-deprecated.json -l python -DpackageName=billforward +rm -r test/ From 0000218316e1925e91b9ebeb5608eb9f87c0a91b Mon Sep 17 00:00:00 2001 From: Mat Jaggard Date: Wed, 8 Dec 2021 15:05:19 +0000 Subject: [PATCH 6/8] Use @type as well as type --- .swagger-codegen/VERSION | 2 +- billforward/models/additional_data.py | 32 +++++++++---------- billforward/models/amendment.py | 32 +++++++++---------- billforward/models/auth_capture_request.py | 32 +++++++++---------- billforward/models/payment.py | 32 +++++++++---------- billforward/models/pricing_component.py | 32 +++++++++---------- billforward/models/subscription_charge.py | 32 +++++++++---------- .../models/tokenization_pre_auth_request.py | 32 +++++++++---------- docs/AdditionalData.md | 2 +- docs/Amendment.md | 2 +- docs/AuthCaptureRequest.md | 2 +- docs/Payment.md | 2 +- docs/PricingComponent.md | 2 +- docs/SubscriptionCharge.md | 2 +- docs/TokenizationPreAuthRequest.md | 2 +- 15 files changed, 120 insertions(+), 120 deletions(-) diff --git a/.swagger-codegen/VERSION b/.swagger-codegen/VERSION index 0667b5f..ae2f493 100644 --- a/.swagger-codegen/VERSION +++ b/.swagger-codegen/VERSION @@ -1 +1 @@ -3.0.29 \ No newline at end of file +3.0.31-SNAPSHOT-Billforward diff --git a/billforward/models/additional_data.py b/billforward/models/additional_data.py index a29f7b8..b2aadd2 100644 --- a/billforward/models/additional_data.py +++ b/billforward/models/additional_data.py @@ -28,44 +28,44 @@ class AdditionalData(object): and the value is json key in definition. """ swagger_types = { - 'type': 'str' + 'at_type': 'str' } attribute_map = { - 'type': '@type' + 'at_type': '@type' } discriminator_value_class_map = { 'StripeAdditionalData': 'StripeAdditionalData' } - def __init__(self, type=None): # noqa: E501 + def __init__(self, at_type=None): # noqa: E501 """AdditionalData - a model defined in Swagger""" # noqa: E501 - self._type = None + self._at_type = None self.discriminator = '@type' - self.type = type + self.at_type = at_type @property - def type(self): - """Gets the type of this AdditionalData. # noqa: E501 + def at_type(self): + """Gets the at_type of this AdditionalData. # noqa: E501 - :return: The type of this AdditionalData. # noqa: E501 + :return: The at_type of this AdditionalData. # noqa: E501 :rtype: str """ - return self._type + return self._at_type - @type.setter - def type(self, type): - """Sets the type of this AdditionalData. + @at_type.setter + def at_type(self, at_type): + """Sets the at_type of this AdditionalData. - :param type: The type of this AdditionalData. # noqa: E501 + :param at_type: The at_type of this AdditionalData. # noqa: E501 :type: str """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + if at_type is None: + raise ValueError("Invalid value for `at_type`, must not be `None`") # noqa: E501 - self._type = type + self._at_type = at_type def get_real_child_model(self, data): """Returns the real base class specified by the discriminator""" diff --git a/billforward/models/amendment.py b/billforward/models/amendment.py index 2165db5..2060536 100644 --- a/billforward/models/amendment.py +++ b/billforward/models/amendment.py @@ -42,7 +42,7 @@ class Amendment(object): 'deleted': 'bool', 'discardable_subsystem_object': 'IDiscardable', 'amendment_type': 'str', - 'type': 'str' + 'at_type': 'str' } attribute_map = { @@ -60,7 +60,7 @@ class Amendment(object): 'deleted': 'deleted', 'discardable_subsystem_object': 'discardableSubsystemObject', 'amendment_type': 'amendmentType', - 'type': '@type' + 'at_type': '@type' } discriminator_value_class_map = { @@ -81,7 +81,7 @@ class Amendment(object): 'ServiceEndAmendment': 'ServiceEndAmendment', 'TimerAmendment': 'TimerAmendment' } - def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None, id=None, organization_id=None, subscription_id=None, description=None, actioning_time=None, actioned_time=None, state=None, deleted=None, discardable_subsystem_object=None, amendment_type=None, type=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None, id=None, organization_id=None, subscription_id=None, description=None, actioning_time=None, actioned_time=None, state=None, deleted=None, discardable_subsystem_object=None, amendment_type=None, at_type=None): # noqa: E501 """Amendment - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -97,7 +97,7 @@ def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None self._deleted = None self._discardable_subsystem_object = None self._amendment_type = None - self._type = None + self._at_type = None self.discriminator = '@type' if created is not None: self.created = created @@ -125,7 +125,7 @@ def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None self.discardable_subsystem_object = discardable_subsystem_object if amendment_type is not None: self.amendment_type = amendment_type - self.type = type + self.at_type = at_type @property def created(self): @@ -438,27 +438,27 @@ def amendment_type(self, amendment_type): self._amendment_type = amendment_type @property - def type(self): - """Gets the type of this Amendment. # noqa: E501 + def at_type(self): + """Gets the at_type of this Amendment. # noqa: E501 - :return: The type of this Amendment. # noqa: E501 + :return: The at_type of this Amendment. # noqa: E501 :rtype: str """ - return self._type + return self._at_type - @type.setter - def type(self, type): - """Sets the type of this Amendment. + @at_type.setter + def at_type(self, at_type): + """Sets the at_type of this Amendment. - :param type: The type of this Amendment. # noqa: E501 + :param at_type: The at_type of this Amendment. # noqa: E501 :type: str """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + if at_type is None: + raise ValueError("Invalid value for `at_type`, must not be `None`") # noqa: E501 - self._type = type + self._at_type = at_type def get_real_child_model(self, data): """Returns the real base class specified by the discriminator""" diff --git a/billforward/models/auth_capture_request.py b/billforward/models/auth_capture_request.py index 0a87e3a..ebe2e57 100644 --- a/billforward/models/auth_capture_request.py +++ b/billforward/models/auth_capture_request.py @@ -43,7 +43,7 @@ class AuthCaptureRequest(object): 'ip_address_country': 'str', 'email_tokenization_id': 'str', 'id': 'str', - 'type': 'str' + 'at_type': 'str' } attribute_map = { @@ -62,7 +62,7 @@ class AuthCaptureRequest(object): 'ip_address_country': 'ipAddressCountry', 'email_tokenization_id': 'emailTokenizationID', 'id': 'id', - 'type': '@type' + 'at_type': '@type' } discriminator_value_class_map = { @@ -76,7 +76,7 @@ class AuthCaptureRequest(object): 'ShuttleAuthCaptureRequest': 'ShuttleAuthCaptureRequest', 'StripeAuthCaptureRequest': 'StripeAuthCaptureRequest' } - def __init__(self, created=None, changed_by=None, account_id=None, gateway=None, company_name=None, email=None, first_name=None, last_name=None, mobile=None, default_payment_method=None, organization_id=None, ip_address=None, ip_address_country=None, email_tokenization_id=None, id=None, type=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, account_id=None, gateway=None, company_name=None, email=None, first_name=None, last_name=None, mobile=None, default_payment_method=None, organization_id=None, ip_address=None, ip_address_country=None, email_tokenization_id=None, id=None, at_type=None): # noqa: E501 """AuthCaptureRequest - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -93,7 +93,7 @@ def __init__(self, created=None, changed_by=None, account_id=None, gateway=None, self._ip_address_country = None self._email_tokenization_id = None self._id = None - self._type = None + self._at_type = None self.discriminator = '@type' if created is not None: self.created = created @@ -124,7 +124,7 @@ def __init__(self, created=None, changed_by=None, account_id=None, gateway=None, self.email_tokenization_id = email_tokenization_id if id is not None: self.id = id - self.type = type + self.at_type = at_type @property def created(self): @@ -450,27 +450,27 @@ def id(self, id): self._id = id @property - def type(self): - """Gets the type of this AuthCaptureRequest. # noqa: E501 + def at_type(self): + """Gets the at_type of this AuthCaptureRequest. # noqa: E501 - :return: The type of this AuthCaptureRequest. # noqa: E501 + :return: The at_type of this AuthCaptureRequest. # noqa: E501 :rtype: str """ - return self._type + return self._at_type - @type.setter - def type(self, type): - """Sets the type of this AuthCaptureRequest. + @at_type.setter + def at_type(self, at_type): + """Sets the at_type of this AuthCaptureRequest. - :param type: The type of this AuthCaptureRequest. # noqa: E501 + :param at_type: The at_type of this AuthCaptureRequest. # noqa: E501 :type: str """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + if at_type is None: + raise ValueError("Invalid value for `at_type`, must not be `None`") # noqa: E501 - self._type = type + self._at_type = at_type def get_real_child_model(self, data): """Returns the real base class specified by the discriminator""" diff --git a/billforward/models/payment.py b/billforward/models/payment.py index 36547c0..fd1934b 100644 --- a/billforward/models/payment.py +++ b/billforward/models/payment.py @@ -48,7 +48,7 @@ class Payment(object): 'refund_id': 'str', 'type': 'str', 'remaining_nominal_value': 'float', - 'type': 'str' + 'at_type': 'str' } attribute_map = { @@ -72,7 +72,7 @@ class Payment(object): 'refund_id': 'refundID', 'type': 'type', 'remaining_nominal_value': 'remainingNominalValue', - 'type': '@type' + 'at_type': '@type' } discriminator_value_class_map = { @@ -93,7 +93,7 @@ class Payment(object): 'EpxPayment': 'EpxPayment', 'PaypalPayment': 'PaypalPayment' } - def __init__(self, created=None, changed_by=None, updated=None, metadata=None, id=None, crm_id=None, account_id=None, subscription_id=None, payment_method_id=None, invoice_id=None, organization_id=None, gateway=None, currency=None, nominal_value=None, actual_value=None, payment_received=None, refunded_value=None, refund_id=None, type=None, remaining_nominal_value=None, type=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, metadata=None, id=None, crm_id=None, account_id=None, subscription_id=None, payment_method_id=None, invoice_id=None, organization_id=None, gateway=None, currency=None, nominal_value=None, actual_value=None, payment_received=None, refunded_value=None, refund_id=None, type=None, remaining_nominal_value=None, at_type=None): # noqa: E501 """Payment - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -115,7 +115,7 @@ def __init__(self, created=None, changed_by=None, updated=None, metadata=None, i self._refund_id = None self._type = None self._remaining_nominal_value = None - self._type = None + self._at_type = None self.discriminator = '@type' if created is not None: self.created = created @@ -152,7 +152,7 @@ def __init__(self, created=None, changed_by=None, updated=None, metadata=None, i self.refund_id = refund_id self.type = type self.remaining_nominal_value = remaining_nominal_value - self.type = type + self.at_type = at_type @property def created(self): @@ -597,27 +597,27 @@ def remaining_nominal_value(self, remaining_nominal_value): self._remaining_nominal_value = remaining_nominal_value @property - def type(self): - """Gets the type of this Payment. # noqa: E501 + def at_type(self): + """Gets the at_type of this Payment. # noqa: E501 - :return: The type of this Payment. # noqa: E501 + :return: The at_type of this Payment. # noqa: E501 :rtype: str """ - return self._type + return self._at_type - @type.setter - def type(self, type): - """Sets the type of this Payment. + @at_type.setter + def at_type(self, at_type): + """Sets the at_type of this Payment. - :param type: The type of this Payment. # noqa: E501 + :param at_type: The at_type of this Payment. # noqa: E501 :type: str """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + if at_type is None: + raise ValueError("Invalid value for `at_type`, must not be `None`") # noqa: E501 - self._type = type + self._at_type = at_type def get_real_child_model(self, data): """Returns the real base class specified by the discriminator""" diff --git a/billforward/models/pricing_component.py b/billforward/models/pricing_component.py index 1e1f326..9d51491 100644 --- a/billforward/models/pricing_component.py +++ b/billforward/models/pricing_component.py @@ -57,7 +57,7 @@ class PricingComponent(object): 'sorted_tiers': 'list[PricingComponentTier]', 'version_id': 'str', 'id': 'str', - 'type': 'str' + 'at_type': 'str' } attribute_map = { @@ -90,7 +90,7 @@ class PricingComponent(object): 'sorted_tiers': 'sortedTiers', 'version_id': 'versionID', 'id': 'id', - 'type': '@type' + 'at_type': '@type' } discriminator_value_class_map = { @@ -98,7 +98,7 @@ class PricingComponent(object): 'FlatPricingComponent': 'FlatPricingComponent', 'TieredVolumePricingComponent': 'TieredVolumePricingComponent' } - def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None, crm_id=None, product_rate_plan_id=None, product_rate_plan_version_id=None, unit_of_measure_id=None, organization_id=None, name=None, public_name=None, description=None, tax_code=None, charge_type=None, invoicing_type=None, charge_model=None, upgrade_mode=None, downgrade_mode=None, default_quantity=None, min_quantity=None, max_quantity=None, valid_from=None, valid_till=None, unit_credit=None, tiers=None, unit_of_measure=None, sorted_tiers=None, version_id=None, id=None, type=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None, crm_id=None, product_rate_plan_id=None, product_rate_plan_version_id=None, unit_of_measure_id=None, organization_id=None, name=None, public_name=None, description=None, tax_code=None, charge_type=None, invoicing_type=None, charge_model=None, upgrade_mode=None, downgrade_mode=None, default_quantity=None, min_quantity=None, max_quantity=None, valid_from=None, valid_till=None, unit_credit=None, tiers=None, unit_of_measure=None, sorted_tiers=None, version_id=None, id=None, at_type=None): # noqa: E501 """PricingComponent - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -129,7 +129,7 @@ def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None self._sorted_tiers = None self._version_id = None self._id = None - self._type = None + self._at_type = None self.discriminator = '@type' if created is not None: self.created = created @@ -181,7 +181,7 @@ def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None if version_id is not None: self.version_id = version_id self.id = id - self.type = type + self.at_type = at_type @property def created(self): @@ -839,27 +839,27 @@ def id(self, id): self._id = id @property - def type(self): - """Gets the type of this PricingComponent. # noqa: E501 + def at_type(self): + """Gets the at_type of this PricingComponent. # noqa: E501 - :return: The type of this PricingComponent. # noqa: E501 + :return: The at_type of this PricingComponent. # noqa: E501 :rtype: str """ - return self._type + return self._at_type - @type.setter - def type(self, type): - """Sets the type of this PricingComponent. + @at_type.setter + def at_type(self, at_type): + """Sets the at_type of this PricingComponent. - :param type: The type of this PricingComponent. # noqa: E501 + :param at_type: The at_type of this PricingComponent. # noqa: E501 :type: str """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + if at_type is None: + raise ValueError("Invalid value for `at_type`, must not be `None`") # noqa: E501 - self._type = type + self._at_type = at_type def get_real_child_model(self, data): """Returns the real base class specified by the discriminator""" diff --git a/billforward/models/subscription_charge.py b/billforward/models/subscription_charge.py index ef47772..1116412 100644 --- a/billforward/models/subscription_charge.py +++ b/billforward/models/subscription_charge.py @@ -60,7 +60,7 @@ class SubscriptionCharge(object): 'group_name': 'str', 'outer_period_start': 'datetime', 'crm_id': 'str', - 'type': 'str' + 'at_type': 'str' } attribute_map = { @@ -96,7 +96,7 @@ class SubscriptionCharge(object): 'group_name': 'groupName', 'outer_period_start': 'outerPeriodStart', 'crm_id': 'crmID', - 'type': '@type' + 'at_type': '@type' } discriminator_value_class_map = { @@ -110,7 +110,7 @@ class SubscriptionCharge(object): 'UpgradeCharge': 'UpgradeCharge', 'PricingComponentCharge': 'PricingComponentCharge' } - def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, subscription_id=None, subscription_version_id=None, invoice_id=None, organization_id=None, name=None, description=None, tax_code=None, amount=None, amount_excluding_tax=None, currency=None, period_start=None, period_end=None, type=None, invoicing_type=None, state=None, charge_type=None, calculation=None, remaining_credit_behaviour=None, trial=None, version_id=None, version_number=None, linked_charge_id=None, percentage_of_original=None, original_charge_id=None, group_name=None, outer_period_start=None, crm_id=None, type=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, id=None, account_id=None, subscription_id=None, subscription_version_id=None, invoice_id=None, organization_id=None, name=None, description=None, tax_code=None, amount=None, amount_excluding_tax=None, currency=None, period_start=None, period_end=None, type=None, invoicing_type=None, state=None, charge_type=None, calculation=None, remaining_credit_behaviour=None, trial=None, version_id=None, version_number=None, linked_charge_id=None, percentage_of_original=None, original_charge_id=None, group_name=None, outer_period_start=None, crm_id=None, at_type=None): # noqa: E501 """SubscriptionCharge - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -144,7 +144,7 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, account self._group_name = None self._outer_period_start = None self._crm_id = None - self._type = None + self._at_type = None self.discriminator = '@type' if created is not None: self.created = created @@ -204,7 +204,7 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, account self.outer_period_start = outer_period_start if crm_id is not None: self.crm_id = crm_id - self.type = type + self.at_type = at_type @property def created(self): @@ -921,27 +921,27 @@ def crm_id(self, crm_id): self._crm_id = crm_id @property - def type(self): - """Gets the type of this SubscriptionCharge. # noqa: E501 + def at_type(self): + """Gets the at_type of this SubscriptionCharge. # noqa: E501 - :return: The type of this SubscriptionCharge. # noqa: E501 + :return: The at_type of this SubscriptionCharge. # noqa: E501 :rtype: str """ - return self._type + return self._at_type - @type.setter - def type(self, type): - """Sets the type of this SubscriptionCharge. + @at_type.setter + def at_type(self, at_type): + """Sets the at_type of this SubscriptionCharge. - :param type: The type of this SubscriptionCharge. # noqa: E501 + :param at_type: The at_type of this SubscriptionCharge. # noqa: E501 :type: str """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + if at_type is None: + raise ValueError("Invalid value for `at_type`, must not be `None`") # noqa: E501 - self._type = type + self._at_type = at_type def get_real_child_model(self, data): """Returns the real base class specified by the discriminator""" diff --git a/billforward/models/tokenization_pre_auth_request.py b/billforward/models/tokenization_pre_auth_request.py index 6498be9..ac2b34d 100644 --- a/billforward/models/tokenization_pre_auth_request.py +++ b/billforward/models/tokenization_pre_auth_request.py @@ -37,7 +37,7 @@ class TokenizationPreAuthRequest(object): 'bill_forward_public_token': 'str', 'email_tokenization_id': 'str', 'id': 'str', - 'type': 'str' + 'at_type': 'str' } attribute_map = { @@ -50,7 +50,7 @@ class TokenizationPreAuthRequest(object): 'bill_forward_public_token': 'billForwardPublicToken', 'email_tokenization_id': 'emailTokenizationID', 'id': 'id', - 'type': '@type' + 'at_type': '@type' } discriminator_value_class_map = { @@ -61,7 +61,7 @@ class TokenizationPreAuthRequest(object): 'BraintreePreAuthRequest': 'BraintreePreAuthRequest', 'ShuttlePreAuthRequest': 'ShuttlePreAuthRequest' } - def __init__(self, created=None, changed_by=None, gateway_id=None, gateway=None, organization_id=None, bill_forward_url=None, bill_forward_public_token=None, email_tokenization_id=None, id=None, type=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, gateway_id=None, gateway=None, organization_id=None, bill_forward_url=None, bill_forward_public_token=None, email_tokenization_id=None, id=None, at_type=None): # noqa: E501 """TokenizationPreAuthRequest - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -72,7 +72,7 @@ def __init__(self, created=None, changed_by=None, gateway_id=None, gateway=None, self._bill_forward_public_token = None self._email_tokenization_id = None self._id = None - self._type = None + self._at_type = None self.discriminator = '@type' if created is not None: self.created = created @@ -92,7 +92,7 @@ def __init__(self, created=None, changed_by=None, gateway_id=None, gateway=None, self.email_tokenization_id = email_tokenization_id if id is not None: self.id = id - self.type = type + self.at_type = at_type @property def created(self): @@ -290,27 +290,27 @@ def id(self, id): self._id = id @property - def type(self): - """Gets the type of this TokenizationPreAuthRequest. # noqa: E501 + def at_type(self): + """Gets the at_type of this TokenizationPreAuthRequest. # noqa: E501 - :return: The type of this TokenizationPreAuthRequest. # noqa: E501 + :return: The at_type of this TokenizationPreAuthRequest. # noqa: E501 :rtype: str """ - return self._type + return self._at_type - @type.setter - def type(self, type): - """Sets the type of this TokenizationPreAuthRequest. + @at_type.setter + def at_type(self, at_type): + """Sets the at_type of this TokenizationPreAuthRequest. - :param type: The type of this TokenizationPreAuthRequest. # noqa: E501 + :param at_type: The at_type of this TokenizationPreAuthRequest. # noqa: E501 :type: str """ - if type is None: - raise ValueError("Invalid value for `type`, must not be `None`") # noqa: E501 + if at_type is None: + raise ValueError("Invalid value for `at_type`, must not be `None`") # noqa: E501 - self._type = type + self._at_type = at_type def get_real_child_model(self, data): """Returns the real base class specified by the discriminator""" diff --git a/docs/AdditionalData.md b/docs/AdditionalData.md index 4c9b3a7..7940ea4 100644 --- a/docs/AdditionalData.md +++ b/docs/AdditionalData.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | | +**at_type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Amendment.md b/docs/Amendment.md index 44ce319..dd18509 100644 --- a/docs/Amendment.md +++ b/docs/Amendment.md @@ -17,7 +17,7 @@ Name | Type | Description | Notes **deleted** | **bool** | | **discardable_subsystem_object** | [**IDiscardable**](IDiscardable.md) | | [optional] **amendment_type** | **str** | | [optional] -**type** | **str** | | +**at_type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AuthCaptureRequest.md b/docs/AuthCaptureRequest.md index 5a12baa..88de41d 100644 --- a/docs/AuthCaptureRequest.md +++ b/docs/AuthCaptureRequest.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes **ip_address_country** | **str** | | [optional] **email_tokenization_id** | **str** | | [optional] **id** | **str** | | [optional] -**type** | **str** | | +**at_type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Payment.md b/docs/Payment.md index d840854..8437c51 100644 --- a/docs/Payment.md +++ b/docs/Payment.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes **refund_id** | **str** | | [optional] **type** | **str** | | **remaining_nominal_value** | **float** | | -**type** | **str** | | +**at_type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PricingComponent.md b/docs/PricingComponent.md index 4a345f1..620e4e3 100644 --- a/docs/PricingComponent.md +++ b/docs/PricingComponent.md @@ -32,7 +32,7 @@ Name | Type | Description | Notes **sorted_tiers** | [**list[PricingComponentTier]**](PricingComponentTier.md) | | [optional] **version_id** | **str** | | [optional] **id** | **str** | | -**type** | **str** | | +**at_type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SubscriptionCharge.md b/docs/SubscriptionCharge.md index c9bc3b4..b496b9b 100644 --- a/docs/SubscriptionCharge.md +++ b/docs/SubscriptionCharge.md @@ -35,7 +35,7 @@ Name | Type | Description | Notes **group_name** | **str** | | [optional] **outer_period_start** | **datetime** | | [optional] **crm_id** | **str** | | [optional] -**type** | **str** | | +**at_type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TokenizationPreAuthRequest.md b/docs/TokenizationPreAuthRequest.md index 1502f6f..7856ebd 100644 --- a/docs/TokenizationPreAuthRequest.md +++ b/docs/TokenizationPreAuthRequest.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **bill_forward_public_token** | **str** | | [optional] **email_tokenization_id** | **str** | | [optional] **id** | **str** | | [optional] -**type** | **str** | | +**at_type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) From 48f9c3a13371297d9667e2d93ec2fc4c16190f7f Mon Sep 17 00:00:00 2001 From: Mat Jaggard Date: Wed, 8 Dec 2021 17:44:46 +0000 Subject: [PATCH 7/8] Remove deprecated calls --- .swagger-codegen/VERSION | 2 +- README.md | 21 +- billforward/__init__.py | 5 - billforward/api/security_api.py | 78 +- billforward/api/tokenization_api.py | 513 ++-------- billforward/api/webhooks_api.py | 48 +- billforward/models/__init__.py | 5 - .../affiliate_rate_plan_relationships.py | 58 +- billforward/models/amendment.py | 54 +- billforward/models/api_configuration.py | 54 +- billforward/models/epx_capture_request.py | 786 --------------- billforward/models/epx_pre_auth_request.py | 266 ----- billforward/models/epx_pre_auth_response.py | 370 ------- .../models/inline_response_default100.py | 6 +- .../models/inline_response_default101.py | 158 +-- .../models/inline_response_default102.py | 6 +- .../models/inline_response_default103.py | 138 --- .../models/inline_response_default79.py | 6 +- .../models/inline_response_default80.py | 158 ++- .../models/inline_response_default81.py | 164 +--- .../models/inline_response_default82.py | 6 +- .../models/inline_response_default83.py | 6 +- .../models/inline_response_default84.py | 164 +++- .../models/inline_response_default85.py | 164 +--- .../models/inline_response_default86.py | 164 +++- .../models/inline_response_default87.py | 6 +- .../models/inline_response_default88.py | 164 +--- .../models/inline_response_default89.py | 6 +- .../models/inline_response_default90.py | 6 +- .../models/inline_response_default91.py | 6 +- .../models/inline_response_default92.py | 6 +- .../models/inline_response_default93.py | 6 +- .../models/inline_response_default94.py | 6 +- .../models/inline_response_default95.py | 6 +- .../models/inline_response_default96.py | 6 +- .../models/inline_response_default97.py | 164 +++- .../models/inline_response_default98.py | 6 +- .../models/inline_response_default99.py | 6 +- billforward/models/invoice.py | 28 +- .../invoice_template_config_response.py | 2 +- .../models/pay_vision_configuration.py | 58 +- billforward/models/refund.py | 54 +- billforward/models/shuttle_configuration.py | 58 +- .../models/tokenization_epxredirect_body.py | 916 ------------------ .../models/trust_commerce_configuration.py | 52 +- .../typed_query_result_wrapper_account.py | 54 +- .../typed_query_result_wrapper_address.py | 54 +- .../typed_query_result_wrapper_amendment.py | 54 +- .../typed_query_result_wrapper_api_quote.py | 54 +- ...ery_result_wrapper_avatax_configuration.py | 54 +- ...yped_query_result_wrapper_bf_permission.py | 54 +- ...ed_query_result_wrapper_braintree_token.py | 54 +- .../typed_query_result_wrapper_contract.py | 54 +- .../typed_query_result_wrapper_coupon.py | 54 +- .../typed_query_result_wrapper_credit_note.py | 54 +- ...y_result_wrapper_data_sync_job_response.py | 54 +- ...typed_query_result_wrapper_dunning_line.py | 54 +- .../typed_query_result_wrapper_invoice.py | 54 +- ...ery_result_wrapper_invoice_line_payment.py | 54 +- ...typed_query_result_wrapper_notification.py | 54 +- .../typed_query_result_wrapper_payment.py | 54 +- ...ped_query_result_wrapper_payment_method.py | 54 +- ...yped_query_result_wrapper_plan_response.py | 54 +- .../typed_query_result_wrapper_profile.py | 54 +- .../typed_query_result_wrapper_receipt.py | 54 +- .../typed_query_result_wrapper_refund.py | 54 +- ...uery_result_wrapper_revenue_attribution.py | 54 +- .../models/typed_query_result_wrapper_role.py | 54 +- ...d_query_result_wrapper_stripe_ach_token.py | 54 +- ...typed_query_result_wrapper_stripe_token.py | 54 +- ...typed_query_result_wrapper_subscription.py | 54 +- ...uery_result_wrapper_subscription_charge.py | 54 +- ..._query_result_wrapper_taxation_strategy.py | 54 +- ...yped_query_result_wrapper_user_response.py | 54 +- .../typed_query_result_wrapper_webhook.py | 54 +- .../models/update_invoice_template_request.py | 2 +- billforward/models/user.py | 58 +- billforward/models/webhook.py | 28 +- docs/APIConfiguration.md | 2 +- docs/AffiliateRatePlanRelationships.md | 2 +- docs/Amendment.md | 2 +- docs/InlineResponseDefault100.md | 2 +- docs/InlineResponseDefault101.md | 6 - docs/InlineResponseDefault102.md | 2 +- docs/InlineResponseDefault79.md | 2 +- docs/InlineResponseDefault80.md | 6 + docs/InlineResponseDefault81.md | 8 +- docs/InlineResponseDefault82.md | 2 +- docs/InlineResponseDefault83.md | 2 +- docs/InlineResponseDefault84.md | 8 +- docs/InlineResponseDefault85.md | 8 +- docs/InlineResponseDefault86.md | 8 +- docs/InlineResponseDefault87.md | 2 +- docs/InlineResponseDefault88.md | 8 +- docs/InlineResponseDefault89.md | 2 +- docs/InlineResponseDefault90.md | 2 +- docs/InlineResponseDefault91.md | 2 +- docs/InlineResponseDefault92.md | 2 +- docs/InlineResponseDefault93.md | 2 +- docs/InlineResponseDefault94.md | 2 +- docs/InlineResponseDefault95.md | 2 +- docs/InlineResponseDefault96.md | 2 +- docs/InlineResponseDefault97.md | 8 +- docs/InlineResponseDefault98.md | 2 +- docs/InlineResponseDefault99.md | 2 +- docs/Invoice.md | 1 + docs/PayVisionConfiguration.md | 2 +- docs/Refund.md | 2 +- docs/SecurityApi.md | 52 +- docs/ShuttleConfiguration.md | 2 +- docs/TokenizationApi.md | 278 +----- docs/TrustCommerceConfiguration.md | 2 +- docs/TypedQueryResultWrapperAPIQuote.md | 2 +- docs/TypedQueryResultWrapperAccount.md | 2 +- docs/TypedQueryResultWrapperAddress.md | 2 +- docs/TypedQueryResultWrapperAmendment.md | 2 +- ...edQueryResultWrapperAvataxConfiguration.md | 2 +- docs/TypedQueryResultWrapperBFPermission.md | 2 +- docs/TypedQueryResultWrapperBraintreeToken.md | 2 +- docs/TypedQueryResultWrapperContract.md | 2 +- docs/TypedQueryResultWrapperCoupon.md | 2 +- docs/TypedQueryResultWrapperCreditNote.md | 2 +- ...edQueryResultWrapperDataSyncJobResponse.md | 2 +- docs/TypedQueryResultWrapperDunningLine.md | 2 +- docs/TypedQueryResultWrapperInvoice.md | 2 +- ...pedQueryResultWrapperInvoiceLinePayment.md | 2 +- docs/TypedQueryResultWrapperNotification.md | 2 +- docs/TypedQueryResultWrapperPayment.md | 2 +- docs/TypedQueryResultWrapperPaymentMethod.md | 2 +- docs/TypedQueryResultWrapperPlanResponse.md | 2 +- docs/TypedQueryResultWrapperProfile.md | 2 +- docs/TypedQueryResultWrapperReceipt.md | 2 +- docs/TypedQueryResultWrapperRefund.md | 2 +- ...pedQueryResultWrapperRevenueAttribution.md | 2 +- docs/TypedQueryResultWrapperRole.md | 2 +- docs/TypedQueryResultWrapperStripeACHToken.md | 2 +- docs/TypedQueryResultWrapperStripeToken.md | 2 +- docs/TypedQueryResultWrapperSubscription.md | 2 +- ...pedQueryResultWrapperSubscriptionCharge.md | 2 +- ...TypedQueryResultWrapperTaxationStrategy.md | 2 +- docs/TypedQueryResultWrapperUserResponse.md | 2 +- docs/TypedQueryResultWrapperWebhook.md | 2 +- docs/User.md | 2 +- docs/Webhook.md | 1 - docs/WebhooksApi.md | 32 +- 145 files changed, 2052 insertions(+), 5150 deletions(-) delete mode 100644 billforward/models/epx_capture_request.py delete mode 100644 billforward/models/epx_pre_auth_request.py delete mode 100644 billforward/models/epx_pre_auth_response.py delete mode 100644 billforward/models/inline_response_default103.py delete mode 100644 billforward/models/tokenization_epxredirect_body.py diff --git a/.swagger-codegen/VERSION b/.swagger-codegen/VERSION index ae2f493..6738154 100644 --- a/.swagger-codegen/VERSION +++ b/.swagger-codegen/VERSION @@ -1 +1 @@ -3.0.31-SNAPSHOT-Billforward +3.0.31-SNAPSHOT \ No newline at end of file diff --git a/README.md b/README.md index ae8145d..4159f56 100644 --- a/README.md +++ b/README.md @@ -9,21 +9,21 @@ This Python package is automatically generated by the [Swagger Codegen](https:// ## Requirements. -Python 3.4+ +Python 2.7 and 3.4+ ## Installation & Usage ### pip install -The python package is hosted on Github, you can install directly from Github +If the python package is hosted on Github, you can install directly from Github ```sh -pip install git+https://github.com/billforward/bf-python.git +pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git ``` -(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/billforward/bf-python.git`) +(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`) Then import the package: ```python -import billforward +import billforward ``` ### Setuptools @@ -51,9 +51,6 @@ import billforward from billforward.rest import ApiException from pprint import pprint -billforward.Configuration.api_key = '>> result = thread.get() :param async_req bool - :return: InlineResponseDefault87 + :return: InlineResponseDefault86 If the method is called asynchronously, returns the request thread. """ @@ -540,7 +540,7 @@ def get_my_organizations_with_http_info(self, **kwargs): # noqa: E501 >>> result = thread.get() :param async_req bool - :return: InlineResponseDefault87 + :return: InlineResponseDefault86 If the method is called asynchronously, returns the request thread. """ @@ -588,7 +588,7 @@ def get_my_organizations_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault87', # noqa: E501 + response_type='InlineResponseDefault86', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -805,7 +805,7 @@ def get_simple_all_users(self, **kwargs): # noqa: E501 :param int records: :param str order_by: :param str order: - :return: InlineResponseDefault85 + :return: InlineResponseDefault84 If the method is called asynchronously, returns the request thread. """ @@ -830,7 +830,7 @@ def get_simple_all_users_with_http_info(self, **kwargs): # noqa: E501 :param int records: :param str order_by: :param str order: - :return: InlineResponseDefault85 + :return: InlineResponseDefault84 If the method is called asynchronously, returns the request thread. """ @@ -889,7 +889,7 @@ def get_simple_all_users_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault85', # noqa: E501 + response_type='InlineResponseDefault84', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -993,7 +993,7 @@ def get_user_by_username(self, email, **kwargs): # noqa: E501 :param async_req bool :param str email: (required) :param list[str] organizations: - :return: InlineResponseDefault88 + :return: InlineResponseDefault87 If the method is called asynchronously, returns the request thread. """ @@ -1015,7 +1015,7 @@ def get_user_by_username_with_http_info(self, email, **kwargs): # noqa: E501 :param async_req bool :param str email: (required) :param list[str] organizations: - :return: InlineResponseDefault88 + :return: InlineResponseDefault87 If the method is called asynchronously, returns the request thread. """ @@ -1072,7 +1072,7 @@ def get_user_by_username_with_http_info(self, email, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault88', # noqa: E501 + response_type='InlineResponseDefault87', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1090,7 +1090,7 @@ def invite_user_login(self, **kwargs): # noqa: E501 :param async_req bool :param UserInviteRequest body: - :return: InlineResponseDefault84 + :return: InlineResponseDefault83 If the method is called asynchronously, returns the request thread. """ @@ -1111,7 +1111,7 @@ def invite_user_login_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param UserInviteRequest body: - :return: InlineResponseDefault84 + :return: InlineResponseDefault83 If the method is called asynchronously, returns the request thread. """ @@ -1165,7 +1165,7 @@ def invite_user_login_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault84', # noqa: E501 + response_type='InlineResponseDefault83', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1183,7 +1183,7 @@ def link_open_id_token_to_user(self, **kwargs): # noqa: E501 :param async_req bool :param OpenIdUserLinkRequest body: - :return: InlineResponseDefault89 + :return: InlineResponseDefault88 If the method is called asynchronously, returns the request thread. """ @@ -1204,7 +1204,7 @@ def link_open_id_token_to_user_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param OpenIdUserLinkRequest body: - :return: InlineResponseDefault89 + :return: InlineResponseDefault88 If the method is called asynchronously, returns the request thread. """ @@ -1258,7 +1258,7 @@ def link_open_id_token_to_user_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault89', # noqa: E501 + response_type='InlineResponseDefault88', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1483,7 +1483,7 @@ def request_password_reset_code(self, **kwargs): # noqa: E501 :param async_req bool :param PasswordResetCodeRequest body: - :return: InlineResponseDefault90 + :return: InlineResponseDefault89 If the method is called asynchronously, returns the request thread. """ @@ -1504,7 +1504,7 @@ def request_password_reset_code_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param PasswordResetCodeRequest body: - :return: InlineResponseDefault90 + :return: InlineResponseDefault89 If the method is called asynchronously, returns the request thread. """ @@ -1558,7 +1558,7 @@ def request_password_reset_code_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault90', # noqa: E501 + response_type='InlineResponseDefault89', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1676,7 +1676,7 @@ def update_email(self, email, **kwargs): # noqa: E501 :param str email: (required) :param UpdateEmailRequest body: :param list[str] organizations: - :return: InlineResponseDefault86 + :return: InlineResponseDefault85 If the method is called asynchronously, returns the request thread. """ @@ -1699,7 +1699,7 @@ def update_email_with_http_info(self, email, **kwargs): # noqa: E501 :param str email: (required) :param UpdateEmailRequest body: :param list[str] organizations: - :return: InlineResponseDefault86 + :return: InlineResponseDefault85 If the method is called asynchronously, returns the request thread. """ @@ -1762,7 +1762,7 @@ def update_email_with_http_info(self, email, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault86', # noqa: E501 + response_type='InlineResponseDefault85', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1875,7 +1875,7 @@ def update_user_infos(self, email, **kwargs): # noqa: E501 :param str email: (required) :param UpdateUserInfoRequest body: :param list[str] organizations: - :return: InlineResponseDefault91 + :return: InlineResponseDefault90 If the method is called asynchronously, returns the request thread. """ @@ -1898,7 +1898,7 @@ def update_user_infos_with_http_info(self, email, **kwargs): # noqa: E501 :param str email: (required) :param UpdateUserInfoRequest body: :param list[str] organizations: - :return: InlineResponseDefault91 + :return: InlineResponseDefault90 If the method is called asynchronously, returns the request thread. """ @@ -1961,7 +1961,7 @@ def update_user_infos_with_http_info(self, email, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault91', # noqa: E501 + response_type='InlineResponseDefault90', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1981,7 +1981,7 @@ def update_user_password(self, email, **kwargs): # noqa: E501 :param str email: (required) :param UpdatePasswordRequest body: :param list[str] organizations: - :return: InlineResponseDefault92 + :return: InlineResponseDefault91 If the method is called asynchronously, returns the request thread. """ @@ -2004,7 +2004,7 @@ def update_user_password_with_http_info(self, email, **kwargs): # noqa: E501 :param str email: (required) :param UpdatePasswordRequest body: :param list[str] organizations: - :return: InlineResponseDefault92 + :return: InlineResponseDefault91 If the method is called asynchronously, returns the request thread. """ @@ -2067,7 +2067,7 @@ def update_user_password_with_http_info(self, email, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault92', # noqa: E501 + response_type='InlineResponseDefault91', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2085,7 +2085,7 @@ def update_user_password_with_reset_code(self, **kwargs): # noqa: E501 :param async_req bool :param PasswordUpdateWithResetCodeRequest body: - :return: InlineResponseDefault92 + :return: InlineResponseDefault91 If the method is called asynchronously, returns the request thread. """ @@ -2106,7 +2106,7 @@ def update_user_password_with_reset_code_with_http_info(self, **kwargs): # noqa :param async_req bool :param PasswordUpdateWithResetCodeRequest body: - :return: InlineResponseDefault92 + :return: InlineResponseDefault91 If the method is called asynchronously, returns the request thread. """ @@ -2160,7 +2160,7 @@ def update_user_password_with_reset_code_with_http_info(self, **kwargs): # noqa body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault92', # noqa: E501 + response_type='InlineResponseDefault91', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/billforward/api/tokenization_api.py b/billforward/api/tokenization_api.py index 3763862..6f775aa 100644 --- a/billforward/api/tokenization_api.py +++ b/billforward/api/tokenization_api.py @@ -228,7 +228,7 @@ def create_authorize_net_token(self, **kwargs): # noqa: E501 :param async_req bool :param AuthorizeNetToken body: - :return: InlineResponseDefault93 + :return: InlineResponseDefault92 If the method is called asynchronously, returns the request thread. """ @@ -249,7 +249,7 @@ def create_authorize_net_token_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param AuthorizeNetToken body: - :return: InlineResponseDefault93 + :return: InlineResponseDefault92 If the method is called asynchronously, returns the request thread. """ @@ -303,7 +303,7 @@ def create_authorize_net_token_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault93', # noqa: E501 + response_type='InlineResponseDefault92', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -321,7 +321,7 @@ def create_braintree_token(self, **kwargs): # noqa: E501 :param async_req bool :param BraintreeToken body: - :return: InlineResponseDefault94 + :return: InlineResponseDefault93 If the method is called asynchronously, returns the request thread. """ @@ -342,7 +342,7 @@ def create_braintree_token_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param BraintreeToken body: - :return: InlineResponseDefault94 + :return: InlineResponseDefault93 If the method is called asynchronously, returns the request thread. """ @@ -396,7 +396,7 @@ def create_braintree_token_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault94', # noqa: E501 + response_type='InlineResponseDefault93', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -414,7 +414,7 @@ def create_stripe_ach_token(self, **kwargs): # noqa: E501 :param async_req bool :param StripeAchToken body: - :return: InlineResponseDefault95 + :return: InlineResponseDefault94 If the method is called asynchronously, returns the request thread. """ @@ -435,7 +435,7 @@ def create_stripe_ach_token_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param StripeAchToken body: - :return: InlineResponseDefault95 + :return: InlineResponseDefault94 If the method is called asynchronously, returns the request thread. """ @@ -489,7 +489,7 @@ def create_stripe_ach_token_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault95', # noqa: E501 + response_type='InlineResponseDefault94', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -507,7 +507,7 @@ def create_stripe_token(self, **kwargs): # noqa: E501 :param async_req bool :param StripeToken body: - :return: InlineResponseDefault96 + :return: InlineResponseDefault95 If the method is called asynchronously, returns the request thread. """ @@ -528,7 +528,7 @@ def create_stripe_token_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param StripeToken body: - :return: InlineResponseDefault96 + :return: InlineResponseDefault95 If the method is called asynchronously, returns the request thread. """ @@ -582,7 +582,7 @@ def create_stripe_token_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault96', # noqa: E501 + response_type='InlineResponseDefault95', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -600,7 +600,7 @@ def create_trust_commerce_token(self, **kwargs): # noqa: E501 :param async_req bool :param TrustCommerceToken body: - :return: InlineResponseDefault97 + :return: InlineResponseDefault96 If the method is called asynchronously, returns the request thread. """ @@ -621,7 +621,7 @@ def create_trust_commerce_token_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param TrustCommerceToken body: - :return: InlineResponseDefault97 + :return: InlineResponseDefault96 If the method is called asynchronously, returns the request thread. """ @@ -675,7 +675,7 @@ def create_trust_commerce_token_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault97', # noqa: E501 + response_type='InlineResponseDefault96', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -773,405 +773,6 @@ def display_card_capture_form_with_http_info(self, **kwargs): # noqa: E501 _request_timeout=params.get('_request_timeout'), collection_formats=collection_formats) - def epx_card_capture(self, **kwargs): # noqa: E501 - """epx_card_capture # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.epx_card_capture(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param EpxCaptureRequest body: - :return: InlineResponseDefault40 - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.epx_card_capture_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.epx_card_capture_with_http_info(**kwargs) # noqa: E501 - return data - - def epx_card_capture_with_http_info(self, **kwargs): # noqa: E501 - """epx_card_capture # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.epx_card_capture_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param EpxCaptureRequest body: - :return: InlineResponseDefault40 - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['body'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in six.iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method epx_card_capture" % key - ) - params[key] = val - del params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'body' in params: - body_params = params['body'] - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['bearerAuth'] # noqa: E501 - - return self.api_client.call_api( - '/tokenization/epx', 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InlineResponseDefault40', # noqa: E501 - auth_settings=auth_settings, - async_req=params.get('async_req'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def epx_pre_auth(self, **kwargs): # noqa: E501 - """epx_pre_auth # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.epx_pre_auth(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param EpxPreAuthRequest body: - :return: InlineResponseDefault79 - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.epx_pre_auth_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.epx_pre_auth_with_http_info(**kwargs) # noqa: E501 - return data - - def epx_pre_auth_with_http_info(self, **kwargs): # noqa: E501 - """epx_pre_auth # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.epx_pre_auth_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param EpxPreAuthRequest body: - :return: InlineResponseDefault79 - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['body'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in six.iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method epx_pre_auth" % key - ) - params[key] = val - del params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - if 'body' in params: - body_params = params['body'] - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['bearerAuth'] # noqa: E501 - - return self.api_client.call_api( - '/tokenization/epx-pre-auth', 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='InlineResponseDefault79', # noqa: E501 - auth_settings=auth_settings, - async_req=params.get('async_req'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - - def epx_pre_auth_response(self, **kwargs): # noqa: E501 - """epx_pre_auth_response # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.epx_pre_auth_response(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str cust_nbr: - :param str merch_nbr: - :param str dba_nbr: - :param str terminal_nbr: - :param str tran_code: - :param str amount: - :param str auth_account: - :param str first_name: - :param str last_name: - :param str exp_date: - :param str bp_resp_code: - :param str bp_resp_text: - :param str bp_field_errors: - :param str msg_version: - :param str tran_type: - :param str tran_nbr: - :param str local_date: - :param str local_time: - :param str auth_guid: - :param str auth_resp: - :param str auth_code: - :param str auth_cvv2: - :param str auth_resp_text: - :param str auth_card_type: - :param str auth_tran_date_gmt: - :param str auth_amount_requested: - :param str auth_amount: - :param str auth_currency_code: - :param str network_response: - :param str auth_masked_account_nbr: - :param str user_data_9: - :param str user_data_10: - :return: None - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - if kwargs.get('async_req'): - return self.epx_pre_auth_response_with_http_info(**kwargs) # noqa: E501 - else: - (data) = self.epx_pre_auth_response_with_http_info(**kwargs) # noqa: E501 - return data - - def epx_pre_auth_response_with_http_info(self, **kwargs): # noqa: E501 - """epx_pre_auth_response # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.epx_pre_auth_response_with_http_info(async_req=True) - >>> result = thread.get() - - :param async_req bool - :param str cust_nbr: - :param str merch_nbr: - :param str dba_nbr: - :param str terminal_nbr: - :param str tran_code: - :param str amount: - :param str auth_account: - :param str first_name: - :param str last_name: - :param str exp_date: - :param str bp_resp_code: - :param str bp_resp_text: - :param str bp_field_errors: - :param str msg_version: - :param str tran_type: - :param str tran_nbr: - :param str local_date: - :param str local_time: - :param str auth_guid: - :param str auth_resp: - :param str auth_code: - :param str auth_cvv2: - :param str auth_resp_text: - :param str auth_card_type: - :param str auth_tran_date_gmt: - :param str auth_amount_requested: - :param str auth_amount: - :param str auth_currency_code: - :param str network_response: - :param str auth_masked_account_nbr: - :param str user_data_9: - :param str user_data_10: - :return: None - If the method is called asynchronously, - returns the request thread. - """ - - all_params = ['cust_nbr', 'merch_nbr', 'dba_nbr', 'terminal_nbr', 'tran_code', 'amount', 'auth_account', 'first_name', 'last_name', 'exp_date', 'bp_resp_code', 'bp_resp_text', 'bp_field_errors', 'msg_version', 'tran_type', 'tran_nbr', 'local_date', 'local_time', 'auth_guid', 'auth_resp', 'auth_code', 'auth_cvv2', 'auth_resp_text', 'auth_card_type', 'auth_tran_date_gmt', 'auth_amount_requested', 'auth_amount', 'auth_currency_code', 'network_response', 'auth_masked_account_nbr', 'user_data_9', 'user_data_10'] # noqa: E501 - all_params.append('async_req') - all_params.append('_return_http_data_only') - all_params.append('_preload_content') - all_params.append('_request_timeout') - - params = locals() - for key, val in six.iteritems(params['kwargs']): - if key not in all_params: - raise TypeError( - "Got an unexpected keyword argument '%s'" - " to method epx_pre_auth_response" % key - ) - params[key] = val - del params['kwargs'] - - collection_formats = {} - - path_params = {} - - query_params = [] - - header_params = {} - - form_params = [] - local_var_files = {} - if 'cust_nbr' in params: - form_params.append(('CUST_NBR', params['cust_nbr'])) # noqa: E501 - if 'merch_nbr' in params: - form_params.append(('MERCH_NBR', params['merch_nbr'])) # noqa: E501 - if 'dba_nbr' in params: - form_params.append(('DBA_NBR', params['dba_nbr'])) # noqa: E501 - if 'terminal_nbr' in params: - form_params.append(('TERMINAL_NBR', params['terminal_nbr'])) # noqa: E501 - if 'tran_code' in params: - form_params.append(('TRAN_CODE', params['tran_code'])) # noqa: E501 - if 'amount' in params: - form_params.append(('AMOUNT', params['amount'])) # noqa: E501 - if 'auth_account' in params: - form_params.append(('AUTH_ACCOUNT', params['auth_account'])) # noqa: E501 - if 'first_name' in params: - form_params.append(('FIRST_NAME', params['first_name'])) # noqa: E501 - if 'last_name' in params: - form_params.append(('LAST_NAME', params['last_name'])) # noqa: E501 - if 'exp_date' in params: - form_params.append(('EXP_DATE', params['exp_date'])) # noqa: E501 - if 'bp_resp_code' in params: - form_params.append(('BP_RESP_CODE', params['bp_resp_code'])) # noqa: E501 - if 'bp_resp_text' in params: - form_params.append(('BP_RESP_TEXT', params['bp_resp_text'])) # noqa: E501 - if 'bp_field_errors' in params: - form_params.append(('BP_FIELD_ERRORS', params['bp_field_errors'])) # noqa: E501 - if 'msg_version' in params: - form_params.append(('MSG_VERSION', params['msg_version'])) # noqa: E501 - if 'tran_type' in params: - form_params.append(('TRAN_TYPE', params['tran_type'])) # noqa: E501 - if 'tran_nbr' in params: - form_params.append(('TRAN_NBR', params['tran_nbr'])) # noqa: E501 - if 'local_date' in params: - form_params.append(('LOCAL_DATE', params['local_date'])) # noqa: E501 - if 'local_time' in params: - form_params.append(('LOCAL_TIME', params['local_time'])) # noqa: E501 - if 'auth_guid' in params: - form_params.append(('AUTH_GUID', params['auth_guid'])) # noqa: E501 - if 'auth_resp' in params: - form_params.append(('AUTH_RESP', params['auth_resp'])) # noqa: E501 - if 'auth_code' in params: - form_params.append(('AUTH_CODE', params['auth_code'])) # noqa: E501 - if 'auth_cvv2' in params: - form_params.append(('AUTH_CVV2', params['auth_cvv2'])) # noqa: E501 - if 'auth_resp_text' in params: - form_params.append(('AUTH_RESP_TEXT', params['auth_resp_text'])) # noqa: E501 - if 'auth_card_type' in params: - form_params.append(('AUTH_CARD_TYPE', params['auth_card_type'])) # noqa: E501 - if 'auth_tran_date_gmt' in params: - form_params.append(('AUTH_TRAN_DATE_GMT', params['auth_tran_date_gmt'])) # noqa: E501 - if 'auth_amount_requested' in params: - form_params.append(('AUTH_AMOUNT_REQUESTED', params['auth_amount_requested'])) # noqa: E501 - if 'auth_amount' in params: - form_params.append(('AUTH_AMOUNT', params['auth_amount'])) # noqa: E501 - if 'auth_currency_code' in params: - form_params.append(('AUTH_CURRENCY_CODE', params['auth_currency_code'])) # noqa: E501 - if 'network_response' in params: - form_params.append(('NETWORK_RESPONSE', params['network_response'])) # noqa: E501 - if 'auth_masked_account_nbr' in params: - form_params.append(('AUTH_MASKED_ACCOUNT_NBR', params['auth_masked_account_nbr'])) # noqa: E501 - if 'user_data_9' in params: - form_params.append(('USER_DATA_9', params['user_data_9'])) # noqa: E501 - if 'user_data_10' in params: - form_params.append(('USER_DATA_10', params['user_data_10'])) # noqa: E501 - - body_params = None - # HTTP header `Content-Type` - header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 - ['application/x-www-form-urlencoded']) # noqa: E501 - - # Authentication setting - auth_settings = ['bearerAuth'] # noqa: E501 - - return self.api_client.call_api( - '/tokenization/epx-redirect', 'POST', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type=None, # noqa: E501 - auth_settings=auth_settings, - async_req=params.get('async_req'), - _return_http_data_only=params.get('_return_http_data_only'), - _preload_content=params.get('_preload_content', True), - _request_timeout=params.get('_request_timeout'), - collection_formats=collection_formats) - def expire_email_redirect_capture(self, id, **kwargs): # noqa: E501 """expire_email_redirect_capture # noqa: E501 @@ -1183,7 +784,7 @@ def expire_email_redirect_capture(self, id, **kwargs): # noqa: E501 :param async_req bool :param str id: (required) :param list[str] organizations: - :return: InlineResponseDefault80 + :return: InlineResponseDefault79 If the method is called asynchronously, returns the request thread. """ @@ -1205,7 +806,7 @@ def expire_email_redirect_capture_with_http_info(self, id, **kwargs): # noqa: E :param async_req bool :param str id: (required) :param list[str] organizations: - :return: InlineResponseDefault80 + :return: InlineResponseDefault79 If the method is called asynchronously, returns the request thread. """ @@ -1262,7 +863,7 @@ def expire_email_redirect_capture_with_http_info(self, id, **kwargs): # noqa: E body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault80', # noqa: E501 + response_type='InlineResponseDefault79', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1283,7 +884,7 @@ def get_all_email_redirect_capture(self, **kwargs): # noqa: E501 :param str subscription_id: :param str invoice_id: :param list[str] organizations: - :return: InlineResponseDefault81 + :return: InlineResponseDefault80 If the method is called asynchronously, returns the request thread. """ @@ -1307,7 +908,7 @@ def get_all_email_redirect_capture_with_http_info(self, **kwargs): # noqa: E501 :param str subscription_id: :param str invoice_id: :param list[str] organizations: - :return: InlineResponseDefault81 + :return: InlineResponseDefault80 If the method is called asynchronously, returns the request thread. """ @@ -1364,7 +965,7 @@ def get_all_email_redirect_capture_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault81', # noqa: E501 + response_type='InlineResponseDefault80', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1383,7 +984,7 @@ def get_braintree_by_account_id(self, account_id, **kwargs): # noqa: E501 :param async_req bool :param str account_id: (required) :param list[str] organizations: - :return: InlineResponseDefault98 + :return: InlineResponseDefault97 If the method is called asynchronously, returns the request thread. """ @@ -1405,7 +1006,7 @@ def get_braintree_by_account_id_with_http_info(self, account_id, **kwargs): # n :param async_req bool :param str account_id: (required) :param list[str] organizations: - :return: InlineResponseDefault98 + :return: InlineResponseDefault97 If the method is called asynchronously, returns the request thread. """ @@ -1462,7 +1063,7 @@ def get_braintree_by_account_id_with_http_info(self, account_id, **kwargs): # n body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault98', # noqa: E501 + response_type='InlineResponseDefault97', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1481,7 +1082,7 @@ def get_by_card_details_id(self, card_details_id, **kwargs): # noqa: E501 :param async_req bool :param str card_details_id: (required) :param list[str] organizations: - :return: InlineResponseDefault99 + :return: InlineResponseDefault98 If the method is called asynchronously, returns the request thread. """ @@ -1503,7 +1104,7 @@ def get_by_card_details_id_with_http_info(self, card_details_id, **kwargs): # n :param async_req bool :param str card_details_id: (required) :param list[str] organizations: - :return: InlineResponseDefault99 + :return: InlineResponseDefault98 If the method is called asynchronously, returns the request thread. """ @@ -1560,7 +1161,7 @@ def get_by_card_details_id_with_http_info(self, card_details_id, **kwargs): # n body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault99', # noqa: E501 + response_type='InlineResponseDefault98', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1579,7 +1180,7 @@ def get_email_redirect_capture(self, id, **kwargs): # noqa: E501 :param async_req bool :param str id: (required) :param list[str] organizations: - :return: InlineResponseDefault80 + :return: InlineResponseDefault79 If the method is called asynchronously, returns the request thread. """ @@ -1601,7 +1202,7 @@ def get_email_redirect_capture_with_http_info(self, id, **kwargs): # noqa: E501 :param async_req bool :param str id: (required) :param list[str] organizations: - :return: InlineResponseDefault80 + :return: InlineResponseDefault79 If the method is called asynchronously, returns the request thread. """ @@ -1658,7 +1259,7 @@ def get_email_redirect_capture_with_http_info(self, id, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault80', # noqa: E501 + response_type='InlineResponseDefault79', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1771,7 +1372,7 @@ def get_stripe_ach(self, stripe_ach_token_id, **kwargs): # noqa: E501 :param async_req bool :param str stripe_ach_token_id: (required) :param list[str] organizations: - :return: InlineResponseDefault100 + :return: InlineResponseDefault99 If the method is called asynchronously, returns the request thread. """ @@ -1793,7 +1394,7 @@ def get_stripe_ach_with_http_info(self, stripe_ach_token_id, **kwargs): # noqa: :param async_req bool :param str stripe_ach_token_id: (required) :param list[str] organizations: - :return: InlineResponseDefault100 + :return: InlineResponseDefault99 If the method is called asynchronously, returns the request thread. """ @@ -1850,7 +1451,7 @@ def get_stripe_ach_with_http_info(self, stripe_ach_token_id, **kwargs): # noqa: body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault100', # noqa: E501 + response_type='InlineResponseDefault99', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -1869,7 +1470,7 @@ def get_stripe_token(self, stripe_token_id, **kwargs): # noqa: E501 :param async_req bool :param str stripe_token_id: (required) :param list[str] organizations: - :return: InlineResponseDefault99 + :return: InlineResponseDefault98 If the method is called asynchronously, returns the request thread. """ @@ -1891,7 +1492,7 @@ def get_stripe_token_with_http_info(self, stripe_token_id, **kwargs): # noqa: E :param async_req bool :param str stripe_token_id: (required) :param list[str] organizations: - :return: InlineResponseDefault99 + :return: InlineResponseDefault98 If the method is called asynchronously, returns the request thread. """ @@ -1948,7 +1549,7 @@ def get_stripe_token_with_http_info(self, stripe_token_id, **kwargs): # noqa: E body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault99', # noqa: E501 + response_type='InlineResponseDefault98', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2152,7 +1753,7 @@ def pre_auth(self, **kwargs): # noqa: E501 :param async_req bool :param TokenizationPreAuthRequest body: - :return: InlineResponseDefault82 + :return: InlineResponseDefault81 If the method is called asynchronously, returns the request thread. """ @@ -2173,7 +1774,7 @@ def pre_auth_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param TokenizationPreAuthRequest body: - :return: InlineResponseDefault82 + :return: InlineResponseDefault81 If the method is called asynchronously, returns the request thread. """ @@ -2227,7 +1828,7 @@ def pre_auth_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault82', # noqa: E501 + response_type='InlineResponseDefault81', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2498,7 +2099,7 @@ def send_email_redirect_capture(self, id, **kwargs): # noqa: E501 :param async_req bool :param str id: (required) :param EmailTokenizationSendAPIRequest body: - :return: InlineResponseDefault80 + :return: InlineResponseDefault79 If the method is called asynchronously, returns the request thread. """ @@ -2520,7 +2121,7 @@ def send_email_redirect_capture_with_http_info(self, id, **kwargs): # noqa: E50 :param async_req bool :param str id: (required) :param EmailTokenizationSendAPIRequest body: - :return: InlineResponseDefault80 + :return: InlineResponseDefault79 If the method is called asynchronously, returns the request thread. """ @@ -2580,7 +2181,7 @@ def send_email_redirect_capture_with_http_info(self, id, **kwargs): # noqa: E50 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault80', # noqa: E501 + response_type='InlineResponseDefault79', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2598,7 +2199,7 @@ def start_email_redirect_capture(self, **kwargs): # noqa: E501 :param async_req bool :param EmailTokenizationCreateAPIRequest body: - :return: InlineResponseDefault80 + :return: InlineResponseDefault79 If the method is called asynchronously, returns the request thread. """ @@ -2619,7 +2220,7 @@ def start_email_redirect_capture_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param EmailTokenizationCreateAPIRequest body: - :return: InlineResponseDefault80 + :return: InlineResponseDefault79 If the method is called asynchronously, returns the request thread. """ @@ -2673,7 +2274,7 @@ def start_email_redirect_capture_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault80', # noqa: E501 + response_type='InlineResponseDefault79', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2874,7 +2475,7 @@ def update_email_redirect_capture(self, id, **kwargs): # noqa: E501 :param async_req bool :param str id: (required) :param EmailTokenizationUpdateAPIRequest body: - :return: InlineResponseDefault80 + :return: InlineResponseDefault79 If the method is called asynchronously, returns the request thread. """ @@ -2896,7 +2497,7 @@ def update_email_redirect_capture_with_http_info(self, id, **kwargs): # noqa: E :param async_req bool :param str id: (required) :param EmailTokenizationUpdateAPIRequest body: - :return: InlineResponseDefault80 + :return: InlineResponseDefault79 If the method is called asynchronously, returns the request thread. """ @@ -2956,7 +2557,7 @@ def update_email_redirect_capture_with_http_info(self, id, **kwargs): # noqa: E body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault80', # noqa: E501 + response_type='InlineResponseDefault79', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -2975,7 +2576,7 @@ def update_profile_with_token(self, **kwargs): # noqa: E501 :param async_req bool :param Profile body: :param str request_token: - :return: InlineResponseDefault83 + :return: InlineResponseDefault82 If the method is called asynchronously, returns the request thread. """ @@ -2997,7 +2598,7 @@ def update_profile_with_token_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param Profile body: :param str request_token: - :return: InlineResponseDefault83 + :return: InlineResponseDefault82 If the method is called asynchronously, returns the request thread. """ @@ -3053,7 +2654,7 @@ def update_profile_with_token_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault83', # noqa: E501 + response_type='InlineResponseDefault82', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3071,7 +2672,7 @@ def update_stripe_ach_token(self, **kwargs): # noqa: E501 :param async_req bool :param StripeAchToken body: - :return: InlineResponseDefault95 + :return: InlineResponseDefault94 If the method is called asynchronously, returns the request thread. """ @@ -3092,7 +2693,7 @@ def update_stripe_ach_token_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param StripeAchToken body: - :return: InlineResponseDefault95 + :return: InlineResponseDefault94 If the method is called asynchronously, returns the request thread. """ @@ -3146,7 +2747,7 @@ def update_stripe_ach_token_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault95', # noqa: E501 + response_type='InlineResponseDefault94', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -3164,7 +2765,7 @@ def update_stripe_token(self, **kwargs): # noqa: E501 :param async_req bool :param StripeToken body: - :return: InlineResponseDefault96 + :return: InlineResponseDefault95 If the method is called asynchronously, returns the request thread. """ @@ -3185,7 +2786,7 @@ def update_stripe_token_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param StripeToken body: - :return: InlineResponseDefault96 + :return: InlineResponseDefault95 If the method is called asynchronously, returns the request thread. """ @@ -3239,7 +2840,7 @@ def update_stripe_token_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault96', # noqa: E501 + response_type='InlineResponseDefault95', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/billforward/api/webhooks_api.py b/billforward/api/webhooks_api.py index 22ac814..83199c4 100644 --- a/billforward/api/webhooks_api.py +++ b/billforward/api/webhooks_api.py @@ -42,7 +42,7 @@ def create_webhook(self, **kwargs): # noqa: E501 :param async_req bool :param Webhook body: - :return: InlineResponseDefault102 + :return: InlineResponseDefault101 If the method is called asynchronously, returns the request thread. """ @@ -63,7 +63,7 @@ def create_webhook_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param Webhook body: - :return: InlineResponseDefault102 + :return: InlineResponseDefault101 If the method is called asynchronously, returns the request thread. """ @@ -117,7 +117,7 @@ def create_webhook_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault102', # noqa: E501 + response_type='InlineResponseDefault101', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -135,7 +135,7 @@ def create_webhook_v2(self, **kwargs): # noqa: E501 :param async_req bool :param LegacyCreateWebhookRequest body: - :return: InlineResponseDefault102 + :return: InlineResponseDefault101 If the method is called asynchronously, returns the request thread. """ @@ -156,7 +156,7 @@ def create_webhook_v2_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param LegacyCreateWebhookRequest body: - :return: InlineResponseDefault102 + :return: InlineResponseDefault101 If the method is called asynchronously, returns the request thread. """ @@ -210,7 +210,7 @@ def create_webhook_v2_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault102', # noqa: E501 + response_type='InlineResponseDefault101', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -233,7 +233,7 @@ def get_all_webhooks(self, **kwargs): # noqa: E501 :param str order_by: :param str order: :param bool include_retired: - :return: InlineResponseDefault101 + :return: InlineResponseDefault100 If the method is called asynchronously, returns the request thread. """ @@ -259,7 +259,7 @@ def get_all_webhooks_with_http_info(self, **kwargs): # noqa: E501 :param str order_by: :param str order: :param bool include_retired: - :return: InlineResponseDefault101 + :return: InlineResponseDefault100 If the method is called asynchronously, returns the request thread. """ @@ -320,7 +320,7 @@ def get_all_webhooks_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault101', # noqa: E501 + response_type='InlineResponseDefault100', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -338,7 +338,7 @@ def get_allowed_webhook_subscriptions(self, **kwargs): # noqa: E501 :param async_req bool :param list[str] organizations: - :return: InlineResponseDefault103 + :return: InlineResponseDefault102 If the method is called asynchronously, returns the request thread. """ @@ -359,7 +359,7 @@ def get_allowed_webhook_subscriptions_with_http_info(self, **kwargs): # noqa: E :param async_req bool :param list[str] organizations: - :return: InlineResponseDefault103 + :return: InlineResponseDefault102 If the method is called asynchronously, returns the request thread. """ @@ -410,7 +410,7 @@ def get_allowed_webhook_subscriptions_with_http_info(self, **kwargs): # noqa: E body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault103', # noqa: E501 + response_type='InlineResponseDefault102', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -429,7 +429,7 @@ def get_webhook_by_id(self, webhook_id, **kwargs): # noqa: E501 :param async_req bool :param str webhook_id: (required) :param list[str] organizations: - :return: InlineResponseDefault102 + :return: InlineResponseDefault101 If the method is called asynchronously, returns the request thread. """ @@ -451,7 +451,7 @@ def get_webhook_by_id_with_http_info(self, webhook_id, **kwargs): # noqa: E501 :param async_req bool :param str webhook_id: (required) :param list[str] organizations: - :return: InlineResponseDefault102 + :return: InlineResponseDefault101 If the method is called asynchronously, returns the request thread. """ @@ -508,7 +508,7 @@ def get_webhook_by_id_with_http_info(self, webhook_id, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault102', # noqa: E501 + response_type='InlineResponseDefault101', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -527,7 +527,7 @@ def retire_webhook(self, webhook_id, **kwargs): # noqa: E501 :param async_req bool :param str webhook_id: (required) :param list[str] organizations: - :return: InlineResponseDefault102 + :return: InlineResponseDefault101 If the method is called asynchronously, returns the request thread. """ @@ -549,7 +549,7 @@ def retire_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501 :param async_req bool :param str webhook_id: (required) :param list[str] organizations: - :return: InlineResponseDefault102 + :return: InlineResponseDefault101 If the method is called asynchronously, returns the request thread. """ @@ -606,7 +606,7 @@ def retire_webhook_with_http_info(self, webhook_id, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault102', # noqa: E501 + response_type='InlineResponseDefault101', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -624,7 +624,7 @@ def update_webhook(self, **kwargs): # noqa: E501 :param async_req bool :param Webhook body: - :return: InlineResponseDefault102 + :return: InlineResponseDefault101 If the method is called asynchronously, returns the request thread. """ @@ -645,7 +645,7 @@ def update_webhook_with_http_info(self, **kwargs): # noqa: E501 :param async_req bool :param Webhook body: - :return: InlineResponseDefault102 + :return: InlineResponseDefault101 If the method is called asynchronously, returns the request thread. """ @@ -699,7 +699,7 @@ def update_webhook_with_http_info(self, **kwargs): # noqa: E501 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault102', # noqa: E501 + response_type='InlineResponseDefault101', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), @@ -718,7 +718,7 @@ def verify_webhook(self, verification_id, **kwargs): # noqa: E501 :param async_req bool :param str verification_id: (required) :param list[str] organizations: - :return: InlineResponseDefault102 + :return: InlineResponseDefault101 If the method is called asynchronously, returns the request thread. """ @@ -740,7 +740,7 @@ def verify_webhook_with_http_info(self, verification_id, **kwargs): # noqa: E50 :param async_req bool :param str verification_id: (required) :param list[str] organizations: - :return: InlineResponseDefault102 + :return: InlineResponseDefault101 If the method is called asynchronously, returns the request thread. """ @@ -797,7 +797,7 @@ def verify_webhook_with_http_info(self, verification_id, **kwargs): # noqa: E50 body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponseDefault102', # noqa: E501 + response_type='InlineResponseDefault101', # noqa: E501 auth_settings=auth_settings, async_req=params.get('async_req'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/billforward/models/__init__.py b/billforward/models/__init__.py index 922046a..8f75968 100644 --- a/billforward/models/__init__.py +++ b/billforward/models/__init__.py @@ -118,11 +118,8 @@ from billforward.models.email_tokenization_send_api_request import EmailTokenizationSendAPIRequest from billforward.models.email_tokenization_update_api_request import EmailTokenizationUpdateAPIRequest from billforward.models.end_trial_amendment import EndTrialAmendment -from billforward.models.epx_capture_request import EpxCaptureRequest from billforward.models.epx_configuration import EpxConfiguration from billforward.models.epx_payment import EpxPayment -from billforward.models.epx_pre_auth_request import EpxPreAuthRequest -from billforward.models.epx_pre_auth_response import EpxPreAuthResponse from billforward.models.execution_receipt_response import ExecutionReceiptResponse from billforward.models.execution_response import ExecutionResponse from billforward.models.extras import Extras @@ -152,7 +149,6 @@ from billforward.models.inline_response_default100 import InlineResponseDefault100 from billforward.models.inline_response_default101 import InlineResponseDefault101 from billforward.models.inline_response_default102 import InlineResponseDefault102 -from billforward.models.inline_response_default103 import InlineResponseDefault103 from billforward.models.inline_response_default11 import InlineResponseDefault11 from billforward.models.inline_response_default12 import InlineResponseDefault12 from billforward.models.inline_response_default13 import InlineResponseDefault13 @@ -406,7 +402,6 @@ from billforward.models.time_request import TimeRequest from billforward.models.time_response import TimeResponse from billforward.models.timer_amendment import TimerAmendment -from billforward.models.tokenization_epxredirect_body import TokenizationEpxredirectBody from billforward.models.tokenization_payvisionshoutv1_body import TokenizationPayvisionshoutv1Body from billforward.models.tokenization_pre_auth import TokenizationPreAuth from billforward.models.tokenization_pre_auth_request import TokenizationPreAuthRequest diff --git a/billforward/models/affiliate_rate_plan_relationships.py b/billforward/models/affiliate_rate_plan_relationships.py index 94e8b78..7358899 100644 --- a/billforward/models/affiliate_rate_plan_relationships.py +++ b/billforward/models/affiliate_rate_plan_relationships.py @@ -37,8 +37,8 @@ class AffiliateRatePlanRelationships(object): 'product_rate_plan_id': 'str', 'start_date': 'datetime', 'end_date': 'datetime', - 'account_id': 'str', - 'interval': 'IntervalDate' + 'interval': 'IntervalDate', + 'account_id': 'str' } attribute_map = { @@ -51,11 +51,11 @@ class AffiliateRatePlanRelationships(object): 'product_rate_plan_id': 'productRatePlanID', 'start_date': 'startDate', 'end_date': 'endDate', - 'account_id': 'accountID', - 'interval': 'interval' + 'interval': 'interval', + 'account_id': 'accountID' } - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, commission_structure=None, product_rate_plan_id=None, start_date=None, end_date=None, account_id=None, interval=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, commission_structure=None, product_rate_plan_id=None, start_date=None, end_date=None, interval=None, account_id=None): # noqa: E501 """AffiliateRatePlanRelationships - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -66,8 +66,8 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self._product_rate_plan_id = None self._start_date = None self._end_date = None - self._account_id = None self._interval = None + self._account_id = None self.discriminator = None if created is not None: self.created = created @@ -87,10 +87,10 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self.start_date = start_date if end_date is not None: self.end_date = end_date - if account_id is not None: - self.account_id = account_id if interval is not None: self.interval = interval + if account_id is not None: + self.account_id = account_id @property def created(self): @@ -281,27 +281,6 @@ def end_date(self, end_date): self._end_date = end_date - @property - def account_id(self): - """Gets the account_id of this AffiliateRatePlanRelationships. # noqa: E501 - - - :return: The account_id of this AffiliateRatePlanRelationships. # noqa: E501 - :rtype: str - """ - return self._account_id - - @account_id.setter - def account_id(self, account_id): - """Sets the account_id of this AffiliateRatePlanRelationships. - - - :param account_id: The account_id of this AffiliateRatePlanRelationships. # noqa: E501 - :type: str - """ - - self._account_id = account_id - @property def interval(self): """Gets the interval of this AffiliateRatePlanRelationships. # noqa: E501 @@ -323,6 +302,27 @@ def interval(self, interval): self._interval = interval + @property + def account_id(self): + """Gets the account_id of this AffiliateRatePlanRelationships. # noqa: E501 + + + :return: The account_id of this AffiliateRatePlanRelationships. # noqa: E501 + :rtype: str + """ + return self._account_id + + @account_id.setter + def account_id(self, account_id): + """Sets the account_id of this AffiliateRatePlanRelationships. + + + :param account_id: The account_id of this AffiliateRatePlanRelationships. # noqa: E501 + :type: str + """ + + self._account_id = account_id + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/billforward/models/amendment.py b/billforward/models/amendment.py index 2060536..ec6d4c6 100644 --- a/billforward/models/amendment.py +++ b/billforward/models/amendment.py @@ -40,8 +40,8 @@ class Amendment(object): 'actioned_time': 'datetime', 'state': 'str', 'deleted': 'bool', - 'discardable_subsystem_object': 'IDiscardable', 'amendment_type': 'str', + 'discardable_subsystem_object': 'IDiscardable', 'at_type': 'str' } @@ -58,8 +58,8 @@ class Amendment(object): 'actioned_time': 'actionedTime', 'state': 'state', 'deleted': 'deleted', - 'discardable_subsystem_object': 'discardableSubsystemObject', 'amendment_type': 'amendmentType', + 'discardable_subsystem_object': 'discardableSubsystemObject', 'at_type': '@type' } @@ -81,7 +81,7 @@ class Amendment(object): 'ServiceEndAmendment': 'ServiceEndAmendment', 'TimerAmendment': 'TimerAmendment' } - def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None, id=None, organization_id=None, subscription_id=None, description=None, actioning_time=None, actioned_time=None, state=None, deleted=None, discardable_subsystem_object=None, amendment_type=None, at_type=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None, id=None, organization_id=None, subscription_id=None, description=None, actioning_time=None, actioned_time=None, state=None, deleted=None, amendment_type=None, discardable_subsystem_object=None, at_type=None): # noqa: E501 """Amendment - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -95,8 +95,8 @@ def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None self._actioned_time = None self._state = None self._deleted = None - self._discardable_subsystem_object = None self._amendment_type = None + self._discardable_subsystem_object = None self._at_type = None self.discriminator = '@type' if created is not None: @@ -121,10 +121,10 @@ def __init__(self, created=None, changed_by=None, updated=None, dummy_field=None self.actioned_time = actioned_time self.state = state self.deleted = deleted - if discardable_subsystem_object is not None: - self.discardable_subsystem_object = discardable_subsystem_object if amendment_type is not None: self.amendment_type = amendment_type + if discardable_subsystem_object is not None: + self.discardable_subsystem_object = discardable_subsystem_object self.at_type = at_type @property @@ -389,27 +389,6 @@ def deleted(self, deleted): self._deleted = deleted - @property - def discardable_subsystem_object(self): - """Gets the discardable_subsystem_object of this Amendment. # noqa: E501 - - - :return: The discardable_subsystem_object of this Amendment. # noqa: E501 - :rtype: IDiscardable - """ - return self._discardable_subsystem_object - - @discardable_subsystem_object.setter - def discardable_subsystem_object(self, discardable_subsystem_object): - """Sets the discardable_subsystem_object of this Amendment. - - - :param discardable_subsystem_object: The discardable_subsystem_object of this Amendment. # noqa: E501 - :type: IDiscardable - """ - - self._discardable_subsystem_object = discardable_subsystem_object - @property def amendment_type(self): """Gets the amendment_type of this Amendment. # noqa: E501 @@ -437,6 +416,27 @@ def amendment_type(self, amendment_type): self._amendment_type = amendment_type + @property + def discardable_subsystem_object(self): + """Gets the discardable_subsystem_object of this Amendment. # noqa: E501 + + + :return: The discardable_subsystem_object of this Amendment. # noqa: E501 + :rtype: IDiscardable + """ + return self._discardable_subsystem_object + + @discardable_subsystem_object.setter + def discardable_subsystem_object(self, discardable_subsystem_object): + """Sets the discardable_subsystem_object of this Amendment. + + + :param discardable_subsystem_object: The discardable_subsystem_object of this Amendment. # noqa: E501 + :type: IDiscardable + """ + + self._discardable_subsystem_object = discardable_subsystem_object + @property def at_type(self): """Gets the at_type of this Amendment. # noqa: E501 diff --git a/billforward/models/api_configuration.py b/billforward/models/api_configuration.py index 7499f39..6431f10 100644 --- a/billforward/models/api_configuration.py +++ b/billforward/models/api_configuration.py @@ -49,9 +49,9 @@ class APIConfiguration(object): 'expires_at': 'datetime', 'migrations': 'list[Migration]', 'gateway_type': 'str', + 'apilogin_id': 'str', 'production': 'bool', 'environment_type': 'str', - 'apilogin_id': 'str', 'apikey': 'str' } @@ -77,13 +77,13 @@ class APIConfiguration(object): 'expires_at': 'expiresAt', 'migrations': 'migrations', 'gateway_type': 'gatewayType', + 'apilogin_id': 'apiloginID', 'production': 'production', 'environment_type': 'environmentType', - 'apilogin_id': 'apiloginID', 'apikey': 'apikey' } - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, type=None, environment=None, merchant_id=None, public_key=None, private_key=None, endpoint=None, client_id=None, client_secret=None, gateway_account_id=None, refresh_token=None, deleted=None, api_login_id=None, transaction_key=None, expires_at=None, migrations=None, gateway_type=None, production=None, environment_type=None, apilogin_id=None, apikey=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, type=None, environment=None, merchant_id=None, public_key=None, private_key=None, endpoint=None, client_id=None, client_secret=None, gateway_account_id=None, refresh_token=None, deleted=None, api_login_id=None, transaction_key=None, expires_at=None, migrations=None, gateway_type=None, apilogin_id=None, production=None, environment_type=None, apikey=None): # noqa: E501 """APIConfiguration - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -106,9 +106,9 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self._expires_at = None self._migrations = None self._gateway_type = None + self._apilogin_id = None self._production = None self._environment_type = None - self._apilogin_id = None self._apikey = None self.discriminator = None if created is not None: @@ -152,12 +152,12 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self.migrations = migrations if gateway_type is not None: self.gateway_type = gateway_type + if apilogin_id is not None: + self.apilogin_id = apilogin_id if production is not None: self.production = production if environment_type is not None: self.environment_type = environment_type - if apilogin_id is not None: - self.apilogin_id = apilogin_id if apikey is not None: self.apikey = apikey @@ -622,6 +622,27 @@ def gateway_type(self, gateway_type): self._gateway_type = gateway_type + @property + def apilogin_id(self): + """Gets the apilogin_id of this APIConfiguration. # noqa: E501 + + + :return: The apilogin_id of this APIConfiguration. # noqa: E501 + :rtype: str + """ + return self._apilogin_id + + @apilogin_id.setter + def apilogin_id(self, apilogin_id): + """Sets the apilogin_id of this APIConfiguration. + + + :param apilogin_id: The apilogin_id of this APIConfiguration. # noqa: E501 + :type: str + """ + + self._apilogin_id = apilogin_id + @property def production(self): """Gets the production of this APIConfiguration. # noqa: E501 @@ -670,27 +691,6 @@ def environment_type(self, environment_type): self._environment_type = environment_type - @property - def apilogin_id(self): - """Gets the apilogin_id of this APIConfiguration. # noqa: E501 - - - :return: The apilogin_id of this APIConfiguration. # noqa: E501 - :rtype: str - """ - return self._apilogin_id - - @apilogin_id.setter - def apilogin_id(self, apilogin_id): - """Sets the apilogin_id of this APIConfiguration. - - - :param apilogin_id: The apilogin_id of this APIConfiguration. # noqa: E501 - :type: str - """ - - self._apilogin_id = apilogin_id - @property def apikey(self): """Gets the apikey of this APIConfiguration. # noqa: E501 diff --git a/billforward/models/epx_capture_request.py b/billforward/models/epx_capture_request.py deleted file mode 100644 index 466f3ec..0000000 --- a/billforward/models/epx_capture_request.py +++ /dev/null @@ -1,786 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import pprint -import re # noqa: F401 - -import six - -class EpxCaptureRequest(object): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'account_id': 'str', - 'tran_type': 'str', - 'auth_guid': 'str', - 'auth_resp': 'str', - 'auth_code': 'str', - 'auth_resp_text': 'str', - 'auth_card_type': 'str', - 'auth_amount_requested': 'str', - 'auth_amount': 'str', - 'auth_currency_code': 'str', - 'auth_masked_account_nbr': 'str', - 'first_name': 'str', - 'last_name': 'str', - 'exp_date': 'str', - 'bp_resp_code': 'str', - 'bp_resp_text': 'str', - 'bp_fields_errors': 'str', - 'network_response': 'str', - 'cust_nbr': 'str', - 'merch_nbr': 'str', - 'dba_nbr': 'str', - 'terminal_nbr': 'str', - 'created': 'datetime', - 'organization_id': 'str', - 'account_id': 'str', - 'default_payment_method': 'bool', - 'formatted_error_message': 'str' - } - - attribute_map = { - 'account_id': 'accountId', - 'tran_type': 'tranType', - 'auth_guid': 'authGuid', - 'auth_resp': 'authResp', - 'auth_code': 'authCode', - 'auth_resp_text': 'authRespText', - 'auth_card_type': 'authCardType', - 'auth_amount_requested': 'authAmountRequested', - 'auth_amount': 'authAmount', - 'auth_currency_code': 'authCurrencyCode', - 'auth_masked_account_nbr': 'authMaskedAccountNbr', - 'first_name': 'firstName', - 'last_name': 'lastName', - 'exp_date': 'expDate', - 'bp_resp_code': 'bpRespCode', - 'bp_resp_text': 'bpRespText', - 'bp_fields_errors': 'bpFieldsErrors', - 'network_response': 'networkResponse', - 'cust_nbr': 'custNbr', - 'merch_nbr': 'merchNbr', - 'dba_nbr': 'dbaNbr', - 'terminal_nbr': 'terminalNbr', - 'created': 'created', - 'organization_id': 'organizationID', - 'account_id': 'accountID', - 'default_payment_method': 'defaultPaymentMethod', - 'formatted_error_message': 'formattedErrorMessage' - } - - def __init__(self, account_id=None, tran_type=None, auth_guid=None, auth_resp=None, auth_code=None, auth_resp_text=None, auth_card_type=None, auth_amount_requested=None, auth_amount=None, auth_currency_code=None, auth_masked_account_nbr=None, first_name=None, last_name=None, exp_date=None, bp_resp_code=None, bp_resp_text=None, bp_fields_errors=None, network_response=None, cust_nbr=None, merch_nbr=None, dba_nbr=None, terminal_nbr=None, created=None, organization_id=None, account_id=None, default_payment_method=None, formatted_error_message=None): # noqa: E501 - """EpxCaptureRequest - a model defined in Swagger""" # noqa: E501 - self._account_id = None - self._tran_type = None - self._auth_guid = None - self._auth_resp = None - self._auth_code = None - self._auth_resp_text = None - self._auth_card_type = None - self._auth_amount_requested = None - self._auth_amount = None - self._auth_currency_code = None - self._auth_masked_account_nbr = None - self._first_name = None - self._last_name = None - self._exp_date = None - self._bp_resp_code = None - self._bp_resp_text = None - self._bp_fields_errors = None - self._network_response = None - self._cust_nbr = None - self._merch_nbr = None - self._dba_nbr = None - self._terminal_nbr = None - self._created = None - self._organization_id = None - self._account_id = None - self._default_payment_method = None - self._formatted_error_message = None - self.discriminator = None - if account_id is not None: - self.account_id = account_id - if tran_type is not None: - self.tran_type = tran_type - if auth_guid is not None: - self.auth_guid = auth_guid - if auth_resp is not None: - self.auth_resp = auth_resp - if auth_code is not None: - self.auth_code = auth_code - if auth_resp_text is not None: - self.auth_resp_text = auth_resp_text - if auth_card_type is not None: - self.auth_card_type = auth_card_type - if auth_amount_requested is not None: - self.auth_amount_requested = auth_amount_requested - if auth_amount is not None: - self.auth_amount = auth_amount - if auth_currency_code is not None: - self.auth_currency_code = auth_currency_code - if auth_masked_account_nbr is not None: - self.auth_masked_account_nbr = auth_masked_account_nbr - if first_name is not None: - self.first_name = first_name - if last_name is not None: - self.last_name = last_name - if exp_date is not None: - self.exp_date = exp_date - if bp_resp_code is not None: - self.bp_resp_code = bp_resp_code - if bp_resp_text is not None: - self.bp_resp_text = bp_resp_text - if bp_fields_errors is not None: - self.bp_fields_errors = bp_fields_errors - if network_response is not None: - self.network_response = network_response - if cust_nbr is not None: - self.cust_nbr = cust_nbr - if merch_nbr is not None: - self.merch_nbr = merch_nbr - if dba_nbr is not None: - self.dba_nbr = dba_nbr - if terminal_nbr is not None: - self.terminal_nbr = terminal_nbr - if created is not None: - self.created = created - if organization_id is not None: - self.organization_id = organization_id - if account_id is not None: - self.account_id = account_id - if default_payment_method is not None: - self.default_payment_method = default_payment_method - if formatted_error_message is not None: - self.formatted_error_message = formatted_error_message - - @property - def account_id(self): - """Gets the account_id of this EpxCaptureRequest. # noqa: E501 - - - :return: The account_id of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._account_id - - @account_id.setter - def account_id(self, account_id): - """Sets the account_id of this EpxCaptureRequest. - - - :param account_id: The account_id of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._account_id = account_id - - @property - def tran_type(self): - """Gets the tran_type of this EpxCaptureRequest. # noqa: E501 - - - :return: The tran_type of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._tran_type - - @tran_type.setter - def tran_type(self, tran_type): - """Sets the tran_type of this EpxCaptureRequest. - - - :param tran_type: The tran_type of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._tran_type = tran_type - - @property - def auth_guid(self): - """Gets the auth_guid of this EpxCaptureRequest. # noqa: E501 - - - :return: The auth_guid of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._auth_guid - - @auth_guid.setter - def auth_guid(self, auth_guid): - """Sets the auth_guid of this EpxCaptureRequest. - - - :param auth_guid: The auth_guid of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._auth_guid = auth_guid - - @property - def auth_resp(self): - """Gets the auth_resp of this EpxCaptureRequest. # noqa: E501 - - - :return: The auth_resp of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._auth_resp - - @auth_resp.setter - def auth_resp(self, auth_resp): - """Sets the auth_resp of this EpxCaptureRequest. - - - :param auth_resp: The auth_resp of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._auth_resp = auth_resp - - @property - def auth_code(self): - """Gets the auth_code of this EpxCaptureRequest. # noqa: E501 - - - :return: The auth_code of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._auth_code - - @auth_code.setter - def auth_code(self, auth_code): - """Sets the auth_code of this EpxCaptureRequest. - - - :param auth_code: The auth_code of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._auth_code = auth_code - - @property - def auth_resp_text(self): - """Gets the auth_resp_text of this EpxCaptureRequest. # noqa: E501 - - - :return: The auth_resp_text of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._auth_resp_text - - @auth_resp_text.setter - def auth_resp_text(self, auth_resp_text): - """Sets the auth_resp_text of this EpxCaptureRequest. - - - :param auth_resp_text: The auth_resp_text of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._auth_resp_text = auth_resp_text - - @property - def auth_card_type(self): - """Gets the auth_card_type of this EpxCaptureRequest. # noqa: E501 - - - :return: The auth_card_type of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._auth_card_type - - @auth_card_type.setter - def auth_card_type(self, auth_card_type): - """Sets the auth_card_type of this EpxCaptureRequest. - - - :param auth_card_type: The auth_card_type of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._auth_card_type = auth_card_type - - @property - def auth_amount_requested(self): - """Gets the auth_amount_requested of this EpxCaptureRequest. # noqa: E501 - - - :return: The auth_amount_requested of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._auth_amount_requested - - @auth_amount_requested.setter - def auth_amount_requested(self, auth_amount_requested): - """Sets the auth_amount_requested of this EpxCaptureRequest. - - - :param auth_amount_requested: The auth_amount_requested of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._auth_amount_requested = auth_amount_requested - - @property - def auth_amount(self): - """Gets the auth_amount of this EpxCaptureRequest. # noqa: E501 - - - :return: The auth_amount of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._auth_amount - - @auth_amount.setter - def auth_amount(self, auth_amount): - """Sets the auth_amount of this EpxCaptureRequest. - - - :param auth_amount: The auth_amount of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._auth_amount = auth_amount - - @property - def auth_currency_code(self): - """Gets the auth_currency_code of this EpxCaptureRequest. # noqa: E501 - - - :return: The auth_currency_code of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._auth_currency_code - - @auth_currency_code.setter - def auth_currency_code(self, auth_currency_code): - """Sets the auth_currency_code of this EpxCaptureRequest. - - - :param auth_currency_code: The auth_currency_code of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._auth_currency_code = auth_currency_code - - @property - def auth_masked_account_nbr(self): - """Gets the auth_masked_account_nbr of this EpxCaptureRequest. # noqa: E501 - - - :return: The auth_masked_account_nbr of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._auth_masked_account_nbr - - @auth_masked_account_nbr.setter - def auth_masked_account_nbr(self, auth_masked_account_nbr): - """Sets the auth_masked_account_nbr of this EpxCaptureRequest. - - - :param auth_masked_account_nbr: The auth_masked_account_nbr of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._auth_masked_account_nbr = auth_masked_account_nbr - - @property - def first_name(self): - """Gets the first_name of this EpxCaptureRequest. # noqa: E501 - - - :return: The first_name of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._first_name - - @first_name.setter - def first_name(self, first_name): - """Sets the first_name of this EpxCaptureRequest. - - - :param first_name: The first_name of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._first_name = first_name - - @property - def last_name(self): - """Gets the last_name of this EpxCaptureRequest. # noqa: E501 - - - :return: The last_name of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._last_name - - @last_name.setter - def last_name(self, last_name): - """Sets the last_name of this EpxCaptureRequest. - - - :param last_name: The last_name of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._last_name = last_name - - @property - def exp_date(self): - """Gets the exp_date of this EpxCaptureRequest. # noqa: E501 - - - :return: The exp_date of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._exp_date - - @exp_date.setter - def exp_date(self, exp_date): - """Sets the exp_date of this EpxCaptureRequest. - - - :param exp_date: The exp_date of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._exp_date = exp_date - - @property - def bp_resp_code(self): - """Gets the bp_resp_code of this EpxCaptureRequest. # noqa: E501 - - - :return: The bp_resp_code of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._bp_resp_code - - @bp_resp_code.setter - def bp_resp_code(self, bp_resp_code): - """Sets the bp_resp_code of this EpxCaptureRequest. - - - :param bp_resp_code: The bp_resp_code of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._bp_resp_code = bp_resp_code - - @property - def bp_resp_text(self): - """Gets the bp_resp_text of this EpxCaptureRequest. # noqa: E501 - - - :return: The bp_resp_text of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._bp_resp_text - - @bp_resp_text.setter - def bp_resp_text(self, bp_resp_text): - """Sets the bp_resp_text of this EpxCaptureRequest. - - - :param bp_resp_text: The bp_resp_text of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._bp_resp_text = bp_resp_text - - @property - def bp_fields_errors(self): - """Gets the bp_fields_errors of this EpxCaptureRequest. # noqa: E501 - - - :return: The bp_fields_errors of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._bp_fields_errors - - @bp_fields_errors.setter - def bp_fields_errors(self, bp_fields_errors): - """Sets the bp_fields_errors of this EpxCaptureRequest. - - - :param bp_fields_errors: The bp_fields_errors of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._bp_fields_errors = bp_fields_errors - - @property - def network_response(self): - """Gets the network_response of this EpxCaptureRequest. # noqa: E501 - - - :return: The network_response of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._network_response - - @network_response.setter - def network_response(self, network_response): - """Sets the network_response of this EpxCaptureRequest. - - - :param network_response: The network_response of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._network_response = network_response - - @property - def cust_nbr(self): - """Gets the cust_nbr of this EpxCaptureRequest. # noqa: E501 - - - :return: The cust_nbr of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._cust_nbr - - @cust_nbr.setter - def cust_nbr(self, cust_nbr): - """Sets the cust_nbr of this EpxCaptureRequest. - - - :param cust_nbr: The cust_nbr of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._cust_nbr = cust_nbr - - @property - def merch_nbr(self): - """Gets the merch_nbr of this EpxCaptureRequest. # noqa: E501 - - - :return: The merch_nbr of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._merch_nbr - - @merch_nbr.setter - def merch_nbr(self, merch_nbr): - """Sets the merch_nbr of this EpxCaptureRequest. - - - :param merch_nbr: The merch_nbr of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._merch_nbr = merch_nbr - - @property - def dba_nbr(self): - """Gets the dba_nbr of this EpxCaptureRequest. # noqa: E501 - - - :return: The dba_nbr of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._dba_nbr - - @dba_nbr.setter - def dba_nbr(self, dba_nbr): - """Sets the dba_nbr of this EpxCaptureRequest. - - - :param dba_nbr: The dba_nbr of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._dba_nbr = dba_nbr - - @property - def terminal_nbr(self): - """Gets the terminal_nbr of this EpxCaptureRequest. # noqa: E501 - - - :return: The terminal_nbr of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._terminal_nbr - - @terminal_nbr.setter - def terminal_nbr(self, terminal_nbr): - """Sets the terminal_nbr of this EpxCaptureRequest. - - - :param terminal_nbr: The terminal_nbr of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._terminal_nbr = terminal_nbr - - @property - def created(self): - """Gets the created of this EpxCaptureRequest. # noqa: E501 - - - :return: The created of this EpxCaptureRequest. # noqa: E501 - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """Sets the created of this EpxCaptureRequest. - - - :param created: The created of this EpxCaptureRequest. # noqa: E501 - :type: datetime - """ - - self._created = created - - @property - def organization_id(self): - """Gets the organization_id of this EpxCaptureRequest. # noqa: E501 - - - :return: The organization_id of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """Sets the organization_id of this EpxCaptureRequest. - - - :param organization_id: The organization_id of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._organization_id = organization_id - - @property - def account_id(self): - """Gets the account_id of this EpxCaptureRequest. # noqa: E501 - - - :return: The account_id of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._account_id - - @account_id.setter - def account_id(self, account_id): - """Sets the account_id of this EpxCaptureRequest. - - - :param account_id: The account_id of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._account_id = account_id - - @property - def default_payment_method(self): - """Gets the default_payment_method of this EpxCaptureRequest. # noqa: E501 - - - :return: The default_payment_method of this EpxCaptureRequest. # noqa: E501 - :rtype: bool - """ - return self._default_payment_method - - @default_payment_method.setter - def default_payment_method(self, default_payment_method): - """Sets the default_payment_method of this EpxCaptureRequest. - - - :param default_payment_method: The default_payment_method of this EpxCaptureRequest. # noqa: E501 - :type: bool - """ - - self._default_payment_method = default_payment_method - - @property - def formatted_error_message(self): - """Gets the formatted_error_message of this EpxCaptureRequest. # noqa: E501 - - - :return: The formatted_error_message of this EpxCaptureRequest. # noqa: E501 - :rtype: str - """ - return self._formatted_error_message - - @formatted_error_message.setter - def formatted_error_message(self, formatted_error_message): - """Sets the formatted_error_message of this EpxCaptureRequest. - - - :param formatted_error_message: The formatted_error_message of this EpxCaptureRequest. # noqa: E501 - :type: str - """ - - self._formatted_error_message = formatted_error_message - - def to_dict(self): - """Returns the model properties as a dict""" - result = {} - - for attr, _ in six.iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - if issubclass(EpxCaptureRequest, dict): - for key, value in self.items(): - result[key] = value - - return result - - def to_str(self): - """Returns the string representation of the model""" - return pprint.pformat(self.to_dict()) - - def __repr__(self): - """For `print` and `pprint`""" - return self.to_str() - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, EpxCaptureRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """Returns true if both objects are not equal""" - return not self == other diff --git a/billforward/models/epx_pre_auth_request.py b/billforward/models/epx_pre_auth_request.py deleted file mode 100644 index f17bdb8..0000000 --- a/billforward/models/epx_pre_auth_request.py +++ /dev/null @@ -1,266 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import pprint -import re # noqa: F401 - -import six - -class EpxPreAuthRequest(object): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'created': 'datetime', - 'organization_id': 'str', - 'account_id': 'str', - 'default_payment_method': 'bool', - 'location_code': 'str', - 'capture_method': 'str', - 'amount': 'float' - } - - attribute_map = { - 'created': 'created', - 'organization_id': 'organizationID', - 'account_id': 'accountID', - 'default_payment_method': 'defaultPaymentMethod', - 'location_code': 'locationCode', - 'capture_method': 'captureMethod', - 'amount': 'amount' - } - - def __init__(self, created=None, organization_id=None, account_id=None, default_payment_method=None, location_code=None, capture_method=None, amount=None): # noqa: E501 - """EpxPreAuthRequest - a model defined in Swagger""" # noqa: E501 - self._created = None - self._organization_id = None - self._account_id = None - self._default_payment_method = None - self._location_code = None - self._capture_method = None - self._amount = None - self.discriminator = None - if created is not None: - self.created = created - if organization_id is not None: - self.organization_id = organization_id - if account_id is not None: - self.account_id = account_id - if default_payment_method is not None: - self.default_payment_method = default_payment_method - if location_code is not None: - self.location_code = location_code - if capture_method is not None: - self.capture_method = capture_method - if amount is not None: - self.amount = amount - - @property - def created(self): - """Gets the created of this EpxPreAuthRequest. # noqa: E501 - - - :return: The created of this EpxPreAuthRequest. # noqa: E501 - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """Sets the created of this EpxPreAuthRequest. - - - :param created: The created of this EpxPreAuthRequest. # noqa: E501 - :type: datetime - """ - - self._created = created - - @property - def organization_id(self): - """Gets the organization_id of this EpxPreAuthRequest. # noqa: E501 - - - :return: The organization_id of this EpxPreAuthRequest. # noqa: E501 - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """Sets the organization_id of this EpxPreAuthRequest. - - - :param organization_id: The organization_id of this EpxPreAuthRequest. # noqa: E501 - :type: str - """ - - self._organization_id = organization_id - - @property - def account_id(self): - """Gets the account_id of this EpxPreAuthRequest. # noqa: E501 - - - :return: The account_id of this EpxPreAuthRequest. # noqa: E501 - :rtype: str - """ - return self._account_id - - @account_id.setter - def account_id(self, account_id): - """Sets the account_id of this EpxPreAuthRequest. - - - :param account_id: The account_id of this EpxPreAuthRequest. # noqa: E501 - :type: str - """ - - self._account_id = account_id - - @property - def default_payment_method(self): - """Gets the default_payment_method of this EpxPreAuthRequest. # noqa: E501 - - - :return: The default_payment_method of this EpxPreAuthRequest. # noqa: E501 - :rtype: bool - """ - return self._default_payment_method - - @default_payment_method.setter - def default_payment_method(self, default_payment_method): - """Sets the default_payment_method of this EpxPreAuthRequest. - - - :param default_payment_method: The default_payment_method of this EpxPreAuthRequest. # noqa: E501 - :type: bool - """ - - self._default_payment_method = default_payment_method - - @property - def location_code(self): - """Gets the location_code of this EpxPreAuthRequest. # noqa: E501 - - - :return: The location_code of this EpxPreAuthRequest. # noqa: E501 - :rtype: str - """ - return self._location_code - - @location_code.setter - def location_code(self, location_code): - """Sets the location_code of this EpxPreAuthRequest. - - - :param location_code: The location_code of this EpxPreAuthRequest. # noqa: E501 - :type: str - """ - - self._location_code = location_code - - @property - def capture_method(self): - """Gets the capture_method of this EpxPreAuthRequest. # noqa: E501 - - - :return: The capture_method of this EpxPreAuthRequest. # noqa: E501 - :rtype: str - """ - return self._capture_method - - @capture_method.setter - def capture_method(self, capture_method): - """Sets the capture_method of this EpxPreAuthRequest. - - - :param capture_method: The capture_method of this EpxPreAuthRequest. # noqa: E501 - :type: str - """ - - self._capture_method = capture_method - - @property - def amount(self): - """Gets the amount of this EpxPreAuthRequest. # noqa: E501 - - - :return: The amount of this EpxPreAuthRequest. # noqa: E501 - :rtype: float - """ - return self._amount - - @amount.setter - def amount(self, amount): - """Sets the amount of this EpxPreAuthRequest. - - - :param amount: The amount of this EpxPreAuthRequest. # noqa: E501 - :type: float - """ - - self._amount = amount - - def to_dict(self): - """Returns the model properties as a dict""" - result = {} - - for attr, _ in six.iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - if issubclass(EpxPreAuthRequest, dict): - for key, value in self.items(): - result[key] = value - - return result - - def to_str(self): - """Returns the string representation of the model""" - return pprint.pformat(self.to_dict()) - - def __repr__(self): - """For `print` and `pprint`""" - return self.to_str() - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, EpxPreAuthRequest): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """Returns true if both objects are not equal""" - return not self == other diff --git a/billforward/models/epx_pre_auth_response.py b/billforward/models/epx_pre_auth_response.py deleted file mode 100644 index edf6bc0..0000000 --- a/billforward/models/epx_pre_auth_response.py +++ /dev/null @@ -1,370 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import pprint -import re # noqa: F401 - -import six - -class EpxPreAuthResponse(object): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'created': 'datetime', - 'organization_id': 'str', - 'tac': 'str', - 'cust_nbr': 'str', - 'merch_nbr': 'str', - 'dba_nbr': 'str', - 'terminal_nbr': 'str', - 'batch_id': 'str', - 'tran_code': 'str', - 'amount': 'str', - 'currency_code': 'str' - } - - attribute_map = { - 'created': 'created', - 'organization_id': 'organizationID', - 'tac': 'tac', - 'cust_nbr': 'custNbr', - 'merch_nbr': 'merchNbr', - 'dba_nbr': 'dbaNbr', - 'terminal_nbr': 'terminalNbr', - 'batch_id': 'batchId', - 'tran_code': 'tranCode', - 'amount': 'amount', - 'currency_code': 'currencyCode' - } - - def __init__(self, created=None, organization_id=None, tac=None, cust_nbr=None, merch_nbr=None, dba_nbr=None, terminal_nbr=None, batch_id=None, tran_code=None, amount=None, currency_code=None): # noqa: E501 - """EpxPreAuthResponse - a model defined in Swagger""" # noqa: E501 - self._created = None - self._organization_id = None - self._tac = None - self._cust_nbr = None - self._merch_nbr = None - self._dba_nbr = None - self._terminal_nbr = None - self._batch_id = None - self._tran_code = None - self._amount = None - self._currency_code = None - self.discriminator = None - if created is not None: - self.created = created - if organization_id is not None: - self.organization_id = organization_id - if tac is not None: - self.tac = tac - if cust_nbr is not None: - self.cust_nbr = cust_nbr - if merch_nbr is not None: - self.merch_nbr = merch_nbr - if dba_nbr is not None: - self.dba_nbr = dba_nbr - if terminal_nbr is not None: - self.terminal_nbr = terminal_nbr - if batch_id is not None: - self.batch_id = batch_id - if tran_code is not None: - self.tran_code = tran_code - if amount is not None: - self.amount = amount - if currency_code is not None: - self.currency_code = currency_code - - @property - def created(self): - """Gets the created of this EpxPreAuthResponse. # noqa: E501 - - - :return: The created of this EpxPreAuthResponse. # noqa: E501 - :rtype: datetime - """ - return self._created - - @created.setter - def created(self, created): - """Sets the created of this EpxPreAuthResponse. - - - :param created: The created of this EpxPreAuthResponse. # noqa: E501 - :type: datetime - """ - - self._created = created - - @property - def organization_id(self): - """Gets the organization_id of this EpxPreAuthResponse. # noqa: E501 - - - :return: The organization_id of this EpxPreAuthResponse. # noqa: E501 - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """Sets the organization_id of this EpxPreAuthResponse. - - - :param organization_id: The organization_id of this EpxPreAuthResponse. # noqa: E501 - :type: str - """ - - self._organization_id = organization_id - - @property - def tac(self): - """Gets the tac of this EpxPreAuthResponse. # noqa: E501 - - - :return: The tac of this EpxPreAuthResponse. # noqa: E501 - :rtype: str - """ - return self._tac - - @tac.setter - def tac(self, tac): - """Sets the tac of this EpxPreAuthResponse. - - - :param tac: The tac of this EpxPreAuthResponse. # noqa: E501 - :type: str - """ - - self._tac = tac - - @property - def cust_nbr(self): - """Gets the cust_nbr of this EpxPreAuthResponse. # noqa: E501 - - - :return: The cust_nbr of this EpxPreAuthResponse. # noqa: E501 - :rtype: str - """ - return self._cust_nbr - - @cust_nbr.setter - def cust_nbr(self, cust_nbr): - """Sets the cust_nbr of this EpxPreAuthResponse. - - - :param cust_nbr: The cust_nbr of this EpxPreAuthResponse. # noqa: E501 - :type: str - """ - - self._cust_nbr = cust_nbr - - @property - def merch_nbr(self): - """Gets the merch_nbr of this EpxPreAuthResponse. # noqa: E501 - - - :return: The merch_nbr of this EpxPreAuthResponse. # noqa: E501 - :rtype: str - """ - return self._merch_nbr - - @merch_nbr.setter - def merch_nbr(self, merch_nbr): - """Sets the merch_nbr of this EpxPreAuthResponse. - - - :param merch_nbr: The merch_nbr of this EpxPreAuthResponse. # noqa: E501 - :type: str - """ - - self._merch_nbr = merch_nbr - - @property - def dba_nbr(self): - """Gets the dba_nbr of this EpxPreAuthResponse. # noqa: E501 - - - :return: The dba_nbr of this EpxPreAuthResponse. # noqa: E501 - :rtype: str - """ - return self._dba_nbr - - @dba_nbr.setter - def dba_nbr(self, dba_nbr): - """Sets the dba_nbr of this EpxPreAuthResponse. - - - :param dba_nbr: The dba_nbr of this EpxPreAuthResponse. # noqa: E501 - :type: str - """ - - self._dba_nbr = dba_nbr - - @property - def terminal_nbr(self): - """Gets the terminal_nbr of this EpxPreAuthResponse. # noqa: E501 - - - :return: The terminal_nbr of this EpxPreAuthResponse. # noqa: E501 - :rtype: str - """ - return self._terminal_nbr - - @terminal_nbr.setter - def terminal_nbr(self, terminal_nbr): - """Sets the terminal_nbr of this EpxPreAuthResponse. - - - :param terminal_nbr: The terminal_nbr of this EpxPreAuthResponse. # noqa: E501 - :type: str - """ - - self._terminal_nbr = terminal_nbr - - @property - def batch_id(self): - """Gets the batch_id of this EpxPreAuthResponse. # noqa: E501 - - - :return: The batch_id of this EpxPreAuthResponse. # noqa: E501 - :rtype: str - """ - return self._batch_id - - @batch_id.setter - def batch_id(self, batch_id): - """Sets the batch_id of this EpxPreAuthResponse. - - - :param batch_id: The batch_id of this EpxPreAuthResponse. # noqa: E501 - :type: str - """ - - self._batch_id = batch_id - - @property - def tran_code(self): - """Gets the tran_code of this EpxPreAuthResponse. # noqa: E501 - - - :return: The tran_code of this EpxPreAuthResponse. # noqa: E501 - :rtype: str - """ - return self._tran_code - - @tran_code.setter - def tran_code(self, tran_code): - """Sets the tran_code of this EpxPreAuthResponse. - - - :param tran_code: The tran_code of this EpxPreAuthResponse. # noqa: E501 - :type: str - """ - - self._tran_code = tran_code - - @property - def amount(self): - """Gets the amount of this EpxPreAuthResponse. # noqa: E501 - - - :return: The amount of this EpxPreAuthResponse. # noqa: E501 - :rtype: str - """ - return self._amount - - @amount.setter - def amount(self, amount): - """Sets the amount of this EpxPreAuthResponse. - - - :param amount: The amount of this EpxPreAuthResponse. # noqa: E501 - :type: str - """ - - self._amount = amount - - @property - def currency_code(self): - """Gets the currency_code of this EpxPreAuthResponse. # noqa: E501 - - - :return: The currency_code of this EpxPreAuthResponse. # noqa: E501 - :rtype: str - """ - return self._currency_code - - @currency_code.setter - def currency_code(self, currency_code): - """Sets the currency_code of this EpxPreAuthResponse. - - - :param currency_code: The currency_code of this EpxPreAuthResponse. # noqa: E501 - :type: str - """ - - self._currency_code = currency_code - - def to_dict(self): - """Returns the model properties as a dict""" - result = {} - - for attr, _ in six.iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - if issubclass(EpxPreAuthResponse, dict): - for key, value in self.items(): - result[key] = value - - return result - - def to_str(self): - """Returns the string representation of the model""" - return pprint.pformat(self.to_dict()) - - def __repr__(self): - """For `print` and `pprint`""" - return self.to_str() - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, EpxPreAuthResponse): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """Returns true if both objects are not equal""" - return not self == other diff --git a/billforward/models/inline_response_default100.py b/billforward/models/inline_response_default100.py index bc2bf66..9284e2b 100644 --- a/billforward/models/inline_response_default100.py +++ b/billforward/models/inline_response_default100.py @@ -35,7 +35,7 @@ class InlineResponseDefault100(object): 'records_returned': 'int', 'total_records': 'int', 'execution_time': 'int', - 'results': 'list[StripeAchToken]' + 'results': 'list[Webhook]' } attribute_map = { @@ -230,7 +230,7 @@ def results(self): :return: The results of this InlineResponseDefault100. # noqa: E501 - :rtype: list[StripeAchToken] + :rtype: list[Webhook] """ return self._results @@ -240,7 +240,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault100. # noqa: E501 - :type: list[StripeAchToken] + :type: list[Webhook] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default101.py b/billforward/models/inline_response_default101.py index 17400c3..02c4518 100644 --- a/billforward/models/inline_response_default101.py +++ b/billforward/models/inline_response_default101.py @@ -28,179 +28,23 @@ class InlineResponseDefault101(object): and the value is json key in definition. """ swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'total_records': 'int', 'execution_time': 'int', 'results': 'list[Webhook]' } attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'total_records': 'totalRecords', 'execution_time': 'executionTime', 'results': 'results' } - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + def __init__(self, execution_time=None, results=None): # noqa: E501 """InlineResponseDefault101 - a model defined in Swagger""" # noqa: E501 - self._next_page = None - self._current_page = None - self._current_offset = None - self._records_requested = None - self._records_returned = None - self._total_records = None self._execution_time = None self._results = None self.discriminator = None - if next_page is not None: - self.next_page = next_page - if current_page is not None: - self.current_page = current_page - if current_offset is not None: - self.current_offset = current_offset - if records_requested is not None: - self.records_requested = records_requested - if records_returned is not None: - self.records_returned = records_returned - if total_records is not None: - self.total_records = total_records self.execution_time = execution_time self.results = results - @property - def next_page(self): - """Gets the next_page of this InlineResponseDefault101. # noqa: E501 - - - :return: The next_page of this InlineResponseDefault101. # noqa: E501 - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """Sets the next_page of this InlineResponseDefault101. - - - :param next_page: The next_page of this InlineResponseDefault101. # noqa: E501 - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """Gets the current_page of this InlineResponseDefault101. # noqa: E501 - - - :return: The current_page of this InlineResponseDefault101. # noqa: E501 - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """Sets the current_page of this InlineResponseDefault101. - - - :param current_page: The current_page of this InlineResponseDefault101. # noqa: E501 - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """Gets the current_offset of this InlineResponseDefault101. # noqa: E501 - - - :return: The current_offset of this InlineResponseDefault101. # noqa: E501 - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """Sets the current_offset of this InlineResponseDefault101. - - - :param current_offset: The current_offset of this InlineResponseDefault101. # noqa: E501 - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """Gets the records_requested of this InlineResponseDefault101. # noqa: E501 - - - :return: The records_requested of this InlineResponseDefault101. # noqa: E501 - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """Sets the records_requested of this InlineResponseDefault101. - - - :param records_requested: The records_requested of this InlineResponseDefault101. # noqa: E501 - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """Gets the records_returned of this InlineResponseDefault101. # noqa: E501 - - - :return: The records_returned of this InlineResponseDefault101. # noqa: E501 - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """Sets the records_returned of this InlineResponseDefault101. - - - :param records_returned: The records_returned of this InlineResponseDefault101. # noqa: E501 - :type: int - """ - - self._records_returned = records_returned - - @property - def total_records(self): - """Gets the total_records of this InlineResponseDefault101. # noqa: E501 - - - :return: The total_records of this InlineResponseDefault101. # noqa: E501 - :rtype: int - """ - return self._total_records - - @total_records.setter - def total_records(self, total_records): - """Sets the total_records of this InlineResponseDefault101. - - - :param total_records: The total_records of this InlineResponseDefault101. # noqa: E501 - :type: int - """ - - self._total_records = total_records - @property def execution_time(self): """Gets the execution_time of this InlineResponseDefault101. # noqa: E501 diff --git a/billforward/models/inline_response_default102.py b/billforward/models/inline_response_default102.py index 452aece..c4cf960 100644 --- a/billforward/models/inline_response_default102.py +++ b/billforward/models/inline_response_default102.py @@ -29,7 +29,7 @@ class InlineResponseDefault102(object): """ swagger_types = { 'execution_time': 'int', - 'results': 'list[Webhook]' + 'results': 'list[AllowedWebhookSubscriptionValues]' } attribute_map = { @@ -74,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault102. # noqa: E501 - :rtype: list[Webhook] + :rtype: list[AllowedWebhookSubscriptionValues] """ return self._results @@ -84,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault102. # noqa: E501 - :type: list[Webhook] + :type: list[AllowedWebhookSubscriptionValues] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default103.py b/billforward/models/inline_response_default103.py deleted file mode 100644 index 09aaa66..0000000 --- a/billforward/models/inline_response_default103.py +++ /dev/null @@ -1,138 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import pprint -import re # noqa: F401 - -import six - -class InlineResponseDefault103(object): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'execution_time': 'int', - 'results': 'list[AllowedWebhookSubscriptionValues]' - } - - attribute_map = { - 'execution_time': 'executionTime', - 'results': 'results' - } - - def __init__(self, execution_time=None, results=None): # noqa: E501 - """InlineResponseDefault103 - a model defined in Swagger""" # noqa: E501 - self._execution_time = None - self._results = None - self.discriminator = None - self.execution_time = execution_time - self.results = results - - @property - def execution_time(self): - """Gets the execution_time of this InlineResponseDefault103. # noqa: E501 - - - :return: The execution_time of this InlineResponseDefault103. # noqa: E501 - :rtype: int - """ - return self._execution_time - - @execution_time.setter - def execution_time(self, execution_time): - """Sets the execution_time of this InlineResponseDefault103. - - - :param execution_time: The execution_time of this InlineResponseDefault103. # noqa: E501 - :type: int - """ - if execution_time is None: - raise ValueError("Invalid value for `execution_time`, must not be `None`") # noqa: E501 - - self._execution_time = execution_time - - @property - def results(self): - """Gets the results of this InlineResponseDefault103. # noqa: E501 - - - :return: The results of this InlineResponseDefault103. # noqa: E501 - :rtype: list[AllowedWebhookSubscriptionValues] - """ - return self._results - - @results.setter - def results(self, results): - """Sets the results of this InlineResponseDefault103. - - - :param results: The results of this InlineResponseDefault103. # noqa: E501 - :type: list[AllowedWebhookSubscriptionValues] - """ - if results is None: - raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 - - self._results = results - - def to_dict(self): - """Returns the model properties as a dict""" - result = {} - - for attr, _ in six.iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - if issubclass(InlineResponseDefault103, dict): - for key, value in self.items(): - result[key] = value - - return result - - def to_str(self): - """Returns the string representation of the model""" - return pprint.pformat(self.to_dict()) - - def __repr__(self): - """For `print` and `pprint`""" - return self.to_str() - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, InlineResponseDefault103): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """Returns true if both objects are not equal""" - return not self == other diff --git a/billforward/models/inline_response_default79.py b/billforward/models/inline_response_default79.py index fd08855..d037d31 100644 --- a/billforward/models/inline_response_default79.py +++ b/billforward/models/inline_response_default79.py @@ -29,7 +29,7 @@ class InlineResponseDefault79(object): """ swagger_types = { 'execution_time': 'int', - 'results': 'list[EpxPreAuthResponse]' + 'results': 'list[EmailTokenization]' } attribute_map = { @@ -74,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault79. # noqa: E501 - :rtype: list[EpxPreAuthResponse] + :rtype: list[EmailTokenization] """ return self._results @@ -84,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault79. # noqa: E501 - :type: list[EpxPreAuthResponse] + :type: list[EmailTokenization] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default80.py b/billforward/models/inline_response_default80.py index 4492d34..7aecb29 100644 --- a/billforward/models/inline_response_default80.py +++ b/billforward/models/inline_response_default80.py @@ -28,23 +28,179 @@ class InlineResponseDefault80(object): and the value is json key in definition. """ swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', 'execution_time': 'int', 'results': 'list[EmailTokenization]' } attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', 'execution_time': 'executionTime', 'results': 'results' } - def __init__(self, execution_time=None, results=None): # noqa: E501 + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 """InlineResponseDefault80 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None self._execution_time = None self._results = None self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records self.execution_time = execution_time self.results = results + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault80. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault80. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault80. + + + :param next_page: The next_page of this InlineResponseDefault80. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault80. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault80. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault80. + + + :param current_page: The current_page of this InlineResponseDefault80. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault80. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault80. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault80. + + + :param current_offset: The current_offset of this InlineResponseDefault80. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault80. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault80. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault80. + + + :param records_requested: The records_requested of this InlineResponseDefault80. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault80. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault80. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault80. + + + :param records_returned: The records_returned of this InlineResponseDefault80. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault80. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault80. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault80. + + + :param total_records: The total_records of this InlineResponseDefault80. # noqa: E501 + :type: int + """ + + self._total_records = total_records + @property def execution_time(self): """Gets the execution_time of this InlineResponseDefault80. # noqa: E501 diff --git a/billforward/models/inline_response_default81.py b/billforward/models/inline_response_default81.py index 340e22f..e750a16 100644 --- a/billforward/models/inline_response_default81.py +++ b/billforward/models/inline_response_default81.py @@ -28,179 +28,23 @@ class InlineResponseDefault81(object): and the value is json key in definition. """ swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'total_records': 'int', 'execution_time': 'int', - 'results': 'list[EmailTokenization]' + 'results': 'list[TokenizationPreAuth]' } attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'total_records': 'totalRecords', 'execution_time': 'executionTime', 'results': 'results' } - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + def __init__(self, execution_time=None, results=None): # noqa: E501 """InlineResponseDefault81 - a model defined in Swagger""" # noqa: E501 - self._next_page = None - self._current_page = None - self._current_offset = None - self._records_requested = None - self._records_returned = None - self._total_records = None self._execution_time = None self._results = None self.discriminator = None - if next_page is not None: - self.next_page = next_page - if current_page is not None: - self.current_page = current_page - if current_offset is not None: - self.current_offset = current_offset - if records_requested is not None: - self.records_requested = records_requested - if records_returned is not None: - self.records_returned = records_returned - if total_records is not None: - self.total_records = total_records self.execution_time = execution_time self.results = results - @property - def next_page(self): - """Gets the next_page of this InlineResponseDefault81. # noqa: E501 - - - :return: The next_page of this InlineResponseDefault81. # noqa: E501 - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """Sets the next_page of this InlineResponseDefault81. - - - :param next_page: The next_page of this InlineResponseDefault81. # noqa: E501 - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """Gets the current_page of this InlineResponseDefault81. # noqa: E501 - - - :return: The current_page of this InlineResponseDefault81. # noqa: E501 - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """Sets the current_page of this InlineResponseDefault81. - - - :param current_page: The current_page of this InlineResponseDefault81. # noqa: E501 - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """Gets the current_offset of this InlineResponseDefault81. # noqa: E501 - - - :return: The current_offset of this InlineResponseDefault81. # noqa: E501 - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """Sets the current_offset of this InlineResponseDefault81. - - - :param current_offset: The current_offset of this InlineResponseDefault81. # noqa: E501 - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """Gets the records_requested of this InlineResponseDefault81. # noqa: E501 - - - :return: The records_requested of this InlineResponseDefault81. # noqa: E501 - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """Sets the records_requested of this InlineResponseDefault81. - - - :param records_requested: The records_requested of this InlineResponseDefault81. # noqa: E501 - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """Gets the records_returned of this InlineResponseDefault81. # noqa: E501 - - - :return: The records_returned of this InlineResponseDefault81. # noqa: E501 - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """Sets the records_returned of this InlineResponseDefault81. - - - :param records_returned: The records_returned of this InlineResponseDefault81. # noqa: E501 - :type: int - """ - - self._records_returned = records_returned - - @property - def total_records(self): - """Gets the total_records of this InlineResponseDefault81. # noqa: E501 - - - :return: The total_records of this InlineResponseDefault81. # noqa: E501 - :rtype: int - """ - return self._total_records - - @total_records.setter - def total_records(self, total_records): - """Sets the total_records of this InlineResponseDefault81. - - - :param total_records: The total_records of this InlineResponseDefault81. # noqa: E501 - :type: int - """ - - self._total_records = total_records - @property def execution_time(self): """Gets the execution_time of this InlineResponseDefault81. # noqa: E501 @@ -230,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault81. # noqa: E501 - :rtype: list[EmailTokenization] + :rtype: list[TokenizationPreAuth] """ return self._results @@ -240,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault81. # noqa: E501 - :type: list[EmailTokenization] + :type: list[TokenizationPreAuth] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default82.py b/billforward/models/inline_response_default82.py index 29a8ab9..60a7154 100644 --- a/billforward/models/inline_response_default82.py +++ b/billforward/models/inline_response_default82.py @@ -29,7 +29,7 @@ class InlineResponseDefault82(object): """ swagger_types = { 'execution_time': 'int', - 'results': 'list[TokenizationPreAuth]' + 'results': 'list[Profile]' } attribute_map = { @@ -74,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault82. # noqa: E501 - :rtype: list[TokenizationPreAuth] + :rtype: list[Profile] """ return self._results @@ -84,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault82. # noqa: E501 - :type: list[TokenizationPreAuth] + :type: list[Profile] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default83.py b/billforward/models/inline_response_default83.py index afe7c2d..b3d92cd 100644 --- a/billforward/models/inline_response_default83.py +++ b/billforward/models/inline_response_default83.py @@ -29,7 +29,7 @@ class InlineResponseDefault83(object): """ swagger_types = { 'execution_time': 'int', - 'results': 'list[Profile]' + 'results': 'list[UserCreationResponse]' } attribute_map = { @@ -74,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault83. # noqa: E501 - :rtype: list[Profile] + :rtype: list[UserCreationResponse] """ return self._results @@ -84,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault83. # noqa: E501 - :type: list[Profile] + :type: list[UserCreationResponse] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default84.py b/billforward/models/inline_response_default84.py index cfb0369..db749ba 100644 --- a/billforward/models/inline_response_default84.py +++ b/billforward/models/inline_response_default84.py @@ -28,23 +28,179 @@ class InlineResponseDefault84(object): and the value is json key in definition. """ swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', 'execution_time': 'int', - 'results': 'list[UserCreationResponse]' + 'results': 'list[SimpleUser]' } attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', 'execution_time': 'executionTime', 'results': 'results' } - def __init__(self, execution_time=None, results=None): # noqa: E501 + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 """InlineResponseDefault84 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None self._execution_time = None self._results = None self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records self.execution_time = execution_time self.results = results + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault84. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault84. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault84. + + + :param next_page: The next_page of this InlineResponseDefault84. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault84. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault84. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault84. + + + :param current_page: The current_page of this InlineResponseDefault84. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault84. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault84. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault84. + + + :param current_offset: The current_offset of this InlineResponseDefault84. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault84. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault84. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault84. + + + :param records_requested: The records_requested of this InlineResponseDefault84. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault84. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault84. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault84. + + + :param records_returned: The records_returned of this InlineResponseDefault84. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault84. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault84. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault84. + + + :param total_records: The total_records of this InlineResponseDefault84. # noqa: E501 + :type: int + """ + + self._total_records = total_records + @property def execution_time(self): """Gets the execution_time of this InlineResponseDefault84. # noqa: E501 @@ -74,7 +230,7 @@ def results(self): :return: The results of this InlineResponseDefault84. # noqa: E501 - :rtype: list[UserCreationResponse] + :rtype: list[SimpleUser] """ return self._results @@ -84,7 +240,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault84. # noqa: E501 - :type: list[UserCreationResponse] + :type: list[SimpleUser] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default85.py b/billforward/models/inline_response_default85.py index 6a4dd32..db191ce 100644 --- a/billforward/models/inline_response_default85.py +++ b/billforward/models/inline_response_default85.py @@ -28,179 +28,23 @@ class InlineResponseDefault85(object): and the value is json key in definition. """ swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'total_records': 'int', 'execution_time': 'int', - 'results': 'list[SimpleUser]' + 'results': 'list[UserResponse]' } attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'total_records': 'totalRecords', 'execution_time': 'executionTime', 'results': 'results' } - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + def __init__(self, execution_time=None, results=None): # noqa: E501 """InlineResponseDefault85 - a model defined in Swagger""" # noqa: E501 - self._next_page = None - self._current_page = None - self._current_offset = None - self._records_requested = None - self._records_returned = None - self._total_records = None self._execution_time = None self._results = None self.discriminator = None - if next_page is not None: - self.next_page = next_page - if current_page is not None: - self.current_page = current_page - if current_offset is not None: - self.current_offset = current_offset - if records_requested is not None: - self.records_requested = records_requested - if records_returned is not None: - self.records_returned = records_returned - if total_records is not None: - self.total_records = total_records self.execution_time = execution_time self.results = results - @property - def next_page(self): - """Gets the next_page of this InlineResponseDefault85. # noqa: E501 - - - :return: The next_page of this InlineResponseDefault85. # noqa: E501 - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """Sets the next_page of this InlineResponseDefault85. - - - :param next_page: The next_page of this InlineResponseDefault85. # noqa: E501 - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """Gets the current_page of this InlineResponseDefault85. # noqa: E501 - - - :return: The current_page of this InlineResponseDefault85. # noqa: E501 - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """Sets the current_page of this InlineResponseDefault85. - - - :param current_page: The current_page of this InlineResponseDefault85. # noqa: E501 - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """Gets the current_offset of this InlineResponseDefault85. # noqa: E501 - - - :return: The current_offset of this InlineResponseDefault85. # noqa: E501 - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """Sets the current_offset of this InlineResponseDefault85. - - - :param current_offset: The current_offset of this InlineResponseDefault85. # noqa: E501 - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """Gets the records_requested of this InlineResponseDefault85. # noqa: E501 - - - :return: The records_requested of this InlineResponseDefault85. # noqa: E501 - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """Sets the records_requested of this InlineResponseDefault85. - - - :param records_requested: The records_requested of this InlineResponseDefault85. # noqa: E501 - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """Gets the records_returned of this InlineResponseDefault85. # noqa: E501 - - - :return: The records_returned of this InlineResponseDefault85. # noqa: E501 - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """Sets the records_returned of this InlineResponseDefault85. - - - :param records_returned: The records_returned of this InlineResponseDefault85. # noqa: E501 - :type: int - """ - - self._records_returned = records_returned - - @property - def total_records(self): - """Gets the total_records of this InlineResponseDefault85. # noqa: E501 - - - :return: The total_records of this InlineResponseDefault85. # noqa: E501 - :rtype: int - """ - return self._total_records - - @total_records.setter - def total_records(self, total_records): - """Sets the total_records of this InlineResponseDefault85. - - - :param total_records: The total_records of this InlineResponseDefault85. # noqa: E501 - :type: int - """ - - self._total_records = total_records - @property def execution_time(self): """Gets the execution_time of this InlineResponseDefault85. # noqa: E501 @@ -230,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault85. # noqa: E501 - :rtype: list[SimpleUser] + :rtype: list[UserResponse] """ return self._results @@ -240,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault85. # noqa: E501 - :type: list[SimpleUser] + :type: list[UserResponse] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default86.py b/billforward/models/inline_response_default86.py index aed3fd4..6d9dbbe 100644 --- a/billforward/models/inline_response_default86.py +++ b/billforward/models/inline_response_default86.py @@ -28,23 +28,179 @@ class InlineResponseDefault86(object): and the value is json key in definition. """ swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', 'execution_time': 'int', - 'results': 'list[UserResponse]' + 'results': 'list[OrganizationLiteView]' } attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', 'execution_time': 'executionTime', 'results': 'results' } - def __init__(self, execution_time=None, results=None): # noqa: E501 + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 """InlineResponseDefault86 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None self._execution_time = None self._results = None self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records self.execution_time = execution_time self.results = results + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault86. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault86. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault86. + + + :param next_page: The next_page of this InlineResponseDefault86. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault86. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault86. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault86. + + + :param current_page: The current_page of this InlineResponseDefault86. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault86. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault86. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault86. + + + :param current_offset: The current_offset of this InlineResponseDefault86. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault86. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault86. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault86. + + + :param records_requested: The records_requested of this InlineResponseDefault86. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault86. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault86. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault86. + + + :param records_returned: The records_returned of this InlineResponseDefault86. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault86. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault86. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault86. + + + :param total_records: The total_records of this InlineResponseDefault86. # noqa: E501 + :type: int + """ + + self._total_records = total_records + @property def execution_time(self): """Gets the execution_time of this InlineResponseDefault86. # noqa: E501 @@ -74,7 +230,7 @@ def results(self): :return: The results of this InlineResponseDefault86. # noqa: E501 - :rtype: list[UserResponse] + :rtype: list[OrganizationLiteView] """ return self._results @@ -84,7 +240,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault86. # noqa: E501 - :type: list[UserResponse] + :type: list[OrganizationLiteView] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default87.py b/billforward/models/inline_response_default87.py index d28a33a..2c98c5a 100644 --- a/billforward/models/inline_response_default87.py +++ b/billforward/models/inline_response_default87.py @@ -35,7 +35,7 @@ class InlineResponseDefault87(object): 'records_returned': 'int', 'total_records': 'int', 'execution_time': 'int', - 'results': 'list[OrganizationLiteView]' + 'results': 'list[UserResponse]' } attribute_map = { @@ -230,7 +230,7 @@ def results(self): :return: The results of this InlineResponseDefault87. # noqa: E501 - :rtype: list[OrganizationLiteView] + :rtype: list[UserResponse] """ return self._results @@ -240,7 +240,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault87. # noqa: E501 - :type: list[OrganizationLiteView] + :type: list[UserResponse] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default88.py b/billforward/models/inline_response_default88.py index 8b5e407..4f23b2e 100644 --- a/billforward/models/inline_response_default88.py +++ b/billforward/models/inline_response_default88.py @@ -28,179 +28,23 @@ class InlineResponseDefault88(object): and the value is json key in definition. """ swagger_types = { - 'next_page': 'str', - 'current_page': 'int', - 'current_offset': 'int', - 'records_requested': 'int', - 'records_returned': 'int', - 'total_records': 'int', 'execution_time': 'int', - 'results': 'list[UserResponse]' + 'results': 'list[OpenIDRegistrationResponse]' } attribute_map = { - 'next_page': 'nextPage', - 'current_page': 'currentPage', - 'current_offset': 'currentOffset', - 'records_requested': 'recordsRequested', - 'records_returned': 'recordsReturned', - 'total_records': 'totalRecords', 'execution_time': 'executionTime', 'results': 'results' } - def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 + def __init__(self, execution_time=None, results=None): # noqa: E501 """InlineResponseDefault88 - a model defined in Swagger""" # noqa: E501 - self._next_page = None - self._current_page = None - self._current_offset = None - self._records_requested = None - self._records_returned = None - self._total_records = None self._execution_time = None self._results = None self.discriminator = None - if next_page is not None: - self.next_page = next_page - if current_page is not None: - self.current_page = current_page - if current_offset is not None: - self.current_offset = current_offset - if records_requested is not None: - self.records_requested = records_requested - if records_returned is not None: - self.records_returned = records_returned - if total_records is not None: - self.total_records = total_records self.execution_time = execution_time self.results = results - @property - def next_page(self): - """Gets the next_page of this InlineResponseDefault88. # noqa: E501 - - - :return: The next_page of this InlineResponseDefault88. # noqa: E501 - :rtype: str - """ - return self._next_page - - @next_page.setter - def next_page(self, next_page): - """Sets the next_page of this InlineResponseDefault88. - - - :param next_page: The next_page of this InlineResponseDefault88. # noqa: E501 - :type: str - """ - - self._next_page = next_page - - @property - def current_page(self): - """Gets the current_page of this InlineResponseDefault88. # noqa: E501 - - - :return: The current_page of this InlineResponseDefault88. # noqa: E501 - :rtype: int - """ - return self._current_page - - @current_page.setter - def current_page(self, current_page): - """Sets the current_page of this InlineResponseDefault88. - - - :param current_page: The current_page of this InlineResponseDefault88. # noqa: E501 - :type: int - """ - - self._current_page = current_page - - @property - def current_offset(self): - """Gets the current_offset of this InlineResponseDefault88. # noqa: E501 - - - :return: The current_offset of this InlineResponseDefault88. # noqa: E501 - :rtype: int - """ - return self._current_offset - - @current_offset.setter - def current_offset(self, current_offset): - """Sets the current_offset of this InlineResponseDefault88. - - - :param current_offset: The current_offset of this InlineResponseDefault88. # noqa: E501 - :type: int - """ - - self._current_offset = current_offset - - @property - def records_requested(self): - """Gets the records_requested of this InlineResponseDefault88. # noqa: E501 - - - :return: The records_requested of this InlineResponseDefault88. # noqa: E501 - :rtype: int - """ - return self._records_requested - - @records_requested.setter - def records_requested(self, records_requested): - """Sets the records_requested of this InlineResponseDefault88. - - - :param records_requested: The records_requested of this InlineResponseDefault88. # noqa: E501 - :type: int - """ - - self._records_requested = records_requested - - @property - def records_returned(self): - """Gets the records_returned of this InlineResponseDefault88. # noqa: E501 - - - :return: The records_returned of this InlineResponseDefault88. # noqa: E501 - :rtype: int - """ - return self._records_returned - - @records_returned.setter - def records_returned(self, records_returned): - """Sets the records_returned of this InlineResponseDefault88. - - - :param records_returned: The records_returned of this InlineResponseDefault88. # noqa: E501 - :type: int - """ - - self._records_returned = records_returned - - @property - def total_records(self): - """Gets the total_records of this InlineResponseDefault88. # noqa: E501 - - - :return: The total_records of this InlineResponseDefault88. # noqa: E501 - :rtype: int - """ - return self._total_records - - @total_records.setter - def total_records(self, total_records): - """Sets the total_records of this InlineResponseDefault88. - - - :param total_records: The total_records of this InlineResponseDefault88. # noqa: E501 - :type: int - """ - - self._total_records = total_records - @property def execution_time(self): """Gets the execution_time of this InlineResponseDefault88. # noqa: E501 @@ -230,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault88. # noqa: E501 - :rtype: list[UserResponse] + :rtype: list[OpenIDRegistrationResponse] """ return self._results @@ -240,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault88. # noqa: E501 - :type: list[UserResponse] + :type: list[OpenIDRegistrationResponse] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default89.py b/billforward/models/inline_response_default89.py index 459528b..102821d 100644 --- a/billforward/models/inline_response_default89.py +++ b/billforward/models/inline_response_default89.py @@ -29,7 +29,7 @@ class InlineResponseDefault89(object): """ swagger_types = { 'execution_time': 'int', - 'results': 'list[OpenIDRegistrationResponse]' + 'results': 'list[PasswordResetResponse]' } attribute_map = { @@ -74,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault89. # noqa: E501 - :rtype: list[OpenIDRegistrationResponse] + :rtype: list[PasswordResetResponse] """ return self._results @@ -84,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault89. # noqa: E501 - :type: list[OpenIDRegistrationResponse] + :type: list[PasswordResetResponse] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default90.py b/billforward/models/inline_response_default90.py index 22d8ccd..8c79ac1 100644 --- a/billforward/models/inline_response_default90.py +++ b/billforward/models/inline_response_default90.py @@ -29,7 +29,7 @@ class InlineResponseDefault90(object): """ swagger_types = { 'execution_time': 'int', - 'results': 'list[PasswordResetResponse]' + 'results': 'list[Username]' } attribute_map = { @@ -74,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault90. # noqa: E501 - :rtype: list[PasswordResetResponse] + :rtype: list[Username] """ return self._results @@ -84,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault90. # noqa: E501 - :type: list[PasswordResetResponse] + :type: list[Username] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default91.py b/billforward/models/inline_response_default91.py index 70145a8..d5f41a5 100644 --- a/billforward/models/inline_response_default91.py +++ b/billforward/models/inline_response_default91.py @@ -29,7 +29,7 @@ class InlineResponseDefault91(object): """ swagger_types = { 'execution_time': 'int', - 'results': 'list[Username]' + 'results': 'list[UpdatePasswordResponse]' } attribute_map = { @@ -74,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault91. # noqa: E501 - :rtype: list[Username] + :rtype: list[UpdatePasswordResponse] """ return self._results @@ -84,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault91. # noqa: E501 - :type: list[Username] + :type: list[UpdatePasswordResponse] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default92.py b/billforward/models/inline_response_default92.py index 8cb9895..87127b7 100644 --- a/billforward/models/inline_response_default92.py +++ b/billforward/models/inline_response_default92.py @@ -29,7 +29,7 @@ class InlineResponseDefault92(object): """ swagger_types = { 'execution_time': 'int', - 'results': 'list[UpdatePasswordResponse]' + 'results': 'list[AuthorizeNetToken]' } attribute_map = { @@ -74,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault92. # noqa: E501 - :rtype: list[UpdatePasswordResponse] + :rtype: list[AuthorizeNetToken] """ return self._results @@ -84,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault92. # noqa: E501 - :type: list[UpdatePasswordResponse] + :type: list[AuthorizeNetToken] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default93.py b/billforward/models/inline_response_default93.py index b7064a0..540e15a 100644 --- a/billforward/models/inline_response_default93.py +++ b/billforward/models/inline_response_default93.py @@ -29,7 +29,7 @@ class InlineResponseDefault93(object): """ swagger_types = { 'execution_time': 'int', - 'results': 'list[AuthorizeNetToken]' + 'results': 'list[BraintreeToken]' } attribute_map = { @@ -74,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault93. # noqa: E501 - :rtype: list[AuthorizeNetToken] + :rtype: list[BraintreeToken] """ return self._results @@ -84,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault93. # noqa: E501 - :type: list[AuthorizeNetToken] + :type: list[BraintreeToken] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default94.py b/billforward/models/inline_response_default94.py index e099d45..ab5a0b2 100644 --- a/billforward/models/inline_response_default94.py +++ b/billforward/models/inline_response_default94.py @@ -29,7 +29,7 @@ class InlineResponseDefault94(object): """ swagger_types = { 'execution_time': 'int', - 'results': 'list[BraintreeToken]' + 'results': 'list[StripeAchToken]' } attribute_map = { @@ -74,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault94. # noqa: E501 - :rtype: list[BraintreeToken] + :rtype: list[StripeAchToken] """ return self._results @@ -84,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault94. # noqa: E501 - :type: list[BraintreeToken] + :type: list[StripeAchToken] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default95.py b/billforward/models/inline_response_default95.py index 2190627..a63c108 100644 --- a/billforward/models/inline_response_default95.py +++ b/billforward/models/inline_response_default95.py @@ -29,7 +29,7 @@ class InlineResponseDefault95(object): """ swagger_types = { 'execution_time': 'int', - 'results': 'list[StripeAchToken]' + 'results': 'list[StripeToken]' } attribute_map = { @@ -74,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault95. # noqa: E501 - :rtype: list[StripeAchToken] + :rtype: list[StripeToken] """ return self._results @@ -84,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault95. # noqa: E501 - :type: list[StripeAchToken] + :type: list[StripeToken] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default96.py b/billforward/models/inline_response_default96.py index c7aab73..2a2db57 100644 --- a/billforward/models/inline_response_default96.py +++ b/billforward/models/inline_response_default96.py @@ -29,7 +29,7 @@ class InlineResponseDefault96(object): """ swagger_types = { 'execution_time': 'int', - 'results': 'list[StripeToken]' + 'results': 'list[TrustCommerceToken]' } attribute_map = { @@ -74,7 +74,7 @@ def results(self): :return: The results of this InlineResponseDefault96. # noqa: E501 - :rtype: list[StripeToken] + :rtype: list[TrustCommerceToken] """ return self._results @@ -84,7 +84,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault96. # noqa: E501 - :type: list[StripeToken] + :type: list[TrustCommerceToken] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default97.py b/billforward/models/inline_response_default97.py index 143aa4a..cf3720c 100644 --- a/billforward/models/inline_response_default97.py +++ b/billforward/models/inline_response_default97.py @@ -28,23 +28,179 @@ class InlineResponseDefault97(object): and the value is json key in definition. """ swagger_types = { + 'next_page': 'str', + 'current_page': 'int', + 'current_offset': 'int', + 'records_requested': 'int', + 'records_returned': 'int', + 'total_records': 'int', 'execution_time': 'int', - 'results': 'list[TrustCommerceToken]' + 'results': 'list[BraintreeToken]' } attribute_map = { + 'next_page': 'nextPage', + 'current_page': 'currentPage', + 'current_offset': 'currentOffset', + 'records_requested': 'recordsRequested', + 'records_returned': 'recordsReturned', + 'total_records': 'totalRecords', 'execution_time': 'executionTime', 'results': 'results' } - def __init__(self, execution_time=None, results=None): # noqa: E501 + def __init__(self, next_page=None, current_page=None, current_offset=None, records_requested=None, records_returned=None, total_records=None, execution_time=None, results=None): # noqa: E501 """InlineResponseDefault97 - a model defined in Swagger""" # noqa: E501 + self._next_page = None + self._current_page = None + self._current_offset = None + self._records_requested = None + self._records_returned = None + self._total_records = None self._execution_time = None self._results = None self.discriminator = None + if next_page is not None: + self.next_page = next_page + if current_page is not None: + self.current_page = current_page + if current_offset is not None: + self.current_offset = current_offset + if records_requested is not None: + self.records_requested = records_requested + if records_returned is not None: + self.records_returned = records_returned + if total_records is not None: + self.total_records = total_records self.execution_time = execution_time self.results = results + @property + def next_page(self): + """Gets the next_page of this InlineResponseDefault97. # noqa: E501 + + + :return: The next_page of this InlineResponseDefault97. # noqa: E501 + :rtype: str + """ + return self._next_page + + @next_page.setter + def next_page(self, next_page): + """Sets the next_page of this InlineResponseDefault97. + + + :param next_page: The next_page of this InlineResponseDefault97. # noqa: E501 + :type: str + """ + + self._next_page = next_page + + @property + def current_page(self): + """Gets the current_page of this InlineResponseDefault97. # noqa: E501 + + + :return: The current_page of this InlineResponseDefault97. # noqa: E501 + :rtype: int + """ + return self._current_page + + @current_page.setter + def current_page(self, current_page): + """Sets the current_page of this InlineResponseDefault97. + + + :param current_page: The current_page of this InlineResponseDefault97. # noqa: E501 + :type: int + """ + + self._current_page = current_page + + @property + def current_offset(self): + """Gets the current_offset of this InlineResponseDefault97. # noqa: E501 + + + :return: The current_offset of this InlineResponseDefault97. # noqa: E501 + :rtype: int + """ + return self._current_offset + + @current_offset.setter + def current_offset(self, current_offset): + """Sets the current_offset of this InlineResponseDefault97. + + + :param current_offset: The current_offset of this InlineResponseDefault97. # noqa: E501 + :type: int + """ + + self._current_offset = current_offset + + @property + def records_requested(self): + """Gets the records_requested of this InlineResponseDefault97. # noqa: E501 + + + :return: The records_requested of this InlineResponseDefault97. # noqa: E501 + :rtype: int + """ + return self._records_requested + + @records_requested.setter + def records_requested(self, records_requested): + """Sets the records_requested of this InlineResponseDefault97. + + + :param records_requested: The records_requested of this InlineResponseDefault97. # noqa: E501 + :type: int + """ + + self._records_requested = records_requested + + @property + def records_returned(self): + """Gets the records_returned of this InlineResponseDefault97. # noqa: E501 + + + :return: The records_returned of this InlineResponseDefault97. # noqa: E501 + :rtype: int + """ + return self._records_returned + + @records_returned.setter + def records_returned(self, records_returned): + """Sets the records_returned of this InlineResponseDefault97. + + + :param records_returned: The records_returned of this InlineResponseDefault97. # noqa: E501 + :type: int + """ + + self._records_returned = records_returned + + @property + def total_records(self): + """Gets the total_records of this InlineResponseDefault97. # noqa: E501 + + + :return: The total_records of this InlineResponseDefault97. # noqa: E501 + :rtype: int + """ + return self._total_records + + @total_records.setter + def total_records(self, total_records): + """Sets the total_records of this InlineResponseDefault97. + + + :param total_records: The total_records of this InlineResponseDefault97. # noqa: E501 + :type: int + """ + + self._total_records = total_records + @property def execution_time(self): """Gets the execution_time of this InlineResponseDefault97. # noqa: E501 @@ -74,7 +230,7 @@ def results(self): :return: The results of this InlineResponseDefault97. # noqa: E501 - :rtype: list[TrustCommerceToken] + :rtype: list[BraintreeToken] """ return self._results @@ -84,7 +240,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault97. # noqa: E501 - :type: list[TrustCommerceToken] + :type: list[BraintreeToken] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default98.py b/billforward/models/inline_response_default98.py index 0c39ceb..24a7026 100644 --- a/billforward/models/inline_response_default98.py +++ b/billforward/models/inline_response_default98.py @@ -35,7 +35,7 @@ class InlineResponseDefault98(object): 'records_returned': 'int', 'total_records': 'int', 'execution_time': 'int', - 'results': 'list[BraintreeToken]' + 'results': 'list[StripeToken]' } attribute_map = { @@ -230,7 +230,7 @@ def results(self): :return: The results of this InlineResponseDefault98. # noqa: E501 - :rtype: list[BraintreeToken] + :rtype: list[StripeToken] """ return self._results @@ -240,7 +240,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault98. # noqa: E501 - :type: list[BraintreeToken] + :type: list[StripeToken] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/inline_response_default99.py b/billforward/models/inline_response_default99.py index 2f8d092..6c46a2e 100644 --- a/billforward/models/inline_response_default99.py +++ b/billforward/models/inline_response_default99.py @@ -35,7 +35,7 @@ class InlineResponseDefault99(object): 'records_returned': 'int', 'total_records': 'int', 'execution_time': 'int', - 'results': 'list[StripeToken]' + 'results': 'list[StripeAchToken]' } attribute_map = { @@ -230,7 +230,7 @@ def results(self): :return: The results of this InlineResponseDefault99. # noqa: E501 - :rtype: list[StripeToken] + :rtype: list[StripeAchToken] """ return self._results @@ -240,7 +240,7 @@ def results(self, results): :param results: The results of this InlineResponseDefault99. # noqa: E501 - :type: list[StripeToken] + :type: list[StripeAchToken] """ if results is None: raise ValueError("Invalid value for `results`, must not be `None`") # noqa: E501 diff --git a/billforward/models/invoice.py b/billforward/models/invoice.py index ad0d2b7..0377ee8 100644 --- a/billforward/models/invoice.py +++ b/billforward/models/invoice.py @@ -79,6 +79,7 @@ class Invoice(object): 'payment_terms': 'int', 'children': 'list[Invoice]', 'executions': 'list[ExecutionReceiptResponse]', + 'monotonic_number': 'int', 'total_invoice_cost': 'float', 'zero_cost': 'bool', 'c_rmid': 'str' @@ -136,12 +137,13 @@ class Invoice(object): 'payment_terms': 'paymentTerms', 'children': 'children', 'executions': 'executions', + 'monotonic_number': 'monotonicNumber', 'total_invoice_cost': 'totalInvoiceCost', 'zero_cost': 'zeroCost', 'c_rmid': 'cRMID' } - def __init__(self, created=None, changed_by=None, updated=None, metadata=None, version_id=None, id=None, subscription_id=None, subscription_version_id=None, account_id=None, organization_id=None, parent_invoice_id=None, name=None, description=None, state=None, issued=None, due=None, period_start=None, period_end=None, deleted=None, total_execution_attempts=None, last_execution_attempt=None, next_execution_attempt=None, final_execution_attempt=None, payment_received=None, currency=None, cost_excluding_tax=None, invoice_cost=None, non_discounted_cost=None, non_discounted_cost_excluding_tax=None, invoice_paid=None, discount_amount=None, discount_amount_excluding_tax=None, invoice_refunded=None, credit_rolled_over=None, credit_rolled_over_excluding_tax=None, type=None, locked=None, managed_by=None, initial_invoice=None, processing=None, purchase_order=None, version_number=None, invoice_lines=None, tax_lines=None, invoice_payments=None, invoice_refunds=None, invoice_credit_notes=None, charges=None, payment_terms=None, children=None, executions=None, total_invoice_cost=None, zero_cost=None, c_rmid=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, metadata=None, version_id=None, id=None, subscription_id=None, subscription_version_id=None, account_id=None, organization_id=None, parent_invoice_id=None, name=None, description=None, state=None, issued=None, due=None, period_start=None, period_end=None, deleted=None, total_execution_attempts=None, last_execution_attempt=None, next_execution_attempt=None, final_execution_attempt=None, payment_received=None, currency=None, cost_excluding_tax=None, invoice_cost=None, non_discounted_cost=None, non_discounted_cost_excluding_tax=None, invoice_paid=None, discount_amount=None, discount_amount_excluding_tax=None, invoice_refunded=None, credit_rolled_over=None, credit_rolled_over_excluding_tax=None, type=None, locked=None, managed_by=None, initial_invoice=None, processing=None, purchase_order=None, version_number=None, invoice_lines=None, tax_lines=None, invoice_payments=None, invoice_refunds=None, invoice_credit_notes=None, charges=None, payment_terms=None, children=None, executions=None, monotonic_number=None, total_invoice_cost=None, zero_cost=None, c_rmid=None): # noqa: E501 """Invoice - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -194,6 +196,7 @@ def __init__(self, created=None, changed_by=None, updated=None, metadata=None, v self._payment_terms = None self._children = None self._executions = None + self._monotonic_number = None self._total_invoice_cost = None self._zero_cost = None self._c_rmid = None @@ -288,6 +291,8 @@ def __init__(self, created=None, changed_by=None, updated=None, metadata=None, v self.children = children if executions is not None: self.executions = executions + if monotonic_number is not None: + self.monotonic_number = monotonic_number if total_invoice_cost is not None: self.total_invoice_cost = total_invoice_cost if zero_cost is not None: @@ -1408,6 +1413,27 @@ def executions(self, executions): self._executions = executions + @property + def monotonic_number(self): + """Gets the monotonic_number of this Invoice. # noqa: E501 + + + :return: The monotonic_number of this Invoice. # noqa: E501 + :rtype: int + """ + return self._monotonic_number + + @monotonic_number.setter + def monotonic_number(self, monotonic_number): + """Sets the monotonic_number of this Invoice. + + + :param monotonic_number: The monotonic_number of this Invoice. # noqa: E501 + :type: int + """ + + self._monotonic_number = monotonic_number + @property def total_invoice_cost(self): """Gets the total_invoice_cost of this Invoice. # noqa: E501 diff --git a/billforward/models/invoice_template_config_response.py b/billforward/models/invoice_template_config_response.py index afbb3e0..186c251 100644 --- a/billforward/models/invoice_template_config_response.py +++ b/billforward/models/invoice_template_config_response.py @@ -368,7 +368,7 @@ def show_unit_price(self, show_unit_price): :param show_unit_price: The show_unit_price of this InvoiceTemplateConfigResponse. # noqa: E501 :type: str """ - allowed_values = ["Hidden", "Column", "Inline"] # noqa: E501 + allowed_values = ["Hidden", "Column"] # noqa: E501 if show_unit_price not in allowed_values: raise ValueError( "Invalid value for `show_unit_price` ({0}), must be one of {1}" # noqa: E501 diff --git a/billforward/models/pay_vision_configuration.py b/billforward/models/pay_vision_configuration.py index 3009811..41f7e79 100644 --- a/billforward/models/pay_vision_configuration.py +++ b/billforward/models/pay_vision_configuration.py @@ -31,9 +31,9 @@ class PayVisionConfiguration(APIConfiguration): swagger_types = { 'key_filename': 'str', 'domain': 'str', - 'password': 'str', 'entity_id': 'str', - 'user_id': 'str' + 'user_id': 'str', + 'password': 'str' } if hasattr(APIConfiguration, "swagger_types"): swagger_types.update(APIConfiguration.swagger_types) @@ -41,31 +41,31 @@ class PayVisionConfiguration(APIConfiguration): attribute_map = { 'key_filename': 'keyFilename', 'domain': 'domain', - 'password': 'password', 'entity_id': 'entityID', - 'user_id': 'userID' + 'user_id': 'userID', + 'password': 'password' } if hasattr(APIConfiguration, "attribute_map"): attribute_map.update(APIConfiguration.attribute_map) - def __init__(self, key_filename=None, domain=None, password=None, entity_id=None, user_id=None, *args, **kwargs): # noqa: E501 + def __init__(self, key_filename=None, domain=None, entity_id=None, user_id=None, password=None, *args, **kwargs): # noqa: E501 """PayVisionConfiguration - a model defined in Swagger""" # noqa: E501 self._key_filename = None self._domain = None - self._password = None self._entity_id = None self._user_id = None + self._password = None self.discriminator = None if key_filename is not None: self.key_filename = key_filename if domain is not None: self.domain = domain - if password is not None: - self.password = password if entity_id is not None: self.entity_id = entity_id if user_id is not None: self.user_id = user_id + if password is not None: + self.password = password APIConfiguration.__init__(self, *args, **kwargs) @property @@ -110,27 +110,6 @@ def domain(self, domain): self._domain = domain - @property - def password(self): - """Gets the password of this PayVisionConfiguration. # noqa: E501 - - - :return: The password of this PayVisionConfiguration. # noqa: E501 - :rtype: str - """ - return self._password - - @password.setter - def password(self, password): - """Sets the password of this PayVisionConfiguration. - - - :param password: The password of this PayVisionConfiguration. # noqa: E501 - :type: str - """ - - self._password = password - @property def entity_id(self): """Gets the entity_id of this PayVisionConfiguration. # noqa: E501 @@ -173,6 +152,27 @@ def user_id(self, user_id): self._user_id = user_id + @property + def password(self): + """Gets the password of this PayVisionConfiguration. # noqa: E501 + + + :return: The password of this PayVisionConfiguration. # noqa: E501 + :rtype: str + """ + return self._password + + @password.setter + def password(self, password): + """Sets the password of this PayVisionConfiguration. + + + :param password: The password of this PayVisionConfiguration. # noqa: E501 + :type: str + """ + + self._password = password + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/billforward/models/refund.py b/billforward/models/refund.py index 71bf647..35394b8 100644 --- a/billforward/models/refund.py +++ b/billforward/models/refund.py @@ -61,8 +61,8 @@ class Refund(object): 'created_by': 'str', 'type': 'str', 'state': 'str', - 'refunded_payment': 'Payment', 'refunded_value': 'float', + 'refunded_payment': 'Payment', 'account': 'str' } @@ -100,12 +100,12 @@ class Refund(object): 'created_by': 'createdBy', 'type': 'type', 'state': 'state', - 'refunded_payment': 'refundedPayment', 'refunded_value': 'refundedValue', + 'refunded_payment': 'refundedPayment', 'account': 'account' } - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, account_id=None, reason=None, nominal_value=None, value=None, refunded=None, actual_value=None, nominal_refunded_value=None, actual_refunded_value=None, refund_state=None, refund_type=None, refund_nature=None, last_execution_attempt=None, next_execution_attempt=None, final_execution_attempt=None, refund_completed=None, currency=None, payment_method_id=None, invoice_payment_id=None, refund_invoice_payment_id=None, original_payment_id=None, original_gateway_payment_reference=None, refund_payment_id=None, invoice_id=None, receipt_id=None, original_receipt_id=None, created_by=None, type=None, state=None, refunded_payment=None, refunded_value=None, account=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, account_id=None, reason=None, nominal_value=None, value=None, refunded=None, actual_value=None, nominal_refunded_value=None, actual_refunded_value=None, refund_state=None, refund_type=None, refund_nature=None, last_execution_attempt=None, next_execution_attempt=None, final_execution_attempt=None, refund_completed=None, currency=None, payment_method_id=None, invoice_payment_id=None, refund_invoice_payment_id=None, original_payment_id=None, original_gateway_payment_reference=None, refund_payment_id=None, invoice_id=None, receipt_id=None, original_receipt_id=None, created_by=None, type=None, state=None, refunded_value=None, refunded_payment=None, account=None): # noqa: E501 """Refund - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -140,8 +140,8 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self._created_by = None self._type = None self._state = None - self._refunded_payment = None self._refunded_value = None + self._refunded_payment = None self._account = None self.discriminator = None if created is not None: @@ -202,10 +202,10 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self.type = type if state is not None: self.state = state - if refunded_payment is not None: - self.refunded_payment = refunded_payment if refunded_value is not None: self.refunded_value = refunded_value + if refunded_payment is not None: + self.refunded_payment = refunded_payment if account is not None: self.account = account @@ -948,27 +948,6 @@ def state(self, state): self._state = state - @property - def refunded_payment(self): - """Gets the refunded_payment of this Refund. # noqa: E501 - - - :return: The refunded_payment of this Refund. # noqa: E501 - :rtype: Payment - """ - return self._refunded_payment - - @refunded_payment.setter - def refunded_payment(self, refunded_payment): - """Sets the refunded_payment of this Refund. - - - :param refunded_payment: The refunded_payment of this Refund. # noqa: E501 - :type: Payment - """ - - self._refunded_payment = refunded_payment - @property def refunded_value(self): """Gets the refunded_value of this Refund. # noqa: E501 @@ -990,6 +969,27 @@ def refunded_value(self, refunded_value): self._refunded_value = refunded_value + @property + def refunded_payment(self): + """Gets the refunded_payment of this Refund. # noqa: E501 + + + :return: The refunded_payment of this Refund. # noqa: E501 + :rtype: Payment + """ + return self._refunded_payment + + @refunded_payment.setter + def refunded_payment(self, refunded_payment): + """Sets the refunded_payment of this Refund. + + + :param refunded_payment: The refunded_payment of this Refund. # noqa: E501 + :type: Payment + """ + + self._refunded_payment = refunded_payment + @property def account(self): """Gets the account of this Refund. # noqa: E501 diff --git a/billforward/models/shuttle_configuration.py b/billforward/models/shuttle_configuration.py index 6b5eae0..2860549 100644 --- a/billforward/models/shuttle_configuration.py +++ b/billforward/models/shuttle_configuration.py @@ -29,56 +29,35 @@ class ShuttleConfiguration(APIConfiguration): and the value is json key in definition. """ swagger_types = { - 'percentage_for_other_payment_methods': 'float', 'hosted_payment_config': 'HostedPaymentConfig', - 'instance_key': 'str' + 'instance_key': 'str', + 'percentage_for_other_payment_methods': 'float' } if hasattr(APIConfiguration, "swagger_types"): swagger_types.update(APIConfiguration.swagger_types) attribute_map = { - 'percentage_for_other_payment_methods': 'percentageForOtherPaymentMethods', 'hosted_payment_config': 'hostedPaymentConfig', - 'instance_key': 'instanceKey' + 'instance_key': 'instanceKey', + 'percentage_for_other_payment_methods': 'percentageForOtherPaymentMethods' } if hasattr(APIConfiguration, "attribute_map"): attribute_map.update(APIConfiguration.attribute_map) - def __init__(self, percentage_for_other_payment_methods=None, hosted_payment_config=None, instance_key=None, *args, **kwargs): # noqa: E501 + def __init__(self, hosted_payment_config=None, instance_key=None, percentage_for_other_payment_methods=None, *args, **kwargs): # noqa: E501 """ShuttleConfiguration - a model defined in Swagger""" # noqa: E501 - self._percentage_for_other_payment_methods = None self._hosted_payment_config = None self._instance_key = None + self._percentage_for_other_payment_methods = None self.discriminator = None - if percentage_for_other_payment_methods is not None: - self.percentage_for_other_payment_methods = percentage_for_other_payment_methods if hosted_payment_config is not None: self.hosted_payment_config = hosted_payment_config if instance_key is not None: self.instance_key = instance_key + if percentage_for_other_payment_methods is not None: + self.percentage_for_other_payment_methods = percentage_for_other_payment_methods APIConfiguration.__init__(self, *args, **kwargs) - @property - def percentage_for_other_payment_methods(self): - """Gets the percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 - - - :return: The percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 - :rtype: float - """ - return self._percentage_for_other_payment_methods - - @percentage_for_other_payment_methods.setter - def percentage_for_other_payment_methods(self, percentage_for_other_payment_methods): - """Sets the percentage_for_other_payment_methods of this ShuttleConfiguration. - - - :param percentage_for_other_payment_methods: The percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 - :type: float - """ - - self._percentage_for_other_payment_methods = percentage_for_other_payment_methods - @property def hosted_payment_config(self): """Gets the hosted_payment_config of this ShuttleConfiguration. # noqa: E501 @@ -121,6 +100,27 @@ def instance_key(self, instance_key): self._instance_key = instance_key + @property + def percentage_for_other_payment_methods(self): + """Gets the percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 + + + :return: The percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 + :rtype: float + """ + return self._percentage_for_other_payment_methods + + @percentage_for_other_payment_methods.setter + def percentage_for_other_payment_methods(self, percentage_for_other_payment_methods): + """Sets the percentage_for_other_payment_methods of this ShuttleConfiguration. + + + :param percentage_for_other_payment_methods: The percentage_for_other_payment_methods of this ShuttleConfiguration. # noqa: E501 + :type: float + """ + + self._percentage_for_other_payment_methods = percentage_for_other_payment_methods + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/billforward/models/tokenization_epxredirect_body.py b/billforward/models/tokenization_epxredirect_body.py deleted file mode 100644 index eeae190..0000000 --- a/billforward/models/tokenization_epxredirect_body.py +++ /dev/null @@ -1,916 +0,0 @@ -# coding: utf-8 - -""" - Billforward API - - This is documentation for the Billforward API. You can find out more at billforward.io. # noqa: E501 - - OpenAPI spec version: 1.0 - Contact: team@billforward.net - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -import pprint -import re # noqa: F401 - -import six - -class TokenizationEpxredirectBody(object): - """NOTE: This class is auto generated by the swagger code generator program. - - Do not edit the class manually. - """ - """ - Attributes: - swagger_types (dict): The key is attribute name - and the value is attribute type. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - """ - swagger_types = { - 'cust_nbr': 'str', - 'merch_nbr': 'str', - 'dba_nbr': 'str', - 'terminal_nbr': 'str', - 'tran_code': 'str', - 'amount': 'str', - 'auth_account': 'str', - 'first_name': 'str', - 'last_name': 'str', - 'exp_date': 'str', - 'bp_resp_code': 'str', - 'bp_resp_text': 'str', - 'bp_field_errors': 'str', - 'msg_version': 'str', - 'tran_type': 'str', - 'tran_nbr': 'str', - 'local_date': 'str', - 'local_time': 'str', - 'auth_guid': 'str', - 'auth_resp': 'str', - 'auth_code': 'str', - 'auth_cvv2': 'str', - 'auth_resp_text': 'str', - 'auth_card_type': 'str', - 'auth_tran_date_gmt': 'str', - 'auth_amount_requested': 'str', - 'auth_amount': 'str', - 'auth_currency_code': 'str', - 'network_response': 'str', - 'auth_masked_account_nbr': 'str', - 'user_data_9': 'str', - 'user_data_10': 'str' - } - - attribute_map = { - 'cust_nbr': 'CUST_NBR', - 'merch_nbr': 'MERCH_NBR', - 'dba_nbr': 'DBA_NBR', - 'terminal_nbr': 'TERMINAL_NBR', - 'tran_code': 'TRAN_CODE', - 'amount': 'AMOUNT', - 'auth_account': 'AUTH_ACCOUNT', - 'first_name': 'FIRST_NAME', - 'last_name': 'LAST_NAME', - 'exp_date': 'EXP_DATE', - 'bp_resp_code': 'BP_RESP_CODE', - 'bp_resp_text': 'BP_RESP_TEXT', - 'bp_field_errors': 'BP_FIELD_ERRORS', - 'msg_version': 'MSG_VERSION', - 'tran_type': 'TRAN_TYPE', - 'tran_nbr': 'TRAN_NBR', - 'local_date': 'LOCAL_DATE', - 'local_time': 'LOCAL_TIME', - 'auth_guid': 'AUTH_GUID', - 'auth_resp': 'AUTH_RESP', - 'auth_code': 'AUTH_CODE', - 'auth_cvv2': 'AUTH_CVV2', - 'auth_resp_text': 'AUTH_RESP_TEXT', - 'auth_card_type': 'AUTH_CARD_TYPE', - 'auth_tran_date_gmt': 'AUTH_TRAN_DATE_GMT', - 'auth_amount_requested': 'AUTH_AMOUNT_REQUESTED', - 'auth_amount': 'AUTH_AMOUNT', - 'auth_currency_code': 'AUTH_CURRENCY_CODE', - 'network_response': 'NETWORK_RESPONSE', - 'auth_masked_account_nbr': 'AUTH_MASKED_ACCOUNT_NBR', - 'user_data_9': 'USER_DATA_9', - 'user_data_10': 'USER_DATA_10' - } - - def __init__(self, cust_nbr=None, merch_nbr=None, dba_nbr=None, terminal_nbr=None, tran_code=None, amount=None, auth_account=None, first_name=None, last_name=None, exp_date=None, bp_resp_code=None, bp_resp_text=None, bp_field_errors=None, msg_version=None, tran_type=None, tran_nbr=None, local_date=None, local_time=None, auth_guid=None, auth_resp=None, auth_code=None, auth_cvv2=None, auth_resp_text=None, auth_card_type=None, auth_tran_date_gmt=None, auth_amount_requested=None, auth_amount=None, auth_currency_code=None, network_response=None, auth_masked_account_nbr=None, user_data_9=None, user_data_10=None): # noqa: E501 - """TokenizationEpxredirectBody - a model defined in Swagger""" # noqa: E501 - self._cust_nbr = None - self._merch_nbr = None - self._dba_nbr = None - self._terminal_nbr = None - self._tran_code = None - self._amount = None - self._auth_account = None - self._first_name = None - self._last_name = None - self._exp_date = None - self._bp_resp_code = None - self._bp_resp_text = None - self._bp_field_errors = None - self._msg_version = None - self._tran_type = None - self._tran_nbr = None - self._local_date = None - self._local_time = None - self._auth_guid = None - self._auth_resp = None - self._auth_code = None - self._auth_cvv2 = None - self._auth_resp_text = None - self._auth_card_type = None - self._auth_tran_date_gmt = None - self._auth_amount_requested = None - self._auth_amount = None - self._auth_currency_code = None - self._network_response = None - self._auth_masked_account_nbr = None - self._user_data_9 = None - self._user_data_10 = None - self.discriminator = None - if cust_nbr is not None: - self.cust_nbr = cust_nbr - if merch_nbr is not None: - self.merch_nbr = merch_nbr - if dba_nbr is not None: - self.dba_nbr = dba_nbr - if terminal_nbr is not None: - self.terminal_nbr = terminal_nbr - if tran_code is not None: - self.tran_code = tran_code - if amount is not None: - self.amount = amount - if auth_account is not None: - self.auth_account = auth_account - if first_name is not None: - self.first_name = first_name - if last_name is not None: - self.last_name = last_name - if exp_date is not None: - self.exp_date = exp_date - if bp_resp_code is not None: - self.bp_resp_code = bp_resp_code - if bp_resp_text is not None: - self.bp_resp_text = bp_resp_text - if bp_field_errors is not None: - self.bp_field_errors = bp_field_errors - if msg_version is not None: - self.msg_version = msg_version - if tran_type is not None: - self.tran_type = tran_type - if tran_nbr is not None: - self.tran_nbr = tran_nbr - if local_date is not None: - self.local_date = local_date - if local_time is not None: - self.local_time = local_time - if auth_guid is not None: - self.auth_guid = auth_guid - if auth_resp is not None: - self.auth_resp = auth_resp - if auth_code is not None: - self.auth_code = auth_code - if auth_cvv2 is not None: - self.auth_cvv2 = auth_cvv2 - if auth_resp_text is not None: - self.auth_resp_text = auth_resp_text - if auth_card_type is not None: - self.auth_card_type = auth_card_type - if auth_tran_date_gmt is not None: - self.auth_tran_date_gmt = auth_tran_date_gmt - if auth_amount_requested is not None: - self.auth_amount_requested = auth_amount_requested - if auth_amount is not None: - self.auth_amount = auth_amount - if auth_currency_code is not None: - self.auth_currency_code = auth_currency_code - if network_response is not None: - self.network_response = network_response - if auth_masked_account_nbr is not None: - self.auth_masked_account_nbr = auth_masked_account_nbr - if user_data_9 is not None: - self.user_data_9 = user_data_9 - if user_data_10 is not None: - self.user_data_10 = user_data_10 - - @property - def cust_nbr(self): - """Gets the cust_nbr of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The cust_nbr of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._cust_nbr - - @cust_nbr.setter - def cust_nbr(self, cust_nbr): - """Sets the cust_nbr of this TokenizationEpxredirectBody. - - - :param cust_nbr: The cust_nbr of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._cust_nbr = cust_nbr - - @property - def merch_nbr(self): - """Gets the merch_nbr of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The merch_nbr of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._merch_nbr - - @merch_nbr.setter - def merch_nbr(self, merch_nbr): - """Sets the merch_nbr of this TokenizationEpxredirectBody. - - - :param merch_nbr: The merch_nbr of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._merch_nbr = merch_nbr - - @property - def dba_nbr(self): - """Gets the dba_nbr of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The dba_nbr of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._dba_nbr - - @dba_nbr.setter - def dba_nbr(self, dba_nbr): - """Sets the dba_nbr of this TokenizationEpxredirectBody. - - - :param dba_nbr: The dba_nbr of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._dba_nbr = dba_nbr - - @property - def terminal_nbr(self): - """Gets the terminal_nbr of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The terminal_nbr of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._terminal_nbr - - @terminal_nbr.setter - def terminal_nbr(self, terminal_nbr): - """Sets the terminal_nbr of this TokenizationEpxredirectBody. - - - :param terminal_nbr: The terminal_nbr of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._terminal_nbr = terminal_nbr - - @property - def tran_code(self): - """Gets the tran_code of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The tran_code of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._tran_code - - @tran_code.setter - def tran_code(self, tran_code): - """Sets the tran_code of this TokenizationEpxredirectBody. - - - :param tran_code: The tran_code of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._tran_code = tran_code - - @property - def amount(self): - """Gets the amount of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The amount of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._amount - - @amount.setter - def amount(self, amount): - """Sets the amount of this TokenizationEpxredirectBody. - - - :param amount: The amount of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._amount = amount - - @property - def auth_account(self): - """Gets the auth_account of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The auth_account of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._auth_account - - @auth_account.setter - def auth_account(self, auth_account): - """Sets the auth_account of this TokenizationEpxredirectBody. - - - :param auth_account: The auth_account of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._auth_account = auth_account - - @property - def first_name(self): - """Gets the first_name of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The first_name of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._first_name - - @first_name.setter - def first_name(self, first_name): - """Sets the first_name of this TokenizationEpxredirectBody. - - - :param first_name: The first_name of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._first_name = first_name - - @property - def last_name(self): - """Gets the last_name of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The last_name of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._last_name - - @last_name.setter - def last_name(self, last_name): - """Sets the last_name of this TokenizationEpxredirectBody. - - - :param last_name: The last_name of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._last_name = last_name - - @property - def exp_date(self): - """Gets the exp_date of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The exp_date of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._exp_date - - @exp_date.setter - def exp_date(self, exp_date): - """Sets the exp_date of this TokenizationEpxredirectBody. - - - :param exp_date: The exp_date of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._exp_date = exp_date - - @property - def bp_resp_code(self): - """Gets the bp_resp_code of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The bp_resp_code of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._bp_resp_code - - @bp_resp_code.setter - def bp_resp_code(self, bp_resp_code): - """Sets the bp_resp_code of this TokenizationEpxredirectBody. - - - :param bp_resp_code: The bp_resp_code of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._bp_resp_code = bp_resp_code - - @property - def bp_resp_text(self): - """Gets the bp_resp_text of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The bp_resp_text of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._bp_resp_text - - @bp_resp_text.setter - def bp_resp_text(self, bp_resp_text): - """Sets the bp_resp_text of this TokenizationEpxredirectBody. - - - :param bp_resp_text: The bp_resp_text of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._bp_resp_text = bp_resp_text - - @property - def bp_field_errors(self): - """Gets the bp_field_errors of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The bp_field_errors of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._bp_field_errors - - @bp_field_errors.setter - def bp_field_errors(self, bp_field_errors): - """Sets the bp_field_errors of this TokenizationEpxredirectBody. - - - :param bp_field_errors: The bp_field_errors of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._bp_field_errors = bp_field_errors - - @property - def msg_version(self): - """Gets the msg_version of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The msg_version of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._msg_version - - @msg_version.setter - def msg_version(self, msg_version): - """Sets the msg_version of this TokenizationEpxredirectBody. - - - :param msg_version: The msg_version of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._msg_version = msg_version - - @property - def tran_type(self): - """Gets the tran_type of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The tran_type of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._tran_type - - @tran_type.setter - def tran_type(self, tran_type): - """Sets the tran_type of this TokenizationEpxredirectBody. - - - :param tran_type: The tran_type of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._tran_type = tran_type - - @property - def tran_nbr(self): - """Gets the tran_nbr of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The tran_nbr of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._tran_nbr - - @tran_nbr.setter - def tran_nbr(self, tran_nbr): - """Sets the tran_nbr of this TokenizationEpxredirectBody. - - - :param tran_nbr: The tran_nbr of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._tran_nbr = tran_nbr - - @property - def local_date(self): - """Gets the local_date of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The local_date of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._local_date - - @local_date.setter - def local_date(self, local_date): - """Sets the local_date of this TokenizationEpxredirectBody. - - - :param local_date: The local_date of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._local_date = local_date - - @property - def local_time(self): - """Gets the local_time of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The local_time of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._local_time - - @local_time.setter - def local_time(self, local_time): - """Sets the local_time of this TokenizationEpxredirectBody. - - - :param local_time: The local_time of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._local_time = local_time - - @property - def auth_guid(self): - """Gets the auth_guid of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The auth_guid of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._auth_guid - - @auth_guid.setter - def auth_guid(self, auth_guid): - """Sets the auth_guid of this TokenizationEpxredirectBody. - - - :param auth_guid: The auth_guid of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._auth_guid = auth_guid - - @property - def auth_resp(self): - """Gets the auth_resp of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The auth_resp of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._auth_resp - - @auth_resp.setter - def auth_resp(self, auth_resp): - """Sets the auth_resp of this TokenizationEpxredirectBody. - - - :param auth_resp: The auth_resp of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._auth_resp = auth_resp - - @property - def auth_code(self): - """Gets the auth_code of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The auth_code of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._auth_code - - @auth_code.setter - def auth_code(self, auth_code): - """Sets the auth_code of this TokenizationEpxredirectBody. - - - :param auth_code: The auth_code of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._auth_code = auth_code - - @property - def auth_cvv2(self): - """Gets the auth_cvv2 of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The auth_cvv2 of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._auth_cvv2 - - @auth_cvv2.setter - def auth_cvv2(self, auth_cvv2): - """Sets the auth_cvv2 of this TokenizationEpxredirectBody. - - - :param auth_cvv2: The auth_cvv2 of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._auth_cvv2 = auth_cvv2 - - @property - def auth_resp_text(self): - """Gets the auth_resp_text of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The auth_resp_text of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._auth_resp_text - - @auth_resp_text.setter - def auth_resp_text(self, auth_resp_text): - """Sets the auth_resp_text of this TokenizationEpxredirectBody. - - - :param auth_resp_text: The auth_resp_text of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._auth_resp_text = auth_resp_text - - @property - def auth_card_type(self): - """Gets the auth_card_type of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The auth_card_type of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._auth_card_type - - @auth_card_type.setter - def auth_card_type(self, auth_card_type): - """Sets the auth_card_type of this TokenizationEpxredirectBody. - - - :param auth_card_type: The auth_card_type of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._auth_card_type = auth_card_type - - @property - def auth_tran_date_gmt(self): - """Gets the auth_tran_date_gmt of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The auth_tran_date_gmt of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._auth_tran_date_gmt - - @auth_tran_date_gmt.setter - def auth_tran_date_gmt(self, auth_tran_date_gmt): - """Sets the auth_tran_date_gmt of this TokenizationEpxredirectBody. - - - :param auth_tran_date_gmt: The auth_tran_date_gmt of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._auth_tran_date_gmt = auth_tran_date_gmt - - @property - def auth_amount_requested(self): - """Gets the auth_amount_requested of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The auth_amount_requested of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._auth_amount_requested - - @auth_amount_requested.setter - def auth_amount_requested(self, auth_amount_requested): - """Sets the auth_amount_requested of this TokenizationEpxredirectBody. - - - :param auth_amount_requested: The auth_amount_requested of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._auth_amount_requested = auth_amount_requested - - @property - def auth_amount(self): - """Gets the auth_amount of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The auth_amount of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._auth_amount - - @auth_amount.setter - def auth_amount(self, auth_amount): - """Sets the auth_amount of this TokenizationEpxredirectBody. - - - :param auth_amount: The auth_amount of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._auth_amount = auth_amount - - @property - def auth_currency_code(self): - """Gets the auth_currency_code of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The auth_currency_code of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._auth_currency_code - - @auth_currency_code.setter - def auth_currency_code(self, auth_currency_code): - """Sets the auth_currency_code of this TokenizationEpxredirectBody. - - - :param auth_currency_code: The auth_currency_code of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._auth_currency_code = auth_currency_code - - @property - def network_response(self): - """Gets the network_response of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The network_response of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._network_response - - @network_response.setter - def network_response(self, network_response): - """Sets the network_response of this TokenizationEpxredirectBody. - - - :param network_response: The network_response of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._network_response = network_response - - @property - def auth_masked_account_nbr(self): - """Gets the auth_masked_account_nbr of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The auth_masked_account_nbr of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._auth_masked_account_nbr - - @auth_masked_account_nbr.setter - def auth_masked_account_nbr(self, auth_masked_account_nbr): - """Sets the auth_masked_account_nbr of this TokenizationEpxredirectBody. - - - :param auth_masked_account_nbr: The auth_masked_account_nbr of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._auth_masked_account_nbr = auth_masked_account_nbr - - @property - def user_data_9(self): - """Gets the user_data_9 of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The user_data_9 of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._user_data_9 - - @user_data_9.setter - def user_data_9(self, user_data_9): - """Sets the user_data_9 of this TokenizationEpxredirectBody. - - - :param user_data_9: The user_data_9 of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._user_data_9 = user_data_9 - - @property - def user_data_10(self): - """Gets the user_data_10 of this TokenizationEpxredirectBody. # noqa: E501 - - - :return: The user_data_10 of this TokenizationEpxredirectBody. # noqa: E501 - :rtype: str - """ - return self._user_data_10 - - @user_data_10.setter - def user_data_10(self, user_data_10): - """Sets the user_data_10 of this TokenizationEpxredirectBody. - - - :param user_data_10: The user_data_10 of this TokenizationEpxredirectBody. # noqa: E501 - :type: str - """ - - self._user_data_10 = user_data_10 - - def to_dict(self): - """Returns the model properties as a dict""" - result = {} - - for attr, _ in six.iteritems(self.swagger_types): - value = getattr(self, attr) - if isinstance(value, list): - result[attr] = list(map( - lambda x: x.to_dict() if hasattr(x, "to_dict") else x, - value - )) - elif hasattr(value, "to_dict"): - result[attr] = value.to_dict() - elif isinstance(value, dict): - result[attr] = dict(map( - lambda item: (item[0], item[1].to_dict()) - if hasattr(item[1], "to_dict") else item, - value.items() - )) - else: - result[attr] = value - if issubclass(TokenizationEpxredirectBody, dict): - for key, value in self.items(): - result[key] = value - - return result - - def to_str(self): - """Returns the string representation of the model""" - return pprint.pformat(self.to_dict()) - - def __repr__(self): - """For `print` and `pprint`""" - return self.to_str() - - def __eq__(self, other): - """Returns true if both objects are equal""" - if not isinstance(other, TokenizationEpxredirectBody): - return False - - return self.__dict__ == other.__dict__ - - def __ne__(self, other): - """Returns true if both objects are not equal""" - return not self == other diff --git a/billforward/models/trust_commerce_configuration.py b/billforward/models/trust_commerce_configuration.py index 6e04abe..3fdb230 100644 --- a/billforward/models/trust_commerce_configuration.py +++ b/billforward/models/trust_commerce_configuration.py @@ -29,71 +29,71 @@ class TrustCommerceConfiguration(APIConfiguration): and the value is json key in definition. """ swagger_types = { - 'password': 'str', - 'cust_id': 'str' + 'cust_id': 'str', + 'password': 'str' } if hasattr(APIConfiguration, "swagger_types"): swagger_types.update(APIConfiguration.swagger_types) attribute_map = { - 'password': 'password', - 'cust_id': 'custID' + 'cust_id': 'custID', + 'password': 'password' } if hasattr(APIConfiguration, "attribute_map"): attribute_map.update(APIConfiguration.attribute_map) - def __init__(self, password=None, cust_id=None, *args, **kwargs): # noqa: E501 + def __init__(self, cust_id=None, password=None, *args, **kwargs): # noqa: E501 """TrustCommerceConfiguration - a model defined in Swagger""" # noqa: E501 - self._password = None self._cust_id = None + self._password = None self.discriminator = None - if password is not None: - self.password = password if cust_id is not None: self.cust_id = cust_id + if password is not None: + self.password = password APIConfiguration.__init__(self, *args, **kwargs) @property - def password(self): - """Gets the password of this TrustCommerceConfiguration. # noqa: E501 + def cust_id(self): + """Gets the cust_id of this TrustCommerceConfiguration. # noqa: E501 - :return: The password of this TrustCommerceConfiguration. # noqa: E501 + :return: The cust_id of this TrustCommerceConfiguration. # noqa: E501 :rtype: str """ - return self._password + return self._cust_id - @password.setter - def password(self, password): - """Sets the password of this TrustCommerceConfiguration. + @cust_id.setter + def cust_id(self, cust_id): + """Sets the cust_id of this TrustCommerceConfiguration. - :param password: The password of this TrustCommerceConfiguration. # noqa: E501 + :param cust_id: The cust_id of this TrustCommerceConfiguration. # noqa: E501 :type: str """ - self._password = password + self._cust_id = cust_id @property - def cust_id(self): - """Gets the cust_id of this TrustCommerceConfiguration. # noqa: E501 + def password(self): + """Gets the password of this TrustCommerceConfiguration. # noqa: E501 - :return: The cust_id of this TrustCommerceConfiguration. # noqa: E501 + :return: The password of this TrustCommerceConfiguration. # noqa: E501 :rtype: str """ - return self._cust_id + return self._password - @cust_id.setter - def cust_id(self, cust_id): - """Sets the cust_id of this TrustCommerceConfiguration. + @password.setter + def password(self, password): + """Sets the password of this TrustCommerceConfiguration. - :param cust_id: The cust_id of this TrustCommerceConfiguration. # noqa: E501 + :param password: The password of this TrustCommerceConfiguration. # noqa: E501 :type: str """ - self._cust_id = cust_id + self._password = password def to_dict(self): """Returns the model properties as a dict""" diff --git a/billforward/models/typed_query_result_wrapper_account.py b/billforward/models/typed_query_result_wrapper_account.py index fbcfee2..3582092 100644 --- a/billforward/models/typed_query_result_wrapper_account.py +++ b/billforward/models/typed_query_result_wrapper_account.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperAccount(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Account', 'typed_results': 'list[Account]', + 'typed_single_result': 'Account', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperAccount(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperAccount - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperAccount. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperAccount. # noqa: E501 - :rtype: Account - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperAccount. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAccount. # noqa: E501 - :type: Account - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperAccount. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperAccount. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperAccount. # noqa: E501 + :rtype: Account + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperAccount. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAccount. # noqa: E501 + :type: Account + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperAccount. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_address.py b/billforward/models/typed_query_result_wrapper_address.py index 94aea13..87d729e 100644 --- a/billforward/models/typed_query_result_wrapper_address.py +++ b/billforward/models/typed_query_result_wrapper_address.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperAddress(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Address', 'typed_results': 'list[Address]', + 'typed_single_result': 'Address', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperAddress(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperAddress - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperAddress. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperAddress. # noqa: E501 - :rtype: Address - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperAddress. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAddress. # noqa: E501 - :type: Address - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperAddress. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperAddress. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperAddress. # noqa: E501 + :rtype: Address + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperAddress. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAddress. # noqa: E501 + :type: Address + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperAddress. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_amendment.py b/billforward/models/typed_query_result_wrapper_amendment.py index 6467416..5815084 100644 --- a/billforward/models/typed_query_result_wrapper_amendment.py +++ b/billforward/models/typed_query_result_wrapper_amendment.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperAmendment(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Amendment', 'typed_results': 'list[Amendment]', + 'typed_single_result': 'Amendment', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperAmendment(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperAmendment - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperAmendment. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperAmendment. # noqa: E501 - :rtype: Amendment - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperAmendment. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAmendment. # noqa: E501 - :type: Amendment - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperAmendment. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperAmendment. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperAmendment. # noqa: E501 + :rtype: Amendment + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperAmendment. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAmendment. # noqa: E501 + :type: Amendment + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperAmendment. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_api_quote.py b/billforward/models/typed_query_result_wrapper_api_quote.py index 0c29f71..880eb4c 100644 --- a/billforward/models/typed_query_result_wrapper_api_quote.py +++ b/billforward/models/typed_query_result_wrapper_api_quote.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperAPIQuote(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'ApiQuote', 'typed_results': 'list[ApiQuote]', + 'typed_single_result': 'ApiQuote', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperAPIQuote(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperAPIQuote - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperAPIQuote. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperAPIQuote. # noqa: E501 - :rtype: ApiQuote - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperAPIQuote. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAPIQuote. # noqa: E501 - :type: ApiQuote - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperAPIQuote. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :rtype: ApiQuote + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperAPIQuote. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAPIQuote. # noqa: E501 + :type: ApiQuote + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperAPIQuote. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_avatax_configuration.py b/billforward/models/typed_query_result_wrapper_avatax_configuration.py index 60c3822..72e6293 100644 --- a/billforward/models/typed_query_result_wrapper_avatax_configuration.py +++ b/billforward/models/typed_query_result_wrapper_avatax_configuration.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperAvataxConfiguration(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'AvataxConfiguration', 'typed_results': 'list[AvataxConfiguration]', + 'typed_single_result': 'AvataxConfiguration', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperAvataxConfiguration(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperAvataxConfiguration - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 - :rtype: AvataxConfiguration - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperAvataxConfiguration. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 - :type: AvataxConfiguration - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :rtype: AvataxConfiguration + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperAvataxConfiguration. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 + :type: AvataxConfiguration + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperAvataxConfiguration. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_bf_permission.py b/billforward/models/typed_query_result_wrapper_bf_permission.py index 7fbd8ed..a723d09 100644 --- a/billforward/models/typed_query_result_wrapper_bf_permission.py +++ b/billforward/models/typed_query_result_wrapper_bf_permission.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperBFPermission(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'BFPermission', 'typed_results': 'list[BFPermission]', + 'typed_single_result': 'BFPermission', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperBFPermission(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperBFPermission - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperBFPermission. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperBFPermission. # noqa: E501 - :rtype: BFPermission - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperBFPermission. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperBFPermission. # noqa: E501 - :type: BFPermission - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperBFPermission. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperBFPermission. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :rtype: BFPermission + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperBFPermission. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperBFPermission. # noqa: E501 + :type: BFPermission + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperBFPermission. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_braintree_token.py b/billforward/models/typed_query_result_wrapper_braintree_token.py index 1e2517f..55ec530 100644 --- a/billforward/models/typed_query_result_wrapper_braintree_token.py +++ b/billforward/models/typed_query_result_wrapper_braintree_token.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperBraintreeToken(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'BraintreeToken', 'typed_results': 'list[BraintreeToken]', + 'typed_single_result': 'BraintreeToken', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperBraintreeToken(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperBraintreeToken - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 - :rtype: BraintreeToken - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperBraintreeToken. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 - :type: BraintreeToken - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :rtype: BraintreeToken + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperBraintreeToken. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 + :type: BraintreeToken + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperBraintreeToken. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_contract.py b/billforward/models/typed_query_result_wrapper_contract.py index 4a344e7..62a2725 100644 --- a/billforward/models/typed_query_result_wrapper_contract.py +++ b/billforward/models/typed_query_result_wrapper_contract.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperContract(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Contract', 'typed_results': 'list[Contract]', + 'typed_single_result': 'Contract', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperContract(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperContract - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperContract. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperContract. # noqa: E501 - :rtype: Contract - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperContract. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperContract. # noqa: E501 - :type: Contract - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperContract. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperContract. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperContract. # noqa: E501 + :rtype: Contract + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperContract. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperContract. # noqa: E501 + :type: Contract + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperContract. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_coupon.py b/billforward/models/typed_query_result_wrapper_coupon.py index 4cf6d1e..a35cc92 100644 --- a/billforward/models/typed_query_result_wrapper_coupon.py +++ b/billforward/models/typed_query_result_wrapper_coupon.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperCoupon(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Coupon', 'typed_results': 'list[Coupon]', + 'typed_single_result': 'Coupon', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperCoupon(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperCoupon - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperCoupon. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperCoupon. # noqa: E501 - :rtype: Coupon - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperCoupon. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperCoupon. # noqa: E501 - :type: Coupon - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperCoupon. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperCoupon. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperCoupon. # noqa: E501 + :rtype: Coupon + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperCoupon. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperCoupon. # noqa: E501 + :type: Coupon + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperCoupon. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_credit_note.py b/billforward/models/typed_query_result_wrapper_credit_note.py index 561782e..ce32c81 100644 --- a/billforward/models/typed_query_result_wrapper_credit_note.py +++ b/billforward/models/typed_query_result_wrapper_credit_note.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperCreditNote(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'CreditNote', 'typed_results': 'list[CreditNote]', + 'typed_single_result': 'CreditNote', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperCreditNote(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperCreditNote - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperCreditNote. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperCreditNote. # noqa: E501 - :rtype: CreditNote - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperCreditNote. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperCreditNote. # noqa: E501 - :type: CreditNote - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperCreditNote. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperCreditNote. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :rtype: CreditNote + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperCreditNote. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperCreditNote. # noqa: E501 + :type: CreditNote + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperCreditNote. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_data_sync_job_response.py b/billforward/models/typed_query_result_wrapper_data_sync_job_response.py index a3168eb..8cc0117 100644 --- a/billforward/models/typed_query_result_wrapper_data_sync_job_response.py +++ b/billforward/models/typed_query_result_wrapper_data_sync_job_response.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperDataSyncJobResponse(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'DataSyncJobResponse', 'typed_results': 'list[DataSyncJobResponse]', + 'typed_single_result': 'DataSyncJobResponse', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperDataSyncJobResponse(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperDataSyncJobResponse - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 - :rtype: DataSyncJobResponse - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperDataSyncJobResponse. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 - :type: DataSyncJobResponse - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :rtype: DataSyncJobResponse + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperDataSyncJobResponse. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 + :type: DataSyncJobResponse + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperDataSyncJobResponse. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_dunning_line.py b/billforward/models/typed_query_result_wrapper_dunning_line.py index de6b18b..314de4e 100644 --- a/billforward/models/typed_query_result_wrapper_dunning_line.py +++ b/billforward/models/typed_query_result_wrapper_dunning_line.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperDunningLine(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'DunningLine', 'typed_results': 'list[DunningLine]', + 'typed_single_result': 'DunningLine', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperDunningLine(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperDunningLine - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperDunningLine. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperDunningLine. # noqa: E501 - :rtype: DunningLine - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperDunningLine. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperDunningLine. # noqa: E501 - :type: DunningLine - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperDunningLine. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperDunningLine. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :rtype: DunningLine + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperDunningLine. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperDunningLine. # noqa: E501 + :type: DunningLine + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperDunningLine. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_invoice.py b/billforward/models/typed_query_result_wrapper_invoice.py index 54a6d28..4c66e03 100644 --- a/billforward/models/typed_query_result_wrapper_invoice.py +++ b/billforward/models/typed_query_result_wrapper_invoice.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperInvoice(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Invoice', 'typed_results': 'list[Invoice]', + 'typed_single_result': 'Invoice', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperInvoice(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperInvoice - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperInvoice. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperInvoice. # noqa: E501 - :rtype: Invoice - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperInvoice. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperInvoice. # noqa: E501 - :type: Invoice - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperInvoice. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperInvoice. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperInvoice. # noqa: E501 + :rtype: Invoice + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperInvoice. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperInvoice. # noqa: E501 + :type: Invoice + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperInvoice. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_invoice_line_payment.py b/billforward/models/typed_query_result_wrapper_invoice_line_payment.py index db45866..08eb434 100644 --- a/billforward/models/typed_query_result_wrapper_invoice_line_payment.py +++ b/billforward/models/typed_query_result_wrapper_invoice_line_payment.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperInvoiceLinePayment(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'InvoiceLinePayments', 'typed_results': 'list[InvoiceLinePayments]', + 'typed_single_result': 'InvoiceLinePayments', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperInvoiceLinePayment(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperInvoiceLinePayment - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 - :rtype: InvoiceLinePayments - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperInvoiceLinePayment. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 - :type: InvoiceLinePayments - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :rtype: InvoiceLinePayments + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperInvoiceLinePayment. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 + :type: InvoiceLinePayments + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperInvoiceLinePayment. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_notification.py b/billforward/models/typed_query_result_wrapper_notification.py index de77bd8..6a9a126 100644 --- a/billforward/models/typed_query_result_wrapper_notification.py +++ b/billforward/models/typed_query_result_wrapper_notification.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperNotification(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Notifications', 'typed_results': 'list[Notifications]', + 'typed_single_result': 'Notifications', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperNotification(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperNotification - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperNotification. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperNotification. # noqa: E501 - :rtype: Notifications - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperNotification. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperNotification. # noqa: E501 - :type: Notifications - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperNotification. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperNotification. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperNotification. # noqa: E501 + :rtype: Notifications + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperNotification. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperNotification. # noqa: E501 + :type: Notifications + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperNotification. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_payment.py b/billforward/models/typed_query_result_wrapper_payment.py index 6cbdaa7..70c3245 100644 --- a/billforward/models/typed_query_result_wrapper_payment.py +++ b/billforward/models/typed_query_result_wrapper_payment.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperPayment(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Payment', 'typed_results': 'list[Payment]', + 'typed_single_result': 'Payment', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperPayment(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperPayment - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperPayment. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperPayment. # noqa: E501 - :rtype: Payment - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperPayment. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperPayment. # noqa: E501 - :type: Payment - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperPayment. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperPayment. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperPayment. # noqa: E501 + :rtype: Payment + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperPayment. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperPayment. # noqa: E501 + :type: Payment + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperPayment. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_payment_method.py b/billforward/models/typed_query_result_wrapper_payment_method.py index 9021a0b..84b6010 100644 --- a/billforward/models/typed_query_result_wrapper_payment_method.py +++ b/billforward/models/typed_query_result_wrapper_payment_method.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperPaymentMethod(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'PaymentMethod', 'typed_results': 'list[PaymentMethod]', + 'typed_single_result': 'PaymentMethod', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperPaymentMethod(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperPaymentMethod - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 - :rtype: PaymentMethod - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperPaymentMethod. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 - :type: PaymentMethod - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :rtype: PaymentMethod + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperPaymentMethod. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 + :type: PaymentMethod + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperPaymentMethod. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_plan_response.py b/billforward/models/typed_query_result_wrapper_plan_response.py index cc9c706..32b2148 100644 --- a/billforward/models/typed_query_result_wrapper_plan_response.py +++ b/billforward/models/typed_query_result_wrapper_plan_response.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperPlanResponse(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'PlanResponse', 'typed_results': 'list[PlanResponse]', + 'typed_single_result': 'PlanResponse', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperPlanResponse(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperPlanResponse - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperPlanResponse. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperPlanResponse. # noqa: E501 - :rtype: PlanResponse - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperPlanResponse. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperPlanResponse. # noqa: E501 - :type: PlanResponse - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperPlanResponse. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :rtype: PlanResponse + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperPlanResponse. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperPlanResponse. # noqa: E501 + :type: PlanResponse + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperPlanResponse. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_profile.py b/billforward/models/typed_query_result_wrapper_profile.py index b3d2de7..acc3ffe 100644 --- a/billforward/models/typed_query_result_wrapper_profile.py +++ b/billforward/models/typed_query_result_wrapper_profile.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperProfile(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Profile', 'typed_results': 'list[Profile]', + 'typed_single_result': 'Profile', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperProfile(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperProfile - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperProfile. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperProfile. # noqa: E501 - :rtype: Profile - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperProfile. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperProfile. # noqa: E501 - :type: Profile - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperProfile. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperProfile. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperProfile. # noqa: E501 + :rtype: Profile + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperProfile. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperProfile. # noqa: E501 + :type: Profile + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperProfile. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_receipt.py b/billforward/models/typed_query_result_wrapper_receipt.py index d44acd7..c8cb328 100644 --- a/billforward/models/typed_query_result_wrapper_receipt.py +++ b/billforward/models/typed_query_result_wrapper_receipt.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperReceipt(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Receipt', 'typed_results': 'list[Receipt]', + 'typed_single_result': 'Receipt', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperReceipt(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperReceipt - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperReceipt. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperReceipt. # noqa: E501 - :rtype: Receipt - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperReceipt. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperReceipt. # noqa: E501 - :type: Receipt - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperReceipt. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperReceipt. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperReceipt. # noqa: E501 + :rtype: Receipt + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperReceipt. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperReceipt. # noqa: E501 + :type: Receipt + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperReceipt. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_refund.py b/billforward/models/typed_query_result_wrapper_refund.py index da43b94..5fe9beb 100644 --- a/billforward/models/typed_query_result_wrapper_refund.py +++ b/billforward/models/typed_query_result_wrapper_refund.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperRefund(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Refund', 'typed_results': 'list[Refund]', + 'typed_single_result': 'Refund', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperRefund(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperRefund - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperRefund. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperRefund. # noqa: E501 - :rtype: Refund - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperRefund. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperRefund. # noqa: E501 - :type: Refund - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperRefund. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperRefund. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperRefund. # noqa: E501 + :rtype: Refund + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperRefund. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperRefund. # noqa: E501 + :type: Refund + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperRefund. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_revenue_attribution.py b/billforward/models/typed_query_result_wrapper_revenue_attribution.py index c84e9fa..162564c 100644 --- a/billforward/models/typed_query_result_wrapper_revenue_attribution.py +++ b/billforward/models/typed_query_result_wrapper_revenue_attribution.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperRevenueAttribution(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'RevenueAttributions', 'typed_results': 'list[RevenueAttributions]', + 'typed_single_result': 'RevenueAttributions', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperRevenueAttribution(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperRevenueAttribution - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 - :rtype: RevenueAttributions - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperRevenueAttribution. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 - :type: RevenueAttributions - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :rtype: RevenueAttributions + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperRevenueAttribution. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 + :type: RevenueAttributions + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperRevenueAttribution. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_role.py b/billforward/models/typed_query_result_wrapper_role.py index a065c77..224834e 100644 --- a/billforward/models/typed_query_result_wrapper_role.py +++ b/billforward/models/typed_query_result_wrapper_role.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperRole(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Role', 'typed_results': 'list[Role]', + 'typed_single_result': 'Role', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperRole(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperRole - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperRole. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperRole. # noqa: E501 - :rtype: Role - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperRole. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperRole. # noqa: E501 - :type: Role - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperRole. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperRole. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperRole. # noqa: E501 + :rtype: Role + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperRole. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperRole. # noqa: E501 + :type: Role + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperRole. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_stripe_ach_token.py b/billforward/models/typed_query_result_wrapper_stripe_ach_token.py index 02ee5ba..bddca11 100644 --- a/billforward/models/typed_query_result_wrapper_stripe_ach_token.py +++ b/billforward/models/typed_query_result_wrapper_stripe_ach_token.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperStripeACHToken(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'StripeAchToken', 'typed_results': 'list[StripeAchToken]', + 'typed_single_result': 'StripeAchToken', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperStripeACHToken(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperStripeACHToken - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 - :rtype: StripeAchToken - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperStripeACHToken. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 - :type: StripeAchToken - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :rtype: StripeAchToken + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperStripeACHToken. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 + :type: StripeAchToken + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperStripeACHToken. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_stripe_token.py b/billforward/models/typed_query_result_wrapper_stripe_token.py index 1a64871..edbb786 100644 --- a/billforward/models/typed_query_result_wrapper_stripe_token.py +++ b/billforward/models/typed_query_result_wrapper_stripe_token.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperStripeToken(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'StripeToken', 'typed_results': 'list[StripeToken]', + 'typed_single_result': 'StripeToken', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperStripeToken(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperStripeToken - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperStripeToken. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperStripeToken. # noqa: E501 - :rtype: StripeToken - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperStripeToken. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperStripeToken. # noqa: E501 - :type: StripeToken - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperStripeToken. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperStripeToken. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :rtype: StripeToken + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperStripeToken. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperStripeToken. # noqa: E501 + :type: StripeToken + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperStripeToken. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_subscription.py b/billforward/models/typed_query_result_wrapper_subscription.py index 36e5332..0d183ee 100644 --- a/billforward/models/typed_query_result_wrapper_subscription.py +++ b/billforward/models/typed_query_result_wrapper_subscription.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperSubscription(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Subscription', 'typed_results': 'list[Subscription]', + 'typed_single_result': 'Subscription', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperSubscription(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperSubscription - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperSubscription. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperSubscription. # noqa: E501 - :rtype: Subscription - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperSubscription. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperSubscription. # noqa: E501 - :type: Subscription - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperSubscription. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperSubscription. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperSubscription. # noqa: E501 + :rtype: Subscription + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperSubscription. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperSubscription. # noqa: E501 + :type: Subscription + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperSubscription. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_subscription_charge.py b/billforward/models/typed_query_result_wrapper_subscription_charge.py index 2fe9699..2e4c9c1 100644 --- a/billforward/models/typed_query_result_wrapper_subscription_charge.py +++ b/billforward/models/typed_query_result_wrapper_subscription_charge.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperSubscriptionCharge(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'SubscriptionCharge', 'typed_results': 'list[SubscriptionCharge]', + 'typed_single_result': 'SubscriptionCharge', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperSubscriptionCharge(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperSubscriptionCharge - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 - :rtype: SubscriptionCharge - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperSubscriptionCharge. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 - :type: SubscriptionCharge - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :rtype: SubscriptionCharge + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperSubscriptionCharge. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 + :type: SubscriptionCharge + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperSubscriptionCharge. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_taxation_strategy.py b/billforward/models/typed_query_result_wrapper_taxation_strategy.py index eacd721..bd9f12c 100644 --- a/billforward/models/typed_query_result_wrapper_taxation_strategy.py +++ b/billforward/models/typed_query_result_wrapper_taxation_strategy.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperTaxationStrategy(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'TaxationStrategy', 'typed_results': 'list[TaxationStrategy]', + 'typed_single_result': 'TaxationStrategy', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperTaxationStrategy(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperTaxationStrategy - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 - :rtype: TaxationStrategy - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperTaxationStrategy. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 - :type: TaxationStrategy - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :rtype: TaxationStrategy + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperTaxationStrategy. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 + :type: TaxationStrategy + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperTaxationStrategy. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_user_response.py b/billforward/models/typed_query_result_wrapper_user_response.py index a4eb669..c1a9485 100644 --- a/billforward/models/typed_query_result_wrapper_user_response.py +++ b/billforward/models/typed_query_result_wrapper_user_response.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperUserResponse(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'UserResponse', 'typed_results': 'list[UserResponse]', + 'typed_single_result': 'UserResponse', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperUserResponse(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperUserResponse - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperUserResponse. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperUserResponse. # noqa: E501 - :rtype: UserResponse - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperUserResponse. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperUserResponse. # noqa: E501 - :type: UserResponse - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperUserResponse. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperUserResponse. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :rtype: UserResponse + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperUserResponse. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperUserResponse. # noqa: E501 + :type: UserResponse + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperUserResponse. # noqa: E501 diff --git a/billforward/models/typed_query_result_wrapper_webhook.py b/billforward/models/typed_query_result_wrapper_webhook.py index 1c6cbfe..d2e1726 100644 --- a/billforward/models/typed_query_result_wrapper_webhook.py +++ b/billforward/models/typed_query_result_wrapper_webhook.py @@ -42,8 +42,8 @@ class TypedQueryResultWrapperWebhook(object): 'include_retired': 'bool', 'wildcard': 'bool', 'entity': 'bool', - 'typed_single_result': 'Webhook', 'typed_results': 'list[Webhook]', + 'typed_single_result': 'Webhook', 'single_result': 'BillingEntityBase' } @@ -62,12 +62,12 @@ class TypedQueryResultWrapperWebhook(object): 'include_retired': 'includeRetired', 'wildcard': 'wildcard', 'entity': 'entity', - 'typed_single_result': 'typedSingleResult', 'typed_results': 'typedResults', + 'typed_single_result': 'typedSingleResult', 'single_result': 'singleResult' } - def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_single_result=None, typed_results=None, single_result=None): # noqa: E501 + def __init__(self, entity_name=None, total_records_returned=None, total_records=None, results=None, arguments=None, organizations=None, types=None, offset=None, records=None, order_by=None, order_direction=None, include_retired=None, wildcard=None, entity=None, typed_results=None, typed_single_result=None, single_result=None): # noqa: E501 """TypedQueryResultWrapperWebhook - a model defined in Swagger""" # noqa: E501 self._entity_name = None self._total_records_returned = None @@ -83,8 +83,8 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self._include_retired = None self._wildcard = None self._entity = None - self._typed_single_result = None self._typed_results = None + self._typed_single_result = None self._single_result = None self.discriminator = None if entity_name is not None: @@ -115,10 +115,10 @@ def __init__(self, entity_name=None, total_records_returned=None, total_records= self.wildcard = wildcard if entity is not None: self.entity = entity - if typed_single_result is not None: - self.typed_single_result = typed_single_result if typed_results is not None: self.typed_results = typed_results + if typed_single_result is not None: + self.typed_single_result = typed_single_result if single_result is not None: self.single_result = single_result @@ -428,27 +428,6 @@ def entity(self, entity): self._entity = entity - @property - def typed_single_result(self): - """Gets the typed_single_result of this TypedQueryResultWrapperWebhook. # noqa: E501 - - - :return: The typed_single_result of this TypedQueryResultWrapperWebhook. # noqa: E501 - :rtype: Webhook - """ - return self._typed_single_result - - @typed_single_result.setter - def typed_single_result(self, typed_single_result): - """Sets the typed_single_result of this TypedQueryResultWrapperWebhook. - - - :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperWebhook. # noqa: E501 - :type: Webhook - """ - - self._typed_single_result = typed_single_result - @property def typed_results(self): """Gets the typed_results of this TypedQueryResultWrapperWebhook. # noqa: E501 @@ -470,6 +449,27 @@ def typed_results(self, typed_results): self._typed_results = typed_results + @property + def typed_single_result(self): + """Gets the typed_single_result of this TypedQueryResultWrapperWebhook. # noqa: E501 + + + :return: The typed_single_result of this TypedQueryResultWrapperWebhook. # noqa: E501 + :rtype: Webhook + """ + return self._typed_single_result + + @typed_single_result.setter + def typed_single_result(self, typed_single_result): + """Sets the typed_single_result of this TypedQueryResultWrapperWebhook. + + + :param typed_single_result: The typed_single_result of this TypedQueryResultWrapperWebhook. # noqa: E501 + :type: Webhook + """ + + self._typed_single_result = typed_single_result + @property def single_result(self): """Gets the single_result of this TypedQueryResultWrapperWebhook. # noqa: E501 diff --git a/billforward/models/update_invoice_template_request.py b/billforward/models/update_invoice_template_request.py index 009f8dc..acbc07e 100644 --- a/billforward/models/update_invoice_template_request.py +++ b/billforward/models/update_invoice_template_request.py @@ -342,7 +342,7 @@ def show_unit_price(self, show_unit_price): :param show_unit_price: The show_unit_price of this UpdateInvoiceTemplateRequest. # noqa: E501 :type: str """ - allowed_values = ["Hidden", "Column", "Inline"] # noqa: E501 + allowed_values = ["Hidden", "Column"] # noqa: E501 if show_unit_price not in allowed_values: raise ValueError( "Invalid value for `show_unit_price` ({0}), must be one of {1}" # noqa: E501 diff --git a/billforward/models/user.py b/billforward/models/user.py index de47eb3..ad350e0 100644 --- a/billforward/models/user.py +++ b/billforward/models/user.py @@ -46,9 +46,9 @@ class User(object): 'timezone': 'UserTimezone', 'flexcheck_user': 'bool', 'two_fa': 'bool', - 'email': 'str', 'main_username': 'Username', - 'active_usernames': 'list[str]' + 'active_usernames': 'list[str]', + 'email': 'str' } attribute_map = { @@ -70,12 +70,12 @@ class User(object): 'timezone': 'timezone', 'flexcheck_user': 'flexcheckUser', 'two_fa': 'twoFA', - 'email': 'email', 'main_username': 'mainUsername', - 'active_usernames': 'activeUsernames' + 'active_usernames': 'activeUsernames', + 'email': 'email' } - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, password=None, username=None, open_id_identifier=None, password_reset_code=None, password_reset_attempts=None, password_reset_valid_till=None, last_successful_login=None, successful_logins=None, bf_admin=None, enabled=None, timezone=None, flexcheck_user=None, two_fa=None, email=None, main_username=None, active_usernames=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, password=None, username=None, open_id_identifier=None, password_reset_code=None, password_reset_attempts=None, password_reset_valid_till=None, last_successful_login=None, successful_logins=None, bf_admin=None, enabled=None, timezone=None, flexcheck_user=None, two_fa=None, main_username=None, active_usernames=None, email=None): # noqa: E501 """User - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -95,9 +95,9 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self._timezone = None self._flexcheck_user = None self._two_fa = None - self._email = None self._main_username = None self._active_usernames = None + self._email = None self.discriminator = None if created is not None: self.created = created @@ -131,12 +131,12 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self.flexcheck_user = flexcheck_user if two_fa is not None: self.two_fa = two_fa - if email is not None: - self.email = email if main_username is not None: self.main_username = main_username if active_usernames is not None: self.active_usernames = active_usernames + if email is not None: + self.email = email @property def created(self): @@ -524,27 +524,6 @@ def two_fa(self, two_fa): self._two_fa = two_fa - @property - def email(self): - """Gets the email of this User. # noqa: E501 - - - :return: The email of this User. # noqa: E501 - :rtype: str - """ - return self._email - - @email.setter - def email(self, email): - """Sets the email of this User. - - - :param email: The email of this User. # noqa: E501 - :type: str - """ - - self._email = email - @property def main_username(self): """Gets the main_username of this User. # noqa: E501 @@ -587,6 +566,27 @@ def active_usernames(self, active_usernames): self._active_usernames = active_usernames + @property + def email(self): + """Gets the email of this User. # noqa: E501 + + + :return: The email of this User. # noqa: E501 + :rtype: str + """ + return self._email + + @email.setter + def email(self, email): + """Sets the email of this User. + + + :param email: The email of this User. # noqa: E501 + :type: str + """ + + self._email = email + def to_dict(self): """Returns the model properties as a dict""" result = {} diff --git a/billforward/models/webhook.py b/billforward/models/webhook.py index a99b66e..d409c66 100644 --- a/billforward/models/webhook.py +++ b/billforward/models/webhook.py @@ -39,7 +39,6 @@ class Webhook(object): 'temporarily_inactive_until': 'datetime', 'inactive_level': 'int', 'webhook_subscriptions': 'list[WebhookSubscription]', - 'url': 'str', 'url': 'str' } @@ -55,11 +54,10 @@ class Webhook(object): 'temporarily_inactive_until': 'temporarilyInactiveUntil', 'inactive_level': 'inactiveLevel', 'webhook_subscriptions': 'webhookSubscriptions', - 'url': 'url', 'url': 'URL' } - def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, name=None, consecutive_failures=None, deleted=None, temporarily_inactive_until=None, inactive_level=None, webhook_subscriptions=None, url=None, url=None): # noqa: E501 + def __init__(self, created=None, changed_by=None, updated=None, id=None, organization_id=None, name=None, consecutive_failures=None, deleted=None, temporarily_inactive_until=None, inactive_level=None, webhook_subscriptions=None, url=None): # noqa: E501 """Webhook - a model defined in Swagger""" # noqa: E501 self._created = None self._changed_by = None @@ -73,7 +71,6 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self._inactive_level = None self._webhook_subscriptions = None self._url = None - self._url = None self.discriminator = None if created is not None: self.created = created @@ -99,8 +96,6 @@ def __init__(self, created=None, changed_by=None, updated=None, id=None, organiz self.webhook_subscriptions = webhook_subscriptions if url is not None: self.url = url - if url is not None: - self.url = url @property def created(self): @@ -348,27 +343,6 @@ def url(self, url): """Sets the url of this Webhook. - :param url: The url of this Webhook. # noqa: E501 - :type: str - """ - - self._url = url - - @property - def url(self): - """Gets the url of this Webhook. # noqa: E501 - - - :return: The url of this Webhook. # noqa: E501 - :rtype: str - """ - return self._url - - @url.setter - def url(self, url): - """Sets the url of this Webhook. - - :param url: The url of this Webhook. # noqa: E501 :type: str """ diff --git a/docs/APIConfiguration.md b/docs/APIConfiguration.md index 1aff6ad..31afaa6 100644 --- a/docs/APIConfiguration.md +++ b/docs/APIConfiguration.md @@ -24,9 +24,9 @@ Name | Type | Description | Notes **expires_at** | **datetime** | | [optional] **migrations** | [**list[Migration]**](Migration.md) | | [optional] **gateway_type** | **str** | | [optional] +**apilogin_id** | **str** | | [optional] **production** | **bool** | | [optional] **environment_type** | **str** | | [optional] -**apilogin_id** | **str** | | [optional] **apikey** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AffiliateRatePlanRelationships.md b/docs/AffiliateRatePlanRelationships.md index 92e942c..0e0d5b0 100644 --- a/docs/AffiliateRatePlanRelationships.md +++ b/docs/AffiliateRatePlanRelationships.md @@ -12,8 +12,8 @@ Name | Type | Description | Notes **product_rate_plan_id** | **str** | | [optional] **start_date** | **datetime** | | [optional] **end_date** | **datetime** | | [optional] -**account_id** | **str** | | [optional] **interval** | [**IntervalDate**](IntervalDate.md) | | [optional] +**account_id** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Amendment.md b/docs/Amendment.md index dd18509..a22a7ea 100644 --- a/docs/Amendment.md +++ b/docs/Amendment.md @@ -15,8 +15,8 @@ Name | Type | Description | Notes **actioned_time** | **datetime** | | [optional] **state** | **str** | | **deleted** | **bool** | | -**discardable_subsystem_object** | [**IDiscardable**](IDiscardable.md) | | [optional] **amendment_type** | **str** | | [optional] +**discardable_subsystem_object** | [**IDiscardable**](IDiscardable.md) | | [optional] **at_type** | **str** | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault100.md b/docs/InlineResponseDefault100.md index fee249c..b7b569a 100644 --- a/docs/InlineResponseDefault100.md +++ b/docs/InlineResponseDefault100.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **records_returned** | **int** | | [optional] **total_records** | **int** | | [optional] **execution_time** | **int** | | -**results** | [**list[StripeAchToken]**](StripeAchToken.md) | | +**results** | [**list[Webhook]**](Webhook.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault101.md b/docs/InlineResponseDefault101.md index 5f674c7..7de743e 100644 --- a/docs/InlineResponseDefault101.md +++ b/docs/InlineResponseDefault101.md @@ -3,12 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**next_page** | **str** | | [optional] -**current_page** | **int** | | [optional] -**current_offset** | **int** | | [optional] -**records_requested** | **int** | | [optional] -**records_returned** | **int** | | [optional] -**total_records** | **int** | | [optional] **execution_time** | **int** | | **results** | [**list[Webhook]**](Webhook.md) | | diff --git a/docs/InlineResponseDefault102.md b/docs/InlineResponseDefault102.md index 23f573b..4e4d903 100644 --- a/docs/InlineResponseDefault102.md +++ b/docs/InlineResponseDefault102.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_time** | **int** | | -**results** | [**list[Webhook]**](Webhook.md) | | +**results** | [**list[AllowedWebhookSubscriptionValues]**](AllowedWebhookSubscriptionValues.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault79.md b/docs/InlineResponseDefault79.md index a2106ca..ea8cbc7 100644 --- a/docs/InlineResponseDefault79.md +++ b/docs/InlineResponseDefault79.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_time** | **int** | | -**results** | [**list[EpxPreAuthResponse]**](EpxPreAuthResponse.md) | | +**results** | [**list[EmailTokenization]**](EmailTokenization.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault80.md b/docs/InlineResponseDefault80.md index 3901b72..27e0513 100644 --- a/docs/InlineResponseDefault80.md +++ b/docs/InlineResponseDefault80.md @@ -3,6 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] **execution_time** | **int** | | **results** | [**list[EmailTokenization]**](EmailTokenization.md) | | diff --git a/docs/InlineResponseDefault81.md b/docs/InlineResponseDefault81.md index 0a6ade5..89fbf8f 100644 --- a/docs/InlineResponseDefault81.md +++ b/docs/InlineResponseDefault81.md @@ -3,14 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**next_page** | **str** | | [optional] -**current_page** | **int** | | [optional] -**current_offset** | **int** | | [optional] -**records_requested** | **int** | | [optional] -**records_returned** | **int** | | [optional] -**total_records** | **int** | | [optional] **execution_time** | **int** | | -**results** | [**list[EmailTokenization]**](EmailTokenization.md) | | +**results** | [**list[TokenizationPreAuth]**](TokenizationPreAuth.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault82.md b/docs/InlineResponseDefault82.md index 74a7185..662e21a 100644 --- a/docs/InlineResponseDefault82.md +++ b/docs/InlineResponseDefault82.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_time** | **int** | | -**results** | [**list[TokenizationPreAuth]**](TokenizationPreAuth.md) | | +**results** | [**list[Profile]**](Profile.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault83.md b/docs/InlineResponseDefault83.md index 8ec9721..7f4954d 100644 --- a/docs/InlineResponseDefault83.md +++ b/docs/InlineResponseDefault83.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_time** | **int** | | -**results** | [**list[Profile]**](Profile.md) | | +**results** | [**list[UserCreationResponse]**](UserCreationResponse.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault84.md b/docs/InlineResponseDefault84.md index bdc2fc4..13a7a9a 100644 --- a/docs/InlineResponseDefault84.md +++ b/docs/InlineResponseDefault84.md @@ -3,8 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] **execution_time** | **int** | | -**results** | [**list[UserCreationResponse]**](UserCreationResponse.md) | | +**results** | [**list[SimpleUser]**](SimpleUser.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault85.md b/docs/InlineResponseDefault85.md index 19c8935..becc2a5 100644 --- a/docs/InlineResponseDefault85.md +++ b/docs/InlineResponseDefault85.md @@ -3,14 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**next_page** | **str** | | [optional] -**current_page** | **int** | | [optional] -**current_offset** | **int** | | [optional] -**records_requested** | **int** | | [optional] -**records_returned** | **int** | | [optional] -**total_records** | **int** | | [optional] **execution_time** | **int** | | -**results** | [**list[SimpleUser]**](SimpleUser.md) | | +**results** | [**list[UserResponse]**](UserResponse.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault86.md b/docs/InlineResponseDefault86.md index 9f5481d..a9a6374 100644 --- a/docs/InlineResponseDefault86.md +++ b/docs/InlineResponseDefault86.md @@ -3,8 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] **execution_time** | **int** | | -**results** | [**list[UserResponse]**](UserResponse.md) | | +**results** | [**list[OrganizationLiteView]**](OrganizationLiteView.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault87.md b/docs/InlineResponseDefault87.md index 4a182ea..deb9c94 100644 --- a/docs/InlineResponseDefault87.md +++ b/docs/InlineResponseDefault87.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **records_returned** | **int** | | [optional] **total_records** | **int** | | [optional] **execution_time** | **int** | | -**results** | [**list[OrganizationLiteView]**](OrganizationLiteView.md) | | +**results** | [**list[UserResponse]**](UserResponse.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault88.md b/docs/InlineResponseDefault88.md index 1b7a6b0..7ae309f 100644 --- a/docs/InlineResponseDefault88.md +++ b/docs/InlineResponseDefault88.md @@ -3,14 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**next_page** | **str** | | [optional] -**current_page** | **int** | | [optional] -**current_offset** | **int** | | [optional] -**records_requested** | **int** | | [optional] -**records_returned** | **int** | | [optional] -**total_records** | **int** | | [optional] **execution_time** | **int** | | -**results** | [**list[UserResponse]**](UserResponse.md) | | +**results** | [**list[OpenIDRegistrationResponse]**](OpenIDRegistrationResponse.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault89.md b/docs/InlineResponseDefault89.md index ba054bc..f3f58c9 100644 --- a/docs/InlineResponseDefault89.md +++ b/docs/InlineResponseDefault89.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_time** | **int** | | -**results** | [**list[OpenIDRegistrationResponse]**](OpenIDRegistrationResponse.md) | | +**results** | [**list[PasswordResetResponse]**](PasswordResetResponse.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault90.md b/docs/InlineResponseDefault90.md index 7779fc8..b7bd039 100644 --- a/docs/InlineResponseDefault90.md +++ b/docs/InlineResponseDefault90.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_time** | **int** | | -**results** | [**list[PasswordResetResponse]**](PasswordResetResponse.md) | | +**results** | [**list[Username]**](Username.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault91.md b/docs/InlineResponseDefault91.md index 99b6ebc..522c599 100644 --- a/docs/InlineResponseDefault91.md +++ b/docs/InlineResponseDefault91.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_time** | **int** | | -**results** | [**list[Username]**](Username.md) | | +**results** | [**list[UpdatePasswordResponse]**](UpdatePasswordResponse.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault92.md b/docs/InlineResponseDefault92.md index 9f0a28c..3bafa28 100644 --- a/docs/InlineResponseDefault92.md +++ b/docs/InlineResponseDefault92.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_time** | **int** | | -**results** | [**list[UpdatePasswordResponse]**](UpdatePasswordResponse.md) | | +**results** | [**list[AuthorizeNetToken]**](AuthorizeNetToken.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault93.md b/docs/InlineResponseDefault93.md index 298be0e..2f5d358 100644 --- a/docs/InlineResponseDefault93.md +++ b/docs/InlineResponseDefault93.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_time** | **int** | | -**results** | [**list[AuthorizeNetToken]**](AuthorizeNetToken.md) | | +**results** | [**list[BraintreeToken]**](BraintreeToken.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault94.md b/docs/InlineResponseDefault94.md index 1525695..99178be 100644 --- a/docs/InlineResponseDefault94.md +++ b/docs/InlineResponseDefault94.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_time** | **int** | | -**results** | [**list[BraintreeToken]**](BraintreeToken.md) | | +**results** | [**list[StripeAchToken]**](StripeAchToken.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault95.md b/docs/InlineResponseDefault95.md index 1cb9ba9..920d52e 100644 --- a/docs/InlineResponseDefault95.md +++ b/docs/InlineResponseDefault95.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_time** | **int** | | -**results** | [**list[StripeAchToken]**](StripeAchToken.md) | | +**results** | [**list[StripeToken]**](StripeToken.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault96.md b/docs/InlineResponseDefault96.md index 95c6328..e171d44 100644 --- a/docs/InlineResponseDefault96.md +++ b/docs/InlineResponseDefault96.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **execution_time** | **int** | | -**results** | [**list[StripeToken]**](StripeToken.md) | | +**results** | [**list[TrustCommerceToken]**](TrustCommerceToken.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault97.md b/docs/InlineResponseDefault97.md index 82b014f..a797821 100644 --- a/docs/InlineResponseDefault97.md +++ b/docs/InlineResponseDefault97.md @@ -3,8 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**current_page** | **int** | | [optional] +**current_offset** | **int** | | [optional] +**records_requested** | **int** | | [optional] +**records_returned** | **int** | | [optional] +**total_records** | **int** | | [optional] **execution_time** | **int** | | -**results** | [**list[TrustCommerceToken]**](TrustCommerceToken.md) | | +**results** | [**list[BraintreeToken]**](BraintreeToken.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault98.md b/docs/InlineResponseDefault98.md index 5298b31..01f7340 100644 --- a/docs/InlineResponseDefault98.md +++ b/docs/InlineResponseDefault98.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **records_returned** | **int** | | [optional] **total_records** | **int** | | [optional] **execution_time** | **int** | | -**results** | [**list[BraintreeToken]**](BraintreeToken.md) | | +**results** | [**list[StripeToken]**](StripeToken.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponseDefault99.md b/docs/InlineResponseDefault99.md index 8b0d56e..d2f01cd 100644 --- a/docs/InlineResponseDefault99.md +++ b/docs/InlineResponseDefault99.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **records_returned** | **int** | | [optional] **total_records** | **int** | | [optional] **execution_time** | **int** | | -**results** | [**list[StripeToken]**](StripeToken.md) | | +**results** | [**list[StripeAchToken]**](StripeAchToken.md) | | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Invoice.md b/docs/Invoice.md index d2b66e6..d8b3580 100644 --- a/docs/Invoice.md +++ b/docs/Invoice.md @@ -54,6 +54,7 @@ Name | Type | Description | Notes **payment_terms** | **int** | | [optional] **children** | [**list[Invoice]**](Invoice.md) | | [optional] **executions** | [**list[ExecutionReceiptResponse]**](ExecutionReceiptResponse.md) | | [optional] +**monotonic_number** | **int** | | [optional] **total_invoice_cost** | **float** | | [optional] **zero_cost** | **bool** | | [optional] **c_rmid** | **str** | | [optional] diff --git a/docs/PayVisionConfiguration.md b/docs/PayVisionConfiguration.md index cd610bd..2a2ba8c 100644 --- a/docs/PayVisionConfiguration.md +++ b/docs/PayVisionConfiguration.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **key_filename** | **str** | | [optional] **domain** | **str** | | [optional] -**password** | **str** | | [optional] **entity_id** | **str** | | [optional] **user_id** | **str** | | [optional] +**password** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Refund.md b/docs/Refund.md index f1c67c1..ef3d8ae 100644 --- a/docs/Refund.md +++ b/docs/Refund.md @@ -36,8 +36,8 @@ Name | Type | Description | Notes **created_by** | **str** | | [optional] **type** | **str** | | [optional] **state** | **str** | | [optional] -**refunded_payment** | [**Payment**](Payment.md) | | [optional] **refunded_value** | **float** | | [optional] +**refunded_payment** | [**Payment**](Payment.md) | | [optional] **account** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/SecurityApi.md b/docs/SecurityApi.md index 735714b..f00f97b 100644 --- a/docs/SecurityApi.md +++ b/docs/SecurityApi.md @@ -28,7 +28,7 @@ Method | HTTP request | Description [**update_user_password_with_reset_code**](SecurityApi.md#update_user_password_with_reset_code) | **POST** /users/password-reset/password-update | # **create_flexcheck_user_login** -> InlineResponseDefault84 create_flexcheck_user_login(body=body) +> InlineResponseDefault83 create_flexcheck_user_login(body=body) @@ -60,7 +60,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault84**](InlineResponseDefault84.md) +[**InlineResponseDefault83**](InlineResponseDefault83.md) ### Authorization @@ -120,7 +120,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_user_login** -> InlineResponseDefault84 create_user_login(body=body) +> InlineResponseDefault83 create_user_login(body=body) @@ -152,7 +152,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault84**](InlineResponseDefault84.md) +[**InlineResponseDefault83**](InlineResponseDefault83.md) ### Authorization @@ -222,7 +222,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_current_user** -> InlineResponseDefault86 get_current_user(organizations=organizations) +> InlineResponseDefault85 get_current_user(organizations=organizations) @@ -254,7 +254,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault86**](InlineResponseDefault86.md) +[**InlineResponseDefault85**](InlineResponseDefault85.md) ### Authorization @@ -268,7 +268,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_my_organizations** -> InlineResponseDefault87 get_my_organizations() +> InlineResponseDefault86 get_my_organizations() @@ -296,7 +296,7 @@ This endpoint does not need any parameter. ### Return type -[**InlineResponseDefault87**](InlineResponseDefault87.md) +[**InlineResponseDefault86**](InlineResponseDefault86.md) ### Authorization @@ -406,7 +406,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_simple_all_users** -> InlineResponseDefault85 get_simple_all_users(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) +> InlineResponseDefault84 get_simple_all_users(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order) @@ -446,7 +446,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault85**](InlineResponseDefault85.md) +[**InlineResponseDefault84**](InlineResponseDefault84.md) ### Authorization @@ -502,7 +502,7 @@ This endpoint does not need any parameter. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_user_by_username** -> InlineResponseDefault88 get_user_by_username(email, organizations=organizations) +> InlineResponseDefault87 get_user_by_username(email, organizations=organizations) @@ -536,7 +536,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault88**](InlineResponseDefault88.md) +[**InlineResponseDefault87**](InlineResponseDefault87.md) ### Authorization @@ -550,7 +550,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **invite_user_login** -> InlineResponseDefault84 invite_user_login(body=body) +> InlineResponseDefault83 invite_user_login(body=body) @@ -582,7 +582,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault84**](InlineResponseDefault84.md) +[**InlineResponseDefault83**](InlineResponseDefault83.md) ### Authorization @@ -596,7 +596,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **link_open_id_token_to_user** -> InlineResponseDefault89 link_open_id_token_to_user(body=body) +> InlineResponseDefault88 link_open_id_token_to_user(body=body) @@ -628,7 +628,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault89**](InlineResponseDefault89.md) +[**InlineResponseDefault88**](InlineResponseDefault88.md) ### Authorization @@ -740,7 +740,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **request_password_reset_code** -> InlineResponseDefault90 request_password_reset_code(body=body) +> InlineResponseDefault89 request_password_reset_code(body=body) @@ -772,7 +772,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault90**](InlineResponseDefault90.md) +[**InlineResponseDefault89**](InlineResponseDefault89.md) ### Authorization @@ -834,7 +834,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_email** -> InlineResponseDefault86 update_email(email, body=body, organizations=organizations) +> InlineResponseDefault85 update_email(email, body=body, organizations=organizations) @@ -870,7 +870,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault86**](InlineResponseDefault86.md) +[**InlineResponseDefault85**](InlineResponseDefault85.md) ### Authorization @@ -930,7 +930,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_user_infos** -> InlineResponseDefault91 update_user_infos(email, body=body, organizations=organizations) +> InlineResponseDefault90 update_user_infos(email, body=body, organizations=organizations) @@ -966,7 +966,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault91**](InlineResponseDefault91.md) +[**InlineResponseDefault90**](InlineResponseDefault90.md) ### Authorization @@ -980,7 +980,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_user_password** -> InlineResponseDefault92 update_user_password(email, body=body, organizations=organizations) +> InlineResponseDefault91 update_user_password(email, body=body, organizations=organizations) @@ -1016,7 +1016,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault92**](InlineResponseDefault92.md) +[**InlineResponseDefault91**](InlineResponseDefault91.md) ### Authorization @@ -1030,7 +1030,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_user_password_with_reset_code** -> InlineResponseDefault92 update_user_password_with_reset_code(body=body) +> InlineResponseDefault91 update_user_password_with_reset_code(body=body) @@ -1062,7 +1062,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault92**](InlineResponseDefault92.md) +[**InlineResponseDefault91**](InlineResponseDefault91.md) ### Authorization diff --git a/docs/ShuttleConfiguration.md b/docs/ShuttleConfiguration.md index f1262ba..ec7af81 100644 --- a/docs/ShuttleConfiguration.md +++ b/docs/ShuttleConfiguration.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**percentage_for_other_payment_methods** | **float** | | [optional] **hosted_payment_config** | [**HostedPaymentConfig**](HostedPaymentConfig.md) | | [optional] **instance_key** | **str** | | [optional] +**percentage_for_other_payment_methods** | **float** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TokenizationApi.md b/docs/TokenizationApi.md index 0606c8c..1f27854 100644 --- a/docs/TokenizationApi.md +++ b/docs/TokenizationApi.md @@ -12,9 +12,6 @@ Method | HTTP request | Description [**create_stripe_token**](TokenizationApi.md#create_stripe_token) | **POST** /vaulted-gateways/stripe | [**create_trust_commerce_token**](TokenizationApi.md#create_trust_commerce_token) | **POST** /vaulted-gateways/trustCommerce | [**display_card_capture_form**](TokenizationApi.md#display_card_capture_form) | **GET** /tokenization/card-capture-form | -[**epx_card_capture**](TokenizationApi.md#epx_card_capture) | **POST** /tokenization/epx | -[**epx_pre_auth**](TokenizationApi.md#epx_pre_auth) | **POST** /tokenization/epx-pre-auth | -[**epx_pre_auth_response**](TokenizationApi.md#epx_pre_auth_response) | **POST** /tokenization/epx-redirect | [**expire_email_redirect_capture**](TokenizationApi.md#expire_email_redirect_capture) | **DELETE** /tokenization/email-redirect/{id} | [**get_all_email_redirect_capture**](TokenizationApi.md#get_all_email_redirect_capture) | **GET** /tokenization/email-redirect | [**get_braintree_by_account_id**](TokenizationApi.md#get_braintree_by_account_id) | **GET** /vaulted-gateways/braintree/{accountID} | @@ -132,7 +129,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_authorize_net_token** -> InlineResponseDefault93 create_authorize_net_token(body=body) +> InlineResponseDefault92 create_authorize_net_token(body=body) @@ -164,7 +161,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault93**](InlineResponseDefault93.md) +[**InlineResponseDefault92**](InlineResponseDefault92.md) ### Authorization @@ -178,7 +175,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_braintree_token** -> InlineResponseDefault94 create_braintree_token(body=body) +> InlineResponseDefault93 create_braintree_token(body=body) @@ -210,7 +207,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault94**](InlineResponseDefault94.md) +[**InlineResponseDefault93**](InlineResponseDefault93.md) ### Authorization @@ -224,7 +221,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_stripe_ach_token** -> InlineResponseDefault95 create_stripe_ach_token(body=body) +> InlineResponseDefault94 create_stripe_ach_token(body=body) @@ -256,7 +253,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault95**](InlineResponseDefault95.md) +[**InlineResponseDefault94**](InlineResponseDefault94.md) ### Authorization @@ -270,7 +267,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_stripe_token** -> InlineResponseDefault96 create_stripe_token(body=body) +> InlineResponseDefault95 create_stripe_token(body=body) @@ -302,7 +299,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault96**](InlineResponseDefault96.md) +[**InlineResponseDefault95**](InlineResponseDefault95.md) ### Authorization @@ -316,7 +313,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_trust_commerce_token** -> InlineResponseDefault97 create_trust_commerce_token(body=body) +> InlineResponseDefault96 create_trust_commerce_token(body=body) @@ -348,7 +345,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault97**](InlineResponseDefault97.md) +[**InlineResponseDefault96**](InlineResponseDefault96.md) ### Authorization @@ -408,207 +405,8 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **epx_card_capture** -> InlineResponseDefault40 epx_card_capture(body=body) - - - -### Example -```python -from __future__ import print_function -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - - -# create an instance of the API class -api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) -body = billforward.EpxCaptureRequest() # EpxCaptureRequest | (optional) - -try: - api_response = api_instance.epx_card_capture(body=body) - pprint(api_response) -except ApiException as e: - print("Exception when calling TokenizationApi->epx_card_capture: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**EpxCaptureRequest**](EpxCaptureRequest.md)| | [optional] - -### Return type - -[**InlineResponseDefault40**](InlineResponseDefault40.md) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **epx_pre_auth** -> InlineResponseDefault79 epx_pre_auth(body=body) - - - -### Example -```python -from __future__ import print_function -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - - -# create an instance of the API class -api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) -body = billforward.EpxPreAuthRequest() # EpxPreAuthRequest | (optional) - -try: - api_response = api_instance.epx_pre_auth(body=body) - pprint(api_response) -except ApiException as e: - print("Exception when calling TokenizationApi->epx_pre_auth: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **body** | [**EpxPreAuthRequest**](EpxPreAuthRequest.md)| | [optional] - -### Return type - -[**InlineResponseDefault79**](InlineResponseDefault79.md) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **epx_pre_auth_response** -> epx_pre_auth_response(cust_nbr=cust_nbr, merch_nbr=merch_nbr, dba_nbr=dba_nbr, terminal_nbr=terminal_nbr, tran_code=tran_code, amount=amount, auth_account=auth_account, first_name=first_name, last_name=last_name, exp_date=exp_date, bp_resp_code=bp_resp_code, bp_resp_text=bp_resp_text, bp_field_errors=bp_field_errors, msg_version=msg_version, tran_type=tran_type, tran_nbr=tran_nbr, local_date=local_date, local_time=local_time, auth_guid=auth_guid, auth_resp=auth_resp, auth_code=auth_code, auth_cvv2=auth_cvv2, auth_resp_text=auth_resp_text, auth_card_type=auth_card_type, auth_tran_date_gmt=auth_tran_date_gmt, auth_amount_requested=auth_amount_requested, auth_amount=auth_amount, auth_currency_code=auth_currency_code, network_response=network_response, auth_masked_account_nbr=auth_masked_account_nbr, user_data_9=user_data_9, user_data_10=user_data_10) - - - -### Example -```python -from __future__ import print_function -import time -import billforward -from billforward.rest import ApiException -from pprint import pprint - - -# create an instance of the API class -api_instance = billforward.TokenizationApi(billforward.ApiClient(configuration)) -cust_nbr = 'cust_nbr_example' # str | (optional) -merch_nbr = 'merch_nbr_example' # str | (optional) -dba_nbr = 'dba_nbr_example' # str | (optional) -terminal_nbr = 'terminal_nbr_example' # str | (optional) -tran_code = 'tran_code_example' # str | (optional) -amount = 'amount_example' # str | (optional) -auth_account = 'auth_account_example' # str | (optional) -first_name = 'first_name_example' # str | (optional) -last_name = 'last_name_example' # str | (optional) -exp_date = 'exp_date_example' # str | (optional) -bp_resp_code = 'bp_resp_code_example' # str | (optional) -bp_resp_text = 'bp_resp_text_example' # str | (optional) -bp_field_errors = 'bp_field_errors_example' # str | (optional) -msg_version = 'msg_version_example' # str | (optional) -tran_type = 'tran_type_example' # str | (optional) -tran_nbr = 'tran_nbr_example' # str | (optional) -local_date = 'local_date_example' # str | (optional) -local_time = 'local_time_example' # str | (optional) -auth_guid = 'auth_guid_example' # str | (optional) -auth_resp = 'auth_resp_example' # str | (optional) -auth_code = 'auth_code_example' # str | (optional) -auth_cvv2 = 'auth_cvv2_example' # str | (optional) -auth_resp_text = 'auth_resp_text_example' # str | (optional) -auth_card_type = 'auth_card_type_example' # str | (optional) -auth_tran_date_gmt = 'auth_tran_date_gmt_example' # str | (optional) -auth_amount_requested = 'auth_amount_requested_example' # str | (optional) -auth_amount = 'auth_amount_example' # str | (optional) -auth_currency_code = 'auth_currency_code_example' # str | (optional) -network_response = 'network_response_example' # str | (optional) -auth_masked_account_nbr = 'auth_masked_account_nbr_example' # str | (optional) -user_data_9 = 'user_data_9_example' # str | (optional) -user_data_10 = 'user_data_10_example' # str | (optional) - -try: - api_instance.epx_pre_auth_response(cust_nbr=cust_nbr, merch_nbr=merch_nbr, dba_nbr=dba_nbr, terminal_nbr=terminal_nbr, tran_code=tran_code, amount=amount, auth_account=auth_account, first_name=first_name, last_name=last_name, exp_date=exp_date, bp_resp_code=bp_resp_code, bp_resp_text=bp_resp_text, bp_field_errors=bp_field_errors, msg_version=msg_version, tran_type=tran_type, tran_nbr=tran_nbr, local_date=local_date, local_time=local_time, auth_guid=auth_guid, auth_resp=auth_resp, auth_code=auth_code, auth_cvv2=auth_cvv2, auth_resp_text=auth_resp_text, auth_card_type=auth_card_type, auth_tran_date_gmt=auth_tran_date_gmt, auth_amount_requested=auth_amount_requested, auth_amount=auth_amount, auth_currency_code=auth_currency_code, network_response=network_response, auth_masked_account_nbr=auth_masked_account_nbr, user_data_9=user_data_9, user_data_10=user_data_10) -except ApiException as e: - print("Exception when calling TokenizationApi->epx_pre_auth_response: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **cust_nbr** | **str**| | [optional] - **merch_nbr** | **str**| | [optional] - **dba_nbr** | **str**| | [optional] - **terminal_nbr** | **str**| | [optional] - **tran_code** | **str**| | [optional] - **amount** | **str**| | [optional] - **auth_account** | **str**| | [optional] - **first_name** | **str**| | [optional] - **last_name** | **str**| | [optional] - **exp_date** | **str**| | [optional] - **bp_resp_code** | **str**| | [optional] - **bp_resp_text** | **str**| | [optional] - **bp_field_errors** | **str**| | [optional] - **msg_version** | **str**| | [optional] - **tran_type** | **str**| | [optional] - **tran_nbr** | **str**| | [optional] - **local_date** | **str**| | [optional] - **local_time** | **str**| | [optional] - **auth_guid** | **str**| | [optional] - **auth_resp** | **str**| | [optional] - **auth_code** | **str**| | [optional] - **auth_cvv2** | **str**| | [optional] - **auth_resp_text** | **str**| | [optional] - **auth_card_type** | **str**| | [optional] - **auth_tran_date_gmt** | **str**| | [optional] - **auth_amount_requested** | **str**| | [optional] - **auth_amount** | **str**| | [optional] - **auth_currency_code** | **str**| | [optional] - **network_response** | **str**| | [optional] - **auth_masked_account_nbr** | **str**| | [optional] - **user_data_9** | **str**| | [optional] - **user_data_10** | **str**| | [optional] - -### Return type - -void (empty response body) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **expire_email_redirect_capture** -> InlineResponseDefault80 expire_email_redirect_capture(id, organizations=organizations) +> InlineResponseDefault79 expire_email_redirect_capture(id, organizations=organizations) @@ -642,7 +440,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault80**](InlineResponseDefault80.md) +[**InlineResponseDefault79**](InlineResponseDefault79.md) ### Authorization @@ -656,7 +454,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_email_redirect_capture** -> InlineResponseDefault81 get_all_email_redirect_capture(account_id=account_id, subscription_id=subscription_id, invoice_id=invoice_id, organizations=organizations) +> InlineResponseDefault80 get_all_email_redirect_capture(account_id=account_id, subscription_id=subscription_id, invoice_id=invoice_id, organizations=organizations) @@ -694,7 +492,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault81**](InlineResponseDefault81.md) +[**InlineResponseDefault80**](InlineResponseDefault80.md) ### Authorization @@ -708,7 +506,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_braintree_by_account_id** -> InlineResponseDefault98 get_braintree_by_account_id(account_id, organizations=organizations) +> InlineResponseDefault97 get_braintree_by_account_id(account_id, organizations=organizations) @@ -742,7 +540,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault98**](InlineResponseDefault98.md) +[**InlineResponseDefault97**](InlineResponseDefault97.md) ### Authorization @@ -756,7 +554,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_by_card_details_id** -> InlineResponseDefault99 get_by_card_details_id(card_details_id, organizations=organizations) +> InlineResponseDefault98 get_by_card_details_id(card_details_id, organizations=organizations) @@ -790,7 +588,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault99**](InlineResponseDefault99.md) +[**InlineResponseDefault98**](InlineResponseDefault98.md) ### Authorization @@ -804,7 +602,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_email_redirect_capture** -> InlineResponseDefault80 get_email_redirect_capture(id, organizations=organizations) +> InlineResponseDefault79 get_email_redirect_capture(id, organizations=organizations) @@ -838,7 +636,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault80**](InlineResponseDefault80.md) +[**InlineResponseDefault79**](InlineResponseDefault79.md) ### Authorization @@ -899,7 +697,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_stripe_ach** -> InlineResponseDefault100 get_stripe_ach(stripe_ach_token_id, organizations=organizations) +> InlineResponseDefault99 get_stripe_ach(stripe_ach_token_id, organizations=organizations) @@ -933,7 +731,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault100**](InlineResponseDefault100.md) +[**InlineResponseDefault99**](InlineResponseDefault99.md) ### Authorization @@ -947,7 +745,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_stripe_token** -> InlineResponseDefault99 get_stripe_token(stripe_token_id, organizations=organizations) +> InlineResponseDefault98 get_stripe_token(stripe_token_id, organizations=organizations) @@ -981,7 +779,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault99**](InlineResponseDefault99.md) +[**InlineResponseDefault98**](InlineResponseDefault98.md) ### Authorization @@ -1088,7 +886,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **pre_auth** -> InlineResponseDefault82 pre_auth(body=body) +> InlineResponseDefault81 pre_auth(body=body) @@ -1120,7 +918,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault82**](InlineResponseDefault82.md) +[**InlineResponseDefault81**](InlineResponseDefault81.md) ### Authorization @@ -1262,7 +1060,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **send_email_redirect_capture** -> InlineResponseDefault80 send_email_redirect_capture(id, body=body) +> InlineResponseDefault79 send_email_redirect_capture(id, body=body) @@ -1296,7 +1094,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault80**](InlineResponseDefault80.md) +[**InlineResponseDefault79**](InlineResponseDefault79.md) ### Authorization @@ -1310,7 +1108,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **start_email_redirect_capture** -> InlineResponseDefault80 start_email_redirect_capture(body=body) +> InlineResponseDefault79 start_email_redirect_capture(body=body) @@ -1342,7 +1140,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault80**](InlineResponseDefault80.md) +[**InlineResponseDefault79**](InlineResponseDefault79.md) ### Authorization @@ -1447,7 +1245,7 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_email_redirect_capture** -> InlineResponseDefault80 update_email_redirect_capture(id, body=body) +> InlineResponseDefault79 update_email_redirect_capture(id, body=body) @@ -1481,7 +1279,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault80**](InlineResponseDefault80.md) +[**InlineResponseDefault79**](InlineResponseDefault79.md) ### Authorization @@ -1495,7 +1293,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_profile_with_token** -> InlineResponseDefault83 update_profile_with_token(body=body, request_token=request_token) +> InlineResponseDefault82 update_profile_with_token(body=body, request_token=request_token) @@ -1529,7 +1327,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault83**](InlineResponseDefault83.md) +[**InlineResponseDefault82**](InlineResponseDefault82.md) ### Authorization @@ -1543,7 +1341,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_stripe_ach_token** -> InlineResponseDefault95 update_stripe_ach_token(body=body) +> InlineResponseDefault94 update_stripe_ach_token(body=body) @@ -1575,7 +1373,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault95**](InlineResponseDefault95.md) +[**InlineResponseDefault94**](InlineResponseDefault94.md) ### Authorization @@ -1589,7 +1387,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_stripe_token** -> InlineResponseDefault96 update_stripe_token(body=body) +> InlineResponseDefault95 update_stripe_token(body=body) @@ -1621,7 +1419,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault96**](InlineResponseDefault96.md) +[**InlineResponseDefault95**](InlineResponseDefault95.md) ### Authorization diff --git a/docs/TrustCommerceConfiguration.md b/docs/TrustCommerceConfiguration.md index edc1397..2f54eae 100644 --- a/docs/TrustCommerceConfiguration.md +++ b/docs/TrustCommerceConfiguration.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**password** | **str** | | [optional] **cust_id** | **str** | | [optional] +**password** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperAPIQuote.md b/docs/TypedQueryResultWrapperAPIQuote.md index 52f2ac7..e175dfd 100644 --- a/docs/TypedQueryResultWrapperAPIQuote.md +++ b/docs/TypedQueryResultWrapperAPIQuote.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**ApiQuote**](ApiQuote.md) | | [optional] **typed_results** | [**list[ApiQuote]**](ApiQuote.md) | | [optional] +**typed_single_result** | [**ApiQuote**](ApiQuote.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperAccount.md b/docs/TypedQueryResultWrapperAccount.md index f5e290f..0b2a7b0 100644 --- a/docs/TypedQueryResultWrapperAccount.md +++ b/docs/TypedQueryResultWrapperAccount.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Account**](Account.md) | | [optional] **typed_results** | [**list[Account]**](Account.md) | | [optional] +**typed_single_result** | [**Account**](Account.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperAddress.md b/docs/TypedQueryResultWrapperAddress.md index 5c2c03a..cbcecaa 100644 --- a/docs/TypedQueryResultWrapperAddress.md +++ b/docs/TypedQueryResultWrapperAddress.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Address**](Address.md) | | [optional] **typed_results** | [**list[Address]**](Address.md) | | [optional] +**typed_single_result** | [**Address**](Address.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperAmendment.md b/docs/TypedQueryResultWrapperAmendment.md index 83b6f7c..1968e13 100644 --- a/docs/TypedQueryResultWrapperAmendment.md +++ b/docs/TypedQueryResultWrapperAmendment.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Amendment**](Amendment.md) | | [optional] **typed_results** | [**list[Amendment]**](Amendment.md) | | [optional] +**typed_single_result** | [**Amendment**](Amendment.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperAvataxConfiguration.md b/docs/TypedQueryResultWrapperAvataxConfiguration.md index adab796..7dce9f0 100644 --- a/docs/TypedQueryResultWrapperAvataxConfiguration.md +++ b/docs/TypedQueryResultWrapperAvataxConfiguration.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**AvataxConfiguration**](AvataxConfiguration.md) | | [optional] **typed_results** | [**list[AvataxConfiguration]**](AvataxConfiguration.md) | | [optional] +**typed_single_result** | [**AvataxConfiguration**](AvataxConfiguration.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperBFPermission.md b/docs/TypedQueryResultWrapperBFPermission.md index 9b14a70..bcda7c5 100644 --- a/docs/TypedQueryResultWrapperBFPermission.md +++ b/docs/TypedQueryResultWrapperBFPermission.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**BFPermission**](BFPermission.md) | | [optional] **typed_results** | [**list[BFPermission]**](BFPermission.md) | | [optional] +**typed_single_result** | [**BFPermission**](BFPermission.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperBraintreeToken.md b/docs/TypedQueryResultWrapperBraintreeToken.md index 772f140..92557a0 100644 --- a/docs/TypedQueryResultWrapperBraintreeToken.md +++ b/docs/TypedQueryResultWrapperBraintreeToken.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**BraintreeToken**](BraintreeToken.md) | | [optional] **typed_results** | [**list[BraintreeToken]**](BraintreeToken.md) | | [optional] +**typed_single_result** | [**BraintreeToken**](BraintreeToken.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperContract.md b/docs/TypedQueryResultWrapperContract.md index 1b4864d..bd6bf05 100644 --- a/docs/TypedQueryResultWrapperContract.md +++ b/docs/TypedQueryResultWrapperContract.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Contract**](Contract.md) | | [optional] **typed_results** | [**list[Contract]**](Contract.md) | | [optional] +**typed_single_result** | [**Contract**](Contract.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperCoupon.md b/docs/TypedQueryResultWrapperCoupon.md index d415edd..1d334c8 100644 --- a/docs/TypedQueryResultWrapperCoupon.md +++ b/docs/TypedQueryResultWrapperCoupon.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Coupon**](Coupon.md) | | [optional] **typed_results** | [**list[Coupon]**](Coupon.md) | | [optional] +**typed_single_result** | [**Coupon**](Coupon.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperCreditNote.md b/docs/TypedQueryResultWrapperCreditNote.md index e871e9a..ae3272a 100644 --- a/docs/TypedQueryResultWrapperCreditNote.md +++ b/docs/TypedQueryResultWrapperCreditNote.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**CreditNote**](CreditNote.md) | | [optional] **typed_results** | [**list[CreditNote]**](CreditNote.md) | | [optional] +**typed_single_result** | [**CreditNote**](CreditNote.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperDataSyncJobResponse.md b/docs/TypedQueryResultWrapperDataSyncJobResponse.md index 507f715..4688bc7 100644 --- a/docs/TypedQueryResultWrapperDataSyncJobResponse.md +++ b/docs/TypedQueryResultWrapperDataSyncJobResponse.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**DataSyncJobResponse**](DataSyncJobResponse.md) | | [optional] **typed_results** | [**list[DataSyncJobResponse]**](DataSyncJobResponse.md) | | [optional] +**typed_single_result** | [**DataSyncJobResponse**](DataSyncJobResponse.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperDunningLine.md b/docs/TypedQueryResultWrapperDunningLine.md index 997e706..a084931 100644 --- a/docs/TypedQueryResultWrapperDunningLine.md +++ b/docs/TypedQueryResultWrapperDunningLine.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**DunningLine**](DunningLine.md) | | [optional] **typed_results** | [**list[DunningLine]**](DunningLine.md) | | [optional] +**typed_single_result** | [**DunningLine**](DunningLine.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperInvoice.md b/docs/TypedQueryResultWrapperInvoice.md index 6b32d80..a2fcb47 100644 --- a/docs/TypedQueryResultWrapperInvoice.md +++ b/docs/TypedQueryResultWrapperInvoice.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Invoice**](Invoice.md) | | [optional] **typed_results** | [**list[Invoice]**](Invoice.md) | | [optional] +**typed_single_result** | [**Invoice**](Invoice.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperInvoiceLinePayment.md b/docs/TypedQueryResultWrapperInvoiceLinePayment.md index b8bdcc4..c72fb1c 100644 --- a/docs/TypedQueryResultWrapperInvoiceLinePayment.md +++ b/docs/TypedQueryResultWrapperInvoiceLinePayment.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**InvoiceLinePayments**](InvoiceLinePayments.md) | | [optional] **typed_results** | [**list[InvoiceLinePayments]**](InvoiceLinePayments.md) | | [optional] +**typed_single_result** | [**InvoiceLinePayments**](InvoiceLinePayments.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperNotification.md b/docs/TypedQueryResultWrapperNotification.md index f30da67..5694df9 100644 --- a/docs/TypedQueryResultWrapperNotification.md +++ b/docs/TypedQueryResultWrapperNotification.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Notifications**](Notifications.md) | | [optional] **typed_results** | [**list[Notifications]**](Notifications.md) | | [optional] +**typed_single_result** | [**Notifications**](Notifications.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperPayment.md b/docs/TypedQueryResultWrapperPayment.md index 124ef18..5b1eede 100644 --- a/docs/TypedQueryResultWrapperPayment.md +++ b/docs/TypedQueryResultWrapperPayment.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Payment**](Payment.md) | | [optional] **typed_results** | [**list[Payment]**](Payment.md) | | [optional] +**typed_single_result** | [**Payment**](Payment.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperPaymentMethod.md b/docs/TypedQueryResultWrapperPaymentMethod.md index 95f2933..a5ad9af 100644 --- a/docs/TypedQueryResultWrapperPaymentMethod.md +++ b/docs/TypedQueryResultWrapperPaymentMethod.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**PaymentMethod**](PaymentMethod.md) | | [optional] **typed_results** | [**list[PaymentMethod]**](PaymentMethod.md) | | [optional] +**typed_single_result** | [**PaymentMethod**](PaymentMethod.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperPlanResponse.md b/docs/TypedQueryResultWrapperPlanResponse.md index 1747d30..de02e92 100644 --- a/docs/TypedQueryResultWrapperPlanResponse.md +++ b/docs/TypedQueryResultWrapperPlanResponse.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**PlanResponse**](PlanResponse.md) | | [optional] **typed_results** | [**list[PlanResponse]**](PlanResponse.md) | | [optional] +**typed_single_result** | [**PlanResponse**](PlanResponse.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperProfile.md b/docs/TypedQueryResultWrapperProfile.md index d40d646..0dcb2a1 100644 --- a/docs/TypedQueryResultWrapperProfile.md +++ b/docs/TypedQueryResultWrapperProfile.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Profile**](Profile.md) | | [optional] **typed_results** | [**list[Profile]**](Profile.md) | | [optional] +**typed_single_result** | [**Profile**](Profile.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperReceipt.md b/docs/TypedQueryResultWrapperReceipt.md index d6a8650..ca5c63c 100644 --- a/docs/TypedQueryResultWrapperReceipt.md +++ b/docs/TypedQueryResultWrapperReceipt.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Receipt**](Receipt.md) | | [optional] **typed_results** | [**list[Receipt]**](Receipt.md) | | [optional] +**typed_single_result** | [**Receipt**](Receipt.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperRefund.md b/docs/TypedQueryResultWrapperRefund.md index cafa0e3..e09ef7f 100644 --- a/docs/TypedQueryResultWrapperRefund.md +++ b/docs/TypedQueryResultWrapperRefund.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Refund**](Refund.md) | | [optional] **typed_results** | [**list[Refund]**](Refund.md) | | [optional] +**typed_single_result** | [**Refund**](Refund.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperRevenueAttribution.md b/docs/TypedQueryResultWrapperRevenueAttribution.md index b34d270..478e01f 100644 --- a/docs/TypedQueryResultWrapperRevenueAttribution.md +++ b/docs/TypedQueryResultWrapperRevenueAttribution.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**RevenueAttributions**](RevenueAttributions.md) | | [optional] **typed_results** | [**list[RevenueAttributions]**](RevenueAttributions.md) | | [optional] +**typed_single_result** | [**RevenueAttributions**](RevenueAttributions.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperRole.md b/docs/TypedQueryResultWrapperRole.md index c0558e4..5ac805d 100644 --- a/docs/TypedQueryResultWrapperRole.md +++ b/docs/TypedQueryResultWrapperRole.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Role**](Role.md) | | [optional] **typed_results** | [**list[Role]**](Role.md) | | [optional] +**typed_single_result** | [**Role**](Role.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperStripeACHToken.md b/docs/TypedQueryResultWrapperStripeACHToken.md index 1f3fb5d..ffc2393 100644 --- a/docs/TypedQueryResultWrapperStripeACHToken.md +++ b/docs/TypedQueryResultWrapperStripeACHToken.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**StripeAchToken**](StripeAchToken.md) | | [optional] **typed_results** | [**list[StripeAchToken]**](StripeAchToken.md) | | [optional] +**typed_single_result** | [**StripeAchToken**](StripeAchToken.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperStripeToken.md b/docs/TypedQueryResultWrapperStripeToken.md index 26b13e2..be0d4ff 100644 --- a/docs/TypedQueryResultWrapperStripeToken.md +++ b/docs/TypedQueryResultWrapperStripeToken.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**StripeToken**](StripeToken.md) | | [optional] **typed_results** | [**list[StripeToken]**](StripeToken.md) | | [optional] +**typed_single_result** | [**StripeToken**](StripeToken.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperSubscription.md b/docs/TypedQueryResultWrapperSubscription.md index b37ef74..502ef41 100644 --- a/docs/TypedQueryResultWrapperSubscription.md +++ b/docs/TypedQueryResultWrapperSubscription.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Subscription**](Subscription.md) | | [optional] **typed_results** | [**list[Subscription]**](Subscription.md) | | [optional] +**typed_single_result** | [**Subscription**](Subscription.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperSubscriptionCharge.md b/docs/TypedQueryResultWrapperSubscriptionCharge.md index f908b5c..998a123 100644 --- a/docs/TypedQueryResultWrapperSubscriptionCharge.md +++ b/docs/TypedQueryResultWrapperSubscriptionCharge.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**SubscriptionCharge**](SubscriptionCharge.md) | | [optional] **typed_results** | [**list[SubscriptionCharge]**](SubscriptionCharge.md) | | [optional] +**typed_single_result** | [**SubscriptionCharge**](SubscriptionCharge.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperTaxationStrategy.md b/docs/TypedQueryResultWrapperTaxationStrategy.md index 68c97af..3645d3a 100644 --- a/docs/TypedQueryResultWrapperTaxationStrategy.md +++ b/docs/TypedQueryResultWrapperTaxationStrategy.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**TaxationStrategy**](TaxationStrategy.md) | | [optional] **typed_results** | [**list[TaxationStrategy]**](TaxationStrategy.md) | | [optional] +**typed_single_result** | [**TaxationStrategy**](TaxationStrategy.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperUserResponse.md b/docs/TypedQueryResultWrapperUserResponse.md index 2997f10..8a9cfe2 100644 --- a/docs/TypedQueryResultWrapperUserResponse.md +++ b/docs/TypedQueryResultWrapperUserResponse.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**UserResponse**](UserResponse.md) | | [optional] **typed_results** | [**list[UserResponse]**](UserResponse.md) | | [optional] +**typed_single_result** | [**UserResponse**](UserResponse.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TypedQueryResultWrapperWebhook.md b/docs/TypedQueryResultWrapperWebhook.md index a80c3b8..5a61e35 100644 --- a/docs/TypedQueryResultWrapperWebhook.md +++ b/docs/TypedQueryResultWrapperWebhook.md @@ -17,8 +17,8 @@ Name | Type | Description | Notes **include_retired** | **bool** | | [optional] **wildcard** | **bool** | | [optional] **entity** | **bool** | | [optional] -**typed_single_result** | [**Webhook**](Webhook.md) | | [optional] **typed_results** | [**list[Webhook]**](Webhook.md) | | [optional] +**typed_single_result** | [**Webhook**](Webhook.md) | | [optional] **single_result** | [**BillingEntityBase**](BillingEntityBase.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/User.md b/docs/User.md index 92365ba..6668c76 100644 --- a/docs/User.md +++ b/docs/User.md @@ -21,9 +21,9 @@ Name | Type | Description | Notes **timezone** | [**UserTimezone**](UserTimezone.md) | | **flexcheck_user** | **bool** | | **two_fa** | **bool** | | [optional] -**email** | **str** | | [optional] **main_username** | [**Username**](Username.md) | | [optional] **active_usernames** | **list[str]** | | [optional] +**email** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Webhook.md b/docs/Webhook.md index 1647953..1b424d7 100644 --- a/docs/Webhook.md +++ b/docs/Webhook.md @@ -15,7 +15,6 @@ Name | Type | Description | Notes **inactive_level** | **int** | | [optional] **webhook_subscriptions** | [**list[WebhookSubscription]**](WebhookSubscription.md) | | [optional] **url** | **str** | | [optional] -**url** | **str** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/WebhooksApi.md b/docs/WebhooksApi.md index abbb3a0..5a313b7 100644 --- a/docs/WebhooksApi.md +++ b/docs/WebhooksApi.md @@ -14,7 +14,7 @@ Method | HTTP request | Description [**verify_webhook**](WebhooksApi.md#verify_webhook) | **GET** /webhooks/verify/{verification-ID} | # **create_webhook** -> InlineResponseDefault102 create_webhook(body=body) +> InlineResponseDefault101 create_webhook(body=body) @@ -46,7 +46,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault102**](InlineResponseDefault102.md) +[**InlineResponseDefault101**](InlineResponseDefault101.md) ### Authorization @@ -60,7 +60,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **create_webhook_v2** -> InlineResponseDefault102 create_webhook_v2(body=body) +> InlineResponseDefault101 create_webhook_v2(body=body) @@ -92,7 +92,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault102**](InlineResponseDefault102.md) +[**InlineResponseDefault101**](InlineResponseDefault101.md) ### Authorization @@ -106,7 +106,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_all_webhooks** -> InlineResponseDefault101 get_all_webhooks(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) +> InlineResponseDefault100 get_all_webhooks(organizations=organizations, offset=offset, records=records, order_by=order_by, order=order, include_retired=include_retired) @@ -148,7 +148,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault101**](InlineResponseDefault101.md) +[**InlineResponseDefault100**](InlineResponseDefault100.md) ### Authorization @@ -162,7 +162,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_allowed_webhook_subscriptions** -> InlineResponseDefault103 get_allowed_webhook_subscriptions(organizations=organizations) +> InlineResponseDefault102 get_allowed_webhook_subscriptions(organizations=organizations) @@ -194,7 +194,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault103**](InlineResponseDefault103.md) +[**InlineResponseDefault102**](InlineResponseDefault102.md) ### Authorization @@ -208,7 +208,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **get_webhook_by_id** -> InlineResponseDefault102 get_webhook_by_id(webhook_id, organizations=organizations) +> InlineResponseDefault101 get_webhook_by_id(webhook_id, organizations=organizations) @@ -242,7 +242,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault102**](InlineResponseDefault102.md) +[**InlineResponseDefault101**](InlineResponseDefault101.md) ### Authorization @@ -256,7 +256,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **retire_webhook** -> InlineResponseDefault102 retire_webhook(webhook_id, organizations=organizations) +> InlineResponseDefault101 retire_webhook(webhook_id, organizations=organizations) @@ -290,7 +290,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault102**](InlineResponseDefault102.md) +[**InlineResponseDefault101**](InlineResponseDefault101.md) ### Authorization @@ -304,7 +304,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **update_webhook** -> InlineResponseDefault102 update_webhook(body=body) +> InlineResponseDefault101 update_webhook(body=body) @@ -336,7 +336,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault102**](InlineResponseDefault102.md) +[**InlineResponseDefault101**](InlineResponseDefault101.md) ### Authorization @@ -350,7 +350,7 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **verify_webhook** -> InlineResponseDefault102 verify_webhook(verification_id, organizations=organizations) +> InlineResponseDefault101 verify_webhook(verification_id, organizations=organizations) @@ -384,7 +384,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponseDefault102**](InlineResponseDefault102.md) +[**InlineResponseDefault101**](InlineResponseDefault101.md) ### Authorization From 3e183fa151affd4aa09b83775142d80c5ab97ecc Mon Sep 17 00:00:00 2001 From: Mat Jaggard Date: Wed, 8 Dec 2021 17:45:54 +0000 Subject: [PATCH 8/8] Reverting incorrect commit --- .swagger-codegen/VERSION | 2 +- README.md | 21 ++++++++++++++++----- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/.swagger-codegen/VERSION b/.swagger-codegen/VERSION index 6738154..ae2f493 100644 --- a/.swagger-codegen/VERSION +++ b/.swagger-codegen/VERSION @@ -1 +1 @@ -3.0.31-SNAPSHOT \ No newline at end of file +3.0.31-SNAPSHOT-Billforward diff --git a/README.md b/README.md index 4159f56..ae8145d 100644 --- a/README.md +++ b/README.md @@ -9,21 +9,21 @@ This Python package is automatically generated by the [Swagger Codegen](https:// ## Requirements. -Python 2.7 and 3.4+ +Python 3.4+ ## Installation & Usage ### pip install -If the python package is hosted on Github, you can install directly from Github +The python package is hosted on Github, you can install directly from Github ```sh -pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git +pip install git+https://github.com/billforward/bf-python.git ``` -(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`) +(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/billforward/bf-python.git`) Then import the package: ```python -import billforward +import billforward ``` ### Setuptools @@ -51,6 +51,9 @@ import billforward from billforward.rest import ApiException from pprint import pprint +billforward.Configuration.api_key = '